dvb_si/tables/
mod.rs

1//! SI + PSI table-section parsers.
2//!
3//! Each `*Section` type parses and serializes one wire section. Use
4//! [`crate::collect`] to assemble complete logical tables that span multiple
5//! sections.
6
7/// Running status of an event or service — EN 300 468 Table 6.
8///
9/// Codes 6-7 are reserved for future use and round-tripped transparently via
10/// [`Reserved`](RunningStatus::Reserved).
11///
12/// # Examples
13/// ```
14/// use dvb_si::tables::RunningStatus;
15///
16/// let s = RunningStatus::from_u8(4);
17/// assert_eq!(s.name(), "running");
18/// assert_eq!(s.to_u8(), 4); // lossless back to the wire value
19///
20/// // Unallocated codes are preserved verbatim for byte-identical round-trip.
21/// assert_eq!(RunningStatus::from_u8(6).to_u8(), 6);
22/// ```
23#[derive(Debug, Clone, Copy, PartialEq, Eq)]
24#[cfg_attr(feature = "serde", derive(serde::Serialize))]
25#[non_exhaustive]
26pub enum RunningStatus {
27    /// Value 0 — undefined.
28    Undefined,
29    /// Value 1 — not running.
30    NotRunning,
31    /// Value 2 — starts in a few seconds (e.g. for video recording).
32    StartsInAFewSeconds,
33    /// Value 3 — pausing.
34    Pausing,
35    /// Value 4 — running.
36    Running,
37    /// Value 5 — service off-air.
38    ServiceOffAir,
39    /// Reserved/unallocated wire value, preserved verbatim for round-trip.
40    Reserved(u8),
41}
42
43impl RunningStatus {
44    /// Map any 3-bit value to a `RunningStatus`.
45    #[must_use]
46    pub fn from_u8(v: u8) -> Self {
47        match v & 0x07 {
48            0 => Self::Undefined,
49            1 => Self::NotRunning,
50            2 => Self::StartsInAFewSeconds,
51            3 => Self::Pausing,
52            4 => Self::Running,
53            5 => Self::ServiceOffAir,
54            r => Self::Reserved(r),
55        }
56    }
57
58    /// Return the 3-bit wire value.
59    #[must_use]
60    pub fn to_u8(self) -> u8 {
61        match self {
62            Self::Undefined => 0,
63            Self::NotRunning => 1,
64            Self::StartsInAFewSeconds => 2,
65            Self::Pausing => 3,
66            Self::Running => 4,
67            Self::ServiceOffAir => 5,
68            Self::Reserved(v) => v & 0x07,
69        }
70    }
71
72    /// Human-readable spec name.
73    #[must_use]
74    pub fn name(self) -> &'static str {
75        match self {
76            Self::Undefined => "undefined",
77            Self::NotRunning => "not running",
78            Self::StartsInAFewSeconds => "starts in a few seconds",
79            Self::Pausing => "pausing",
80            Self::Running => "running",
81            Self::ServiceOffAir => "service off-air",
82            Self::Reserved(_) => "reserved",
83        }
84    }
85}
86
87#[cfg(test)]
88mod running_status_tests {
89    use super::*;
90
91    #[test]
92    fn from_u8_maps_known_values() {
93        assert_eq!(RunningStatus::from_u8(0), RunningStatus::Undefined);
94        assert_eq!(RunningStatus::from_u8(1), RunningStatus::NotRunning);
95        assert_eq!(
96            RunningStatus::from_u8(2),
97            RunningStatus::StartsInAFewSeconds
98        );
99        assert_eq!(RunningStatus::from_u8(3), RunningStatus::Pausing);
100        assert_eq!(RunningStatus::from_u8(4), RunningStatus::Running);
101        assert_eq!(RunningStatus::from_u8(5), RunningStatus::ServiceOffAir);
102        assert_eq!(RunningStatus::from_u8(6), RunningStatus::Reserved(6));
103        assert_eq!(RunningStatus::from_u8(7), RunningStatus::Reserved(7));
104    }
105
106    #[test]
107    fn to_u8_from_u8_round_trips_all_byte_values() {
108        for v in 0u8..=0xFFu8 {
109            assert_eq!(RunningStatus::to_u8(RunningStatus::from_u8(v)), v & 0x07);
110        }
111    }
112
113    #[test]
114    fn name_returns_known_strings() {
115        assert_eq!(RunningStatus::Undefined.name(), "undefined");
116        assert_eq!(RunningStatus::NotRunning.name(), "not running");
117        assert_eq!(RunningStatus::Running.name(), "running");
118        assert_eq!(RunningStatus::ServiceOffAir.name(), "service off-air");
119        assert_eq!(RunningStatus::Reserved(6).name(), "reserved");
120    }
121}
122
123/// Byte 1 flags nibble for MPEG-2 PSI long-form sections.
124///
125/// Layout: `section_syntax_indicator(1) | '0'(1) | reserved(2)`.
126/// Per ISO/IEC 13818-1 §2.4.4.10, the second bit is a spec-mandated
127/// zero in PSI tables (PAT, PMT, CAT, TSDT, DSM-CC).
128pub(crate) const SECTION_B1_FLAGS_PSI: u8 = 0xB0;
129
130/// Byte 1 flags nibble for EN 300 468 (DVB) long-form sections.
131///
132/// Layout: `section_syntax_indicator(1) | reserved_future_use(1) | reserved(2)`.
133/// Per ETSI EN 300 468 §5.1.1, the top nibble must be `F` — all four
134/// bits set (SSI=1, rfu=1, reserved=11).
135pub(crate) const SECTION_B1_FLAGS_DVB: u8 = 0xF0;
136
137/// `section_syntax_indicator` bit in long-form section byte 1.
138pub(crate) const SECTION_B1_SSI: u8 = 0x80;
139
140/// Reserved bits `[5:4]` in long-form section byte 1, set to `11`.
141pub(crate) const SECTION_B1_RESERVED_HI: u8 = 0x30;
142
143/// Byte 1 flags nibble for short-form sections (no extension header, no CRC).
144///
145/// Layout: `section_syntax_indicator(0) | reserved_future_use(1) | reserved(11)`.
146/// Top nibble `0b0111` = `0x70`. Used by RST, ST, DIT, TDT, TOT.
147pub(crate) const SECTION_B1_FLAGS_SHORT: u8 = 0x70;
148
149/// Validate a section_length field and compute the total encoded length.
150///
151/// Returns `total` (= `header_len + section_length`) on success, or
152/// `Err(SectionLengthOverflow)` when the declared `section_length` would
153/// make `total` smaller than `min_total` or larger than `bytes_len`.
154///
155/// Every table's `Parse` implementation should call this immediately after
156/// extracting `section_length` from bytes 1-2, passing the appropriate
157/// constants for that table type.
158pub(crate) fn check_section_length(
159    bytes_len: usize,
160    header_len: usize,
161    section_length: usize,
162    min_total: usize,
163) -> crate::Result<usize> {
164    let total = header_len + section_length;
165    if bytes_len < total || total < min_total {
166        return Err(crate::error::Error::SectionLengthOverflow {
167            declared: section_length,
168            available: bytes_len.saturating_sub(header_len),
169        });
170    }
171    Ok(total)
172}
173
174pub mod any;
175pub use any::AnyTableSection;
176
177pub mod registry;
178pub use registry::{TableObject, TableRegistry};
179
180pub mod ait;
181pub mod bat;
182pub mod cat;
183pub mod cit;
184pub mod container;
185pub mod dit;
186pub mod downloadable_font_info;
187pub mod dsmcc;
188pub mod eit;
189pub mod int;
190pub mod mpe;
191pub mod mpe_fec;
192pub mod mpe_ifec;
193pub mod nit;
194pub mod pat;
195pub mod pmt;
196pub mod protection_message;
197pub mod rct;
198pub mod rnt;
199pub mod rst;
200pub mod sat;
201pub mod sdt;
202pub mod sit;
203pub mod st;
204pub mod tdt;
205pub mod tot;
206pub mod tsdt;
207pub mod unt;
dvb_si/tables/mod.rs

dvb_si/tables/
mod.rs
