dvb-ci 0.8.0

DVB Common Interface (EN 50221) — APDU/resource objects, session/transport PDUs, and a CA_PMT builder from a dvb-si PMT.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207

//! Differential test: dvb-ci APDU tag constants vs the libdvben50221 canonical reference.
//!
//! The golden file (`en50221_tags_golden.txt`) was extracted from
//! `tbsdtv/dvb-apps lib/libdvben50221/en50221_app_tags.h` and committed next to this
//! test.  Each line has the form `TAG_NAME = 0xVALUE`.
//!
//! For every C `TAG_*` name that dvb-ci implements, we assert that the Rust constant's
//! `.as_u24()` equals the golden hex value byte-for-byte.  Tags present in the golden
//! file but not yet implemented in dvb-ci are collected into an informational
//! coverage-gap list (printed with `eprintln!`) and do NOT cause a test failure.

use dvb_ci::tag;
use std::collections::HashMap;
use std::path::PathBuf;

// ---------------------------------------------------------------------------
// Mapping: C golden name  →  dvb-ci Rust constant (ApduTag value).
//
// Names are taken verbatim from en50221_tags_golden.txt; values are the
// corresponding `dvb_ci::tag::*` constants.
// ---------------------------------------------------------------------------
fn build_mapping() -> HashMap<&'static str, u32> {
    let mut m: HashMap<&'static str, u32> = HashMap::new();

    // Resource Manager
    m.insert("TAG_PROFILE_ENQUIRY", tag::PROFILE_ENQ.as_u24());
    m.insert("TAG_PROFILE", tag::PROFILE.as_u24());
    m.insert("TAG_PROFILE_CHANGE", tag::PROFILE_CHANGE.as_u24());

    // Application Information
    m.insert("TAG_APP_INFO_ENQUIRY", tag::APPLICATION_INFO_ENQ.as_u24());
    m.insert("TAG_APP_INFO", tag::APPLICATION_INFO.as_u24());
    m.insert("TAG_ENTER_MENU", tag::ENTER_MENU.as_u24());

    // CA Support
    m.insert("TAG_CA_INFO_ENQUIRY", tag::CA_INFO_ENQ.as_u24());
    m.insert("TAG_CA_INFO", tag::CA_INFO.as_u24());
    m.insert("TAG_CA_PMT", tag::CA_PMT.as_u24());
    m.insert("TAG_CA_PMT_REPLY", tag::CA_PMT_REPLY.as_u24());

    // Host Control
    m.insert("TAG_TUNE", tag::TUNE.as_u24());
    m.insert("TAG_REPLACE", tag::REPLACE.as_u24());
    m.insert("TAG_CLEAR_REPLACE", tag::CLEAR_REPLACE.as_u24());
    m.insert("TAG_ASK_RELEASE", tag::ASK_RELEASE.as_u24());

    // Date-Time
    m.insert("TAG_DATE_TIME_ENQUIRY", tag::DATE_TIME_ENQ.as_u24());
    m.insert("TAG_DATE_TIME", tag::DATE_TIME.as_u24());

    // MMI
    m.insert("TAG_CLOSE_MMI", tag::CLOSE_MMI.as_u24());
    m.insert("TAG_DISPLAY_CONTROL", tag::DISPLAY_CONTROL.as_u24());
    m.insert("TAG_DISPLAY_REPLY", tag::DISPLAY_REPLY.as_u24());
    m.insert("TAG_TEXT_LAST", tag::TEXT_LAST.as_u24());
    m.insert("TAG_TEXT_MORE", tag::TEXT_MORE.as_u24());
    m.insert("TAG_KEYPAD_CONTROL", tag::KEYPAD_CONTROL.as_u24());
    m.insert("TAG_KEYPRESS", tag::KEYPRESS.as_u24());
    m.insert("TAG_ENQUIRY", tag::ENQ.as_u24());
    m.insert("TAG_ANSWER", tag::ANSW.as_u24());
    m.insert("TAG_MENU_LAST", tag::MENU_LAST.as_u24());
    m.insert("TAG_MENU_MORE", tag::MENU_MORE.as_u24());
    m.insert("TAG_MENU_ANSWER", tag::MENU_ANSW.as_u24());
    m.insert("TAG_LIST_LAST", tag::LIST_LAST.as_u24());
    m.insert("TAG_LIST_MORE", tag::LIST_MORE.as_u24());
    m.insert(
        "TAG_SUBTITLE_SEGMENT_LAST",
        tag::SUBTITLE_SEGMENT_LAST.as_u24(),
    );
    m.insert(
        "TAG_SUBTITLE_SEGMENT_MORE",
        tag::SUBTITLE_SEGMENT_MORE.as_u24(),
    );
    m.insert("TAG_DISPLAY_MESSAGE", tag::DISPLAY_MESSAGE.as_u24());
    m.insert("TAG_SCENE_END_MARK", tag::SCENE_END_MARK.as_u24());
    m.insert("TAG_SCENE_DONE", tag::SCENE_DONE.as_u24());
    m.insert("TAG_SCENE_CONTROL", tag::SCENE_CONTROL.as_u24());
    m.insert(
        "TAG_SUBTITLE_DOWNLOAD_LAST",
        tag::SUBTITLE_DOWNLOAD_LAST.as_u24(),
    );
    m.insert(
        "TAG_SUBTITLE_DOWNLOAD_MORE",
        tag::SUBTITLE_DOWNLOAD_MORE.as_u24(),
    );
    m.insert("TAG_FLUSH_DOWNLOAD", tag::FLUSH_DOWNLOAD.as_u24());
    m.insert("TAG_DOWNLOAD_REPLY", tag::DOWNLOAD_REPLY.as_u24());

    // Low-Speed Communications
    m.insert("TAG_COMMS_COMMAND", tag::COMMS_CMD.as_u24());
    m.insert(
        "TAG_CONNECTION_DESCRIPTOR",
        tag::CONNECTION_DESCRIPTOR.as_u24(),
    );
    m.insert("TAG_COMMS_REPLY", tag::COMMS_REPLY.as_u24());
    m.insert("TAG_COMMS_SEND_LAST", tag::COMMS_SEND_LAST.as_u24());
    m.insert("TAG_COMMS_SEND_MORE", tag::COMMS_SEND_MORE.as_u24());
    m.insert("TAG_COMMS_RECV_LAST", tag::COMMS_RCV_LAST.as_u24());
    m.insert("TAG_COMMS_RECV_MORE", tag::COMMS_RCV_MORE.as_u24());

    m
}

// ---------------------------------------------------------------------------
// Parse the golden file.
// ---------------------------------------------------------------------------
fn parse_golden(path: &std::path::Path) -> HashMap<String, u32> {
    let text = std::fs::read_to_string(path)
        .unwrap_or_else(|e| panic!("failed to read golden file {}: {e}", path.display()));

    let mut golden: HashMap<String, u32> = HashMap::new();
    for line in text.lines() {
        let line = line.trim();
        // Skip blank lines and comments.
        if line.is_empty() || line.starts_with('#') {
            continue;
        }
        // Expected form: `TAG_NAME = 0xVALUE` (possibly with trailing whitespace).
        let Some((name_part, val_part)) = line.split_once('=') else {
            continue;
        };
        let name = name_part.trim().to_string();
        let val_str = val_part.trim();
        let hex = val_str
            .strip_prefix("0x")
            .or_else(|| val_str.strip_prefix("0X"));
        let Some(hex) = hex else {
            continue;
        };
        let Ok(value) = u32::from_str_radix(hex, 16) else {
            continue;
        };
        golden.insert(name, value);
    }
    golden
}

// ---------------------------------------------------------------------------
// The test.
// ---------------------------------------------------------------------------
#[test]
fn diff_vs_libdvben50221() {
    // Locate the golden file relative to this crate's manifest directory.
    let manifest_dir = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
    let golden_path = manifest_dir.join("tests").join("en50221_tags_golden.txt");

    let golden = parse_golden(&golden_path);
    let mapping = build_mapping();

    assert!(
        mapping.len() >= 40,
        "expected at least 40 tag mappings, got {}",
        mapping.len()
    );

    let mut mismatches: Vec<String> = Vec::new();
    let mut coverage_gaps: Vec<String> = Vec::new();
    let mut matched = 0usize;

    // Walk every entry in the golden file.
    for (golden_name, golden_value) in &golden {
        match mapping.get(golden_name.as_str()) {
            Some(&dvb_ci_value) => {
                if dvb_ci_value != *golden_value {
                    mismatches.push(format!(
                        "  {golden_name}: dvb-ci=0x{dvb_ci_value:06X}, golden=0x{golden_value:06X}"
                    ));
                } else {
                    matched += 1;
                }
            }
            None => {
                coverage_gaps.push(format!("  {golden_name} = 0x{golden_value:06X}"));
            }
        }
    }

    // Report coverage gaps (informational only).
    if !coverage_gaps.is_empty() {
        let mut sorted = coverage_gaps.clone();
        sorted.sort();
        eprintln!(
            "\n[diff_libdvben50221] coverage gaps ({} tags in golden not mapped by dvb-ci):",
            coverage_gaps.len()
        );
        for g in &sorted {
            eprintln!("{g}");
        }
    }

    eprintln!(
        "\n[diff_libdvben50221] matched {matched} tags against libdvben50221 golden reference"
    );

    // Fail on any value mismatch.
    assert!(
        mismatches.is_empty(),
        "dvb-ci tag value(s) differ from libdvben50221 golden reference:\n{}",
        mismatches.join("\n")
    );

    // Sanity: at least 40 of our mapped consts appeared in the golden file.
    assert!(
        matched >= 40,
        "expected at least 40 matched tags, got {matched} — check mapping keys match the golden file"
    );
}