/rtsp-simple-proxy

ready-to-use RTSP proxy

Primary LanguageGoMIT LicenseMIT

rtsp-simple-proxy

Go Report Card Build Status

rtsp-simple-proxy is a simple, ready-to-use and zero-dependency RTSP proxy, a program that receives one or more existing RTSP streams and makes them available to other users. A proxy is usually deployed in one of these scenarios:

  • when there are multiple users that are receiving a stream and the bandwidth is limited, so the proxy is used to receive the stream once and users connect to the proxy;
  • when there's a NAT / firewall between a stream and the users, in this case the proxy is installed in the NAT and makes the stream available to the outside world.

Features:

  • Receive streams in TCP or UDP
  • Distribute streams in TCP or UDP
  • Supports the RTP/RTCP streaming protocol
  • Supports authentication
  • Compatible with Linux and Windows, 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

  1. Create a configuration file named conf.yml, placed in the same folder of the executable, with the following content:

    server:
  # supported protocols
  protocols: [ tcp, udp ]
  # port of the RTSP TCP listener
  rtspPort: 8554
  # port of the RTP UDP listener
  rtpPort: 8050
  # port of the RTCP UDP listener
  rtcpPort: 8051

streams:
  # name of the stream
  mypath:
    # url of the source stream
    url: rtsp://localhost:8554/mystream
    # whether to receive this stream in udp or tcp
    useTcp: no

  2. Launch the proxy:

    ./rtsp-simple-proxy conf.yml

  3. Open any stream you have defined in the configuration file by using the stream name as path, for instance with VLC:

    vlc rtsp://localhost:8554/mypath

Full command-line usage

usage: rtsp-simple-proxy [<flags>] <confpath>

rtsp-simple-proxy v0.0.0

RTSP proxy.

Flags:
  --help     Show context-sensitive help (also try --help-long and --help-man).
  --version  print rtsp-simple-proxy version

Args:
  <confpath>  path of the config file. Use 'stdin' to read config from stdin

Links

Related projects

IETF Standard