mirror of https://github.com/bluenviron/mediamtx synced 2024-12-16 11:44:50 +00:00

Go to file

Alessandro Ros 3436b56d0b update readme		2020-05-11 00:11:32 +02:00
test-images/ffmpeg	add tests	2020-05-10 21:32:40 +02:00
.dockerignore	update .dockerignore	2019-12-28 22:28:00 +01:00
.gitignore	initial commit	2019-12-28 22:07:49 +01:00
.travis.yml	add tests	2020-05-10 21:32:40 +02:00
go.mod	run go mod tidy	2020-05-10 21:47:40 +02:00
go.sum	update gortsplib	2020-05-07 22:30:03 +02:00
LICENSE	initial commit	2019-12-28 22:07:49 +01:00
main_test.go	add arguments --read-user --read-pass	2020-05-10 22:56:46 +02:00
main.go	add arguments --read-user --read-pass	2020-05-10 22:56:46 +02:00
Makefile	add tests	2020-05-10 21:32:40 +02:00
README.md	update readme	2020-05-11 00:11:32 +02:00
server-client.go	add arguments --read-user --read-pass	2020-05-10 22:56:46 +02:00
server-tcpl.go	add serverTcpListener.close()	2020-05-10 16:28:40 +02:00
server-udpl.go	add new arguments --read-timeout and --write-timeout	2020-05-10 22:35:56 +02:00

README.md

rtsp-simple-server

rtsp-simple-server is a simple, ready-to-use and zero-dependency RTSP server, a program that allows multiple users to read or publish live video and audio streams. RTSP is a standardized protocol that defines how to perform these operations with the help of a server, that is contacted by both readers and publishers in order to negotiate a streaming protocol and read or write data. The server is then responsible of linking the publisher stream with the readers.

This software was developed with the aim of simulating a live camera feed for debugging purposes, and therefore to use files instead of real streams. Another reason for the development was the deprecation of FFserver, the component of the FFmpeg project that allowed to create a RTSP server (but this server is not bounded to FFmpeg and can be used with any software that supports publishing to RTSP).

Features:

Read and publish streams via UDP and TCP
Publish multiple streams at once, each in a separate path, that can be read by multiple users
Each stream can have multiple video and audio tracks
Supports the RTP/RTCP streaming protocol
Supports authentication for publishers
Run a script when a client connects or disconnects
Compatible with Linux, Windows and Mac, does not require any dependency or interpreter, it's a single executable

Installation

Precompiled binaries are available in the release page. Just download and extract the executable.

Usage

Basic usage

Start the server:
```
./rtsp-simple-server
```
In another terminal, publish something with FFmpeg (in this example it's a video file, but it can be anything you want):
```
ffmpeg -re -stream_loop -1 -i file.ts -c copy -f rtsp rtsp://localhost:8554/mystream
```

Open the stream with VLC:

vlc rtsp://localhost:8554/mystream

you can alternatively use GStreamer:

gst-launch-1.0 -v rtspsrc location=rtsp://localhost:8554/mystream ! rtph264depay ! decodebin ! autovideosink

Publisher authentication

Start the server and set a username and a password:

./rtsp-simple-server --publish-user=admin --publish-pass=mypassword

Only publishers that know both username and password will be able to publish:

ffmpeg -re -stream_loop -1 -i file.ts -c copy -f rtsp rtsp://admin:mypassword@localhost:8554/mystream

Full command-line usage

usage: rtsp-simple-server [<flags>]

rtsp-simple-server v0.0.0

RTSP server.

Flags:
  --help                 Show context-sensitive help (also try --help-long and --help-man).
  --version              print rtsp-simple-server version
  --protocols="udp,tcp"  supported protocols
  --rtsp-port=8554       port of the RTSP TCP listener
  --rtp-port=8000        port of the RTP UDP listener
  --rtcp-port=8001       port of the RTCP UDP listener
  --read-timeout=5s      timeout for read operations
  --write-timeout=5s     timeout for write operations
  --publish-user=""      optional username required to publish
  --publish-pass=""      optional password required to publish
  --read-user=""         optional username required to read
  --read-pass=""         optional password required to read
  --pre-script=""        optional script to run on client connect
  --post-script=""       optional script to run on client disconnect