High-level RTSP multimedia streaming library, in Rust
48f2c2eb15
The new implementation has several benefits:
* it's more correct, in a way that probably doesn't matter now but
will if we ever send ONVIF backchannel audio. See the removed
comment about deadlock possibility. Similarly, I realized that if
packets became readable halfway through flushing a keepalive, the
keepalive future would be improperly dropped as described at
the beginning of this blog post:
https://carllerche.com/2021/06/17/six-ways-to-make-async-rust-easier/
* we'll be able to make other method calls on the Session while using
the stream, eg sending audio with ONVIF backchannel
* it's 8% faster according to the client benchmark.
* it doesn't pull in the async-stream dependency anymore.
* we can name the type of the stream, avoiding a Box in some cases.
|
||
|---|---|---|
| .github/workflows | ||
| benches | ||
| examples/client | ||
| fuzz | ||
| src | ||
| .gitignore | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| LICENSE-APACHE.txt | ||
| LICENSE-MIT.txt | ||
| README.md | ||
retina
High-level RTSP multimedia streaming library, in Rust. Good support for ONVIF RTSP/1.0 IP surveillance cameras, as needed by Moonfire NVR. Works around brokenness in cheap closed-source cameras.
Progress:
- client support
- digest authentication.
- RTP over TCP via RTSP interleaved channels.
- RTP over UDP.
- RTSP/1.0.
- RTSP/2.0.
- SRTP.
- ONVIF backchannel support (for sending audio).
- ONVIF replay mode.
- receiving RTCP Sender Reports (currently only uses the timestamp)
- sending RTCP Receiver Reports
- server support
- I/O modes
- async with tokio
- async-std. (Most of the crate's code is independent of the async library, so I don't expect this would be too hard to add.)
- synchronous with std only
- codec depacketization
- uniform, documented API. (Currently haphazard in terms of naming, what fields are exposed directly vs use an accessors, etc.)
- rich errors. (Currently uses untyped errors with the deprecated
failurecrate; some error messages are quite detailed, others aren't.) - good functional testing coverage. (Currently lightly / unevenly tested. The depacketizers have no tests.)
- fuzz testing. (In progress.)
- benchmark
Currently very unstable: expect breaking API changes at every release as I work through items above.
Help welcome!
Getting started
Try the mp4 example. It streams from an RTSP server to a .mp4 file until
you hit ctrl-C.
$ cargo run --example client mp4 --url rtsp://ip.address.goes.here/ --username admin --password test out.mp4
...
^C
Acknowledgements
This builds on the whole Rust ecosystem. A couple folks have been especially helpful:
- Sebastian Dröge, author of
rtsp-types - David Holroyd, author of
h264-reader
Why "retina"?
It's a working name. Other ideas welcome. I started by looking at dictionary words with the letters R, T, S, and P in order and picking out ones related to video:
$ egrep '^r.*t.*s.*p' /usr/share/dict/words' |
|
|---|---|
| retinoscope | close but too long, thus retina |
| retrospect | good name for an NVR, but I already picked Moonfire |
| rotascope | misspelling of "rotascope" (animation tool) or archaic name for "gyroscope"? |
License
Your choice of MIT or Apache; see LICENSE-MIT.txt or LICENSE-APACHE, respectively.