https://github.com/aler9/rtsp-simple-proxy
DEPRECATED - please use https://github.com/aler9/rtsp-simple-server
https://github.com/aler9/rtsp-simple-proxy
audio golang rtcp rtp rtsp rtsp-proxy rtsp-server streaming video
Last synced: about 2 months ago
JSON representation
DEPRECATED - please use https://github.com/aler9/rtsp-simple-server
- Host: GitHub
- URL: https://github.com/aler9/rtsp-simple-proxy
- Owner: aler9
- License: mit
- Archived: true
- Created: 2020-01-20T16:39:29.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-07-02T08:18:50.000Z (almost 5 years ago)
- Last Synced: 2024-11-05T22:41:38.883Z (7 months ago)
- Topics: audio, golang, rtcp, rtp, rtsp, rtsp-proxy, rtsp-server, streaming, video
- Language: Go
- Homepage:
- Size: 108 KB
- Stars: 54
- Watchers: 6
- Forks: 19
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DEPRECATED - Merged into rtsp-simple-server
This project has been merged into rtsp-simple-server; please look at this page for instructions on how to setup a RTSP proxy:
https://github.com/aler9/rtsp-simple-server#usage-as-rtsp-proxy
# rtsp-simple-proxy
[](https://goreportcard.com/report/github.com/aler9/rtsp-simple-proxy)
[](https://travis-ci.org/aler9/rtsp-simple-proxy)
_rtsp-simple-proxy_ is a simple, ready-to-use and zero-dependency RTSP proxy, a software 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. Users can then connect to the proxy instead of the original source.
* 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 multiple streams in TCP or UDP
* Distribute streams in TCP or UDP
* Supports the RTP/RTCP streaming protocol
* Supports authentication (i.e. username and password)
* 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](https://github.com/aler9/rtsp-simple-proxy/releases) 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:
```yaml
streams:
# name of the stream
mypath:
# url of the source stream, in the format rtsp://user:pass@host:port/path
url: rtsp://myhost:8554/mystream
```
2. Launch the proxy:
```
./rtsp-simple-proxy
```
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 configuration file
```yaml
# timeout of read operations
readTimeout: 5s
# timeout of write operations
writeTimeout: 5s
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
# optional username required to read
readUser:
# optional password required to read
readPass:
streams:
# name of the stream
test1:
# url of the source stream, in the format rtsp://user:pass@host:port/path
url: rtsp://myhost:8554/mystream
# whether to use tcp or udp
protocol: udp
```
#### Full command-line usage
```
usage: rtsp-simple-proxy []
rtsp-simple-proxy v0.0.0
RTSP proxy.
Flags:
--help Show context-sensitive help (also try --help-long and --help-man).
--version print version
Args:
[] path of a config file. The default is conf.yml. Use 'stdin' to
read config from stdin
```
## Links
Related projects
* https://github.com/aler9/rtsp-simple-server
* https://github.com/aler9/gortsplib
IETF Standards
* RTSP 1.0 https://tools.ietf.org/html/rfc2326
* RTSP 2.0 https://tools.ietf.org/html/rfc7826
* HTTP 1.1 https://tools.ietf.org/html/rfc2616