mirror of
https://github.com/ddidderr/wuffs.git
synced 2026-11-19 16:47:28 +01:00
This commit, part of a series, is inspired by pull request PR #168 by Damian Kaczmarek (with AI assistance), with some modifications. Updates PR #168
458 lines
15 KiB
Plaintext
458 lines
15 KiB
Plaintext
// Copyright 2024 The Wuffs Authors.
|
||
//
|
||
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
||
// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
||
// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
|
||
// option. This file may not be copied, modified, or distributed
|
||
// except according to those terms.
|
||
//
|
||
// SPDX-License-Identifier: Apache-2.0 OR MIT
|
||
|
||
pub status "#bad QUIRK_SOURCE_LENGTH"
|
||
pub status "#bad header"
|
||
pub status "#missing QUIRK_SOURCE_LENGTH"
|
||
pub status "#truncated input"
|
||
pub status "#unsupported QUIRK_SOURCE_LENGTH"
|
||
pub status "#unsupported VP8 file"
|
||
|
||
pub const DECODER_WORKBUF_LEN_MAX_INCL_WORST_CASE : base.u64 = 0x20FF_FFFF
|
||
|
||
pub struct decoder? implements base.image_decoder(
|
||
width : base.u32[..= 0x3FFF],
|
||
height : base.u32[..= 0x3FFF],
|
||
|
||
// Width and height again, but this time measured in 16×16 macroblocks.
|
||
mbw : base.u32[..= 0x400],
|
||
mbh : base.u32[..= 0x400],
|
||
|
||
// The call sequence state machine is discussed in
|
||
// (/doc/std/image-decoders-call-sequence.md).
|
||
call_sequence : base.u8,
|
||
|
||
is_key_frame : base.bool,
|
||
|
||
frame_config_io_position : base.u64,
|
||
|
||
quirk_source_length : base.u64,
|
||
|
||
// Just under 144 MiB, for 9 partitions each up to 0xFF_FFFF bytes.
|
||
partitioned_data_length : base.u32[..= 0x08FF_FFF7],
|
||
|
||
// args.workbuf strides and offsets.
|
||
//
|
||
// The workbuf holds the YUV buffers (after decoding from the source
|
||
// bytes but before converting YUV to RGBX) and then also a copy of
|
||
// most of the source bytes themselves - the "at least 2, up to 9"
|
||
// partitions after the frame header. Decoding successive rows of
|
||
// macroblocks alternates between the other (not-first) partitions.
|
||
// Source bytes are processed with random (not sequential) access.
|
||
workbuf_yuv_y_stride : base.u32[..= 0x4000],
|
||
workbuf_yuv_uv_stride : base.u32[..= 0x2000],
|
||
workbuf_yuv_y_end : base.u64[..= 0x1000_0000],
|
||
workbuf_yuv_u_end : base.u64[..= 0x1400_0000],
|
||
workbuf_yuv_v_end : base.u64[..= 0x1800_0000],
|
||
|
||
// Partition lengths and per-partition entropy decoder state.
|
||
//
|
||
// On naming: "foobar_m1" is "foobar minus 1" and "foobar_m1s" is the
|
||
// plural, "an array of (foobar - 1) values".
|
||
part_workbuf_ris : array[9] base.u64,
|
||
part_range_m1s : array[9] base.u32[..= 0xFF],
|
||
part_bits : array[9] base.u32,
|
||
part_n_bits : array[9] base.u32,
|
||
part_lens : array[9] base.u32[..= 0xFF_FFFF],
|
||
|
||
// The number of other partitions (other than the first one), minus 1.
|
||
num_other_partitions_m1 : base.u32[..= 7],
|
||
|
||
// Segmentation parameters.
|
||
seg_enabled : base.bool,
|
||
seg_update_map : base.bool,
|
||
seg_absolute : base.bool,
|
||
seg_quants : array[4] base.u8,
|
||
seg_strengths : array[4] base.u8,
|
||
seg_probs : array[3] base.u8,
|
||
|
||
// Loop filter parameters.
|
||
filt_simple : base.bool,
|
||
filt_level : base.u8[..= 63],
|
||
filt_sharpness : base.u8[..= 7],
|
||
filt_deltas_enabled : base.bool,
|
||
filt_deltas : array[2] array[4] base.u8,
|
||
|
||
// Dequantization parameters.
|
||
quant_yac_qi : base.u32[..= 127],
|
||
quant_ydc_delta : base.u32,
|
||
quant_y2dc_delta : base.u32,
|
||
quant_y2ac_delta : base.u32,
|
||
quant_uvdc_delta : base.u32,
|
||
quant_uvac_delta : base.u32,
|
||
|
||
// Look-up tables derived from the dequantization parameters.
|
||
//
|
||
// The first index is the segment. The second index is Y/Y2/UV. The
|
||
// third index is DC/AC.
|
||
dequants : array[4] array[3] array[2] base.u16,
|
||
|
||
// These 9 bits combine what RFC 6386 calls mb_no_skip_coeff (which we
|
||
// hold in the 0x100 bit) and prob_skip_false (in the low 8 bits).
|
||
prob_skip : base.u32[..= 0x1FF],
|
||
|
||
mb_subblock_modes : array[16] base.u8[..= 9],
|
||
|
||
dst_x : base.u32,
|
||
dst_y : base.u32,
|
||
|
||
swizzler : base.pixel_swizzler,
|
||
util : base.utility,
|
||
) + (
|
||
// 1056 is (4 planes, 8 bands, 3 contexts, 11 tokens) flattened.
|
||
coeff_probs : array[1056] base.u8,
|
||
|
||
mb_coeffs : array[25] array[16] base.u16,
|
||
|
||
// Macroblock states are a u32 whose bits are packed like this:
|
||
//
|
||
// - 28 ..= 31 are Chroma (UV) HNZC bits.
|
||
// - 24 ..= 27 are Luma4 (Y4) HNZC bits.
|
||
// - 23 is Luma16 (Y16) HNZC bit.
|
||
// - 16 ..= 22 are unused.
|
||
// - 12 ..= 15 are the 3rd predictor mode.
|
||
// - 8 ..= 12 are the 2nd predictor mode.
|
||
// - 4 ..= 7 are the 1st predictor mode.
|
||
// - 0 ..= 3 are the 0th predictor mode.
|
||
//
|
||
// HNZC stands for has-non-zero-coefficients.
|
||
//
|
||
// The mb_states_top array is indexed by mbx.
|
||
mb_states_left : base.u32,
|
||
mb_states_top : array[0x400] base.u32,
|
||
)
|
||
|
||
pub func decoder.get_quirk(key: base.u32) base.u64 {
|
||
if args.key == base.QUIRK_SOURCE_LENGTH {
|
||
return this.quirk_source_length
|
||
}
|
||
return 0
|
||
}
|
||
|
||
pub func decoder.set_quirk!(key: base.u32, value: base.u64) base.status {
|
||
if args.key == base.QUIRK_SOURCE_LENGTH {
|
||
this.quirk_source_length = args.value
|
||
return ok
|
||
}
|
||
return base."#unsupported option"
|
||
}
|
||
|
||
pub func decoder.decode_image_config?(dst: nptr base.image_config, src: base.io_reader) {
|
||
var status : base.status
|
||
|
||
while true {
|
||
status =? this.do_decode_image_config?(dst: args.dst, src: args.src)
|
||
if (status == base."$short read") and args.src.is_closed() {
|
||
return "#truncated input"
|
||
}
|
||
yield? status
|
||
}
|
||
}
|
||
|
||
pri func decoder.do_decode_image_config?(dst: nptr base.image_config, src: base.io_reader) {
|
||
var c32 : base.u32
|
||
|
||
if this.call_sequence <> 0x00 {
|
||
return base."#bad call sequence"
|
||
}
|
||
|
||
if (this.quirk_source_length & 1) == 0 {
|
||
return "#missing QUIRK_SOURCE_LENGTH"
|
||
} else if (this.quirk_source_length >> 1) < 10 {
|
||
return "#bad QUIRK_SOURCE_LENGTH"
|
||
} else if (this.quirk_source_length >> 1) > (0x08FF_FFF7 + 10) {
|
||
return "#unsupported QUIRK_SOURCE_LENGTH"
|
||
}
|
||
this.partitioned_data_length = ((this.quirk_source_length >> 1) as base.u32) - 10
|
||
|
||
// RFC 6386 Section 9. Frame Header, up to and including 9.1. Uncompressed
|
||
// Data Chunk. decode_first_partition handles the rest of section 9.
|
||
|
||
c32 = args.src.read_u24le_as_u32?()
|
||
this.is_key_frame = ((c32 & 0x01) == 0)
|
||
if not this.is_key_frame {
|
||
// TODO: support non-key frames.
|
||
return "#unsupported VP8 file"
|
||
}
|
||
this.part_lens[0] = c32 >> 5
|
||
if this.part_lens[0] > this.partitioned_data_length {
|
||
return "#bad header"
|
||
}
|
||
|
||
c32 = args.src.read_u24le_as_u32?()
|
||
if c32 <> '\x9D\x01\x2A'le {
|
||
return "#bad header"
|
||
}
|
||
|
||
c32 = args.src.read_u32le?()
|
||
this.width = 0x3FFF & (c32 >> 0)
|
||
this.height = 0x3FFF & (c32 >> 16)
|
||
this.mbw = (this.width + 15) / 16
|
||
this.mbh = (this.height + 15) / 16
|
||
|
||
this.workbuf_yuv_y_stride = this.mbw * 16
|
||
this.workbuf_yuv_uv_stride = this.mbw * 8
|
||
this.workbuf_yuv_y_end =
|
||
((this.workbuf_yuv_y_stride as base.u64) * ((this.mbh * 16) as base.u64))
|
||
this.workbuf_yuv_u_end = this.workbuf_yuv_y_end +
|
||
((this.workbuf_yuv_uv_stride as base.u64) * ((this.mbh * 8) as base.u64))
|
||
this.workbuf_yuv_v_end = this.workbuf_yuv_u_end +
|
||
((this.workbuf_yuv_uv_stride as base.u64) * ((this.mbh * 8) as base.u64))
|
||
|
||
this.frame_config_io_position = args.src.position()
|
||
|
||
if args.dst <> nullptr {
|
||
args.dst.set!(
|
||
pixfmt: base.PIXEL_FORMAT__BGRX,
|
||
pixsub: 0,
|
||
width: this.width,
|
||
height: this.height,
|
||
first_frame_io_position: this.frame_config_io_position,
|
||
first_frame_is_opaque: false)
|
||
}
|
||
|
||
this.call_sequence = 0x20
|
||
}
|
||
|
||
pub func decoder.decode_frame_config?(dst: nptr base.frame_config, src: base.io_reader) {
|
||
var status : base.status
|
||
|
||
while true {
|
||
status =? this.do_decode_frame_config?(dst: args.dst, src: args.src)
|
||
if (status == base."$short read") and args.src.is_closed() {
|
||
return "#truncated input"
|
||
}
|
||
yield? status
|
||
}
|
||
}
|
||
|
||
pri func decoder.do_decode_frame_config?(dst: nptr base.frame_config, src: base.io_reader) {
|
||
if this.call_sequence == 0x20 {
|
||
// No-op.
|
||
} else if this.call_sequence < 0x20 {
|
||
this.do_decode_image_config?(dst: nullptr, src: args.src)
|
||
} else if this.call_sequence == 0x28 {
|
||
if this.frame_config_io_position <> args.src.position() {
|
||
return base."#bad restart"
|
||
}
|
||
} else if this.call_sequence == 0x40 {
|
||
this.call_sequence = 0x60
|
||
return base."@end of data"
|
||
} else {
|
||
return base."@end of data"
|
||
}
|
||
|
||
if args.dst <> nullptr {
|
||
args.dst.set!(bounds: this.util.make_rect_ie_u32(
|
||
min_incl_x: 0,
|
||
min_incl_y: 0,
|
||
max_excl_x: this.width,
|
||
max_excl_y: this.height),
|
||
duration: 0,
|
||
index: 0,
|
||
io_position: this.frame_config_io_position,
|
||
disposal: 0,
|
||
opaque_within_bounds: false,
|
||
overwrite_instead_of_blend: false,
|
||
background_color: 0xFF00_0000)
|
||
}
|
||
|
||
this.call_sequence = 0x40
|
||
}
|
||
|
||
pub func decoder.decode_frame?(dst: ptr base.pixel_buffer, src: base.io_reader, blend: base.pixel_blend, workbuf: slice base.u8, opts: nptr base.decode_frame_options) {
|
||
var wb_len : base.u64[..= DECODER_WORKBUF_LEN_MAX_INCL_WORST_CASE]
|
||
var status : base.status
|
||
|
||
while true {
|
||
wb_len = this.workbuf_yuv_v_end + (this.partitioned_data_length as base.u64) + 8
|
||
if wb_len > args.workbuf.length() {
|
||
return base."#bad workbuf length"
|
||
} else {
|
||
args.workbuf = args.workbuf[.. wb_len]
|
||
}
|
||
|
||
status =? this.do_decode_frame?(dst: args.dst, src: args.src, blend: args.blend, workbuf: args.workbuf, opts: args.opts)
|
||
if (status == base."$short read") and args.src.is_closed() {
|
||
return "#truncated input"
|
||
}
|
||
yield? status
|
||
}
|
||
}
|
||
|
||
pri func decoder.do_decode_frame?(dst: ptr base.pixel_buffer, src: base.io_reader, blend: base.pixel_blend, workbuf: slice base.u8, opts: nptr base.decode_frame_options) {
|
||
var i : base.u32
|
||
var status : base.status
|
||
|
||
if this.call_sequence == 0x40 {
|
||
// No-op.
|
||
} else if this.call_sequence < 0x40 {
|
||
this.do_decode_frame_config?(dst: nullptr, src: args.src)
|
||
} else {
|
||
return base."@end of data"
|
||
}
|
||
|
||
this.copy_partitions_to_workbuf?(src: args.src, workbuf: args.workbuf)
|
||
|
||
// Initialize per-partition bitstreams.
|
||
i = 0
|
||
while i < 9 {
|
||
this.part_workbuf_ris[i] = this.workbuf_yuv_v_end
|
||
this.part_range_m1s[i] = 0xFE
|
||
this.part_bits[i] = 0
|
||
this.part_n_bits[i] = 0
|
||
i += 1
|
||
}
|
||
|
||
status = this.decode_first_partition!(workbuf: args.workbuf)
|
||
if not status.is_ok() {
|
||
return status
|
||
}
|
||
|
||
status = this.decode_other_partition_lengths!(workbuf: args.workbuf)
|
||
if not status.is_ok() {
|
||
return status
|
||
}
|
||
|
||
status = this.decode_macroblocks!(workbuf: args.workbuf)
|
||
if not status.is_ok() {
|
||
return status
|
||
}
|
||
|
||
this.dst_x = 0
|
||
this.dst_y = 0
|
||
|
||
status = this.swizzler.prepare!(
|
||
dst_pixfmt: args.dst.pixel_format(),
|
||
dst_palette: args.dst.palette(),
|
||
src_pixfmt: this.util.make_pixel_format(repr: base.PIXEL_FORMAT__BGRX),
|
||
src_palette: this.util.empty_slice_u8(),
|
||
blend: args.blend)
|
||
if not status.is_ok() {
|
||
return status
|
||
}
|
||
|
||
// TODO: actually decode the pixels.
|
||
status = this.make_a_placeholder_gradient!(dst: args.dst)
|
||
if not status.is_ok() {
|
||
return status
|
||
}
|
||
|
||
this.call_sequence = 0x60
|
||
}
|
||
|
||
pri func decoder.make_a_placeholder_gradient!(dst: ptr base.pixel_buffer) base.status {
|
||
var dst_pixfmt : base.pixel_format
|
||
var dst_bits_per_pixel : base.u32[..= 256]
|
||
var dst_bytes_per_pixel : base.u32[..= 32]
|
||
var dst_bytes_per_row : base.u64
|
||
var tab : table base.u8
|
||
var dst : slice base.u8
|
||
var i : base.u64
|
||
var bgrx : array[4] base.u8
|
||
|
||
// TODO: the dst_pixfmt variable shouldn't be necessary. We should be able
|
||
// to chain the two calls: "args.dst.pixel_format().bits_per_pixel()".
|
||
dst_pixfmt = args.dst.pixel_format()
|
||
dst_bits_per_pixel = dst_pixfmt.bits_per_pixel()
|
||
if (dst_bits_per_pixel & 7) <> 0 {
|
||
return base."#unsupported option"
|
||
}
|
||
dst_bytes_per_pixel = dst_bits_per_pixel / 8
|
||
dst_bytes_per_row = (this.width * dst_bytes_per_pixel) as base.u64
|
||
tab = args.dst.plane(p: 0)
|
||
|
||
bgrx[0] = 0x80
|
||
|
||
while this.dst_y < this.height {
|
||
assert this.dst_y < 0x3FFF via "a < b: a < c; c <= b"(c: this.height)
|
||
bgrx[1] = (this.dst_y & 0xFF) as base.u8
|
||
|
||
this.dst_x = 0
|
||
while this.dst_x < this.width,
|
||
inv this.dst_y < 0x3FFF,
|
||
{
|
||
assert this.dst_x < 0x3FFF via "a < b: a < c; c <= b"(c: this.width)
|
||
bgrx[2] = (this.dst_x & 0xFF) as base.u8
|
||
|
||
dst = tab.row_u32(y: this.dst_y)
|
||
if dst_bytes_per_row < dst.length() {
|
||
dst = dst[.. dst_bytes_per_row]
|
||
}
|
||
i = (this.dst_x as base.u64) * (dst_bytes_per_pixel as base.u64)
|
||
if i < dst.length() {
|
||
this.swizzler.swizzle_interleaved_from_slice!(
|
||
dst: dst[i ..],
|
||
dst_palette: args.dst.palette(),
|
||
src: bgrx[.. 4])
|
||
}
|
||
|
||
this.dst_x += 1
|
||
}
|
||
this.dst_y += 1
|
||
}
|
||
|
||
return ok
|
||
}
|
||
|
||
pub func decoder.frame_dirty_rect() base.rect_ie_u32 {
|
||
return this.util.make_rect_ie_u32(
|
||
min_incl_x: 0,
|
||
min_incl_y: 0,
|
||
max_excl_x: this.width,
|
||
max_excl_y: this.height)
|
||
}
|
||
|
||
pub func decoder.num_animation_loops() base.u32 {
|
||
return 0
|
||
}
|
||
|
||
pub func decoder.num_decoded_frame_configs() base.u64 {
|
||
if this.call_sequence > 0x20 {
|
||
return 1
|
||
}
|
||
return 0
|
||
}
|
||
|
||
pub func decoder.num_decoded_frames() base.u64 {
|
||
if this.call_sequence > 0x40 {
|
||
return 1
|
||
}
|
||
return 0
|
||
}
|
||
|
||
pub func decoder.restart_frame!(index: base.u64, io_position: base.u64) base.status {
|
||
if this.call_sequence < 0x20 {
|
||
return base."#bad call sequence"
|
||
}
|
||
if (args.index <> 0) or (args.io_position <> this.frame_config_io_position) {
|
||
return base."#bad argument"
|
||
}
|
||
this.call_sequence = 0x28
|
||
return ok
|
||
}
|
||
|
||
pub func decoder.set_report_metadata!(fourcc: base.u32, report: base.bool) {
|
||
// No-op. VP8 doesn't support metadata (but WEBP does).
|
||
}
|
||
|
||
pub func decoder.tell_me_more?(dst: base.io_writer, minfo: nptr base.more_information, src: base.io_reader) {
|
||
return base."#no more information"
|
||
}
|
||
|
||
pub func decoder.workbuf_len() base.range_ii_u64 {
|
||
var wb_len : base.u64[..= DECODER_WORKBUF_LEN_MAX_INCL_WORST_CASE]
|
||
|
||
wb_len = this.workbuf_yuv_v_end + (this.partitioned_data_length as base.u64) + 8
|
||
return this.util.make_range_ii_u64(
|
||
min_incl: wb_len,
|
||
max_incl: wb_len)
|
||
}
|