dvb_si/descriptors/
transport_stream.rs

1//! Transport Stream Descriptor — ETSI EN 300 468 §6.2.46 (tag 0x67, Table 105, PDF p. 109).
2//!
3//! Carried inside the NIT transport_stream_loop. The body is a raw byte
4//! sequence "for indication of DVB compliance" — a single
5//! `for (i=0;i<N;i++) { byte }` loop with no internal structure (Table 105).
6//! The de-facto convention is the three ASCII bytes `b"DVB"`, but the spec
7//! defines no semantics so we preserve the raw bytes verbatim.
8
9use crate::error::{Error, Result};
10use crate::traits::Descriptor;
11use dvb_common::{Parse, Serialize};
12
13/// Descriptor tag for transport_stream_descriptor.
14pub const TAG: u8 = 0x67;
15/// Length of the header (tag byte + length byte).
16pub const HEADER_LEN: usize = 2;
17
18/// Transport Stream Descriptor.
19#[derive(Debug, Clone, PartialEq, Eq)]
20#[cfg_attr(feature = "serde", derive(serde::Serialize))]
21pub struct TransportStreamDescriptor<'a> {
22    /// Raw `byte` loop — DVB-compliance marker (conventionally `b"DVB"`).
23    pub bytes: &'a [u8],
24}
25
26impl<'a> Parse<'a> for TransportStreamDescriptor<'a> {
27    type Error = crate::error::Error;
28    fn parse(bytes: &'a [u8]) -> Result<Self> {
29        if bytes.len() < HEADER_LEN {
30            return Err(Error::BufferTooShort {
31                need: HEADER_LEN,
32                have: bytes.len(),
33                what: "TransportStreamDescriptor header",
34            });
35        }
36        if bytes[0] != TAG {
37            return Err(Error::InvalidDescriptor {
38                tag: bytes[0],
39                reason: "unexpected tag for transport_stream_descriptor",
40            });
41        }
42        let length = bytes[1] as usize;
43        let end = HEADER_LEN + length;
44        if bytes.len() < end {
45            return Err(Error::BufferTooShort {
46                need: end,
47                have: bytes.len(),
48                what: "TransportStreamDescriptor body",
49            });
50        }
51        Ok(Self {
52            bytes: &bytes[HEADER_LEN..end],
53        })
54    }
55}
56
57impl Serialize for TransportStreamDescriptor<'_> {
58    type Error = crate::error::Error;
59    fn serialized_len(&self) -> usize {
60        HEADER_LEN + self.bytes.len()
61    }
62
63    fn serialize_into(&self, buf: &mut [u8]) -> Result<usize> {
64        if self.bytes.len() > u8::MAX as usize {
65            return Err(Error::InvalidDescriptor {
66                tag: TAG,
67                reason: "transport_stream_descriptor body exceeds 255 bytes",
68            });
69        }
70        let len = self.serialized_len();
71        if buf.len() < len {
72            return Err(Error::OutputBufferTooSmall {
73                need: len,
74                have: buf.len(),
75            });
76        }
77        buf[0] = TAG;
78        buf[1] = self.bytes.len() as u8;
79        buf[HEADER_LEN..len].copy_from_slice(self.bytes);
80        Ok(len)
81    }
82}
83
84impl<'a> Descriptor<'a> for TransportStreamDescriptor<'a> {
85    const TAG: u8 = TAG;
86    fn descriptor_length(&self) -> u8 {
87        self.bytes.len() as u8
88    }
89}
90
91impl<'a> crate::traits::DescriptorDef<'a> for TransportStreamDescriptor<'a> {
92    const TAG: u8 = TAG;
93    const NAME: &'static str = "TRANSPORT_STREAM";
94}
95
96#[cfg(test)]
97mod tests {
98    use super::*;
99
100    #[test]
101    fn parse_extracts_dvb_marker() {
102        let bytes = [TAG, 3, b'D', b'V', b'B'];
103        let d = TransportStreamDescriptor::parse(&bytes).unwrap();
104        assert_eq!(d.bytes, b"DVB");
105    }
106
107    #[test]
108    fn empty_body_is_valid() {
109        let bytes = [TAG, 0];
110        let d = TransportStreamDescriptor::parse(&bytes).unwrap();
111        assert!(d.bytes.is_empty());
112    }
113
114    #[test]
115    fn parse_rejects_wrong_tag() {
116        assert!(matches!(
117            TransportStreamDescriptor::parse(&[0x68, 0]).unwrap_err(),
118            Error::InvalidDescriptor { tag: 0x68, .. }
119        ));
120    }
121
122    #[test]
123    fn parse_rejects_short_header() {
124        assert!(matches!(
125            TransportStreamDescriptor::parse(&[TAG]).unwrap_err(),
126            Error::BufferTooShort { .. }
127        ));
128    }
129
130    #[test]
131    fn parse_rejects_length_overrunning_buffer() {
132        let bytes = [TAG, 5, 1, 2, 3];
133        assert!(matches!(
134            TransportStreamDescriptor::parse(&bytes).unwrap_err(),
135            Error::BufferTooShort { .. }
136        ));
137    }
138
139    #[test]
140    fn serialize_round_trip() {
141        let d = TransportStreamDescriptor { bytes: b"DVB" };
142        let mut buf = vec![0u8; d.serialized_len()];
143        d.serialize_into(&mut buf).unwrap();
144        assert_eq!(TransportStreamDescriptor::parse(&buf).unwrap(), d);
145    }
146
147    #[test]
148    fn serialize_rejects_too_small_buffer() {
149        let d = TransportStreamDescriptor { bytes: b"DVB" };
150        let mut buf = vec![0u8; 1];
151        assert!(matches!(
152            d.serialize_into(&mut buf).unwrap_err(),
153            Error::OutputBufferTooSmall { .. }
154        ));
155    }
156
157    #[test]
158    fn serialize_rejects_over_range_body() {
159        let big = vec![0u8; 256];
160        let d = TransportStreamDescriptor { bytes: &big };
161        let mut buf = vec![0u8; d.serialized_len()];
162        assert!(matches!(
163            d.serialize_into(&mut buf).unwrap_err(),
164            Error::InvalidDescriptor { tag: TAG, .. }
165        ));
166    }
167
168    // No JSON serde round-trip test: the borrowed `&[u8]` field cannot
169    // round-trip through serde_json (it serializes a slice as a sequence,
170    // not a borrowed byte array). This matches sibling borrowed-bytes
171    // descriptors (linkage.rs, default_authority.rs, content_identifier.rs),
172    // none of which carry a serde_round_trip test. The serde derive itself
173    // is still exercised by compilation under `--all-features`.
174}
dvb_si/descriptors/transport_stream.rs

dvb_si/descriptors/
transport_stream.rs
