Everywhere: Hoist the Utilities folder to the top-level

Author: https://github.com/trflynn89 Commit: 950e819ee7 Pull-request: https://github.com/LadybirdBrowser/ladybird/pull/2256 Reviewed-by: https://github.com/sideshowbarker
2025-07-29 20:29:18 +00:00 · 2024-11-09 12:16:38 -05:00 · 2024-11-09 12:16:38 -05:00 · 950e819ee7 · 2024-11-10 11:51:59 +00:00
commit 950e819ee7
parent 22e0eeada2
13 changed files with 12 additions and 12 deletions
--- a/Utilities/image.cpp
+++ b/Utilities/image.cpp
@ -0,0 +1,329 @@
+/*
+ * Copyright (c) 2023, Nico Weber <thakis@chromium.org>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#include <LibCore/ArgsParser.h>
+#include <LibCore/File.h>
+#include <LibCore/MappedFile.h>
+#include <LibGfx/ICC/Profile.h>
+#include <LibGfx/ImageFormats/BMPWriter.h>
+#include <LibGfx/ImageFormats/GIFWriter.h>
+#include <LibGfx/ImageFormats/ImageDecoder.h>
+#include <LibGfx/ImageFormats/JPEGWriter.h>
+#include <LibGfx/ImageFormats/PNGWriter.h>
+#include <LibGfx/ImageFormats/WebPSharedLossless.h>
+#include <LibGfx/ImageFormats/WebPWriter.h>
+
+using AnyBitmap = Variant<RefPtr<Gfx::Bitmap>, RefPtr<Gfx::CMYKBitmap>>;
+struct LoadedImage {
+    Gfx::NaturalFrameFormat internal_format;
+    AnyBitmap bitmap;
+
+    Optional<ReadonlyBytes> icc_data;
+};
+
+static ErrorOr<LoadedImage> load_image(RefPtr<Gfx::ImageDecoder> const& decoder, int frame_index)
+{
+    auto internal_format = decoder->natural_frame_format();
+
+    auto bitmap = TRY([&]() -> ErrorOr<AnyBitmap> {
+        switch (internal_format) {
+        case Gfx::NaturalFrameFormat::RGB:
+        case Gfx::NaturalFrameFormat::Grayscale:
+        case Gfx::NaturalFrameFormat::Vector:
+            return TRY(decoder->frame(frame_index)).image;
+        case Gfx::NaturalFrameFormat::CMYK:
+            return RefPtr(TRY(decoder->cmyk_frame()));
+        }
+        VERIFY_NOT_REACHED();
+    }());
+
+    return LoadedImage { internal_format, move(bitmap), TRY(decoder->icc_data()) };
+}
+
+static ErrorOr<void> invert_cmyk(LoadedImage& image)
+{
+    if (!image.bitmap.has<RefPtr<Gfx::CMYKBitmap>>())
+        return Error::from_string_literal("Can't --invert-cmyk with RGB bitmaps");
+    auto& frame = image.bitmap.get<RefPtr<Gfx::CMYKBitmap>>();
+
+    for (auto& pixel : *frame) {
+        pixel.c = ~pixel.c;
+        pixel.m = ~pixel.m;
+        pixel.y = ~pixel.y;
+        pixel.k = ~pixel.k;
+    }
+    return {};
+}
+
+static ErrorOr<void> crop_image(LoadedImage& image, Gfx::IntRect const& rect)
+{
+    if (!image.bitmap.has<RefPtr<Gfx::Bitmap>>())
+        return Error::from_string_literal("Can't --crop CMYK bitmaps yet");
+    auto& frame = image.bitmap.get<RefPtr<Gfx::Bitmap>>();
+    frame = TRY(frame->cropped(rect));
+    return {};
+}
+
+static ErrorOr<void> move_alpha_to_rgb(LoadedImage& image)
+{
+    if (!image.bitmap.has<RefPtr<Gfx::Bitmap>>())
+        return Error::from_string_literal("Can't --move-alpha-to-rgb with CMYK bitmaps");
+    auto& frame = image.bitmap.get<RefPtr<Gfx::Bitmap>>();
+
+    switch (frame->format()) {
+    case Gfx::BitmapFormat::Invalid:
+        return Error::from_string_literal("Can't --move-alpha-to-rgb with invalid bitmaps");
+    case Gfx::BitmapFormat::RGBA8888:
+        // No image decoder currently produces bitmaps with this format.
+        // If that ever changes, preferrably fix the image decoder to use BGRA8888 instead :)
+        // If there's a good reason for not doing that, implement support for this, I suppose.
+        return Error::from_string_literal("--move-alpha-to-rgb not implemented for RGBA8888");
+    case Gfx::BitmapFormat::BGRA8888:
+    case Gfx::BitmapFormat::BGRx8888:
+        // FIXME: If BitmapFormat::Gray8 existed (and image encoders made use of it to write grayscale images), we could use it here.
+        for (auto& pixel : *frame) {
+            u8 alpha = pixel >> 24;
+            pixel = 0xff000000 | (alpha << 16) | (alpha << 8) | alpha;
+        }
+        break;
+    case Gfx::BitmapFormat::RGBx8888:
+        // This should never be the case, as there's no alpha channel in the image
+        return Error::from_string_literal("Can't --move-alpha-to-rgb with RGBx8888 bitmaps");
+    }
+    return {};
+}
+
+static ErrorOr<void> strip_alpha(LoadedImage& image)
+{
+    if (!image.bitmap.has<RefPtr<Gfx::Bitmap>>())
+        return Error::from_string_literal("Can't --strip-alpha with CMYK bitmaps");
+    auto& frame = image.bitmap.get<RefPtr<Gfx::Bitmap>>();
+
+    switch (frame->format()) {
+    case Gfx::BitmapFormat::Invalid:
+        return Error::from_string_literal("Can't --strip-alpha with invalid bitmaps");
+    case Gfx::BitmapFormat::RGBA8888:
+        // No image decoder currently produces bitmaps with this format.
+        // If that ever changes, preferrably fix the image decoder to use BGRA8888 instead :)
+        // If there's a good reason for not doing that, implement support for this, I suppose.
+        return Error::from_string_literal("--strip-alpha not implemented for RGBA8888");
+    case Gfx::BitmapFormat::BGRA8888:
+    case Gfx::BitmapFormat::BGRx8888:
+        // BGRx8888 is sent as BGRA8888 to Skia,
+        // that's why we need to ensure there's no "alpha channel" left
+        frame->strip_alpha_channel();
+        break;
+    case Gfx::BitmapFormat::RGBx8888:
+        // This format means there's no alpha channel, so nothing to do here
+        break;
+    }
+    return {};
+}
+
+static ErrorOr<OwnPtr<Core::MappedFile>> convert_image_profile(LoadedImage& image, StringView convert_color_profile_path, OwnPtr<Core::MappedFile> maybe_source_icc_file)
+{
+    if (!image.icc_data.has_value())
+        return Error::from_string_literal("No source color space embedded in image. Pass one with --assign-color-profile.");
+
+    auto source_icc_file = move(maybe_source_icc_file);
+    auto source_icc_data = image.icc_data.value();
+    auto icc_file = TRY(Core::MappedFile::map(convert_color_profile_path));
+    image.icc_data = icc_file->bytes();
+
+    auto source_profile = TRY(Gfx::ICC::Profile::try_load_from_externally_owned_memory(source_icc_data));
+    auto destination_profile = TRY(Gfx::ICC::Profile::try_load_from_externally_owned_memory(icc_file->bytes()));
+
+    if (destination_profile->data_color_space() != Gfx::ICC::ColorSpace::RGB)
+        return Error::from_string_literal("Can only convert to RGB at the moment, but destination color space is not RGB");
+
+    if (image.bitmap.has<RefPtr<Gfx::CMYKBitmap>>()) {
+        if (source_profile->data_color_space() != Gfx::ICC::ColorSpace::CMYK)
+            return Error::from_string_literal("Source image data is CMYK but source color space is not CMYK");
+
+        auto& cmyk_frame = image.bitmap.get<RefPtr<Gfx::CMYKBitmap>>();
+        auto rgb_frame = TRY(Gfx::Bitmap::create(Gfx::BitmapFormat::BGRx8888, cmyk_frame->size()));
+        TRY(destination_profile->convert_cmyk_image(*rgb_frame, *cmyk_frame, *source_profile));
+        image.bitmap = RefPtr(move(rgb_frame));
+        image.internal_format = Gfx::NaturalFrameFormat::RGB;
+    } else {
+        // FIXME: This likely wrong for grayscale images because they've been converted to
+        //        RGB at this point, but their embedded color profile is still for grayscale.
+        auto& frame = image.bitmap.get<RefPtr<Gfx::Bitmap>>();
+        TRY(destination_profile->convert_image(*frame, *source_profile));
+    }
+
+    return icc_file;
+}
+
+static ErrorOr<void> save_image(LoadedImage& image, StringView out_path, u8 jpeg_quality, Optional<unsigned> webp_allowed_transforms)
+{
+    auto stream = [out_path]() -> ErrorOr<NonnullOwnPtr<Core::OutputBufferedFile>> {
+        auto output_stream = TRY(Core::File::open(out_path, Core::File::OpenMode::Write));
+        return Core::OutputBufferedFile::create(move(output_stream));
+    };
+
+    auto& frame = image.bitmap.get<RefPtr<Gfx::Bitmap>>();
+
+    if (out_path.ends_with(".gif"sv, CaseSensitivity::CaseInsensitive)) {
+        TRY(Gfx::GIFWriter::encode(*TRY(stream()), *frame));
+        return {};
+    }
+    if (out_path.ends_with(".jpg"sv, CaseSensitivity::CaseInsensitive) || out_path.ends_with(".jpeg"sv, CaseSensitivity::CaseInsensitive)) {
+        TRY(Gfx::JPEGWriter::encode(*TRY(stream()), *frame, { .icc_data = image.icc_data, .quality = jpeg_quality }));
+        return {};
+    }
+    if (out_path.ends_with(".webp"sv, CaseSensitivity::CaseInsensitive)) {
+        Gfx::WebPWriter::Options options;
+        options.icc_data = image.icc_data;
+        if (webp_allowed_transforms.has_value())
+            options.vp8l_options.allowed_transforms = webp_allowed_transforms.value();
+        TRY(Gfx::WebPWriter::encode(*TRY(stream()), *frame, options));
+        return {};
+    }
+
+    ByteBuffer bytes;
+    if (out_path.ends_with(".bmp"sv, CaseSensitivity::CaseInsensitive)) {
+        bytes = TRY(Gfx::BMPWriter::encode(*frame, { .icc_data = image.icc_data }));
+    } else if (out_path.ends_with(".png"sv, CaseSensitivity::CaseInsensitive)) {
+        bytes = TRY(Gfx::PNGWriter::encode(*frame, { .icc_data = image.icc_data }));
+    } else {
+        return Error::from_string_literal("can only write .bmp, .gif, .jpg, .png, and .webp");
+    }
+    TRY(TRY(stream())->write_until_depleted(bytes));
+
+    return {};
+}
+
+struct Options {
+    StringView in_path;
+    StringView out_path;
+    bool no_output = false;
+    int frame_index = 0;
+    bool invert_cmyk = false;
+    Optional<Gfx::IntRect> crop_rect;
+    bool move_alpha_to_rgb = false;
+    bool strip_alpha = false;
+    StringView assign_color_profile_path;
+    StringView convert_color_profile_path;
+    bool strip_color_profile = false;
+    u8 quality = 75;
+    Optional<unsigned> webp_allowed_transforms;
+};
+
+template<class T>
+static ErrorOr<Vector<T>> parse_comma_separated_numbers(StringView rect_string)
+{
+    auto parts = rect_string.split_view(',');
+    Vector<T> part_numbers;
+    for (size_t i = 0; i < parts.size(); ++i) {
+        auto part = parts[i].to_number<T>();
+        if (!part.has_value())
+            return Error::from_string_literal("comma-separated parts must be numbers");
+        TRY(part_numbers.try_append(part.value()));
+    }
+    return part_numbers;
+}
+
+static ErrorOr<Gfx::IntRect> parse_rect_string(StringView rect_string)
+{
+    auto numbers = TRY(parse_comma_separated_numbers<i32>(rect_string));
+    if (numbers.size() != 4)
+        return Error::from_string_literal("rect must have 4 comma-separated parts");
+    return Gfx::IntRect { numbers[0], numbers[1], numbers[2], numbers[3] };
+}
+
+static ErrorOr<unsigned> parse_webp_allowed_transforms_string(StringView string)
+{
+    unsigned allowed_transforms = 0;
+    for (StringView part : string.split_view(',')) {
+        if (part == "predictor" || part == "p")
+            allowed_transforms |= 1 << Gfx::PREDICTOR_TRANSFORM;
+        else if (part == "color" || part == "c")
+            allowed_transforms |= 1 << Gfx::COLOR_TRANSFORM;
+        else if (part == "subtract-green" || part == "sg")
+            allowed_transforms |= 1 << Gfx::SUBTRACT_GREEN_TRANSFORM;
+        else if (part == "color-indexing" || part == "ci")
+            allowed_transforms |= 1 << Gfx::COLOR_INDEXING_TRANSFORM;
+        else
+            return Error::from_string_literal("unknown WebP transform; valid values: predictor, p, color, c, subtract-green, sg, color-indexing, ci");
+    }
+    return allowed_transforms;
+}
+
+static ErrorOr<Options> parse_options(Main::Arguments arguments)
+{
+    Options options;
+    Core::ArgsParser args_parser;
+    args_parser.add_positional_argument(options.in_path, "Path to input image file", "FILE");
+    args_parser.add_option(options.out_path, "Path to output image file", "output", 'o', "FILE");
+    args_parser.add_option(options.no_output, "Do not write output (only useful for benchmarking image decoding)", "no-output", {});
+    args_parser.add_option(options.frame_index, "Which frame of a multi-frame input image (0-based)", "frame-index", {}, "INDEX");
+    args_parser.add_option(options.invert_cmyk, "Invert CMYK channels", "invert-cmyk", {});
+    StringView crop_rect_string;
+    args_parser.add_option(crop_rect_string, "Crop to a rectangle", "crop", {}, "x,y,w,h");
+    args_parser.add_option(options.move_alpha_to_rgb, "Copy alpha channel to rgb, clear alpha", "move-alpha-to-rgb", {});
+    args_parser.add_option(options.strip_alpha, "Remove alpha channel", "strip-alpha", {});
+    args_parser.add_option(options.assign_color_profile_path, "Load color profile from file and assign it to output image", "assign-color-profile", {}, "FILE");
+    args_parser.add_option(options.convert_color_profile_path, "Load color profile from file and convert output image from current profile to loaded profile", "convert-to-color-profile", {}, "FILE");
+    args_parser.add_option(options.strip_color_profile, "Do not write color profile to output", "strip-color-profile", {});
+    args_parser.add_option(options.quality, "Quality used for the JPEG encoder, the default value is 75 on a scale from 0 to 100", "quality", {}, {});
+    StringView webp_allowed_transforms = "default"sv;
+    args_parser.add_option(webp_allowed_transforms, "Comma-separated list of allowed transforms (predictor,p,color,c,subtract-green,sg,color-indexing,ci) for WebP output (default: all allowed)", "webp-allowed-transforms", {}, {});
+    args_parser.parse(arguments);
+
+    if (options.out_path.is_empty() ^ options.no_output)
+        return Error::from_string_literal("exactly one of -o or --no-output is required");
+
+    if (!crop_rect_string.is_empty())
+        options.crop_rect = TRY(parse_rect_string(crop_rect_string));
+    if (webp_allowed_transforms != "default"sv)
+        options.webp_allowed_transforms = TRY(parse_webp_allowed_transforms_string(webp_allowed_transforms));
+
+    return options;
+}
+
+ErrorOr<int> serenity_main(Main::Arguments arguments)
+{
+    Options options = TRY(parse_options(arguments));
+
+    auto file = TRY(Core::MappedFile::map(options.in_path));
+    auto decoder = TRY(Gfx::ImageDecoder::try_create_for_raw_bytes(file->bytes()));
+    if (!decoder)
+        return Error::from_string_literal("Could not find decoder for input file");
+
+    LoadedImage image = TRY(load_image(*decoder, options.frame_index));
+
+    if (options.invert_cmyk)
+        TRY(invert_cmyk(image));
+
+    if (options.crop_rect.has_value())
+        TRY(crop_image(image, options.crop_rect.value()));
+
+    if (options.move_alpha_to_rgb)
+        TRY(move_alpha_to_rgb(image));
+
+    if (options.strip_alpha)
+        TRY(strip_alpha(image));
+
+    OwnPtr<Core::MappedFile> icc_file;
+    if (!options.assign_color_profile_path.is_empty()) {
+        icc_file = TRY(Core::MappedFile::map(options.assign_color_profile_path));
+        image.icc_data = icc_file->bytes();
+    }
+
+    if (!options.convert_color_profile_path.is_empty())
+        icc_file = TRY(convert_image_profile(image, options.convert_color_profile_path, move(icc_file)));
+
+    if (options.strip_color_profile)
+        image.icc_data.clear();
+
+    if (options.no_output)
+        return 0;
+
+    TRY(save_image(image, options.out_path, options.quality, options.webp_allowed_transforms));
+
+    return 0;
+}