Profile.cpp 80 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641
  1. /*
  2. * Copyright (c) 2022-2023, Nico Weber <thakis@chromium.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include <AK/Endian.h>
  7. #include <LibGfx/CIELAB.h>
  8. #include <LibGfx/ICC/BinaryFormat.h>
  9. #include <LibGfx/ICC/Profile.h>
  10. #include <LibGfx/ICC/Tags.h>
  11. #include <LibGfx/Matrix3x3.h>
  12. #include <math.h>
  13. #include <time.h>
  14. // V2 spec: https://color.org/specification/ICC.1-2001-04.pdf
  15. // V4 spec: https://color.org/specification/ICC.1-2022-05.pdf
  16. namespace Gfx::ICC {
  17. namespace {
  18. ErrorOr<time_t> parse_date_time_number(DateTimeNumber const& date_time)
  19. {
  20. // ICC V4, 4.2 dateTimeNumber
  21. // "Number of the month (1 to 12)"
  22. if (date_time.month < 1 || date_time.month > 12)
  23. return Error::from_string_literal("ICC::Profile: dateTimeNumber month out of bounds");
  24. // "Number of the day of the month (1 to 31)"
  25. if (date_time.day < 1 || date_time.day > 31)
  26. return Error::from_string_literal("ICC::Profile: dateTimeNumber day out of bounds");
  27. // "Number of hours (0 to 23)"
  28. if (date_time.hours > 23)
  29. return Error::from_string_literal("ICC::Profile: dateTimeNumber hours out of bounds");
  30. // "Number of minutes (0 to 59)"
  31. if (date_time.minutes > 59)
  32. return Error::from_string_literal("ICC::Profile: dateTimeNumber minutes out of bounds");
  33. // "Number of seconds (0 to 59)"
  34. // ICC profiles apparently can't be created during leap seconds (seconds would be 60 there, but the spec doesn't allow that).
  35. if (date_time.seconds > 59)
  36. return Error::from_string_literal("ICC::Profile: dateTimeNumber seconds out of bounds");
  37. struct tm tm = {};
  38. tm.tm_year = date_time.year - 1900;
  39. tm.tm_mon = date_time.month - 1;
  40. tm.tm_mday = date_time.day;
  41. tm.tm_hour = date_time.hours;
  42. tm.tm_min = date_time.minutes;
  43. tm.tm_sec = date_time.seconds;
  44. // timegm() doesn't read tm.tm_isdst, tm.tm_wday, and tm.tm_yday, no need to fill them in.
  45. time_t timestamp = timegm(&tm);
  46. if (timestamp == -1)
  47. return Error::from_string_literal("ICC::Profile: dateTimeNumber not representable as timestamp");
  48. return timestamp;
  49. }
  50. ErrorOr<u32> parse_size(ICCHeader const& header, ReadonlyBytes icc_bytes)
  51. {
  52. // ICC v4, 7.2.2 Profile size field
  53. // "The value in the profile size field shall be the exact size obtained by combining the profile header,
  54. // the tag table, and the tagged element data, including the pad bytes for the last tag."
  55. // Valid files have enough data for profile header and tag table entry count.
  56. if (header.profile_size < sizeof(ICCHeader) + sizeof(u32))
  57. return Error::from_string_literal("ICC::Profile: Profile size too small");
  58. if (header.profile_size > icc_bytes.size())
  59. return Error::from_string_literal("ICC::Profile: Profile size larger than input data");
  60. // ICC v4, 7.1.2:
  61. // "NOTE 1 This implies that the length is required to be a multiple of four."
  62. // The ICC v2 spec doesn't have this note. It instead has:
  63. // ICC v2, 6.2.2 Offset:
  64. // "All tag data is required to start on a 4-byte boundary"
  65. // And indeed, there are files in the wild where the last tag has a size that isn't a multiple of four,
  66. // resulting in an ICC file whose size isn't a multiple of four either.
  67. if (header.profile_version_major >= 4 && header.profile_size % 4 != 0)
  68. return Error::from_string_literal("ICC::Profile: Profile size not a multiple of four");
  69. return header.profile_size;
  70. }
  71. Optional<PreferredCMMType> parse_preferred_cmm_type(ICCHeader const& header)
  72. {
  73. // ICC v4, 7.2.3 Preferred CMM type field
  74. // "This field may be used to identify the preferred CMM to be used.
  75. // If used, it shall match a CMM type signature registered in the ICC Tag Registry"
  76. // https://www.color.org/signatures2.xalter currently links to
  77. // https://www.color.org/registry/signature/TagRegistry-2021-03.pdf, which contains
  78. // some CMM signatures.
  79. // This requirement is often honored in practice, but not always. For example,
  80. // JPEGs exported in Adobe Lightroom contain profiles that set this to 'Lino',
  81. // which is not present in the "CMM Signatures" table in that PDF.
  82. // "If no preferred CMM is identified, this field shall be set to zero (00000000h)."
  83. if (header.preferred_cmm_type == PreferredCMMType { 0 })
  84. return {};
  85. return header.preferred_cmm_type;
  86. }
  87. ErrorOr<Version> parse_version(ICCHeader const& header)
  88. {
  89. // ICC v4, 7.2.4 Profile version field
  90. if (header.profile_version_zero != 0)
  91. return Error::from_string_literal("ICC::Profile: Reserved version bytes not zero");
  92. return Version(header.profile_version_major, header.profile_version_minor_bugfix);
  93. }
  94. ErrorOr<DeviceClass> parse_device_class(ICCHeader const& header)
  95. {
  96. // ICC v4, 7.2.5 Profile/device class field
  97. switch (header.profile_device_class) {
  98. case DeviceClass::InputDevice:
  99. case DeviceClass::DisplayDevice:
  100. case DeviceClass::OutputDevice:
  101. case DeviceClass::DeviceLink:
  102. case DeviceClass::ColorSpace:
  103. case DeviceClass::Abstract:
  104. case DeviceClass::NamedColor:
  105. return header.profile_device_class;
  106. }
  107. return Error::from_string_literal("ICC::Profile: Invalid device class");
  108. }
  109. ErrorOr<ColorSpace> parse_color_space(ColorSpace color_space)
  110. {
  111. // ICC v4, Table 19 — Data colour space signatures
  112. switch (color_space) {
  113. case ColorSpace::nCIEXYZ:
  114. case ColorSpace::CIELAB:
  115. case ColorSpace::CIELUV:
  116. case ColorSpace::YCbCr:
  117. case ColorSpace::CIEYxy:
  118. case ColorSpace::RGB:
  119. case ColorSpace::Gray:
  120. case ColorSpace::HSV:
  121. case ColorSpace::HLS:
  122. case ColorSpace::CMYK:
  123. case ColorSpace::CMY:
  124. case ColorSpace::TwoColor:
  125. case ColorSpace::ThreeColor:
  126. case ColorSpace::FourColor:
  127. case ColorSpace::FiveColor:
  128. case ColorSpace::SixColor:
  129. case ColorSpace::SevenColor:
  130. case ColorSpace::EightColor:
  131. case ColorSpace::NineColor:
  132. case ColorSpace::TenColor:
  133. case ColorSpace::ElevenColor:
  134. case ColorSpace::TwelveColor:
  135. case ColorSpace::ThirteenColor:
  136. case ColorSpace::FourteenColor:
  137. case ColorSpace::FifteenColor:
  138. return color_space;
  139. }
  140. return Error::from_string_literal("ICC::Profile: Invalid color space");
  141. }
  142. ErrorOr<ColorSpace> parse_data_color_space(ICCHeader const& header)
  143. {
  144. // ICC v4, 7.2.6 Data colour space field
  145. return parse_color_space(header.data_color_space);
  146. }
  147. ErrorOr<ColorSpace> parse_connection_space(ICCHeader const& header)
  148. {
  149. // ICC v4, 7.2.7 PCS field
  150. // and Annex D
  151. auto space = TRY(parse_color_space(header.profile_connection_space));
  152. if (header.profile_device_class != DeviceClass::DeviceLink && (space != ColorSpace::PCSXYZ && space != ColorSpace::PCSLAB))
  153. return Error::from_string_literal("ICC::Profile: Invalid profile connection space: Non-PCS space on non-DeviceLink profile");
  154. return space;
  155. }
  156. ErrorOr<time_t> parse_creation_date_time(ICCHeader const& header)
  157. {
  158. // ICC v4, 7.2.8 Date and time field
  159. return parse_date_time_number(header.profile_creation_time);
  160. }
  161. ErrorOr<void> parse_file_signature(ICCHeader const& header)
  162. {
  163. // ICC v4, 7.2.9 Profile file signature field
  164. if (header.profile_file_signature != ProfileFileSignature)
  165. return Error::from_string_literal("ICC::Profile: profile file signature not 'acsp'");
  166. return {};
  167. }
  168. ErrorOr<Optional<PrimaryPlatform>> parse_primary_platform(ICCHeader const& header)
  169. {
  170. // ICC v4, 7.2.10 Primary platform field
  171. // "If there is no primary platform identified, this field shall be set to zero (00000000h)."
  172. if (header.primary_platform == PrimaryPlatform { 0 })
  173. return OptionalNone {};
  174. switch (header.primary_platform) {
  175. case PrimaryPlatform::Apple:
  176. case PrimaryPlatform::Microsoft:
  177. case PrimaryPlatform::SiliconGraphics:
  178. case PrimaryPlatform::Sun:
  179. return header.primary_platform;
  180. }
  181. return Error::from_string_literal("ICC::Profile: Invalid primary platform");
  182. }
  183. Optional<DeviceManufacturer> parse_device_manufacturer(ICCHeader const& header)
  184. {
  185. // ICC v4, 7.2.12 Device manufacturer field
  186. // "This field may be used to identify a device manufacturer.
  187. // If used the signature shall match the signature contained in the appropriate section of the ICC signature registry found at www.color.org"
  188. // Device manufacturers can be looked up at https://www.color.org/signatureRegistry/index.xalter
  189. // For example: https://www.color.org/signatureRegistry/?entityEntry=APPL-4150504C
  190. // Some icc files use codes not in that registry. For example. D50_XYZ.icc from https://www.color.org/XYZprofiles.xalter
  191. // has its device manufacturer set to 'none', but https://www.color.org/signatureRegistry/?entityEntry=none-6E6F6E65 does not exist.
  192. // "If not used this field shall be set to zero (00000000h)."
  193. if (header.device_manufacturer == DeviceManufacturer { 0 })
  194. return {};
  195. return header.device_manufacturer;
  196. }
  197. Optional<DeviceModel> parse_device_model(ICCHeader const& header)
  198. {
  199. // ICC v4, 7.2.13 Device model field
  200. // "This field may be used to identify a device model.
  201. // If used the signature shall match the signature contained in the appropriate section of the ICC signature registry found at www.color.org"
  202. // Device models can be looked up at https://www.color.org/signatureRegistry/deviceRegistry/index.xalter
  203. // For example: https://www.color.org/signatureRegistry/deviceRegistry/?entityEntry=7FD8-37464438
  204. // Some icc files use codes not in that registry. For example. D50_XYZ.icc from https://www.color.org/XYZprofiles.xalter
  205. // has its device model set to 'none', but https://www.color.org/signatureRegistry/deviceRegistry?entityEntry=none-6E6F6E65 does not exist.
  206. // "If not used this field shall be set to zero (00000000h)."
  207. if (header.device_model == DeviceModel { 0 })
  208. return {};
  209. return header.device_model;
  210. }
  211. ErrorOr<DeviceAttributes> parse_device_attributes(ICCHeader const& header)
  212. {
  213. // ICC v4, 7.2.14 Device attributes field
  214. // "4 to 31": "Reserved (set to binary zero)"
  215. if (header.device_attributes & 0xffff'fff0)
  216. return Error::from_string_literal("ICC::Profile: Device attributes reserved bits not set to 0");
  217. return DeviceAttributes { header.device_attributes };
  218. }
  219. ErrorOr<RenderingIntent> parse_rendering_intent(ICCHeader const& header)
  220. {
  221. // ICC v4, 7.2.15 Rendering intent field
  222. switch (header.rendering_intent) {
  223. case RenderingIntent::Perceptual:
  224. case RenderingIntent::MediaRelativeColorimetric:
  225. case RenderingIntent::Saturation:
  226. case RenderingIntent::ICCAbsoluteColorimetric:
  227. return header.rendering_intent;
  228. }
  229. return Error::from_string_literal("ICC::Profile: Invalid rendering intent");
  230. }
  231. ErrorOr<XYZ> parse_pcs_illuminant(ICCHeader const& header)
  232. {
  233. // ICC v4, 7.2.16 PCS illuminant field
  234. XYZ xyz = (XYZ)header.pcs_illuminant;
  235. /// "The value, when rounded to four decimals, shall be X = 0,9642, Y = 1,0 and Z = 0,8249."
  236. if (round(xyz.X * 10'000) != 9'642 || round(xyz.Y * 10'000) != 10'000 || round(xyz.Z * 10'000) != 8'249)
  237. return Error::from_string_literal("ICC::Profile: Invalid pcs illuminant");
  238. return xyz;
  239. }
  240. Optional<Creator> parse_profile_creator(ICCHeader const& header)
  241. {
  242. // ICC v4, 7.2.17 Profile creator field
  243. // "This field may be used to identify the creator of the profile.
  244. // If used the signature should match the signature contained in the device manufacturer section of the ICC signature registry found at www.color.org."
  245. // This is not always true in practice.
  246. // For example, .icc files in /System/ColorSync/Profiles on macOS 12.6 set this to 'appl', which is a CMM signature, not a device signature (that one would be 'APPL').
  247. // "If not used this field shall be set to zero (00000000h)."
  248. if (header.profile_creator == Creator { 0 })
  249. return {};
  250. return header.profile_creator;
  251. }
  252. template<size_t N>
  253. bool all_bytes_are_zero(const u8 (&bytes)[N])
  254. {
  255. for (u8 byte : bytes) {
  256. if (byte != 0)
  257. return false;
  258. }
  259. return true;
  260. }
  261. ErrorOr<Optional<Crypto::Hash::MD5::DigestType>> parse_profile_id(ICCHeader const& header, ReadonlyBytes icc_bytes)
  262. {
  263. // ICC v4, 7.2.18 Profile ID field
  264. // "A profile ID field value of zero (00h) shall indicate that a profile ID has not been calculated."
  265. if (all_bytes_are_zero(header.profile_id))
  266. return OptionalNone {};
  267. Crypto::Hash::MD5::DigestType id;
  268. static_assert(sizeof(id.data) == sizeof(header.profile_id));
  269. memcpy(id.data, header.profile_id, sizeof(id.data));
  270. auto computed_id = Profile::compute_id(icc_bytes);
  271. if (id != computed_id)
  272. return Error::from_string_literal("ICC::Profile: Invalid profile id");
  273. return id;
  274. }
  275. ErrorOr<void> parse_reserved(ICCHeader const& header)
  276. {
  277. // ICC v4, 7.2.19 Reserved field
  278. // "This field of the profile header is reserved for future ICC definition and shall be set to zero."
  279. if (!all_bytes_are_zero(header.reserved))
  280. return Error::from_string_literal("ICC::Profile: Reserved header bytes are not zero");
  281. return {};
  282. }
  283. }
  284. URL device_manufacturer_url(DeviceManufacturer device_manufacturer)
  285. {
  286. return URL(ByteString::formatted("https://www.color.org/signatureRegistry/?entityEntry={:c}{:c}{:c}{:c}-{:08X}",
  287. device_manufacturer.c0(), device_manufacturer.c1(), device_manufacturer.c2(), device_manufacturer.c3(), device_manufacturer.value));
  288. }
  289. URL device_model_url(DeviceModel device_model)
  290. {
  291. return URL(ByteString::formatted("https://www.color.org/signatureRegistry/deviceRegistry/?entityEntry={:c}{:c}{:c}{:c}-{:08X}",
  292. device_model.c0(), device_model.c1(), device_model.c2(), device_model.c3(), device_model.value));
  293. }
  294. Flags::Flags() = default;
  295. Flags::Flags(u32 bits)
  296. : m_bits(bits)
  297. {
  298. }
  299. DeviceAttributes::DeviceAttributes() = default;
  300. DeviceAttributes::DeviceAttributes(u64 bits)
  301. : m_bits(bits)
  302. {
  303. }
  304. static ErrorOr<ProfileHeader> read_header(ReadonlyBytes bytes)
  305. {
  306. if (bytes.size() < sizeof(ICCHeader))
  307. return Error::from_string_literal("ICC::Profile: Not enough data for header");
  308. ProfileHeader header;
  309. auto raw_header = *bit_cast<ICCHeader const*>(bytes.data());
  310. TRY(parse_file_signature(raw_header));
  311. header.on_disk_size = TRY(parse_size(raw_header, bytes));
  312. header.preferred_cmm_type = parse_preferred_cmm_type(raw_header);
  313. header.version = TRY(parse_version(raw_header));
  314. header.device_class = TRY(parse_device_class(raw_header));
  315. header.data_color_space = TRY(parse_data_color_space(raw_header));
  316. header.connection_space = TRY(parse_connection_space(raw_header));
  317. header.creation_timestamp = TRY(parse_creation_date_time(raw_header));
  318. header.primary_platform = TRY(parse_primary_platform(raw_header));
  319. header.flags = Flags { raw_header.profile_flags };
  320. header.device_manufacturer = parse_device_manufacturer(raw_header);
  321. header.device_model = parse_device_model(raw_header);
  322. header.device_attributes = TRY(parse_device_attributes(raw_header));
  323. header.rendering_intent = TRY(parse_rendering_intent(raw_header));
  324. header.pcs_illuminant = TRY(parse_pcs_illuminant(raw_header));
  325. header.creator = parse_profile_creator(raw_header);
  326. header.id = TRY(parse_profile_id(raw_header, bytes));
  327. TRY(parse_reserved(raw_header));
  328. return header;
  329. }
  330. static ErrorOr<NonnullRefPtr<TagData>> read_tag(ReadonlyBytes bytes, u32 offset_to_beginning_of_tag_data_element, u32 size_of_tag_data_element)
  331. {
  332. // "All tag data elements shall start on a 4-byte boundary (relative to the start of the profile data stream)"
  333. if (offset_to_beginning_of_tag_data_element % 4 != 0)
  334. return Error::from_string_literal("ICC::Profile: Tag data not aligned");
  335. if (static_cast<u64>(offset_to_beginning_of_tag_data_element) + size_of_tag_data_element > bytes.size())
  336. return Error::from_string_literal("ICC::Profile: Tag data out of bounds");
  337. auto tag_bytes = bytes.slice(offset_to_beginning_of_tag_data_element, size_of_tag_data_element);
  338. // ICC v4, 9 Tag definitions
  339. // ICC v4, 9.1 General
  340. // "All tags, including private tags, have as their first four bytes a tag signature to identify to profile readers
  341. // what kind of data is contained within a tag."
  342. if (tag_bytes.size() < sizeof(u32))
  343. return Error::from_string_literal("ICC::Profile: Not enough data for tag type");
  344. auto type = tag_type(tag_bytes);
  345. switch (type) {
  346. case ChromaticityTagData::Type:
  347. return ChromaticityTagData::from_bytes(tag_bytes, offset_to_beginning_of_tag_data_element, size_of_tag_data_element);
  348. case CicpTagData::Type:
  349. return CicpTagData::from_bytes(tag_bytes, offset_to_beginning_of_tag_data_element, size_of_tag_data_element);
  350. case CurveTagData::Type:
  351. return CurveTagData::from_bytes(tag_bytes, offset_to_beginning_of_tag_data_element, size_of_tag_data_element);
  352. case Lut16TagData::Type:
  353. return Lut16TagData::from_bytes(tag_bytes, offset_to_beginning_of_tag_data_element, size_of_tag_data_element);
  354. case Lut8TagData::Type:
  355. return Lut8TagData::from_bytes(tag_bytes, offset_to_beginning_of_tag_data_element, size_of_tag_data_element);
  356. case LutAToBTagData::Type:
  357. return LutAToBTagData::from_bytes(tag_bytes, offset_to_beginning_of_tag_data_element, size_of_tag_data_element);
  358. case LutBToATagData::Type:
  359. return LutBToATagData::from_bytes(tag_bytes, offset_to_beginning_of_tag_data_element, size_of_tag_data_element);
  360. case MeasurementTagData::Type:
  361. return MeasurementTagData::from_bytes(tag_bytes, offset_to_beginning_of_tag_data_element, size_of_tag_data_element);
  362. case MultiLocalizedUnicodeTagData::Type:
  363. return MultiLocalizedUnicodeTagData::from_bytes(tag_bytes, offset_to_beginning_of_tag_data_element, size_of_tag_data_element);
  364. case NamedColor2TagData::Type:
  365. return NamedColor2TagData::from_bytes(tag_bytes, offset_to_beginning_of_tag_data_element, size_of_tag_data_element);
  366. case ParametricCurveTagData::Type:
  367. return ParametricCurveTagData::from_bytes(tag_bytes, offset_to_beginning_of_tag_data_element, size_of_tag_data_element);
  368. case S15Fixed16ArrayTagData::Type:
  369. return S15Fixed16ArrayTagData::from_bytes(tag_bytes, offset_to_beginning_of_tag_data_element, size_of_tag_data_element);
  370. case SignatureTagData::Type:
  371. return SignatureTagData::from_bytes(tag_bytes, offset_to_beginning_of_tag_data_element, size_of_tag_data_element);
  372. case TextDescriptionTagData::Type:
  373. return TextDescriptionTagData::from_bytes(tag_bytes, offset_to_beginning_of_tag_data_element, size_of_tag_data_element);
  374. case TextTagData::Type:
  375. return TextTagData::from_bytes(tag_bytes, offset_to_beginning_of_tag_data_element, size_of_tag_data_element);
  376. case ViewingConditionsTagData::Type:
  377. return ViewingConditionsTagData::from_bytes(tag_bytes, offset_to_beginning_of_tag_data_element, size_of_tag_data_element);
  378. case XYZTagData::Type:
  379. return XYZTagData::from_bytes(tag_bytes, offset_to_beginning_of_tag_data_element, size_of_tag_data_element);
  380. default:
  381. // FIXME: optionally ignore tags of unknown type
  382. return try_make_ref_counted<UnknownTagData>(offset_to_beginning_of_tag_data_element, size_of_tag_data_element, type);
  383. }
  384. }
  385. static ErrorOr<OrderedHashMap<TagSignature, NonnullRefPtr<TagData>>> read_tag_table(ReadonlyBytes bytes)
  386. {
  387. OrderedHashMap<TagSignature, NonnullRefPtr<TagData>> tag_table;
  388. // ICC v4, 7.3 Tag table
  389. // ICC v4, 7.3.1 Overview
  390. // "The tag table acts as a table of contents for the tags and an index into the tag data element in the profiles. It
  391. // shall consist of a 4-byte entry that contains a count of the number of tags in the table followed by a series of 12-
  392. // byte entries with one entry for each tag. The tag table therefore contains 4+12n bytes where n is the number of
  393. // tags contained in the profile. The entries for the tags within the table are not required to be in any particular
  394. // order nor are they required to match the sequence of tag data element within the profile.
  395. // Each 12-byte tag entry following the tag count shall consist of a 4-byte tag signature, a 4-byte offset to define
  396. // the beginning of the tag data element, and a 4-byte entry identifying the length of the tag data element in bytes.
  397. // [...]
  398. // The tag table shall define a contiguous sequence of unique tag elements, with no gaps between the last byte
  399. // of any tag data element referenced from the tag table (inclusive of any necessary additional pad bytes required
  400. // to reach a four-byte boundary) and the byte offset of the following tag element, or the end of the file.
  401. // Duplicate tag signatures shall not be included in the tag table.
  402. // Tag data elements shall not partially overlap, so there shall be no part of any tag data element that falls within
  403. // the range defined for another tag in the tag table."
  404. ReadonlyBytes tag_table_bytes = bytes.slice(sizeof(ICCHeader));
  405. if (tag_table_bytes.size() < sizeof(u32))
  406. return Error::from_string_literal("ICC::Profile: Not enough data for tag count");
  407. auto tag_count = *bit_cast<BigEndian<u32> const*>(tag_table_bytes.data());
  408. tag_table_bytes = tag_table_bytes.slice(sizeof(u32));
  409. if (tag_table_bytes.size() < tag_count * sizeof(TagTableEntry))
  410. return Error::from_string_literal("ICC::Profile: Not enough data for tag table entries");
  411. auto tag_table_entries = bit_cast<TagTableEntry const*>(tag_table_bytes.data());
  412. // "The tag table may contain multiple tags signatures that all reference the same tag data element offset, allowing
  413. // efficient reuse of tag data elements."
  414. HashMap<u32, NonnullRefPtr<TagData>> offset_to_tag_data;
  415. for (u32 i = 0; i < tag_count; ++i) {
  416. // FIXME: optionally ignore tags with unknown signature
  417. // Dedupe identical offset/sizes.
  418. NonnullRefPtr<TagData> tag_data = TRY(offset_to_tag_data.try_ensure(tag_table_entries[i].offset_to_beginning_of_tag_data_element, [&]() {
  419. return read_tag(bytes, tag_table_entries[i].offset_to_beginning_of_tag_data_element, tag_table_entries[i].size_of_tag_data_element);
  420. }));
  421. // "In such cases, both the offset and size of the tag data elements in the tag table shall be the same."
  422. if (tag_data->size() != tag_table_entries[i].size_of_tag_data_element)
  423. return Error::from_string_literal("ICC::Profile: two tags have same offset but different sizes");
  424. // "Duplicate tag signatures shall not be included in the tag table."
  425. if (TRY(tag_table.try_set(tag_table_entries[i].tag_signature, move(tag_data))) != AK::HashSetResult::InsertedNewEntry)
  426. return Error::from_string_literal("ICC::Profile: duplicate tag signature");
  427. }
  428. return tag_table;
  429. }
  430. static bool is_xCLR(ColorSpace color_space)
  431. {
  432. switch (color_space) {
  433. case ColorSpace::TwoColor:
  434. case ColorSpace::ThreeColor:
  435. case ColorSpace::FourColor:
  436. case ColorSpace::FiveColor:
  437. case ColorSpace::SixColor:
  438. case ColorSpace::SevenColor:
  439. case ColorSpace::EightColor:
  440. case ColorSpace::NineColor:
  441. case ColorSpace::TenColor:
  442. case ColorSpace::ElevenColor:
  443. case ColorSpace::TwelveColor:
  444. case ColorSpace::ThirteenColor:
  445. case ColorSpace::FourteenColor:
  446. case ColorSpace::FifteenColor:
  447. return true;
  448. default:
  449. return false;
  450. }
  451. }
  452. ErrorOr<void> Profile::check_required_tags()
  453. {
  454. // ICC v4, 8 Required tags
  455. // ICC v4, 8.2 Common requirements
  456. // "With the exception of DeviceLink profiles, all profiles shall contain the following tags:
  457. // - profileDescriptionTag (see 9.2.41);
  458. // - copyrightTag (see 9.2.21);
  459. // - mediaWhitePointTag (see 9.2.34);
  460. // - chromaticAdaptationTag, when the measurement data used to calculate the profile was specified for an
  461. // adopted white with a chromaticity different from that of the PCS adopted white (see 9.2.15).
  462. // NOTE A DeviceLink profile is not required to have either a mediaWhitePointTag or a chromaticAdaptationTag."
  463. // profileDescriptionTag, copyrightTag are required for DeviceLink too (see ICC v4, 8.6 DeviceLink profile).
  464. // profileDescriptionTag, copyrightTag, mediaWhitePointTag are required in ICC v2 as well.
  465. // chromaticAdaptationTag isn't required in v2 profiles as far as I can tell.
  466. if (!m_tag_table.contains(profileDescriptionTag))
  467. return Error::from_string_literal("ICC::Profile: required profileDescriptionTag is missing");
  468. if (!m_tag_table.contains(copyrightTag))
  469. return Error::from_string_literal("ICC::Profile: required copyrightTag is missing");
  470. if (device_class() != DeviceClass::DeviceLink) {
  471. if (!m_tag_table.contains(mediaWhitePointTag))
  472. return Error::from_string_literal("ICC::Profile: required mediaWhitePointTag is missing");
  473. // FIXME: Check for chromaticAdaptationTag after figuring out when exactly it needs to be present.
  474. }
  475. auto has_tag = [&](auto& tag) { return m_tag_table.contains(tag); };
  476. auto has_all_tags = [&]<class T>(T tags) { return all_of(tags, has_tag); };
  477. switch (device_class()) {
  478. case DeviceClass::InputDevice: {
  479. // ICC v4, 8.3 Input profiles
  480. // "8.3.1 General
  481. // Input profiles are generally used with devices such as scanners and digital cameras. The types of profiles
  482. // available for use as Input profiles are N-component LUT-based, Three-component matrix-based, and
  483. // monochrome.
  484. // 8.3.2 N-component LUT-based Input profiles
  485. // In addition to the tags listed in 8.2 an N-component LUT-based Input profile shall contain the following tag:
  486. // - AToB0Tag (see 9.2.1).
  487. // 8.3.3 Three-component matrix-based Input profiles
  488. // In addition to the tags listed in 8.2, a three-component matrix-based Input profile shall contain the following tags:
  489. // - redMatrixColumnTag (see 9.2.44);
  490. // - greenMatrixColumnTag (see 9.2.30);
  491. // - blueMatrixColumnTag (see 9.2.4);
  492. // - redTRCTag (see 9.2.45);
  493. // - greenTRCTag (see 9.2.31);
  494. // - blueTRCTag (see 9.2.5).
  495. // [...] Only the PCSXYZ encoding can be used with matrix/TRC models.
  496. // 8.3.4 Monochrome Input profiles
  497. // In addition to the tags listed in 8.2, a monochrome Input profile shall contain the following tag:
  498. // - grayTRCTag (see 9.2.29)."
  499. bool has_n_component_lut_based_tags = has_tag(AToB0Tag);
  500. bool has_three_component_matrix_based_tags = has_all_tags(Array { redMatrixColumnTag, greenMatrixColumnTag, blueMatrixColumnTag, redTRCTag, greenTRCTag, blueTRCTag });
  501. bool has_monochrome_tags = has_tag(grayTRCTag);
  502. if (!has_n_component_lut_based_tags && !has_three_component_matrix_based_tags && !has_monochrome_tags)
  503. return Error::from_string_literal("ICC::Profile: InputDevice required tags are missing");
  504. if (!has_n_component_lut_based_tags && has_three_component_matrix_based_tags && connection_space() != ColorSpace::PCSXYZ)
  505. return Error::from_string_literal("ICC::Profile: InputDevice three-component matrix-based profile must use PCSXYZ");
  506. break;
  507. }
  508. case DeviceClass::DisplayDevice: {
  509. // ICC v4, 8.4 Display profiles
  510. // "8.4.1 General
  511. // This class of profiles represents display devices such as monitors. The types of profiles available for use as
  512. // Display profiles are N-component LUT-based, Three-component matrix-based, and monochrome.
  513. // 8.4.2 N-Component LUT-based Display profiles
  514. // In addition to the tags listed in 8.2 an N-component LUT-based Input profile shall contain the following tags:
  515. // - AToB0Tag (see 9.2.1);
  516. // - BToA0Tag (see 9.2.6).
  517. // 8.4.3 Three-component matrix-based Display profiles
  518. // In addition to the tags listed in 8.2, a three-component matrix-based Display profile shall contain the following
  519. // tags:
  520. // - redMatrixColumnTag (see 9.2.44);
  521. // - greenMatrixColumnTag (see 9.2.30);
  522. // - blueMatrixColumnTag (see 9.2.4);
  523. // - redTRCTag (see 9.2.45);
  524. // - greenTRCTag (see 9.2.31);
  525. // - blueTRCTag (see 9.2.5).
  526. // [...] Only the PCSXYZ encoding can be used with matrix/TRC models.
  527. // 8.4.4 Monochrome Display profiles
  528. // In addition to the tags listed in 8.2 a monochrome Display profile shall contain the following tag:
  529. // - grayTRCTag (see 9.2.29)."
  530. bool has_n_component_lut_based_tags = has_all_tags(Array { AToB0Tag, BToA0Tag });
  531. bool has_three_component_matrix_based_tags = has_all_tags(Array { redMatrixColumnTag, greenMatrixColumnTag, blueMatrixColumnTag, redTRCTag, greenTRCTag, blueTRCTag });
  532. bool has_monochrome_tags = has_tag(grayTRCTag);
  533. if (!has_n_component_lut_based_tags && !has_three_component_matrix_based_tags && !has_monochrome_tags)
  534. return Error::from_string_literal("ICC::Profile: DisplayDevice required tags are missing");
  535. if (!has_n_component_lut_based_tags && has_three_component_matrix_based_tags && connection_space() != ColorSpace::PCSXYZ)
  536. return Error::from_string_literal("ICC::Profile: DisplayDevice three-component matrix-based profile must use PCSXYZ");
  537. break;
  538. }
  539. case DeviceClass::OutputDevice: {
  540. // ICC v4, 8.5 Output profiles
  541. // "8.5.1 General
  542. // Output profiles are used to support devices such as printers and film recorders. The types of profiles available
  543. // for use as Output profiles are N-component LUT-based and Monochrome.
  544. // 8.5.2 N-component LUT-based Output profiles
  545. // In addition to the tags listed in 8.2 an N-component LUT-based Output profile shall contain the following tags:
  546. // - AToB0Tag (see 9.2.1);
  547. // - AToB1Tag (see 9.2.2);
  548. // - AToB2Tag (see 9.2.3);
  549. // - BToA0Tag (see 9.2.6);
  550. // - BToA1Tag (see 9.2.7);
  551. // - BToA2Tag (see 9.2.8);
  552. // - gamutTag (see 9.2.28);
  553. // - colorantTableTag (see 9.2.18), for the xCLR colour spaces (see 7.2.6)
  554. // 8.5.3 Monochrome Output profiles
  555. // In addition to the tags listed in 8.2 a monochrome Output profile shall contain the following tag:
  556. // - grayTRCTag (see 9.2.29)."
  557. // The colorantTableTag requirement is new in v4.
  558. Vector<TagSignature, 8> required_n_component_lut_based_tags = { AToB0Tag, AToB1Tag, AToB2Tag, BToA0Tag, BToA1Tag, BToA2Tag, gamutTag };
  559. if (is_v4() && is_xCLR(connection_space()))
  560. required_n_component_lut_based_tags.append(colorantTableTag);
  561. bool has_n_component_lut_based_tags = has_all_tags(required_n_component_lut_based_tags);
  562. bool has_monochrome_tags = has_tag(grayTRCTag);
  563. if (!has_n_component_lut_based_tags && !has_monochrome_tags)
  564. return Error::from_string_literal("ICC::Profile: OutputDevice required tags are missing");
  565. break;
  566. }
  567. case DeviceClass::DeviceLink: {
  568. // ICC v4, 8.6 DeviceLink profile
  569. // "A DeviceLink profile shall contain the following tags:
  570. // - profileDescriptionTag (see 9.2.41);
  571. // - copyrightTag (see 9.2.21);
  572. // - profileSequenceDescTag (see 9.2.42);
  573. // - AToB0Tag (see 9.2.1);
  574. // - colorantTableTag (see 9.2.18) which is required only if the data colour space field is xCLR, where x is
  575. // hexadecimal 2 to F (see 7.2.6);
  576. // - colorantTableOutTag (see 9.2.19), required only if the PCS field is xCLR, where x is hexadecimal 2 to F
  577. // (see 7.2.6)"
  578. // profileDescriptionTag and copyrightTag are already checked above, in the code for section 8.2.
  579. Vector<TagSignature, 4> required_tags = { profileSequenceDescTag, AToB0Tag };
  580. if (is_v4() && is_xCLR(connection_space())) { // This requirement is new in v4.
  581. required_tags.append(colorantTableTag);
  582. required_tags.append(colorantTableOutTag);
  583. }
  584. if (!has_all_tags(required_tags))
  585. return Error::from_string_literal("ICC::Profile: DeviceLink required tags are missing");
  586. // "The data colour space field (see 7.2.6) in the DeviceLink profile will be the same as the data colour space field
  587. // of the first profile in the sequence used to construct the device link. The PCS field (see 7.2.7) will be the same
  588. // as the data colour space field of the last profile in the sequence."
  589. // FIXME: Check that if profileSequenceDescType parsing is implemented.
  590. break;
  591. }
  592. case DeviceClass::ColorSpace:
  593. // ICC v4, 8.7 ColorSpace profile
  594. // "In addition to the tags listed in 8.2, a ColorSpace profile shall contain the following tags:
  595. // - BToA0Tag (see 9.2.6);
  596. // - AToB0Tag (see 9.2.1).
  597. // [...] ColorSpace profiles may be embedded in images."
  598. if (!has_all_tags(Array { AToB0Tag, BToA0Tag }))
  599. return Error::from_string_literal("ICC::Profile: ColorSpace required tags are missing");
  600. break;
  601. case DeviceClass::Abstract:
  602. // ICC v4, 8.8 Abstract profile
  603. // "In addition to the tags listed in 8.2, an Abstract profile shall contain the following tag:
  604. // - AToB0Tag (see 9.2.1).
  605. // [...] Abstract profiles cannot be embedded in images."
  606. if (!has_tag(AToB0Tag))
  607. return Error::from_string_literal("ICC::Profile: Abstract required AToB0Tag is missing");
  608. break;
  609. case DeviceClass::NamedColor:
  610. // ICC v4, 8.9 NamedColor profile
  611. // "In addition to the tags listed in 8.2, a NamedColor profile shall contain the following tag:
  612. // - namedColor2Tag (see 9.2.35)."
  613. if (!has_tag(namedColor2Tag))
  614. return Error::from_string_literal("ICC::Profile: NamedColor required namedColor2Tag is missing");
  615. break;
  616. }
  617. return {};
  618. }
  619. ErrorOr<void> Profile::check_tag_types()
  620. {
  621. // This uses m_tag_table.get() even for tags that are guaranteed to exist after check_required_tags()
  622. // so that the two functions can be called in either order.
  623. // Profile ID of /System/Library/ColorSync/Profiles/ITU-2020.icc on macOS 13.1.
  624. static constexpr Crypto::Hash::MD5::DigestType apple_itu_2020_id = { 0x57, 0x0b, 0x1b, 0x76, 0xc6, 0xa0, 0x50, 0xaa, 0x9f, 0x6c, 0x53, 0x8d, 0xbe, 0x2d, 0x3e, 0xf0 };
  625. // Profile ID of the "Display P3" profiles embedded in the images on https://webkit.org/blog-files/color-gamut/comparison.html
  626. // (The macOS 13.1 /System/Library/ColorSync/Profiles/Display\ P3.icc file no longer has this quirk.)
  627. static constexpr Crypto::Hash::MD5::DigestType apple_p3_2015_id = { 0xe5, 0xbb, 0x0e, 0x98, 0x67, 0xbd, 0x46, 0xcd, 0x4b, 0xbe, 0x44, 0x6e, 0xbd, 0x1b, 0x75, 0x98 };
  628. auto has_type = [&](auto tag, std::initializer_list<TagTypeSignature> types, std::initializer_list<TagTypeSignature> v4_types) {
  629. if (auto type = m_tag_table.get(tag); type.has_value()) {
  630. auto type_matches = [&](auto wanted_type) { return type.value()->type() == wanted_type; };
  631. return any_of(types, type_matches) || (is_v4() && any_of(v4_types, type_matches));
  632. }
  633. return true;
  634. };
  635. // ICC v4, 9.2.1 AToB0Tag
  636. // "Permitted tag types: lut8Type or lut16Type or lutAToBType"
  637. // ICC v2, 6.4.1 AToB0Tag
  638. // "Tag Type: lut8Type or lut16Type"
  639. if (!has_type(AToB0Tag, { Lut8TagData::Type, Lut16TagData::Type }, { LutAToBTagData::Type }))
  640. return Error::from_string_literal("ICC::Profile: AToB0Tag has unexpected type");
  641. // ICC v4, 9.2.2 AToB1Tag
  642. // "Permitted tag types: lut8Type or lut16Type or lutAToBType"
  643. // ICC v2, 6.4.2 AToB1Tag
  644. // "Tag Type: lut8Type or lut16Type"
  645. if (!has_type(AToB1Tag, { Lut8TagData::Type, Lut16TagData::Type }, { LutAToBTagData::Type }))
  646. return Error::from_string_literal("ICC::Profile: AToB1Tag has unexpected type");
  647. // ICC v4, 9.2.3 AToB2Tag
  648. // "Permitted tag types: lut8Type or lut16Type or lutAToBType"
  649. // ICC v2, 6.4.3 AToB2Tag
  650. // "Tag Type: lut8Type or lut16Type"
  651. if (!has_type(AToB2Tag, { Lut8TagData::Type, Lut16TagData::Type }, { LutAToBTagData::Type }))
  652. return Error::from_string_literal("ICC::Profile: AToB2Tag has unexpected type");
  653. // ICC v4, 9.2.4 blueMatrixColumnTag
  654. // "Permitted tag types: XYZType
  655. // This tag contains the third column in the matrix used in matrix/TRC transforms."
  656. // (Called blueColorantTag in the v2 spec, otherwise identical there.)
  657. if (auto type = m_tag_table.get(blueMatrixColumnTag); type.has_value()) {
  658. if (type.value()->type() != XYZTagData::Type)
  659. return Error::from_string_literal("ICC::Profile: blueMatrixColumnTag has unexpected type");
  660. if (static_cast<XYZTagData const&>(*type.value()).xyzs().size() != 1)
  661. return Error::from_string_literal("ICC::Profile: blueMatrixColumnTag has unexpected size");
  662. }
  663. // ICC v4, 9.2.5 blueTRCTag
  664. // "Permitted tag types: curveType or parametricCurveType"
  665. // ICC v2, 6.4.5 blueTRCTag
  666. // "Tag Type: curveType"
  667. if (!has_type(blueTRCTag, { CurveTagData::Type }, { ParametricCurveTagData::Type }))
  668. return Error::from_string_literal("ICC::Profile: blueTRCTag has unexpected type");
  669. // ICC v4, 9.2.6 BToA0Tag
  670. // "Permitted tag types: lut8Type or lut16Type or lutBToAType"
  671. // ICC v2, 6.4.6 BToA0Tag
  672. // "Tag Type: lut8Type or lut16Type"
  673. if (!has_type(BToA0Tag, { Lut8TagData::Type, Lut16TagData::Type }, { LutBToATagData::Type }))
  674. return Error::from_string_literal("ICC::Profile: BToA0Tag has unexpected type");
  675. // ICC v4, 9.2.7 BToA1Tag
  676. // "Permitted tag types: lut8Type or lut16Type or lutBToAType"
  677. // ICC v2, 6.4.7 BToA1Tag
  678. // "Tag Type: lut8Type or lut16Type"
  679. if (!has_type(BToA1Tag, { Lut8TagData::Type, Lut16TagData::Type }, { LutBToATagData::Type }))
  680. return Error::from_string_literal("ICC::Profile: BToA1Tag has unexpected type");
  681. // ICC v4, 9.2.8 BToA2Tag
  682. // "Permitted tag types: lut8Type or lut16Type or lutBToAType"
  683. // ICC v2, 6.4.8 BToA2Tag
  684. // "Tag Type: lut8Type or lut16Type"
  685. if (!has_type(BToA2Tag, { Lut8TagData::Type, Lut16TagData::Type }, { LutBToATagData::Type }))
  686. return Error::from_string_literal("ICC::Profile: BToA2Tag has unexpected type");
  687. // ICC v4, 9.2.9 BToD0Tag
  688. // "Permitted tag types: multiProcessElementsType"
  689. // FIXME
  690. // ICC v4, 9.2.10 BToD1Tag
  691. // "Permitted tag types: multiProcessElementsType"
  692. // FIXME
  693. // ICC v4, 9.2.11 BToD2Tag
  694. // "Permitted tag types: multiProcessElementsType"
  695. // FIXME
  696. // ICC v4, 9.2.12 BToD3Tag
  697. // "Permitted tag types: multiProcessElementsType"
  698. // FIXME
  699. // ICC v4, 9.2.13 calibrationDateTimeTag
  700. // "Permitted tag types: dateTimeType"
  701. // FIXME
  702. // ICC v4, 9.2.14 charTargetTag
  703. // "Permitted tag types: textType"
  704. if (!has_type(charTargetTag, { TextTagData::Type }, {}))
  705. return Error::from_string_literal("ICC::Profile: charTargetTag has unexpected type");
  706. // ICC v4, 9.2.15 chromaticAdaptationTag
  707. // "Permitted tag types: s15Fixed16ArrayType [...]
  708. // Such a 3 x 3 chromatic adaptation matrix is organized as a 9-element array"
  709. if (auto type = m_tag_table.get(chromaticAdaptationTag); type.has_value()) {
  710. if (type.value()->type() != S15Fixed16ArrayTagData::Type)
  711. return Error::from_string_literal("ICC::Profile: chromaticAdaptationTag has unexpected type");
  712. if (static_cast<S15Fixed16ArrayTagData const&>(*type.value()).values().size() != 9)
  713. return Error::from_string_literal("ICC::Profile: chromaticAdaptationTag has unexpected size");
  714. }
  715. // ICC v4, 9.2.16 chromaticityTag
  716. // "Permitted tag types: chromaticityType"
  717. if (!has_type(chromaticityTag, { ChromaticityTagData::Type }, {}))
  718. return Error::from_string_literal("ICC::Profile: ChromaticityTagData has unexpected type");
  719. // ICC v4, 9.2.17 cicpTag
  720. // "Permitted tag types: cicpType"
  721. if (auto type = m_tag_table.get(cicpTag); type.has_value()) {
  722. if (type.value()->type() != CicpTagData::Type)
  723. return Error::from_string_literal("ICC::Profile: cicpTag has unexpected type");
  724. // "The colour encoding specified by the CICP tag content shall be equivalent to the data colour space encoding
  725. // represented by this ICC profile.
  726. // NOTE The ICC colour transform cannot match every possible rendering of a CICP colour encoding."
  727. // FIXME: Figure out what that means and check for it.
  728. // "This tag may be present when the data colour space in the profile header is RGB, YCbCr, or XYZ, and the
  729. // profile class in the profile header is Input or Display. The tag shall not be present for other data colour spaces
  730. // or profile classes indicated in the profile header."
  731. bool is_color_space_allowed = data_color_space() == ColorSpace::RGB || data_color_space() == ColorSpace::YCbCr || data_color_space() == ColorSpace::nCIEXYZ;
  732. bool is_profile_class_allowed = device_class() == DeviceClass::InputDevice || device_class() == DeviceClass::DisplayDevice;
  733. bool cicp_is_allowed = is_color_space_allowed && is_profile_class_allowed;
  734. if (!cicp_is_allowed)
  735. return Error::from_string_literal("ICC::Profile: cicpTag present but not allowed");
  736. }
  737. // ICC v4, 9.2.18 colorantOrderTag
  738. // "Permitted tag types: colorantOrderType"
  739. // FIXME
  740. // ICC v4, 9.2.19 colorantTableTag
  741. // "Permitted tag types: colorantTableType"
  742. // FIXME
  743. // ICC v4, 9.2.20 colorantTableOutTag
  744. // "Permitted tag types: colorantTableType"
  745. // FIXME
  746. // ICC v4, 9.2.21 colorimetricIntentImageStateTag
  747. // "Permitted tag types: signatureType"
  748. if (!has_type(colorimetricIntentImageStateTag, { SignatureTagData::Type }, {}))
  749. return Error::from_string_literal("ICC::Profile: colorimetricIntentImageStateTag has unexpected type");
  750. // ICC v4, 9.2.22 copyrightTag
  751. // "Permitted tag types: multiLocalizedUnicodeType"
  752. // ICC v2, 6.4.13 copyrightTag
  753. // "Tag Type: textType"
  754. if (auto type = m_tag_table.get(copyrightTag); type.has_value()) {
  755. // The v4 spec requires multiLocalizedUnicodeType for this, but I'm aware of a single file
  756. // that still uses the v2 'text' type here: /System/Library/ColorSync/Profiles/ITU-2020.icc on macOS 13.1.
  757. // https://openradar.appspot.com/radar?id=5529765549178880
  758. bool has_v2_cprt_type_in_v4_file_quirk = id() == apple_itu_2020_id || id() == apple_p3_2015_id;
  759. if (is_v4() && type.value()->type() != MultiLocalizedUnicodeTagData::Type && (!has_v2_cprt_type_in_v4_file_quirk || type.value()->type() != TextTagData::Type))
  760. return Error::from_string_literal("ICC::Profile: copyrightTag has unexpected v4 type");
  761. if (is_v2() && type.value()->type() != TextTagData::Type)
  762. return Error::from_string_literal("ICC::Profile: copyrightTag has unexpected v2 type");
  763. }
  764. // ICC v4, 9.2.23 deviceMfgDescTag
  765. // "Permitted tag types: multiLocalizedUnicodeType"
  766. // ICC v2, 6.4.15 deviceMfgDescTag
  767. // "Tag Type: textDescriptionType"
  768. if (auto type = m_tag_table.get(deviceMfgDescTag); type.has_value()) {
  769. if (is_v4() && type.value()->type() != MultiLocalizedUnicodeTagData::Type)
  770. return Error::from_string_literal("ICC::Profile: deviceMfgDescTag has unexpected v4 type");
  771. if (is_v2() && type.value()->type() != TextDescriptionTagData::Type)
  772. return Error::from_string_literal("ICC::Profile: deviceMfgDescTag has unexpected v2 type");
  773. }
  774. // ICC v4, 9.2.24 deviceModelDescTag
  775. // "Permitted tag types: multiLocalizedUnicodeType"
  776. // ICC v2, 6.4.16 deviceModelDescTag
  777. // "Tag Type: textDescriptionType"
  778. if (auto type = m_tag_table.get(deviceModelDescTag); type.has_value()) {
  779. if (is_v4() && type.value()->type() != MultiLocalizedUnicodeTagData::Type)
  780. return Error::from_string_literal("ICC::Profile: deviceModelDescTag has unexpected v4 type");
  781. if (is_v2() && type.value()->type() != TextDescriptionTagData::Type)
  782. return Error::from_string_literal("ICC::Profile: deviceModelDescTag has unexpected v2 type");
  783. }
  784. // ICC v4, 9.2.25 DToB0Tag
  785. // "Permitted tag types: multiProcessElementsType"
  786. // FIXME
  787. // ICC v4, 9.2.26 DToB1Tag
  788. // "Permitted tag types: multiProcessElementsType"
  789. // FIXME
  790. // ICC v4, 9.2.27 DToB2Tag
  791. // "Permitted tag types: multiProcessElementsType"
  792. // FIXME
  793. // ICC v4, 9.2.28 DToB3Tag
  794. // "Permitted tag types: multiProcessElementsType"
  795. // FIXME
  796. // ICC v4, 9.2.29 gamutTag
  797. // "Permitted tag types: lut8Type or lut16Type or lutBToAType"
  798. // ICC v2, 6.4.18 gamutTag
  799. // "Tag Type: lut8Type or lut16Type"
  800. if (!has_type(gamutTag, { Lut8TagData::Type, Lut16TagData::Type }, { LutBToATagData::Type }))
  801. return Error::from_string_literal("ICC::Profile: gamutTag has unexpected type");
  802. // ICC v4, 9.2.30 grayTRCTag
  803. // "Permitted tag types: curveType or parametricCurveType"
  804. // ICC v2, 6.4.19 grayTRCTag
  805. // "Tag Type: curveType"
  806. if (!has_type(grayTRCTag, { CurveTagData::Type }, { ParametricCurveTagData::Type }))
  807. return Error::from_string_literal("ICC::Profile: grayTRCTag has unexpected type");
  808. // ICC v4, 9.2.31 greenMatrixColumnTag
  809. // "Permitted tag types: XYZType
  810. // This tag contains the second column in the matrix, which is used in matrix/TRC transforms."
  811. // (Called greenColorantTag in the v2 spec, otherwise identical there.)
  812. if (auto type = m_tag_table.get(greenMatrixColumnTag); type.has_value()) {
  813. if (type.value()->type() != XYZTagData::Type)
  814. return Error::from_string_literal("ICC::Profile: greenMatrixColumnTag has unexpected type");
  815. if (static_cast<XYZTagData const&>(*type.value()).xyzs().size() != 1)
  816. return Error::from_string_literal("ICC::Profile: greenMatrixColumnTag has unexpected size");
  817. }
  818. // ICC v4, 9.2.32 greenTRCTag
  819. // "Permitted tag types: curveType or parametricCurveType"
  820. // ICC v2, 6.4.21 greenTRCTag
  821. // "Tag Type: curveType"
  822. if (!has_type(greenTRCTag, { CurveTagData::Type }, { ParametricCurveTagData::Type }))
  823. return Error::from_string_literal("ICC::Profile: greenTRCTag has unexpected type");
  824. // ICC v4, 9.2.33 luminanceTag
  825. // "Permitted tag types: XYZType"
  826. // This tag contains the absolute luminance of emissive devices in candelas per square metre as described by the
  827. // Y channel.
  828. // NOTE The X and Z values are set to zero."
  829. // ICC v2, 6.4.22 luminanceTag
  830. // "Absolute luminance of emissive devices in candelas per square meter as described by the Y channel. The
  831. // X and Z channels are ignored in all cases."
  832. if (auto type = m_tag_table.get(luminanceTag); type.has_value()) {
  833. if (type.value()->type() != XYZTagData::Type)
  834. return Error::from_string_literal("ICC::Profile: luminanceTag has unexpected type");
  835. auto& xyz_type = static_cast<XYZTagData const&>(*type.value());
  836. if (xyz_type.xyzs().size() != 1)
  837. return Error::from_string_literal("ICC::Profile: luminanceTag has unexpected size");
  838. if (is_v4() && xyz_type.xyzs()[0].X != 0)
  839. return Error::from_string_literal("ICC::Profile: luminanceTag.x unexpectedly not 0");
  840. if (is_v4() && xyz_type.xyzs()[0].Z != 0)
  841. return Error::from_string_literal("ICC::Profile: luminanceTag.z unexpectedly not 0");
  842. }
  843. // ICC v4, 9.2.34 measurementTag
  844. // "Permitted tag types: measurementType"
  845. if (!has_type(measurementTag, { MeasurementTagData::Type }, {}))
  846. return Error::from_string_literal("ICC::Profile: measurementTag has unexpected type");
  847. // ICC v4, 9.2.35 metadataTag
  848. // "Permitted tag types: dictType"
  849. // FIXME
  850. // ICC v4, 9.2.36 mediaWhitePointTag
  851. // "Permitted tag types: XYZType
  852. // This tag, which is used for generating the ICC-absolute colorimetric intent, specifies the chromatically adapted
  853. // nCIEXYZ tristimulus values of the media white point. When the measurement data used to create the profile
  854. // were specified relative to an adopted white with a chromaticity different from that of the PCS adopted white, the
  855. // media white point nCIEXYZ values shall be adapted to be relative to the PCS adopted white chromaticity using
  856. // the chromaticAdaptationTag matrix, before recording in the tag. For capture devices, the media white point is
  857. // the encoding maximum white for the capture encoding. For displays, the values specified shall be those of the
  858. // PCS illuminant as defined in 7.2.16.
  859. // See Clause 6 and Annex A for a more complete description of the use of the media white point."
  860. // ICC v2, 6.4.25 mediaWhitePointTag
  861. // "This tag specifies the media white point and is used for generating ICC-absolute colorimetric intent. See
  862. // Annex A for a more complete description of its use."
  863. if (auto type = m_tag_table.get(mediaWhitePointTag); type.has_value()) {
  864. if (type.value()->type() != XYZTagData::Type)
  865. return Error::from_string_literal("ICC::Profile: mediaWhitePointTag has unexpected type");
  866. auto& xyz_type = static_cast<XYZTagData const&>(*type.value());
  867. if (xyz_type.xyzs().size() != 1)
  868. return Error::from_string_literal("ICC::Profile: mediaWhitePointTag has unexpected size");
  869. // V4 requires "For displays, the values specified shall be those of the PCS illuminant".
  870. // But in practice that's not always true. For example, on macOS 13.1, '/System/Library/ColorSync/Profiles/DCI(P3) RGB.icc'
  871. // has these values in the header: 0000F6D6 00010000 0000D32D
  872. // but these values in the tag: 0000F6D5 00010000 0000D32C
  873. // These are close, but not equal.
  874. // FIXME: File bug for these, and add id-based quirk instead.
  875. // if (is_v4() && device_class() == DeviceClass::DisplayDevice && xyz_type.xyzs()[0] != pcs_illuminant())
  876. // return Error::from_string_literal("ICC::Profile: mediaWhitePointTag for displays should be equal to PCS illuminant");
  877. }
  878. // ICC v4, 9.2.37 namedColor2Tag
  879. // "Permitted tag types: namedColor2Type"
  880. if (auto type = m_tag_table.get(namedColor2Tag); type.has_value()) {
  881. if (type.value()->type() != NamedColor2TagData::Type)
  882. return Error::from_string_literal("ICC::Profile: namedColor2Tag has unexpected type");
  883. // ICC v4, 10.17 namedColor2Type
  884. // "The device representation corresponds to the header’s “data colour space” field.
  885. // This representation should be consistent with the “number of device coordinates” field in the namedColor2Type.
  886. // If this field is 0, device coordinates are not provided."
  887. if (auto number_of_device_coordinates = static_cast<NamedColor2TagData const&>(*type.value()).number_of_device_coordinates();
  888. number_of_device_coordinates != 0 && number_of_device_coordinates != number_of_components_in_color_space(data_color_space())) {
  889. return Error::from_string_literal("ICC::Profile: namedColor2Tag number of device coordinates inconsistent with data color space");
  890. }
  891. }
  892. // ICC v4, 9.2.38 outputResponseTag
  893. // "Permitted tag types: responseCurveSet16Type"
  894. // FIXME
  895. // ICC v4, 9.2.39 perceptualRenderingIntentGamutTag
  896. // "Permitted tag types: signatureType"
  897. if (!has_type(perceptualRenderingIntentGamutTag, { SignatureTagData::Type }, {}))
  898. return Error::from_string_literal("ICC::Profile: perceptualRenderingIntentGamutTag has unexpected type");
  899. // ICC v4, 9.2.40 preview0Tag
  900. // "Permitted tag types: lut8Type or lut16Type or lutAToBType or lutBToAType"
  901. // ICC v2, 6.4.29 preview0Tag
  902. // "Tag Type: lut8Type or lut16Type"
  903. if (!has_type(preview0Tag, { Lut8TagData::Type, Lut16TagData::Type }, { LutBToATagData::Type, LutBToATagData::Type }))
  904. return Error::from_string_literal("ICC::Profile: preview0Tag has unexpected type");
  905. // ICC v4, 9.2.41 preview1Tag
  906. // "Permitted tag types: lut8Type or lut16Type or lutBToAType"
  907. // ICC v2, 6.4.30 preview1Tag
  908. // "Tag Type: lut8Type or lut16Type"
  909. if (!has_type(preview1Tag, { Lut8TagData::Type, Lut16TagData::Type }, { LutBToATagData::Type }))
  910. return Error::from_string_literal("ICC::Profile: preview1Tag has unexpected type");
  911. // ICC v4, 9.2.42 preview2Tag
  912. // "Permitted tag types: lut8Type or lut16Type or lutBToAType"
  913. // ICC v2, 6.4.31 preview2Tag
  914. // "Tag Type: lut8Type or lut16Type"
  915. if (!has_type(preview2Tag, { Lut8TagData::Type, Lut16TagData::Type }, { LutBToATagData::Type }))
  916. return Error::from_string_literal("ICC::Profile: preview2Tag has unexpected type");
  917. // ICC v4, 9.2.43 profileDescriptionTag
  918. // "Permitted tag types: multiLocalizedUnicodeType"
  919. // ICC v2, 6.4.32 profileDescriptionTag
  920. // "Tag Type: textDescriptionType"
  921. if (auto type = m_tag_table.get(profileDescriptionTag); type.has_value()) {
  922. // The v4 spec requires multiLocalizedUnicodeType for this, but I'm aware of a single file
  923. // that still uses the v2 'desc' type here: /System/Library/ColorSync/Profiles/ITU-2020.icc on macOS 13.1.
  924. // https://openradar.appspot.com/radar?id=5529765549178880
  925. bool has_v2_desc_type_in_v4_file_quirk = id() == apple_itu_2020_id || id() == apple_p3_2015_id;
  926. if (is_v4() && type.value()->type() != MultiLocalizedUnicodeTagData::Type && (!has_v2_desc_type_in_v4_file_quirk || type.value()->type() != TextDescriptionTagData::Type))
  927. return Error::from_string_literal("ICC::Profile: profileDescriptionTag has unexpected v4 type");
  928. if (is_v2() && type.value()->type() != TextDescriptionTagData::Type)
  929. return Error::from_string_literal("ICC::Profile: profileDescriptionTag has unexpected v2 type");
  930. }
  931. // ICC v4, 9.2.44 profileSequenceDescTag
  932. // "Permitted tag types: profileSequenceDescType"
  933. // FIXME
  934. // ICC v4, 9.2.45 profileSequenceIdentifierTag
  935. // "Permitted tag types: profileSequenceIdentifierType"
  936. // FIXME
  937. // ICC v4, 9.2.46 redMatrixColumnTag
  938. // "Permitted tag types: XYZType
  939. // This tag contains the first column in the matrix, which is used in matrix/TRC transforms."
  940. // (Called redColorantTag in the v2 spec, otherwise identical there.)
  941. if (auto type = m_tag_table.get(redMatrixColumnTag); type.has_value()) {
  942. if (type.value()->type() != XYZTagData::Type)
  943. return Error::from_string_literal("ICC::Profile: redMatrixColumnTag has unexpected type");
  944. if (static_cast<XYZTagData const&>(*type.value()).xyzs().size() != 1)
  945. return Error::from_string_literal("ICC::Profile: redMatrixColumnTag has unexpected size");
  946. }
  947. // ICC v4, 9.2.47 redTRCTag
  948. // "Permitted tag types: curveType or parametricCurveType"
  949. // ICC v2, 6.4.41 redTRCTag
  950. // "Tag Type: curveType"
  951. if (!has_type(redTRCTag, { CurveTagData::Type }, { ParametricCurveTagData::Type }))
  952. return Error::from_string_literal("ICC::Profile: redTRCTag has unexpected type");
  953. // ICC v4, 9.2.48 saturationRenderingIntentGamutTag
  954. // "Permitted tag types: signatureType"
  955. if (!has_type(saturationRenderingIntentGamutTag, { SignatureTagData::Type }, {}))
  956. return Error::from_string_literal("ICC::Profile: saturationRenderingIntentGamutTag has unexpected type");
  957. // ICC v4, 9.2.49 technologyTag
  958. // "Permitted tag types: signatureType"
  959. if (!has_type(technologyTag, { SignatureTagData::Type }, {}))
  960. return Error::from_string_literal("ICC::Profile: technologyTag has unexpected type");
  961. // ICC v4, 9.2.50 viewingCondDescTag
  962. // "Permitted tag types: multiLocalizedUnicodeType"
  963. // ICC v2, 6.4.46 viewingCondDescTag
  964. // "Tag Type: textDescriptionType"
  965. if (auto type = m_tag_table.get(viewingCondDescTag); type.has_value()) {
  966. if (is_v4() && type.value()->type() != MultiLocalizedUnicodeTagData::Type)
  967. return Error::from_string_literal("ICC::Profile: viewingCondDescTag has unexpected v4 type");
  968. if (is_v2() && type.value()->type() != TextDescriptionTagData::Type)
  969. return Error::from_string_literal("ICC::Profile: viewingCondDescTag has unexpected v2 type");
  970. }
  971. // ICC v4, 9.2.51 viewingConditionsTag
  972. // "Permitted tag types: viewingConditionsType"
  973. if (!has_type(viewingConditionsTag, { ViewingConditionsTagData::Type }, {}))
  974. return Error::from_string_literal("ICC::Profile: viewingConditionsTag has unexpected type");
  975. // FIXME: Add validation for v2-only tags:
  976. // - ICC v2, 6.4.14 crdInfoTag
  977. // "Tag Type: crdInfoType"
  978. // - ICC v2, 6.4.17 deviceSettingsTag
  979. // "Tag Type: deviceSettingsType"
  980. // - ICC v2, 6.4.24 mediaBlackPointTag
  981. // "Tag Type: XYZType"
  982. // - ICC v2, 6.4.26 namedColorTag
  983. // "Tag Type: namedColorType"
  984. // - ICC v2, 6.4.34 ps2CRD0Tag
  985. // "Tag Type: dataType"
  986. // - ICC v2, 6.4.35 ps2CRD1Tag
  987. // "Tag Type: dataType"
  988. // - ICC v2, 6.4.36 ps2CRD2Tag
  989. // "Tag Type: dataType"
  990. // - ICC v2, 6.4.37 ps2CRD3Tag
  991. // "Tag Type: dataType"
  992. // - ICC v2, 6.4.38 ps2CSATag
  993. // "Tag Type: dataType"
  994. // - ICC v2, 6.4.39 ps2RenderingIntentTag
  995. // "Tag Type: dataType"
  996. // - ICC v2, 6.4.42 screeningDescTag
  997. // "Tag Type: textDescriptionType"
  998. // - ICC v2, 6.4.43 screeningTag
  999. // "Tag Type: screeningType"
  1000. // - ICC v2, 6.4.45 ucrbgTag
  1001. // "Tag Type: ucrbgType"
  1002. // https://www.color.org/v2profiles.xalter says about these tags:
  1003. // "it is also recommended that optional tags in the v2 specification that have subsequently become
  1004. // obsolete are not included in future profiles made to the v2 specification."
  1005. return {};
  1006. }
  1007. ErrorOr<NonnullRefPtr<Profile>> Profile::try_load_from_externally_owned_memory(ReadonlyBytes bytes)
  1008. {
  1009. auto header = TRY(read_header(bytes));
  1010. bytes = bytes.trim(header.on_disk_size);
  1011. auto tag_table = TRY(read_tag_table(bytes));
  1012. return create(header, move(tag_table));
  1013. }
  1014. ErrorOr<NonnullRefPtr<Profile>> Profile::create(ProfileHeader const& header, OrderedHashMap<TagSignature, NonnullRefPtr<TagData>> tag_table)
  1015. {
  1016. auto profile = TRY(adopt_nonnull_ref_or_enomem(new (nothrow) Profile(header, move(tag_table))));
  1017. TRY(profile->check_required_tags());
  1018. TRY(profile->check_tag_types());
  1019. return profile;
  1020. }
  1021. Crypto::Hash::MD5::DigestType Profile::compute_id(ReadonlyBytes bytes)
  1022. {
  1023. // ICC v4, 7.2.18 Profile ID field
  1024. // "The Profile ID shall be calculated using the MD5 fingerprinting method as defined in Internet RFC 1321.
  1025. // The entire profile, whose length is given by the size field in the header, with the
  1026. // profile flags field (bytes 44 to 47, see 7.2.11),
  1027. // rendering intent field (bytes 64 to 67, see 7.2.15),
  1028. // and profile ID field (bytes 84 to 99)
  1029. // in the profile header temporarily set to zeros (00h),
  1030. // shall be used to calculate the ID."
  1031. const u8 zero[16] = {};
  1032. Crypto::Hash::MD5 md5;
  1033. md5.update(bytes.slice(0, 44));
  1034. md5.update(ReadonlyBytes { zero, 4 }); // profile flags field
  1035. md5.update(bytes.slice(48, 64 - 48));
  1036. md5.update(ReadonlyBytes { zero, 4 }); // rendering intent field
  1037. md5.update(bytes.slice(68, 84 - 68));
  1038. md5.update(ReadonlyBytes { zero, 16 }); // profile ID field
  1039. md5.update(bytes.slice(100));
  1040. return md5.digest();
  1041. }
  1042. static TagSignature forward_transform_tag_for_rendering_intent(RenderingIntent rendering_intent)
  1043. {
  1044. // ICCv4, Table 25 — Profile type/profile tag and defined rendering intents
  1045. // This function assumes a profile class of InputDevice, DisplayDevice, OutputDevice, or ColorSpace.
  1046. switch (rendering_intent) {
  1047. case RenderingIntent::Perceptual:
  1048. return AToB0Tag;
  1049. case RenderingIntent::MediaRelativeColorimetric:
  1050. case RenderingIntent::ICCAbsoluteColorimetric:
  1051. return AToB1Tag;
  1052. case RenderingIntent::Saturation:
  1053. return AToB2Tag;
  1054. }
  1055. VERIFY_NOT_REACHED();
  1056. }
  1057. ErrorOr<FloatVector3> Profile::to_pcs_a_to_b(TagData const& tag_data, ReadonlyBytes color) const
  1058. {
  1059. // Assumes a "normal" device_class() (i.e. not DeviceLink).
  1060. VERIFY(number_of_components_in_color_space(connection_space()) == 3);
  1061. switch (tag_data.type()) {
  1062. case Lut16TagData::Type: {
  1063. auto const& a_to_b = static_cast<Lut16TagData const&>(tag_data);
  1064. return a_to_b.evaluate(data_color_space(), connection_space(), color);
  1065. }
  1066. case Lut8TagData::Type: {
  1067. auto const& a_to_b = static_cast<Lut8TagData const&>(tag_data);
  1068. return a_to_b.evaluate(data_color_space(), connection_space(), color);
  1069. }
  1070. case LutAToBTagData::Type: {
  1071. auto const& a_to_b = static_cast<LutAToBTagData const&>(tag_data);
  1072. if (a_to_b.number_of_input_channels() != number_of_components_in_color_space(data_color_space()))
  1073. return Error::from_string_literal("ICC::Profile::to_pcs_a_to_b: mAB input channel count does not match color space size");
  1074. if (a_to_b.number_of_output_channels() != number_of_components_in_color_space(connection_space()))
  1075. return Error::from_string_literal("ICC::Profile::to_pcs_a_to_b: mAB output channel count does not match profile connection space size");
  1076. return a_to_b.evaluate(connection_space(), color);
  1077. }
  1078. }
  1079. VERIFY_NOT_REACHED();
  1080. }
  1081. ErrorOr<FloatVector3> Profile::to_pcs(ReadonlyBytes color) const
  1082. {
  1083. if (color.size() != number_of_components_in_color_space(data_color_space()))
  1084. return Error::from_string_literal("ICC::Profile: input color doesn't match color space size");
  1085. auto get_tag = [&](auto tag) { return m_tag_table.get(tag); };
  1086. auto has_tag = [&](auto tag) { return m_tag_table.contains(tag); };
  1087. auto has_all_tags = [&]<class T>(T tags) { return all_of(tags, has_tag); };
  1088. switch (device_class()) {
  1089. case DeviceClass::InputDevice:
  1090. case DeviceClass::DisplayDevice:
  1091. case DeviceClass::OutputDevice:
  1092. case DeviceClass::ColorSpace: {
  1093. // ICC v4, 8.10 Precedence order of tag usage
  1094. // "There are several methods of colour transformation that can function within a single CMM. If data for more than
  1095. // one method are included in the same profile, the following selection algorithm shall be used by the software
  1096. // implementation."
  1097. // ICC v4, 8.10.2 Input, display, output, or colour space profile types
  1098. // "a) Use the BToD0Tag, BToD1Tag, BToD2Tag, BToD3Tag, DToB0Tag, DToB1Tag, DToB2Tag, or
  1099. // DToB3Tag designated for the rendering intent if the tag is present, except where this tag is not needed or
  1100. // supported by the CMM (if a particular processing element within the tag is not supported the tag is not
  1101. // supported)."
  1102. // FIXME: Implement multiProcessElementsType one day.
  1103. // "b) Use the BToA0Tag, BToA1Tag, BToA2Tag, AToB0Tag, AToB1Tag, or AToB2Tag designated for the
  1104. // rendering intent if present, when the tag in a) is not used."
  1105. if (auto tag = get_tag(forward_transform_tag_for_rendering_intent(rendering_intent())); tag.has_value())
  1106. return to_pcs_a_to_b(*tag.value(), color);
  1107. // "c) Use the BToA0Tag or AToB0Tag if present, when the tags in a) and b) are not used."
  1108. // AToB0Tag is for the conversion _to_ PCS (BToA0Tag is for conversion _from_ PCS, so not needed in this function).
  1109. if (auto tag = get_tag(AToB0Tag); tag.has_value())
  1110. return to_pcs_a_to_b(*tag.value(), color);
  1111. // "d) Use TRCs (redTRCTag, greenTRCTag, blueTRCTag, or grayTRCTag) and colorants
  1112. // (redMatrixColumnTag, greenMatrixColumnTag, blueMatrixColumnTag) when tags in a), b), and c) are not
  1113. // used."
  1114. auto evaluate_curve = [this](TagSignature curve_tag, float f) {
  1115. auto const& trc = *m_tag_table.get(curve_tag).value();
  1116. VERIFY(trc.type() == CurveTagData::Type || trc.type() == ParametricCurveTagData::Type);
  1117. if (trc.type() == CurveTagData::Type)
  1118. return static_cast<CurveTagData const&>(trc).evaluate(f);
  1119. return static_cast<ParametricCurveTagData const&>(trc).evaluate(f);
  1120. };
  1121. if (data_color_space() == ColorSpace::Gray) {
  1122. VERIFY(color.size() == 1); // True because of color.size() check further up.
  1123. // ICC v4, F.2 grayTRCTag
  1124. // "connection = grayTRC[device]"
  1125. float gray = evaluate_curve(grayTRCTag, color[0] / 255.f);
  1126. FloatVector3 white { pcs_illuminant().X, pcs_illuminant().Y, pcs_illuminant().Z };
  1127. return white * gray;
  1128. }
  1129. // FIXME: Per ICC v4, A.1 General, this should also handle HLS, HSV, YCbCr.
  1130. if (data_color_space() == ColorSpace::RGB) {
  1131. if (!has_all_tags(Array { redMatrixColumnTag, greenMatrixColumnTag, blueMatrixColumnTag, redTRCTag, greenTRCTag, blueTRCTag }))
  1132. return Error::from_string_literal("ICC::Profile::to_pcs: RGB color space but neither LUT-based nor matrix-based tags present");
  1133. VERIFY(color.size() == 3); // True because of color.size() check further up.
  1134. // ICC v4, F.3 Three-component matrix-based profiles
  1135. // "linear_r = redTRC[device_r]
  1136. // linear_g = greenTRC[device_g]
  1137. // linear_b = blueTRC[device_b]
  1138. // [connection_X] = [redMatrixColumn_X greenMatrixColumn_X blueMatrixColumn_X] [ linear_r ]
  1139. // [connection_Y] = [redMatrixColumn_Y greenMatrixColumn_Y blueMatrixColumn_Y] * [ linear_g ]
  1140. // [connection_Z] = [redMatrixColumn_Z greenMatrixColumn_Z blueMatrixColumn_Z] [ linear_b ]"
  1141. FloatVector3 linear_rgb {
  1142. evaluate_curve(redTRCTag, color[0] / 255.f),
  1143. evaluate_curve(greenTRCTag, color[1] / 255.f),
  1144. evaluate_curve(blueTRCTag, color[2] / 255.f),
  1145. };
  1146. return rgb_to_xyz_matrix() * linear_rgb;
  1147. }
  1148. return Error::from_string_literal("ICC::Profile::to_pcs: What happened?!");
  1149. }
  1150. case DeviceClass::DeviceLink:
  1151. case DeviceClass::Abstract:
  1152. // ICC v4, 8.10.3 DeviceLink or Abstract profile types
  1153. // FIXME
  1154. return Error::from_string_literal("ICC::Profile::to_pcs: conversion for DeviceLink and Abstract not implemented");
  1155. case DeviceClass::NamedColor:
  1156. return Error::from_string_literal("ICC::Profile::to_pcs: to_pcs with NamedColor profile does not make sense");
  1157. }
  1158. VERIFY_NOT_REACHED();
  1159. }
  1160. static FloatVector3 lab_from_xyz(FloatVector3 xyz, XYZ white_point)
  1161. {
  1162. // 6.3.2.2 Translation between media-relative colorimetric data and ICC-absolute colorimetric data
  1163. // 6.3.2.3 Computation of PCSLAB
  1164. // 6.3.4 Colour space encodings for the PCS
  1165. // A.3 PCS encodings
  1166. auto f = [](float x) {
  1167. if (x > powf(6.f / 29.f, 3))
  1168. return cbrtf(x);
  1169. return x / (3 * powf(6.f / 29.f, 2)) + 4.f / 29.f;
  1170. };
  1171. // "X/Xn is replaced by Xr/Xi (or Xa/Xmw)"
  1172. // 6.3.2.2 Translation between media-relative colorimetric data and ICC-absolute colorimetric data
  1173. // "The translation from ICC-absolute colorimetric data to media-relative colorimetry data is given by Equations
  1174. // Xr = (Xi/Xmw) * Xa
  1175. // where
  1176. // Xr media-relative colorimetric data (i.e. PCSXYZ);
  1177. // Xa ICC-absolute colorimetric data (i.e. nCIEXYZ);
  1178. // Xmw nCIEXYZ values of the media white point as specified in the mediaWhitePointTag;
  1179. // Xi PCSXYZ values of the PCS white point defined in 6.3.4.3."
  1180. // 6.3.4.3 PCS encodings for white and black
  1181. // "Table 14 — Encodings of PCS white point: X 0,9642 Y 1,0000 Z 0,8249"
  1182. // That's identical to the values in 7.2.16 PCS illuminant field (Bytes 68 to 79).
  1183. // 9.2.36 mediaWhitePointTag
  1184. // "For displays, the values specified shall be those of the PCS illuminant as defined in 7.2.16."
  1185. // ...so for displays, this is all equivalent I think? It's maybe different for OutputDevice profiles?
  1186. float Xn = white_point.X;
  1187. float Yn = white_point.Y;
  1188. float Zn = white_point.Z;
  1189. float x = xyz[0] / Xn;
  1190. float y = xyz[1] / Yn;
  1191. float z = xyz[2] / Zn;
  1192. float L = 116 * f(y) - 16;
  1193. float a = 500 * (f(x) - f(y));
  1194. float b = 200 * (f(y) - f(z));
  1195. return { L, a, b };
  1196. }
  1197. static FloatVector3 xyz_from_lab(FloatVector3 lab, XYZ white_point)
  1198. {
  1199. // Inverse of lab_from_xyz().
  1200. auto L_star = lab[0];
  1201. auto a_star = lab[1];
  1202. auto b_star = lab[2];
  1203. auto L = (L_star + 16) / 116 + a_star / 500; // f(x)
  1204. auto M = (L_star + 16) / 116; // f(y)
  1205. auto N = (L_star + 16) / 116 - b_star / 200; // f(z)
  1206. // Inverse of f in lab_from_xyz().
  1207. auto g = [](float x) {
  1208. if (x >= 6.0f / 29.0f)
  1209. return powf(x, 3);
  1210. return (x - 4.0f / 29.0f) * (3 * powf(6.f / 29.f, 2));
  1211. };
  1212. return { white_point.X * g(L), white_point.Y * g(M), white_point.Z * g(N) };
  1213. }
  1214. static TagSignature backward_transform_tag_for_rendering_intent(RenderingIntent rendering_intent)
  1215. {
  1216. // ICCv4, Table 25 — Profile type/profile tag and defined rendering intents
  1217. // This function assumes a profile class of InputDevice, DisplayDevice, OutputDevice, or ColorSpace.
  1218. switch (rendering_intent) {
  1219. case RenderingIntent::Perceptual:
  1220. return BToA0Tag;
  1221. case RenderingIntent::MediaRelativeColorimetric:
  1222. case RenderingIntent::ICCAbsoluteColorimetric:
  1223. return BToA1Tag;
  1224. case RenderingIntent::Saturation:
  1225. return BToA2Tag;
  1226. }
  1227. VERIFY_NOT_REACHED();
  1228. }
  1229. ErrorOr<void> Profile::from_pcs_b_to_a(TagData const& tag_data, FloatVector3 const& pcs, Bytes out_bytes) const
  1230. {
  1231. switch (tag_data.type()) {
  1232. case Lut16TagData::Type:
  1233. // FIXME
  1234. return Error::from_string_literal("ICC::Profile::to_pcs: BToA*Tag handling for mft2 tags not yet implemented");
  1235. case Lut8TagData::Type:
  1236. // FIXME
  1237. return Error::from_string_literal("ICC::Profile::to_pcs: BToA*Tag handling for mft1 tags not yet implemented");
  1238. case LutBToATagData::Type: {
  1239. auto const& b_to_a = static_cast<LutBToATagData const&>(tag_data);
  1240. if (b_to_a.number_of_input_channels() != number_of_components_in_color_space(connection_space()))
  1241. return Error::from_string_literal("ICC::Profile::from_pcs_b_to_a: mBA input channel count does not match color space size");
  1242. if (b_to_a.number_of_output_channels() != number_of_components_in_color_space(data_color_space()))
  1243. return Error::from_string_literal("ICC::Profile::from_pcs_b_to_a: mBA output channel count does not match profile connection space size");
  1244. return b_to_a.evaluate(connection_space(), pcs, out_bytes);
  1245. }
  1246. }
  1247. VERIFY_NOT_REACHED();
  1248. }
  1249. ErrorOr<void> Profile::from_pcs(Profile const& source_profile, FloatVector3 pcs, Bytes color) const
  1250. {
  1251. if (source_profile.connection_space() != connection_space()) {
  1252. if (source_profile.connection_space() == ColorSpace::PCSLAB) {
  1253. VERIFY(connection_space() == ColorSpace::PCSXYZ);
  1254. pcs = xyz_from_lab(pcs, source_profile.pcs_illuminant());
  1255. } else {
  1256. VERIFY(source_profile.connection_space() == ColorSpace::PCSXYZ);
  1257. VERIFY(connection_space() == ColorSpace::PCSLAB);
  1258. pcs = lab_from_xyz(pcs, pcs_illuminant());
  1259. }
  1260. }
  1261. // See `to_pcs()` for spec links.
  1262. // This function is very similar, but uses BToAn instead of AToBn for LUT profiles,
  1263. // and an inverse transform for matrix profiles.
  1264. if (color.size() != number_of_components_in_color_space(data_color_space()))
  1265. return Error::from_string_literal("ICC::Profile: output color doesn't match color space size");
  1266. auto get_tag = [&](auto tag) { return m_tag_table.get(tag); };
  1267. auto has_tag = [&](auto tag) { return m_tag_table.contains(tag); };
  1268. auto has_all_tags = [&]<class T>(T tags) { return all_of(tags, has_tag); };
  1269. switch (device_class()) {
  1270. case DeviceClass::InputDevice:
  1271. case DeviceClass::DisplayDevice:
  1272. case DeviceClass::OutputDevice:
  1273. case DeviceClass::ColorSpace: {
  1274. // FIXME: Implement multiProcessElementsType one day.
  1275. if (auto tag = get_tag(backward_transform_tag_for_rendering_intent(rendering_intent())); tag.has_value())
  1276. return from_pcs_b_to_a(*tag.value(), pcs, color);
  1277. if (auto tag = get_tag(BToA0Tag); tag.has_value())
  1278. return from_pcs_b_to_a(*tag.value(), pcs, color);
  1279. if (data_color_space() == ColorSpace::Gray) {
  1280. // FIXME
  1281. return Error::from_string_literal("ICC::Profile::from_pcs: Gray handling not yet implemented");
  1282. }
  1283. // FIXME: Per ICC v4, A.1 General, this should also handle HLS, HSV, YCbCr.
  1284. if (data_color_space() == ColorSpace::RGB) {
  1285. if (!has_all_tags(Array { redMatrixColumnTag, greenMatrixColumnTag, blueMatrixColumnTag, redTRCTag, greenTRCTag, blueTRCTag }))
  1286. return Error::from_string_literal("ICC::Profile::from_pcs: RGB color space but neither LUT-based nor matrix-based tags present");
  1287. VERIFY(color.size() == 3); // True because of color.size() check further up.
  1288. // ICC v4, F.3 Three-component matrix-based profiles
  1289. // "The inverse model is given by the following equations:
  1290. // [linear_r] = [redMatrixColumn_X greenMatrixColumn_X blueMatrixColumn_X]^-1 [ connection_X ]
  1291. // [linear_g] = [redMatrixColumn_Y greenMatrixColumn_Y blueMatrixColumn_Y] * [ connection_Y ]
  1292. // [linear_b] = [redMatrixColumn_Z greenMatrixColumn_Z blueMatrixColumn_Z] [ connection_Z ]
  1293. //
  1294. // for linear_r < 0, device_r = redTRC^-1[0] (F.8)
  1295. // for 0 ≤ linear_r ≤ 1, device_r = redTRC^-1[linear_r] (F.9)
  1296. // for linear_r > 1, device_r = redTRC^-1[1] (F.10)
  1297. //
  1298. // for linear_g < 0, device_g = greenTRC^-1[0] (F.11)
  1299. // for 0 ≤ linear_g ≤ 1, device_g = greenTRC^-1[linear_g] (F.12)
  1300. // for linear_g > 1, device_g = greenTRC^-1[1] (F.13)
  1301. //
  1302. // for linear_b < 0, device_b = blueTRC^-1[0] (F.14)
  1303. // for 0 ≤ linear_b ≤ 1, device_b = blueTRC^-1[linear_b] (F.15)
  1304. // for linear_b > 1, device_b = blueTRC^-1[1] (F.16)
  1305. //
  1306. // where redTRC^-1, greenTRC^-1, and blueTRC^-1 indicate the inverse functions of the redTRC greenTRC and
  1307. // blueTRC functions respectively.
  1308. // If the redTRC, greenTRC, or blueTRC function is not invertible the behaviour of the corresponding redTRC^-1,
  1309. // greenTRC^-1, and blueTRC^-1 function is undefined. If a one-dimensional curve is constant, the curve cannot be
  1310. // inverted."
  1311. // Convert from XYZ to linear rgb.
  1312. // FIXME: Inverting matrix and curve on every call to this function is very inefficient.
  1313. FloatVector3 linear_rgb = TRY(xyz_to_rgb_matrix()) * pcs;
  1314. auto evaluate_curve_inverse = [this](TagSignature curve_tag, float f) {
  1315. auto const& trc = *m_tag_table.get(curve_tag).value();
  1316. VERIFY(trc.type() == CurveTagData::Type || trc.type() == ParametricCurveTagData::Type);
  1317. if (trc.type() == CurveTagData::Type)
  1318. return static_cast<CurveTagData const&>(trc).evaluate_inverse(f);
  1319. return static_cast<ParametricCurveTagData const&>(trc).evaluate_inverse(f);
  1320. };
  1321. // Convert from linear rgb to device rgb.
  1322. // See equations (F.8) - (F.16) above.
  1323. // FIXME: The spec says to do this, but it loses information. Color.js returns unclamped
  1324. // values instead (...but how do those make it through the TRC?) and has a separate
  1325. // clipping step. Maybe that's better?
  1326. // Also, maybe doing actual gamut mapping would look better?
  1327. // (For LUT profiles, I think the gamut mapping is baked into the BToA* data in the profile (?).
  1328. // But for matrix profiles, it'd have to be done in code.)
  1329. linear_rgb.clamp(0.f, 1.f);
  1330. float device_r = evaluate_curve_inverse(redTRCTag, linear_rgb[0]);
  1331. float device_g = evaluate_curve_inverse(greenTRCTag, linear_rgb[1]);
  1332. float device_b = evaluate_curve_inverse(blueTRCTag, linear_rgb[2]);
  1333. color[0] = round(255 * device_r);
  1334. color[1] = round(255 * device_g);
  1335. color[2] = round(255 * device_b);
  1336. return {};
  1337. }
  1338. return Error::from_string_literal("ICC::Profile::from_pcs: What happened?!");
  1339. }
  1340. case DeviceClass::DeviceLink:
  1341. case DeviceClass::Abstract:
  1342. // ICC v4, 8.10.3 DeviceLink or Abstract profile types
  1343. // FIXME
  1344. return Error::from_string_literal("ICC::Profile::from_pcs: conversion for DeviceLink and Abstract not implemented");
  1345. case DeviceClass::NamedColor:
  1346. return Error::from_string_literal("ICC::Profile::from_pcs: from_pcs with NamedColor profile does not make sense");
  1347. }
  1348. VERIFY_NOT_REACHED();
  1349. }
  1350. ErrorOr<CIELAB> Profile::to_lab(ReadonlyBytes color) const
  1351. {
  1352. auto pcs = TRY(to_pcs(color));
  1353. if (connection_space() == ColorSpace::PCSLAB)
  1354. return CIELAB { pcs[0], pcs[1], pcs[2] };
  1355. if (connection_space() != ColorSpace::PCSXYZ) {
  1356. VERIFY(device_class() == DeviceClass::DeviceLink);
  1357. return Error::from_string_literal("ICC::Profile::to_lab: conversion for DeviceLink not implemented");
  1358. }
  1359. FloatVector3 lab = lab_from_xyz(pcs, pcs_illuminant());
  1360. return CIELAB { lab[0], lab[1], lab[2] };
  1361. }
  1362. ErrorOr<void> Profile::convert_image(Gfx::Bitmap& bitmap, Profile const& source_profile) const
  1363. {
  1364. for (auto& pixel : bitmap) {
  1365. u8 rgb[] = { Color::from_argb(pixel).red(), Color::from_argb(pixel).green(), Color::from_argb(pixel).blue() };
  1366. auto pcs = TRY(source_profile.to_pcs(rgb));
  1367. TRY(from_pcs(source_profile, pcs, rgb));
  1368. pixel = Color(rgb[0], rgb[1], rgb[2], Color::from_argb(pixel).alpha()).value();
  1369. }
  1370. return {};
  1371. }
  1372. XYZ const& Profile::red_matrix_column() const { return xyz_data(redMatrixColumnTag); }
  1373. XYZ const& Profile::green_matrix_column() const { return xyz_data(greenMatrixColumnTag); }
  1374. XYZ const& Profile::blue_matrix_column() const { return xyz_data(blueMatrixColumnTag); }
  1375. Optional<String> Profile::tag_string_data(TagSignature signature) const
  1376. {
  1377. auto maybe_tag_data = tag_data(signature);
  1378. if (!maybe_tag_data.has_value())
  1379. return {};
  1380. auto& tag_data = maybe_tag_data.release_value();
  1381. if (tag_data.type() == Gfx::ICC::MultiLocalizedUnicodeTagData::Type) {
  1382. auto& multi_localized_unicode = static_cast<Gfx::ICC::MultiLocalizedUnicodeTagData const&>(tag_data);
  1383. // Try to find 'en-US', otherwise any 'en' language, otherwise the first record.
  1384. Optional<String> en_string;
  1385. constexpr u16 language_en = ('e' << 8) + 'n';
  1386. constexpr u16 country_us = ('U' << 8) + 'S';
  1387. for (auto const& record : multi_localized_unicode.records()) {
  1388. if (record.iso_639_1_language_code == language_en) {
  1389. if (record.iso_3166_1_country_code == country_us)
  1390. return record.text;
  1391. en_string = record.text;
  1392. }
  1393. }
  1394. if (en_string.has_value())
  1395. return en_string.value();
  1396. if (!multi_localized_unicode.records().is_empty())
  1397. return multi_localized_unicode.records().first().text;
  1398. return {};
  1399. }
  1400. if (tag_data.type() == Gfx::ICC::TextDescriptionTagData::Type) {
  1401. auto& text_description = static_cast<Gfx::ICC::TextDescriptionTagData const&>(tag_data);
  1402. return text_description.ascii_description();
  1403. }
  1404. if (tag_data.type() == Gfx::ICC::TextTagData::Type) {
  1405. auto& text = static_cast<Gfx::ICC::TextTagData const&>(tag_data);
  1406. return text.text();
  1407. }
  1408. return {};
  1409. }
  1410. ErrorOr<FloatMatrix3x3> Profile::xyz_to_rgb_matrix() const
  1411. {
  1412. FloatMatrix3x3 forward_matrix = rgb_to_xyz_matrix();
  1413. if (!forward_matrix.is_invertible())
  1414. return Error::from_string_literal("ICC::Profile::from_pcs: matrix not invertible");
  1415. return forward_matrix.inverse();
  1416. }
  1417. FloatMatrix3x3 Profile::rgb_to_xyz_matrix() const
  1418. {
  1419. auto const& red_matrix_column = this->red_matrix_column();
  1420. auto const& green_matrix_column = this->green_matrix_column();
  1421. auto const& blue_matrix_column = this->blue_matrix_column();
  1422. return FloatMatrix3x3 {
  1423. red_matrix_column.X, green_matrix_column.X, blue_matrix_column.X,
  1424. red_matrix_column.Y, green_matrix_column.Y, blue_matrix_column.Y,
  1425. red_matrix_column.Z, green_matrix_column.Z, blue_matrix_column.Z
  1426. };
  1427. }
  1428. }