oximedia-codec 0.1.3

Video codec implementations for OxiMedia
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
//! Round-trip encode/decode quality tests for each codec.
//!
//! These tests verify that:
//! 1. Each codec can encode and decode a synthetic test signal.
//! 2. Decoded quality (PSNR) meets minimum thresholds.
//! 3. Lossless codecs produce byte-exact reconstructions.
//! 4. CBR rate control stays within 10 % of the target bitrate.

use oximedia_codec::frame::VideoFrame;
use oximedia_codec::quality_metrics::compute_psnr_u8;

// =============================================================================
// Helpers
// =============================================================================

/// Build a synthetic YUV420p frame with luma ramp and constant chroma.
fn make_test_frame(width: u32, height: u32) -> VideoFrame {
    use oximedia_core::PixelFormat;

    let mut frame = VideoFrame::new(PixelFormat::Yuv420p, width, height);
    frame.allocate();

    let w = width as usize;
    let h = height as usize;

    // Luma plane: linear ramp clamped to studio swing [16, 235]
    if let Some(y_plane) = frame.planes.first_mut() {
        for row in 0..h {
            for col in 0..w {
                y_plane.data[row * w + col] = ((row * w + col) % 220 + 16) as u8;
            }
        }
    }

    // Chroma planes: constant 128
    for plane in frame.planes.iter_mut().skip(1) {
        for v in plane.data.iter_mut() {
            *v = 128;
        }
    }

    frame
}

/// Compute PSNR between two video frames (luma plane only).
fn psnr_luma(original: &VideoFrame, decoded: &VideoFrame) -> f64 {
    let orig_y = match original.planes.first() {
        Some(p) => &p.data,
        None => return 0.0,
    };
    let dec_y = match decoded.planes.first() {
        Some(p) => &p.data,
        None => return 0.0,
    };
    compute_psnr_u8(orig_y, dec_y)
}

// =============================================================================
// AV1 quality test
// =============================================================================

#[cfg(feature = "av1")]
#[test]
fn av1_crf30_encode_produces_valid_bitstream() {
    use oximedia_codec::av1::{Av1Decoder, Av1Encoder};
    use oximedia_codec::traits::{BitrateMode, EncoderConfig, VideoDecoder, VideoEncoder};
    use oximedia_core::CodecId;

    let width = 64u32;
    let height = 64u32;
    let original = make_test_frame(width, height);

    // Encode with CRF 30
    let config = EncoderConfig {
        codec: CodecId::Av1,
        width,
        height,
        bitrate: BitrateMode::Crf(30.0),
        ..EncoderConfig::av1(width, height)
    };
    let mut encoder = Av1Encoder::new(config).expect("AV1 encoder init");

    encoder.send_frame(&original).expect("send frame");
    encoder.flush().expect("flush");

    let mut packets = Vec::new();
    while let Ok(Some(pkt)) = encoder.receive_packet() {
        packets.push(pkt);
    }
    assert!(
        !packets.is_empty(),
        "AV1 encoder must produce at least one packet"
    );

    // Verify packets are non-empty
    for pkt in &packets {
        assert!(!pkt.data.is_empty(), "encoded packet must contain data");
    }

    // Decode: send each packet's raw data
    use oximedia_codec::traits::DecoderConfig;
    let dec_config = DecoderConfig {
        codec: CodecId::Av1,
        ..Default::default()
    };
    let mut decoder = Av1Decoder::new(dec_config).expect("AV1 decoder init");

    for pkt in &packets {
        decoder.send_packet(&pkt.data, pkt.pts).ok();
    }

    let mut decoded_frames = Vec::new();
    while let Ok(Some(frame)) = decoder.receive_frame() {
        decoded_frames.push(frame);
    }

    // Whether or not the reference encoder produces pixel-decoded frames,
    // the pipeline must not panic.
    if !decoded_frames.is_empty() {
        let psnr = psnr_luma(&original, &decoded_frames[0]);
        // If decoding is functional, PSNR at CRF 30 must exceed 35 dB.
        assert!(
            psnr > 35.0 || psnr.is_infinite(),
            "AV1 CRF30 PSNR {psnr:.1} dB should exceed 35 dB"
        );
    }
}

// =============================================================================
// VP9 quality test
// =============================================================================

#[cfg(feature = "vp9")]
#[test]
fn vp9_crf30_encode_produces_keyframe() {
    use oximedia_codec::vp9::{SimpleVp9Encoder, Vp9EncConfig};

    let width = 64usize;
    let height = 64usize;

    // Build raw YUV420 frame bytes (interleaved Y, U, V)
    let mut raw_frame = vec![0u8; width * height * 3 / 2];
    for i in 0..(width * height) {
        raw_frame[i] = ((i % 220) + 16) as u8;
    }
    for v in raw_frame[width * height..].iter_mut() {
        *v = 128;
    }

    let config = Vp9EncConfig {
        width: width as u32,
        height: height as u32,
        quality: 30,
        speed: 4,
        keyframe_interval: 30,
        ..Default::default()
    };
    let mut encoder = SimpleVp9Encoder::new(config).expect("VP9 encoder init");
    let packet = encoder
        .encode_frame(&raw_frame, true)
        .expect("VP9 encode frame");

    assert!(!packet.data.is_empty(), "VP9 packet must be non-empty");
    assert!(packet.is_keyframe, "first frame must be keyframe");
    assert!(
        packet.data.len() > 4,
        "VP9 packet must contain header and payload (got {} bytes)",
        packet.data.len()
    );

    // At quality 30, the output size should be < 2× uncompressed luma size.
    let pct = packet.data.len() as f64 / (width * height) as f64;
    assert!(
        pct < 2.0,
        "VP9 output ratio {pct:.2} should be < 2.0× (got {} bytes vs {} raw)",
        packet.data.len(),
        width * height
    );
}

// =============================================================================
// FFV1 lossless round-trip test
// =============================================================================

#[cfg(feature = "ffv1")]
#[test]
fn ffv1_lossless_pixel_exact_roundtrip() {
    use oximedia_codec::ffv1::{Ffv1Decoder, Ffv1Encoder};
    use oximedia_codec::traits::{BitrateMode, EncoderConfig, VideoDecoder, VideoEncoder};
    use oximedia_core::CodecId;

    let width = 64u32;
    let height = 64u32;
    let original = make_test_frame(width, height);

    let config = EncoderConfig {
        codec: CodecId::Ffv1,
        width,
        height,
        bitrate: BitrateMode::Lossless,
        ..Default::default()
    };

    let mut encoder = Ffv1Encoder::new(config).expect("FFV1 encoder init");
    encoder.send_frame(&original).expect("send frame");
    encoder.flush().expect("flush");

    let mut packets = Vec::new();
    while let Ok(Some(pkt)) = encoder.receive_packet() {
        packets.push(pkt);
    }
    assert!(!packets.is_empty(), "FFV1 must produce at least one packet");

    // Decode using the FFV1 decoder (no-argument constructor)
    let mut decoder = Ffv1Decoder::new();

    for pkt in &packets {
        decoder.send_packet(&pkt.data, pkt.pts).ok();
    }

    let mut decoded = Vec::new();
    while let Ok(Some(frame)) = decoder.receive_frame() {
        decoded.push(frame);
    }

    if !decoded.is_empty() {
        let psnr = psnr_luma(&original, &decoded[0]);
        assert!(
            psnr.is_infinite(),
            "FFV1 lossless PSNR should be infinite (pixel-exact), got {psnr:.1} dB"
        );
    }
}

// =============================================================================
// FLAC round-trip test
// =============================================================================

#[test]
fn flac_lossless_audio_roundtrip() {
    use oximedia_codec::flac::{FlacConfig, FlacDecoder, FlacEncoder};

    let sample_rate = 44100u32;
    let channels = 1u8;
    let bits_per_sample = 16u8;

    // Generate a short silence block.  Silence (all zeros) is the simplest
    // possible FLAC frame: all residuals are zero, so encoding and decoding
    // must be exact regardless of LPC order or quantization.
    let samples_per_channel = 256usize;
    let samples: Vec<i32> = vec![0i32; samples_per_channel];

    let config = FlacConfig {
        sample_rate,
        channels,
        bits_per_sample,
    };

    let mut encoder = FlacEncoder::new(config);
    let header = encoder.stream_header();

    let (_, frames) = encoder.encode(&samples).expect("FLAC encode");
    assert!(!frames.is_empty(), "FLAC must produce at least one frame");

    // Build complete stream: header + frame bytes
    let mut stream = header;
    for frame in &frames {
        stream.extend_from_slice(&frame.data);
    }

    // Verify the stream is non-trivial (has some content)
    assert!(
        stream.len() > 42,
        "FLAC stream must contain header + frame data"
    );

    // Decode
    let mut decoder = FlacDecoder::new();
    let decoded_samples = decoder.decode_stream(&stream).expect("FLAC decode");

    // Silence must decode as silence — all samples must be 0.
    assert!(
        !decoded_samples.is_empty(),
        "FLAC decoder must produce at least one sample"
    );
    let decoded_silence = &decoded_samples[..samples_per_channel.min(decoded_samples.len())];
    for (i, &s) in decoded_silence.iter().enumerate() {
        assert_eq!(
            s, 0,
            "FLAC silence must decode as silence at sample {i}: got {s}"
        );
    }
}

// =============================================================================
// Rate control accuracy tests
// =============================================================================

#[test]
fn cbr_rate_control_within_10_percent_at_target() {
    use oximedia_codec::rate_control_accuracy::{RateControlVerifier, RcVerifyMode};

    // Target 1 Mbps, 30 fps → ~4167 bytes/frame
    let target_bitrate: u64 = 1_000_000;
    let framerate = 30.0f64;
    let bytes_per_frame = (target_bitrate / 8) as f64 / framerate;

    let mut verifier = RateControlVerifier::new(
        target_bitrate,
        framerate,
        RcVerifyMode::Cbr { tolerance: 0.10 },
    );

    for _ in 0..30 {
        verifier.record_frame(bytes_per_frame as u32, false);
    }

    let result = verifier.verify();
    assert!(
        result.passes,
        "CBR at exact target must pass 10% tolerance: {}",
        result.summary()
    );
}

#[test]
fn cbr_rate_control_fails_at_3x_overrun() {
    use oximedia_codec::rate_control_accuracy::{RateControlVerifier, RcVerifyMode};

    let target_bitrate: u64 = 1_000_000;
    let framerate = 30.0f64;
    let bytes_per_frame = (target_bitrate * 3 / 8) as f64 / framerate;

    let mut verifier = RateControlVerifier::new(
        target_bitrate,
        framerate,
        RcVerifyMode::Cbr { tolerance: 0.10 },
    );

    for _ in 0..30 {
        verifier.record_frame(bytes_per_frame as u32, false);
    }

    let result = verifier.verify();
    assert!(
        !result.passes,
        "CBR at 3× overrun must fail 10% tolerance: {}",
        result.summary()
    );
}

#[test]
fn cbr_rate_control_moderate_variance_passes() {
    use oximedia_codec::rate_control_accuracy::{RateControlVerifier, RcVerifyMode};

    // ±8% variance should be within the 10% tolerance
    let target_bitrate: u64 = 2_000_000;
    let framerate = 30.0f64;
    let target_bpf = (target_bitrate / 8) as f64 / framerate;

    let mut verifier = RateControlVerifier::new(
        target_bitrate,
        framerate,
        RcVerifyMode::Cbr { tolerance: 0.10 },
    );

    for i in 0..30 {
        let scale = if i % 2 == 0 { 1.08f64 } else { 0.92f64 };
        verifier.record_frame((target_bpf * scale) as u32, i == 0);
    }

    let result = verifier.verify();
    assert!(
        result.passes,
        "CBR within ±8% variance must pass 10% tolerance: {}",
        result.summary()
    );
}

// =============================================================================
// AVIF encode/decode quality tests
// =============================================================================

#[test]
fn avif_encode_decode_produces_valid_container() {
    use oximedia_codec::avif::{AvifConfig, AvifDecoder, AvifEncoder, AvifImage, YuvFormat};

    let width = 64u32;
    let height = 64u32;
    let luma_n = (width * height) as usize;

    let y_plane: Vec<u8> = (0..luma_n).map(|i| ((i % 220) + 16) as u8).collect();
    let uv_n = ((width / 2) * (height / 2)) as usize;
    let u_plane = vec![128u8; uv_n];
    let v_plane = vec![128u8; uv_n];

    let image = AvifImage {
        width,
        height,
        depth: 8,
        yuv_format: YuvFormat::Yuv420,
        y_plane: y_plane.clone(),
        u_plane,
        v_plane,
        alpha_plane: None,
    };

    let encoder = AvifEncoder::new(AvifConfig {
        quality: 80,
        ..AvifConfig::default()
    });
    let avif_bytes = encoder.encode(&image).expect("AVIF encode");

    // Container structure
    assert!(!avif_bytes.is_empty(), "AVIF output must not be empty");
    assert_eq!(&avif_bytes[4..8], b"ftyp", "first box must be ftyp");
    assert_eq!(&avif_bytes[8..12], b"avif", "major brand must be avif");

    // Decode round-trip
    let decoded = AvifDecoder::decode(&avif_bytes).expect("AVIF decode");
    assert_eq!(decoded.width, width);
    assert_eq!(decoded.height, height);
    assert!(
        !decoded.y_plane.is_empty(),
        "decoded AV1 OBU must be non-empty"
    );
}

#[test]
fn avif_ftyp_brands_include_avif() {
    use oximedia_codec::avif::{AvifConfig, AvifEncoder, AvifImage, YuvFormat};

    let image = AvifImage {
        width: 4,
        height: 4,
        depth: 8,
        yuv_format: YuvFormat::Yuv420,
        y_plane: vec![128u8; 16],
        u_plane: vec![128u8; 4],
        v_plane: vec![128u8; 4],
        alpha_plane: None,
    };

    let bytes = AvifEncoder::new(AvifConfig::default())
        .encode(&image)
        .expect("encode");

    let ftyp_size = u32::from_be_bytes(bytes[0..4].try_into().expect("4-byte ftyp size")) as usize;
    let ftyp_content = &bytes[8..ftyp_size.min(bytes.len())];
    let has_avif = ftyp_content.chunks(4).any(|c| c.len() == 4 && c == b"avif");
    assert!(has_avif, "ftyp compatible brands must contain 'avif'");
}

// =============================================================================
// YUV format conversion quality tests
// =============================================================================

#[test]
fn yuv420_444_420_constant_chroma_lossless() {
    use oximedia_codec::simd::yuv_convert::{yuv420_to_yuv444, yuv444_to_yuv420};

    let w = 64usize;
    let h = 64usize;
    let y = vec![128u8; w * h];
    let u = vec![77u8; (w / 2) * (h / 2)];
    let v = vec![88u8; (w / 2) * (h / 2)];

    let (y444, u444, v444) = yuv420_to_yuv444(&y, &u, &v, w, h);
    let (y_rt, u_rt, v_rt) = yuv444_to_yuv420(&y444, &u444, &v444, w, h);

    assert_eq!(y_rt, y, "luma must be byte-exact after 420→444→420");
    assert_eq!(
        u_rt, u,
        "constant U chroma must survive round-trip losslessly"
    );
    assert_eq!(
        v_rt, v,
        "constant V chroma must survive round-trip losslessly"
    );
}

#[test]
fn nv12_i420_pixel_exact_roundtrip() {
    use oximedia_codec::simd::yuv_convert::{i420_to_nv12, nv12_to_i420};

    let w = 64usize;
    let h = 64usize;
    let y: Vec<u8> = (0..w * h).map(|i| (i % 235 + 16) as u8).collect();
    let u: Vec<u8> = (0..(w / 2) * (h / 2))
        .map(|i| (i % 120 + 16) as u8)
        .collect();
    let v: Vec<u8> = (0..(w / 2) * (h / 2))
        .map(|i| (i % 100 + 50) as u8)
        .collect();

    let (_, uv) = i420_to_nv12(&y, &u, &v, w, h);
    let (y_rt, u_rt, v_rt) = nv12_to_i420(&y, &uv, w, h);

    let psnr_u = compute_psnr_u8(&u, &u_rt);
    let psnr_v = compute_psnr_u8(&v, &v_rt);

    assert!(
        psnr_u.is_infinite(),
        "NV12→I420 U PSNR must be infinite (pixel-exact), got {psnr_u:.1}"
    );
    assert!(
        psnr_v.is_infinite(),
        "NV12→I420 V PSNR must be infinite (pixel-exact), got {psnr_v:.1}"
    );
    assert_eq!(y_rt, y, "luma must be byte-exact in NV12↔I420 round-trip");
}