LibGfx: Remove BooleanDecoder

This went unused.
This commit is contained in:
Jelle Raaijmakers 2026-04-30 09:35:10 +02:00 committed by Jelle Raaijmakers
parent 3d1140e998
commit f32bcbc5c9
5 changed files with 0 additions and 196 deletions

View file

@ -302,10 +302,6 @@
# cmakedefine01 UTF8_DEBUG
#endif
#ifndef VPX_DEBUG
# cmakedefine01 VPX_DEBUG
#endif
#ifndef VULKAN_VALIDATION_LAYERS_DEBUG
# cmakedefine01 VULKAN_VALIDATION_LAYERS_DEBUG
#endif

View file

@ -25,7 +25,6 @@ set(SOURCES
ImageFormats/AVIFLoader.cpp
ImageFormats/BMPLoader.cpp
ImageFormats/BMPWriter.cpp
ImageFormats/BooleanDecoder.cpp
ImageFormats/CCITTDecoder.cpp
ImageFormats/GIFLoader.cpp
ImageFormats/ICOLoader.cpp

View file

@ -1,137 +0,0 @@
/*
* Copyright (c) 2021, Hunter Salyer <thefalsehonesty@gmail.com>
* Copyright (c) 2022, Gregory Bertilson <zaggy1024@gmail.com>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#include <AK/BuiltinWrappers.h>
#include <AK/Debug.h>
#include <AK/Endian.h>
#include "BooleanDecoder.h"
namespace Gfx {
// 9.2.1 Initialization process for Boolean decoder
ErrorOr<BooleanDecoder> BooleanDecoder::initialize(ReadonlyBytes data)
{
if (data.size() == 0)
return Error::from_string_literal("Size of decoder range cannot be zero");
// NOTE: This implementation is shared between VP8 and VP9. Therefore, we do not check the
// marker bit at the start of the range decode that is required in the VP9 specification.
// This is instead handled by the function that instantiates all range decoders for the
// VP9 decoder.
// NOTE: As noted below in fill_reservoir(), we read in multi-byte-sized chunks,
// so here we will deviate from the standard to count in bytes rather than bits.
return BooleanDecoder { data.data(), data.size() };
}
// Instead of filling the value field one bit at a time as the spec suggests, we store the
// data to be read in a reservoir of greater than one byte. This allows us to read out data
// for the entire reservoir at once, avoiding a lot of branch misses in read_bool().
void BooleanDecoder::fill_reservoir()
{
if (m_value_bits_left > 8)
return;
// Defer errors until the decode is finalized, so the work to check for errors and return them only has
// to be done once. Not refilling the reservoir here will only result in reading out all zeroes until
// the range decode is finished.
if (m_bytes_left == 0) {
dbgln_if(VPX_DEBUG, "BooleanDecoder has read past the end of the coded range");
m_overread = true;
return;
}
// Read the data into the most significant bits of a variable.
auto read_size = min<size_t>(reserve_bytes, m_bytes_left);
ValueType read_value = 0;
memcpy(&read_value, m_data, read_size);
read_value = AK::convert_between_host_and_big_endian(read_value);
// Skip the number of bytes read in the data.
m_data += read_size;
m_bytes_left -= read_size;
// Shift the value that was read to be less significant than the least significant bit available in the reservoir.
read_value >>= m_value_bits_left;
m_value |= read_value;
m_value_bits_left += read_size * 8;
}
// 9.2.2 Boolean decoding process
bool BooleanDecoder::read_bool(u8 probability)
{
auto split = 1u + (((m_range - 1u) * probability) >> 8u);
// The actual value being read resides in the most significant 8 bits
// of the value field, so we shift the split into that range for comparison.
auto split_shifted = static_cast<ValueType>(split) << reserve_bits;
bool return_bool;
if (m_value < split_shifted) {
m_range = split;
return_bool = false;
} else {
m_range -= split;
m_value -= split_shifted;
return_bool = true;
}
u8 bits_to_shift_into_range = count_leading_zeroes(m_range) - ((sizeof(m_range) - 1) * 8);
m_range <<= bits_to_shift_into_range;
m_value <<= bits_to_shift_into_range;
m_value_bits_left -= bits_to_shift_into_range;
fill_reservoir();
return return_bool;
}
// 9.2.4 Parsing process for read_literal
u8 BooleanDecoder::read_literal(u8 bits)
{
u8 return_value = 0;
for (size_t i = 0; i < bits; i++) {
return_value = (2 * return_value) + read_bool(128);
}
return return_value;
}
ErrorOr<void> BooleanDecoder::finish_decode()
{
if (m_overread)
return Error::from_string_literal("Range decoder was read past the end of its data");
#if VPX_DEBUG
// 9.2.3 Exit process for Boolean decoder
//
// This process is invoked when the function exit_bool( ) is called from the syntax structure.
//
// The padding syntax element is read using the f(BoolMaxBits) parsing process.
//
// It is a requirement of bitstream conformance that padding is equal to 0.
//
// NOTE: This requirement holds up for all of our WebP lossy test inputs, as well.
bool padding_good = true;
if (m_value != 0)
padding_good = false;
while (m_bytes_left > 0) {
if (*m_data != 0)
padding_good = false;
m_data++;
m_bytes_left--;
}
if (!padding_good)
return Error::from_string_literal("Range decoder padding was non-zero");
#endif
return {};
}
}

View file

@ -1,53 +0,0 @@
/*
* Copyright (c) 2021, Hunter Salyer <thefalsehonesty@gmail.com>
* Copyright (c) 2022, Gregory Bertilson <zaggy1024@gmail.com>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/Error.h>
#include <AK/Types.h>
namespace Gfx {
// Can decode bitstreams encoded with VP8's and VP9's arithmetic boolean encoder.
class BooleanDecoder {
public:
static ErrorOr<BooleanDecoder> initialize(ReadonlyBytes data);
/* (9.2) */
bool read_bool(u8 probability);
u8 read_literal(u8 bits);
ErrorOr<void> finish_decode();
private:
using ValueType = size_t;
static constexpr u8 reserve_bytes = sizeof(ValueType) - 1;
static constexpr u8 reserve_bits = reserve_bytes * 8;
BooleanDecoder(u8 const* data, u64 bytes_left)
: m_data(data + 1)
, m_bytes_left(bytes_left - 1)
, m_range(255)
, m_value(static_cast<ValueType>(*data) << reserve_bits)
, m_value_bits_left(8)
{
fill_reservoir();
}
void fill_reservoir();
u8 const* m_data;
size_t m_bytes_left { 0 };
bool m_overread { false };
// This value will never exceed 255. If this is a u8, the compiler will generate a truncation in read_bool().
u32 m_range { 0 };
ValueType m_value { 0 };
// Like above, this will never exceed reserve_bits, but will truncate if it is a u8.
u32 m_value_bits_left { 0 };
};
}

View file

@ -71,7 +71,6 @@ set(UPDATE_LAYOUT_DEBUG ON)
set(URL_PARSER_DEBUG ON)
set(URL_PATTERN_DEBUG ON)
set(UTF8_DEBUG ON)
set(VPX_DEBUG ON)
set(VULKAN_VALIDATION_LAYERS_DEBUG ON)
set(WASI_DEBUG ON)
set(WASI_FINE_GRAINED_DEBUG ON)