use crate::error::{Error, Result};
use crate::text::{DvbText, LangCode};
use dvb_common::{Parse, Serialize};
mod ac4;
mod audio_preselection;
mod c2_bundle_delivery_system;
mod c2_delivery_system;
mod image_icon;
mod message;
mod network_change_notify;
pub mod registry;
mod s2x_satellite_delivery_system;
mod service_prominence;
mod service_relocated;
mod sh_delivery_system;
mod supplementary_audio;
mod t2_delivery_system;
mod t2mi;
mod target_region;
mod target_region_name;
mod ttml_subtitling;
mod uri_linkage;
mod video_depth_range;
mod vvc_subpictures;
#[cfg(test)]
mod test_support;
pub use ac4::*;
pub use audio_preselection::*;
pub use c2_bundle_delivery_system::*;
pub use c2_delivery_system::*;
pub use image_icon::*;
pub use message::*;
pub use network_change_notify::*;
pub use s2x_satellite_delivery_system::*;
pub use service_prominence::*;
pub use service_relocated::*;
pub use sh_delivery_system::*;
pub use supplementary_audio::*;
pub use t2_delivery_system::*;
pub use t2mi::*;
pub use target_region::*;
pub use target_region_name::*;
pub use ttml_subtitling::*;
pub use uri_linkage::*;
pub use video_depth_range::*;
pub use vvc_subpictures::*;
pub const TAG: u8 = 0x7F;
pub(crate) const HEADER_LEN: usize = 2;
pub(crate) const TAG_EXTENSION_LEN: usize = 1;
pub(crate) const MIN_BODY_LEN: usize = TAG_EXTENSION_LEN;
pub(crate) const MAX_DESCRIPTOR_LENGTH: usize = 0xFF;
pub(crate) const ISO_639_LEN: usize = 3;
pub(crate) const T2_FIXED_PREFIX_LEN: usize = 3; pub(crate) const T2_FLAGS_BLOCK_LEN: usize = 2; pub(crate) const C2_LEN: usize = 7; pub(crate) const C2_BUNDLE_ENTRY_LEN: usize = 8; pub(crate) const SERVICE_RELOCATED_LEN: usize = 6; pub(crate) const S2X_PRIMARY_LEN: usize = 11;
pub(crate) const S2X_SCRAMBLING_LEN: usize = 3;
pub(crate) const TTML_FIXED_LEN: usize = ISO_639_LEN + 2; pub(crate) const T2MI_MIN_LEN: usize = 3;
pub(crate) const VD_RANGE_HDR_LEN: usize = 2;
pub(crate) const VD_DISPARITY_LEN: usize = 3;
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[non_exhaustive]
#[repr(u8)]
pub enum ExtensionTag {
ImageIcon = 0x00,
T2DeliverySystem = 0x04,
ShDeliverySystem = 0x05,
SupplementaryAudio = 0x06,
NetworkChangeNotify = 0x07,
Message = 0x08,
TargetRegion = 0x09,
TargetRegionName = 0x0A,
ServiceRelocated = 0x0B,
C2DeliverySystem = 0x0D,
VideoDepthRange = 0x10,
T2mi = 0x11,
UriLinkage = 0x13,
Ac4 = 0x15,
C2BundleDeliverySystem = 0x16,
S2XSatelliteDeliverySystem = 0x17,
AudioPreselection = 0x19,
TtmlSubtitling = 0x20,
ServiceProminence = 0x22,
VvcSubpictures = 0x23,
}
macro_rules! declare_extension_bodies {
(
$lt:lifetime;
$( $(#[doc = $doc:literal])* $variant:ident = $tag:literal => $($path:ident)::+ $(<$plt:lifetime>)? ),+ $(,)?
) => {
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
#[non_exhaustive]
pub enum ExtensionBody<$lt> {
$(
$(#[doc = $doc])*
$variant($($path)::+ $(<$plt>)?),
)+
Raw(&$lt [u8]),
}
fn parse_body(tag_extension: u8, sel: &[u8]) -> Result<ExtensionBody<'_>> {
Ok(match tag_extension {
$(
$tag => ExtensionBody::$variant(<$($path)::+>::parse(sel)?),
)+
_ => ExtensionBody::Raw(sel),
})
}
impl ExtensionBody<'_> {
fn selector_len(&self) -> usize {
match self {
$(
ExtensionBody::$variant(b) => b.serialized_len(),
)+
ExtensionBody::Raw(s) => s.len(),
}
}
fn write_selector(&self, out: &mut [u8]) {
match self {
$(
ExtensionBody::$variant(b) => {
b.serialize_into(out)
.expect("caller pre-sizes out to selector_len");
}
)+
ExtensionBody::Raw(s) => out[..s.len()].copy_from_slice(s),
}
}
}
fn kind_from_tag(tag_extension: u8) -> Option<ExtensionTag> {
Some(match tag_extension {
$(
$tag => ExtensionTag::$variant,
)+
_ => return None,
})
}
#[cfg(test)]
mod dispatch_drift {
use super::*;
#[test]
fn ext_dispatch_single_source() {
$(
assert_eq!(
$tag,
<$($path)::+ as ExtensionBodyDef<'_>>::TAG_EXTENSION,
concat!("TAG_EXTENSION drift for ", stringify!($variant)),
);
assert!(
!<$($path)::+ as ExtensionBodyDef<'_>>::NAME.is_empty(),
concat!("empty NAME for ", stringify!($variant)),
);
assert_eq!(
ExtensionDescriptor {
tag_extension: $tag,
body: ExtensionBody::Raw(&[]),
}
.kind(),
Some(ExtensionTag::$variant),
concat!("kind() drift for ", stringify!($variant)),
);
)+
}
}
};
}
declare_extension_bodies! {'a;
ImageIcon = 0x00 => ImageIcon<'a>,
T2DeliverySystem = 0x04 => T2DeliverySystem,
ShDeliverySystem = 0x05 => ShDeliverySystem,
SupplementaryAudio = 0x06 => SupplementaryAudio<'a>,
NetworkChangeNotify = 0x07 => NetworkChangeNotify,
Message = 0x08 => Message<'a>,
TargetRegion = 0x09 => TargetRegion,
TargetRegionName = 0x0A => TargetRegionName<'a>,
ServiceRelocated = 0x0B => ServiceRelocated,
C2DeliverySystem = 0x0D => C2DeliverySystem,
VideoDepthRange = 0x10 => VideoDepthRange<'a>,
T2mi = 0x11 => T2mi<'a>,
UriLinkage = 0x13 => UriLinkage<'a>,
Ac4 = 0x15 => Ac4<'a>,
C2BundleDeliverySystem = 0x16 => C2BundleDeliverySystem,
S2XSatelliteDeliverySystem = 0x17 => S2XSatelliteDeliverySystem<'a>,
AudioPreselection = 0x19 => AudioPreselection<'a>,
TtmlSubtitling = 0x20 => TtmlSubtitling<'a>,
ServiceProminence = 0x22 => ServiceProminence<'a>,
VvcSubpictures = 0x23 => VvcSubpictures<'a>,
}
pub trait ExtensionBodyDef<'a>: dvb_common::Parse<'a, Error = crate::error::Error> {
const TAG_EXTENSION: u8;
const NAME: &'static str;
}
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[cfg_attr(feature = "yoke", derive(yoke::Yokeable))]
pub struct ExtensionDescriptor<'a> {
pub tag_extension: u8,
pub body: ExtensionBody<'a>,
}
impl ExtensionDescriptor<'_> {
#[must_use]
pub fn kind(&self) -> Option<ExtensionTag> {
kind_from_tag(self.tag_extension)
}
}
pub(crate) fn invalid(reason: &'static str) -> Error {
Error::InvalidDescriptor { tag: TAG, reason }
}
pub(crate) fn validate_and_split(bytes: &[u8]) -> Result<(u8, &[u8])> {
if bytes.len() < HEADER_LEN {
return Err(Error::BufferTooShort {
need: HEADER_LEN,
have: bytes.len(),
what: "ExtensionDescriptor header",
});
}
if bytes[0] != TAG {
return Err(Error::InvalidDescriptor {
tag: bytes[0],
reason: "unexpected tag for extension_descriptor",
});
}
let length = bytes[1] as usize;
let end = HEADER_LEN + length;
if bytes.len() < end {
return Err(Error::BufferTooShort {
need: end,
have: bytes.len(),
what: "ExtensionDescriptor body",
});
}
if length < MIN_BODY_LEN {
return Err(Error::InvalidDescriptor {
tag: TAG,
reason: "body must contain at least the descriptor_tag_extension byte",
});
}
let tag_extension = bytes[HEADER_LEN];
let sel = &bytes[HEADER_LEN + TAG_EXTENSION_LEN..end];
Ok((tag_extension, sel))
}
impl<'a> Parse<'a> for ExtensionDescriptor<'a> {
type Error = crate::error::Error;
fn parse(bytes: &'a [u8]) -> Result<Self> {
let (tag_extension, sel) = validate_and_split(bytes)?;
let body = parse_body(tag_extension, sel)?;
Ok(Self {
tag_extension,
body,
})
}
}
impl Serialize for ExtensionDescriptor<'_> {
type Error = crate::error::Error;
fn serialized_len(&self) -> usize {
HEADER_LEN + TAG_EXTENSION_LEN + self.body.selector_len()
}
fn serialize_into(&self, buf: &mut [u8]) -> Result<usize> {
let len = self.serialized_len();
if buf.len() < len {
return Err(Error::OutputBufferTooSmall {
need: len,
have: buf.len(),
});
}
let body_len = len - HEADER_LEN;
if body_len > MAX_DESCRIPTOR_LENGTH {
return Err(Error::InvalidDescriptor {
tag: TAG,
reason: "descriptor_length exceeds 255 bytes",
});
}
buf[0] = TAG;
buf[1] = body_len as u8;
buf[HEADER_LEN] = self.tag_extension;
self.body
.write_selector(&mut buf[HEADER_LEN + TAG_EXTENSION_LEN..len]);
Ok(len)
}
}
impl<'a> crate::traits::DescriptorDef<'a> for ExtensionDescriptor<'a> {
const TAG: u8 = TAG;
const NAME: &'static str = "EXTENSION";
}
#[cfg(test)]
mod tests {
use super::test_support::*;
use super::*;
#[test]
fn parse_rejects_wrong_tag() {
let raw = [0x43, 1, 0x04];
assert!(matches!(
ExtensionDescriptor::parse(&raw).unwrap_err(),
Error::InvalidDescriptor { tag: 0x43, .. }
));
}
#[test]
fn parse_rejects_empty_body() {
let raw = [TAG, 0];
assert!(matches!(
ExtensionDescriptor::parse(&raw).unwrap_err(),
Error::InvalidDescriptor { tag: TAG, .. }
));
}
#[test]
fn parse_rejects_truncated_body() {
let raw = [TAG, 3, 0x08];
assert!(matches!(
ExtensionDescriptor::parse(&raw).unwrap_err(),
Error::BufferTooShort { .. }
));
}
#[test]
fn unknown_tag_round_trips_as_raw() {
let sel = [0xDE, 0xAD, 0xBE, 0xEF];
let bytes = wrap(0x42, &sel);
let d = ExtensionDescriptor::parse(&bytes).unwrap();
assert_eq!(d.tag_extension, 0x42);
assert_eq!(d.kind(), None);
assert!(matches!(d.body, ExtensionBody::Raw(b) if b == sel));
round_trip(&d);
}
#[test]
fn user_defined_tag_preserved() {
let bytes = wrap(0x90, &[0x01, 0x02]);
let d = ExtensionDescriptor::parse(&bytes).unwrap();
assert_eq!(d.tag_extension, 0x90);
assert!(matches!(d.body, ExtensionBody::Raw(_)));
round_trip(&d);
}
#[test]
fn serialize_rejects_too_small_buffer() {
let d = ExtensionDescriptor {
tag_extension: 0x0B,
body: ExtensionBody::ServiceRelocated(ServiceRelocated {
old_original_network_id: 1,
old_transport_stream_id: 2,
old_service_id: 3,
}),
};
let mut tiny = [0u8; 2];
assert!(matches!(
d.serialize_into(&mut tiny).unwrap_err(),
Error::OutputBufferTooSmall { .. }
));
}
#[test]
fn descriptor_length_matches_body() {
let d = ExtensionDescriptor {
tag_extension: 0x08,
body: ExtensionBody::Message(Message {
message_id: 1,
iso_639_language_code: LangCode(*b"eng"),
text: DvbText::new(b"hello"),
}),
};
assert_eq!(d.serialized_len() - 2, 10);
}
#[cfg(feature = "serde")]
#[test]
fn serde_serialize_is_stable_owned_body() {
let typed = ExtensionDescriptor {
tag_extension: 0x0D,
body: ExtensionBody::C2DeliverySystem(C2DeliverySystem {
plp_id: 1,
data_slice_id: 2,
c2_system_tuning_frequency: 0xDEAD_BEEF,
c2_system_tuning_frequency_type: C2TuningFrequencyType::C2SystemCentreFrequency,
active_ofdm_symbol_duration: ActiveOfdmSymbolDuration::Reserved(2),
guard_interval: C2GuardInterval::Reserved(3),
}),
};
let json = serde_json::to_string(&typed).unwrap();
assert_eq!(json, serde_json::to_string(&typed.clone()).unwrap());
assert!(json.contains("\"tag_extension\":13"));
assert!(json.contains("\"c2DeliverySystem\""));
}
#[cfg(feature = "serde")]
#[test]
fn serde_serializes_borrowed_body() {
let raw = ExtensionDescriptor {
tag_extension: 0x42,
body: ExtensionBody::Raw(&[0x01, 0x02, 0x03]),
};
let json = serde_json::to_string(&raw).unwrap();
assert!(json.contains("\"tag_extension\":66"));
assert!(json.contains("\"raw\""));
let msg = ExtensionDescriptor {
tag_extension: 0x08,
body: ExtensionBody::Message(Message {
message_id: 7,
iso_639_language_code: LangCode(*b"eng"),
text: DvbText::new(b"hi"),
}),
};
let json = serde_json::to_string(&msg).unwrap();
assert!(json.contains("\"message_id\":7"));
}
#[test]
fn tsduck_reference_round_trip_byte_exact() {
let vectors = [
(
"7f20221a300c04d2f000092911fc465241fd47425211fa0102fb0b0c000ddeadbeef",
ExtensionTag::ServiceProminence,
),
("7f0a22000011223344556677", ExtensionTag::ServiceProminence),
(
"7f0d220b700e092906fe4742520102",
ExtensionTag::ServiceProminence,
),
(
"7f1a000cfc2b3e71c809696d6167652f706e67080123456789abcdef",
ExtensionTag::ImageIcon,
),
(
"7f220007fe5f0a696d6167652f6a70656712687474703a2f2f666f6f2f6261722e6a7067",
ExtensionTag::ImageIcon,
),
("7f090033fe050123456789", ExtensionTag::ImageIcon),
("7f02055f", ExtensionTag::ShDeliverySystem),
(
"7f0d05afff94ac175f68831d8d99ad",
ExtensionTag::ShDeliverySystem,
),
];
for (hex, ext) in vectors {
let bytes = from_hex(hex);
let d =
ExtensionDescriptor::parse(&bytes).unwrap_or_else(|e| panic!("parse {hex}: {e:?}"));
assert_eq!(d.kind(), Some(ext), "kind for {hex}");
let mut out = vec![0u8; d.serialized_len()];
let n = d.serialize_into(&mut out).unwrap();
assert_eq!(out[..n], bytes[..], "byte-exact re-serialize for {hex}");
}
let icon = from_hex("7f1a000cfc2b3e71c809696d6167652f706e67080123456789abcdef");
match &ExtensionDescriptor::parse(&icon).unwrap().body {
ExtensionBody::ImageIcon(b) => {
assert_eq!(b.descriptor_number, 0);
assert_eq!(b.last_descriptor_number, 12);
assert_eq!(b.icon_id, 4);
match &b.body {
ImageIconBody::First(f) => {
assert_eq!(f.icon_transport_mode, 0);
let p = f.position.as_ref().unwrap();
assert_eq!(p.coordinate_system, 2);
assert_eq!(p.icon_horizontal_origin, 999);
assert_eq!(p.icon_vertical_origin, 456);
assert_eq!(f.icon_type.decode(), "image/png");
match &f.payload {
IconLocation::Data(d) => {
assert_eq!(*d, &[0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF])
}
other => panic!("expected Data, got {other:?}"),
}
}
other => panic!("expected First, got {other:?}"),
}
}
other => panic!("expected ImageIcon, got {other:?}"),
}
let sp = from_hex("7f20221a300c04d2f000092911fc465241fd47425211fa0102fb0b0c000ddeadbeef");
match &ExtensionDescriptor::parse(&sp).unwrap().body {
ExtensionBody::ServiceProminence(b) => {
assert_eq!(b.sogi_list.len(), 2);
assert_eq!(b.sogi_list[0].sogi_priority, 12);
assert_eq!(b.sogi_list[0].service_id, Some(1234));
assert!(b.sogi_list[1].sogi_flag);
assert_eq!(b.sogi_list[1].service_id, Some(2345));
assert!(b.sogi_list[1].target_region_loop.is_some());
assert_eq!(b.private_data, &[0xDE, 0xAD, 0xBE, 0xEF]);
}
other => panic!("expected ServiceProminence, got {other:?}"),
}
}
}