dvb_si/descriptors/
extended_event.rs

1//! Extended Event Descriptor — ETSI EN 300 468 §6.2.16 (tag 0x4E).
2//!
3//! Carried inside EIT. Provides the full event description split across
4//! descriptor_number / last_descriptor_number fragments. Each fragment
5//! contributes text plus an optional list of (item_description, item) pairs.
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 extended_event_descriptor.
13pub const TAG: u8 = 0x4E;
14const HEADER_LEN: usize = 2;
15const NUMBERS_LEN: usize = 1;
16const LANG_LEN: usize = 3;
17const ITEMS_LEN_FIELD: usize = 1;
18const TEXT_LEN_FIELD: usize = 1;
19
20/// One (description, value) item — e.g. "Director" → "Alice Smith".
21#[derive(Debug, Clone, PartialEq, Eq)]
22#[cfg_attr(feature = "serde", derive(serde::Serialize))]
23#[cfg_attr(feature = "yoke", derive(yoke::Yokeable))]
24pub struct ExtendedEventItem<'a> {
25    /// DVB Annex-A encoded item description.
26    pub description: DvbText<'a>,
27    /// DVB Annex-A encoded item value.
28    pub value: DvbText<'a>,
29}
30
31/// Extended Event Descriptor.
32#[derive(Debug, Clone, PartialEq, Eq)]
33#[cfg_attr(feature = "serde", derive(serde::Serialize))]
34#[cfg_attr(feature = "yoke", derive(yoke::Yokeable))]
35pub struct ExtendedEventDescriptor<'a> {
36    /// 0-based fragment index within the extended event series.
37    pub descriptor_number: u8,
38    /// Index of the final fragment in the series (0-based).
39    pub last_descriptor_number: u8,
40    /// ISO 639-2 language code.
41    pub language_code: LangCode,
42    /// Item list.
43    pub items: Vec<ExtendedEventItem<'a>>,
44    /// DVB Annex-A encoded extended text.
45    pub text: DvbText<'a>,
46}
47
48impl<'a> Parse<'a> for ExtendedEventDescriptor<'a> {
49    type Error = crate::error::Error;
50    fn parse(bytes: &'a [u8]) -> Result<Self> {
51        let min_len = HEADER_LEN + NUMBERS_LEN + LANG_LEN + ITEMS_LEN_FIELD + TEXT_LEN_FIELD;
52        if bytes.len() < min_len {
53            return Err(Error::BufferTooShort {
54                need: min_len,
55                have: bytes.len(),
56                what: "ExtendedEventDescriptor header",
57            });
58        }
59        if bytes[0] != TAG {
60            return Err(Error::InvalidDescriptor {
61                tag: bytes[0],
62                reason: "unexpected tag for extended_event_descriptor",
63            });
64        }
65        let length = bytes[1] as usize;
66        let end = HEADER_LEN + length;
67        if bytes.len() < end {
68            return Err(Error::BufferTooShort {
69                need: end,
70                have: bytes.len(),
71                what: "ExtendedEventDescriptor body",
72            });
73        }
74        let numbers_byte = bytes[2];
75        let descriptor_number = numbers_byte >> 4;
76        let last_descriptor_number = numbers_byte & 0x0F;
77        let language_code = LangCode([bytes[3], bytes[4], bytes[5]]);
78
79        let items_len_pos = HEADER_LEN + NUMBERS_LEN + LANG_LEN;
80        let items_length = bytes[items_len_pos] as usize;
81        let items_start = items_len_pos + ITEMS_LEN_FIELD;
82        let items_end = items_start + items_length;
83        if items_end + TEXT_LEN_FIELD > end {
84            return Err(Error::InvalidDescriptor {
85                tag: TAG,
86                reason: "length_of_items runs past descriptor end",
87            });
88        }
89
90        let mut items = Vec::new();
91        let mut pos = items_start;
92        while pos < items_end {
93            if pos >= items_end {
94                break;
95            }
96            let desc_len = bytes[pos] as usize;
97            let desc_start = pos + 1;
98            let desc_end = desc_start + desc_len;
99            if desc_end + 1 > items_end {
100                return Err(Error::InvalidDescriptor {
101                    tag: TAG,
102                    reason: "item_description_length runs past items loop",
103                });
104            }
105            let value_len = bytes[desc_end] as usize;
106            let value_start = desc_end + 1;
107            let value_end = value_start + value_len;
108            if value_end > items_end {
109                return Err(Error::InvalidDescriptor {
110                    tag: TAG,
111                    reason: "item_length runs past items loop",
112                });
113            }
114            items.push(ExtendedEventItem {
115                description: DvbText::new(&bytes[desc_start..desc_end]),
116                value: DvbText::new(&bytes[value_start..value_end]),
117            });
118            pos = value_end;
119        }
120
121        let text_len = bytes[items_end] as usize;
122        let text_start = items_end + TEXT_LEN_FIELD;
123        let text_end = text_start + text_len;
124        if text_end > end {
125            return Err(Error::InvalidDescriptor {
126                tag: TAG,
127                reason: "text_length runs past descriptor end",
128            });
129        }
130        let text = DvbText::new(&bytes[text_start..text_end]);
131
132        Ok(Self {
133            descriptor_number,
134            last_descriptor_number,
135            language_code,
136            items,
137            text,
138        })
139    }
140}
141
142impl Serialize for ExtendedEventDescriptor<'_> {
143    type Error = crate::error::Error;
144    fn serialized_len(&self) -> usize {
145        let items_bytes: usize = self
146            .items
147            .iter()
148            .map(|i| 1 + i.description.len() + 1 + i.value.len())
149            .sum();
150        HEADER_LEN
151            + NUMBERS_LEN
152            + LANG_LEN
153            + ITEMS_LEN_FIELD
154            + items_bytes
155            + TEXT_LEN_FIELD
156            + self.text.len()
157    }
158
159    fn serialize_into(&self, buf: &mut [u8]) -> Result<usize> {
160        let len = self.serialized_len();
161        if buf.len() < len {
162            return Err(Error::OutputBufferTooSmall {
163                need: len,
164                have: buf.len(),
165            });
166        }
167        buf[0] = TAG;
168        buf[1] = (len - HEADER_LEN) as u8;
169        buf[2] = ((self.descriptor_number & 0x0F) << 4) | (self.last_descriptor_number & 0x0F);
170        buf[3..6].copy_from_slice(&self.language_code.0);
171
172        let items_bytes: usize = self
173            .items
174            .iter()
175            .map(|i| 1 + i.description.len() + 1 + i.value.len())
176            .sum();
177        buf[6] = items_bytes as u8;
178
179        let mut pos = 7;
180        for item in &self.items {
181            buf[pos] = item.description.len() as u8;
182            let d_start = pos + 1;
183            let d_end = d_start + item.description.len();
184            buf[d_start..d_end].copy_from_slice(item.description.raw());
185            buf[d_end] = item.value.len() as u8;
186            let v_start = d_end + 1;
187            let v_end = v_start + item.value.len();
188            buf[v_start..v_end].copy_from_slice(item.value.raw());
189            pos = v_end;
190        }
191        buf[pos] = self.text.len() as u8;
192        buf[pos + 1..pos + 1 + self.text.len()].copy_from_slice(self.text.raw());
193        Ok(len)
194    }
195}
196
197impl<'a> Descriptor<'a> for ExtendedEventDescriptor<'a> {
198    const TAG: u8 = TAG;
199    fn descriptor_length(&self) -> u8 {
200        (self.serialized_len() - HEADER_LEN) as u8
201    }
202}
203
204impl<'a> crate::traits::DescriptorDef<'a> for ExtendedEventDescriptor<'a> {
205    const TAG: u8 = TAG;
206    const NAME: &'static str = "EXTENDED_EVENT";
207}
208
209#[cfg(test)]
210mod tests {
211    use super::*;
212
213    fn build(
214        descriptor_number: u8,
215        last_descriptor_number: u8,
216        lang: [u8; 3],
217        items: &[(&[u8], &[u8])],
218        text: &[u8],
219    ) -> Vec<u8> {
220        let items_bytes: Vec<u8> = items
221            .iter()
222            .flat_map(|(d, v)| {
223                let mut x = Vec::with_capacity(2 + d.len() + v.len());
224                x.push(d.len() as u8);
225                x.extend_from_slice(d);
226                x.push(v.len() as u8);
227                x.extend_from_slice(v);
228                x
229            })
230            .collect();
231        let body_len = NUMBERS_LEN
232            + LANG_LEN
233            + ITEMS_LEN_FIELD
234            + items_bytes.len()
235            + TEXT_LEN_FIELD
236            + text.len();
237        let mut v = Vec::with_capacity(HEADER_LEN + body_len);
238        v.push(TAG);
239        v.push(body_len as u8);
240        v.push(((descriptor_number & 0x0F) << 4) | (last_descriptor_number & 0x0F));
241        v.extend_from_slice(&lang);
242        v.push(items_bytes.len() as u8);
243        v.extend_from_slice(&items_bytes);
244        v.push(text.len() as u8);
245        v.extend_from_slice(text);
246        v
247    }
248
249    #[test]
250    fn parse_extracts_numbers_language_and_text() {
251        let bytes = build(2, 3, *b"fra", &[], b"Hello");
252        let d = ExtendedEventDescriptor::parse(&bytes).unwrap();
253        assert_eq!(d.descriptor_number, 2);
254        assert_eq!(d.last_descriptor_number, 3);
255        assert_eq!(d.language_code, LangCode(*b"fra"));
256        assert_eq!(d.text.raw(), b"Hello");
257        assert_eq!(d.items.len(), 0);
258    }
259
260    #[test]
261    fn parse_extracts_item_list() {
262        let items: [(&[u8], &[u8]); 2] = [(b"Director", b"Alice"), (b"Year", b"2023")];
263        let bytes = build(0, 0, *b"eng", &items, b"");
264        let d = ExtendedEventDescriptor::parse(&bytes).unwrap();
265        assert_eq!(d.items.len(), 2);
266        assert_eq!(d.items[0].description.raw(), b"Director");
267        assert_eq!(d.items[0].value.raw(), b"Alice");
268        assert_eq!(d.items[1].description.raw(), b"Year");
269        assert_eq!(d.items[1].value.raw(), b"2023");
270    }
271
272    #[test]
273    fn parse_rejects_wrong_tag() {
274        // Full 8-byte descriptor with the wrong tag — must fail with tag mismatch.
275        let bytes = [0x4D, 6, 0x00, b'e', b'n', b'g', 0, 0];
276        assert!(matches!(
277            ExtendedEventDescriptor::parse(&bytes).unwrap_err(),
278            Error::InvalidDescriptor { tag: 0x4D, .. }
279        ));
280    }
281
282    #[test]
283    fn parse_rejects_short_header() {
284        assert!(matches!(
285            ExtendedEventDescriptor::parse(&[TAG, 2, 0, 0]).unwrap_err(),
286            Error::BufferTooShort { .. }
287        ));
288    }
289
290    #[test]
291    fn parse_rejects_item_length_overrun() {
292        // items_length=10 but body only 6 bytes after the items_length field.
293        let bytes = [
294            TAG, 11, 0x00, b'e', b'n', b'g', 10, // items_length claims 10 bytes
295            0, 0, 0, 0, 0, // only 5 bytes of items
296            0, // text_length (partially unreachable)
297        ];
298        assert!(matches!(
299            ExtendedEventDescriptor::parse(&bytes).unwrap_err(),
300            Error::InvalidDescriptor { .. }
301        ));
302    }
303
304    #[test]
305    fn parse_rejects_text_length_overrun() {
306        // body=6: numbers + lang + items_length=0 + text_length=5 but no text bytes.
307        let bytes = [TAG, 6, 0x00, b'e', b'n', b'g', 0, 5];
308        assert!(matches!(
309            ExtendedEventDescriptor::parse(&bytes).unwrap_err(),
310            Error::InvalidDescriptor { .. }
311        ));
312    }
313
314    #[test]
315    fn empty_items_and_text_valid() {
316        let bytes = build(0, 0, *b"eng", &[], b"");
317        let d = ExtendedEventDescriptor::parse(&bytes).unwrap();
318        assert_eq!(d.items.len(), 0);
319        assert_eq!(d.text.raw(), b"");
320    }
321
322    #[test]
323    fn serialize_round_trip_with_items_and_text() {
324        let items: [(&[u8], &[u8]); 1] = [(b"Genre", b"Drama")];
325        let bytes = build(1, 2, *b"eng", &items, b"Plot summary.");
326        let parsed = ExtendedEventDescriptor::parse(&bytes).unwrap();
327        let mut buf = vec![0u8; parsed.serialized_len()];
328        parsed.serialize_into(&mut buf).unwrap();
329        assert_eq!(buf, bytes);
330        let re = ExtendedEventDescriptor::parse(&buf).unwrap();
331        assert_eq!(parsed, re);
332    }
333
334    #[test]
335    fn serialize_round_trip_without_items() {
336        let bytes = build(3, 3, *b"fra", &[], b"Plot.");
337        let parsed = ExtendedEventDescriptor::parse(&bytes).unwrap();
338        let mut buf = vec![0u8; parsed.serialized_len()];
339        parsed.serialize_into(&mut buf).unwrap();
340        assert_eq!(buf, bytes);
341    }
342}
dvb_si/descriptors/extended_event.rs

dvb_si/descriptors/
extended_event.rs
