dvb_si/descriptors/
iso_639_language.rs

1//! ISO 639 Language Descriptor — MPEG-2 ISO/IEC 13818-1 §2.6.19 (tag 0x0A).
2
3use super::descriptor_body;
4use crate::error::{Error, Result};
5use crate::text::LangCode;
6use dvb_common::{Parse, Serialize};
7
8/// Descriptor tag for iso_639_language_descriptor.
9pub const TAG: u8 = 0x0A;
10const HEADER_LEN: usize = 2;
11const ENTRY_LEN: usize = 4;
12
13/// Audio type — ISO/IEC 13818-1 §2.6.19 Table 2-63.
14#[derive(Debug, Clone, Copy, PartialEq, Eq)]
15#[cfg_attr(feature = "serde", derive(serde::Serialize))]
16#[non_exhaustive]
17pub enum AudioType {
18    /// 0x00 — undefined.
19    Undefined,
20    /// 0x01 — clean effects.
21    CleanEffects,
22    /// 0x02 — hearing impaired.
23    HearingImpaired,
24    /// 0x03 — visual impaired commentary.
25    VisualImpairedCommentary,
26    /// 0x04–0x7F — user private.
27    UserPrivate(u8),
28    /// 0x80 — primary.
29    Primary,
30    /// 0x81 — native.
31    Native,
32    /// 0x82 — emergency.
33    Emergency,
34    /// 0x83 — primary commentary.
35    PrimaryCommentary,
36    /// 0x84 — alternate commentary.
37    AlternateCommentary,
38    /// 0x85–0xFF — reserved.
39    Reserved(u8),
40}
41
42impl AudioType {
43    #[must_use]
44    /// Creates a value from a wire byte, preserving every possible
45    /// byte value for lossless round-trip.
46    pub fn from_u8(v: u8) -> Self {
47        match v {
48            0x00 => Self::Undefined,
49            0x01 => Self::CleanEffects,
50            0x02 => Self::HearingImpaired,
51            0x03 => Self::VisualImpairedCommentary,
52            0x04..=0x7F => Self::UserPrivate(v),
53            0x80 => Self::Primary,
54            0x81 => Self::Native,
55            0x82 => Self::Emergency,
56            0x83 => Self::PrimaryCommentary,
57            0x84 => Self::AlternateCommentary,
58            v => Self::Reserved(v),
59        }
60    }
61
62    #[must_use]
63    /// Returns the wire byte for this value.
64    pub fn to_u8(self) -> u8 {
65        match self {
66            Self::Undefined => 0x00,
67            Self::CleanEffects => 0x01,
68            Self::HearingImpaired => 0x02,
69            Self::VisualImpairedCommentary => 0x03,
70            Self::UserPrivate(v) => v,
71            Self::Primary => 0x80,
72            Self::Native => 0x81,
73            Self::Emergency => 0x82,
74            Self::PrimaryCommentary => 0x83,
75            Self::AlternateCommentary => 0x84,
76            Self::Reserved(v) => v,
77        }
78    }
79
80    #[must_use]
81    /// Returns a human-readable spec name for this value.
82    pub fn name(self) -> &'static str {
83        match self {
84            Self::Undefined => "undefined",
85            Self::CleanEffects => "clean effects",
86            Self::HearingImpaired => "hearing impaired",
87            Self::VisualImpairedCommentary => "visual impaired commentary",
88            Self::UserPrivate(_) => "user private",
89            Self::Primary => "primary",
90            Self::Native => "native",
91            Self::Emergency => "emergency",
92            Self::PrimaryCommentary => "primary commentary",
93            Self::AlternateCommentary => "alternate commentary",
94            Self::Reserved(_) => "reserved",
95        }
96    }
97}
98dvb_common::impl_spec_display!(AudioType, UserPrivate, Reserved);
99
100/// One (language code, audio type) pair.
101#[derive(Debug, Clone, PartialEq, Eq)]
102#[cfg_attr(feature = "serde", derive(serde::Serialize))]
103pub struct LanguageEntry {
104    /// Three-character ISO 639-2 language code (e.g. `LangCode(*b"eng")`).
105    pub language_code: LangCode,
106    /// Audio type (ETSI EN 300 468 §6.2.22).
107    pub audio_type: AudioType,
108}
109
110/// ISO 639 Language Descriptor.
111#[derive(Debug, Clone, PartialEq, Eq)]
112#[cfg_attr(feature = "serde", derive(serde::Serialize))]
113pub struct Iso639LanguageDescriptor {
114    /// One or more language entries.
115    pub entries: Vec<LanguageEntry>,
116}
117
118impl<'a> Parse<'a> for Iso639LanguageDescriptor {
119    type Error = crate::error::Error;
120    fn parse(bytes: &'a [u8]) -> Result<Self> {
121        let body = descriptor_body(
122            bytes,
123            TAG,
124            "Iso639LanguageDescriptor",
125            "unexpected tag for iso_639_language_descriptor",
126        )?;
127        if body.len() % ENTRY_LEN != 0 {
128            return Err(Error::InvalidDescriptor {
129                tag: TAG,
130                reason: "iso_639_language_descriptor length not a multiple of 4",
131            });
132        }
133        let mut entries = Vec::with_capacity(body.len() / ENTRY_LEN);
134        for chunk in body.chunks_exact(ENTRY_LEN) {
135            entries.push(LanguageEntry {
136                language_code: LangCode([chunk[0], chunk[1], chunk[2]]),
137                audio_type: AudioType::from_u8(chunk[3]),
138            });
139        }
140        Ok(Self { entries })
141    }
142}
143
144impl Serialize for Iso639LanguageDescriptor {
145    type Error = crate::error::Error;
146    fn serialized_len(&self) -> usize {
147        HEADER_LEN + self.entries.len() * ENTRY_LEN
148    }
149
150    fn serialize_into(&self, buf: &mut [u8]) -> Result<usize> {
151        let len = self.serialized_len();
152        if buf.len() < len {
153            return Err(Error::OutputBufferTooSmall {
154                need: len,
155                have: buf.len(),
156            });
157        }
158        buf[0] = TAG;
159        buf[1] = (self.entries.len() * ENTRY_LEN) as u8;
160        let mut pos = HEADER_LEN;
161        for e in &self.entries {
162            buf[pos..pos + 3].copy_from_slice(&e.language_code.0);
163            buf[pos + 3] = e.audio_type.to_u8();
164            pos += ENTRY_LEN;
165        }
166        Ok(len)
167    }
168}
169impl<'a> crate::traits::DescriptorDef<'a> for Iso639LanguageDescriptor {
170    const TAG: u8 = TAG;
171    const NAME: &'static str = "ISO_639_LANGUAGE";
172}
173
174#[cfg(test)]
175mod tests {
176    use super::*;
177
178    #[test]
179    fn parse_single_language_entry() {
180        let bytes = [TAG, 4, b'e', b'n', b'g', 0x00];
181        let d = Iso639LanguageDescriptor::parse(&bytes).unwrap();
182        assert_eq!(d.entries.len(), 1);
183        assert_eq!(d.entries[0].language_code, LangCode(*b"eng"));
184        assert_eq!(d.entries[0].audio_type, AudioType::Undefined);
185    }
186
187    #[test]
188    fn parse_multiple_entries() {
189        let bytes = [TAG, 8, b'e', b'n', b'g', 1, b'f', b'r', b'a', 2];
190        let d = Iso639LanguageDescriptor::parse(&bytes).unwrap();
191        assert_eq!(d.entries.len(), 2);
192        assert_eq!(d.entries[1].language_code, LangCode(*b"fra"));
193        assert_eq!(d.entries[1].audio_type, AudioType::HearingImpaired);
194    }
195
196    #[test]
197    fn parse_rejects_wrong_tag() {
198        let err = Iso639LanguageDescriptor::parse(&[0x0B, 0]).unwrap_err();
199        assert!(matches!(err, Error::InvalidDescriptor { tag: 0x0B, .. }));
200    }
201
202    #[test]
203    fn parse_rejects_short_header() {
204        let err = Iso639LanguageDescriptor::parse(&[TAG]).unwrap_err();
205        assert!(matches!(err, Error::BufferTooShort { .. }));
206    }
207
208    #[test]
209    fn parse_rejects_length_not_multiple_of_4() {
210        let bytes = [TAG, 5, b'e', b'n', b'g', 0, 0];
211        let err = Iso639LanguageDescriptor::parse(&bytes).unwrap_err();
212        assert!(matches!(err, Error::InvalidDescriptor { .. }));
213    }
214
215    #[test]
216    fn serialize_round_trip() {
217        let d = Iso639LanguageDescriptor {
218            entries: vec![
219                LanguageEntry {
220                    language_code: LangCode(*b"eng"),
221                    audio_type: AudioType::Undefined,
222                },
223                LanguageEntry {
224                    language_code: LangCode(*b"fra"),
225                    audio_type: AudioType::CleanEffects,
226                },
227            ],
228        };
229        let mut buf = vec![0u8; d.serialized_len()];
230        d.serialize_into(&mut buf).unwrap();
231        let re = Iso639LanguageDescriptor::parse(&buf).unwrap();
232        assert_eq!(d, re);
233    }
234
235    #[test]
236    fn descriptor_length_matches_payload() {
237        let d = Iso639LanguageDescriptor {
238            entries: vec![LanguageEntry {
239                language_code: LangCode(*b"eng"),
240                audio_type: AudioType::Undefined,
241            }],
242        };
243        assert_eq!(d.serialized_len() - 2, 4);
244    }
245
246    #[test]
247    fn audio_type_full_range_round_trip() {
248        for b in 0..=0xFF_u8 {
249            let at = AudioType::from_u8(b);
250            assert_eq!(at.to_u8(), b, "round-trip failed for byte 0x{b:02X}");
251        }
252    }
253
254    #[test]
255    fn audio_type_name_for_known() {
256        assert_eq!(AudioType::Undefined.name(), "undefined");
257        assert_eq!(AudioType::CleanEffects.name(), "clean effects");
258        assert_eq!(AudioType::HearingImpaired.name(), "hearing impaired");
259        assert_eq!(
260            AudioType::VisualImpairedCommentary.name(),
261            "visual impaired commentary"
262        );
263        assert_eq!(AudioType::Reserved(0x55).name(), "reserved");
264    }
265
266    #[test]
267    fn audio_type_round_trip_known_values() {
268        for b in [0x00u8, 0x03, 0x40, 0x80, 0x84, 0x85, 0xFF] {
269            assert_eq!(
270                AudioType::from_u8(b).to_u8(),
271                b,
272                "round-trip failed for byte 0x{b:02X}"
273            );
274        }
275    }
276
277    #[test]
278    fn audio_type_primary_name() {
279        assert_eq!(AudioType::from_u8(0x80).name(), "primary");
280    }
281}
dvb_si/descriptors/iso_639_language.rs

dvb_si/descriptors/
iso_639_language.rs
