1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-27 08:37:46 +00:00

LibGfx: Split ICC/Profile.{h,cpp} into several files

s15Fixed16Number and XYZNumber are somewhat awkwardly duplicated
in both Profile.cpp and TagTypes.cpp. Other than that, this is a
pure code move.

No behavior change.
This commit is contained in:
Nico Weber 2023-01-27 14:58:02 -05:00 committed by Linus Groh
parent 6d51d8ad32
commit b5deccf859
9 changed files with 876 additions and 781 deletions

View file

@ -7,119 +7,21 @@
#pragma once
#include <AK/Error.h>
#include <AK/FixedPoint.h>
#include <AK/Format.h>
#include <AK/HashMap.h>
#include <AK/NonnullRefPtr.h>
#include <AK/RefCounted.h>
#include <AK/Span.h>
#include <AK/String.h>
#include <AK/URL.h>
#include <LibCrypto/Hash/MD5.h>
#include <LibGfx/ICC/DistinctFourCC.h>
#include <LibGfx/ICC/TagTypes.h>
namespace Gfx::ICC {
// The ICC spec uses FourCCs for many different things.
// This is used to give FourCCs for different roles distinct types, so that they can only be compared to the correct constants.
// (FourCCs that have only a small and fixed set of values should use an enum class instead, see e.g. DeviceClass and ColorSpace below.)
enum class FourCCType {
PreferredCMMType,
DeviceManufacturer,
DeviceModel,
Creator,
TagSignature,
TagTypeSignature,
};
template<FourCCType type>
struct [[gnu::packed]] DistinctFourCC {
constexpr explicit DistinctFourCC(u32 value)
: value(value)
{
}
constexpr operator u32() const { return value; }
char c0() const { return value >> 24; }
char c1() const { return (value >> 16) & 0xff; }
char c2() const { return (value >> 8) & 0xff; }
char c3() const { return value & 0xff; }
bool operator==(DistinctFourCC b) const { return value == b.value; }
u32 value { 0 };
};
using PreferredCMMType = DistinctFourCC<FourCCType::PreferredCMMType>; // ICC v4, "7.2.3 Preferred CMM type field"
using DeviceManufacturer = DistinctFourCC<FourCCType::DeviceManufacturer>; // ICC v4, "7.2.12 Device manufacturer field"
using DeviceModel = DistinctFourCC<FourCCType::DeviceModel>; // ICC v4, "7.2.13 Device model field"
using Creator = DistinctFourCC<FourCCType::Creator>; // ICC v4, "7.2.17 Profile creator field"
using TagSignature = DistinctFourCC<FourCCType::TagSignature>; // ICC v4, "9.2 Tag listing"
using TagTypeSignature = DistinctFourCC<FourCCType::TagTypeSignature>; // ICC v4, "10 Tag type definitions"
URL device_manufacturer_url(DeviceManufacturer);
URL device_model_url(DeviceModel);
// ICC v4, 9.2 Tag listing
// FIXME: Add v2-only tags too.
#define ENUMERATE_TAG_SIGNATURES(TAG) \
TAG(AToB0Tag, 0x41324230 /* 'A2B0' */) \
TAG(AToB1Tag, 0x41324231 /* 'A2B1' */) \
TAG(AToB2Tag, 0x41324232 /* 'A2B2' */) \
TAG(blueMatrixColumnTag, 0x6258595A /* 'bXYZ' */) \
TAG(blueTRCTag, 0x62545243 /* 'bTRC' */) \
TAG(BToA0Tag, 0x42324130 /* 'B2A0' */) \
TAG(BToA1Tag, 0x42324131 /* 'B2A1' */) \
TAG(BToA2Tag, 0x42324132 /* 'B2A2' */) \
TAG(BToD0Tag, 0x42324430 /* 'B2D0' */) \
TAG(BToD1Tag, 0x42324431 /* 'B2D1' */) \
TAG(BToD2Tag, 0x42324432 /* 'B2D2' */) \
TAG(BToD3Tag, 0x42324433 /* 'B2D3' */) \
TAG(calibrationDateTimeTag, 0x63616C74 /* 'calt' */) \
TAG(charTargetTag, 0x74617267 /* 'targ' */) \
TAG(chromaticAdaptationTag, 0x63686164 /* 'chad' */) \
TAG(chromaticityTag, 0x6368726D /* 'chrm' */) \
TAG(cicpTag, 0x63696370 /* 'cicp' */) \
TAG(colorantOrderTag, 0x636C726F /* 'clro' */) \
TAG(colorantTableTag, 0x636C7274 /* 'clrt' */) \
TAG(colorantTableOutTag, 0x636C6F74 /* 'clot' */) \
TAG(colorimetricIntentImageStateTag, 0x63696973 /* 'ciis' */) \
TAG(copyrightTag, 0x63707274 /* 'cprt' */) \
TAG(deviceMfgDescTag, 0x646D6E64 /* 'dmnd' */) \
TAG(deviceModelDescTag, 0x646D6464 /* 'dmdd' */) \
TAG(DToB0Tag, 0x44324230 /* 'D2B0' */) \
TAG(DToB1Tag, 0x44324231 /* 'D2B1' */) \
TAG(DToB2Tag, 0x44324232 /* 'D2B2' */) \
TAG(DToB3Tag, 0x44324233 /* 'D2B3' */) \
TAG(gamutTag, 0x67616D74 /* 'gamt' */) \
TAG(grayTRCTag, 0x6B545243 /* 'kTRC' */) \
TAG(greenMatrixColumnTag, 0x6758595A /* 'gXYZ' */) \
TAG(greenTRCTag, 0x67545243 /* 'gTRC' */) \
TAG(luminanceTag, 0x6C756D69 /* 'lumi' */) \
TAG(measurementTag, 0x6D656173 /* 'meas' */) \
TAG(metadataTag, 0x6D657461 /* 'meta' */) \
TAG(mediaWhitePointTag, 0x77747074 /* 'wtpt' */) \
TAG(namedColor2Tag, 0x6E636C32 /* 'ncl2' */) \
TAG(outputResponseTag, 0x72657370 /* 'resp' */) \
TAG(perceptualRenderingIntentGamutTag, 0x72696730 /* 'rig0' */) \
TAG(preview0Tag, 0x70726530 /* 'pre0' */) \
TAG(preview1Tag, 0x70726531 /* 'pre1' */) \
TAG(preview2Tag, 0x70726532 /* 'pre2' */) \
TAG(profileDescriptionTag, 0x64657363 /* 'desc' */) \
TAG(profileSequenceDescTag, 0x70736571 /* 'pseq' */) \
TAG(profileSequenceIdentifierTag, 0x70736964 /* 'psid' */) \
TAG(redMatrixColumnTag, 0x7258595A /* 'rXYZ' */) \
TAG(redTRCTag, 0x72545243 /* 'rTRC' */) \
TAG(saturationRenderingIntentGamutTag, 0x72696732 /* 'rig2' */) \
TAG(technologyTag, 0x74656368 /* 'tech' */) \
TAG(viewingCondDescTag, 0x76756564 /* 'vued' */) \
TAG(viewingConditionsTag, 0x76696577 /* 'view' */)
#define TAG(name, id) constexpr inline TagSignature name { id };
ENUMERATE_TAG_SIGNATURES(TAG)
#undef TAG
Optional<StringView> tag_signature_spec_name(TagSignature);
// ICC v4, 7.2.4 Profile version field
class Version {
public:
@ -285,279 +187,6 @@ private:
u64 m_bits = 0;
};
using S15Fixed16 = FixedPoint<16, i32>;
struct XYZ {
double x { 0 };
double y { 0 };
double z { 0 };
bool operator==(const XYZ&) const = default;
};
class TagData : public RefCounted<TagData> {
public:
u32 offset() const { return m_offset; }
u32 size() const { return m_size; }
TagTypeSignature type() const { return m_type; }
protected:
TagData(u32 offset, u32 size, TagTypeSignature type)
: m_offset(offset)
, m_size(size)
, m_type(type)
{
}
private:
u32 m_offset;
u32 m_size;
TagTypeSignature m_type;
};
class UnknownTagData : public TagData {
public:
UnknownTagData(u32 offset, u32 size, TagTypeSignature type)
: TagData(offset, size, type)
{
}
};
// ICC v4, 10.6 curveType
class CurveTagData : public TagData {
public:
static constexpr TagTypeSignature Type { 0x63757276 }; // 'curv'
static ErrorOr<NonnullRefPtr<CurveTagData>> from_bytes(ReadonlyBytes, u32 offset, u32 size);
CurveTagData(u32 offset, u32 size, Vector<u16> values)
: TagData(offset, size, Type)
, m_values(move(values))
{
}
// "The curveType embodies a one-dimensional function which maps an input value in the domain of the function
// to an output value in the range of the function. The domain and range values are in the range of 0,0 to 1,0.
// - When n is equal to 0, an identity response is assumed.
// - When n is equal to 1, then the curve value shall be interpreted as a gamma value, encoded as a
// u8Fixed8Number. Gamma shall be interpreted as the exponent in the equation y = pow(x,γ) and not as an inverse.
// - When n is greater than 1, the curve values (which embody a sampled one-dimensional function) shall be
// defined as follows:
// - The first entry represents the input value 0,0, the last entry represents the input value 1,0, and intermediate
// entries are uniformly spaced using an increment of 1,0/(n-1). These entries are encoded as uInt16Numbers
// (i.e. the values represented by the entries, which are in the range 0,0 to 1,0 are encoded in the range 0 to
// 65 535). Function values between the entries shall be obtained through linear interpolation."
Vector<u16> const& values() const { return m_values; }
private:
Vector<u16> m_values;
};
// ICC v4, 10.15 multiLocalizedUnicodeType
class MultiLocalizedUnicodeTagData : public TagData {
public:
static constexpr TagTypeSignature Type { 0x6D6C7563 }; // 'mluc'
static ErrorOr<NonnullRefPtr<MultiLocalizedUnicodeTagData>> from_bytes(ReadonlyBytes, u32 offset, u32 size);
struct Record {
u16 iso_639_1_language_code;
u16 iso_3166_1_country_code;
String text;
};
MultiLocalizedUnicodeTagData(u32 offset, u32 size, Vector<Record> records)
: TagData(offset, size, Type)
, m_records(move(records))
{
}
Vector<Record> const& records() const { return m_records; }
private:
Vector<Record> m_records;
};
// ICC v4, 10.18 parametricCurveType
class ParametricCurveTagData : public TagData {
public:
// Table 68 — parametricCurveType function type encoding
enum class FunctionType {
// Y = X**g
Type0,
// Y = (a*X + b)**g if X >= -b/a
// = 0 else
Type1,
CIE_122_1966 = Type1,
// Y = (a*X + b)**g + c if X >= -b/a
// = c else
Type2,
IEC_61966_1 = Type2,
// Y = (a*X + b)**g if X >= d
// = c*X else
Type3,
IEC_61966_2_1 = Type3,
sRGB = Type3,
// Y = (a*X + b)**g + e if X >= d
// = c*X + f else
Type4,
};
// "The domain and range of each function shall be [0,0 1,0]. Any function value outside the range shall be clipped
// to the range of the function."
// "NOTE 1 The parameters selected for a parametric curve can result in complex or undefined values for the input range
// used. This can occur, for example, if d < -b/a. In such cases the behaviour of the curve is undefined."
static constexpr TagTypeSignature Type { 0x70617261 }; // 'para'
static ErrorOr<NonnullRefPtr<ParametricCurveTagData>> from_bytes(ReadonlyBytes, u32 offset, u32 size);
ParametricCurveTagData(u32 offset, u32 size, FunctionType function_type, Array<S15Fixed16, 7> parameters)
: TagData(offset, size, Type)
, m_function_type(function_type)
, m_parameters(move(parameters))
{
}
FunctionType function_type() const { return m_function_type; }
static unsigned parameter_count(FunctionType);
S15Fixed16 g() const { return m_parameters[0]; }
S15Fixed16 a() const
{
VERIFY(function_type() >= FunctionType::Type1);
return m_parameters[1];
}
S15Fixed16 b() const
{
VERIFY(function_type() >= FunctionType::Type1);
return m_parameters[2];
}
S15Fixed16 c() const
{
VERIFY(function_type() >= FunctionType::Type2);
return m_parameters[3];
}
S15Fixed16 d() const
{
VERIFY(function_type() >= FunctionType::Type3);
return m_parameters[4];
}
S15Fixed16 e() const
{
VERIFY(function_type() >= FunctionType::Type4);
return m_parameters[5];
}
S15Fixed16 f() const
{
VERIFY(function_type() >= FunctionType::Type4);
return m_parameters[6];
}
private:
FunctionType m_function_type;
// Contains, in this order, g a b c d e f.
// Not all FunctionTypes use all parameters.
Array<S15Fixed16, 7> m_parameters;
};
// ICC v4, 10.22 s15Fixed16ArrayType
class S15Fixed16ArrayTagData : public TagData {
public:
static constexpr TagTypeSignature Type { 0x73663332 }; // 'sf32'
static ErrorOr<NonnullRefPtr<S15Fixed16ArrayTagData>> from_bytes(ReadonlyBytes, u32 offset, u32 size);
S15Fixed16ArrayTagData(u32 offset, u32 size, Vector<S15Fixed16, 9> values)
: TagData(offset, size, Type)
, m_values(move(values))
{
}
Vector<S15Fixed16, 9> const& values() const { return m_values; }
private:
Vector<S15Fixed16, 9> m_values;
};
// ICC v2, 6.5.17 textDescriptionType
class TextDescriptionTagData : public TagData {
public:
static constexpr TagTypeSignature Type { 0x64657363 }; // 'desc'
static ErrorOr<NonnullRefPtr<TextDescriptionTagData>> from_bytes(ReadonlyBytes, u32 offset, u32 size);
TextDescriptionTagData(u32 offset, u32 size, String ascii_description, u32 unicode_language_code, Optional<String> unicode_description, Optional<String> macintosh_description)
: TagData(offset, size, Type)
, m_ascii_description(move(ascii_description))
, m_unicode_language_code(unicode_language_code)
, m_unicode_description(move(unicode_description))
, m_macintosh_description(move(macintosh_description))
{
}
// Guaranteed to be 7-bit ASCII.
String const& ascii_description() const { return m_ascii_description; }
u32 unicode_language_code() const { return m_unicode_language_code; }
Optional<String> const& unicode_description() const { return m_unicode_description; }
Optional<String> const& macintosh_description() const { return m_macintosh_description; }
private:
String m_ascii_description;
u32 m_unicode_language_code { 0 };
Optional<String> m_unicode_description;
Optional<String> m_macintosh_description;
};
// ICC v4, 10.24 textType
class TextTagData : public TagData {
public:
static constexpr TagTypeSignature Type { 0x74657874 }; // 'text'
static ErrorOr<NonnullRefPtr<TextTagData>> from_bytes(ReadonlyBytes, u32 offset, u32 size);
TextTagData(u32 offset, u32 size, String text)
: TagData(offset, size, Type)
, m_text(move(text))
{
}
// Guaranteed to be 7-bit ASCII.
String const& text() const { return m_text; }
private:
String m_text;
};
// ICC v4, 10.31 XYZType
class XYZTagData : public TagData {
public:
static constexpr TagTypeSignature Type { 0x58595A20 }; // 'XYZ '
static ErrorOr<NonnullRefPtr<XYZTagData>> from_bytes(ReadonlyBytes, u32 offset, u32 size);
XYZTagData(u32 offset, u32 size, Vector<XYZ, 1> xyzs)
: TagData(offset, size, Type)
, m_xyzs(move(xyzs))
{
}
Vector<XYZ, 1> const& xyzs() const { return m_xyzs; }
private:
Vector<XYZ, 1> m_xyzs;
};
class Profile : public RefCounted<Profile> {
public:
static ErrorOr<NonnullRefPtr<Profile>> try_load_from_externally_owned_memory(ReadonlyBytes);
@ -624,47 +253,10 @@ private:
}
namespace AK {
template<Gfx::ICC::FourCCType Type>
struct Formatter<Gfx::ICC::DistinctFourCC<Type>> : StandardFormatter {
ErrorOr<void> format(FormatBuilder& builder, Gfx::ICC::DistinctFourCC<Type> const& four_cc)
{
TRY(builder.put_padding('\'', 1));
TRY(builder.put_padding(four_cc.c0(), 1));
TRY(builder.put_padding(four_cc.c1(), 1));
TRY(builder.put_padding(four_cc.c2(), 1));
TRY(builder.put_padding(four_cc.c3(), 1));
TRY(builder.put_padding('\'', 1));
return {};
}
};
template<>
struct Formatter<Gfx::ICC::Version> : Formatter<FormatString> {
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());
}
};
template<>
struct Formatter<Gfx::ICC::XYZ> : Formatter<FormatString> {
ErrorOr<void> format(FormatBuilder& builder, Gfx::ICC::XYZ const& xyz)
{
return Formatter<FormatString>::format(builder, "X = {}, Y = {}, Z = {}"sv, xyz.x, xyz.y, xyz.z);
}
};
template<Gfx::ICC::FourCCType Type>
struct Traits<Gfx::ICC::DistinctFourCC<Type>> : public GenericTraits<Gfx::ICC::DistinctFourCC<Type>> {
static unsigned hash(Gfx::ICC::DistinctFourCC<Type> const& key)
{
return int_hash(key.value);
}
static bool equals(Gfx::ICC::DistinctFourCC<Type> const& a, Gfx::ICC::DistinctFourCC<Type> const& b)
{
return a == b;
}
};
}