Stowage/ladybird
2
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2025-10-31 13:20:59 +00:00
Code Issues Projects Releases Packages Wiki Activity
ladybird/Userland/Libraries/LibGfx/ImageDecoder.h

80 lines
2.4 KiB
C
Raw Normal View History

Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header.
2020-01-18 09:38:21 +01:00
/*
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
*
Everything: Move to SPDX license identifiers in all files. SPDX License Identifiers are a more compact / standardized way of representing file license information. See: https://spdx.dev/resources/use/#identifiers This was done with the `ambr` search and replace tool. ambr --no-parent-ignore --key-from-file --rep-from-file key.txt rep.txt *
2021-04-22 01:24:48 -07:00
* SPDX-License-Identifier: BSD-2-Clause
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header.
2020-01-18 09:38:21 +01:00
*/
LibDraw: Add ImageLoader, a simple abstraction for image loading An ImageLoader is a generic interface for loading encoded image data of any supported format. It has an ImageLoaderPlugin internally that does all the work. This patch adds an initial PNGImageLoaderPlugin that knows how to retrieve the size of a PNG, and the bitmap. The API is divided into size() and bitmap() to facilitate geometry-only decoding. This will be useful in places like LibHTML where we need dimensions for layout purposes but can wait with the bitmap until later.
2019-10-15 21:48:08 +02:00
#pragma once
LibGfx: Add ImageDecoder factory overload for ByteBuffers
2020-06-01 21:32:54 +02:00
#include <AK/ByteBuffer.h>
LibDraw: Add ImageLoader, a simple abstraction for image loading An ImageLoader is a generic interface for loading encoded image data of any supported format. It has an ImageLoaderPlugin internally that does all the work. This patch adds an initial PNGImageLoaderPlugin that knows how to retrieve the size of a PNG, and the bitmap. The API is divided into size() and bitmap() to facilitate geometry-only decoding. This will be useful in places like LibHTML where we need dimensions for layout purposes but can wait with the bitmap until later.
2019-10-15 21:48:08 +02:00
#include <AK/OwnPtr.h>
#include <AK/RefCounted.h>
LibGfx: Add support for animated images to ImageDecoder{Plugin} Adds methods to determine whether an image is animated, how many times the animation loops, the number of frames, and to get individual frames. Implements stubs of these methods for PNGImageDecoderPlugin and GIFImageDecoderPlugin.
2020-05-03 17:12:54 +01:00
#include <AK/RefPtr.h>
Libraries: Add missing headers A C++ source file containing just #include <LibFoo/Bar.h> should always compile cleanly. This patch adds missing header inclusions that could have caused weird error messages if they were used in a different context. Also, this confused QtCreator.
2021-01-21 20:55:37 +01:00
#include <LibGfx/Bitmap.h>
LibGfx: Rename from LibDraw :^)
2020-02-06 12:04:00 +01:00
#include <LibGfx/Size.h>
LibDraw: Add ImageLoader, a simple abstraction for image loading An ImageLoader is a generic interface for loading encoded image data of any supported format. It has an ImageLoaderPlugin internally that does all the work. This patch adds an initial PNGImageLoaderPlugin that knows how to retrieve the size of a PNG, and the bitmap. The API is divided into size() and bitmap() to facilitate geometry-only decoding. This will be useful in places like LibHTML where we need dimensions for layout purposes but can wait with the bitmap until later.
2019-10-15 21:48:08 +02:00
LibDraw: Put all classes in the Gfx namespace I started adding things to a Draw namespace, but it somehow felt really wrong seeing Draw::Rect and Draw::Bitmap, etc. So instead, let's rename the library to LibGfx. :^)
2020-02-06 11:56:38 +01:00
namespace Gfx {
class Bitmap;
LibDraw: Add ImageLoader, a simple abstraction for image loading An ImageLoader is a generic interface for loading encoded image data of any supported format. It has an ImageLoaderPlugin internally that does all the work. This patch adds an initial PNGImageLoaderPlugin that knows how to retrieve the size of a PNG, and the bitmap. The API is divided into size() and bitmap() to facilitate geometry-only decoding. This will be useful in places like LibHTML where we need dimensions for layout purposes but can wait with the bitmap until later.
2019-10-15 21:48:08 +02:00
LibGfx: Make all image decoders reject image sizes above 16384 pixels Let's just say no to shenanigans by capping images at 16384 pixels both wide and tall. If a day comes in the future where we need to handle images larger than this, we can deal with it then.
2020-12-25 00:19:06 +01:00
static constexpr size_t maximum_width_for_decoded_images = 16384;
static constexpr size_t maximum_height_for_decoded_images = 16384;
LibGfx: Add support for animated images to ImageDecoder{Plugin} Adds methods to determine whether an image is animated, how many times the animation loops, the number of frames, and to get individual frames. Implements stubs of these methods for PNGImageDecoderPlugin and GIFImageDecoderPlugin.
2020-05-03 17:12:54 +01:00
struct ImageFrameDescriptor {
RefPtr<Bitmap> image;
int duration { 0 };
};
LibDraw: Rename ImageLoader => ImageDecoder ImageLoader was not the right name for this, as there is no loading happening, only decoding. :^)
2019-10-19 19:56:49 +02:00
class ImageDecoderPlugin {
LibDraw: Add ImageLoader, a simple abstraction for image loading An ImageLoader is a generic interface for loading encoded image data of any supported format. It has an ImageLoaderPlugin internally that does all the work. This patch adds an initial PNGImageLoaderPlugin that knows how to retrieve the size of a PNG, and the bitmap. The API is divided into size() and bitmap() to facilitate geometry-only decoding. This will be useful in places like LibHTML where we need dimensions for layout purposes but can wait with the bitmap until later.
2019-10-15 21:48:08 +02:00
public:
LibGfx: Add ImageDecoder factory overload for ByteBuffers
2020-06-01 21:32:54 +02:00
virtual ~ImageDecoderPlugin() { }
LibDraw: Add ImageLoader, a simple abstraction for image loading An ImageLoader is a generic interface for loading encoded image data of any supported format. It has an ImageLoaderPlugin internally that does all the work. This patch adds an initial PNGImageLoaderPlugin that knows how to retrieve the size of a PNG, and the bitmap. The API is divided into size() and bitmap() to facilitate geometry-only decoding. This will be useful in places like LibHTML where we need dimensions for layout purposes but can wait with the bitmap until later.
2019-10-15 21:48:08 +02:00
LibGfx: Rename Rect,Point,Size => IntRect,IntPoint,IntSize This fits nicer with FloatRect,FloatPoint,FloatSize and gives a much better visual clue about what type of metric is being used.
2020-06-10 10:57:59 +02:00
virtual IntSize size() = 0;
LibDraw: Put all classes in the Gfx namespace I started adding things to a Draw namespace, but it somehow felt really wrong seeing Draw::Rect and Draw::Bitmap, etc. So instead, let's rename the library to LibGfx. :^)
2020-02-06 11:56:38 +01:00
virtual RefPtr<Gfx::Bitmap> bitmap() = 0;
LibDraw: Add ImageLoader, a simple abstraction for image loading An ImageLoader is a generic interface for loading encoded image data of any supported format. It has an ImageLoaderPlugin internally that does all the work. This patch adds an initial PNGImageLoaderPlugin that knows how to retrieve the size of a PNG, and the bitmap. The API is divided into size() and bitmap() to facilitate geometry-only decoding. This will be useful in places like LibHTML where we need dimensions for layout purposes but can wait with the bitmap until later.
2019-10-15 21:48:08 +02:00
LibDraw: Create purgeable GraphicsBitmap in the PNG decoder Also add ImageDecoder APIs for controlling the volatile flag.
2019-12-18 20:50:58 +01:00
virtual void set_volatile() = 0;
LibGfx: Make Gfx::Bitmap::set_nonvolatile() report allocation failure Making a bitmap non-volatile after being volatile may fail to allocate physical pages after the kernel stole the old pages in a purge. This is different from the pages being purged, but reallocated. In that case, they are simply replaced with zero-fill-on-demand pages as if they were freshly allocated.
2021-07-24 22:49:48 +02:00
[[nodiscard]] virtual bool set_nonvolatile(bool& was_purged) = 0;
LibDraw: Create purgeable GraphicsBitmap in the PNG decoder Also add ImageDecoder APIs for controlling the volatile flag.
2019-12-18 20:50:58 +01:00
LibGfx: Add a sniff method to ImageDecoder and implement for GIF and PNG The sniff method is intended to be used for content sniffing. It should be a cheap test to rapidly rule out whether a candidate image can be successfully decoded. For the GIF and PNG implementations it simply attempts to decode the image header, returning true if successful and false if not.
2020-04-25 13:51:00 +01:00
virtual bool sniff() = 0;
LibGfx: Add support for animated images to ImageDecoder{Plugin} Adds methods to determine whether an image is animated, how many times the animation loops, the number of frames, and to get individual frames. Implements stubs of these methods for PNGImageDecoderPlugin and GIFImageDecoderPlugin.
2020-05-03 17:12:54 +01:00
virtual bool is_animated() = 0;
virtual size_t loop_count() = 0;
virtual size_t frame_count() = 0;
virtual ImageFrameDescriptor frame(size_t i) = 0;
LibDraw: Add ImageLoader, a simple abstraction for image loading An ImageLoader is a generic interface for loading encoded image data of any supported format. It has an ImageLoaderPlugin internally that does all the work. This patch adds an initial PNGImageLoaderPlugin that knows how to retrieve the size of a PNG, and the bitmap. The API is divided into size() and bitmap() to facilitate geometry-only decoding. This will be useful in places like LibHTML where we need dimensions for layout purposes but can wait with the bitmap until later.
2019-10-15 21:48:08 +02:00
protected:
LibGfx: Add ImageDecoder factory overload for ByteBuffers
2020-06-01 21:32:54 +02:00
ImageDecoderPlugin() { }
LibDraw: Add ImageLoader, a simple abstraction for image loading An ImageLoader is a generic interface for loading encoded image data of any supported format. It has an ImageLoaderPlugin internally that does all the work. This patch adds an initial PNGImageLoaderPlugin that knows how to retrieve the size of a PNG, and the bitmap. The API is divided into size() and bitmap() to facilitate geometry-only decoding. This will be useful in places like LibHTML where we need dimensions for layout purposes but can wait with the bitmap until later.
2019-10-15 21:48:08 +02:00
};
LibDraw: Rename ImageLoader => ImageDecoder ImageLoader was not the right name for this, as there is no loading happening, only decoding. :^)
2019-10-19 19:56:49 +02:00
class ImageDecoder : public RefCounted<ImageDecoder> {
LibDraw: Add ImageLoader, a simple abstraction for image loading An ImageLoader is a generic interface for loading encoded image data of any supported format. It has an ImageLoaderPlugin internally that does all the work. This patch adds an initial PNGImageLoaderPlugin that knows how to retrieve the size of a PNG, and the bitmap. The API is divided into size() and bitmap() to facilitate geometry-only decoding. This will be useful in places like LibHTML where we need dimensions for layout purposes but can wait with the bitmap until later.
2019-10-15 21:48:08 +02:00
public:
AK: Rename adopt() to adopt_ref() This makes it more symmetrical with adopt_own() (which is used to create a NonnullOwnPtr from the result of a naked new.)
2021-04-23 16:46:57 +02:00
static NonnullRefPtr<ImageDecoder> create(const u8* data, size_t size) { return adopt_ref(*new ImageDecoder(data, size)); }
static NonnullRefPtr<ImageDecoder> create(const ByteBuffer& data) { return adopt_ref(*new ImageDecoder(data.data(), data.size())); }
LibDraw: Rename ImageLoader => ImageDecoder ImageLoader was not the right name for this, as there is no loading happening, only decoding. :^)
2019-10-19 19:56:49 +02:00
~ImageDecoder();
LibDraw: Add ImageLoader, a simple abstraction for image loading An ImageLoader is a generic interface for loading encoded image data of any supported format. It has an ImageLoaderPlugin internally that does all the work. This patch adds an initial PNGImageLoaderPlugin that knows how to retrieve the size of a PNG, and the bitmap. The API is divided into size() and bitmap() to facilitate geometry-only decoding. This will be useful in places like LibHTML where we need dimensions for layout purposes but can wait with the bitmap until later.
2019-10-15 21:48:08 +02:00
LibGfx: Don't keep an unused GIF decoder plugin in failed ImageDecoders If we can't decode the input data, just have a null decoder. In this state we simply return a null bitmap and whatever empty values make sense for each API. This way, we don't try to decode the same thing over and over since it's not gonna work anyway. :^)
2020-06-13 15:28:04 +02:00
bool is_valid() const { return m_plugin; }
IntSize size() const { return m_plugin ? m_plugin->size() : IntSize(); }
LibDraw: Add ImageLoader, a simple abstraction for image loading An ImageLoader is a generic interface for loading encoded image data of any supported format. It has an ImageLoaderPlugin internally that does all the work. This patch adds an initial PNGImageLoaderPlugin that knows how to retrieve the size of a PNG, and the bitmap. The API is divided into size() and bitmap() to facilitate geometry-only decoding. This will be useful in places like LibHTML where we need dimensions for layout purposes but can wait with the bitmap until later.
2019-10-15 21:48:08 +02:00
int width() const { return size().width(); }
int height() const { return size().height(); }
LibGfx: Move a bunch of LogStream::operator<< to cpp files
2020-02-15 00:58:14 +01:00
RefPtr<Gfx::Bitmap> bitmap() const;
LibGfx: Don't keep an unused GIF decoder plugin in failed ImageDecoders If we can't decode the input data, just have a null decoder. In this state we simply return a null bitmap and whatever empty values make sense for each API. This way, we don't try to decode the same thing over and over since it's not gonna work anyway. :^)
2020-06-13 15:28:04 +02:00
void set_volatile()
{
if (m_plugin)
m_plugin->set_volatile();
}
LibGfx: Make Gfx::Bitmap::set_nonvolatile() report allocation failure Making a bitmap non-volatile after being volatile may fail to allocate physical pages after the kernel stole the old pages in a purge. This is different from the pages being purged, but reallocated. In that case, they are simply replaced with zero-fill-on-demand pages as if they were freshly allocated.
2021-07-24 22:49:48 +02:00
[[nodiscard]] bool set_nonvolatile(bool& was_purged) { return m_plugin ? m_plugin->set_nonvolatile(was_purged) : false; }
LibGfx: Don't keep an unused GIF decoder plugin in failed ImageDecoders If we can't decode the input data, just have a null decoder. In this state we simply return a null bitmap and whatever empty values make sense for each API. This way, we don't try to decode the same thing over and over since it's not gonna work anyway. :^)
2020-06-13 15:28:04 +02:00
bool sniff() const { return m_plugin ? m_plugin->sniff() : false; }
bool is_animated() const { return m_plugin ? m_plugin->is_animated() : false; }
size_t loop_count() const { return m_plugin ? m_plugin->loop_count() : 0; }
size_t frame_count() const { return m_plugin ? m_plugin->frame_count() : 0; }
ImageFrameDescriptor frame(size_t i) const { return m_plugin ? m_plugin->frame(i) : ImageFrameDescriptor(); }
LibDraw: Add ImageLoader, a simple abstraction for image loading An ImageLoader is a generic interface for loading encoded image data of any supported format. It has an ImageLoaderPlugin internally that does all the work. This patch adds an initial PNGImageLoaderPlugin that knows how to retrieve the size of a PNG, and the bitmap. The API is divided into size() and bitmap() to facilitate geometry-only decoding. This will be useful in places like LibHTML where we need dimensions for layout purposes but can wait with the bitmap until later.
2019-10-15 21:48:08 +02:00
private:
LibDraw: Rename ImageLoader => ImageDecoder ImageLoader was not the right name for this, as there is no loading happening, only decoding. :^)
2019-10-19 19:56:49 +02:00
ImageDecoder(const u8*, size_t);
LibDraw: Add ImageLoader, a simple abstraction for image loading An ImageLoader is a generic interface for loading encoded image data of any supported format. It has an ImageLoaderPlugin internally that does all the work. This patch adds an initial PNGImageLoaderPlugin that knows how to retrieve the size of a PNG, and the bitmap. The API is divided into size() and bitmap() to facilitate geometry-only decoding. This will be useful in places like LibHTML where we need dimensions for layout purposes but can wait with the bitmap until later.
2019-10-15 21:48:08 +02:00
LibDraw: Rename ImageLoader => ImageDecoder ImageLoader was not the right name for this, as there is no loading happening, only decoding. :^)
2019-10-19 19:56:49 +02:00
mutable OwnPtr<ImageDecoderPlugin> m_plugin;
LibDraw: Add ImageLoader, a simple abstraction for image loading An ImageLoader is a generic interface for loading encoded image data of any supported format. It has an ImageLoaderPlugin internally that does all the work. This patch adds an initial PNGImageLoaderPlugin that knows how to retrieve the size of a PNG, and the bitmap. The API is divided into size() and bitmap() to facilitate geometry-only decoding. This will be useful in places like LibHTML where we need dimensions for layout purposes but can wait with the bitmap until later.
2019-10-15 21:48:08 +02:00
};
LibDraw: Put all classes in the Gfx namespace I started adding things to a Draw namespace, but it somehow felt really wrong seeing Draw::Rect and Draw::Bitmap, etc. So instead, let's rename the library to LibGfx. :^)
2020-02-06 11:56:38 +01:00
}
Reference in a new issue Copy permalink