ladybird/Userland/Libraries/LibGfx/Bitmap.h
Andreas Kling 143443e0b6 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-25 14:39:25 +02:00

344 lines
11 KiB
C++

/*
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/Forward.h>
#include <AK/RefCounted.h>
#include <AK/RefPtr.h>
#include <LibCore/AnonymousBuffer.h>
#include <LibGfx/Color.h>
#include <LibGfx/Forward.h>
#include <LibGfx/Rect.h>
#define ENUMERATE_IMAGE_FORMATS \
__ENUMERATE_IMAGE_FORMAT(pbm, ".pbm") \
__ENUMERATE_IMAGE_FORMAT(pgm, ".pgm") \
__ENUMERATE_IMAGE_FORMAT(png, ".png") \
__ENUMERATE_IMAGE_FORMAT(ppm, ".ppm") \
__ENUMERATE_IMAGE_FORMAT(gif, ".gif") \
__ENUMERATE_IMAGE_FORMAT(bmp, ".bmp") \
__ENUMERATE_IMAGE_FORMAT(ico, ".ico") \
__ENUMERATE_IMAGE_FORMAT(jpg, ".jpg") \
__ENUMERATE_IMAGE_FORMAT(jpg, ".jpeg") \
__ENUMERATE_IMAGE_FORMAT(dds, ".dds")
namespace Gfx {
enum class BitmapFormat {
Invalid,
Indexed1,
Indexed2,
Indexed4,
Indexed8,
BGRx8888,
BGRA8888,
RGBA8888,
};
inline bool is_valid_bitmap_format(unsigned format)
{
switch (format) {
case (unsigned)BitmapFormat::Invalid:
case (unsigned)BitmapFormat::Indexed1:
case (unsigned)BitmapFormat::Indexed2:
case (unsigned)BitmapFormat::Indexed4:
case (unsigned)BitmapFormat::Indexed8:
case (unsigned)BitmapFormat::BGRx8888:
case (unsigned)BitmapFormat::BGRA8888:
case (unsigned)BitmapFormat::RGBA8888:
return true;
}
return false;
}
enum class StorageFormat {
Indexed8,
BGRx8888,
BGRA8888,
RGBA8888,
};
static StorageFormat determine_storage_format(BitmapFormat format)
{
switch (format) {
case BitmapFormat::BGRx8888:
return StorageFormat::BGRx8888;
case BitmapFormat::BGRA8888:
return StorageFormat::BGRA8888;
case BitmapFormat::RGBA8888:
return StorageFormat::RGBA8888;
case BitmapFormat::Indexed1:
case BitmapFormat::Indexed2:
case BitmapFormat::Indexed4:
case BitmapFormat::Indexed8:
return StorageFormat::Indexed8;
default:
VERIFY_NOT_REACHED();
}
}
struct BackingStore;
enum RotationDirection {
CounterClockwise,
Clockwise
};
class Bitmap : public RefCounted<Bitmap> {
public:
[[nodiscard]] static RefPtr<Bitmap> try_create(BitmapFormat, const IntSize&, int intrinsic_scale = 1);
[[nodiscard]] static RefPtr<Bitmap> try_create_shareable(BitmapFormat, const IntSize&, int intrinsic_scale = 1);
[[nodiscard]] static RefPtr<Bitmap> try_create_wrapper(BitmapFormat, const IntSize&, int intrinsic_scale, size_t pitch, void*);
[[nodiscard]] static RefPtr<Bitmap> try_load_from_file(String const& path, int scale_factor = 1);
[[nodiscard]] static RefPtr<Bitmap> try_create_with_anonymous_buffer(BitmapFormat, Core::AnonymousBuffer, const IntSize&, int intrinsic_scale, const Vector<RGBA32>& palette);
[[nodiscard]] static RefPtr<Bitmap> try_create_from_serialized_byte_buffer(ByteBuffer&& buffer);
static bool is_path_a_supported_image_format(const StringView& path)
{
#define __ENUMERATE_IMAGE_FORMAT(Name, Ext) \
if (path.ends_with(Ext, CaseSensitivity::CaseInsensitive)) \
return true;
ENUMERATE_IMAGE_FORMATS
#undef __ENUMERATE_IMAGE_FORMAT
return false;
}
[[nodiscard]] RefPtr<Gfx::Bitmap> clone() const;
[[nodiscard]] RefPtr<Gfx::Bitmap> rotated(Gfx::RotationDirection) const;
[[nodiscard]] RefPtr<Gfx::Bitmap> flipped(Gfx::Orientation) const;
[[nodiscard]] RefPtr<Gfx::Bitmap> scaled(int sx, int sy) const;
[[nodiscard]] RefPtr<Gfx::Bitmap> scaled(float sx, float sy) const;
[[nodiscard]] RefPtr<Gfx::Bitmap> cropped(Gfx::IntRect) const;
[[nodiscard]] RefPtr<Bitmap> to_bitmap_backed_by_anonymous_buffer() const;
[[nodiscard]] ByteBuffer serialize_to_byte_buffer() const;
[[nodiscard]] ShareableBitmap to_shareable_bitmap() const;
~Bitmap();
[[nodiscard]] u8* scanline_u8(int physical_y);
[[nodiscard]] const u8* scanline_u8(int physical_y) const;
[[nodiscard]] RGBA32* scanline(int physical_y);
[[nodiscard]] const RGBA32* scanline(int physical_y) const;
[[nodiscard]] IntRect rect() const { return { {}, m_size }; }
[[nodiscard]] IntSize size() const { return m_size; }
[[nodiscard]] int width() const { return m_size.width(); }
[[nodiscard]] int height() const { return m_size.height(); }
[[nodiscard]] int scale() const { return m_scale; }
[[nodiscard]] IntRect physical_rect() const { return rect() * scale(); }
[[nodiscard]] IntSize physical_size() const { return size() * scale(); }
[[nodiscard]] int physical_width() const { return physical_size().width(); }
[[nodiscard]] int physical_height() const { return physical_size().height(); }
[[nodiscard]] size_t pitch() const { return m_pitch; }
[[nodiscard]] ALWAYS_INLINE bool is_indexed() const
{
return is_indexed(m_format);
}
[[nodiscard]] ALWAYS_INLINE static bool is_indexed(BitmapFormat format)
{
return format == BitmapFormat::Indexed8 || format == BitmapFormat::Indexed4
|| format == BitmapFormat::Indexed2 || format == BitmapFormat::Indexed1;
}
[[nodiscard]] static size_t palette_size(BitmapFormat format)
{
switch (format) {
case BitmapFormat::Indexed1:
return 2;
case BitmapFormat::Indexed2:
return 4;
case BitmapFormat::Indexed4:
return 16;
case BitmapFormat::Indexed8:
return 256;
default:
return 0;
}
}
[[nodiscard]] Vector<RGBA32> palette_to_vector() const;
[[nodiscard]] static unsigned bpp_for_format(BitmapFormat format)
{
switch (format) {
case BitmapFormat::Indexed1:
return 1;
case BitmapFormat::Indexed2:
return 2;
case BitmapFormat::Indexed4:
return 4;
case BitmapFormat::Indexed8:
return 8;
case BitmapFormat::BGRx8888:
case BitmapFormat::BGRA8888:
return 32;
default:
VERIFY_NOT_REACHED();
case BitmapFormat::Invalid:
return 0;
}
}
[[nodiscard]] static size_t minimum_pitch(size_t physical_width, BitmapFormat);
[[nodiscard]] unsigned bpp() const
{
return bpp_for_format(m_format);
}
void fill(Color);
[[nodiscard]] bool has_alpha_channel() const { return m_format == BitmapFormat::BGRA8888; }
[[nodiscard]] BitmapFormat format() const { return m_format; }
void set_mmap_name(String const&);
[[nodiscard]] static constexpr size_t size_in_bytes(size_t pitch, int physical_height) { return pitch * physical_height; }
[[nodiscard]] size_t size_in_bytes() const { return size_in_bytes(m_pitch, physical_height()); }
[[nodiscard]] Color palette_color(u8 index) const { return Color::from_rgba(m_palette[index]); }
void set_palette_color(u8 index, Color color) { m_palette[index] = color.value(); }
template<StorageFormat>
[[nodiscard]] Color get_pixel(int physical_x, int physical_y) const;
[[nodiscard]] Color get_pixel(int physical_x, int physical_y) const;
[[nodiscard]] Color get_pixel(const IntPoint& physical_position) const
{
return get_pixel(physical_position.x(), physical_position.y());
}
template<StorageFormat>
void set_pixel(int physical_x, int physical_y, Color);
void set_pixel(int physical_x, int physical_y, Color);
void set_pixel(const IntPoint& physical_position, Color color)
{
set_pixel(physical_position.x(), physical_position.y(), color);
}
[[nodiscard]] bool is_volatile() const { return m_volatile; }
void set_volatile();
// Returns true if making the bitmap non-volatile succeeded. `was_purged` indicates status of contents.
// Returns false if there was not enough memory.
[[nodiscard]] bool set_nonvolatile(bool& was_purged);
[[nodiscard]] Core::AnonymousBuffer& anonymous_buffer() { return m_buffer; }
[[nodiscard]] Core::AnonymousBuffer const& anonymous_buffer() const { return m_buffer; }
private:
Bitmap(BitmapFormat, IntSize const&, int, BackingStore const&);
Bitmap(BitmapFormat, const IntSize&, int, size_t pitch, void*);
Bitmap(BitmapFormat, Core::AnonymousBuffer, const IntSize&, int, const Vector<RGBA32>& palette);
static Optional<BackingStore> try_allocate_backing_store(BitmapFormat format, IntSize const& size, int scale_factor);
void allocate_palette_from_format(BitmapFormat, const Vector<RGBA32>& source_palette);
IntSize m_size;
int m_scale;
void* m_data { nullptr };
RGBA32* m_palette { nullptr };
size_t m_pitch { 0 };
BitmapFormat m_format { BitmapFormat::Invalid };
bool m_needs_munmap { false };
bool m_volatile { false };
Core::AnonymousBuffer m_buffer;
};
inline u8* Bitmap::scanline_u8(int y)
{
VERIFY(y >= 0 && y < physical_height());
return reinterpret_cast<u8*>(m_data) + (y * m_pitch);
}
inline const u8* Bitmap::scanline_u8(int y) const
{
VERIFY(y >= 0 && y < physical_height());
return reinterpret_cast<const u8*>(m_data) + (y * m_pitch);
}
inline RGBA32* Bitmap::scanline(int y)
{
return reinterpret_cast<RGBA32*>(scanline_u8(y));
}
inline const RGBA32* Bitmap::scanline(int y) const
{
return reinterpret_cast<const RGBA32*>(scanline_u8(y));
}
template<>
inline Color Bitmap::get_pixel<StorageFormat::BGRx8888>(int x, int y) const
{
VERIFY(x >= 0 && x < physical_width());
return Color::from_rgb(scanline(y)[x]);
}
template<>
inline Color Bitmap::get_pixel<StorageFormat::BGRA8888>(int x, int y) const
{
VERIFY(x >= 0 && x < physical_width());
return Color::from_rgba(scanline(y)[x]);
}
template<>
inline Color Bitmap::get_pixel<StorageFormat::Indexed8>(int x, int y) const
{
VERIFY(x >= 0 && x < physical_width());
return Color::from_rgb(m_palette[scanline_u8(y)[x]]);
}
inline Color Bitmap::get_pixel(int x, int y) const
{
switch (determine_storage_format(m_format)) {
case StorageFormat::BGRx8888:
return get_pixel<StorageFormat::BGRx8888>(x, y);
case StorageFormat::BGRA8888:
return get_pixel<StorageFormat::BGRA8888>(x, y);
case StorageFormat::Indexed8:
return get_pixel<StorageFormat::Indexed8>(x, y);
default:
VERIFY_NOT_REACHED();
}
}
template<>
inline void Bitmap::set_pixel<StorageFormat::BGRx8888>(int x, int y, Color color)
{
VERIFY(x >= 0 && x < physical_width());
scanline(y)[x] = color.value();
}
template<>
inline void Bitmap::set_pixel<StorageFormat::BGRA8888>(int x, int y, Color color)
{
VERIFY(x >= 0 && x < physical_width());
scanline(y)[x] = color.value(); // drop alpha
}
inline void Bitmap::set_pixel(int x, int y, Color color)
{
switch (determine_storage_format(m_format)) {
case StorageFormat::BGRx8888:
set_pixel<StorageFormat::BGRx8888>(x, y, color);
break;
case StorageFormat::BGRA8888:
set_pixel<StorageFormat::BGRA8888>(x, y, color);
break;
case StorageFormat::Indexed8:
VERIFY_NOT_REACHED();
default:
VERIFY_NOT_REACHED();
}
}
}