Skip to content

CHANGELOG.md

Latest commit

 

History

History
371 lines (294 loc) · 17.5 KB

CHANGELOG.md

File metadata and controls

371 lines (294 loc) · 17.5 KB
Raw

unreleased

  • accept schemeless Content-Base header (e.g. 192.168.1.10:554/stream0/ instead of rtsp://192.168.1.10:554/stream0/) as sent by some Anjvision cameras. See moonfire-nvr#356.

v0.4.19 (2026-03-13)

v0.4.18 (2026-03-10)

  • retina::codec::FrameFormat: support Annex B encoding (#44), ADTS encoding, and parameter set insertion control. This makes it easier to feed frames directly to a decoder or muxer without munging them. It also makes Retina's behavior more camera-agnostic: previously it would include inline parameters or not based on what the camera choose; now it's configurable via frame_format.
  • use the RUST_LOG environment variable to control logging in the examples and tests. (Formerly it used MOONFIRE_LOG, but Retina is not part of Moonfire, and RUST_LOG is standard.) Document in README.md. As requested in #55.
  • restructure the webrtc-proxy example to avoid causing the upstream RTSP server's buffer to fill while waiting for the user to copy'n'paste tokens in both directions. Fixes #80.
  • add a new webcodecs example that decodes video frames using WebCodecs API. This is the absolute lowest-latency way to watch RTSP streams from a browser!
  • expose receive timestamps (both wall clock and monotonic/instant) in packet contexts.
  • expose coded as well as display pixel dimensions in VideoParameters to ease construction of a WebCodecs VideoDecoderConfiguration.
  • expose number of audio channels in AudioParameters to ease construction of a WebCodecs AudioDecoderConfig.
  • allow producing VideoParameters from H.264 SPS and PPS NALs.

v0.4.17 (2026-02-17)

  • trim whitespace in SSRC values from Transport and RTP-Info headers, improving compatibility with some Hikvision cameras (e.g. iDS-2CD9396-BIS and DS-2CD3641G2-IZS). Thanks to @myermukhanov in #128.
  • ignore trailing semicolons in RTP-Info header parsing, improving compatibility with Laureii cameras. Reported by @ZXY595 in #117.
  • H.265: fix bug in which TrailNs (unit type 0) were rejected as a single NAL. This was noticeable with an Intel N100 encoder + ffmpeg + MediaMTX. As reported by @anti-social in #123.
  • H.264 and H.265: allow empty fragments, which are useless but sent by some cameras, as reported by @nemosupremo in #115.

v0.4.16 (2026-02-08)

  • fix inverted logic in simple audio frame_length() that caused valid G.711 (PCMA/PCMU) audio streams to be rejected with "invalid length" errors. Reported by C-Format in #126.
  • fix resuming depacketization (via Demuxed::poll_next) after an error. Previously this could panic due to error paths not maintaining the invariants. See #122.
  • support pps_scaling_list_data_present, needed by some Reolink H.265 cameras. See #112 and #116.

v0.4.15 (2025-10-10)

  • fix parsing of the Transport when the ssrc parameter precedes other parameters and of SDP when the control attribute precedes other attributes. This improves compatibility with Luckfox's rkip server. See #120.

v0.4.14 (2025-10-03)

  • fix H.265 ProfileTierLevel parsing when sps_max_sub_layers_minus1 > 0. This caused strange error messages because the SPS bitstream was mis-positioned. Thanks to nemosupremo!
  • improve compatibility with some Tiandy cameras by warning rather than erroring when H.264 FU-A and H.265 FU change NAL types within a fragmented access unit. These cameras appear to never set the subsequent packets' NAL types correctly. See scottlamb/moonfire-nvr#344.
  • update dependencies: jiff to 0.2 and thiserror to 2.0
  • add an example that uses ffmpeg to decode frames
  • update minimum Rust version to 1.85
  • ignore the "reserved" bit in FU-A payload, improving camera compatibility

v0.4.13 (2025-01-31)

  • fix H.265 SPS parsing flaw that affected the Tenda CP3PRO camera.
  • fix format of RTCP packet used for firewall hole punching.
  • support H.265 SPSs which set st_ref_pic_set.inter_ref_pic_set_prediction_flag, including Xiaomi YI Pro 2K Home cameras running https://github.com/roleoroleo/yi-hack-Allwinner-v2 firmware. Fixes scottlamb/moonfire-nvr#333.
  • fix RFC 6381 codec string generation to match a significant bug fix in Technical Corrigendum 1 to ISO/IEC 14496-15:2014.

v0.4.12 (2025-01-28)

  • support H.265 (#57).
  • fix Connecting via TCP to known-broken RTSP server log line on connection to a non-broken server.

v0.4.11 (2025-01-22)

  • improve some error messages on bad H.264 sprop-parameter-sets
  • interoperate with V380 cameras by interpreting Annex B sequences in RTP payload contexts where single NALs are otherwise expected. (Fixes #68, [#108]).
  • interpret Annex B sequences in H.264 sprop-parameter-sets also, improving interoperability with additional cameras. In particular, Retina now understands these video parameters at DESCRIBE time, rather than delaying until the first full video frame is received.
  • update minimum Rust to 1.70.
  • use jiff for date formatting.

v0.4.10 (2024-08-19)

  • update base64 dep to 0.22
  • update minimum Rust version to 1.70.

v0.4.9 (2024-08-19)

  • added helpers for building .mp4 VisualSampleEntry and AudioSampleEntry for H.264, MJPEG, and AAC.
  • shrunk VideoParameters from 112 bytes to 88 bytes and AudioParameters from 80 bytes to 64 bytes (measured on a 64-bit platform).

v0.4.8 (2024-05-26)

  • support MJPEG codec (contribution from zanshi)
  • permit MP2T/ protocol in media description (contribution from (yujincheng08)[https://github.com/yujincheng08)]).
  • #102: support Reolink cameras which have extraneous bytes following the SPS.

v0.4.7 (2024-01-08)

  • support servers that do not set Content-Type on DESCRIBE responses

v0.4.6 (2023-12-29)

  • add default User-Agent header
  • add policy for handling session IDs. Required for some broken cameras which can change the session ID between SETUP calls.
  • ignore connection refused errors triggered by the firewall punch-through packets.
  • improve several vague or misleading log messages.
  • fix inverted logic in live555 bug detection, introduced with v0.3.10.
  • ignore seq=0 and seq=1 in PLAY response's RTP-Info header by default. These values are known to be set erroneously by the Hikvision DS-2CD2032-I and Tapo C320WS, respectively.
  • customizable behavior for RTCP packets with unknown ssrcs, now defaulting to ignoring them. This also is necessary to interoperate with the Tapo C320WS.
  • improve some incorrect, misleading, and/or uninformative logging.
  • minimum Rust is now 1.67.

v0.4.5 (2023-02-02)

  • minimum Rust version is now 1.64.
  • upgrade to rtsp-types 0.0.5, which ignores trailing whitespace in RTSP headers. This fixes errors when communicating with some Longse cameras (#77).
  • remove obsolete workaround for GW security GW security GW4089IP's bad out-of-band parameters. Instead, we treat them as unparseable and ignore them as described in the v0.4.2 notes below.

v0.4.4 (2022-12-26)

  • improve interop with Ubiquiti cameras by ignoring fmtp attributes in SDP which have nothing (no required SP, no data) after the payload type.
  • fix parsing of RTP packets with extensions, which broke with v0.4.0 (2e34bf92).

v0.4.3 (2022-09-28)

  • upgrade version of h264-reader crate. Compatibility note: Retina may now be stricter about parsing H.264 parameters (SPS/PPS). In practice, with some cameras this means unparseable "out-of-line" parameters (specified in the SDP) will be ignored in favor of parseable "in-line" parameters (specified within the RTP data stream).

v0.4.2 (2022-09-28)

v0.4.1 (2022-08-09)

  • Send keepalives at every half-session-timeout rather than a fixed 30-second interval. This allows persistent connections to servers that have timeouts shorter than 30 seconds.
  • Use OPTIONS for initial keepalive, and only switch to SET_PARAMETER if the server advertises its support. This allows persistent connections to rtsp-simple-server v0.19.3, which does not support the latter method and drops the connection on receiving unsupported methods.

v0.4.0 (2022-05-17)

  • BREAKING: remove deprecated retina::client::Session<Playing>::teardown and retina::client::Demuxed::teardown; made private some items already #[doc(hidden)].
  • BREAKING: retina::client::Session<Described>::setup takes a new SetupOptions argument for future expansion.
  • BREAKING: the transport to use is configured per-stream as part of retina::SetupOptions (rather than the prior retina::SessionOptions) and takes per-transport options for future expansion.
  • BREAKING: retina::StreamContext has been split out of retina::PacketContext. Both must be printed to provide the same information as before. This change reduces how much data needs to be copied with each packet.
  • BREAKING: PacketItem and CodecItem are now #[non_exhaustive] for future expansion.
  • BREAKING: retina::client::rtp::Packet is now retina::rtp::ReceivedPacket, and field access has been removed in favor of accessors.
  • BREAKING: retina::client::PacketItem::RtpPacket has been renamed to retina::client::PacketItem::Rtp.
  • BREAKING: retina::client::PacketItem::SenderReport has been replaced with retina::client::PacketItem::Rtcp, to expose full RTCP compound packets. Likewise retina::codec::CodecItem.
  • BREAKING: retina::codec::Parameters is now retina::codec::ParametersRef, which references parameters stored within the Stream to reduce copying.
  • minimum Rust version is now 1.59.

v0.3.10 (2022-05-09)

  • ignore unparseable rtptime values in the PLAY response's RTP-Info header. This improves compatibility with the OMNY M5S2A 2812 camera, as described in scottlamb/moonfire-nvr#224.

v0.3.9 (2022-04-12)

  • camera interop: eliminate bad clockrate in rtpmap errors with cameras that (incorrectly) add trailing spaces to this SDP parameter, as described at scottlamb/moonfire-nvr#213.
  • camera interop: allow ignoring RTSP interleaved data messages on unassigned channels, also described at scottlamb-moonfire-nvr#213.
  • camera interop: when using TCP, default to attempting a TEARDOWN before closing the connection, to improve behavior with cameras that have the live555 stale session bug but do not advertise it.
  • clarify Session's expectations for tokio runtimes.
  • additional diagnostics/logging on certain camera failures.

v0.3.8 (2022-03-08)

  • fix depacketization of fragmented AAC frames
  • #52: allow compatibility with cameras that incorrectly omit the SDP origin line.
  • fix panic if RTSP server precedes a data message with a CRLF.
  • expose SDP framerate via retina::client::Stream::framerate.

v0.3.7 (2022-01-28)

  • #50: fix a panic on certain invalid H.264 sprop-parameter-sets
  • documentation improvements

v0.3.6 (2021-12-29)

  • correctly expire stale session entries that track live555 stale file descriptor sessions. See moonfire-nvr#184.
  • ignore (rather than error on) spurious RTP data packets between the PLAY request and response. These are sent by some versions of v4l2rtspserver.

v0.3.5 (2021-11-30)

  • #42: support servers that don't send out-of-band H.264 parameters or send invalid parameters; wait for in-band parameters in this case. The in-band parameters must be valid.
  • documentation improvements.

v0.3.4 (2021-10-26)

  • use rtsp-types 0.0.3, and thus nom 7.0.

v0.3.3 (2021-10-20)

  • #25: better HTTP authentication support via the new http-auth crate. Before, retina would only authenticate properly if the first requested challenge was Digest. Now, it will pick out a Digest or Basic challenge from a list.

v0.3.2 (2021-09-29)

  • better TEARDOWN handling, which often avoids the need to wait for session expiration ((#34).

v0.3.1 (2021-09-09)

  • warn when connecting via TCP to a known-broken live555 server version.
  • improve Geovision compatibility by skipping its strange RTP packets with payload type 50.
  • UDP fixes.
  • improve compatibility with cameras with non-compliant SDP, including Anpviz (#26 and Geovision ([#33])(#33)).
  • new mechanism to more reliably send TEARDOWN requests.

v0.3.0 (2021-08-31)

  • BREAKING CHANGE: #30: experimental UDP support. Several RtspMessageContext fields have been replaced with PacketContext.
  • BREAKING CHANGE: remove retina::client::SessionOptions::ignore_spurious_data. This was an attempted workaround for old live555 servers (#17) that was ineffective.
  • #22: fix handling of 44.1 kHz AAC audio.

v0.2.0 (2021-08-20)

  • BREAKING CHANGE: retina::client::Session::describe now takes a new options: SessionOptions. The creds has moved into the options, along with some new options.
  • BREAKING CHANGE: renamed PlayPolicy to PlayOptions for consistency.
  • Added options to work around bugs found in Reolink cameras.
  • #9. Improve compatibility with how some cameras handle the control and RTP-Info urls. This adopts a URL joining behavior which isn't RFC-compliant but seems to be more compatible in practice.

v0.1.0 (2021-08-13)

  • use SET_PARAMETERS rather than GET_PARAMETERS for keepalives. The latter doesn't work with GW Security GW4089IP cameras.
  • removed rtcp dependency. Fixes #8. Avoids picking up various transitive dependencies needed by later versions of the rtcp crate, including tokio. (retina's own tokio dependency will likely become optional in a future version.)

v0.0.5 (2021-07-08)

  • BREAKING CHANGE: New opaque error type with more uniform, richer error messages. No more failure dependency.
  • BREAKING CHANGE: retina::client::Stream::parameters now returns parameters by value. This allows shrinking depacketizer types.
  • BREAKING CHANGE: retina::codec::VideoFrame::new_parameters is now boxed. This allows shrinking VideoFrame and CodecItem by 80 bytes each (on 64-bit platforms). The box is only rarely populated.
  • in client mp4 example, handle an initial video parameter change correctly.

v0.0.4 (2021-06-28)

  • bugfix: Retina stopped receiving packets after receiving a keepalive response.

v0.0.3 (2021-06-28)

  • BREAKING CHANGE: Session<Playing> now directly implements Stream instead of through pkts().
  • Performance improvements.

v0.0.2 (2021-06-25)

  • BREAKING CHANGE: Video frames are now provided as a single, contiguous Bytes, and H.264 depacketization is more efficient (#4).

v0.0.1 (2021-06-09)

Initial release.