andrey/retina
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
High-level RTSP multimedia streaming library, in Rust
133 Commits 2 Branches 24 Tags 2.2 MiB
Rust 99.6%
JavaScript 0.3%
HTML 0.1%
aff87d1919
Go to file
Scott Lamb aff87d1919 fix possible panic reading data from server 
Found by inspection. It'd be nice to fuzz the tokio module to more
reliably find problems like this, but it looks like I'd have to make
a bunch more stuff public for that. Maybe later...
2022-03-08 10:34:11 -08:00
.github/workflows clippy, take 2 2022-01-31 14:17:07 -08:00
benches experimental UDP support (fixes #30) 2021-08-30 21:40:51 -07:00
examples/client mp4 example: allow in-band h264 params 2022-01-30 21:18:47 -08:00
fuzz clippy 2022-01-31 14:07:03 -08:00
src fix possible panic reading data from server 2022-03-08 10:34:11 -08:00
.gitignore initial commit 2021-06-03 16:49:53 -07:00
Cargo.lock fix #52 with upgrade to sdp-types 0.1.4 2022-03-08 10:05:41 -08:00
Cargo.toml fix #52 with upgrade to sdp-types 0.1.4 2022-03-08 10:05:41 -08:00
CHANGELOG.md fix possible panic reading data from server 2022-03-08 10:34:11 -08: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 update overall crate status 2022-01-25 23:42:59 -08: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.

Status: In production use in Moonfire NVR. Many missing features. Some breaking changes needed to clean up APIs (see #47.)

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

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.