https://github.com/nintha/river
Pure Rust Implementation of RTMP Live Streaming Server
https://github.com/nintha/river
flv live-stream livestreaming pure-rust river rtmp rust
Last synced: 6 months ago
JSON representation
Pure Rust Implementation of RTMP Live Streaming Server
- Host: GitHub
- URL: https://github.com/nintha/river
- Owner: nintha
- License: apache-2.0
- Created: 2020-11-07T00:42:51.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-05-29T03:36:45.000Z (about 4 years ago)
- Last Synced: 2024-08-07T23:55:33.925Z (10 months ago)
- Topics: flv, live-stream, livestreaming, pure-rust, river, rtmp, rust
- Language: Rust
- Homepage:
- Size: 272 KB
- Stars: 126
- Watchers: 5
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# River
Pure Rust Implementation of RTMP Live Stream Server
## Usage
```
USAGE:
river.exe [OPTIONS]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
--http-flv-port disabled if port is 0 [default: 0]
--http-player-port disabled if port is 0 [default: 0]
--rtmp-port [default: 1935]
--ws-fmp4-port disabled if port is 0 [default: 0]
--ws-h264-port disabled if port is 0 [default: 0]
```
## Push
OBS, x264, tune=zerolatency, CBR, preset=veryfast, profile=baseline
## Play
### ffplay
```shell
ffplay -fflags nobuffer -analyzeduration 100000 rtmp://localhost:11935/channel/token
```
`-fflags nobuffer -analyzeduration 100000` could reduce the latency. On my computer, the latency is about 1 second.
### JMuxer
Playing in the browser with [Jmuxer](https://github.com/samirkumardas/jmuxer).
If pushing stream with x264 codec, recommended profile is baseline
If you are using x264 encoding to push the stream, it is recommended that profile=baseline to avoid frequent video jitter. The current local test latency is about 1 second.
**Example:**
1. Run `River`
```shell
cargo run -- --http-player-port=8080 --ws-h264-port=18000
```
2. Push with OBS, x264, tune=zerolatency, CBR, preset=veryfast, profile=baseline
3. Open your browser http://localhost:8080
## Completed
- [x] support custom width and height
- [x] support audio
- [x] support HTTP-FLV output
- [x] support raw H264 stream output
- [x] deal with the problem of websocket message backlog
- [x] configurable startup parameters (monitoring server port)
- [x] optional output formats based on the startup parameters
- [x] web video player with `JMuxer` (ws-h264-port required)
## TODO
- [ ] PUSH/PULL authentication
- [ ] support fragmented MP4 output
## FAQ
### The Chrome auto pauses muted video in inactive tabs.
- Listen to the event `visibilitychange`, and change Video playback progress manually
```js
var video = document.getElementById('video');
document.addEventListener("visibilitychange", function() {
video.currentTime = video.buffered.end(0);
});
```
- Timed changing Video playback progress manually
```js
var video = document.getElementById('video');
setInterval(()=>{
var latest = video.buffered.end(0);
// over 200ms
if (latest - video.currentTime > 0.2){
video.currentTime = latest;
}
}, 1000);
```
## Reference
- [RTMP推送AAC ADTS音频流](https://www.jianshu.com/p/1a6f195863c7)
- [视音频数据处理入门](https://blog.csdn.net/leixiaohua1020/article/details/50534369)
- [rtmp数据封装](https://blog.csdn.net/Jacob_job/article/details/81880445)
- [视音频编解码学习工程：FLV封装格式分析器](https://blog.csdn.net/leixiaohua1020/article/details/17934487)
Thanks to [Jetbrains](https://www.jetbrains.com/?from=River) for their great IDEs and the free [open source license](https://jb.gg/OpenSource).
