rtp-packet 0.4.0

RTP fixed header + CSRC list + generic header extension (RFC 3550 §5.1/§5.3.1) — spec-complete parse/serialize, no_std.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

# rtp-packet

[![Crates.io](https://img.shields.io/crates/v/rtp-packet.svg)](https://crates.io/crates/rtp-packet)
[![docs.rs](https://img.shields.io/docsrs/rtp-packet)](https://docs.rs/rtp-packet)

RFC 3550 §5.1 RTP fixed header + CSRC list + §5.3.1 generic header extension —
spec-complete parse/serialize, `no_std`.

`rtp-packet` is a shared low-level wire crate (in the same spirit as
`mpeg-ts`/`mpeg-pes`/`mpeg-ps`): a single, spec-complete implementation of the
RTP fixed header meant to be consumed by every higher-level crate that speaks
RTP (`transmux`'s RTP spoke today; the upcoming SMPTE ST 2110-40 ANC-over-RTP
work next), instead of each crate re-implementing its own header codec.

- **[`RtpPacket`]** — version (validated `== 2` on parse, always written `2`
  on serialize), padding (the trailing pad-count octet correctly
  stripped/re-appended), the CSRC identifier list (0–15 entries, `CC` always
  derived from the list length), marker, payload type, sequence number,
  timestamp, SSRC, an optional [`HeaderExtension`], and the payload.
- **[`HeaderExtension`]** — the §5.3.1 generic header extension: a 16-bit
  profile-specific identifier + opaque profile-specific data (the `length`
  field, in 32-bit words, is always derived from the data length).

See `docs/rtp-header.md` for the curated RFC 3550 §5.1/§5.3.1 transcription
this crate implements field-for-field.

The optional `rfc8285` feature adds `rfc8285::parse_extensions`, decoding
[RFC 8285](https://www.rfc-editor.org/rfc/rfc8285.txt)'s one-byte/two-byte
multiplexed extension elements out of a `HeaderExtension`'s opaque `data`
(the profile-specific interpretation RFC 3550 itself leaves to the
profile). See `docs/rfc8285_header_ext.md` for the curated transcription.

`#![no_std]` + `alloc`; depends only on `broadcast-common`.

## Quick start

```rust
use broadcast_common::{Parse, Serialize};
use rtp_packet::RtpPacket;

let pkt = RtpPacket {
    marker: true,
    payload_type: 96,
    sequence_number: 1,
    timestamp: 3600,
    ssrc: 0x1234_5678,
    csrc: vec![],
    extension: None,
    padding: None,
    payload: &[0xDE, 0xAD, 0xBE, 0xEF],
};
let mut bytes = vec![0u8; pkt.serialized_len()];
pkt.serialize_into(&mut bytes).unwrap();
assert_eq!(RtpPacket::parse(&bytes).unwrap(), pkt);
```

## Examples

```sh
cargo run -p rtp-packet --example build_packet
cargo run -p rtp-packet --example parse_packet
cargo run -p rtp-packet --example rfc8285_extensions --features rfc8285
```

## Features

| Feature   | Default | Description |
|-----------|---------|-------------|
| `std`     | yes     | Link the standard library. Without it the crate is `#![no_std]` + `alloc`. |
| `serde`   | no      | `serde::Serialize` derives on public types. |
| `rfc8285` | no      | RFC 8285 one-byte/two-byte multiplexed header-extension element decoding (`rfc8285` module). |

## Minimum Supported Rust Version

1.95.0

## License

MIT OR Apache-2.0