b54ea3f4fd
* match a couple h264-reader semantic changes. E.g., decode_nal now
expects the full NALU including header byte.
* adjust test data in depacketize_parameter_change. The SDP parameters
I used were invalid in a way caught only by the new h264-reader crate.
That's not the intended scenario, so use different parameters. But
mention the accidental scenario in CHANGELOG.md.
* initialize logging in h264 tests to ease debugging problems like the
bullet above.
* in AAC code, match h264-reader's switch from bitreader to
bitstream-io. This keeps dependencies down, in addition to the reasons
for h264-reader's switch, described here:
|
||
|---|---|---|
| .github/workflows | ||
| benches | ||
| examples | ||
| 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.
Status: In production use in Moonfire NVR. Many missing features.
Progress:
- client support
- basic authentication.
- digest authentication.
- RTP over TCP via RTSP interleaved channels.
- RTP over UDP (experimental).
-
- re-order buffer. (Out-of-order packets are dropped now.)
- 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
- synchronous with std only
- codec depacketization
- clean, stable API. (See #47.)
- quality errors
-
- detailed error description text.
-
- programmatically inspectable error type.
- good functional testing coverage. (Currently lightly / unevenly tested. Most depacketizers have no tests.)
- fuzz testing. (In progress.)
- benchmark
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 --package client mp4 --url rtsp://ip.address.goes.here/ --username admin --password test out.mp4
...
^C
Example client
$ cargo run --package client <CMD>
Where CMD:
- info - Gets info about available streams and exits.
- mp4 - Writes RTSP streams to mp4 file; exit with Ctrl+C.
- onvif - Gets realtime onvif metadata if available; exit with Ctrl+C.
Example WebRTC proxy
This allows viewing a H.264 video stream from your browser, with the help of
webrtc-rs.
$ cargo run --package webrtc-proxy -- --help
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.