webmedia 0.2.0

Standalone raster image and streaming video decoders for Rust applications
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
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
//! VP8 uncompressed frame header (RFC 6386, section 9.1).

use super::backend::MediaDecodeError;
use super::vp8_coeff::CoeffProbs;
use super::vp8_probs::KEYFRAME_BMODE_PROBS;

/// Presentation-only upscaling from RFC 6386 section 9.1.
/// Reference pictures always retain their coded dimensions.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum DisplayScale {
    Unscaled,
    FiveFourths,
    FiveThirds,
    Double,
}

impl DisplayScale {
    fn from_bits(bits: u16) -> Self {
        match bits {
            0 => Self::Unscaled,
            1 => Self::FiveFourths,
            2 => Self::FiveThirds,
            _ => Self::Double,
        }
    }

    pub const fn ratio(self) -> (u32, u32) {
        match self {
            Self::Unscaled => (1, 1),
            Self::FiveFourths => (5, 4),
            Self::FiveThirds => (5, 3),
            Self::Double => (2, 1),
        }
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct FrameHeader {
    pub key_frame: bool,
    pub version: u8,
    pub show_frame: bool,
    pub first_partition_size: usize,
    pub width: Option<u16>,
    pub height: Option<u16>,
    pub horizontal_scale: Option<DisplayScale>,
    pub vertical_scale: Option<DisplayScale>,
}

impl FrameHeader {
    pub fn parse(data: &[u8]) -> Result<Self, MediaDecodeError> {
        if data.len() < 3 {
            return Err(MediaDecodeError::InvalidData(
                "truncated VP8 frame tag".into(),
            ));
        }
        let tag = u32::from(data[0]) | (u32::from(data[1]) << 8) | (u32::from(data[2]) << 16);
        let key_frame = tag & 1 == 0;
        let header_len = if key_frame { 10 } else { 3 };
        if data.len() < header_len {
            return Err(MediaDecodeError::InvalidData(
                "truncated VP8 keyframe header".into(),
            ));
        }
        let first_partition_size = (tag >> 5) as usize;
        if first_partition_size > data.len() - header_len {
            return Err(MediaDecodeError::InvalidData(
                "VP8 first partition exceeds frame".into(),
            ));
        }
        let (width, height, horizontal_scale, vertical_scale) = if key_frame {
            if data[3..6] != [0x9d, 0x01, 0x2a] {
                return Err(MediaDecodeError::InvalidData(
                    "invalid VP8 keyframe marker".into(),
                ));
            }
            let raw_width = u16::from_le_bytes([data[6], data[7]]);
            let raw_height = u16::from_le_bytes([data[8], data[9]]);
            let width = raw_width & 0x3fff;
            let height = raw_height & 0x3fff;
            if width == 0 || height == 0 {
                return Err(MediaDecodeError::InvalidData(
                    "zero-sized VP8 keyframe".into(),
                ));
            }
            (Some(width), Some(height), Some(DisplayScale::from_bits(raw_width >> 14)),
                Some(DisplayScale::from_bits(raw_height >> 14)))
        } else {
            (None, None, None, None)
        };
        Ok(Self {
            key_frame,
            version: ((tag >> 1) & 7) as u8,
            show_frame: tag & 0x10 != 0,
            first_partition_size,
            width,
            height,
            horizontal_scale,
            vertical_scale,
        })
    }

    /// Unrounded display extent; scale ratios remain available separately.
    /// Interframes inherit their last keyframe's display extent.
    pub fn display_size(&self) -> Option<(f64, f64)> {
        let (xn, xd) = self.horizontal_scale?.ratio();
        let (yn, yd) = self.vertical_scale?.ratio();
        Some((f64::from(self.width?) * f64::from(xn) / f64::from(xd),
            f64::from(self.height?) * f64::from(yn) / f64::from(yd)))
    }

    pub fn control_partition<'a>(&self, frame: &'a [u8]) -> &'a [u8] {
        let start = if self.key_frame { 10 } else { 3 };
        &frame[start..start + self.first_partition_size]
    }
}

/// Probability decoder for VP8 control and token partitions.
#[derive(Debug)]
pub struct BoolDecoder<'a> {
    data: &'a [u8],
    next_bit: usize,
    value: u32,
    range: u32,
}

#[derive(Debug)]
pub struct KeyFrameLayout<'a> {
    pub simple_filter: bool,
    pub loop_filter_level: u8,
    pub sharpness_level: u8,
    pub(super) refresh_entropy_probs: bool,
    segment_filter_levels: [i16; 4],
    filter_adjustments: bool,
    reference_filter_deltas: [i16; 4],
    mode_filter_deltas: [i16; 4],
    pub quantizer: u8,
    quant_deltas: [i8; 5],
    segment_quantizers: [i16; 4],
    segment_absolute: bool,
    pub token_partitions: Vec<&'a [u8]>,
    coeff_probs: CoeffProbs,
    control: BoolDecoder<'a>,
    segment_map_update: bool,
    segment_probs: [u8; 3],
    mb_no_skip_coeff: bool,
    prob_skip_false: u8,
    macroblocks_wide: usize,
    macroblocks_high: usize,
    next_macroblock: usize,
    above_b_modes: Vec<u8>,
    left_b_modes: [u8; 4],
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct KeyMacroblockMode {
    pub segment: u8,
    pub skip_coefficients: bool,
    pub luma: u8,
    pub subblocks: [u8; 16],
    pub chroma: u8,
}

impl<'a> KeyFrameLayout<'a> {
    pub fn parse(frame: &'a [u8]) -> Result<Self, MediaDecodeError> {
        let header = FrameHeader::parse(frame)?;
        if !header.key_frame || header.version > 3 {
            return Err(MediaDecodeError::Unsupported);
        }
        let mut control = BoolDecoder::new(header.control_partition(frame))?;
        if control.read_bit()? {
            return Err(MediaDecodeError::Unsupported); // reserved color space
        }
        let _clamping_type = control.read_bit()?;
        let mut segment_probs = [255; 3];
        let mut segment_map_update = false;
        let mut segment_quantizers = [0; 4];
        let mut segment_filter_levels = [0; 4];
        let mut segment_absolute = false;
        if control.read_bit()? {
            let update_map = control.read_bit()?;
            segment_map_update = update_map;
            let update_features = control.read_bit()?;
            if update_features {
                segment_absolute = control.read_bit()?;
                for bits in [7, 6] {
                    for segment in 0..4 {
                        if control.read_bit()? {
                            let magnitude = control.read_literal(bits)? as i16;
                            let negative = control.read_bit()?;
                            if bits == 7 {
                                segment_quantizers[segment] =
                                    if negative { -magnitude } else { magnitude };
                            } else {
                                segment_filter_levels[segment] =
                                    if negative { -magnitude } else { magnitude };
                            }
                        }
                    }
                }
            }
            if update_map {
                for probability in &mut segment_probs {
                    if control.read_bit()? {
                        *probability = control.read_literal(8)? as u8;
                    }
                }
            }
        }
        let simple_filter = control.read_bit()?;
        let loop_filter_level = control.read_literal(6)? as u8;
        let sharpness_level = control.read_literal(3)? as u8;
        let filter_adjustments = control.read_bit()?;
        let mut reference_filter_deltas = [0; 4];
        let mut mode_filter_deltas = [0; 4];
        if filter_adjustments && control.read_bit()? {
            for deltas in [&mut reference_filter_deltas, &mut mode_filter_deltas] {
                for delta in deltas {
                    if control.read_bit()? {
                        let magnitude = control.read_literal(6)? as i16;
                        *delta = if control.read_bit()? {
                            -magnitude
                        } else {
                            magnitude
                        };
                    }
                }
            }
        }
        let count = 1usize << control.read_literal(2)?;
        let quantizer = control.read_literal(7)? as u8;
        let mut quant_deltas = [0; 5];
        for delta in &mut quant_deltas {
            if control.read_bit()? {
                let magnitude = control.read_literal(4)? as i8;
                *delta = if control.read_bit()? {
                    -magnitude
                } else {
                    magnitude
                };
            }
        }
        let refresh_entropy_probs = control.read_bit()?;
        let mut coeff_probs = CoeffProbs::default();
        coeff_probs.update(&mut control)?;
        let mb_no_skip_coeff = control.read_bit()?;
        let prob_skip_false = if mb_no_skip_coeff {
            control.read_literal(8)? as u8
        } else {
            0
        };
        let mut pos = 10 + header.first_partition_size;
        let table_len = (count - 1) * 3;
        if frame.len() < pos + table_len {
            return Err(MediaDecodeError::InvalidData(
                "truncated VP8 partition sizes".into(),
            ));
        }
        let table = &frame[pos..pos + table_len];
        pos += table_len;
        let mut token_partitions = Vec::with_capacity(count);
        for entry in table.chunks_exact(3) {
            let length =
                usize::from(entry[0]) | usize::from(entry[1]) << 8 | usize::from(entry[2]) << 16;
            let end = pos
                .checked_add(length)
                .filter(|end| *end <= frame.len())
                .ok_or_else(|| {
                    MediaDecodeError::InvalidData("VP8 token partition exceeds frame".into())
                })?;
            token_partitions.push(&frame[pos..end]);
            pos = end;
        }
        token_partitions.push(&frame[pos..]);
        let macroblocks_wide = usize::from(header.width.unwrap()).div_ceil(16);
        let macroblocks_high = usize::from(header.height.unwrap()).div_ceil(16);
        Ok(Self {
            simple_filter,
            loop_filter_level,
            sharpness_level,
            refresh_entropy_probs,
            segment_filter_levels,
            filter_adjustments,
            reference_filter_deltas,
            mode_filter_deltas,
            quantizer,
            quant_deltas,
            segment_quantizers,
            segment_absolute,
            token_partitions,
            coeff_probs,
            control,
            segment_map_update,
            segment_probs,
            mb_no_skip_coeff,
            prob_skip_false,
            macroblocks_wide,
            macroblocks_high,
            next_macroblock: 0,
            above_b_modes: vec![0; macroblocks_wide * 4],
            left_b_modes: [0; 4],
        })
    }

    pub fn next_macroblock_mode(&mut self) -> Result<Option<KeyMacroblockMode>, MediaDecodeError> {
        if self.next_macroblock == self.macroblocks_wide * self.macroblocks_high {
            return Ok(None);
        }
        let x = self.next_macroblock % self.macroblocks_wide;
        if x == 0 {
            self.left_b_modes = [0; 4];
        }
        let segment = if self.segment_map_update {
            if self.control.read(self.segment_probs[0])? {
                if self.control.read(self.segment_probs[2])? {
                    3
                } else {
                    2
                }
            } else if self.control.read(self.segment_probs[1])? {
                1
            } else {
                0
            }
        } else {
            0
        };
        let skip_coefficients = self.mb_no_skip_coeff && self.control.read(self.prob_skip_false)?;
        let luma = if !self.control.read(145)? {
            4
        } else if !self.control.read(156)? {
            if self.control.read(163)? {
                1
            } else {
                0
            }
        } else if self.control.read(128)? {
            3
        } else {
            2
        };
        let mut subblocks = [0; 16];
        if luma == 4 {
            for row in 0..4 {
                for col in 0..4 {
                    let above = self.above_b_modes[x * 4 + col];
                    let left = self.left_b_modes[row];
                    let probs: &[u8; 9] =
                        (&KEYFRAME_BMODE_PROBS[((usize::from(above) * 10 + usize::from(left)) * 9)
                            ..((usize::from(above) * 10 + usize::from(left)) * 9 + 9)])
                            .try_into()
                            .unwrap();
                    let mode = read_bmode(&mut self.control, probs)?;
                    subblocks[row * 4 + col] = mode;
                    self.above_b_modes[x * 4 + col] = mode;
                    self.left_b_modes[row] = mode;
                }
            }
        } else {
            let mode = [0, 2, 3, 1][luma as usize];
            subblocks.fill(mode);
            self.above_b_modes[x * 4..x * 4 + 4].fill(mode);
            self.left_b_modes.fill(mode);
        }
        let chroma = if !self.control.read(142)? {
            0
        } else if !self.control.read(114)? {
            1
        } else if !self.control.read(183)? {
            2
        } else {
            3
        };
        self.next_macroblock += 1;
        Ok(Some(KeyMacroblockMode {
            segment,
            skip_coefficients,
            luma,
            subblocks,
            chroma,
        }))
    }

    pub fn decode_coeff_block(
        &self,
        partition: &mut BoolDecoder<'_>,
        plane: usize,
        neighbor_context: usize,
        first_coefficient: usize,
    ) -> Result<([i32; 16], bool), MediaDecodeError> {
        self.coeff_probs
            .decode_block(partition, plane, neighbor_context, first_coefficient)
    }

    pub fn control_decoder(&mut self) -> &mut BoolDecoder<'a> {
        &mut self.control
    }

    pub fn dequant_factors(&self, segment: u8) -> [i32; 6] {
        let base = if self.segment_absolute {
            self.segment_quantizers[segment as usize]
        } else {
            i16::from(self.quantizer) + self.segment_quantizers[segment as usize]
        };
        super::vp8_quant::factors(base, self.quant_deltas)
    }

    pub fn macroblocks_wide(&self) -> usize {
        self.macroblocks_wide
    }

    pub(super) fn macroblocks_high(&self) -> usize {
        self.macroblocks_high
    }

    pub(super) fn coeff_probabilities(&self) -> CoeffProbs {
        self.coeff_probs.clone()
    }

    pub(super) fn segment_features(&self) -> ([i16; 4], [i16; 4], bool) {
        (self.segment_quantizers, self.segment_filter_levels, self.segment_absolute)
    }

    pub(super) fn filter_deltas(&self) -> ([i16; 4], [i16; 4]) {
        (self.reference_filter_deltas, self.mode_filter_deltas)
    }

    pub fn filter_level(&self, segment: u8, luma_mode: u8) -> u8 {
        if self.loop_filter_level == 0 { return 0; }
        let base = if self.segment_absolute {
            self.segment_filter_levels[segment as usize]
        } else {
            i16::from(self.loop_filter_level) + self.segment_filter_levels[segment as usize]
        }.clamp(0, 63);
        let level = if self.filter_adjustments {
            base + self.reference_filter_deltas[0]
                + if luma_mode == 4 { self.mode_filter_deltas[0] } else { 0 }
        } else {
            base
        };
        level.clamp(0, 63) as u8
    }
}

pub(super) fn read_bmode(decoder: &mut BoolDecoder<'_>, p: &[u8; 9]) -> Result<u8, MediaDecodeError> {
    if !decoder.read(p[0])? {
        return Ok(0);
    }
    if !decoder.read(p[1])? {
        return Ok(1);
    }
    if !decoder.read(p[2])? {
        return Ok(2);
    }
    if !decoder.read(p[3])? {
        if !decoder.read(p[4])? {
            return Ok(3);
        }
        return Ok(if decoder.read(p[5])? { 6 } else { 5 });
    }
    if !decoder.read(p[6])? {
        return Ok(4);
    }
    if !decoder.read(p[7])? {
        return Ok(7);
    }
    Ok(if decoder.read(p[8])? { 9 } else { 8 })
}

impl<'a> BoolDecoder<'a> {
    pub fn new(data: &'a [u8]) -> Result<Self, MediaDecodeError> {
        if data.len() < 2 {
            return Err(MediaDecodeError::InvalidData(
                "truncated VP8 partition".into(),
            ));
        }
        Ok(Self {
            data,
            next_bit: 16,
            value: u32::from(u16::from_be_bytes([data[0], data[1]])),
            range: 255,
        })
    }

    #[inline]
    pub fn read(&mut self, probability: u8) -> Result<bool, MediaDecodeError> {
        let split = 1 + ((self.range - 1) * u32::from(probability) >> 8);
        let threshold = split << 8;
        let bit = self.value >= threshold;
        if bit {
            self.value -= threshold;
            self.range -= split;
        } else {
            self.range = split;
        }
        let shift = self.range.leading_zeros() - 24;
        if shift != 0 {
            let byte = self.next_bit / 8;
            if self.next_bit + shift as usize > self.data.len() * 8 + 16 {
                return Err(MediaDecodeError::InvalidData(
                    "truncated VP8 arithmetic code".into(),
                ));
            }
            let window = u32::from(self.data.get(byte).copied().unwrap_or(0)) << 8
                | u32::from(self.data.get(byte + 1).copied().unwrap_or(0));
            let next = (window >> (16 - self.next_bit % 8 - shift as usize))
                & ((1 << shift) - 1);
            self.range <<= shift;
            self.value = (self.value << shift) | next;
            self.next_bit += shift as usize;
        }
        Ok(bit)
    }

    pub fn read_bit(&mut self) -> Result<bool, MediaDecodeError> {
        self.read(128)
    }

    pub fn read_literal(&mut self, bits: usize) -> Result<u32, MediaDecodeError> {
        let mut value = 0;
        for _ in 0..bits {
            value = (value << 1) | u32::from(self.read_bit()?);
        }
        Ok(value)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn bulk_arithmetic_refill_matches_bitwise_reader() {
        for length in [2, 3, 4, 7, 8, 9, 17, 31, 32, 33, 128, 257, 1024] {
            let mut seed = 31u32;
            let data: Vec<u8> = (0..length).map(|_| {
                seed = seed.wrapping_mul(1664525).wrapping_add(1013904223);
                (seed >> 24) as u8
            }).collect();
            let mut bulk = BoolDecoder::new(&data).unwrap();
            let mut scalar = BoolDecoder::new(&data).unwrap();
            for i in 0..10000 {
                let probability = (i * 73) as u8;
                let split = 1 + ((scalar.range - 1) * u32::from(probability) >> 8);
                let threshold = split << 8;
                let expected = scalar.value >= threshold;
                if expected {
                    scalar.value -= threshold;
                    scalar.range -= split;
                } else {
                    scalar.range = split;
                }
                let mut truncated = false;
                while scalar.range < 128 {
                    scalar.range <<= 1;
                    if scalar.next_bit >= data.len() * 8 + 16 {
                        truncated = true;
                        break;
                    }
                    let next = data.get(scalar.next_bit / 8)
                        .map_or(0, |byte| (byte >> (7 - scalar.next_bit % 8)) & 1);
                    scalar.value = (scalar.value << 1) | u32::from(next);
                    scalar.next_bit += 1;
                }
                let result = bulk.read(probability);
                if truncated {
                    assert!(result.is_err());
                    break;
                }
                assert_eq!(result.unwrap(), expected);
                assert_eq!((bulk.range, bulk.value, bulk.next_bit),
                    (scalar.range, scalar.value, scalar.next_bit));
            }
        }
    }

    #[test]
    fn display_scale_hints_do_not_change_reconstruction_dimensions() {
        let frame = [0x30, 0, 0, 0x9d, 1, 0x2a, 0x80, 0x02, 0x68, 0x01, 0];
        let expected = FrameHeader::parse(&frame).unwrap();
        // RFC 6386 section 9.1 keeps reconstruction at the encoded resolution.
        for horizontal in 0..4 {
            for vertical in 0..4 {
                let mut scaled = frame;
                scaled[7] |= horizontal << 6;
                scaled[9] |= vertical << 6;
                let actual = FrameHeader::parse(&scaled).unwrap();
                assert_eq!((actual.width, actual.height), (expected.width, expected.height));
                let scales = [DisplayScale::Unscaled, DisplayScale::FiveFourths,
                    DisplayScale::FiveThirds, DisplayScale::Double];
                assert_eq!(actual.horizontal_scale, Some(scales[horizontal as usize]));
                assert_eq!(actual.vertical_scale, Some(scales[vertical as usize]));
                let (xn, xd) = scales[horizontal as usize].ratio();
                let (yn, yd) = scales[vertical as usize].ratio();
                assert_eq!(actual.display_size(), Some((640.0 * xn as f64 / xd as f64,
                    360.0 * yn as f64 / yd as f64)));
                assert_eq!(FrameHeader { horizontal_scale: expected.horizontal_scale,
                    vertical_scale: expected.vertical_scale, ..actual }, expected);
            }
        }
        let inter = FrameHeader::parse(&[0x11, 0, 0]).unwrap();
        assert_eq!(inter.horizontal_scale, None);
        assert_eq!(inter.vertical_scale, None);
        assert_eq!(inter.display_size(), None);
    }

    #[test]
    fn parses_keyframe_dimensions_and_rejects_bad_marker() {
        let frame = [0x30, 0, 0, 0x9d, 1, 0x2a, 0x80, 0x02, 0x68, 0x01, 0];
        let header = FrameHeader::parse(&frame).unwrap();
        assert_eq!((header.width, header.height), (Some(640), Some(360)));
        assert!(header.key_frame && header.show_frame);
        let mut bad = frame;
        bad[3] = 0;
        assert!(FrameHeader::parse(&bad).is_err());
    }
}