Files
libfreemkv/src/mux/codec/dvdsub.rs
T
Matthew Jackson 789b699f95 mux: make B1 concealment decode-clean on every gap shape
Closes the three residual holes where a concealed/lost gap could still let
a dangling-reference frame reach the muxer (degraded/undecryptable-disc
path only; clean rips are byte-identical and untouched). Root cause: the
discontinuity signal was reconstructed from the 4-bit continuity counter
and applied per-PES, both of which are lossy.

Three coordinated changes:

1. CC-INDEPENDENT marker. fill_null_ts_unit now tags its NULL packets with
   an adaptation-field discontinuity_indicator; the demuxer recognises a
   0x1FFF packet carrying it as a concealed gap and forces a discontinuity
   on every tracked PID (the lost unit's PID is unknowable). This survives
   a loss that is an exact multiple of 16 packets (CC aliases to in-sequence
   — hole 3) and a loss at a PID's very start (no prior CC — hole 4); it
   also drops any open, potentially-truncated partial PES.

2. PUSI ATTRIBUTION. A gap landing on a PES boundary now flags the PES
   STARTING after it, not the one flushed at the boundary (hole 1) —
   stamping the pre-gap frame could arm-then-disarm the gate on a keyframe
   and admit the real post-gap inter frame.

3. PER-FRAME signal. codec::Frame gains `discontinuity`; each parser
   propagates it onto the first post-gap frame. MPEG-2 buffers whole GOPs
   asynchronously, so it associates the gap by ES OFFSET (like PTS/source),
   landing it on the exact post-gap picture mid-GOP (hole 2) — a per-PES
   flag stamped the previous picture. consume_ts (and the EOF flush drain)
   gate on frame.discontinuity.

Tests: CC-independent marker with in-sequence CC + leading-loss; PUSI
attribution flags the post-gap PES; MPEG-2 offset-mark stamps the post-gap
picture through GOP reorder, not the previous one. Existing B1 gate + EOF
tests still green (2270 lib tests).
2026-06-29 09:39:03 -07:00

707 lines
28 KiB
Rust

//! DVD bitmap subtitle (VobSub) parser.
//!
//! DVD subtitles are carried in PS private stream 1 with sub-stream IDs 0x20-0x3F.
//! A single subpicture unit (SPU — one displayed bitmap) may span multiple PES
//! packets: only the first PES carries a PTS; continuation PES packets have no
//! PTS field (the PS demuxer leaves `pts` as `None`). The SPU begins with a
//! 2-byte big-endian `SPU_size` giving the total byte length of the whole unit.
//! We reassemble across PES boundaries into one Frame so large subtitles aren't
//! split/garbled, inheriting the head PES's PTS. The presence of a PTS — not
//! merely an open `pending` — is the authoritative SPU-boundary signal, so a
//! lost continuation or a corrupt SPU_size can't merge the next subtitle into
//! the stuck unit.
//!
//! For MKV: codec ID "S_VOBSUB".
//! All frames are keyframes (each is a complete bitmap).
use super::{CodecParser, Frame, PesPacket, pts_to_ns};
/// Upper bound on a single reassembled SPU. The SPU_size field is 16 bits, so a
/// well-formed unit is at most 0xFFFF bytes; cap accumulation here to bound
/// memory if the field is corrupt or the stream never completes a unit.
const MAX_SPU_BYTES: usize = 0xFFFF;
pub struct DvdSubParser {
/// Pre-formatted VobSub .idx palette header for codec_private.
codec_data: Option<Vec<u8>>,
/// In-progress SPU reassembly: (head PTS in ns, declared SPU_size, bytes).
pending: Option<(i64, usize, Vec<u8>)>,
}
impl DvdSubParser {
pub fn new(codec_data: Option<Vec<u8>>) -> Self {
Self {
codec_data,
pending: None,
}
}
/// Emit `pending` as a Frame if it is complete (or `force` at EOF),
/// returning it and clearing the buffer. Returns None if nothing to emit.
fn take_if_complete(&mut self, force: bool) -> Option<Frame> {
let (_, size, buf) = self.pending.as_ref()?;
if force || buf.len() >= *size {
let (pts_ns, _, data) = self.pending.take().unwrap();
return Some(Frame {
discontinuity: false,
coding: None,
source: None,
pts_ns,
keyframe: true,
data,
duration_ns: None,
});
}
None
}
}
impl CodecParser for DvdSubParser {
fn parse(&mut self, pes: &PesPacket) -> Vec<Frame> {
if pes.data.is_empty() {
return Vec::new();
}
let mut out = Vec::new();
// A PES carrying a real PTS is the START of a new SPU; continuations of
// an in-progress SPU carry no PTS (the PS demuxer leaves `pts` None when
// the PES has no PTS field — see the module doc). PTS is therefore the
// authoritative SPU-boundary signal, NOT merely `pending.is_some()`.
//
// Append-as-continuation ONLY when this PES has no PTS. When it has a
// PTS but a stale `pending` is still open (a lost continuation, or a
// corrupt/oversized declared SPU_size that real data never reaches),
// force-emit the stuck unit truncated and fall through to start a fresh
// SPU from this PES. Without this, one bad SPU_size would swallow every
// later subtitle until EOF — exactly the damaged-disc case we target.
if pes.pts.is_none() {
if self.pending.is_some() {
// Continuation: append, bounded by MAX_SPU_BYTES.
if let Some((_, _, buf)) = self.pending.as_mut() {
let room = MAX_SPU_BYTES.saturating_sub(buf.len());
let take = room.min(pes.data.len());
buf.extend_from_slice(&pes.data[..take]);
}
if let Some(frame) = self.take_if_complete(false) {
out.push(frame);
}
return out;
}
// No pending and no PTS: nothing to attach this to. Pass it through
// as a lone frame (PTS unknown → 0) rather than drop it.
} else if let Some(frame) = self.take_if_complete(true) {
// New SPU starting while a previous one is still open → flush stale.
out.push(frame);
}
// Start of a new SPU. The first 2 bytes are the big-endian total size.
let pts_ns = pes.pts.map(pts_to_ns).unwrap_or(0);
let declared = if pes.data.len() >= 2 {
// SPU_size includes the 2-byte header, so a declared size < 2 is
// always malformed; treat it like the too-short path (lone frame)
// rather than emit an immediate oversized unit.
let d = ((pes.data[0] as usize) << 8) | pes.data[1] as usize;
if d < 2 {
out.push(Frame {
discontinuity: false,
coding: None,
source: None,
pts_ns,
keyframe: true,
data: pes.data.clone(),
duration_ns: None,
});
return out;
}
d
} else {
// Too short to carry SPU_size — pass through as a lone frame.
out.push(Frame {
discontinuity: false,
coding: None,
source: None,
pts_ns,
keyframe: true,
data: pes.data.clone(),
duration_ns: None,
});
return out;
};
let mut buf = pes.data.clone();
if buf.len() > MAX_SPU_BYTES {
buf.truncate(MAX_SPU_BYTES);
}
self.pending = Some((pts_ns, declared, buf));
if let Some(frame) = self.take_if_complete(false) {
out.push(frame);
}
out
}
fn flush(&mut self) -> Vec<Frame> {
// At EOF, emit whatever SPU bytes remain even if the declared size was
// never reached (truncated final subtitle is better than dropping it).
self.take_if_complete(true).into_iter().collect()
}
fn codec_private(&self) -> Option<Vec<u8>> {
self.codec_data.clone()
}
}
// ── YCbCr → RGB conversion and palette formatting ─────────────────────────
/// Convert a single YCbCr color to RGB, clamping to [0, 255].
///
/// Input: `[padding, Y, Cb, Cr]` (as stored in DVD IFO PGC data).
/// Returns `[R, G, B]`.
///
/// Range convention (deliberate): this uses the **full-range (JFIF) BT.601**
/// coefficients with no 16/235 luma scaling. DVD IFO palette YCbCr is nominally
/// studio-swing BT.601, so studio-swing math would be more colorimetrically
/// "correct" in isolation. But the output here is a VobSub `.idx` `palette:`
/// line, and the entire VobSub ecosystem (the original tooling, mkvtoolnix,
/// players that read the .idx palette) is built around this full-range formula —
/// it is the de-facto on-disk convention. Emitting studio-swing-scaled RGB here
/// would make freemkv's palettes inconsistent with every other tool and wrong in
/// players that assume the VobSub convention. We therefore intentionally keep
/// full-range; do NOT "fix" this to studio-swing without changing the consuming
/// side in lockstep.
pub fn ycbcr_to_rgb(color: &[u8; 4]) -> [u8; 3] {
let y = color[1] as f64;
let cb = color[2] as f64;
let cr = color[3] as f64;
let r = y + 1.402 * (cr - 128.0);
let g = y - 0.344 * (cb - 128.0) - 0.714 * (cr - 128.0);
let b = y + 1.772 * (cb - 128.0);
[clamp_u8(r), clamp_u8(g), clamp_u8(b)]
}
fn clamp_u8(v: f64) -> u8 {
if v < 0.0 {
0
} else if v > 255.0 {
255
} else {
v.round() as u8
}
}
/// Format a 16-color YCbCr palette as a VobSub `.idx` header for S_VOBSUB
/// CodecPrivate.
///
/// Each entry is `[padding, Y, Cb, Cr]`. Output is a UTF-8 text block carrying
/// the two `.idx` header lines mkvmerge / libvobsub expect:
///
/// ```text
/// size: <width>x<height>
/// palette: rrggbb, rrggbb, ...
/// ```
///
/// The `size:` line is the VobSub original-frame resolution (the video frame the
/// subpicture coordinates were authored against). Players read it to place and
/// scale the bitmap; without it, some renderers assume a default frame and
/// mis-position or mis-scale the subtitles. `width`/`height` are the title's
/// coded video dimensions. When either is 0 (unknown) the `size:` line is
/// omitted rather than emitting a `0x0` frame.
///
/// Returns the formatted bytes suitable for MKV codec_private.
pub fn format_palette(palette: &[[u8; 4]], width: u32, height: u32) -> Vec<u8> {
let mut parts: Vec<String> = Vec::with_capacity(palette.len());
for color in palette {
let [r, g, b] = ycbcr_to_rgb(color);
parts.push(format!("{r:02x}{g:02x}{b:02x}"));
}
let mut out = String::new();
if width > 0 && height > 0 {
out.push_str(&format!("size: {width}x{height}\n"));
}
out.push_str(&format!("palette: {}\n", parts.join(", ")));
out.into_bytes()
}
#[cfg(test)]
mod tests {
use super::*;
use crate::mux::ts::PesPacket;
fn make_pes(data: Vec<u8>, pts: Option<i64>) -> PesPacket {
PesPacket {
source: None,
pid: 0x1200,
pts,
dts: None,
data,
discontinuity: false,
}
}
#[test]
fn passthrough_data() {
let mut parser = DvdSubParser::new(None);
let sub_data = vec![0x00, 0x0A, 0x00, 0x08, 0x01, 0xFF, 0x02, 0x03, 0x04, 0x05];
let pes = make_pes(sub_data.clone(), Some(90000));
let frames = parser.parse(&pes);
assert_eq!(frames.len(), 1);
assert_eq!(
frames[0].data, sub_data,
"VobSub data should pass through unmodified"
);
assert_eq!(frames[0].pts_ns, 1_000_000_000);
}
#[test]
fn always_keyframe() {
let mut parser = DvdSubParser::new(None);
for i in 0..3u8 {
let data = vec![0x00, i, 0x00, i + 1];
let pes = make_pes(data, Some(90000 * i as i64));
let frames = parser.parse(&pes);
assert_eq!(frames.len(), 1);
assert!(
frames[0].keyframe,
"DVD subtitle frames should always be keyframes"
);
}
}
#[test]
fn empty_pes_returns_no_frames() {
let mut parser = DvdSubParser::new(None);
let pes = make_pes(Vec::new(), Some(0));
assert!(parser.parse(&pes).is_empty());
}
#[test]
fn codec_private_none_by_default() {
let parser = DvdSubParser::new(None);
assert!(parser.codec_private().is_none());
}
#[test]
fn codec_private_returns_palette_when_set() {
let palette_data = b"palette: 000000, ffffff\n".to_vec();
let parser = DvdSubParser::new(Some(palette_data.clone()));
let cp = parser.codec_private();
assert!(cp.is_some());
assert_eq!(cp.unwrap(), palette_data);
}
#[test]
fn no_pts_defaults_to_zero() {
let mut parser = DvdSubParser::new(None);
// SPU_size = 2, single complete PES (the 2 size bytes themselves).
let pes = make_pes(vec![0x00, 0x02], None);
let frames = parser.parse(&pes);
assert_eq!(frames.len(), 1);
assert_eq!(frames[0].pts_ns, 0);
}
#[test]
fn multi_pes_spu_reassembled() {
let mut parser = DvdSubParser::new(None);
// Declared SPU_size = 12 bytes total. First PES carries the 2 size
// bytes + 4 payload bytes and the only PTS; the next two PESs are
// continuations with PTS=0.
let head = vec![0x00, 0x0C, 0xAA, 0xBB, 0xCC, 0xDD];
let cont1 = vec![0x11, 0x22, 0x33];
let cont2 = vec![0x44, 0x55, 0x66];
let f = parser.parse(&make_pes(head.clone(), Some(90000)));
assert!(f.is_empty(), "incomplete SPU should not emit yet");
// Continuations carry NO PTS (None), per the PS demuxer.
let f = parser.parse(&make_pes(cont1.clone(), None));
assert!(f.is_empty(), "still incomplete");
let frames = parser.parse(&make_pes(cont2.clone(), None));
assert_eq!(frames.len(), 1, "completed SPU emits exactly one frame");
// Reassembled bytes = head + cont1 + cont2, in order.
let mut expected = head;
expected.extend_from_slice(&cont1);
expected.extend_from_slice(&cont2);
assert_eq!(frames[0].data, expected);
// PTS inherited from the head PES (1s = 1e9 ns), not the PTS=0 tails.
assert_eq!(frames[0].pts_ns, 1_000_000_000);
assert!(frames[0].keyframe);
}
#[test]
fn flush_emits_truncated_trailing_spu() {
let mut parser = DvdSubParser::new(None);
// Declared 100 bytes but only 6 ever arrive before EOF.
let head = vec![0x00, 0x64, 0xDE, 0xAD, 0xBE, 0xEF];
let f = parser.parse(&make_pes(head.clone(), Some(90000)));
assert!(f.is_empty(), "incomplete SPU should not emit during parse");
let frames = parser.flush();
assert_eq!(frames.len(), 1, "EOF flush emits the partial SPU");
assert_eq!(frames[0].data, head);
assert_eq!(frames[0].pts_ns, 1_000_000_000);
}
#[test]
fn real_pts_pes_force_emits_stale_pending_and_starts_new_spu() {
// A lost continuation leaves an incomplete pending SPU. The NEXT real
// subtitle arrives with its own PTS — it must force-emit the stuck unit
// (truncated) and begin a fresh SPU, not be appended as a continuation.
let mut parser = DvdSubParser::new(None);
// SPU 1 declares 100 bytes but only 6 arrive; the continuation is lost.
let head1 = vec![0x00, 0x64, 0xDE, 0xAD, 0xBE, 0xEF];
assert!(
parser
.parse(&make_pes(head1.clone(), Some(90000)))
.is_empty(),
"SPU 1 incomplete, held pending"
);
// SPU 2 arrives with a real PTS — declares 4 bytes, fully present.
let head2 = vec![0x00, 0x04, 0x11, 0x22];
let frames = parser.parse(&make_pes(head2.clone(), Some(180000)));
// First the truncated stale SPU 1, then complete SPU 2.
assert_eq!(frames.len(), 2, "stale flushed + new emitted");
assert_eq!(frames[0].data, head1, "stale SPU 1 emitted truncated");
assert_eq!(frames[0].pts_ns, 1_000_000_000, "SPU 1 keeps its PTS");
assert_eq!(frames[1].data, head2, "SPU 2 emitted fresh");
assert_eq!(frames[1].pts_ns, 2_000_000_000, "SPU 2 keeps its own PTS");
}
#[test]
fn corrupt_oversized_size_recovers_on_next_real_pts() {
// A corrupt SPU_size that real data never reaches must not swallow every
// later subtitle. The next real-PTS PES resets pending and recovers the
// track.
let mut parser = DvdSubParser::new(None);
// Declares 0xFFFF but only a few bytes ever arrive (corrupt size).
let bad = vec![0xFF, 0xFF, 0x01, 0x02, 0x03];
assert!(parser.parse(&make_pes(bad.clone(), Some(90000))).is_empty());
// A no-PTS stray continuation appends (still stuck under the bad size).
assert!(parser.parse(&make_pes(vec![0x04, 0x05], None)).is_empty());
// Next real subtitle (PTS present) recovers: stale flushed + new SPU.
let good = vec![0x00, 0x04, 0xAA, 0xBB];
let frames = parser.parse(&make_pes(good.clone(), Some(270000)));
assert_eq!(frames.len(), 2, "track recovers, not swallowed to EOF");
assert_eq!(frames[1].data, good);
assert_eq!(frames[1].pts_ns, 3_000_000_000);
}
#[test]
fn declared_size_below_two_passes_through_as_lone_frame() {
// SPU_size includes its own 2-byte header, so a declared size < 2 is
// malformed. It must pass through as a lone frame, not emit an oversized
// unit or get stuck pending.
let mut parser = DvdSubParser::new(None);
let data = vec![0x00, 0x00, 0xAB, 0xCD]; // declared = 0
let frames = parser.parse(&make_pes(data.clone(), Some(90000)));
assert_eq!(frames.len(), 1);
assert_eq!(frames[0].data, data, "passed through whole");
assert!(parser.pending.is_none(), "no pending left open");
}
// ── YCbCr → RGB conversion tests ──────────────────────────────────────
#[test]
fn ycbcr_to_rgb_white() {
// White in YCbCr: Y=235, Cb=128, Cr=128 → R=235, G=235, B=235
let color = [0x00, 235, 128, 128];
let [r, g, b] = ycbcr_to_rgb(&color);
assert_eq!(r, 235);
assert_eq!(g, 235);
assert_eq!(b, 235);
}
#[test]
fn ycbcr_to_rgb_black() {
// Black: Y=16, Cb=128, Cr=128 → R=16, G=16, B=16
let color = [0x00, 16, 128, 128];
let [r, g, b] = ycbcr_to_rgb(&color);
assert_eq!(r, 16);
assert_eq!(g, 16);
assert_eq!(b, 16);
}
#[test]
fn ycbcr_to_rgb_clamps_overflow() {
// Y=255, Cr=255 → R would be 255 + 1.402*127 = ~433, should clamp to 255
let color = [0x00, 255, 128, 255];
let [r, _g, _b] = ycbcr_to_rgb(&color);
assert_eq!(r, 255);
}
#[test]
fn ycbcr_to_rgb_clamps_underflow() {
// Y=0, Cr=0 → R = 0 + 1.402*(0-128) = -179, should clamp to 0
let color = [0x00, 0, 128, 0];
let [r, _g, _b] = ycbcr_to_rgb(&color);
assert_eq!(r, 0);
}
#[test]
fn ycbcr_to_rgb_red() {
// Approximate red: Y=82, Cb=90, Cr=240
let color = [0x00, 82, 90, 240];
let [r, g, b] = ycbcr_to_rgb(&color);
// R = 82 + 1.402*(240-128) = 82 + 156.9 ≈ 239
// G = 82 - 0.344*(90-128) - 0.714*(240-128) = 82 + 13.1 - 79.97 ≈ 15
// B = 82 + 1.772*(90-128) = 82 - 67.3 ≈ 15
assert!(r > 200, "R should be high for red, got {}", r);
assert!(g < 30, "G should be low for red, got {}", g);
assert!(b < 30, "B should be low for red, got {}", b);
}
// ── Palette formatting tests ──────────────────────────────────────────
#[test]
fn format_palette_basic() {
// Two colors: black and white (at neutral chroma)
let palette = vec![
[0x00, 0, 128, 128], // Y=0 → RGB (0,0,0)
[0x00, 255, 128, 128], // Y=255 → RGB (255,255,255)
];
let result = format_palette(&palette, 0, 0);
let text = String::from_utf8(result).unwrap();
assert!(
text.starts_with("palette: "),
"should start with 'palette: '"
);
assert!(text.ends_with('\n'), "should end with newline");
// First color: 000000
assert!(
text.contains("000000"),
"black should be 000000, got: {}",
text
);
// Second color: ffffff
assert!(
text.contains("ffffff"),
"white should be ffffff, got: {}",
text
);
}
#[test]
fn format_palette_16_colors() {
let palette: Vec<[u8; 4]> = (0..16).map(|i| [0x00, (i * 16) as u8, 128, 128]).collect();
let result = format_palette(&palette, 0, 0);
let text = String::from_utf8(result).unwrap();
// Should have exactly 15 commas (16 colors separated by ", ")
let comma_count = text.matches(", ").count();
assert_eq!(
comma_count, 15,
"16 colors should have 15 separators, got {}",
comma_count
);
}
#[test]
fn format_palette_hex_format() {
// Y=128, Cb=128, Cr=128 → R=128, G=128, B=128 → "808080"
let palette = vec![[0x00, 128, 128, 128]];
let result = format_palette(&palette, 0, 0);
let text = String::from_utf8(result).unwrap();
assert_eq!(text, "palette: 808080\n");
}
#[test]
fn format_palette_emits_size_line_before_palette() {
// With non-zero dimensions the `.idx` `size:` line is prepended ahead of
// the palette so players place/scale the VobSub bitmap (PAL 720x576).
let palette = vec![[0x00, 128, 128, 128]];
let result = format_palette(&palette, 720, 576);
let text = String::from_utf8(result).unwrap();
assert_eq!(
text, "size: 720x576\npalette: 808080\n",
"size: line must precede palette: line"
);
}
#[test]
fn format_palette_omits_size_line_when_dimensions_unknown() {
// 0 width/height (unknown resolution) omits the size line rather than
// emitting a 0x0 frame; the palette line is still present.
let palette = vec![[0x00, 128, 128, 128]];
let result = format_palette(&palette, 0, 576);
let text = String::from_utf8(result).unwrap();
assert_eq!(text, "palette: 808080\n", "no size line when a dim is 0");
}
// --- SPU_size boundary: completes exactly at declared size ---
#[test]
fn spu_completes_exactly_at_declared_size() {
// SPU_size is the total byte length including the 2-byte header. When the
// accumulated bytes reach exactly the declared size, the unit emits.
// Declared = 6, head carries all 6 → emits immediately on the head PES.
let mut parser = DvdSubParser::new(None);
let head = vec![0x00, 0x06, 0xAA, 0xBB, 0xCC, 0xDD]; // 6 bytes, declared 6
let f = parser.parse(&make_pes(head.clone(), Some(90000)));
assert_eq!(f.len(), 1, "complete-on-arrival SPU emits at once");
assert_eq!(f[0].data, head);
assert!(parser.pending.is_none(), "nothing left pending");
}
#[test]
fn spu_one_byte_short_waits_then_completes() {
// Declared 7 but head has 6 → held; a 1-byte continuation completes it.
let mut parser = DvdSubParser::new(None);
let head = vec![0x00, 0x07, 0xAA, 0xBB, 0xCC, 0xDD]; // 6 of 7
assert!(
parser
.parse(&make_pes(head.clone(), Some(90000)))
.is_empty()
);
let f = parser.parse(&make_pes(vec![0xEE], None)); // continuation
assert_eq!(f.len(), 1);
let mut expect = head;
expect.push(0xEE);
assert_eq!(
f[0].data, expect,
"reassembled to exactly the declared size"
);
}
#[test]
fn spu_overshoot_emits_all_buffered_bytes() {
// If a continuation pushes the buffer PAST the declared size, the unit
// still emits with all buffered bytes (>= size triggers emit). Declared
// 5, head 4, continuation 4 → 8 buffered, emits all 8.
let mut parser = DvdSubParser::new(None);
let head = vec![0x00, 0x05, 0xAA, 0xBB]; // 4 of 5
assert!(parser.parse(&make_pes(head, Some(90000))).is_empty());
let f = parser.parse(&make_pes(vec![0xCC, 0xDD, 0xEE, 0xFF], None));
assert_eq!(f.len(), 1);
assert_eq!(
f[0].data,
vec![0x00, 0x05, 0xAA, 0xBB, 0xCC, 0xDD, 0xEE, 0xFF],
"all buffered bytes emitted, not truncated to declared size"
);
}
// --- MAX_SPU_BYTES bound ---
#[test]
fn head_pes_larger_than_max_spu_is_truncated() {
// A head PES larger than MAX_SPU_BYTES (0xFFFF) is truncated to the cap
// when buffered. Declared size in the first 2 bytes = 0xFFFF.
let mut parser = DvdSubParser::new(None);
let mut head = vec![0xFF, 0xFF]; // declared 0xFFFF
head.extend(std::iter::repeat_n(0xAB, MAX_SPU_BYTES + 100));
// The declared size 0xFFFF == buffered cap, so it completes at the cap.
let f = parser.parse(&make_pes(head, Some(90000)));
assert_eq!(f.len(), 1);
assert_eq!(
f[0].data.len(),
MAX_SPU_BYTES,
"head buffer truncated to MAX_SPU_BYTES"
);
}
#[test]
fn continuation_appends_bounded_by_max_spu() {
// A continuation must not push the buffer past MAX_SPU_BYTES. Declared a
// huge size so it never completes naturally, then flood continuations.
let mut parser = DvdSubParser::new(None);
let mut head = vec![0xFF, 0xFE]; // declared 0xFFFE
head.extend(std::iter::repeat_n(0x11, 1000));
assert!(parser.parse(&make_pes(head, Some(90000))).is_empty());
// Flood continuations far exceeding the cap.
for _ in 0..100 {
let _ = parser.parse(&make_pes(vec![0x22u8; 2000], None));
}
let pending_len = parser
.pending
.as_ref()
.map(|(_, _, b)| b.len())
.unwrap_or(0);
assert!(
pending_len <= MAX_SPU_BYTES,
"pending {pending_len} exceeded MAX_SPU_BYTES {MAX_SPU_BYTES}"
);
}
// --- one-byte head: too short to carry SPU_size ---
#[test]
fn single_byte_head_passes_through_as_lone_frame() {
// < 2 bytes can't carry the SPU_size field → passed through as a lone
// frame, not stored pending.
let mut parser = DvdSubParser::new(None);
let f = parser.parse(&make_pes(vec![0xAB], Some(90000)));
assert_eq!(f.len(), 1);
assert_eq!(f[0].data, vec![0xAB]);
assert!(parser.pending.is_none());
}
#[test]
fn declared_size_one_passes_through() {
// declared = 1 < 2 (the 2-byte header itself) is malformed → lone frame.
let mut parser = DvdSubParser::new(None);
let data = vec![0x00, 0x01, 0xAB];
let f = parser.parse(&make_pes(data.clone(), Some(90000)));
assert_eq!(f.len(), 1);
assert_eq!(f[0].data, data);
assert!(parser.pending.is_none());
}
#[test]
fn no_pts_short_segment_without_pending_passes_through() {
// A no-PTS segment with NO pending SPU and too few bytes to carry an
// SPU_size (< 2) has nothing to attach to and can't start a unit → passed
// through as a lone frame at pts 0 (the documented fallback).
let mut parser = DvdSubParser::new(None);
let f = parser.parse(&make_pes(vec![0xAA], None));
assert_eq!(f.len(), 1);
assert_eq!(f[0].pts_ns, 0, "lone no-PTS segment falls back to pts 0");
assert_eq!(f[0].data, vec![0xAA]);
}
#[test]
fn no_pts_sized_segment_without_pending_starts_new_spu() {
// A no-PTS segment with no pending but a valid SPU_size (>= 2) and an
// incomplete length begins a fresh pending SPU (the demuxer may have
// dropped the PTS, but the size field is authoritative for boundary).
// declared = 16, only 3 bytes present → held pending, no emit.
let mut parser = DvdSubParser::new(None);
let f = parser.parse(&make_pes(vec![0x00, 0x10, 0xAA], None));
assert!(f.is_empty(), "incomplete sized segment held, not emitted");
assert!(parser.pending.is_some(), "started a new pending SPU");
assert_eq!(parser.pending.as_ref().unwrap().0, 0, "pts 0 (no PTS)");
}
#[test]
fn flush_empty_when_nothing_pending() {
let mut parser = DvdSubParser::new(None);
assert!(parser.flush().is_empty());
}
// --- YCbCr → RGB green channel + neutral chroma ---
#[test]
fn ycbcr_blue_channel_clamps_high() {
// B = Y + 1.772*(Cb-128). Y=128, Cb=255 → 128 + 1.772*127 ≈ 353 → clamp 255.
let [_r, _g, b] = ycbcr_to_rgb(&[0x00, 128, 255, 128]);
assert_eq!(b, 255, "blue clamps at 255");
}
#[test]
fn format_palette_empty_is_just_prefix() {
// An empty palette yields "palette: \n" (prefix + newline, no entries).
let result = format_palette(&[], 0, 0);
assert_eq!(String::from_utf8(result).unwrap(), "palette: \n");
}
#[test]
fn format_palette_pads_each_channel_to_two_hex_digits() {
// Each RGB channel is formatted as exactly 2 hex digits (zero-padded).
// Y=16,neutral → 0x10 → "101010" (each channel two digits).
let result = format_palette(&[[0x00, 16, 128, 128]], 0, 0);
assert_eq!(String::from_utf8(result).unwrap(), "palette: 101010\n");
}
}