mirror of
https://github.com/RGBCube/serenity
synced 2025-05-31 11:38:11 +00:00
LibGfx: Commonize functions in P*MLoader class implementations
Problem: - Functions are duplicated in [PBM,PGM,PPM]Loader class implementations. They are functionally equivalent. This does not follow the DRY (Don't Repeat Yourself) principle. Solution: - Factor out the common functions into a separate file. - Refactor common code to generic functions. - Change `PPM_DEBUG` macro to be `PORTABLE_IMAGE_LOADER_DEBUG` to work with all the supported types. This requires adding the image type to the debug log messages for easier debugging.
This commit is contained in:
Lenny Maiorani
Andreas Kling
parent
6fac1abac4
commit
a95d230a3e
6 changed files with 367 additions and 685 deletions
318
Libraries/LibGfx/PortableImageLoaderCommon.h
Normal file
318
Libraries/LibGfx/PortableImageLoaderCommon.h
Normal file
|
|
@ -0,0 +1,318 @@
|
|||
/*
|
||||
* Copyright (c) 2020, the SerenityOS developers, Hüseyin ASLITÜRK <asliturk@hotmail.com>
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
* this list of conditions and the following disclaimer in the documentation
|
||||
* and/or other materials provided with the distribution.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "Streamer.h"
|
||||
#include <AK/Array.h>
|
||||
#include <AK/Endian.h>
|
||||
#include <AK/LexicalPath.h>
|
||||
#include <AK/MappedFile.h>
|
||||
#include <AK/ScopeGuard.h>
|
||||
#include <AK/String.h>
|
||||
#include <AK/StringBuilder.h>
|
||||
#include <AK/Types.h>
|
||||
#include <AK/Vector.h>
|
||||
|
||||
//#define PORTABLE_IMAGE_LOADER_DEBUG
|
||||
|
||||
namespace Gfx {
|
||||
|
||||
static constexpr Color adjust_color(u16 max_val, Color color)
|
||||
{
|
||||
color.set_red((color.red() * 255) / max_val);
|
||||
color.set_green((color.green() * 255) / max_val);
|
||||
color.set_blue((color.blue() * 255) / max_val);
|
||||
|
||||
return color;
|
||||
}
|
||||
|
||||
template<typename TValue>
|
||||
static bool read_number(Streamer& streamer, TValue* value)
|
||||
{
|
||||
u8 byte {};
|
||||
StringBuilder sb {};
|
||||
|
||||
while (streamer.read(byte)) {
|
||||
if (byte == ' ' || byte == '\t' || byte == '\n' || byte == '\r') {
|
||||
streamer.step_back();
|
||||
break;
|
||||
}
|
||||
|
||||
sb.append(byte);
|
||||
}
|
||||
|
||||
const auto opt_value = sb.to_string().to_uint();
|
||||
if (!opt_value.has_value()) {
|
||||
*value = 0;
|
||||
return false;
|
||||
}
|
||||
|
||||
*value = static_cast<u16>(opt_value.value());
|
||||
return true;
|
||||
}
|
||||
|
||||
template<typename TContext>
|
||||
static bool read_comment([[maybe_unused]] TContext& context, Streamer& streamer)
|
||||
{
|
||||
bool exist = false;
|
||||
u8 byte {};
|
||||
|
||||
while (streamer.read(byte)) {
|
||||
if (byte == '#') {
|
||||
exist = true;
|
||||
} else if (byte == '\t' || byte == '\n') {
|
||||
return exist;
|
||||
}
|
||||
}
|
||||
|
||||
return exist;
|
||||
}
|
||||
|
||||
template<typename TContext>
|
||||
static bool read_magic_number(TContext& context, Streamer& streamer)
|
||||
{
|
||||
if (context.state >= TContext::State::MagicNumber) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if (!context.data || context.data_size < 2) {
|
||||
context.state = TContext::State::Error;
|
||||
#ifdef PORTABLE_IMAGE_LOADER_DEBUG
|
||||
dbg() << "There is no enough data for " << TContext::image_type;
|
||||
#endif
|
||||
return false;
|
||||
}
|
||||
|
||||
u8 magic_number[2] {};
|
||||
if (!streamer.read_bytes(magic_number, 2)) {
|
||||
context.state = TContext::State::Error;
|
||||
#ifdef PORTABLE_IMAGE_LOADER_DEBUG
|
||||
dbg() << "We can't read magic number for " << TContext::image_type;
|
||||
#endif
|
||||
return false;
|
||||
}
|
||||
|
||||
if (magic_number[0] == 'P' && magic_number[1] == TContext::ascii_magic_number) {
|
||||
context.type = TContext::Type::ASCII;
|
||||
context.state = TContext::State::MagicNumber;
|
||||
return true;
|
||||
}
|
||||
|
||||
if (magic_number[0] == 'P' && magic_number[1] == TContext::binary_magic_number) {
|
||||
context.type = TContext::Type::RAWBITS;
|
||||
context.state = TContext::State::MagicNumber;
|
||||
return true;
|
||||
}
|
||||
|
||||
context.state = TContext::State::Error;
|
||||
#ifdef PORTABLE_IMAGE_LOADER_DEBUG
|
||||
dbg() << "Magic number is not valid for "
|
||||
<< magic_number[0] << magic_number[1] << TContext::image_type;
|
||||
#endif
|
||||
return false;
|
||||
}
|
||||
|
||||
template<typename TContext>
|
||||
static bool read_white_space(TContext& context, Streamer& streamer)
|
||||
{
|
||||
bool exist = false;
|
||||
u8 byte {};
|
||||
|
||||
while (streamer.read(byte)) {
|
||||
if (byte == ' ' || byte == '\t' || byte == '\n' || byte == '\r') {
|
||||
exist = true;
|
||||
} else if (byte == '#') {
|
||||
streamer.step_back();
|
||||
read_comment(context, streamer);
|
||||
} else {
|
||||
streamer.step_back();
|
||||
return exist;
|
||||
}
|
||||
}
|
||||
|
||||
return exist;
|
||||
}
|
||||
|
||||
template<typename TContext>
|
||||
static bool read_width(TContext& context, Streamer& streamer)
|
||||
{
|
||||
if (const bool result = read_number(streamer, &context.width);
|
||||
!result || context.width == 0) {
|
||||
return false;
|
||||
}
|
||||
|
||||
context.state = TContext::Width;
|
||||
return true;
|
||||
}
|
||||
|
||||
template<typename TContext>
|
||||
static bool read_height(TContext& context, Streamer& streamer)
|
||||
{
|
||||
if (const bool result = read_number(streamer, &context.height);
|
||||
!result || context.height == 0) {
|
||||
return false;
|
||||
}
|
||||
|
||||
context.state = TContext::Height;
|
||||
return true;
|
||||
}
|
||||
|
||||
template<typename TContext>
|
||||
static bool read_max_val(TContext& context, Streamer& streamer)
|
||||
{
|
||||
if (const bool result = read_number(streamer, &context.max_val);
|
||||
!result || context.max_val == 0) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (context.max_val > 255) {
|
||||
#ifdef PORTABLE_IMAGE_LOADER_DEBUG
|
||||
dbg() << "We can't parse 2 byte color for " << TContext::image_type;
|
||||
#endif
|
||||
context.state = TContext::Error;
|
||||
return false;
|
||||
}
|
||||
|
||||
context.state = TContext::Maxval;
|
||||
return true;
|
||||
}
|
||||
|
||||
template<typename TContext>
|
||||
static bool create_bitmap(TContext& context)
|
||||
{
|
||||
context.bitmap = Bitmap::create_purgeable(BitmapFormat::RGB32, { context.width, context.height });
|
||||
if (!context.bitmap) {
|
||||
context.state = TContext::State::Error;
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
template<typename TContext>
|
||||
static void set_adjusted_pixels(TContext& context, const AK::Vector<Gfx::Color>& color_data)
|
||||
{
|
||||
size_t index = 0;
|
||||
for (int y = 0; y < context.height; ++y) {
|
||||
for (int x = 0; x < context.width; ++x) {
|
||||
Color color = color_data.at(index);
|
||||
if (context.max_val < 255) {
|
||||
color = adjust_color(context.max_val, color);
|
||||
}
|
||||
context.bitmap->set_pixel(x, y, color);
|
||||
index++;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
template<typename TContext>
|
||||
static void set_pixels(TContext& context, const AK::Vector<Gfx::Color>& color_data)
|
||||
{
|
||||
size_t index = 0;
|
||||
for (int y = 0; y < context.height; ++y) {
|
||||
for (int x = 0; x < context.width; ++x) {
|
||||
context.bitmap->set_pixel(x, y, color_data.at(index));
|
||||
index++;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
template<typename TContext>
|
||||
static bool decode(TContext& context)
|
||||
{
|
||||
if (context.state >= TContext::State::Decoded)
|
||||
return true;
|
||||
|
||||
auto error_guard = ArmedScopeGuard([&] {
|
||||
context.state = TContext::State::Error;
|
||||
});
|
||||
|
||||
Streamer streamer(context.data, context.data_size);
|
||||
|
||||
if (!read_magic_number(context, streamer))
|
||||
return false;
|
||||
|
||||
if (!read_white_space(context, streamer))
|
||||
return false;
|
||||
|
||||
if (!read_width(context, streamer))
|
||||
return false;
|
||||
|
||||
if (!read_white_space(context, streamer))
|
||||
return false;
|
||||
|
||||
if (!read_height(context, streamer))
|
||||
return false;
|
||||
|
||||
if (!read_white_space(context, streamer))
|
||||
return false;
|
||||
|
||||
if constexpr (requires { context.max_val; }) {
|
||||
if (!read_max_val(context, streamer))
|
||||
return false;
|
||||
|
||||
if (!read_white_space(context, streamer))
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!read_image_data(context, streamer))
|
||||
return false;
|
||||
|
||||
error_guard.disarm();
|
||||
context.state = TContext::State::Decoded;
|
||||
return true;
|
||||
}
|
||||
|
||||
template<typename TContext>
|
||||
static RefPtr<Gfx::Bitmap> load_impl(const u8* data, size_t data_size)
|
||||
{
|
||||
TContext context {};
|
||||
context.data = data;
|
||||
context.data_size = data_size;
|
||||
|
||||
if (!decode(context)) {
|
||||
return nullptr;
|
||||
}
|
||||
return context.bitmap;
|
||||
}
|
||||
template<typename TContext>
|
||||
static RefPtr<Gfx::Bitmap> load(const StringView& path)
|
||||
{
|
||||
MappedFile mapped_file(path);
|
||||
if (!mapped_file.is_valid()) {
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
auto bitmap = load_impl<TContext>((const u8*)mapped_file.data(), mapped_file.size());
|
||||
if (bitmap)
|
||||
bitmap->set_mmap_name(String::format("Gfx::Bitmap [%dx%d] - Decoded %s: %s",
|
||||
bitmap->width(), bitmap->height(),
|
||||
TContext::image_type,
|
||||
LexicalPath::canonicalized_path(path).characters()));
|
||||
return bitmap;
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue