Skip to main content

dvb_si/text/
mod.rs

1//! DVB-SI text decoding — ETSI EN 300 468 Annex A.
2//!
3//! Covers the full Annex A Table A.3 selector set: the default Latin table
4//! (Figure A.1, an ISO 6937 superset — see `iso_6937_single`), ISO 8859-n
5//! (single-byte 0x01–0x0B and extended 0x10 forms), UCS-2 BE (0x11),
6//! KS X 1001 Korean (0x12, decoded as EUC-KR), GB-2312 Simplified Chinese
7//! (0x13, decoded via GBK which is a GB-2312 superset), Big5 Traditional
8//! Chinese (0x14), UTF-8 (0x15), and the 0x1F `encoding_type_id` escape
9//! (no ids are registered for broadcast use — yields U+FFFD). Reserved
10//! selectors (0x08, 0x0C–0x0F, 0x16–0x1E) yield U+FFFD per byte.
11//!
12//! Glyph mappings are pinned to EN 300 468 V1.19.1 (2025-02) Figure A.1
13//! "Character code table 00 - Latin alphabet with Unicode equivalents"
14//! (PDF p. 159, vendored at `specs/etsi_en_300_468_v01.19.01_dvb_si.pdf`;
15//! transcription in `dvb-si/docs/en_300_468.md`).
16//!
17//! [`DvbText`] wraps the raw wire bytes and decodes only on demand — parsing
18//! stays zero-copy; decoding happens when you call [`DvbText::decode`], `Display`,
19//! or serde:
20//!
21//! ```
22//! use dvb_si::text::{DvbText, LangCode};
23//!
24//! // Leading 0x15 is the Annex A UTF-8 selector; "café" follows.
25//! let name = DvbText::new(&[0x15, b'c', b'a', b'f', 0xC3, 0xA9]);
26//! assert_eq!(name.decode(), "café");
27//! assert_eq!(name.raw(), &[0x15, b'c', b'a', b'f', 0xC3, 0xA9]); // selector kept
28//!
29//! // A selector-less default-Latin (ISO 6937) sequence: combining acute + e → é.
30//! assert_eq!(DvbText::new(&[0xC2, b'e']).decode(), "é");
31//!
32//! // LangCode is 3 raw bytes (ISO 639-2 / ISO 3166) decoded lossily on demand.
33//! assert_eq!(LangCode(*b"fre").as_str(), "fre");
34//! ```
35
36use std::borrow::Cow;
37
38/// Decode a DVB text payload (e.g. short_event_descriptor event_name_char)
39/// into an owned UTF-8 `String`. The first byte may be a charset indicator
40/// per ETSI EN 300 468 Annex A Table A.3.
41#[must_use]
42pub fn decode_dvb_string(bytes: &[u8]) -> String {
43    if bytes.is_empty() {
44        return String::new();
45    }
46
47    let (charset, body) = split_charset(bytes);
48    let decoded = match charset {
49        Charset::Iso6937 => decode_iso_6937(body),
50        Charset::Iso8859(n) => decode_iso_8859(n, body),
51        Charset::Utf8 => String::from_utf8_lossy(body).into_owned(),
52        Charset::Ucs2Be => decode_ucs2_be(body),
53        Charset::Ksx1001 => decode_with(encoding_rs::EUC_KR, body),
54        Charset::Gb2312 => decode_with(encoding_rs::GBK, body),
55        Charset::Big5 => decode_with(encoding_rs::BIG5, body),
56        Charset::Unsupported(_indicator) => body.iter().map(|_| '\u{FFFD}').collect(),
57    };
58
59    // Annex A.1 control codes:
60    //   single-byte tables: 0x86 emphasis on, 0x87 emphasis off, 0x8A CR/LF
61    //   -> space; other C0/C1 controls are stripped.
62    //   two-byte tables (Table A.2): the same functions live at U+E086 /
63    //   U+E087 / U+E08A inside the ISO 10646 PUA; the rest of
64    //   U+E080..U+E09F is reserved for control functions and stripped.
65    decoded
66        .chars()
67        .filter_map(|c| match c as u32 {
68            0x86 | 0x87 | 0xE086 | 0xE087 => None,
69            0x8A | 0xE08A => Some(' '),
70            0x0A => Some(' '),
71            code if code < 0x20 => None,
72            code if (0x80..0xA0).contains(&code) => None,
73            code if (0xE080..0xE0A0).contains(&code) => None,
74            _ => Some(c),
75        })
76        .collect()
77}
78
79/// Convenience wrapper returning `Cow::Borrowed` for pure-ASCII input,
80/// `Cow::Owned` otherwise.
81#[must_use]
82pub fn decode(bytes: &[u8]) -> Cow<'_, str> {
83    if bytes.iter().all(|&b| b.is_ascii() && b >= 0x20) {
84        return Cow::Borrowed(std::str::from_utf8(bytes).unwrap_or(""));
85    }
86    Cow::Owned(decode_dvb_string(bytes))
87}
88
89/// Borrowed DVB-encoded text (EN 300 468 Annex A). Wraps the raw selector +
90/// body bytes; decoding happens only on [`DvbText::decode`] / `Display` /
91/// serde — never in the parse hot path.
92#[derive(Clone, Copy, PartialEq, Eq, Hash)]
93pub struct DvbText<'a>(&'a [u8]);
94
95impl<'a> DvbText<'a> {
96    /// Wrap raw Annex A bytes (charset selector included, if any).
97    #[must_use]
98    pub const fn new(raw: &'a [u8]) -> Self {
99        Self(raw)
100    }
101    /// The raw wire bytes, selector included.
102    #[must_use]
103    pub const fn raw(&self) -> &'a [u8] {
104        self.0
105    }
106    /// Decode per Annex A (Table A.3 selector + control codes). Borrows only
107    /// for selector-less printable-ASCII input; any charset selector byte
108    /// forces an owned decode.
109    #[must_use]
110    pub fn decode(&self) -> Cow<'a, str> {
111        decode(self.0)
112    }
113}
114
115impl std::ops::Deref for DvbText<'_> {
116    /// Derefs to the raw wire bytes (selector included) — `len()`/indexing are
117    /// byte counts for serialization, not decoded character counts.
118    type Target = [u8];
119    fn deref(&self) -> &[u8] {
120        self.0
121    }
122}
123
124impl std::fmt::Display for DvbText<'_> {
125    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
126        f.write_str(&self.decode())
127    }
128}
129
130impl std::fmt::Debug for DvbText<'_> {
131    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
132        write!(f, "DvbText({:?})", self.decode())
133    }
134}
135
136impl<'a> From<&'a [u8]> for DvbText<'a> {
137    fn from(raw: &'a [u8]) -> Self {
138        Self(raw)
139    }
140}
141
142#[cfg(feature = "serde")]
143impl serde::Serialize for DvbText<'_> {
144    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
145        s.serialize_str(&self.decode())
146    }
147}
148// Deliberately NO Deserialize: re-encoding decoded text into DVB charset
149// bytes is lossy. Structs holding DvbText derive Serialize only (2.0 break).
150
151/// ISO 639-2 language code or ISO 3166 country code — 3 raw bytes.
152#[derive(Clone, Copy, PartialEq, Eq, Hash)]
153pub struct LangCode(pub [u8; 3]);
154
155impl LangCode {
156    /// The code as a string; lossy (U+FFFD) for non-ASCII garbage.
157    #[must_use]
158    pub fn as_str(&self) -> Cow<'_, str> {
159        String::from_utf8_lossy(&self.0)
160    }
161}
162
163impl std::ops::Deref for LangCode {
164    type Target = [u8; 3];
165    fn deref(&self) -> &[u8; 3] {
166        &self.0
167    }
168}
169
170impl std::fmt::Display for LangCode {
171    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
172        f.write_str(&self.as_str())
173    }
174}
175
176impl std::fmt::Debug for LangCode {
177    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
178        write!(f, "LangCode({})", self.as_str())
179    }
180}
181
182#[cfg(feature = "serde")]
183impl serde::Serialize for LangCode {
184    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
185        s.serialize_str(&self.as_str())
186    }
187}
188
189#[cfg(feature = "serde")]
190impl<'de> serde::Deserialize<'de> for LangCode {
191    fn deserialize<D: serde::Deserializer<'de>>(d: D) -> Result<Self, D::Error> {
192        let s = <std::borrow::Cow<'_, str>>::deserialize(d)?;
193        let b = s.as_bytes();
194        if b.len() != 3 {
195            return Err(serde::de::Error::invalid_length(b.len(), &"a 3-byte code"));
196        }
197        Ok(LangCode([b[0], b[1], b[2]]))
198    }
199}
200
201#[derive(Debug)]
202enum Charset {
203    Iso6937,
204    Iso8859(u8),
205    Utf8,
206    Ucs2Be,
207    /// KS X 1001 (selector 0x12), decoded as EUC-KR.
208    Ksx1001,
209    /// GB-2312 (selector 0x13), decoded via GBK (a GB-2312 superset).
210    Gb2312,
211    /// Big5 (selector 0x14).
212    Big5,
213    Unsupported(u8),
214}
215
216fn split_charset(bytes: &[u8]) -> (Charset, &[u8]) {
217    match bytes[0] {
218        b if b >= 0x20 => (Charset::Iso6937, bytes),
219        0x00 => (Charset::Iso6937, &bytes[1..]),
220        // Table A.3: 0x01..=0x0B map to ISO 8859-5..-15, EXCEPT 0x08 which is
221        // "reserved for future use" (there is no ISO 8859-12).
222        0x08 => (Charset::Unsupported(0x08), &bytes[1..]),
223        0x01..=0x0B => (Charset::Iso8859(bytes[0] + 4), &bytes[1..]),
224        0x10 if bytes.len() >= 3 && bytes[1] == 0x00 => (Charset::Iso8859(bytes[2]), &bytes[3..]),
225        0x11 => (Charset::Ucs2Be, &bytes[1..]),
226        0x12 => (Charset::Ksx1001, &bytes[1..]),
227        0x13 => (Charset::Gb2312, &bytes[1..]),
228        0x14 => (Charset::Big5, &bytes[1..]),
229        0x15 => (Charset::Utf8, &bytes[1..]),
230        // 0x1F: an 8-bit encoding_type_id follows (Table A.4 area); no ids are
231        // registered for broadcast text — treat the body as undecodable.
232        0x1F if bytes.len() >= 2 => (Charset::Unsupported(0x1F), &bytes[2..]),
233        other => (Charset::Unsupported(other), &bytes[1..]),
234    }
235}
236
237fn decode_iso_6937(bytes: &[u8]) -> String {
238    let mut out = String::with_capacity(bytes.len());
239    let mut i = 0;
240    while i < bytes.len() {
241        let b = bytes[i];
242        // 0xC0..=0xCF is the Figure A.1 non-spacing (combining-prefix) row.
243        if (0xC0..=0xCF).contains(&b) {
244            match combining_mark(b) {
245                Some(mark) if i + 1 < bytes.len() => {
246                    let base = bytes[i + 1];
247                    if let Some(c) = combine(b, base) {
248                        out.push(c);
249                    } else {
250                        // No precomposed form — emit base + Unicode combining
251                        // mark, which is canonically equivalent.
252                        out.push(iso_6937_single(base));
253                        out.push(mark);
254                    }
255                    i += 2;
256                }
257                // Undefined prefix (0xC0/0xC9/0xCC) or dangling prefix at end.
258                _ => {
259                    out.push('\u{FFFD}');
260                    i += 1;
261                }
262            }
263            continue;
264        }
265        out.push(iso_6937_single(b));
266        i += 1;
267    }
268    out
269}
270
271/// Decode a single (non-combining) byte of the default Latin table.
272///
273/// Source: ETSI EN 300 468 V1.19.1 (2025-02) Figure A.1 — "Character code
274/// table 00 - Latin alphabet with Unicode equivalents" (PDF p. 159). Per the
275/// note under the figure, the table is a superset of ISO/IEC 6937 with the
276/// Euro symbol (U+20AC) added at position 0xA4. Grey (undefined) positions
277/// decode to U+FFFD.
278fn iso_6937_single(b: u8) -> char {
279    match b {
280        0x00..=0x7F => b as char,
281        // Preserve ETSI Annex A.2 C1 control codes so the post-filter can act on them.
282        0x86 | 0x87 | 0x8A => b as char,
283        0x80..=0x9F => '\u{FFFD}',
284        0xA0 => '\u{00A0}', // NBSP
285        0xA1 => '¡',
286        0xA2 => '¢',
287        0xA3 => '£',
288        0xA4 => '\u{20AC}', // € — DVB addition (note under Figure A.1)
289        0xA5 => '¥',
290        0xA6 => '\u{FFFD}', // undefined
291        0xA7 => '§',
292        0xA8 => '\u{00A4}', // ¤ general currency sign
293        0xA9 => '\u{2018}', // ' left single quotation mark
294        0xAA => '\u{201C}', // " left double quotation mark
295        0xAB => '«',
296        0xAC => '\u{2190}', // ←
297        0xAD => '\u{2191}', // ↑
298        0xAE => '\u{2192}', // →
299        0xAF => '\u{2193}', // ↓
300        0xB0 => '°',
301        0xB1 => '±',
302        0xB2 => '²',
303        0xB3 => '³',
304        0xB4 => '\u{00D7}', // ×
305        0xB5 => 'µ',
306        0xB6 => '¶',
307        0xB7 => '·',
308        0xB8 => '\u{00F7}', // ÷
309        0xB9 => '\u{2019}', // ' right single quotation mark
310        0xBA => '\u{201D}', // " right double quotation mark
311        0xBB => '»',
312        0xBC => '¼',
313        0xBD => '½',
314        0xBE => '¾',
315        0xBF => '¿',
316        // Combining-prefix row; reached only for a dangling/undefined prefix.
317        0xC0..=0xCF => '\u{FFFD}',
318        0xD0 => '\u{2015}', // ― horizontal bar
319        0xD1 => '¹',
320        0xD2 => '®',
321        0xD3 => '©',
322        0xD4 => '\u{2122}', // ™
323        0xD5 => '\u{266A}', // ♪ eighth note
324        0xD6 => '¬',
325        0xD7 => '\u{00A6}',        // ¦ broken bar
326        0xD8..=0xDB => '\u{FFFD}', // undefined
327        0xDC => '\u{215B}',        // ⅛
328        0xDD => '\u{215C}',        // ⅜
329        0xDE => '\u{215D}',        // ⅝
330        0xDF => '\u{215E}',        // ⅞
331        0xE0 => '\u{2126}',        // Ω OHM SIGN
332        0xE1 => 'Æ',
333        0xE2 => '\u{0110}', // Đ
334        0xE3 => 'ª',
335        0xE4 => '\u{0126}', // Ħ
336        0xE5 => '\u{FFFD}', // undefined
337        0xE6 => '\u{0132}', // IJ
338        0xE7 => '\u{013F}', // Ŀ
339        0xE8 => '\u{0141}', // Ł
340        0xE9 => 'Ø',
341        0xEA => '\u{0152}', // Œ
342        0xEB => 'º',
343        0xEC => 'Þ',
344        0xED => '\u{0166}', // Ŧ
345        0xEE => '\u{014A}', // Ŋ
346        0xEF => '\u{0149}', // ʼn
347        0xF0 => '\u{0138}', // ĸ
348        0xF1 => 'æ',
349        0xF2 => '\u{0111}', // đ
350        0xF3 => 'ð',
351        0xF4 => '\u{0127}', // ħ
352        0xF5 => '\u{0131}', // ı dotless i
353        0xF6 => '\u{0133}', // ij
354        0xF7 => '\u{0140}', // ŀ
355        0xF8 => '\u{0142}', // ł
356        0xF9 => 'ø',
357        0xFA => '\u{0153}', // œ
358        0xFB => 'ß',
359        0xFC => '\u{00FE}', // þ
360        0xFD => '\u{0167}', // ŧ
361        0xFE => '\u{014B}', // ŋ
362        0xFF => '\u{00AD}', // SHY soft hyphen
363    }
364}
365
366/// Unicode combining mark for a Figure A.1 non-spacing prefix byte
367/// (row 0xC0..=0xCF). `None` for the undefined positions 0xC0/0xC9/0xCC.
368fn combining_mark(prefix: u8) -> Option<char> {
369    Some(match prefix {
370        0xC1 => '\u{0300}', // grave
371        0xC2 => '\u{0301}', // acute
372        0xC3 => '\u{0302}', // circumflex
373        0xC4 => '\u{0303}', // tilde
374        0xC5 => '\u{0304}', // macron
375        0xC6 => '\u{0306}', // breve
376        0xC7 => '\u{0307}', // dot above
377        0xC8 => '\u{0308}', // diaeresis
378        0xCA => '\u{030A}', // ring above
379        0xCB => '\u{0327}', // cedilla
380        0xCD => '\u{030B}', // double acute
381        0xCE => '\u{0328}', // ogonek
382        0xCF => '\u{030C}', // caron
383        _ => return None,
384    })
385}
386
387fn combine(prefix: u8, base: u8) -> Option<char> {
388    Some(match (prefix, base) {
389        (0xC1, b'A') => 'À',
390        (0xC1, b'E') => 'È',
391        (0xC1, b'I') => 'Ì',
392        (0xC1, b'O') => 'Ò',
393        (0xC1, b'U') => 'Ù',
394        (0xC1, b'a') => 'à',
395        (0xC1, b'e') => 'è',
396        (0xC1, b'i') => 'ì',
397        (0xC1, b'o') => 'ò',
398        (0xC1, b'u') => 'ù',
399        (0xC2, b'A') => 'Á',
400        (0xC2, b'E') => 'É',
401        (0xC2, b'I') => 'Í',
402        (0xC2, b'O') => 'Ó',
403        (0xC2, b'U') => 'Ú',
404        (0xC2, b'Y') => 'Ý',
405        (0xC2, b'a') => 'á',
406        (0xC2, b'e') => 'é',
407        (0xC2, b'i') => 'í',
408        (0xC2, b'o') => 'ó',
409        (0xC2, b'u') => 'ú',
410        (0xC2, b'y') => 'ý',
411        (0xC2, b'C') => 'Ć',
412        (0xC2, b'c') => 'ć',
413        (0xC2, b'L') => 'Ĺ',
414        (0xC2, b'l') => 'ĺ',
415        (0xC2, b'N') => 'Ń',
416        (0xC2, b'n') => 'ń',
417        (0xC2, b'R') => 'Ŕ',
418        (0xC2, b'r') => 'ŕ',
419        (0xC2, b'S') => 'Ś',
420        (0xC2, b's') => 'ś',
421        (0xC2, b'Z') => 'Ź',
422        (0xC2, b'z') => 'ź',
423        (0xC3, b'A') => 'Â',
424        (0xC3, b'E') => 'Ê',
425        (0xC3, b'I') => 'Î',
426        (0xC3, b'O') => 'Ô',
427        (0xC3, b'U') => 'Û',
428        (0xC3, b'a') => 'â',
429        (0xC3, b'e') => 'ê',
430        (0xC3, b'i') => 'î',
431        (0xC3, b'o') => 'ô',
432        (0xC3, b'u') => 'û',
433        (0xC4, b'A') => 'Ã',
434        (0xC4, b'N') => 'Ñ',
435        (0xC4, b'O') => 'Õ',
436        (0xC4, b'a') => 'ã',
437        (0xC4, b'n') => 'ñ',
438        (0xC4, b'o') => 'õ',
439        (0xC4, b'I') => 'Ĩ',
440        (0xC4, b'i') => 'ĩ',
441        (0xC4, b'U') => 'Ũ',
442        (0xC4, b'u') => 'ũ',
443        // macron
444        (0xC5, b'A') => 'Ā',
445        (0xC5, b'a') => 'ā',
446        (0xC5, b'E') => 'Ē',
447        (0xC5, b'e') => 'ē',
448        (0xC5, b'I') => 'Ī',
449        (0xC5, b'i') => 'ī',
450        (0xC5, b'O') => 'Ō',
451        (0xC5, b'o') => 'ō',
452        (0xC5, b'U') => 'Ū',
453        (0xC5, b'u') => 'ū',
454        // breve
455        (0xC6, b'A') => 'Ă',
456        (0xC6, b'a') => 'ă',
457        (0xC6, b'G') => 'Ğ',
458        (0xC6, b'g') => 'ğ',
459        (0xC6, b'U') => 'Ŭ',
460        (0xC6, b'u') => 'ŭ',
461        // dot above
462        (0xC7, b'C') => 'Ċ',
463        (0xC7, b'c') => 'ċ',
464        (0xC7, b'E') => 'Ė',
465        (0xC7, b'e') => 'ė',
466        (0xC7, b'G') => 'Ġ',
467        (0xC7, b'g') => 'ġ',
468        (0xC7, b'I') => 'İ',
469        (0xC7, b'Z') => 'Ż',
470        (0xC7, b'z') => 'ż',
471        (0xC8, b'A') => 'Ä',
472        (0xC8, b'E') => 'Ë',
473        (0xC8, b'I') => 'Ï',
474        (0xC8, b'O') => 'Ö',
475        (0xC8, b'U') => 'Ü',
476        (0xC8, b'Y') => 'Ÿ',
477        (0xC8, b'a') => 'ä',
478        (0xC8, b'e') => 'ë',
479        (0xC8, b'i') => 'ï',
480        (0xC8, b'o') => 'ö',
481        (0xC8, b'u') => 'ü',
482        (0xC8, b'y') => 'ÿ',
483        // ring above
484        (0xCA, b'A') => 'Å',
485        (0xCA, b'a') => 'å',
486        (0xCA, b'U') => 'Ů',
487        (0xCA, b'u') => 'ů',
488        (0xCB, b'C') => 'Ç',
489        (0xCB, b'c') => 'ç',
490        (0xCB, b'G') => 'Ģ',
491        (0xCB, b'g') => 'ģ',
492        (0xCB, b'K') => 'Ķ',
493        (0xCB, b'k') => 'ķ',
494        (0xCB, b'L') => 'Ļ',
495        (0xCB, b'l') => 'ļ',
496        (0xCB, b'N') => 'Ņ',
497        (0xCB, b'n') => 'ņ',
498        (0xCB, b'R') => 'Ŗ',
499        (0xCB, b'r') => 'ŗ',
500        (0xCB, b'S') => 'Ş',
501        (0xCB, b's') => 'ş',
502        (0xCB, b'T') => 'Ţ',
503        (0xCB, b't') => 'ţ',
504        // double acute
505        (0xCD, b'O') => 'Ő',
506        (0xCD, b'o') => 'ő',
507        (0xCD, b'U') => 'Ű',
508        (0xCD, b'u') => 'ű',
509        // ogonek
510        (0xCE, b'A') => 'Ą',
511        (0xCE, b'a') => 'ą',
512        (0xCE, b'E') => 'Ę',
513        (0xCE, b'e') => 'ę',
514        (0xCE, b'I') => 'Į',
515        (0xCE, b'i') => 'į',
516        (0xCE, b'U') => 'Ų',
517        (0xCE, b'u') => 'ų',
518        // caron
519        (0xCF, b'C') => 'Č',
520        (0xCF, b'c') => 'č',
521        (0xCF, b'D') => 'Ď',
522        (0xCF, b'd') => 'ď',
523        (0xCF, b'E') => 'Ě',
524        (0xCF, b'e') => 'ě',
525        (0xCF, b'L') => 'Ľ',
526        (0xCF, b'l') => 'ľ',
527        (0xCF, b'N') => 'Ň',
528        (0xCF, b'n') => 'ň',
529        (0xCF, b'R') => 'Ř',
530        (0xCF, b'r') => 'ř',
531        (0xCF, b'S') => 'Š',
532        (0xCF, b's') => 'š',
533        (0xCF, b'T') => 'Ť',
534        (0xCF, b't') => 'ť',
535        (0xCF, b'Z') => 'Ž',
536        (0xCF, b'z') => 'ž',
537        _ => return None,
538    })
539}
540
541fn decode_iso_8859(n: u8, bytes: &[u8]) -> String {
542    use encoding_rs::*;
543    let encoding: &'static Encoding = match n {
544        2 => ISO_8859_2,
545        3 => ISO_8859_3,
546        4 => ISO_8859_4,
547        5 => ISO_8859_5,
548        6 => ISO_8859_6,
549        7 => ISO_8859_7,
550        8 => ISO_8859_8,
551        9 => WINDOWS_1254,
552        10 => ISO_8859_10,
553        11 => WINDOWS_874,
554        13 => ISO_8859_13,
555        14 => ISO_8859_14,
556        15 => ISO_8859_15,
557        _ => return bytes.iter().map(|&b| b as char).collect(),
558    };
559    let (cow, _, _) = encoding.decode(bytes);
560    cow.into_owned()
561}
562
563fn decode_with(encoding: &'static encoding_rs::Encoding, bytes: &[u8]) -> String {
564    let (cow, _, _) = encoding.decode(bytes);
565    cow.into_owned()
566}
567
568fn decode_ucs2_be(bytes: &[u8]) -> String {
569    let code_units: Vec<u16> = bytes
570        .chunks_exact(2)
571        .map(|pair| u16::from_be_bytes([pair[0], pair[1]]))
572        .collect();
573    String::from_utf16_lossy(&code_units)
574}
575
576#[cfg(test)]
577mod tests {
578    use super::*;
579
580    #[test]
581    fn decode_empty_input_returns_empty_string() {
582        assert_eq!(decode_dvb_string(&[]), "");
583    }
584
585    #[test]
586    fn decode_plain_ascii_is_borrowed() {
587        let cow = decode(b"HELLO");
588        assert!(matches!(cow, Cow::Borrowed(_)));
589        assert_eq!(cow, "HELLO");
590    }
591
592    #[test]
593    fn decode_iso6937_latin_accent_chars() {
594        assert_eq!(decode_dvb_string(&[0x00, 0xC2, b'A']), "Á");
595        assert_eq!(decode_dvb_string(&[0x00, 0xC1, b'e']), "è");
596        assert_eq!(decode_dvb_string(&[0x00, 0xC8, b'o']), "ö");
597    }
598
599    #[test]
600    fn decode_selector_0x01_yields_iso8859_5_cyrillic() {
601        let s = decode_dvb_string(&[0x01, 0xB0, 0xB1]);
602        assert!(s.chars().all(|c| c != '\u{FFFD}'), "got: {s:?}");
603        assert!(!s.is_empty());
604    }
605
606    #[test]
607    fn decode_selector_0x10_extended_yields_iso8859_nn() {
608        let s = decode_dvb_string(&[0x10, 0x00, 0x09, b'A', b'B']);
609        assert_eq!(s, "AB");
610    }
611
612    #[test]
613    fn decode_selector_0x11_ucs2_be() {
614        let s = decode_dvb_string(&[0x11, 0x00, 0x41, 0x00, 0x42]);
615        assert_eq!(s, "AB");
616    }
617
618    #[test]
619    fn decode_selector_0x15_utf8_passthrough() {
620        let s = decode_dvb_string(&[0x15, 0xC3, 0xA9, 0xC3, 0xA9]);
621        assert_eq!(s, "éé");
622    }
623
624    #[test]
625    fn decode_control_chars_stripped_linefeed_becomes_space() {
626        let s = decode_dvb_string(b"A\x01B\nC");
627        assert_eq!(s, "AB C");
628    }
629
630    #[test]
631    fn emphasis_on_off_markers_stripped_per_annex_a2() {
632        // 0x86 and 0x87 are emphasis on/off markers per ETSI Annex A.2 — not
633        // representable in plain text, strip silently.
634        let s = decode_dvb_string(&[0x00, b'A', 0x86, b'B', 0x87, b'C']);
635        assert_eq!(s, "ABC");
636    }
637
638    #[test]
639    fn decode_annex_a2_crlf_0x8a_becomes_space() {
640        // 0x8A in DVB text maps to CR/LF per Annex A.2 — render as space.
641        let s = decode_dvb_string(&[0x00, b'A', 0x8A, b'B']);
642        assert_eq!(s, "A B");
643    }
644
645    #[test]
646    fn decode_selector_0x12_ksx1001_euc_kr() {
647        // EUC-KR 0xB0A1 = '가' (HANGUL SYLLABLE GA).
648        assert_eq!(decode_dvb_string(&[0x12, 0xB0, 0xA1]), "가");
649    }
650
651    #[test]
652    fn decode_selector_0x13_gb2312() {
653        // GB-2312/GBK 0xC4E3 = '你'.
654        assert_eq!(decode_dvb_string(&[0x13, 0xC4, 0xE3]), "你");
655    }
656
657    #[test]
658    fn decode_selector_0x14_big5() {
659        // Big5 0xA4A4 = '中'.
660        assert_eq!(decode_dvb_string(&[0x14, 0xA4, 0xA4]), "中");
661    }
662
663    /// A multi-byte trail byte in 0x80–0x9F must survive: the C1 control
664    /// filter operates on decoded code points, never on raw trail bytes.
665    /// GBK 0x8180 = '亐' (U+4E90, trail byte in the C1 range).
666    #[test]
667    fn decode_selector_0x13_gbk_trail_byte_in_c1_range() {
668        assert_eq!(decode_dvb_string(&[0x13, 0x81, 0x80]), "亐");
669    }
670
671    /// Annex A.1 two-byte control codes live at U+E080–U+E09F in the PUA
672    /// (Table A.2): U+E08A is CR/LF → space; the reserved rest is stripped.
673    /// GBK 0xABCD decodes to U+E08A; GBK 0xABC3 decodes to U+E080.
674    #[test]
675    fn two_byte_control_codes_filtered() {
676        assert_eq!(decode_dvb_string(&[0x13, 0xAB, 0xCD]), " ");
677        assert_eq!(decode_dvb_string(&[0x13, 0xAB, 0xC3]), "");
678    }
679
680    /// 0x1F consumes its 8-bit encoding_type_id; the body is undecodable
681    /// (no registered broadcast ids) and yields U+FFFD per byte.
682    #[test]
683    fn decode_selector_0x1f_encoding_type_id() {
684        let s = decode_dvb_string(&[0x1F, 0x01, 0x41, 0x42]);
685        assert_eq!(s.chars().count(), 2);
686        assert!(s.chars().all(|c| c == '\u{FFFD}'));
687    }
688
689    /// Table A.3 marks single-byte selector 0x08 reserved (no ISO 8859-12).
690    #[test]
691    fn reserved_selector_0x08_is_unsupported() {
692        let s = decode_dvb_string(&[0x08, 0x41, 0x42]);
693        assert!(s.chars().all(|c| c == '\u{FFFD}'));
694        assert_eq!(s.chars().count(), 2);
695    }
696
697    #[test]
698    fn unknown_selector_returns_replacement_characters() {
699        // Selector 0x16 is reserved for future use — each byte becomes U+FFFD.
700        let s = decode_dvb_string(&[0x16, 0xAA, 0xBB, 0xCC]);
701        assert_eq!(s.chars().count(), 3);
702        assert!(s.chars().all(|c| c == '\u{FFFD}'));
703    }
704
705    /// Pins the GR-area single-byte mappings to ETSI EN 300 468 V1.19.1
706    /// (2025-02) Figure A.1 — "Character code table 00 - Latin alphabet with
707    /// Unicode equivalents" (PDF p. 159; vendored at
708    /// `specs/etsi_en_300_468_v01.19.01_dvb_si.pdf`).
709    #[test]
710    fn figure_a1_gr_area_single_byte_mappings() {
711        let pins: &[(u8, char)] = &[
712            (0xA0, '\u{00A0}'), // NBSP
713            (0xA1, '¡'),
714            (0xA2, '¢'),
715            (0xA3, '£'),
716            (0xA4, '\u{20AC}'), // € — DVB addition (note under Figure A.1)
717            (0xA5, '¥'),
718            (0xA7, '§'),
719            (0xA8, '\u{00A4}'), // ¤ general currency sign
720            (0xA9, '\u{2018}'), // '
721            (0xAA, '\u{201C}'), // "
722            (0xAB, '«'),
723            (0xAC, '\u{2190}'), // ←
724            (0xAD, '\u{2191}'), // ↑
725            (0xAE, '\u{2192}'), // →
726            (0xAF, '\u{2193}'), // ↓
727            (0xB0, '°'),
728            (0xB1, '±'),
729            (0xB2, '²'),
730            (0xB3, '³'),
731            (0xB4, '\u{00D7}'), // ×
732            (0xB5, 'µ'),
733            (0xB6, '¶'),
734            (0xB7, '·'),
735            (0xB8, '\u{00F7}'), // ÷
736            (0xB9, '\u{2019}'), // '
737            (0xBA, '\u{201D}'), // "
738            (0xBB, '»'),
739            (0xBC, '¼'),
740            (0xBD, '½'),
741            (0xBE, '¾'),
742            (0xBF, '¿'),
743            (0xD0, '\u{2015}'), // ―
744            (0xD1, '¹'),
745            (0xD2, '®'),
746            (0xD3, '©'),
747            (0xD4, '\u{2122}'), // ™
748            (0xD5, '\u{266A}'), // ♪
749            (0xD6, '¬'),
750            (0xD7, '\u{00A6}'), // ¦
751            (0xDC, '\u{215B}'), // ⅛
752            (0xDD, '\u{215C}'), // ⅜
753            (0xDE, '\u{215D}'), // ⅝
754            (0xDF, '\u{215E}'), // ⅞
755            (0xE0, '\u{2126}'), // Ω OHM SIGN
756            (0xE1, 'Æ'),
757            (0xE2, '\u{0110}'), // Đ
758            (0xE3, 'ª'),
759            (0xE4, '\u{0126}'), // Ħ
760            (0xE6, '\u{0132}'), // IJ
761            (0xE7, '\u{013F}'), // Ŀ
762            (0xE8, '\u{0141}'), // Ł
763            (0xE9, 'Ø'),
764            (0xEA, '\u{0152}'), // Œ
765            (0xEB, 'º'),
766            (0xEC, 'Þ'),
767            (0xED, '\u{0166}'), // Ŧ
768            (0xEE, '\u{014A}'), // Ŋ
769            (0xEF, '\u{0149}'), // ʼn
770            (0xF0, '\u{0138}'), // ĸ
771            (0xF1, 'æ'),
772            (0xF2, '\u{0111}'), // đ
773            (0xF3, 'ð'),
774            (0xF4, '\u{0127}'), // ħ
775            (0xF5, '\u{0131}'), // ı
776            (0xF6, '\u{0133}'), // ij
777            (0xF7, '\u{0140}'), // ŀ
778            (0xF8, '\u{0142}'), // ł
779            (0xF9, 'ø'),
780            (0xFA, '\u{0153}'), // œ
781            (0xFB, 'ß'),
782            (0xFC, '\u{00FE}'), // þ
783            (0xFD, '\u{0167}'), // ŧ
784            (0xFE, '\u{014B}'), // ŋ
785            (0xFF, '\u{00AD}'), // SHY soft hyphen
786        ];
787        for &(byte, want) in pins {
788            let got = decode_dvb_string(&[0x00, byte]);
789            assert_eq!(
790                got,
791                want.to_string(),
792                "byte {byte:#04x}: want {want:?} (U+{:04X}), got {got:?}",
793                want as u32
794            );
795        }
796    }
797
798    /// Bytes undefined (grey) in Figure A.1 decode to U+FFFD.
799    #[test]
800    fn figure_a1_undefined_positions_are_replacement() {
801        for byte in [0xA6u8, 0xD8, 0xD9, 0xDA, 0xDB, 0xE5] {
802            let got = decode_dvb_string(&[0x00, byte]);
803            assert_eq!(got, "\u{FFFD}", "byte {byte:#04x} should be U+FFFD");
804        }
805    }
806
807    /// C-row prefixes with precomposed entries (Figure A.1 non-spacing row).
808    #[test]
809    fn figure_a1_combining_precomposed() {
810        assert_eq!(decode_dvb_string(&[0x00, 0xCA, b'a']), "å"); // ring U+030A
811        assert_eq!(decode_dvb_string(&[0x00, 0xCA, b'A']), "Å");
812        assert_eq!(decode_dvb_string(&[0x00, 0xCF, b's']), "š"); // caron U+030C
813        assert_eq!(decode_dvb_string(&[0x00, 0xCF, b'Z']), "Ž");
814        assert_eq!(decode_dvb_string(&[0x00, 0xCE, b'e']), "ę"); // ogonek U+0328
815        assert_eq!(decode_dvb_string(&[0x00, 0xCD, b'o']), "ő"); // double acute U+030B
816        assert_eq!(decode_dvb_string(&[0x00, 0xC7, b'z']), "ż"); // dot above U+0307
817        assert_eq!(decode_dvb_string(&[0x00, 0xC5, b'a']), "ā"); // macron U+0304
818        assert_eq!(decode_dvb_string(&[0x00, 0xC6, b'g']), "ğ"); // breve U+0306
819    }
820
821    /// A defined prefix with no precomposed form falls back to
822    /// base + Unicode combining mark (canonically equivalent).
823    #[test]
824    fn figure_a1_combining_fallback_emits_base_plus_mark() {
825        assert_eq!(decode_dvb_string(&[0x00, 0xC5, b'x']), "x\u{0304}");
826    }
827
828    /// Undefined C-row prefixes (0xC0, 0xC9, 0xCC) and a dangling prefix at
829    /// end of input decode to U+FFFD.
830    #[test]
831    fn figure_a1_combining_undefined_or_dangling_prefix() {
832        assert_eq!(decode_dvb_string(&[0x00, 0xC0, b'a']), "\u{FFFD}a");
833        assert_eq!(decode_dvb_string(&[0x00, 0xC9, b'a']), "\u{FFFD}a");
834        assert_eq!(decode_dvb_string(&[0x00, 0xCC, b'a']), "\u{FFFD}a");
835        assert_eq!(decode_dvb_string(&[0x00, 0xC2]), "\u{FFFD}");
836    }
837
838    #[test]
839    fn dvb_text_decodes_with_charset_selector() {
840        let t = DvbText::new(&[0x15, 0xC3, 0xA9]); // UTF-8 selector + é
841        assert_eq!(t.decode(), "é");
842        assert_eq!(t.raw(), &[0x15, 0xC3, 0xA9]);
843        assert_eq!(&t[..], &[0x15, 0xC3, 0xA9]); // Deref
844        assert_eq!(format!("{t}"), "é");
845    }
846
847    #[test]
848    fn lang_code_as_str() {
849        assert_eq!(LangCode(*b"fre").as_str(), "fre");
850        assert_eq!(LangCode([0xFF, b'r', b'e']).as_str(), "\u{FFFD}re"); // lossy, no panic
851    }
852
853    #[cfg(feature = "serde")]
854    #[test]
855    fn dvb_text_serializes_decoded() {
856        let t = DvbText::new(&[0x15, 0xC3, 0xA9]);
857        assert_eq!(serde_json::to_string(&t).unwrap(), "\"é\"");
858    }
859
860    #[cfg(feature = "serde")]
861    #[test]
862    fn lang_code_serde_round_trip() {
863        let lc = LangCode(*b"FRA");
864        let json = serde_json::to_string(&lc).unwrap();
865        assert_eq!(json, "\"FRA\"");
866        assert_eq!(serde_json::from_str::<LangCode>(&json).unwrap(), lc);
867        assert!(serde_json::from_str::<LangCode>("\"FRAN\"").is_err()); // not 3 bytes
868                                                                        // escaped JSON must also deserialize (Cow path, not zero-copy &str)
869        assert_eq!(
870            serde_json::from_str::<LangCode>("\"\\u0046RA\"").unwrap(),
871            LangCode(*b"FRA")
872        );
873    }
874}