Color management system - base classes + settings

PdfForQtLib/PdfForQtLib.pro

@@ -39,6 +39,7 @@ SOURCES += \
     sources/pdfaction.cpp \
     sources/pdfblendfunction.cpp \
     sources/pdfccittfaxdecoder.cpp \
+    sources/pdfcms.cpp \
     sources/pdfcompiler.cpp \
     sources/pdffile.cpp \
     sources/pdfitemmodels.cpp \
@@ -77,6 +78,7 @@ HEADERS += \
     sources/pdfaction.h \
     sources/pdfblendfunction.h \
     sources/pdfccittfaxdecoder.h \
+    sources/pdfcms.h \
     sources/pdfcompiler.h \
     sources/pdffile.h \
     sources/pdfitemmodels.h \
@@ -174,6 +176,16 @@ zlib.files = $$PDFFORQT_DEPENDENCIES_PATH/zlib/bin/zlib.dll
 zlib.path = $$DESTDIR/install
 INSTALLS += zlib
 
+# Link lcms2
+LIBS += -L$$PDFFORQT_DEPENDENCIES_PATH/lcms2/bin/ -llcms2
+INCLUDEPATH += $$PDFFORQT_DEPENDENCIES_PATH/lcms2/include
+DEPENDPATH += $$PDFFORQT_DEPENDENCIES_PATH/lcms2/include
+
+# Add lcms2 to installations
+lcms2.files = $$PDFFORQT_DEPENDENCIES_PATH/lcms2/bin/lcms2.dll
+lcms2.path = $$DESTDIR/install
+INSTALLS += lcms2
+
 # ensure debug info even for RELEASE build
 CONFIG += force_debug_info
 

PdfForQtLib/sources/pdfcms.cpp

@@ -0,0 +1,219 @@
+//    Copyright (C) 2019 Jakub Melka
+//
+//    This file is part of PdfForQt.
+//
+//    PdfForQt is free software: you can redistribute it and/or modify
+//    it under the terms of the GNU Lesser General Public License as published by
+//    the Free Software Foundation, either version 3 of the License, or
+//    (at your option) any later version.
+//
+//    PdfForQt is distributed in the hope that it will be useful,
+//    but WITHOUT ANY WARRANTY; without even the implied warranty of
+//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//    GNU Lesser General Public License for more details.
+//
+//    You should have received a copy of the GNU Lesser General Public License
+//    along with PDFForQt.  If not, see <https://www.gnu.org/licenses/>.
+
+#include "pdfcms.h"
+
+#pragma warning(push)
+#pragma warning(disable:5033)
+#include <lcms2.h>
+#pragma warning(pop)
+
+namespace pdf
+{
+
+bool PDFCMSGeneric::isCompatible(const PDFCMSSettings& settings) const
+{
+    return settings.system == PDFCMSSettings::System::Generic;
+}
+
+QColor PDFCMSGeneric::getColorFromDeviceGray(const PDFColor& color, RenderingIntent intent, PDFRenderErrorReporter* reporter) const
+{
+    Q_UNUSED(color);
+    Q_UNUSED(intent);
+    Q_UNUSED(reporter);
+    return QColor();
+}
+
+QColor PDFCMSGeneric::getColorFromDeviceRGB(const PDFColor& color, RenderingIntent intent, PDFRenderErrorReporter* reporter) const
+{
+    Q_UNUSED(color);
+    Q_UNUSED(intent);
+    Q_UNUSED(reporter);
+    return QColor();
+}
+
+QColor PDFCMSGeneric::getColorFromDeviceCMYK(const PDFColor& color, RenderingIntent intent, PDFRenderErrorReporter* reporter) const
+{
+    Q_UNUSED(color);
+    Q_UNUSED(intent);
+    Q_UNUSED(reporter);
+    return QColor();
+}
+
+QColor PDFCMSGeneric::getColorFromXYZ(const PDFColor3& whitePoint, const PDFColor& color, RenderingIntent intent, PDFRenderErrorReporter* reporter) const
+{
+    Q_UNUSED(color);
+    Q_UNUSED(intent);
+    Q_UNUSED(reporter);
+    Q_UNUSED(whitePoint);
+    return QColor();
+}
+
+PDFCMSManager::PDFCMSManager(QObject* parent) :
+    BaseClass(parent)
+{
+
+}
+
+const PDFColorSpaceIdentifiers& PDFCMSManager::getOutputProfiles() const
+{
+    QMutexLocker lock(&m_mutex);
+    return m_outputProfiles.get(this, &PDFCMSManager::getOutputProfilesImpl);
+}
+
+const PDFColorSpaceIdentifiers& PDFCMSManager::getGrayProfiles() const
+{
+    QMutexLocker lock(&m_mutex);
+    return m_grayProfiles.get(this, &PDFCMSManager::getGrayProfilesImpl);
+}
+
+const PDFColorSpaceIdentifiers& PDFCMSManager::getRGBProfiles() const
+{
+    QMutexLocker lock(&m_mutex);
+    return m_RGBProfiles.get(this, &PDFCMSManager::getRGBProfilesImpl);
+}
+
+const PDFColorSpaceIdentifiers& PDFCMSManager::getCMYKProfiles() const
+{
+    QMutexLocker lock(&m_mutex);
+    return m_CMYKProfiles.get(this, &PDFCMSManager::getCMYKProfilesImpl);
+}
+
+PDFCMSSettings PDFCMSManager::getDefaultSettings() const
+{
+    PDFCMSSettings settings;
+
+    auto getFirstProfileId = [](const PDFColorSpaceIdentifiers& identifiers)
+    {
+        if (!identifiers.empty())
+        {
+            return identifiers.front().id;
+        }
+        return QString();
+    };
+
+    settings.system = PDFCMSSettings::System::LittleCMS2;
+    settings.outputCS = getFirstProfileId(getOutputProfiles());
+    settings.deviceGray = getFirstProfileId(getGrayProfiles());
+    settings.deviceRGB = getFirstProfileId(getRGBProfiles());
+    settings.deviceCMYK = getFirstProfileId(getCMYKProfiles());
+
+    return settings;
+}
+
+QString PDFCMSManager::getSystemName(PDFCMSSettings::System system)
+{
+    switch (system)
+    {
+        case PDFCMSSettings::System::Generic:
+            return tr("Generic");
+
+        case PDFCMSSettings::System::LittleCMS2:
+        {
+            const int major = LCMS_VERSION / 1000;
+            const int minor = (LCMS_VERSION % 1000) / 10;
+            return tr("Little CMS %1.%2").arg(major).arg(minor);
+        }
+
+        default:
+        {
+            Q_ASSERT(false);
+            break;
+        }
+    }
+
+    return QString();
+}
+
+PDFColorSpaceIdentifiers PDFCMSManager::getOutputProfilesImpl() const
+{
+    // Currently, we only support sRGB output color profile.
+    return { PDFColorSpaceIdentifier::createSRGB() };
+}
+
+PDFColorSpaceIdentifiers PDFCMSManager::getGrayProfilesImpl() const
+{
+    // Jakub Melka: We create gray profiles for temperature 5000K, 6500K and 9300K.
+    // We also use linear gamma and gamma value 2.2.
+    return {
+        PDFColorSpaceIdentifier::createGray(tr("Gray D65, γ = 2.2"), "@GENERIC_Gray_D65_g22", 6500.0, 2.2),
+        PDFColorSpaceIdentifier::createGray(tr("Gray D50, γ = 2.2"), "@GENERIC_Gray_D50_g22", 5000.0, 2.2),
+        PDFColorSpaceIdentifier::createGray(tr("Gray D93, γ = 2.2"), "@GENERIC_Gray_D93_g22", 9300.0, 2.2),
+        PDFColorSpaceIdentifier::createGray(tr("Gray D65, γ = 1.0 (linear)"), "@GENERIC_Gray_D65_g10", 6500.0, 1.0),
+        PDFColorSpaceIdentifier::createGray(tr("Gray D50, γ = 1.0 (linear)"), "@GENERIC_Gray_D50_g10", 5000.0, 1.0),
+        PDFColorSpaceIdentifier::createGray(tr("Gray D93, γ = 1.0 (linear)"), "@GENERIC_Gray_D93_g10", 9300.0, 1.0)
+    };
+}
+
+PDFColorSpaceIdentifiers PDFCMSManager::getRGBProfilesImpl() const
+{
+    // Jakub Melka: We create RGB profiles for common standars and also for
+    // default standard sRGB. See https://en.wikipedia.org/wiki/Color_spaces_with_RGB_primaries.
+    return {
+        PDFColorSpaceIdentifier::createSRGB(),
+        PDFColorSpaceIdentifier::createRGB(tr("HDTV (ITU-R BT.709)"), "@GENERIC_RGB_HDTV", 6500, QPointF(0.64, 0.33), QPointF(0.30, 0.60), QPointF(0.15, 0.06), 20.0 / 9.0),
+        PDFColorSpaceIdentifier::createRGB(tr("Adobe RGB 1998"), "@GENERIC_RGB_Adobe1998", 6500, QPointF(0.64, 0.33), QPointF(0.30, 0.60), QPointF(0.15, 0.06), 563.0 / 256.0),
+        PDFColorSpaceIdentifier::createRGB(tr("PAL / SECAM"), "@GENERIC_RGB_PalSecam", 6500, QPointF(0.64, 0.33), QPointF(0.29, 0.60), QPointF(0.15, 0.06), 14.0 / 5.0),
+        PDFColorSpaceIdentifier::createRGB(tr("NTSC"), "@GENERIC_RGB_NTSC", 6500, QPointF(0.64, 0.34), QPointF(0.31, 0.595), QPointF(0.155, 0.07), 20.0 / 9.0),
+        PDFColorSpaceIdentifier::createRGB(tr("Adobe Wide Gamut RGB"), "@GENERIC_RGB_AdobeWideGamut", 5000, QPointF(0.735, 0.265), QPointF(0.115, 0.826), QPointF(0.157, 0.018), 563.0 / 256.0),
+        PDFColorSpaceIdentifier::createRGB(tr("ProPhoto RGB"), "@GENERIC_RGB_ProPhoto", 5000, QPointF(0.7347, 0.2653), QPointF(0.1596, 0.8404), QPointF(0.0366, 0.0001), 9.0 / 5.0)
+    };
+}
+
+PDFColorSpaceIdentifiers PDFCMSManager::getCMYKProfilesImpl() const
+{
+    return {
+
+    };
+}
+
+PDFColorSpaceIdentifier PDFColorSpaceIdentifier::createGray(QString name, QString id, PDFReal temperature, PDFReal gamma)
+{
+    PDFColorSpaceIdentifier result;
+    result.type = Type::Gray;
+    result.name = qMove(name);
+    result.id = qMove(id);
+    result.temperature = temperature;
+    result.gamma = gamma;
+    return result;
+}
+
+PDFColorSpaceIdentifier PDFColorSpaceIdentifier::createSRGB()
+{
+    PDFColorSpaceIdentifier result;
+    result.type = Type::sRGB;
+    result.name = PDFCMSManager::tr("sRGB");
+    result.id = "@GENERIC_sRGB";
+    return result;
+}
+
+PDFColorSpaceIdentifier PDFColorSpaceIdentifier::createRGB(QString name, QString id, PDFReal temperature, QPointF primaryR, QPointF primaryG, QPointF primaryB, PDFReal gamma)
+{
+    PDFColorSpaceIdentifier result;
+    result.type = Type::RGB;
+    result.name = qMove(name);
+    result.id = qMove(id);
+    result.temperature = temperature;
+    result.primaryR = primaryR;
+    result.primaryG = primaryG;
+    result.primaryB = primaryB;
+    result.gamma = gamma;
+    return result;
+}
+
+}   // namespace pdf
+

PdfForQtLib/sources/pdfcms.h

@@ -0,0 +1,225 @@
+//    Copyright (C) 2019 Jakub Melka
+//
+//    This file is part of PdfForQt.
+//
+//    PdfForQt is free software: you can redistribute it and/or modify
+//    it under the terms of the GNU Lesser General Public License as published by
+//    the Free Software Foundation, either version 3 of the License, or
+//    (at your option) any later version.
+//
+//    PdfForQt is distributed in the hope that it will be useful,
+//    but WITHOUT ANY WARRANTY; without even the implied warranty of
+//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//    GNU Lesser General Public License for more details.
+//
+//    You should have received a copy of the GNU Lesser General Public License
+//    along with PDFForQt. If not, see <https://www.gnu.org/licenses/>.
+
+#ifndef PDFCMS_H
+#define PDFCMS_H
+
+#include "pdfglobal.h"
+#include "pdfcolorspaces.h"
+#include "pdfexception.h"
+#include "pdfutils.h"
+
+#include <QMutex>
+
+#include <compare>
+
+namespace pdf
+{
+
+/// This simple structure stores settings for color management system, and what
+/// color management system should be used. At default, two color management
+/// system are available - generic (which uses default imprecise color management),
+/// and CMS using engine LittleCMS2, which was written by Marti Maria, and is
+/// linked as separate library.
+struct PDFCMSSettings
+{
+    /// Type of color management system
+    enum class System
+    {
+        Generic,
+        LittleCMS2
+    };
+
+    /// Controls accuracy of the color transformations. High accuracy
+    /// could mean high memory consumption, but better color accuracy,
+    /// low accuracy means low memory consumption and low color accuracy.
+    enum class Accuracy
+    {
+        Low,
+        Medium,
+        High
+    };
+
+    bool operator==(const PDFCMSSettings&) const = default;
+
+    System system = System::Generic;
+    Accuracy accuracy = Accuracy::Medium;
+    RenderingIntent intent = RenderingIntent::Auto;
+    bool isBlackPointCompensationActive = true;
+    bool isWhitePaperColorTransformed = false;
+    QString outputCS;       ///< Output (rendering) color space
+    QString deviceGray;     ///< Identifiers for color space (device gray)
+    QString deviceRGB;      ///< Identifiers for color space (device RGB)
+    QString deviceCMYK;     ///< Identifiers for color space (device CMYK)
+};
+
+/// Color management system base class. It contains functions to transform
+/// colors from various color system to device color system. If color management
+/// system can't handle color transform, it should return invalid color.
+class PDFCMS
+{
+public:
+    explicit inline PDFCMS() = default;
+    virtual ~PDFCMS() = default;
+
+    /// This function should decide, if color management system is compatible with these
+    /// settings (so, it transforms colors according to this setting). If this
+    /// function returns false, then this color management system should be replaced
+    /// by newly created one, according these settings.
+    virtual bool isCompatible(const PDFCMSSettings& settings) const = 0;
+
+    /// Converts color in Device Gray color space to the target device
+    /// color space. If error occurs, then invalid color is returned.
+    /// Caller then should handle this - try to convert color as accurate
+    /// as possible.
+    /// \param color Single color channel value
+    /// \param intent Rendering intent
+    /// \param reporter Render error reporter (used, when color transform fails)
+    virtual QColor getColorFromDeviceGray(const PDFColor& color, RenderingIntent intent, PDFRenderErrorReporter* reporter) const = 0;
+
+    /// Converts color in Device RGB color space to the target device
+    /// color space. If error occurs, then invalid color is returned.
+    /// Caller then should handle this - try to convert color as accurate
+    /// as possible.
+    /// \param color Three color channel value (R,G,B channel)
+    /// \param intent Rendering intent
+    /// \param reporter Render error reporter (used, when color transform fails)
+    virtual QColor getColorFromDeviceRGB(const PDFColor& color, RenderingIntent intent, PDFRenderErrorReporter* reporter) const = 0;
+
+    /// Converts color in Device CMYK color space to the target device
+    /// color space. If error occurs, then invalid color is returned.
+    /// Caller then should handle this - try to convert color as accurate
+    /// as possible.
+    /// \param color Four color channel value (C,M,Y,K channel)
+    /// \param intent Rendering intent
+    /// \param reporter Render error reporter (used, when color transform fails)
+    virtual QColor getColorFromDeviceCMYK(const PDFColor& color, RenderingIntent intent, PDFRenderErrorReporter* reporter) const = 0;
+
+    /// Converts color in XYZ color space to the target device
+    /// color space. If error occurs, then invalid color is returned.
+    /// Caller then should handle this - try to convert color as accurate
+    /// as possible.
+    /// \param whitePoint White point of source XYZ color space
+    /// \param Three color channel value (X,Y,Z channel)
+    /// \param intent Rendering intent
+    /// \param reporter Render error reporter (used, when color transform fails)
+    virtual QColor getColorFromXYZ(const PDFColor3& whitePoint, const PDFColor& color, RenderingIntent intent, PDFRenderErrorReporter* reporter) const = 0;
+};
+
+class PDFCMSGeneric : public PDFCMS
+{
+public:
+    explicit inline PDFCMSGeneric() = default;
+
+    virtual bool isCompatible(const PDFCMSSettings& settings) const override;
+    virtual QColor getColorFromDeviceGray(const PDFColor& color, RenderingIntent intent, PDFRenderErrorReporter* reporter) const override;
+    virtual QColor getColorFromDeviceRGB(const PDFColor& color, RenderingIntent intent, PDFRenderErrorReporter* reporter) const override;
+    virtual QColor getColorFromDeviceCMYK(const PDFColor& color, RenderingIntent intent, PDFRenderErrorReporter* reporter) const override;
+    virtual QColor getColorFromXYZ(const PDFColor3& whitePoint, const PDFColor& color, RenderingIntent intent, PDFRenderErrorReporter* reporter) const override;
+};
+
+struct PDFColorSpaceIdentifier
+{
+    enum class Type
+    {
+        Gray,
+        sRGB,
+        RGB,
+        CMYK
+    };
+
+    Type type = Type::sRGB;
+    QString name;
+    QString id;
+    PDFReal temperature = 6500.0;
+    QPointF primaryR;
+    QPointF primaryG;
+    QPointF primaryB;
+    PDFReal gamma = 1.0;
+
+    /// Creates gray color space identifier
+    /// \param name Name of color profile
+    /// \param id Identifier of color profile
+    /// \param temperature White point temperature
+    /// \param gamma Gamma correction
+    static PDFColorSpaceIdentifier createGray(QString name, QString id, PDFReal temperature, PDFReal gamma);
+
+    /// Creates sRGB color space identifier
+    static PDFColorSpaceIdentifier createSRGB();
+
+    /// Creates RGB color space identifier
+    /// \param name Name of color profile
+    /// \param id Identifier of color profile
+    /// \param temperature White point temperature
+    /// \param primaryR Primary red
+    /// \param primaryG Primary green
+    /// \param primaryB Primary blue
+    /// \param gamma Gamma correction
+    static PDFColorSpaceIdentifier createRGB(QString name, QString id, PDFReal temperature, QPointF primaryR, QPointF primaryG, QPointF primaryB, PDFReal gamma);
+};
+
+using PDFColorSpaceIdentifiers = std::vector<PDFColorSpaceIdentifier>;
+
+/// Manager, that manages current color management system and also list
+/// of usable input and output color profiles. It has color profiles
+/// for outout device, and color profiles for input (gray/RGB/CMYK).
+/// It also handles settings, and it's changes. Constant functions
+/// is save to call from multiple threads, this also holds for some
+/// non-constant functions - manager is protected by mutexes.
+class PDFFORQTLIBSHARED_EXPORT PDFCMSManager : public QObject
+{
+    Q_OBJECT
+
+private:
+    using BaseClass = QObject;
+
+public:
+    explicit PDFCMSManager(QObject* parent);
+
+    const PDFColorSpaceIdentifiers& getOutputProfiles() const;
+    const PDFColorSpaceIdentifiers& getGrayProfiles() const;
+    const PDFColorSpaceIdentifiers& getRGBProfiles() const;
+    const PDFColorSpaceIdentifiers& getCMYKProfiles() const;
+
+    /// Returns default color management settings
+    PDFCMSSettings getDefaultSettings() const;
+
+    /// Get translated name for color management system
+    /// \param system System
+    static QString getSystemName(PDFCMSSettings::System system);
+
+signals:
+    void colorManagementSystemChanged();
+
+private:
+    PDFColorSpaceIdentifiers getOutputProfilesImpl() const;
+    PDFColorSpaceIdentifiers getGrayProfilesImpl() const;
+    PDFColorSpaceIdentifiers getRGBProfilesImpl() const;
+    PDFColorSpaceIdentifiers getCMYKProfilesImpl() const;
+
+    PDFCMSSettings m_settings;
+
+    mutable QMutex m_mutex;
+    mutable PDFCachedItem<PDFColorSpaceIdentifiers> m_outputProfiles;
+    mutable PDFCachedItem<PDFColorSpaceIdentifiers> m_grayProfiles;
+    mutable PDFCachedItem<PDFColorSpaceIdentifiers> m_RGBProfiles;
+    mutable PDFCachedItem<PDFColorSpaceIdentifiers> m_CMYKProfiles;
+};
+
+}   // namespace pdf
+
+#endif // PDFCMS_H

PdfForQtLib/sources/pdfglobal.h

@@ -150,6 +150,7 @@ enum class RendererEngine
 
 enum class RenderingIntent
 {
+    Auto,                   ///< Rendering intent is automatically selected
     Perceptual,
     AbsoluteColorimetric,
     RelativeColorimetric,