1145ed053e
Since writing that text, I've made some design decisions that complicate this: * dropping a Session uses tokio::runtime::Handle::spawn * keepalives are tracked with a tokio::time::Sleep * I support UDP (so multiple sockets per session), which means the blocking API would have to use extra threads or async IO behind the scenes. I might make decisions that complicate it further, e.g. having a tokio task for each socket rather than polling them all in Session::poll_next. It's of course still *possible* to support async-std and/or a blocking API if there's demand. It'd require more duplicate logic/APIs now, so I'm not excited about the possibility.
4.0 KiB
4.0 KiB
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
- 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
- uniform, documented API. (Currently haphazard in terms of naming, what fields are exposed directly vs use an accessors, etc.)
- 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
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
Example client
$ cargo run --example client <CMD>
Where CMD:
- info - Get info about available streams and exit
- mp4 - Write RTSP streams to mp4 file, exit with Ctrl+C
- metadata - Get realtime onvif metadata if available, exit with Ctrl+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.