andrey/retina
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
High-level RTSP multimedia streaming library, in Rust
14 Commits 2 Branches 24 Tags 2.2 MiB
Rust 99.6%
JavaScript 0.3%
HTML 0.1%
b9aad86d57
Go to file
Scott Lamb b9aad86d57 box aac and h264 depacketizers 
These are huge, not present for every stream, and only allocated once at
describe time, so boxing makes sense. I probably should listen to that
clippy lint!
2021-06-09 22:42:48 -07:00
.github/workflows initial commit 2021-06-03 16:49:53 -07:00
examples/client initial commit 2021-06-03 16:49:53 -07:00
fuzz add missing copyright header 2021-06-07 21:35:08 -07:00
src box aac and h264 depacketizers 2021-06-09 22:42:48 -07:00
.gitignore initial commit 2021-06-03 16:49:53 -07:00
Cargo.lock prepare v0.0.1 release 2021-06-09 13:50:30 -07:00
Cargo.toml add repository link to Cargo.toml 2021-06-09 22:26:52 -07:00
LICENSE-APACHE.txt initial commit 2021-06-03 16:49:53 -07:00
LICENSE-MIT.txt initial commit 2021-06-03 16:49:53 -07:00
README.md fix README formatting 2021-06-09 15:24:10 -07:00

README.md

retina

crates.io version Documentation CI

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
    • video: H.264 (RFC 6184)
      • SVC
      • periodic infra refresh
      • multiple slices per picture
      • multiple SPS/PPS
      • interleaved mode
    • audio
      • AAC
        • interleaving
      • RFC 3551 codecs: G.711, G.723, L8/L16
    • application: ONVIF metadata
  • 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 failure crate; 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.)
  • benchmarks

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:

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.