1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-05-16 12:44:57 +00:00
serenity/Userland/Libraries/LibGfx/ICC/Profile.h
Nico Weber 8f415e7b21 LibGfx: Introduce ICC::Profile::create
This can be used to programmatically create ICC::Profile objects.
2023-03-04 21:38:47 +00:00

281 lines
9.7 KiB
C++

/*
* Copyright (c) 2022-2023, Nico Weber <thakis@chromium.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/Error.h>
#include <AK/Format.h>
#include <AK/HashMap.h>
#include <AK/NonnullRefPtr.h>
#include <AK/RefCounted.h>
#include <AK/Span.h>
#include <AK/URL.h>
#include <LibCrypto/Hash/MD5.h>
#include <LibGfx/ICC/DistinctFourCC.h>
#include <LibGfx/ICC/TagTypes.h>
namespace Gfx::ICC {
URL device_manufacturer_url(DeviceManufacturer);
URL device_model_url(DeviceModel);
// ICC v4, 7.2.4 Profile version field
class Version {
public:
Version() = default;
Version(u8 major, u8 minor_and_bugfix)
: m_major_version(major)
, m_minor_and_bugfix_version(minor_and_bugfix)
{
}
u8 major_version() const { return m_major_version; }
u8 minor_version() const { return m_minor_and_bugfix_version >> 4; }
u8 bugfix_version() const { return m_minor_and_bugfix_version & 0xf; }
u8 minor_and_bugfix_version() const { return m_minor_and_bugfix_version; }
private:
u8 m_major_version = 0;
u8 m_minor_and_bugfix_version = 0;
};
// ICC v4, 7.2.5 Profile/device class field
enum class DeviceClass : u32 {
InputDevice = 0x73636E72, // 'scnr'
DisplayDevice = 0x6D6E7472, // 'mntr'
OutputDevice = 0x70727472, // 'prtr'
DeviceLink = 0x6C696E6B, // 'link'
ColorSpace = 0x73706163, // 'spac'
Abstract = 0x61627374, // 'abst'
NamedColor = 0x6E6D636C, // 'nmcl'
};
StringView device_class_name(DeviceClass);
// ICC v4, 7.2.6 Data colour space field, Table 19 — Data colour space signatures
enum class ColorSpace : u32 {
nCIEXYZ = 0x58595A20, // 'XYZ ', used in data color spaces.
PCSXYZ = nCIEXYZ, // Used in profile connection space instead.
CIELAB = 0x4C616220, // 'Lab ', used in data color spaces.
PCSLAB = CIELAB, // Used in profile connection space instead.
CIELUV = 0x4C757620, // 'Luv '
YCbCr = 0x59436272, // 'YCbr'
CIEYxy = 0x59787920, // 'Yxy '
RGB = 0x52474220, // 'RGB '
Gray = 0x47524159, // 'GRAY'
HSV = 0x48535620, // 'HSV '
HLS = 0x484C5320, // 'HLS '
CMYK = 0x434D594B, // 'CMYK'
CMY = 0x434D5920, // 'CMY '
TwoColor = 0x32434C52, // '2CLR'
ThreeColor = 0x33434C52, // '3CLR'
FourColor = 0x34434C52, // '4CLR'
FiveColor = 0x35434C52, // '5CLR'
SixColor = 0x36434C52, // '6CLR'
SevenColor = 0x37434C52, // '7CLR'
EightColor = 0x38434C52, // '8CLR'
NineColor = 0x39434C52, // '9CLR'
TenColor = 0x41434C52, // 'ACLR'
ElevenColor = 0x42434C52, // 'BCLR'
TwelveColor = 0x43434C52, // 'CCLR'
ThirteenColor = 0x44434C52, // 'DCLR'
FourteenColor = 0x45434C52, // 'ECLR'
FifteenColor = 0x46434C52, // 'FCLR'
};
StringView data_color_space_name(ColorSpace);
StringView profile_connection_space_name(ColorSpace);
// ICC v4, 7.2.10 Primary platform field, Table 20 — Primary platforms
enum class PrimaryPlatform : u32 {
Apple = 0x4150504C, // 'APPL'
Microsoft = 0x4D534654, // 'MSFT'
SiliconGraphics = 0x53474920, // 'SGI '
Sun = 0x53554E57, // 'SUNW'
};
StringView primary_platform_name(PrimaryPlatform);
// ICC v4, 7.2.15 Rendering intent field
enum class RenderingIntent : u32 {
Perceptual = 0,
MediaRelativeColorimetric = 1,
Saturation = 2,
ICCAbsoluteColorimetric = 3,
};
StringView rendering_intent_name(RenderingIntent);
// ICC v4, 7.2.11 Profile flags field
class Flags {
public:
Flags();
// "The profile flags field contains flags."
Flags(u32);
u32 bits() const { return m_bits; }
// "These can indicate various hints for the CMM such as distributed processing and caching options."
// "The least-significant 16 bits are reserved for the ICC."
u16 color_management_module_bits() const { return bits() >> 16; }
u16 icc_bits() const { return bits() & 0xffff; }
// "Bit position 0: Embedded profile (0 if not embedded, 1 if embedded in file)"
bool is_embedded_in_file() const { return (icc_bits() & 1) != 0; }
// "Bit position 1: Profile cannot be used independently of the embedded colour data (set to 1 if true, 0 if false)"
// Double negation isn't unconfusing, so this function uses the inverted, positive sense.
bool can_be_used_independently_of_embedded_color_data() const { return (icc_bits() & 2) == 0; }
static constexpr u32 KnownBitsMask = 3;
private:
u32 m_bits = 0;
};
// ICC v4, 7.2.14 Device attributes field
class DeviceAttributes {
public:
DeviceAttributes();
// "The device attributes field shall contain flags used to identify attributes
// unique to the particular device setup for which the profile is applicable."
DeviceAttributes(u64);
u64 bits() const { return m_bits; }
// "The least-significant 32 bits of this 64-bit value are defined by the ICC. "
u32 icc_bits() const { return bits() & 0xffff'ffff; }
// "Notice that bits 0, 1, 2, and 3 describe the media, not the device."
// "0": "Reflective (0) or transparency (1)"
enum class MediaReflectivity {
Reflective,
Transparent,
};
MediaReflectivity media_reflectivity() const { return MediaReflectivity(icc_bits() & 1); }
// "1": "Glossy (0) or matte (1)"
enum class MediaGlossiness {
Glossy,
Matte,
};
MediaGlossiness media_glossiness() const { return MediaGlossiness((icc_bits() >> 1) & 1); }
// "2": "Media polarity, positive (0) or negative (1)"
enum class MediaPolarity {
Positive,
Negative,
};
MediaPolarity media_polarity() const { return MediaPolarity((icc_bits() >> 2) & 1); }
// "3": "Colour media (0), black & white media (1)"
enum class MediaColor {
Colored,
BlackAndWhite,
};
MediaColor media_color() const { return MediaColor((icc_bits() >> 3) & 1); }
// "4 to 31": Reserved (set to binary zero)"
// "32 to 63": "Use not defined by ICC (vendor specific"
u32 vendor_bits() const { return bits() >> 32; }
static constexpr u64 KnownBitsMask = 0xf;
private:
u64 m_bits = 0;
};
struct ProfileHeader {
u32 on_disk_size { 0 };
Optional<PreferredCMMType> preferred_cmm_type;
Version version;
DeviceClass device_class {};
ColorSpace data_color_space {};
ColorSpace connection_space {};
time_t creation_timestamp { 0 };
Optional<PrimaryPlatform> primary_platform {};
Flags flags;
Optional<DeviceManufacturer> device_manufacturer;
Optional<DeviceModel> device_model;
DeviceAttributes device_attributes;
RenderingIntent rendering_intent {};
XYZ pcs_illuminant;
Optional<Creator> creator;
Optional<Crypto::Hash::MD5::DigestType> id;
};
class Profile : public RefCounted<Profile> {
public:
static ErrorOr<NonnullRefPtr<Profile>> try_load_from_externally_owned_memory(ReadonlyBytes);
static ErrorOr<NonnullRefPtr<Profile>> create(ProfileHeader const& header, OrderedHashMap<TagSignature, NonnullRefPtr<TagData>> tag_table);
Optional<PreferredCMMType> preferred_cmm_type() const { return m_header.preferred_cmm_type; }
Version version() const { return m_header.version; }
DeviceClass device_class() const { return m_header.device_class; }
ColorSpace data_color_space() const { return m_header.data_color_space; }
// For non-DeviceLink profiles, always PCSXYZ or PCSLAB.
ColorSpace connection_space() const { return m_header.connection_space; }
u32 on_disk_size() const { return m_header.on_disk_size; }
time_t creation_timestamp() const { return m_header.creation_timestamp; }
Optional<PrimaryPlatform> primary_platform() const { return m_header.primary_platform; }
Flags flags() const { return m_header.flags; }
Optional<DeviceManufacturer> device_manufacturer() const { return m_header.device_manufacturer; }
Optional<DeviceModel> device_model() const { return m_header.device_model; }
DeviceAttributes device_attributes() const { return m_header.device_attributes; }
RenderingIntent rendering_intent() const { return m_header.rendering_intent; }
XYZ const& pcs_illuminant() const { return m_header.pcs_illuminant; }
Optional<Creator> creator() const { return m_header.creator; }
Optional<Crypto::Hash::MD5::DigestType> const& id() const { return m_header.id; }
static Crypto::Hash::MD5::DigestType compute_id(ReadonlyBytes);
template<typename Callback>
void for_each_tag(Callback callback) const
{
for (auto const& tag : m_tag_table)
callback(tag.key, tag.value);
}
template<FallibleFunction<TagSignature, NonnullRefPtr<TagData>> Callback>
ErrorOr<void> try_for_each_tag(Callback&& callback) const
{
for (auto const& tag : m_tag_table)
TRY(callback(tag.key, tag.value));
return {};
}
size_t tag_count() const { return m_tag_table.size(); }
// Only versions 2 and 4 are in use.
bool is_v2() const { return version().major_version() == 2; }
bool is_v4() const { return version().major_version() == 4; }
private:
Profile(ProfileHeader const& header, OrderedHashMap<TagSignature, NonnullRefPtr<TagData>> tag_table)
: m_header(header)
, m_tag_table(move(tag_table))
{
}
ErrorOr<void> check_required_tags();
ErrorOr<void> check_tag_types();
ProfileHeader m_header;
OrderedHashMap<TagSignature, NonnullRefPtr<TagData>> m_tag_table;
};
}
template<>
struct AK::Formatter<Gfx::ICC::Version> : Formatter<FormatString> {
ErrorOr<void> format(FormatBuilder& builder, Gfx::ICC::Version const& version)
{
return Formatter<FormatString>::format(builder, "{}.{}.{}"sv, version.major_version(), version.minor_version(), version.bugfix_version());
}
};