IccColorSpaceEngine Class Reference

#include <IccColorSpaceEngine.h>

Inheritance diagram for IccColorSpaceEngine:

Classes
struct	Private

Public Member Functions
const KoColorProfile *	addProfile (const QByteArray &data) override
const KoColorProfile *	addProfile (const QString &filename) override
quint32	computeColorSpaceType (const KoColorSpace *cs) const
KoColorProofingConversionTransformation *	createColorProofingTransformation (const KoColorSpace *srcColorSpace, const KoColorSpace *dstColorSpace, const KoColorSpace *proofingSpace, KoColorConversionTransformation::Intent renderingIntent, KoColorConversionTransformation::Intent proofingIntent, bool firstTransformBPC, quint8 *gamutWarning, KoColorConversionTransformation::ConversionFlags displayConversionFlags) const override
KoColorConversionTransformation *	createColorTransformation (const KoColorSpace *srcColorSpace, const KoColorSpace *dstColorSpace, KoColorConversionTransformation::Intent renderingIntent, KoColorConversionTransformation::ConversionFlags conversionFlags) const override
const KoColorProfile *	getProfile (const QVector< double > &colorants, ColorPrimaries colorPrimaries, TransferCharacteristics transferFunction) override
	getProfile This tries to generate a profile with the given characteristics and add it to the registry.
	IccColorSpaceEngine ()
void	removeProfile (const QString &filename) override
bool	supportsColorSpace (const QString &colorModelId, const QString &colorDepthId, const KoColorProfile *profile) const override
	~IccColorSpaceEngine () override
Public Member Functions inherited from KoColorSpaceEngine
const QString &	id () const
	KoColorSpaceEngine (const QString &id, const QString &name)
const QString &	name () const
	~KoColorSpaceEngine () override
Public Member Functions inherited from Private
	Private (KisCanvas2 *c)
Public Member Functions inherited from KoColorConversionTransformationAbstractFactory
	KoColorConversionTransformationAbstractFactory ()
virtual	~KoColorConversionTransformationAbstractFactory ()

Private Attributes
Private *const	d

Additional Inherited Members
Public Attributes inherited from KoColorSpaceEngine
QString	id
QString	name
Public Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Detailed Description

Definition at line 12 of file IccColorSpaceEngine.h.

Constructor & Destructor Documentation

IccColorSpaceEngine()

IccColorSpaceEngine::IccColorSpaceEngine

(

)

Definition at line 149 of file IccColorSpaceEngine.cpp.

                                         : KoColorSpaceEngine("icc", i18n("ICC Engine")), d(new Private)
{
}

~IccColorSpaceEngine()

IccColorSpaceEngine::~IccColorSpaceEngine ( )

override

Definition at line 153 of file IccColorSpaceEngine.cpp.

{
    delete d;
}

References d.

Member Function Documentation

addProfile() [1/2]

const KoColorProfile * IccColorSpaceEngine::addProfile ( const QByteArray & data )

overridevirtual

Implements KoColorSpaceEngine.

Definition at line 189 of file IccColorSpaceEngine.cpp.

{
    KoColorSpaceRegistry *registry = KoColorSpaceRegistry::instance();
 
    KoColorProfile *profile = new IccColorProfile(data);
    Q_CHECK_PTR(profile);
 
    if (profile->valid()) {
        dbgPigment << "Valid profile : " << profile->fileName() << profile->name();
        registry->addProfile(profile);
    } else {
        dbgPigment << "Invalid profile : " << profile->fileName() << profile->name();
        delete profile;
        profile = 0;
    }
 
    return profile;
}

References KoColorSpaceRegistry::addProfile(), dbgPigment, KoColorProfile::fileName, KoColorSpaceRegistry::instance(), KoColorProfile::name, and KoColorProfile::valid().

addProfile() [2/2]

const KoColorProfile * IccColorSpaceEngine::addProfile ( const QString & filename )

overridevirtual

Implements KoColorSpaceEngine.

Definition at line 158 of file IccColorSpaceEngine.cpp.

{
    KoColorSpaceRegistry *registry = KoColorSpaceRegistry::instance();
 
    KoColorProfile *profile = new IccColorProfile(filename);
    Q_CHECK_PTR(profile);
 
    // this our own loading code; sometimes it fails because of an lcms error
    profile->load();
 
    // and then lcms can read the profile from file itself without problems,
    // quite often, and we can initialize it
    if (!profile->valid()) {
        cmsHPROFILE cmsp = cmsOpenProfileFromFile(filename.toLatin1(), "r");
        if (cmsp) {
            profile = LcmsColorProfileContainer::createFromLcmsProfile(cmsp);
        }
    }
 
    if (profile->valid()) {
        dbgPigment << "Valid profile : " << profile->fileName() << profile->name();
        registry->addProfile(profile);
    } else {
        dbgPigment << "Invalid profile : " << profile->fileName() << profile->name();
        delete profile;
        profile = 0;
    }
 
    return profile;
}

References KoColorSpaceRegistry::addProfile(), LcmsColorProfileContainer::createFromLcmsProfile(), dbgPigment, KoColorProfile::fileName, KoColorSpaceRegistry::instance(), KoColorProfile::load(), KoColorProfile::name, and KoColorProfile::valid().

computeColorSpaceType()

quint32 IccColorSpaceEngine::computeColorSpaceType

(

const KoColorSpace *

cs

)

const

Definition at line 293 of file IccColorSpaceEngine.cpp.

{
    Q_ASSERT(cs);
 
    if (const KoLcmsInfo *lcmsInfo = dynamic_cast<const KoLcmsInfo *>(cs)) {
        return lcmsInfo->colorSpaceType();
    } else {
        QString modelId = cs->colorModelId().id();
        QString depthId = cs->colorDepthId().id();
        // Compute the depth part of the type
        quint32 depthType;
 
        if (depthId == Integer8BitsColorDepthID.id()) {
            depthType = BYTES_SH(1);
        } else if (depthId == Integer16BitsColorDepthID.id()) {
            depthType = BYTES_SH(2);
        } else if (depthId == Float16BitsColorDepthID.id()) {
            depthType = BYTES_SH(2) | FLOAT_SH(1);
        } else if (depthId == Float32BitsColorDepthID.id()) {
            depthType = BYTES_SH(4) | FLOAT_SH(1);
        } else if (depthId == Float64BitsColorDepthID.id()) {
            depthType = BYTES_SH(0) | FLOAT_SH(1);
        } else {
            qWarning() << "Unknown bit depth";
            return 0;
        }
        // Compute the model part of the type
        quint32 modelType = 0;
 
        if (modelId == RGBAColorModelID.id()) {
            if (depthId.startsWith(QLatin1Char('U'))) {
                modelType = (COLORSPACE_SH(PT_RGB) | EXTRA_SH(1) | CHANNELS_SH(3) | DOSWAP_SH(1) | SWAPFIRST_SH(1));
            } else if (depthId.startsWith(QLatin1Char('F'))) {
                modelType = (COLORSPACE_SH(PT_RGB) | EXTRA_SH(1) | CHANNELS_SH(3));
            }
        } else if (modelId == XYZAColorModelID.id()) {
            modelType = (COLORSPACE_SH(PT_XYZ) | EXTRA_SH(1) | CHANNELS_SH(3));
        } else if (modelId == LABAColorModelID.id()) {
            modelType = (COLORSPACE_SH(PT_Lab) | EXTRA_SH(1) | CHANNELS_SH(3));
        } else if (modelId == CMYKAColorModelID.id()) {
            modelType = (COLORSPACE_SH(PT_CMYK) | EXTRA_SH(1) | CHANNELS_SH(4));
        } else if (modelId == GrayAColorModelID.id()) {
            modelType = (COLORSPACE_SH(PT_GRAY) | EXTRA_SH(1) | CHANNELS_SH(1));
        } else if (modelId == GrayColorModelID.id()) {
            modelType = (COLORSPACE_SH(PT_GRAY) | CHANNELS_SH(1));
        } else if (modelId == YCbCrAColorModelID.id()) {
            modelType = (COLORSPACE_SH(PT_YCbCr) | EXTRA_SH(1) | CHANNELS_SH(3));
        } else {
            qWarning() << "Cannot convert colorspace to lcms modeltype";
            return 0;
        }
        return depthType | modelType;
    }
}

References CMYKAColorModelID, KoColorSpace::colorDepthId(), KoColorSpace::colorModelId(), Float16BitsColorDepthID, Float32BitsColorDepthID, Float64BitsColorDepthID, GrayAColorModelID, GrayColorModelID, KoID::id(), Integer16BitsColorDepthID, Integer8BitsColorDepthID, LABAColorModelID, RGBAColorModelID, XYZAColorModelID, and YCbCrAColorModelID.

createColorProofingTransformation()

KoColorProofingConversionTransformation * IccColorSpaceEngine::createColorProofingTransformation ( const KoColorSpace * srcColorSpace, const KoColorSpace * dstColorSpace, const KoColorSpace * proofingSpace, KoColorConversionTransformation::Intent renderingIntent, KoColorConversionTransformation::Intent proofingIntent, bool firstTransformBPC, quint8 * gamutWarning, KoColorConversionTransformation::ConversionFlags displayConversionFlags ) const

overridevirtual

Reimplemented from KoColorConversionTransformationAbstractFactory.

Definition at line 271 of file IccColorSpaceEngine.cpp.

{
    KIS_ASSERT(srcColorSpace);
    KIS_ASSERT(dstColorSpace);
    KIS_ASSERT(dynamic_cast<const IccColorProfile *>(srcColorSpace->profile()));
    KIS_ASSERT(dynamic_cast<const IccColorProfile *>(dstColorSpace->profile()));
 
    return new KoLcmsColorProofingConversionTransformation(
                srcColorSpace, computeColorSpaceType(srcColorSpace),
                dynamic_cast<const IccColorProfile *>(srcColorSpace->profile())->asLcms(), dstColorSpace, computeColorSpaceType(dstColorSpace),
                dynamic_cast<const IccColorProfile *>(dstColorSpace->profile())->asLcms(), proofingSpace, renderingIntent, proofingIntent, firstTransformBPC, gamutWarning,
                displayConversionFlags
                );
}

References IccColorProfile::asLcms(), computeColorSpaceType(), KIS_ASSERT, and KoColorSpace::profile().

createColorTransformation()

KoColorConversionTransformation * IccColorSpaceEngine::createColorTransformation ( const KoColorSpace * srcColorSpace, const KoColorSpace * dstColorSpace, KoColorConversionTransformation::Intent renderingIntent, KoColorConversionTransformation::ConversionFlags conversionFlags ) const

overridevirtual

Creates a color transformation between the source color space and the destination color space.

Parameters

srcColorSpace	source color space
dstColorSpace	destination color space
renderingIntent	rendering intent
conversionFlags	conversion flags

Implements KoColorConversionTransformationAbstractFactory.

Definition at line 255 of file IccColorSpaceEngine.cpp.

{
    KIS_ASSERT(srcColorSpace);
    KIS_ASSERT(dstColorSpace);
    KIS_ASSERT(dynamic_cast<const IccColorProfile *>(srcColorSpace->profile()));
    KIS_ASSERT(dynamic_cast<const IccColorProfile *>(dstColorSpace->profile()));
 
    return new KoLcmsColorConversionTransformation(
                srcColorSpace, computeColorSpaceType(srcColorSpace),
                dynamic_cast<const IccColorProfile *>(srcColorSpace->profile())->asLcms(), dstColorSpace, computeColorSpaceType(dstColorSpace),
                dynamic_cast<const IccColorProfile *>(dstColorSpace->profile())->asLcms(), renderingIntent, conversionFlags);
 
}

References IccColorProfile::asLcms(), computeColorSpaceType(), KIS_ASSERT, and KoColorSpace::profile().

getProfile()

const KoColorProfile * IccColorSpaceEngine::getProfile ( const QVector< double > & colorants, ColorPrimaries colorPrimaries, TransferCharacteristics transferFunction )

overridevirtual

getProfile This tries to generate a profile with the given characteristics and add it to the registry.

Parameters

colorants	a double of xy (for xyY) values, this expects the first two as the white point, then the red, green and blue. Will only be used if primaries is unspecified. If there's only a whitepoint, a grayscale profile will be returned.
colorPrimaries	the color primaries type as defined in KoColorProfile.
transferFunction	the transfer function, as defined in KoColorProfile.

Returns

a profile that matches these characteristics.

Implements KoColorSpaceEngine.

Definition at line 208 of file IccColorSpaceEngine.cpp.

{
    KoColorSpaceRegistry *registry = KoColorSpaceRegistry::instance();
 
    KIS_SAFE_ASSERT_RECOVER(
        (!colorants.isEmpty() || colorPrimaries != PRIMARIES_UNSPECIFIED)
        && transferFunction != TRC_UNSPECIFIED)
    {
        if (transferFunction == TRC_LINEAR) {
            colorPrimaries = PRIMARIES_ITU_R_BT_2020_2_AND_2100_0;
        } else {
            colorPrimaries = PRIMARIES_ITU_R_BT_709_5;
        }
 
        if (transferFunction == TRC_UNSPECIFIED) {
            transferFunction = TRC_IEC_61966_2_1;
        }
    }
 
    const KoColorProfile *profile = new IccColorProfile(colorants, colorPrimaries, transferFunction);
    Q_CHECK_PTR(profile);
 
    if (profile->valid()) {
        dbgPigment << "Valid profile : " << profile->fileName() << profile->name();
        registry->addProfile(profile);
    } else {
        dbgPigment << "Invalid profile : " << profile->fileName() << profile->name();
        delete profile;
        profile = nullptr;
    }
 
    return profile;
}

References KoColorSpaceRegistry::addProfile(), dbgPigment, KoColorProfile::fileName, KoColorSpaceRegistry::instance(), KIS_SAFE_ASSERT_RECOVER, KoColorProfile::name, PRIMARIES_ITU_R_BT_2020_2_AND_2100_0, PRIMARIES_ITU_R_BT_709_5, PRIMARIES_UNSPECIFIED, TRC_IEC_61966_2_1, TRC_LINEAR, TRC_UNSPECIFIED, and KoColorProfile::valid().

removeProfile()

void IccColorSpaceEngine::removeProfile ( const QString & filename )

overridevirtual

Implements KoColorSpaceEngine.

Definition at line 242 of file IccColorSpaceEngine.cpp.

{
    KoColorSpaceRegistry *registry = KoColorSpaceRegistry::instance();
 
    KoColorProfile *profile = new IccColorProfile(filename);
    Q_CHECK_PTR(profile);
    profile->load();
 
    if (profile->valid() && registry->profileByName(profile->name())) {
        registry->removeProfile(profile);
    }
}

References KoColorSpaceRegistry::instance(), KoColorProfile::load(), KoColorProfile::name, KoColorSpaceRegistry::profileByName(), KoColorSpaceRegistry::removeProfile(), and KoColorProfile::valid().

supportsColorSpace()

bool IccColorSpaceEngine::supportsColorSpace ( const QString & colorModelId, const QString & colorDepthId, const KoColorProfile * profile ) const

overridevirtual

Returns

true if the color space can be converted via this engine

Reimplemented from KoColorSpaceEngine.

Definition at line 348 of file IccColorSpaceEngine.cpp.

{
    Q_UNUSED(colorDepthId);
    return colorModelId != RGBAColorModelID.id() || !profile || profile->name() != "High Dynamic Range UHDTV Wide Color Gamut Display (Rec. 2020) - SMPTE ST 2084 PQ EOTF";
}

References KoID::id(), KoColorProfile::name, and RGBAColorModelID.

Member Data Documentation

d

Private* const IccColorSpaceEngine::d

private

Definition at line 38 of file IccColorSpaceEngine.h.

---

The documentation for this class was generated from the following files:

• plugins/color/lcms2engine/IccColorSpaceEngine.h
• plugins/color/lcms2engine/IccColorSpaceEngine.cpp