Krita Source Code Documentation
Loading...
Searching...
No Matches
LcmsEnginePlugin.cpp
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2003 Patrick Julien <freak@codepimps.org>
3 * SPDX-FileCopyrightText: 2004, 2010 Cyrille Berger <cberger@cberger.net>
4 * SPDX-FileCopyrightText: 2011 Srikanth Tiyyagura <srikanth.tulasiram@gmail.com>
5 *
6 * SPDX-License-Identifier: LGPL-2.1-or-later
7*/
8#include "LcmsEnginePlugin.h"
9
10#include <QApplication>
11#include <QDebug>
12#include <QDir>
13#include <QStringList>
14
15#include <klocalizedstring.h>
16#include <kpluginfactory.h>
17
18#include <KoBasicHistogramProducers.h>
19#include <KoColorSpace.h>
20#include <KoColorSpaceEngine.h>
21#include <KoColorSpaceRegistry.h>
22#include <KoResourcePaths.h>
23#include <kis_assert.h>
24#include <kis_debug.h>
25
26#include "IccColorSpaceEngine.h"
27#include <KoColorProfileQuery.h>
28#include "colorprofiles/LcmsColorProfileContainer.h"
29
30#include "colorspaces/cmyk_u8/CmykU8ColorSpace.h"
31#include "colorspaces/cmyk_u16/CmykU16ColorSpace.h"
32#include "colorspaces/cmyk_f32/CmykF32ColorSpace.h"
33
34#include "colorspaces/gray_u8/GrayU8ColorSpace.h"
35#include "colorspaces/gray_u16/GrayU16ColorSpace.h"
36#include "colorspaces/gray_f32/GrayF32ColorSpace.h"
37
38#include "colorspaces/lab_u8/LabU8ColorSpace.h"
39#include "colorspaces/lab_u16/LabColorSpace.h"
40#include "colorspaces/lab_f32/LabF32ColorSpace.h"
41
42#include "colorspaces/xyz_u8/XyzU8ColorSpace.h"
43#include "colorspaces/xyz_u16/XyzU16ColorSpace.h"
44#include "colorspaces/xyz_f32/XyzF32ColorSpace.h"
45
46#include "colorspaces/rgb_u8/RgbU8ColorSpace.h"
47#include "colorspaces/rgb_u16/RgbU16ColorSpace.h"
48#include "colorspaces/rgb_f32/RgbF32ColorSpace.h"
49
50#include "colorspaces/ycbcr_u8/YCbCrU8ColorSpace.h"
51#include "colorspaces/ycbcr_u16/YCbCrU16ColorSpace.h"
52#include "colorspaces/ycbcr_f32/YCbCrF32ColorSpace.h"
53
54#include <KoConfig.h>
55
56#ifdef HAVE_OPENEXR
57# include <half.h>
58# ifdef HAVE_LCMS24
59# include "colorspaces/gray_f16/GrayF16ColorSpace.h"
60# include "colorspaces/xyz_f16/XyzF16ColorSpace.h"
61# include "colorspaces/rgb_f16/RgbF16ColorSpace.h"
62# endif
63#endif
64
65#if defined(HAVE_LCMS_FAST_FLOAT_PLUGIN)
66#include <lcms2_fast_float.h>
67#endif
68
69void lcms2LogErrorHandlerFunction(cmsContext /*ContextID*/, cmsUInt32Number ErrorCode, const char *Text)
70{
71 errorPigment << "Lcms2 error: " << ErrorCode << Text;
72}
73
74K_PLUGIN_FACTORY_WITH_JSON(PluginFactory, "kolcmsengine.json", registerPlugin<LcmsEnginePlugin>();)
75
76LcmsEnginePlugin::LcmsEnginePlugin(QObject *parent, const QVariantList &)
77 : QObject(parent)
78{
79 KoResourcePaths::addAssetType("icc_profiles", "data", "/color/icc");
80 KoResourcePaths::addAssetType("icc_profiles", "data", "/profiles/");
81
82 // Set the lmcs error reporting function
83 cmsSetLogErrorHandler(&lcms2LogErrorHandlerFunction);
84
85 KoColorSpaceRegistry *registry = KoColorSpaceRegistry::instance();
86
87 // Initialise color engine
88 KoColorSpaceEngineRegistry::instance()->add(new IccColorSpaceEngine);
89
90 QStringList profileFilenames;
91 profileFilenames += KoResourcePaths::findAllAssets("icc_profiles", "*.icm", KoResourcePaths::Recursive);
92 profileFilenames += KoResourcePaths::findAllAssets("icc_profiles", "*.ICM", KoResourcePaths::Recursive);
93 profileFilenames += KoResourcePaths::findAllAssets("icc_profiles", "*.ICC", KoResourcePaths::Recursive);
94 profileFilenames += KoResourcePaths::findAllAssets("icc_profiles", "*.icc", KoResourcePaths::Recursive);
95
96 QStringList iccProfileDirs;
97
98#ifdef Q_OS_MAC
99 iccProfileDirs.append(QDir::homePath() + "/Library/ColorSync/Profiles/");
100 iccProfileDirs.append("/System/Library/ColorSync/Profiles/");
101 iccProfileDirs.append("/Library/ColorSync/Profiles/");
102#endif
103#ifdef Q_OS_WIN
104 QString winPath = QString::fromUtf8(qgetenv("windir"));
105 winPath.replace('\\','/');
106 iccProfileDirs.append(winPath + "/System32/Spool/Drivers/Color/");
107
108#endif
109#ifdef Q_OS_LINUX
110 iccProfileDirs.append(QDir::homePath() + "./share/color/icc");
111#endif
112
113 QStringList blackList = QStringList() << "panhexro.icm"
114 << "ctpctdmed.icc";
115
116
117 Q_FOREACH(const QString &iccProfiledir, iccProfileDirs) {
118 QDir profileDir(iccProfiledir);
119 Q_FOREACH(const QString &entry, profileDir.entryList(QStringList() << "*.icm" << "*.icc" << "*.ICM" << "*.ICC", QDir::NoDotAndDotDot | QDir::Files | QDir::Readable)) {
120 if (blackList.contains(entry.toLower())) continue;
121 profileFilenames << iccProfiledir + "/" + entry;
122 }
123 }
124
125 // Load the profiles
126 if (!profileFilenames.empty()) {
127 for (QStringList::Iterator it = profileFilenames.begin(); it != profileFilenames.end(); ++it) {
128
129 KoColorProfile *profile = new IccColorProfile(*it);
130 Q_CHECK_PTR(profile);
131
132 profile->load();
133 if (profile->valid()) {
134 //qDebug() << "Valid profile : " << profile->fileName() << profile->name();
135 registry->addProfileToMap(profile);
136 } else {
137 qDebug() << "Invalid profile : " << *it;
138 delete profile;
139 }
140 }
141 }
142
143 // ------------------- LAB ---------------------------------
144
145 KoColorProfile *labProfile = LcmsColorProfileContainer::createFromLcmsProfile(cmsCreateLab4Profile(0));
146 registry->addProfile(labProfile);
147
148 registry->add(new LabU8ColorSpaceFactory());
149 registry->add(new LabU16ColorSpaceFactory());
150 registry->add(new LabF32ColorSpaceFactory());
151
152 KoHistogramProducerFactoryRegistry::instance()->add(
153 new KoBasicHistogramProducerFactory<KoBasicU8HistogramProducer>
154 (KoID("LABAU8HISTO", i18n("L*a*b*/8 Histogram")), LABAColorModelID.id(), Integer8BitsColorDepthID.id()));
155
156 KoHistogramProducerFactoryRegistry::instance()->add(
157 new KoBasicHistogramProducerFactory<KoBasicU16HistogramProducer>
158 (KoID("LABAU16HISTO", i18n("L*a*b*/16 Histogram")), LABAColorModelID.id(), Integer16BitsColorDepthID.id()));
159
160 KoHistogramProducerFactoryRegistry::instance()->add(
161 new KoBasicHistogramProducerFactory<KoBasicF32HistogramProducer>
162 (KoID("LABAF32HISTO", i18n("L*a*b*/32 Histogram")), LABAColorModelID.id(), Float32BitsColorDepthID.id()));
163
164 // ------------------- RGB ---------------------------------
165
166 KoColorProfile *rgbProfile = LcmsColorProfileContainer::createFromLcmsProfile(cmsCreate_sRGBProfile());
167 registry->addProfile(rgbProfile);
168
169 KoColorProfileQuery query(PRIMARIES_ITU_R_BT_2020_2_AND_2100_0, TRC_ITU_R_BT_2100_0_PQ);
170 query.hdrReferenceWhite = std::make_optional(203.0);
171
172 KoColorProfile *rec2100pq203nits = new IccColorProfile(query);
173 registry->addProfile(rec2100pq203nits);
174
175 query.hdrReferenceWhite = std::make_optional(80.0);
176 KoColorProfile *rec2100pq80nits = new IccColorProfile(query);
177 registry->addProfile(rec2100pq80nits);
178
186 const QString legacyRec2020PQProfileName = "High Dynamic Range UHDTV Wide Color Gamut Display (Rec. 2020) - SMPTE ST 2084 PQ EOTF";
187 registry->addProfileAlias(legacyRec2020PQProfileName, rec2100pq203nits->name());
188
189 registry->add(new RgbU8ColorSpaceFactory());
190 registry->add(new RgbU16ColorSpaceFactory());
191 #ifdef HAVE_LCMS24
192 #ifdef HAVE_OPENEXR
193 registry->add(new RgbF16ColorSpaceFactory());
194 #endif
195 #endif
196 registry->add(new RgbF32ColorSpaceFactory());
197
198 KoHistogramProducerFactoryRegistry::instance()->add(
199 new KoBasicHistogramProducerFactory<KoBasicU8HistogramProducer>
200 (KoID("RGBU8HISTO", i18n("RGBA/8 Histogram")), RGBAColorModelID.id(), Integer8BitsColorDepthID.id()));
201
202 KoHistogramProducerFactoryRegistry::instance()->add(
203 new KoBasicHistogramProducerFactory<KoBasicU16HistogramProducer>
204 (KoID("RGBU16HISTO", i18n("RGBA/16 Histogram")), RGBAColorModelID.id(), Integer16BitsColorDepthID.id()));
205
206#ifdef HAVE_LCMS24
207#ifdef HAVE_OPENEXR
208 KoHistogramProducerFactoryRegistry::instance()->add(
209 new KoBasicHistogramProducerFactory<KoBasicF16HalfHistogramProducer>
210 (KoID("RGBF16HISTO", i18n("RGBA/F16 Histogram")), RGBAColorModelID.id(), Float16BitsColorDepthID.id()));
211#endif
212#endif
213
214 KoHistogramProducerFactoryRegistry::instance()->add(
215 new KoBasicHistogramProducerFactory<KoBasicF32HistogramProducer>
216 (KoID("RGF328HISTO", i18n("RGBA/F32 Histogram")), RGBAColorModelID.id(), Float32BitsColorDepthID.id()));
217
218 // ------------------- GRAY ---------------------------------
219
220 cmsToneCurve *Gamma = cmsBuildGamma(0, 2.2);
221 cmsHPROFILE hProfile = cmsCreateGrayProfile(cmsD50_xyY(), Gamma);
222 cmsFreeToneCurve(Gamma);
223 KoColorProfile *defProfile = LcmsColorProfileContainer::createFromLcmsProfile(hProfile);
224 registry->addProfile(defProfile);
225
226 registry->add(new GrayAU8ColorSpaceFactory());
227 registry->add(new GrayAU16ColorSpaceFactory());
228#ifdef HAVE_LCMS24
229#ifdef HAVE_OPENEXR
230 registry->add(new GrayF16ColorSpaceFactory());
231#endif
232#endif
233 registry->add(new GrayF32ColorSpaceFactory());
234
235 KoHistogramProducerFactoryRegistry::instance()->add(
236 new KoBasicHistogramProducerFactory<KoBasicU8HistogramProducer>
237 (KoID("GRAYA8HISTO", i18n("GRAY/8 Histogram")), GrayAColorModelID.id(), Integer8BitsColorDepthID.id()));
238
239 KoHistogramProducerFactoryRegistry::instance()->add(
240 new KoBasicHistogramProducerFactory<KoBasicU16HistogramProducer>
241 (KoID("GRAYA16HISTO", i18n("GRAY/16 Histogram")), GrayAColorModelID.id(), Integer16BitsColorDepthID.id()));
242#ifdef HAVE_LCMS24
243#ifdef HAVE_OPENEXR
244 KoHistogramProducerFactoryRegistry::instance()->add(
245 new KoBasicHistogramProducerFactory<KoBasicF16HalfHistogramProducer>
246 (KoID("GRAYF16HISTO", i18n("GRAYF/F16 Histogram")), GrayAColorModelID.id(), Float16BitsColorDepthID.id()));
247#endif
248#endif
249
250 KoHistogramProducerFactoryRegistry::instance()->add(
251 new KoBasicHistogramProducerFactory<KoBasicF32HistogramProducer>
252 (KoID("GRAYAF32HISTO", i18n("GRAY/F32 float Histogram")), GrayAColorModelID.id(), Float32BitsColorDepthID.id()));
253
254 // ------------------- CMYK ---------------------------------
255
256 registry->add(new CmykU8ColorSpaceFactory());
257 registry->add(new CmykU16ColorSpaceFactory());
258 registry->add(new CmykF32ColorSpaceFactory());
259
260 KoHistogramProducerFactoryRegistry::instance()->add(
261 new KoBasicHistogramProducerFactory<KoBasicU8HistogramProducer>
262 (KoID("CMYK8HISTO", i18n("CMYK/8 Histogram")), CMYKAColorModelID.id(), Integer8BitsColorDepthID.id()));
263
264 KoHistogramProducerFactoryRegistry::instance()->add(
265 new KoBasicHistogramProducerFactory<KoBasicU16HistogramProducer>
266 (KoID("CMYK16HISTO", i18n("CMYK/16 Histogram")), CMYKAColorModelID.id(), Integer16BitsColorDepthID.id()));
267
268 KoHistogramProducerFactoryRegistry::instance()->add(
269 new KoBasicHistogramProducerFactory<KoBasicF32HistogramProducer>
270 (KoID("CMYKF32HISTO", i18n("CMYK/F32 Histogram")), CMYKAColorModelID.id(), Float32BitsColorDepthID.id()));
271
272 // ------------------- XYZ ---------------------------------
273
274 KoColorProfile *xyzProfile = LcmsColorProfileContainer::createFromLcmsProfile(cmsCreateXYZProfile());
275 registry->addProfile(xyzProfile);
276
277 registry->add(new XyzU8ColorSpaceFactory());
278 registry->add(new XyzU16ColorSpaceFactory());
279#ifdef HAVE_LCMS24
280#ifdef HAVE_OPENEXR
281 registry->add(new XyzF16ColorSpaceFactory());
282#endif
283#endif
284 registry->add(new XyzF32ColorSpaceFactory());
285
286 KoHistogramProducerFactoryRegistry::instance()->add(
287 new KoBasicHistogramProducerFactory<KoBasicU8HistogramProducer>
288 (KoID("XYZ8HISTO", i18n("XYZ/8 Histogram")), XYZAColorModelID.id(), Integer8BitsColorDepthID.id()));
289
290 KoHistogramProducerFactoryRegistry::instance()->add(
291 new KoBasicHistogramProducerFactory<KoBasicU16HistogramProducer>
292 (KoID("XYZ16HISTO", i18n("XYZ/16 Histogram")), XYZAColorModelID.id(), Integer16BitsColorDepthID.id()));
293
294#ifdef HAVE_LCMS24
295#ifdef HAVE_OPENEXR
296 KoHistogramProducerFactoryRegistry::instance()->add(
297 new KoBasicHistogramProducerFactory<KoBasicF32HistogramProducer>
298 (KoID("XYZF16HISTO", i18n("XYZ/F16 Histogram")), XYZAColorModelID.id(), Float16BitsColorDepthID.id()));
299#endif
300#endif
301
302 KoHistogramProducerFactoryRegistry::instance()->add(
303 new KoBasicHistogramProducerFactory<KoBasicF32HistogramProducer>
304 (KoID("XYZF32HISTO", i18n("XYZF32 Histogram")), XYZAColorModelID.id(), Float32BitsColorDepthID.id()));
305
306 // ------------------- YCBCR ---------------------------------
307
308 // KoColorProfile *yCbCrProfile = LcmsColorProfileContainer::createFromLcmsProfile(cmsCreateYCBCRProfile());
309 // registry->addProfile(yCbCrProfile);
310
311 registry->add(new YCbCrU8ColorSpaceFactory());
312 registry->add(new YCbCrU16ColorSpaceFactory());
313 registry->add(new YCbCrF32ColorSpaceFactory());
314
315 KoHistogramProducerFactoryRegistry::instance()->add(
316 new KoBasicHistogramProducerFactory<KoBasicU8HistogramProducer>
317 (KoID("YCBCR8HISTO", i18n("YCbCr/8 Histogram")), YCbCrAColorModelID.id(), Integer8BitsColorDepthID.id()));
318
319 KoHistogramProducerFactoryRegistry::instance()->add(
320 new KoBasicHistogramProducerFactory<KoBasicU16HistogramProducer>
321 (KoID("YCBCR16HISTO", i18n("YCbCr/16 Histogram")), YCbCrAColorModelID.id(), Integer16BitsColorDepthID.id()));
322
323 KoHistogramProducerFactoryRegistry::instance()->add(
324 new KoBasicHistogramProducerFactory<KoBasicF32HistogramProducer>
325 (KoID("YCBCRF32HISTO", i18n("YCbCr/F32 Histogram")), YCbCrAColorModelID.id(), Float32BitsColorDepthID.id()));
326
327 // Add profile alias for default profile from lcms1
328 registry->addProfileAlias("sRGB built-in - (lcms internal)", "sRGB built-in");
329 registry->addProfileAlias("gray built-in - (lcms internal)", "gray built-in");
330 registry->addProfileAlias("Lab identity built-in - (lcms internal)", "Lab identity built-in");
331 registry->addProfileAlias("XYZ built-in - (lcms internal)", "XYZ identity built-in");
332
333#if defined(HAVE_LCMS_FAST_FLOAT_PLUGIN)
334 cmsPlugin(cmsFastFloatExtensions());
335#endif
336}
337
338#include <LcmsEnginePlugin.moc>
errorPigment
#define errorPigment
Definition DebugPigment.h:21
QStringList
QList< QString > QStringList
Definition KisQStringListFwd.h:18
Float32BitsColorDepthID
const KoID Float32BitsColorDepthID("F32", ki18n("32-bit float/channel"))
YCbCrAColorModelID
const KoID YCbCrAColorModelID("YCbCrA", ki18n("YCbCr/Alpha"))
GrayAColorModelID
const KoID GrayAColorModelID("GRAYA", ki18n("Grayscale/Alpha"))
XYZAColorModelID
const KoID XYZAColorModelID("XYZA", ki18n("XYZ/Alpha"))
Float16BitsColorDepthID
const KoID Float16BitsColorDepthID("F16", ki18n("16-bit float/channel"))
Integer8BitsColorDepthID
const KoID Integer8BitsColorDepthID("U8", ki18n("8-bit integer/channel"))
Integer16BitsColorDepthID
const KoID Integer16BitsColorDepthID("U16", ki18n("16-bit integer/channel"))
CMYKAColorModelID
const KoID CMYKAColorModelID("CMYKA", ki18n("CMYK/Alpha"))
LABAColorModelID
const KoID LABAColorModelID("LABA", ki18n("L*a*b*/Alpha"))
RGBAColorModelID
const KoID RGBAColorModelID("RGBA", ki18n("RGB/Alpha"))
PRIMARIES_ITU_R_BT_2020_2_AND_2100_0
@ PRIMARIES_ITU_R_BT_2020_2_AND_2100_0
Definition KoColorProfileConstants.h:28
TRC_ITU_R_BT_2100_0_PQ
@ TRC_ITU_R_BT_2100_0_PQ
Definition KoColorProfileConstants.h:63
lcms2LogErrorHandlerFunction
void lcms2LogErrorHandlerFunction(cmsContext, cmsUInt32Number ErrorCode, const char *Text)
Definition LcmsEnginePlugin.cpp:69
KoColorSpaceEngineRegistry::instance
static KoColorSpaceEngineRegistry * instance()
Definition KoColorSpaceEngine.cpp:60
KoHistogramProducerFactoryRegistry::instance
static KoHistogramProducerFactoryRegistry * instance()
Definition KoHistogramProducer.cpp:29
KoID
Definition KoID.h:30
KoID::id
QString id() const
Definition KoID.cpp:63
KoResourcePaths::addAssetType
static void addAssetType(const QString &type, const char *basetype, const QString &relativeName, bool priority=true)
Definition KoResourcePaths.cpp:339
KoResourcePaths::findAllAssets
static QStringList findAllAssets(const QString &type, const QString &filter=QString(), SearchOptions options=NoSearchOptions)
Definition KoResourcePaths.cpp:360
LcmsColorProfileContainer::createFromLcmsProfile
static IccColorProfile * createFromLcmsProfile(const cmsHPROFILE profile)
Definition LcmsColorProfileContainer.cpp:144
LcmsEnginePlugin::LcmsEnginePlugin
LcmsEnginePlugin(QObject *parent, const QVariantList &)
Definition LcmsEnginePlugin.cpp:76
K_PLUGIN_FACTORY_WITH_JSON
K_PLUGIN_FACTORY_WITH_JSON(KritaASCCDLFactory, "kritaasccdl.json", registerPlugin< KritaASCCDL >();) KritaASCCDL
Definition kis_asccdl_filter.cpp:16
kis_assert.h
kis_debug.h
KoColorProfileQuery
The KoColorProfileQuery struct.
Definition KoColorProfileQuery.h:19
KoColorProfileQuery::hdrReferenceWhite
std::optional< double > hdrReferenceWhite
CICP-compatible enum value representing the transfer function.
Definition KoColorProfileQuery.h:40
KoColorProfile::load
virtual bool load()
Definition KoColorProfile.cpp:41
KoColorProfile::valid
virtual bool valid() const =0
KoColorSpaceRegistry::addProfileAlias
void addProfileAlias(const QString &name, const QString &to)
Definition KoColorSpaceRegistry.cpp:271
KoColorSpaceRegistry::instance
static KoColorSpaceRegistry * instance()
Definition KoColorSpaceRegistry.cpp:137
KoColorSpaceRegistry::add
void add(KoColorSpaceFactory *item)
Definition KoColorSpaceRegistry.cpp:232
KoColorSpaceRegistry::addProfileToMap
void addProfileToMap(KoColorProfile *p)
Definition KoColorSpaceRegistry.cpp:325
KoColorSpaceRegistry::addProfile
void addProfile(KoColorProfile *profile)
Definition KoColorSpaceRegistry.cpp:330