Skip to main content

dvb_si/descriptors/
content.rs

1//! Content Descriptor โ€” ETSI EN 300 468 ยง6.2.9 (tag 0x54).
2//!
3//! Carried inside EIT. Classifies the event's genre via a two-nibble
4//! content type plus an 8-bit broadcaster-specific user byte.
5
6use crate::error::{Error, Result};
7use crate::traits::Descriptor;
8use dvb_common::{Parse, Serialize};
9
10/// Descriptor tag for content_descriptor.
11pub const TAG: u8 = 0x54;
12const HEADER_LEN: usize = 2;
13const ENTRY_LEN: usize = 2;
14
15/// One content classification entry.
16#[derive(Debug, Clone, Copy, PartialEq, Eq)]
17#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
18pub struct ContentEntry {
19    /// content_nibble_level_1 (4 bits) โ€” broad genre (ETSI Table 29).
20    pub nibble_1: u8,
21    /// content_nibble_level_2 (4 bits) โ€” sub-genre.
22    pub nibble_2: u8,
23    /// Broadcaster-specific user byte.
24    pub user_byte: u8,
25}
26
27/// Content Descriptor.
28#[derive(Debug, Clone, PartialEq, Eq)]
29#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
30pub struct ContentDescriptor {
31    /// Entries in wire order. EIT events can carry multiple genre entries.
32    pub entries: Vec<ContentEntry>,
33}
34
35impl<'a> Parse<'a> for ContentDescriptor {
36    type Error = crate::error::Error;
37    fn parse(bytes: &'a [u8]) -> Result<Self> {
38        if bytes.len() < HEADER_LEN {
39            return Err(Error::BufferTooShort {
40                need: HEADER_LEN,
41                have: bytes.len(),
42                what: "ContentDescriptor header",
43            });
44        }
45
46        if bytes[0] != TAG {
47            return Err(Error::InvalidDescriptor {
48                tag: bytes[0],
49                reason: "unexpected tag for ContentDescriptor",
50            });
51        }
52
53        let length = bytes[1] as usize;
54        let body_start = HEADER_LEN;
55        let body_end = body_start + length;
56
57        if bytes.len() < body_end {
58            return Err(Error::BufferTooShort {
59                need: body_end,
60                have: bytes.len(),
61                what: "ContentDescriptor body",
62            });
63        }
64
65        if length % 2 != 0 {
66            return Err(Error::InvalidDescriptor {
67                tag: TAG,
68                reason: "descriptor_length must be a multiple of 2",
69            });
70        }
71
72        let body = &bytes[body_start..body_end];
73        let mut entries = Vec::with_capacity(length / ENTRY_LEN);
74
75        for chunk in body.chunks_exact(ENTRY_LEN) {
76            entries.push(ContentEntry {
77                nibble_1: chunk[0] >> 4,
78                nibble_2: chunk[0] & 0x0F,
79                user_byte: chunk[1],
80            });
81        }
82
83        Ok(Self { entries })
84    }
85}
86
87impl Serialize for ContentDescriptor {
88    type Error = crate::error::Error;
89    fn serialized_len(&self) -> usize {
90        HEADER_LEN + self.entries.len() * ENTRY_LEN
91    }
92
93    fn serialize_into(&self, buf: &mut [u8]) -> Result<usize> {
94        let len = self.serialized_len();
95        if buf.len() < len {
96            return Err(Error::OutputBufferTooSmall {
97                need: len,
98                have: buf.len(),
99            });
100        }
101        buf[0] = TAG;
102        buf[1] = (len - HEADER_LEN) as u8;
103        let mut pos = HEADER_LEN;
104        for entry in &self.entries {
105            buf[pos] = (entry.nibble_1 << 4) | entry.nibble_2;
106            buf[pos + 1] = entry.user_byte;
107            pos += ENTRY_LEN;
108        }
109        Ok(len)
110    }
111}
112
113impl<'a> Descriptor<'a> for ContentDescriptor {
114    const TAG: u8 = TAG;
115    fn descriptor_length(&self) -> u8 {
116        (self.serialized_len() - HEADER_LEN) as u8
117    }
118}
119
120#[cfg(test)]
121mod tests {
122    use super::*;
123
124    #[test]
125    fn parse_single_entry_extracts_nibbles_and_user_byte() {
126        let result = ContentDescriptor::parse(&[TAG, 2, 0x31, 0xFF]).unwrap();
127        assert_eq!(result.entries.len(), 1);
128        let e = result.entries[0];
129        assert_eq!(e.nibble_1, 3);
130        assert_eq!(e.nibble_2, 1);
131        assert_eq!(e.user_byte, 0xFF);
132    }
133
134    #[test]
135    fn parse_multiple_entries_preserves_order() {
136        let bytes = [TAG, 6, 0x31, 0xAA, 0x42, 0xBB, 0x53, 0xCC];
137        let result = ContentDescriptor::parse(&bytes).unwrap();
138        assert_eq!(result.entries.len(), 3);
139        assert_eq!(result.entries[0].nibble_1, 3);
140        assert_eq!(result.entries[0].nibble_2, 1);
141        assert_eq!(result.entries[0].user_byte, 0xAA);
142        assert_eq!(result.entries[1].nibble_1, 4);
143        assert_eq!(result.entries[1].nibble_2, 2);
144        assert_eq!(result.entries[1].user_byte, 0xBB);
145        assert_eq!(result.entries[2].nibble_1, 5);
146        assert_eq!(result.entries[2].nibble_2, 3);
147        assert_eq!(result.entries[2].user_byte, 0xCC);
148    }
149
150    #[test]
151    fn parse_rejects_wrong_tag() {
152        assert!(matches!(
153            ContentDescriptor::parse(&[0x55, 2, 0x00, 0x00]).unwrap_err(),
154            Error::InvalidDescriptor { tag: 0x55, .. }
155        ));
156    }
157
158    #[test]
159    fn parse_rejects_short_header() {
160        assert!(matches!(
161            ContentDescriptor::parse(&[TAG]).unwrap_err(),
162            Error::BufferTooShort { .. }
163        ));
164    }
165
166    #[test]
167    fn parse_rejects_body_truncation() {
168        // length=4 means body is 4 bytes, but only 1 byte follows header
169        assert!(matches!(
170            ContentDescriptor::parse(&[TAG, 4, 0x01]).unwrap_err(),
171            Error::BufferTooShort { .. }
172        ));
173    }
174
175    #[test]
176    fn parse_rejects_length_not_multiple_of_2() {
177        // length=3 is odd, can't form complete entries
178        assert!(matches!(
179            ContentDescriptor::parse(&[TAG, 3, 0x01, 0x02, 0x03]).unwrap_err(),
180            Error::InvalidDescriptor { .. }
181        ));
182    }
183
184    #[test]
185    fn serialize_round_trip() {
186        let original = ContentDescriptor {
187            entries: vec![
188                ContentEntry {
189                    nibble_1: 3,
190                    nibble_2: 1,
191                    user_byte: 0xAA,
192                },
193                ContentEntry {
194                    nibble_1: 4,
195                    nibble_2: 2,
196                    user_byte: 0xBB,
197                },
198            ],
199        };
200        let mut buf = vec![0u8; original.serialized_len()];
201        original.serialize_into(&mut buf).unwrap();
202        let parsed = ContentDescriptor::parse(&buf).unwrap();
203        assert_eq!(parsed, original);
204    }
205
206    #[test]
207    fn empty_descriptor_valid() {
208        let bytes = [TAG, 0];
209        let result = ContentDescriptor::parse(&bytes).unwrap();
210        assert!(result.entries.is_empty());
211    }
212}