imferno-core 0.1.2

SMPTE ST 2067 IMF parser and validator
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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229

//! Typed validation-code catalogue for SMPTE ST 2067-3 (Composition Playlist).

use crate::diagnostics::codes::ValidationCode;
use crate::diagnostics::{Category, Severity};

// ─── Spec-agnostic reason enum ────────────────────────────────────────────────

/// Reason codes for ST 2067-3 validators, independent of spec edition year.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum St2067_3Code {
    /// ST 2067-3 §5.5.1.2: ContentKind uses an unrecognized value under the SMPTE scope.
    ContentKindUnknown,
    /// ST 2067-3 §6.4.2: SourceEncoding present but EssenceDescriptorList absent.
    SourceEncodingNoEssenceDescriptorList,
    /// ST 2067-3 §6.4.2: SourceEncoding does not match any EssenceDescriptor Id.
    SourceEncodingUnresolved,
    /// ST 2067-3 §6.4.2: EssenceDescriptorList present but contains no descriptors.
    EssenceDescriptorListEmpty,
    /// ST 2067-3 §6.11: ContentVersionList present but empty.
    ContentVersionListEmpty,
    /// ST 2067-3 §6.11: ContentVersion/Id is empty (shall be a URI).
    ContentVersionIdInvalid,
    /// ST 2067-3 §6.11: ContentVersion/LabelText is absent.
    ContentVersionLabelTextMissing,
    /// ST 2067-3 §6.12: Locale language tag does not conform to RFC 5646.
    LocaleLanguageTagInvalid,
    /// ST 2067-3 §7.3: TrackId is not unique within a segment.
    TrackIdNotUnique,
    /// ST 2067-3 §7.4: Marker offset exceeds resource effective duration.
    MarkerOffsetOutOfRange,
    /// ST 2067-3 §7.4: Marker label is not a recognized SMPTE standard value.
    MarkerLabelUnknown,
    /// ST 2067-3 §7.2.2: All virtual tracks in a segment must span the same edit units.
    SegmentDuration,
    /// ST 2067-3 §6.1.9: Two ContentVersion elements share the same Id value.
    ContentVersionIdDuplicate,
    /// ST 2067-3 §7.3: Sequence duration is not an integer number of Composition Edit Units.
    SegmentDurationIntegerEditUnits,
}

// ─── Per-edition enums ────────────────────────────────────────────────────────

macro_rules! define_st2067_3_enum {
    ($name:ident, $prefix:literal) => {
        #[allow(non_camel_case_types)]
        #[derive(Debug, Clone, Copy, PartialEq, Eq)]
        pub enum $name {
            ContentKindUnknown,
            SourceEncodingNoEssenceDescriptorList,
            SourceEncodingUnresolved,
            EssenceDescriptorListEmpty,
            ContentVersionListEmpty,
            ContentVersionIdInvalid,
            ContentVersionLabelTextMissing,
            LocaleLanguageTagInvalid,
            TrackIdNotUnique,
            MarkerOffsetOutOfRange,
            MarkerLabelUnknown,
            SegmentDuration,
            ContentVersionIdDuplicate,
            SegmentDurationIntegerEditUnits,
        }

        impl $name {
            pub fn for_code(r: St2067_3Code) -> &'static str {
                match r {
                    St2067_3Code::ContentKindUnknown =>
                        concat!($prefix, ":5.5.1.2/ContentKindUnknown"),
                    St2067_3Code::SourceEncodingNoEssenceDescriptorList =>
                        concat!($prefix, ":6.4.2/SourceEncodingNoEssenceDescriptorList"),
                    St2067_3Code::SourceEncodingUnresolved =>
                        concat!($prefix, ":6.4.2/SourceEncodingUnresolved"),
                    St2067_3Code::EssenceDescriptorListEmpty =>
                        concat!($prefix, ":6.4.2/EssenceDescriptorListEmpty"),
                    St2067_3Code::ContentVersionListEmpty =>
                        concat!($prefix, ":6.11/ContentVersionListEmpty"),
                    St2067_3Code::ContentVersionIdInvalid =>
                        concat!($prefix, ":6.11/ContentVersionIdInvalid"),
                    St2067_3Code::ContentVersionLabelTextMissing =>
                        concat!($prefix, ":6.11/ContentVersionLabelTextMissing"),
                    St2067_3Code::LocaleLanguageTagInvalid =>
                        concat!($prefix, ":6.12/LocaleLanguageTagInvalid"),
                    St2067_3Code::TrackIdNotUnique =>
                        concat!($prefix, ":7.3/TrackIdNotUnique"),
                    St2067_3Code::MarkerOffsetOutOfRange =>
                        concat!($prefix, ":7.4/MarkerOffsetOutOfRange"),
                    St2067_3Code::MarkerLabelUnknown =>
                        concat!($prefix, ":7.4/MarkerLabelUnknown"),
                    St2067_3Code::SegmentDuration =>
                        concat!($prefix, ":7.2.2/SegmentDuration"),
                    St2067_3Code::ContentVersionIdDuplicate =>
                        concat!($prefix, ":6.1.9/ContentVersionIdDuplicate"),
                    St2067_3Code::SegmentDurationIntegerEditUnits =>
                        concat!($prefix, ":7.3/SegmentDurationIntegerEditUnits"),
                }
            }

            pub const ALL: &'static [Self] = &[
                Self::ContentKindUnknown,
                Self::SourceEncodingNoEssenceDescriptorList,
                Self::SourceEncodingUnresolved,
                Self::EssenceDescriptorListEmpty,
                Self::ContentVersionListEmpty,
                Self::ContentVersionIdInvalid,
                Self::ContentVersionLabelTextMissing,
                Self::LocaleLanguageTagInvalid,
                Self::TrackIdNotUnique,
                Self::MarkerOffsetOutOfRange,
                Self::MarkerLabelUnknown,
                Self::SegmentDuration,
                Self::ContentVersionIdDuplicate,
                Self::SegmentDurationIntegerEditUnits,
            ];
        }

        impl ValidationCode for $name {
            fn code(&self) -> &'static str {
                match self {
                    Self::ContentKindUnknown =>
                        concat!($prefix, ":5.5.1.2/ContentKindUnknown"),
                    Self::SourceEncodingNoEssenceDescriptorList =>
                        concat!($prefix, ":6.4.2/SourceEncodingNoEssenceDescriptorList"),
                    Self::SourceEncodingUnresolved =>
                        concat!($prefix, ":6.4.2/SourceEncodingUnresolved"),
                    Self::EssenceDescriptorListEmpty =>
                        concat!($prefix, ":6.4.2/EssenceDescriptorListEmpty"),
                    Self::ContentVersionListEmpty =>
                        concat!($prefix, ":6.11/ContentVersionListEmpty"),
                    Self::ContentVersionIdInvalid =>
                        concat!($prefix, ":6.11/ContentVersionIdInvalid"),
                    Self::ContentVersionLabelTextMissing =>
                        concat!($prefix, ":6.11/ContentVersionLabelTextMissing"),
                    Self::LocaleLanguageTagInvalid =>
                        concat!($prefix, ":6.12/LocaleLanguageTagInvalid"),
                    Self::TrackIdNotUnique =>
                        concat!($prefix, ":7.3/TrackIdNotUnique"),
                    Self::MarkerOffsetOutOfRange =>
                        concat!($prefix, ":7.4/MarkerOffsetOutOfRange"),
                    Self::MarkerLabelUnknown =>
                        concat!($prefix, ":7.4/MarkerLabelUnknown"),
                    Self::SegmentDuration =>
                        concat!($prefix, ":7.2.2/SegmentDuration"),
                    Self::ContentVersionIdDuplicate =>
                        concat!($prefix, ":6.1.9/ContentVersionIdDuplicate"),
                    Self::SegmentDurationIntegerEditUnits =>
                        concat!($prefix, ":7.3/SegmentDurationIntegerEditUnits"),
                }
            }
            fn description(&self) -> &'static str {
                match self {
                    Self::ContentKindUnknown =>
                        "ContentKind uses an unrecognized value under the SMPTE scope.",
                    Self::SourceEncodingNoEssenceDescriptorList =>
                        "SourceEncoding present but EssenceDescriptorList absent.",
                    Self::SourceEncodingUnresolved =>
                        "SourceEncoding does not match any EssenceDescriptor Id.",
                    Self::EssenceDescriptorListEmpty =>
                        "EssenceDescriptorList present but contains no descriptors.",
                    Self::ContentVersionListEmpty =>
                        "ContentVersionList present but empty.",
                    Self::ContentVersionIdInvalid =>
                        "ContentVersion/Id is empty (shall be a URI).",
                    Self::ContentVersionLabelTextMissing =>
                        "ContentVersion/LabelText is absent.",
                    Self::LocaleLanguageTagInvalid =>
                        "Locale language tag does not conform to RFC 5646.",
                    Self::TrackIdNotUnique =>
                        "TrackId is not unique within a segment.",
                    Self::MarkerOffsetOutOfRange =>
                        "Marker offset exceeds resource effective duration.",
                    Self::MarkerLabelUnknown =>
                        "Marker label is not a recognized SMPTE standard value.",
                    Self::SegmentDuration =>
                        "All virtual tracks in a segment must span the same number of edit units.",
                    Self::ContentVersionIdDuplicate =>
                        "No two ContentVersion elements shall have identical Id values.",
                    Self::SegmentDurationIntegerEditUnits =>
                        "Sequence duration shall be an integer number of Composition Edit Units.",
                }
            }
            fn default_severity(&self) -> Severity {
                match self {
                    Self::ContentKindUnknown => Severity::Warning,
                    Self::SourceEncodingNoEssenceDescriptorList => Severity::Error,
                    Self::SourceEncodingUnresolved => Severity::Error,
                    Self::EssenceDescriptorListEmpty => Severity::Error,
                    Self::ContentVersionListEmpty => Severity::Error,
                    Self::ContentVersionIdInvalid => Severity::Error,
                    Self::ContentVersionLabelTextMissing => Severity::Warning,
                    Self::LocaleLanguageTagInvalid => Severity::Warning,
                    Self::TrackIdNotUnique => Severity::Error,
                    Self::MarkerOffsetOutOfRange => Severity::Error,
                    Self::MarkerLabelUnknown => Severity::Warning,
                    Self::SegmentDuration => Severity::Error,
                    Self::ContentVersionIdDuplicate => Severity::Error,
                    Self::SegmentDurationIntegerEditUnits => Severity::Error,
                }
            }
            fn category(&self) -> Category {
                match self {
                    Self::ContentKindUnknown => Category::Metadata,
                    Self::SourceEncodingNoEssenceDescriptorList => Category::Reference,
                    Self::SourceEncodingUnresolved => Category::Reference,
                    Self::EssenceDescriptorListEmpty => Category::Structure,
                    Self::ContentVersionListEmpty => Category::Structure,
                    Self::ContentVersionIdInvalid => Category::Metadata,
                    Self::ContentVersionLabelTextMissing => Category::Metadata,
                    Self::LocaleLanguageTagInvalid => Category::Metadata,
                    Self::TrackIdNotUnique => Category::Structure,
                    Self::MarkerOffsetOutOfRange => Category::Timing,
                    Self::MarkerLabelUnknown => Category::Metadata,
                    Self::SegmentDuration => Category::Timing,
                    Self::ContentVersionIdDuplicate => Category::Structure,
                    Self::SegmentDurationIntegerEditUnits => Category::Timing,
                }
            }
        }

        impl From<$name> for String {
            fn from(c: $name) -> String {
                c.code().to_string()
            }
        }
    };
}

define_st2067_3_enum!(St2067_3_2013, "ST2067-3:2013");
define_st2067_3_enum!(St2067_3_2016, "ST2067-3:2016");
define_st2067_3_enum!(St2067_3_2020, "ST2067-3:2020");