dvb_si/descriptors/
component.rs

1//! Component Descriptor — ETSI EN 300 468 §6.2.8 (tag 0x50).
2//!
3//! Describes one elementary component (audio/video/data/teletext/subtitle)
4//! with a language code and free-text label. Carried inside EIT event
5//! descriptor loops.
6
7use crate::error::{Error, Result};
8use crate::text::{DvbText, LangCode};
9use crate::traits::Descriptor;
10use dvb_common::{Parse, Serialize};
11
12/// Descriptor tag for component_descriptor.
13pub const TAG: u8 = 0x50;
14const HEADER_LEN: usize = 2;
15/// stream_content(1) + component_type(1) + component_tag(1) + language_code(3) = 6
16const PRE_TEXT_LEN: usize = 6;
17const STREAM_CONTENT_MASK: u8 = 0x0F;
18
19/// Component Descriptor.
20#[derive(Debug, Clone, PartialEq, Eq)]
21#[cfg_attr(feature = "serde", derive(serde::Serialize))]
22pub struct ComponentDescriptor<'a> {
23    /// 4-bit stream_content_ext (high nibble) — combines with `stream_content`
24    /// to identify the component (EN 300 468 §6.2.8 Table 25).
25    pub stream_content_ext: u8,
26    /// 4-bit stream_content (0x01 video, 0x02 audio, 0x03 teletext, …).
27    pub stream_content: u8,
28    /// component_type byte (sub-classification inside the stream_content).
29    pub component_type: u8,
30    /// component_tag for cross-reference with stream_identifier_descriptor.
31    pub component_tag: u8,
32    /// ISO 639-2 language code.
33    pub language_code: LangCode,
34    /// DVB Annex-A encoded text label for this component.
35    pub text: DvbText<'a>,
36}
37
38impl<'a> Parse<'a> for ComponentDescriptor<'a> {
39    type Error = crate::error::Error;
40    fn parse(bytes: &'a [u8]) -> Result<Self> {
41        if bytes.len() < HEADER_LEN {
42            return Err(Error::BufferTooShort {
43                need: HEADER_LEN,
44                have: bytes.len(),
45                what: "ComponentDescriptor header",
46            });
47        }
48        if bytes[0] != TAG {
49            return Err(Error::InvalidDescriptor {
50                tag: bytes[0],
51                reason: "unexpected tag for component_descriptor",
52            });
53        }
54        let length = bytes[1] as usize;
55        let end = HEADER_LEN + length;
56        if bytes.len() < end {
57            return Err(Error::BufferTooShort {
58                need: end,
59                have: bytes.len(),
60                what: "ComponentDescriptor body",
61            });
62        }
63        if length < PRE_TEXT_LEN {
64            return Err(Error::InvalidDescriptor {
65                tag: TAG,
66                reason: "component_descriptor body shorter than minimum 6 bytes",
67            });
68        }
69        let stream_content_ext = bytes[HEADER_LEN] >> 4;
70        let stream_content = bytes[HEADER_LEN] & STREAM_CONTENT_MASK;
71        let component_type = bytes[HEADER_LEN + 1];
72        let component_tag = bytes[HEADER_LEN + 2];
73        let language_code = LangCode([
74            bytes[HEADER_LEN + 3],
75            bytes[HEADER_LEN + 4],
76            bytes[HEADER_LEN + 5],
77        ]);
78        let text = DvbText::new(&bytes[HEADER_LEN + PRE_TEXT_LEN..end]);
79        Ok(Self {
80            stream_content_ext,
81            stream_content,
82            component_type,
83            component_tag,
84            language_code,
85            text,
86        })
87    }
88}
89
90impl Serialize for ComponentDescriptor<'_> {
91    type Error = crate::error::Error;
92    fn serialized_len(&self) -> usize {
93        HEADER_LEN + PRE_TEXT_LEN + self.text.len()
94    }
95
96    fn serialize_into(&self, buf: &mut [u8]) -> Result<usize> {
97        let len = self.serialized_len();
98        if buf.len() < len {
99            return Err(Error::OutputBufferTooSmall {
100                need: len,
101                have: buf.len(),
102            });
103        }
104        buf[0] = TAG;
105        buf[1] = (len - HEADER_LEN) as u8;
106        // High nibble = stream_content_ext, low nibble = stream_content (§6.2.8).
107        buf[HEADER_LEN] =
108            (self.stream_content_ext << 4) | (self.stream_content & STREAM_CONTENT_MASK);
109        buf[HEADER_LEN + 1] = self.component_type;
110        buf[HEADER_LEN + 2] = self.component_tag;
111        buf[HEADER_LEN + 3..HEADER_LEN + 6].copy_from_slice(&self.language_code.0);
112        buf[HEADER_LEN + PRE_TEXT_LEN..len].copy_from_slice(self.text.raw());
113        Ok(len)
114    }
115}
116
117impl<'a> Descriptor<'a> for ComponentDescriptor<'a> {
118    const TAG: u8 = TAG;
119    fn descriptor_length(&self) -> u8 {
120        (self.serialized_len() - HEADER_LEN) as u8
121    }
122}
123
124impl<'a> crate::traits::DescriptorDef<'a> for ComponentDescriptor<'a> {
125    const TAG: u8 = TAG;
126    const NAME: &'static str = "COMPONENT";
127}
128
129#[cfg(test)]
130mod tests {
131    use super::*;
132
133    #[test]
134    fn parse_extracts_all_fields() {
135        let bytes = [
136            TAG, 12, 0x02, 0x01, 0x42, b'e', b'n', b'g', b'S', b'T', b'E', b'R', b'E', b'O',
137        ];
138        let d = ComponentDescriptor::parse(&bytes).unwrap();
139        assert_eq!(d.stream_content, 2);
140        assert_eq!(d.component_type, 0x01);
141        assert_eq!(d.component_tag, 0x42);
142        assert_eq!(d.language_code, LangCode(*b"eng"));
143        assert_eq!(d.text.raw(), b"STEREO");
144    }
145
146    #[test]
147    fn parse_rejects_wrong_tag() {
148        assert!(matches!(
149            ComponentDescriptor::parse(&[0x51, 6, 0, 0, 0, b'e', b'n', b'g']).unwrap_err(),
150            Error::InvalidDescriptor { tag: 0x51, .. }
151        ));
152    }
153
154    #[test]
155    fn parse_rejects_short_body() {
156        let bytes = [TAG, 5, 0x01, 0x00, 0x00, b'e', b'n'];
157        assert!(matches!(
158            ComponentDescriptor::parse(&bytes).unwrap_err(),
159            Error::InvalidDescriptor { .. }
160        ));
161    }
162
163    #[test]
164    fn parse_rejects_truncated_buffer() {
165        let bytes = [TAG, 6, 0x01];
166        assert!(matches!(
167            ComponentDescriptor::parse(&bytes).unwrap_err(),
168            Error::BufferTooShort { .. }
169        ));
170    }
171
172    #[test]
173    fn parse_with_empty_text_valid() {
174        let bytes = [TAG, 6, 0x01, 0x01, 0x01, b'e', b'n', b'g'];
175        let d = ComponentDescriptor::parse(&bytes).unwrap();
176        assert!(d.text.raw().is_empty());
177    }
178
179    #[test]
180    fn serialize_round_trip() {
181        let d = ComponentDescriptor {
182            stream_content_ext: 0x0F,
183            stream_content: 0x03,
184            component_type: 0x10,
185            component_tag: 0x05,
186            language_code: LangCode(*b"fra"),
187            text: DvbText::new(b"Sous-titres"),
188        };
189        let mut buf = vec![0u8; d.serialized_len()];
190        d.serialize_into(&mut buf).unwrap();
191        assert_eq!(ComponentDescriptor::parse(&buf).unwrap(), d);
192    }
193
194    #[test]
195    fn stream_content_masked_to_low_nibble() {
196        // Byte = 0xF2 → high nibble is stream_content_ext (0xF), low nibble is stream_content=2.
197        let bytes = [TAG, 6, 0xF2, 0x00, 0x00, b'e', b'n', b'g'];
198        let d = ComponentDescriptor::parse(&bytes).unwrap();
199        assert_eq!(d.stream_content, 2);
200    }
201}
dvb_si/descriptors/component.rs

dvb_si/descriptors/
component.rs
