#include <KoColorSpaceRegistry.h>

Inheritance diagram for KoColorSpaceRegistry:

Public Types
enum	ColorSpaceListProfilesSelection { OnlyDefaultProfile = 1 , AllProfiles = 4 }

enum	ColorSpaceListVisibility { OnlyUserVisible = 1 , AllColorSpaces = 4 }

using	CustomProfileNameAlias = QHash<QString, QString>

Public Member Functions
void	add (KoColorSpaceFactory *item)

void	addProfile (const KoColorProfile *profile)

void	addProfile (KoColorProfile *profile)

void	addProfileAlias (const QString &name, const QString &to)

void	addProfileToMap (KoColorProfile *p)

const KoColorSpace *	alpha16 ()

const KoColorSpace *	alpha32f ()

const KoColorSpace *	alpha8 ()

KoColorConversionCache *	colorConversionCache () const

QList< KoID >	colorDepthList (const KoID &colorModelId, ColorSpaceListVisibility option) const

QList< KoID >	colorDepthList (const QString &colorModelId, ColorSpaceListVisibility option) const

QList< KoID >	colorModelsList (ColorSpaceListVisibility option) const

const KoColorSpace *	colorSpace (const QString &colorModelId, const QString &colorDepthId)

const KoColorSpace *	colorSpace (const QString &colorModelId, const QString &colorDepthId, const KoColorProfile *profile)

const KoColorSpace *	colorSpace (const QString &colorModelId, const QString &colorDepthId, const QString &profileName)

const KoColorSpace *	colorSpace1 (const QString &colorSpaceId, const KoColorProfile *profile)

template<class LockPolicy = NormalLockPolicy>
const KoColorSpace *	colorSpace1 (const QString &colorSpaceId, const QString &pName=QString())

KoID	colorSpaceColorDepthId (const QString &_colorSpaceId) const

KoID	colorSpaceColorModelId (const QString &_colorSpaceId) const

QString	colorSpaceId (const KoID &colorModelId, const KoID &colorDepthId) const

QString	colorSpaceId (const QString &colorModelId, const QString &colorDepthId) const

QString	colorSpaceIdImpl (const QString &colorModelId, const QString &colorDepthId) const

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

void	createColorConverters (const KoColorSpace colorSpace, const QList< QPair< KoID, KoID > > &possibilities, KoColorConversionTransformation &fromCS, KoColorConversionTransformation *&toCS) const

const KoColorProfile *	createColorProfile (const QString &colorModelId, const QString &colorDepthId, const QByteArray &rawData)

const KoColorProfile *	createColorProfile (const QString &colorModelId, const QString &colorDepthId, const QByteArray &rawData, CustomProfileNameAlias customProfileNameAlias)

QString	defaultProfileForColorSpace (const QString &colorSpaceId) const

QString	defaultProfileForCsIdImpl (const QString &csID)

const KoColorSpace *	getCachedColorSpaceImpl (const QString &csId, const QString &profileName) const

const KoColorSpace *	graya16 (const KoColorProfile *profile)

const KoColorSpace *	graya16 (const QString &profile=QString())

const KoColorSpace *	graya8 (const KoColorProfile *profile)

const KoColorSpace *	graya8 (const QString &profile=QString())

QString	idsToCacheName (const QString &csId, const QString &profileName) const

	KoColorSpaceRegistry ()

const KoColorSpace *	lab16 (const KoColorProfile *profile)

const KoColorSpace *	lab16 (const QString &profileName=QString())

const KoColorSpace *	lazyCreateColorSpaceImpl (const QString &csID, const KoColorProfile *profile)

QList< KoID >	listKeys () const

const KoColorProfile *	p2020G10Profile () const

const KoColorProfile *	p2020PQProfile () const

const KoColorProfile *	p709G10Profile () const

const KoColorProfile *	p709SRGBProfile () const

const KoColorSpace *	permanentColorspace (const KoColorSpace *_colorSpace)

	Private (KoColorSpaceRegistry *_q)

QString	profileAlias (const QString &name) const

const KoColorProfile *	profileByName (const QString &name) const

const KoColorProfile *	profileByUniqueId (const QByteArray &id) const

const KoColorProfile *	profileFor (const KoColorProfileQuery &query, const bool generate=true) const
	profileFor tries to find the profile that matches these characteristics, if no such profile is found, it attempts to generate one.

const KoColorProfile *	profileForCsIdWithFallbackImpl (const QString &csID, const QString &profileName)

const KoColorProfile *	profileForQColorSpace (const QColorSpace &space)
	profileForQColorSpace Find a KoColorProfile that matches a given QColorSpace. This will use the QColorSpace::IccProfile function as a last resort, preferring to use preexisting profiles in the registry.

bool	profileIsCompatible (const KoColorProfile *profile, const QString &colorSpaceId)

QList< const KoColorProfile * >	profilesFor (const QString &csID) const

QColorSpace	QColorSpaceForProfile (const KoColorProfile *profile) const
	QColorSpaceForProfile Generate a QColorSpace for the given KoColorProfile. Will return sRGB when the profile is null.

void	remove (KoColorSpaceFactory *item)

void	removeProfile (KoColorProfile *profile)

void	removeProfileAlias (const QString &name)

const KoColorSpace *	rgb16 (const KoColorProfile *profile)

const KoColorSpace *	rgb16 (const QString &profileName=QString())

const KoColorSpace *	rgb8 (const KoColorProfile *profile)

const KoColorSpace *	rgb8 (const QString &profileName=QString())

virtual	~KoColorSpaceRegistry ()

Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Static Public Member Functions
static KoColorSpaceRegistry *	instance ()

Public Attributes
const KoColorSpace *	alphaCs {nullptr}

const KoColorSpace *	alphaF32Cs {nullptr}

const KoColorSpace *	alphaU16Cs {nullptr}

KoColorConversionCache *	colorConversionCache {nullptr}

KoColorConversionSystem *	colorConversionSystem {nullptr}

KoGenericRegistry< KoColorSpaceFactory * >	colorSpaceFactoryRegistry

QScopedPointer< ConversionSystemInterface >	conversionSystemInterface

QHash< QString, const KoColorSpace * >	csMap

const KoColorSpace *	lab16sLAB {nullptr}

KoColorProfileStorage	profileStorage

KoColorSpaceRegistry *	q {nullptr}

QReadWriteLock	registrylock

const KoColorSpace *	rgbU8sRGB {nullptr}

Public Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Private Member Functions
QList< const KoColorSpace * >	allColorSpaces (ColorSpaceListVisibility visibility, ColorSpaceListProfilesSelection pSelection)

const KoColorConversionSystem *	colorConversionSystem () const

void	init ()

	KoColorSpaceRegistry (const KoColorSpaceRegistry &)

KoColorSpaceRegistry	operator= (const KoColorSpaceRegistry &)

const KoColorProfile *	profileForInternal (const KoColorProfileQuery &query, const bool generate) const

Private Attributes
Private *const	d

Friends
struct	FriendOfColorSpaceRegistry

class	KisCrashFilterTest

class	KisCsConversionTest

class	KisIteratorNGTest

class	KisIteratorTest

class	KisPainterTest

class	KoColorSpacesBenchmark

class	TestColorConversionSystem

class	TestKoColorSpaceSanity

class	TestProfileGeneration

Detailed Description

The registry for colorspaces and profiles. This class contains:

a registry of colorspace instantiated with specific profiles.
a registry of singleton colorspace factories.
a registry of icc profiles

Locking policy details:

Basically, we have two levels of locks in the registry: 1) (outer level) is Private::registrylock, which controls the structures of the color space registry itself 2) (inner level) is KoColorProfileStorage::Private::lock controls the structures related to profiles.

The locks can be taken individually, but if you are going to take both of them, you should always follow the order 1) registry; 2) profiles. Otherwise you'll get a deadlock.

To avoid recursive deadlocks, all the dependent classes (KoColorConversionSystem and KoColorSpaceFactory) now do not use the direct links to the registry. Instead, they use special private interfaces that skip recursive locking and ensure we take a lock twice.

Definition at line 43 of file KoColorSpaceRegistry.cpp.

Member Typedef Documentation

◆ CustomProfileNameAlias

using KoColorSpaceRegistry::CustomProfileNameAlias = QHash<QString, QString>

Create a color profile from a memory array, if possible, otherwise return 0. If there is an existing profile with the same name, it will be used instead, and the binary data from rawData will be ignored

Definition at line 135 of file KoColorSpaceRegistry.h.

Member Enumeration Documentation

◆ ColorSpaceListProfilesSelection

enum KoColorSpaceRegistry::ColorSpaceListProfilesSelection

Enumerator
OnlyDefaultProfile	Only add the default profile.
AllProfiles	Add all profiles.

Definition at line 62 of file KoColorSpaceRegistry.h.

                                         {
        OnlyDefaultProfile = 1, 
        AllProfiles = 4 
    };

◆ ColorSpaceListVisibility

enum KoColorSpaceRegistry::ColorSpaceListVisibility

Enumerator
OnlyUserVisible	Only user visible color space.
AllColorSpaces	All color space even those not visible to the user.

Definition at line 58 of file KoColorSpaceRegistry.h.

                                  {
        OnlyUserVisible = 1, 
        AllColorSpaces = 4 
    };

Constructor & Destructor Documentation

◆ KoColorSpaceRegistry() [1/2]

KoColorSpaceRegistry::KoColorSpaceRegistry ( )

Definition at line 199 of file KoColorSpaceRegistry.cpp.

                                           : d(new Private(this))
{
    d->colorConversionSystem = nullptr;
    d->colorConversionCache = nullptr;
}

References d.

◆ ~KoColorSpaceRegistry()

KoColorSpaceRegistry::~KoColorSpaceRegistry ( )

virtual

Definition at line 205 of file KoColorSpaceRegistry.cpp.

{
    delete d->colorConversionSystem;
    d->colorConversionSystem = nullptr;
 
    Q_FOREACH (const KoColorSpace * cs, d->csMap) {
        cs->d->deletability = OwnedByRegistryRegistryDeletes;
        delete cs;
    }
    d->csMap.clear();
 
    // deleting colorspaces calls a function in the cache
    delete d->colorConversionCache;
    d->colorConversionCache = nullptr;
 
    // Delete the colorspace factories
    Q_FOREACH(KoColorSpaceFactory *f, d->colorSpaceFactoryRegistry.values()) {
        d->colorSpaceFactoryRegistry.remove(f->id());
        delete f;
    }
    Q_FOREACH(KoColorSpaceFactory *f, d->colorSpaceFactoryRegistry.doubleEntries()) {
        delete f;
    }
 
    delete d;
}

References KoColorSpace::d, d, and OwnedByRegistryRegistryDeletes.

◆ KoColorSpaceRegistry() [2/2]

KoColorSpaceRegistry::KoColorSpaceRegistry ( const KoColorSpaceRegistry & )

private

Member Function Documentation

◆ add()

void KoColorSpaceRegistry::add ( KoColorSpaceFactory * item )

add a color space to the registry

Parameters

item	the color space factory to add

Definition at line 232 of file KoColorSpaceRegistry.cpp.

{
    {
        QReadLocker l(&d->registrylock);
        auto connectionProfileRequests = d->colorConversionSystem->requiredConnectionProfilesFor(item);
 
        // the actual connection profiles should be added without any lock held
        l.unlock();
 
        for (auto it = connectionProfileRequests.begin(); it != connectionProfileRequests.end(); ++it) {
            const KoColorProfile *profile = this->profileFor(*it, true); // auto-generate all the required profiles
            KIS_SAFE_ASSERT_RECOVER_NOOP(profile);
        }
    }
 
    QWriteLocker l(&d->registrylock);
    d->colorSpaceFactoryRegistry.add(item);
    d->colorConversionSystem->insertColorSpace(item);
}

References d, KIS_SAFE_ASSERT_RECOVER_NOOP, and profileFor().

◆ addProfile() [1/2]

void KoColorSpaceRegistry::addProfile ( const KoColorProfile * profile )

Definition at line 355 of file KoColorSpaceRegistry.cpp.

{
    addProfile(profile->clone());
}

References addProfile(), and KoColorProfile::clone().

◆ addProfile() [2/2]

void KoColorSpaceRegistry::addProfile ( KoColorProfile * profile )

register the profile with the color space registry

Parameters

profile the new profile to be registered so it can be combined with colorspaces.

Definition at line 330 of file KoColorSpaceRegistry.cpp.

{
    if (!p->valid()) return;
 
    {
        QReadLocker l(&d->registrylock);
        auto connectionProfileRequests = d->colorConversionSystem->requiredConnectionProfilesFor(p);
 
        // the actual connection profiles should be added without any lock held
        l.unlock();
 
        for (auto it = connectionProfileRequests.begin(); it != connectionProfileRequests.end(); ++it) {
            const KoColorProfile *profile = this->profileFor(*it, true); // auto-generate all the required profiles
            KIS_SAFE_ASSERT_RECOVER_NOOP(profile);
        }
 
    }
 
    QWriteLocker locker(&d->registrylock);
    if (p->valid()) {
        addProfileToMap(p);
        d->colorConversionSystem->insertColorProfile(p);
    }
}

References addProfileToMap(), d, KIS_SAFE_ASSERT_RECOVER_NOOP, p, and profileFor().

◆ addProfileAlias()

void KoColorSpaceRegistry::addProfileAlias	(	const QString &	name,
		const QString &	to )

Create an alias to a profile with a different name. Then profileByName will return the profile to when passed name as a parameter.

Aliases are considered 'weak'. If a real profile with the name name is present (or added), it shadows the existing alias. If such an explicit profile gets removed, then the alias takes its place again.

Definition at line 271 of file KoColorSpaceRegistry.cpp.

{
    d->profileStorage.addProfileAlias(name, to);
}

References d.

◆ addProfileToMap()

void KoColorSpaceRegistry::addProfileToMap ( KoColorProfile * p )

Add a profile to the profile map but do not add it to the color conversion system yet.

Parameters

profile the new profile to be registered.

Definition at line 325 of file KoColorSpaceRegistry.cpp.

{
    d->profileStorage.addProfile(p);
}

References d, and p.

◆ allColorSpaces()

QList< const KoColorSpace * > KoColorSpaceRegistry::allColorSpaces	(	ColorSpaceListVisibility	visibility,
		ColorSpaceListProfilesSelection	pSelection )

private

Returns: a list with an instance of all color space with their default profile.

Definition at line 1032 of file KoColorSpaceRegistry.cpp.

{
    QList<const KoColorSpace*> colorSpaces;
 
    // TODO: thread-unsafe code: the factories might change right after the lock in released
    // HINT: used in a unittest only!
 
    d->registrylock.lockForRead();
    QList<KoColorSpaceFactory*> factories = d->colorSpaceFactoryRegistry.values();
    d->registrylock.unlock();
 
    Q_FOREACH (KoColorSpaceFactory* factory, factories) {
        // Don't test with ycbcr for now, since we don't have a default profile for it.
        if (factory->colorModelId().id().startsWith("Y")) continue;
        if (visibility == AllColorSpaces || factory->userVisible()) {
            if (pSelection == OnlyDefaultProfile) {
                const KoColorSpace *cs = d->colorSpace1(factory->id());
                if (cs) {
                    colorSpaces.append(cs);
                }
                else {
                    warnPigment << "Could not create colorspace for id" << factory->id() << "since there is no working default profile";
                }
            } else {
                QList<const KoColorProfile*> profiles = KoColorSpaceRegistry::instance()->profilesFor(factory->id());
                Q_FOREACH (const KoColorProfile * profile, profiles) {
                    const KoColorSpace *cs = d->colorSpace1(factory->id(), profile);
                    if (cs) {
                        colorSpaces.append(cs);
                    }
                    else {
                        warnPigment << "Could not create colorspace for id" << factory->id() << "and profile" << profile->name();
                    }
                }
            }
        }
    }
 
    return colorSpaces;
}

References AllColorSpaces, KoColorSpaceFactory::colorModelId(), d, KoID::id(), KoColorSpaceFactory::id(), instance(), KoColorProfile::name, OnlyDefaultProfile, profilesFor(), KoColorSpaceFactory::userVisible(), and warnPigment.

◆ alpha16()

const KoColorSpace * KoColorSpaceRegistry::alpha16 ( )

Definition at line 575 of file KoColorSpaceRegistry.cpp.

{
    if (!d->alphaU16Cs) {
        d->alphaU16Cs = d->colorSpace1(KoAlphaU16ColorSpace::colorSpaceId());
    }
    Q_ASSERT(d->alphaU16Cs);
    return d->alphaU16Cs;
}

References KoAlphaColorSpaceImpl< _CSTrait >::colorSpaceId(), and d.

◆ alpha32f()

const KoColorSpace * KoColorSpaceRegistry::alpha32f ( )

Definition at line 595 of file KoColorSpaceRegistry.cpp.

{
    if (!d->alphaF32Cs) {
        d->alphaF32Cs = d->colorSpace1(KoAlphaF32ColorSpace::colorSpaceId());
    }
    Q_ASSERT(d->alphaF32Cs);
    return d->alphaF32Cs;
}

References KoAlphaColorSpaceImpl< _CSTrait >::colorSpaceId(), and d.

◆ alpha8()

const KoColorSpace * KoColorSpaceRegistry::alpha8 ( )

Convenience methods to get the often used alpha colorspaces

Definition at line 566 of file KoColorSpaceRegistry.cpp.

{
    if (!d->alphaCs) {
        d->alphaCs = d->colorSpace1(KoAlphaColorSpace::colorSpaceId());
    }
    Q_ASSERT(d->alphaCs);
    return d->alphaCs;
}

References KoAlphaColorSpaceImpl< _CSTrait >::colorSpaceId(), and d.

◆ colorConversionCache()

KoColorConversionCache * KoColorSpaceRegistry::colorConversionCache ( ) const

Returns: the cache of color conversion transformation to be use by KoColorSpace

◆ colorConversionSystem()

const KoColorConversionSystem * KoColorSpaceRegistry::colorConversionSystem ( ) const

private

Returns: the color conversion system use by the registry and the color spaces to create color conversion transformation.

WARNING: conversion system is guarded by the registry locks, don't use it anywhere other than unittests!

◆ colorDepthList() [1/2]

QList< KoID > KoColorSpaceRegistry::colorDepthList	(	const KoID &	colorModelId,
		ColorSpaceListVisibility	option ) const

Returns: the list of available color models for the given colorModelId

Definition at line 893 of file KoColorSpaceRegistry.cpp.

{
    return colorDepthList(colorModelId.id(), option);
}

References colorDepthList(), and KoID::id().

◆ colorDepthList() [2/2]

QList< KoID > KoColorSpaceRegistry::colorDepthList	(	const QString &	colorModelId,
		ColorSpaceListVisibility	option ) const

Returns: the list of available color models for the given colorModelId

Definition at line 899 of file KoColorSpaceRegistry.cpp.

{
    QReadLocker l(&d->registrylock);
 
    QList<KoID> ids;
    QList<KoColorSpaceFactory*> factories = d->colorSpaceFactoryRegistry.values();
    Q_FOREACH (KoColorSpaceFactory* factory, factories) {
        if (!ids.contains(KoID(factory->colorDepthId()))
                && factory->colorModelId().id() == colorModelId
                && (option == AllColorSpaces || factory->userVisible())) {
            ids << factory->colorDepthId();
        }
    }
    QList<KoID> r;
 
    if (ids.contains(Integer8BitsColorDepthID)) r << Integer8BitsColorDepthID;
    if (ids.contains(Integer16BitsColorDepthID)) r << Integer16BitsColorDepthID;
    if (ids.contains(Float16BitsColorDepthID)) r << Float16BitsColorDepthID;
    if (ids.contains(Float32BitsColorDepthID)) r << Float32BitsColorDepthID;
    if (ids.contains(Float64BitsColorDepthID)) r << Float64BitsColorDepthID;
 
    return r;
}

References AllColorSpaces, KoColorSpaceFactory::colorDepthId(), KoColorSpaceFactory::colorModelId(), d, Float16BitsColorDepthID, Float32BitsColorDepthID, Float64BitsColorDepthID, KoID::id(), Integer16BitsColorDepthID, Integer8BitsColorDepthID, and KoColorSpaceFactory::userVisible().

◆ colorModelsList()

QList< KoID > KoColorSpaceRegistry::colorModelsList ( ColorSpaceListVisibility option ) const

Returns: the list of available color models

Definition at line 879 of file KoColorSpaceRegistry.cpp.

{
    QReadLocker l(&d->registrylock);
 
    QList<KoID> ids;
    QList<KoColorSpaceFactory*> factories = d->colorSpaceFactoryRegistry.values();
    Q_FOREACH (KoColorSpaceFactory* factory, factories) {
        if (!ids.contains(factory->colorModelId())
                && (option == AllColorSpaces || factory->userVisible())) {
            ids << factory->colorModelId();
        }
    }
    return ids;
}

References AllColorSpaces, KoColorSpaceFactory::colorModelId(), d, and KoColorSpaceFactory::userVisible().

◆ colorSpace() [1/3]

const KoColorSpace * KoColorSpaceRegistry::colorSpace	(	const QString &	colorModelId,
		const QString &	colorDepthId )

Definition at line 312 of file KoColorSpaceRegistry.cpp.

{
    return d->colorSpace1(colorSpaceId(colorModelId, colorDepthId));
}

References colorSpaceId(), and d.

◆ colorSpace() [2/3]

const KoColorSpace * KoColorSpaceRegistry::colorSpace	(	const QString &	colorModelId,
		const QString &	colorDepthId,
		const KoColorProfile *	profile )

Return a colorspace that works with the parameter profile.

Parameters

colorSpaceId	the ID string of the colorspace that you want to have returned
profile	the profile be combined with the colorspace

Returns: the wanted colorspace, or 0 when the cs and profile can not be combined.

Definition at line 302 of file KoColorSpaceRegistry.cpp.

{
    return d->colorSpace1(colorSpaceId(colorModelId, colorDepthId), profile);
}

References colorSpaceId(), and d.

◆ colorSpace() [3/3]

const KoColorSpace * KoColorSpaceRegistry::colorSpace	(	const QString &	colorModelId,
		const QString &	colorDepthId,
		const QString &	profileName )

Return a colorspace that works with the parameter profile.

Parameters

profileName the name of the KoColorProfile to be combined with the colorspace

Returns: the wanted colorspace, or 0 when the cs and profile can not be combined.

Definition at line 307 of file KoColorSpaceRegistry.cpp.

{
    return d->colorSpace1(colorSpaceId(colorModelId, colorDepthId), profileName);
}

References colorSpaceId(), and d.

◆ colorSpace1() [1/2]

const KoColorSpace * KoColorSpaceRegistry::colorSpace1	(	const QString &	colorSpaceId,
		const KoColorProfile *	profile )

Return a colorspace that works with the parameter profile.

Parameters

colorSpaceId	the ID string of the colorspace that you want to have returned
profile	the profile be combined with the colorspace

Returns: the wanted colorspace, or 0 when the cs and profile can not be combined.

◆ colorSpace1() [2/2]

template<class LockPolicy = NormalLockPolicy>

const KoColorSpace * KoColorSpaceRegistry::colorSpace1	(	const QString &	colorSpaceId,
		const QString &	pName = QString() )

Return a colorspace that works with the parameter profile.

Parameters

profileName the name of the KoColorProfile to be combined with the colorspace

Returns: the wanted colorspace, or 0 when the cs and profile can not be combined.

◆ colorSpaceColorDepthId()

KoID KoColorSpaceRegistry::colorSpaceColorDepthId ( const QString & _colorSpaceId ) const

Returns: the identifier of the color depth for the given color space id.

This function is a compatibility function used to get the color space from all kra files.

Definition at line 956 of file KoColorSpaceRegistry.cpp.

{
    QReadLocker l(&d->registrylock);
 
    KoColorSpaceFactory* factory = d->colorSpaceFactoryRegistry.get(_colorSpaceId);
    if (factory) {
        return factory->colorDepthId();
    } else {
        return KoID();
    }
}

References KoColorSpaceFactory::colorDepthId(), and d.

◆ colorSpaceColorModelId()

KoID KoColorSpaceRegistry::colorSpaceColorModelId ( const QString & _colorSpaceId ) const

Returns: the identifier of the color model for the given color space id.

This function is a compatibility function used to get the color space from all kra files.

Definition at line 944 of file KoColorSpaceRegistry.cpp.

{
    QReadLocker l(&d->registrylock);
 
    KoColorSpaceFactory* factory = d->colorSpaceFactoryRegistry.get(_colorSpaceId);
    if (factory) {
        return factory->colorModelId();
    } else {
        return KoID();
    }
}

References KoColorSpaceFactory::colorModelId(), and d.

◆ colorSpaceId() [1/2]

QString KoColorSpaceRegistry::colorSpaceId	(	const KoID &	colorModelId,
		const KoID &	colorDepthId ) const

It's a convenient function that behave like the above. Return the id of the colorspace that have the defined colorModelId with colorDepthId.

Parameters

colorModelId	id of the color model
colorDepthId	id of the color depth

Returns: the id of the wanted colorspace, or "" if no colorspace correspond to those ids

Definition at line 939 of file KoColorSpaceRegistry.cpp.

{
    return colorSpaceId(colorModelId.id(), colorDepthId.id());
}

References colorSpaceId(), and KoID::id().

◆ colorSpaceId() [2/2]

QString KoColorSpaceRegistry::colorSpaceId	(	const QString &	colorModelId,
		const QString &	colorDepthId ) const

Return the id of the colorspace that have the defined colorModelId with colorDepthId.

Parameters

colorModelId	id of the color model
colorDepthId	id of the color depth

Returns: the id of the wanted colorspace, or "" if no colorspace correspond to those ids

Definition at line 933 of file KoColorSpaceRegistry.cpp.

{
    QReadLocker l(&d->registrylock);
    return d->colorSpaceIdImpl(colorModelId, colorDepthId);
}

References d.

◆ colorSpaceIdImpl()

QString KoColorSpaceRegistry::colorSpaceIdImpl	(	const QString &	colorModelId,
		const QString &	colorDepthId ) const

◆ createColorConverter()

KoColorConversionTransformation * KoColorSpaceRegistry::createColorConverter	(	const KoColorSpace *	srcColorSpace,
		const KoColorSpace *	dstColorSpace,
		KoColorConversionTransformation::Intent	renderingIntent,
		KoColorConversionTransformation::ConversionFlags	conversionFlags ) const

This function is called by the color space to create a color conversion between two color space. This function search in the graph of transformations the best possible path between the two color space.

Definition at line 388 of file KoColorSpaceRegistry.cpp.

{
    QWriteLocker l(&d->registrylock);
    return d->colorConversionSystem->createColorConverter(srcColorSpace, dstColorSpace, renderingIntent, conversionFlags);
}

References d.

◆ createColorConverters()

void KoColorSpaceRegistry::createColorConverters	(	const KoColorSpace *	colorSpace,
		const QList< QPair< KoID, KoID > > &	possibilities,
		KoColorConversionTransformation *&	fromCS,
		KoColorConversionTransformation *&	toCS ) const

This function creates two transformations, one from the color space and one to the color space. The destination color space is picked from a list of color space, such as the conversion between the two color space is of the best quality.

The typical use case of this function is for KoColorTransformationFactory which doesn't support all color spaces, so unsupported color space have to find an acceptable conversion in order to use that KoColorTransformationFactory.

Parameters

colorSpace	the source color space
possibilities	a list of color space among which we need to find the best conversion
fromCS	the conversion from the source color space will be affected to this variable
toCS	the revert conversion to the source color space will be affected to this variable

Definition at line 394 of file KoColorSpaceRegistry.cpp.

{
    QWriteLocker l(&d->registrylock);
    d->colorConversionSystem->createColorConverters(colorSpace, possibilities, fromCS, toCS);
}

References colorSpace(), and d.

◆ createColorProfile() [1/2]

const KoColorProfile * KoColorSpaceRegistry::createColorProfile	(	const QString &	colorModelId,
		const QString &	colorDepthId,
		const QByteArray &	rawData )

create a profile of the specified type.

Definition at line 1003 of file KoColorSpaceRegistry.cpp.

{
    return createColorProfile(colorModelId, colorDepthId, rawData, {});
}

References createColorProfile().

◆ createColorProfile() [2/2]

const KoColorProfile * KoColorSpaceRegistry::createColorProfile	(	const QString &	colorModelId,
		const QString &	colorDepthId,
		const QByteArray &	rawData,
		CustomProfileNameAlias	customProfileNameAlias )

Definition at line 1008 of file KoColorSpaceRegistry.cpp.

{
    QReadLocker l(&d->registrylock);
 
    KoColorSpaceFactory* factory_ = d->colorSpaceFactoryRegistry.get(d->colorSpaceIdImpl(colorModelId, colorDepthId));
    std::unique_ptr<KoColorProfile> profile(factory_->createColorProfile(rawData));
 
    l.unlock();
 
    if (profile && profile->valid()) {
        const QString effectiveProfileName = customProfileNameAlias.value(profile->name(), profile->name());
        if (const KoColorProfile* existingProfile = profileByName(effectiveProfileName)) {
            return existingProfile;
        }
 
        const KoColorProfile *constProfile = profile.get();
        this->addProfile(profile.release());
 
        return constProfile;
    }
 
    return nullptr;
}

References addProfile(), KoColorSpaceFactory::createColorProfile(), d, and profileByName().

◆ defaultProfileForColorSpace()

QString KoColorSpaceRegistry::defaultProfileForColorSpace ( const QString & colorSpaceId ) const

Definition at line 382 of file KoColorSpaceRegistry.cpp.

{
    QReadLocker l(&d->registrylock);
    return d->defaultProfileForCsIdImpl(colorSpaceId);
}

References colorSpaceId(), and d.

◆ defaultProfileForCsIdImpl()

QString KoColorSpaceRegistry::defaultProfileForCsIdImpl ( const QString & csID )

◆ getCachedColorSpaceImpl()

const KoColorSpace * KoColorSpaceRegistry::getCachedColorSpaceImpl	(	const QString &	csId,
		const QString &	profileName ) const

The function checks if a colorspace with a certain id and profile name can be found in the cache NOTE: the function doesn't take any lock but it needs to be called inside a d->registryLock locked either in read or write.

Parameters

csId	The colorspace id
profileName	The colorspace profile name

Return values

KoColorSpace	The matching colorspace
0	Null pointer if not match

◆ graya16() [1/2]

const KoColorSpace * KoColorSpaceRegistry::graya16 ( const KoColorProfile * profile )

Convenience method to get a GRAYA 16 bit colorspace. If a profile is not specified, the default profile defined in the GRAY colorspace will be used

Parameters

the profile

Returns: an 8 bit graya colorspace with the default profile or 0.

Definition at line 640 of file KoColorSpaceRegistry.cpp.

{
    if (!profile) {
        return graya16();
    }
    else {
        return KoColorSpaceRegistry::instance()->colorSpace(GrayAColorModelID.id(), Integer16BitsColorDepthID.id(), profile);
    }
}

References colorSpace(), graya16(), GrayAColorModelID, KoID::id(), instance(), and Integer16BitsColorDepthID.

◆ graya16() [2/2]

const KoColorSpace * KoColorSpaceRegistry::graya16 ( const QString & profile = QString() )

Convenience method to get a GRAYA 16 bit colorspace. If a profile is not specified, the default profile defined in the GRAY colorspace will be used

Parameters

the profile

Returns: an 8 bit graya colorspace with the default profile or 0.

Definition at line 628 of file KoColorSpaceRegistry.cpp.

{
    if (profile.isEmpty()) {
        KoColorSpaceFactory* factory = d->colorSpaceFactoryRegistry.get(GrayAColorModelID.id());
        return KoColorSpaceRegistry::instance()->colorSpace(GrayAColorModelID.id(), Integer16BitsColorDepthID.id(), factory->defaultProfile());
    }
    else {
        return KoColorSpaceRegistry::instance()->colorSpace(GrayAColorModelID.id(), Integer16BitsColorDepthID.id(), profile);
    }
 
}

References colorSpace(), d, KoColorSpaceFactory::defaultProfile(), GrayAColorModelID, KoID::id(), instance(), and Integer16BitsColorDepthID.

◆ graya8() [1/2]

const KoColorSpace * KoColorSpaceRegistry::graya8 ( const KoColorProfile * profile )

Convenience method to get a GRAYA 8 bit colorspace. If a profile is not specified, the default profile defined in the GRAY colorspace will be used

Parameters

profile the profile

Returns: an 8 bit graya colorspace with the default profile or 0.

Definition at line 617 of file KoColorSpaceRegistry.cpp.

{
    if (!profile) {
        return graya8();
    }
    else {
        return KoColorSpaceRegistry::instance()->colorSpace(GrayAColorModelID.id(), Integer8BitsColorDepthID.id(), profile);
    }
 
}

References colorSpace(), graya8(), GrayAColorModelID, KoID::id(), instance(), and Integer8BitsColorDepthID.

◆ graya8() [2/2]

const KoColorSpace * KoColorSpaceRegistry::graya8 ( const QString & profile = QString() )

Convenience method to get a GRAYA 8 bit colorspace. If a profile is not specified, the default profile defined in the GRAY colorspace will be used

Parameters

profile the profile name

Returns: an 8 bit graya colorspace with the default profile or 0.

Definition at line 604 of file KoColorSpaceRegistry.cpp.

{
 
    if (profile.isEmpty()) {
        KoColorSpaceFactory* factory = d->colorSpaceFactoryRegistry.get(GrayAColorModelID.id());
        return KoColorSpaceRegistry::instance()->colorSpace(GrayAColorModelID.id(), Integer8BitsColorDepthID.id(), factory->defaultProfile());
    }
    else {
        return KoColorSpaceRegistry::instance()->colorSpace(GrayAColorModelID.id(), Integer8BitsColorDepthID.id(), profile);
    }
 
}

References colorSpace(), d, KoColorSpaceFactory::defaultProfile(), GrayAColorModelID, KoID::id(), instance(), and Integer8BitsColorDepthID.

◆ idsToCacheName()

QString KoColorSpaceRegistry::idsToCacheName	(	const QString &	csId,
		const QString &	profileName ) const

◆ init()

void KoColorSpaceRegistry::init ( )

private

Definition at line 146 of file KoColorSpaceRegistry.cpp.

{
    d->rgbU8sRGB = 0;
    d->lab16sLAB = 0;
    d->alphaCs = 0;
    d->alphaU16Cs = 0;
#ifdef HAVE_OPENEXR
    d->alphaF16Cs = 0;
#endif
    d->alphaF32Cs = 0;
 
    d->conversionSystemInterface.reset(new Private::ConversionSystemInterface(this));
    d->colorConversionSystem = new KoColorConversionSystem(d->conversionSystemInterface.data());
    d->colorConversionCache = new KoColorConversionCache;
 
    KoColorSpaceEngineRegistry::instance()->add(new KoSimpleColorSpaceEngine());
 
    addProfile(new KoDummyColorProfile);
 
    // Create the built-in colorspaces
    QList<KoColorSpaceFactory *> localFactories;
    localFactories
            << new KoAlphaColorSpaceFactory()
            << new KoAlphaU16ColorSpaceFactory()
           #ifdef HAVE_OPENEXR
            << new KoAlphaF16ColorSpaceFactory()
           #endif
            << new KoAlphaF32ColorSpaceFactory()
            << new KoLabColorSpaceFactory()
            << new KoRgbU8ColorSpaceFactory()
            << new KoRgbU16ColorSpaceFactory();
 
    Q_FOREACH (KoColorSpaceFactory *factory, localFactories) {
        add(factory);
    }
 
    KoPluginLoader::PluginsConfig config;
    config.blacklist = "ColorSpacePluginsDisabled";
    config.group = "krita";
    KoPluginLoader::instance()->load("Krita/ColorSpace", config);
 
    KoPluginLoader::PluginsConfig configExtensions;
    configExtensions.blacklist = "ColorSpaceExtensionsPluginsDisabled";
    configExtensions.group = "krita";
    KoPluginLoader::instance()->load("Krita/ColorSpaceExtension", configExtensions);
 
 
    dbgPigment << "Loaded the following colorspaces:";
    Q_FOREACH (const KoID& id, listKeys()) {
        dbgPigment << "\t" << id.id() << "," << id.name();
    }
}

References add(), KoGenericRegistry< T >::add(), addProfile(), KoPluginLoader::PluginsConfig::blacklist, d, dbgPigment, KoPluginLoader::PluginsConfig::group, KoPluginLoader::instance(), KoColorSpaceEngineRegistry::instance(), listKeys(), and KoPluginLoader::load().

◆ instance()

KoColorSpaceRegistry * KoColorSpaceRegistry::instance ( )

static

Return an instance of the KoColorSpaceRegistry Creates an instance if that has never happened before and returns the singleton instance.

Definition at line 137 of file KoColorSpaceRegistry.cpp.

{
    if (!s_instance.exists()) {
        s_instance->init();
    }
    return s_instance;
}

References init().

◆ lab16() [1/2]

const KoColorSpace * KoColorSpaceRegistry::lab16 ( const KoColorProfile * profile )

Convenience method to get an Lab 16bit colorspace with the given profile.

Parameters

profile an Lab profile

Returns: the wanted colorspace, or 0 if the color space and profile can not be combined.

Definition at line 696 of file KoColorSpaceRegistry.cpp.

{
    if (profile == 0) {
        if (!d->lab16sLAB) {
            d->lab16sLAB = d->colorSpace1(KoLabColorSpace::colorSpaceId());
        }
        Q_ASSERT(d->lab16sLAB);
        return d->lab16sLAB;
    }
    return d->colorSpace1(KoLabColorSpace::colorSpaceId(), profile);
}

References KoLabColorSpace::colorSpaceId(), and d.

◆ lab16() [2/2]

const KoColorSpace * KoColorSpaceRegistry::lab16 ( const QString & profileName = QString() )

Convenience method to get an Lab 16bit colorspace. If a profile is not specified, an Lab profile with a D50 whitepoint will be used.

Parameters

profileName the name of an Lab color profile

Returns: the wanted colorspace, or 0 if the color space and profile can not be combined.

Definition at line 685 of file KoColorSpaceRegistry.cpp.

{
    if (profileName.isEmpty()) {
        if (!d->lab16sLAB) {
            d->lab16sLAB = d->colorSpace1(KoLabColorSpace::colorSpaceId());
        }
        return d->lab16sLAB;
    }
    return d->colorSpace1(KoLabColorSpace::colorSpaceId(), profileName);
}

References KoLabColorSpace::colorSpaceId(), and d.

◆ lazyCreateColorSpaceImpl()

const KoColorSpace * KoColorSpaceRegistry::lazyCreateColorSpaceImpl	(	const QString &	csID,
		const KoColorProfile *	profile )

◆ listKeys()

QList< KoID > KoColorSpaceRegistry::listKeys ( ) const

This function return a list of all the keys in KoID format by using the name() method on the objects stored in the registry.

Definition at line 992 of file KoColorSpaceRegistry.cpp.

{
    QReadLocker l(&d->registrylock);
    QList<KoID> answer;
    Q_FOREACH (const QString& key, d->colorSpaceFactoryRegistry.keys()) {
        answer.append(KoID(key, d->colorSpaceFactoryRegistry.get(key)->name()));
    }
 
    return answer;
}

References d.

◆ operator=()

KoColorSpaceRegistry KoColorSpaceRegistry::operator= ( const KoColorSpaceRegistry & )

private

◆ p2020G10Profile()

const KoColorProfile * KoColorSpaceRegistry::p2020G10Profile ( ) const

Convenience method to get a standard profile for Rec.2020 linear light color space

Definition at line 708 of file KoColorSpaceRegistry.cpp.

{
    return profileByName("Rec2020-elle-V4-g10.icc");
}

References profileByName().

◆ p2020PQProfile()

const KoColorProfile * KoColorSpaceRegistry::p2020PQProfile ( ) const

Convenience method to get a standard profile for Rec.2020 PQ color space

Definition at line 713 of file KoColorSpaceRegistry.cpp.

{
    return profileByName("Krita Rec. 2100 Perceptual Quantizer (203cd/m²)");
}

References profileByName().

◆ p709G10Profile()

const KoColorProfile * KoColorSpaceRegistry::p709G10Profile ( ) const

Convenience method to get a standard profile for Rec. 709 linear light color space

Definition at line 718 of file KoColorSpaceRegistry.cpp.

{
    return profileByName("sRGB-elle-V2-g10.icc");
}

References profileByName().

◆ p709SRGBProfile()

const KoColorProfile * KoColorSpaceRegistry::p709SRGBProfile ( ) const

Convenience method to get a standard profile for Rec. 709 sRGB-tone- response-curve profile

Definition at line 723 of file KoColorSpaceRegistry.cpp.

{
    return profileByName("sRGB-elle-V2-srgbtrc.icc");
}

References profileByName().

◆ permanentColorspace()

const KoColorSpace * KoColorSpaceRegistry::permanentColorspace ( const KoColorSpace * _colorSpace )

Returns: a permanent colorspace owned by the registry, of the same type and profile as the one given in argument

Definition at line 978 of file KoColorSpaceRegistry.cpp.

{
    if (_colorSpace->d->deletability != NotOwnedByRegistry) {
        return _colorSpace;
    } else if (*_colorSpace == *d->alphaCs) {
        return d->alphaCs;
    } else {
        const KoColorSpace* cs = d->colorSpace1(_colorSpace->id(), _colorSpace->profile());
        Q_ASSERT(cs);
        Q_ASSERT(*cs == *_colorSpace);
        return cs;
    }
}

References KoColorSpace::d, d, KoColorSpace::id, NotOwnedByRegistry, and KoColorSpace::profile().

◆ Private()

KoColorSpaceRegistry::Private ( KoColorSpaceRegistry * _q )

inline

Definition at line 49 of file KoColorSpaceRegistry.cpp.

49: q(_q) {}

KoColorSpaceRegistry::q

KoColorSpaceRegistry * q

Definition KoColorSpaceRegistry.cpp:51

◆ profileAlias()

QString KoColorSpaceRegistry::profileAlias ( const QString & name ) const

Returns: the profile alias, or name if not aliased

Definition at line 281 of file KoColorSpaceRegistry.cpp.

{
    return d->profileStorage.profileAlias(name);
}

References d.

◆ profileByName()

const KoColorProfile * KoColorSpaceRegistry::profileByName ( const QString & name ) const

Return a profile by its given name, or 0 if none registered.

Returns: a profile by its given name, or 0 if none registered.

Parameters

name	the product name as set on the profile.

See also: addProfile(); KoColorProfile::productName()

Definition at line 286 of file KoColorSpaceRegistry.cpp.

{
    return d->profileStorage.profileByName(name);
}

References d.

◆ profileByUniqueId()

const KoColorProfile * KoColorSpaceRegistry::profileByUniqueId ( const QByteArray & id ) const

Returns a profile by its unique id stored/calculated in the header. The first call to this function might take long, because the map is created on the first use only (atm used by SVG only)

Parameters

id	unique ProfileID of the profile (MD5 sum of its header)

Returns: the profile or 0 if not found

Definition at line 291 of file KoColorSpaceRegistry.cpp.

{
    return d->profileStorage.profileByUniqueId(id);
}

References d.

◆ profileFor()

const KoColorProfile * KoColorSpaceRegistry::profileFor	(	const KoColorProfileQuery &	query,
		const bool	generate = true ) const

profileFor tries to find the profile that matches these characteristics, if no such profile is found, it attempts to generate one.

Parameters

query	– profile characteristics to get the profile for.
generate	– whether to try to generate a profile if no match was found.

Returns: a profile that matches these characteristics.

Definition at line 728 of file KoColorSpaceRegistry.cpp.

{
    // We're currently disabling on-the-fly generation of PQ profiles, because it can cause
    // some issues with inconsistent hdr-reference-white value, i.e. the user of this
    // code may get nits value he/she didn't expect
    return profileForInternal(query, generate && query.transfer != TRC_ITU_R_BT_2100_0_PQ);
}

References profileForInternal(), KoColorProfileQuery::transfer, and TRC_ITU_R_BT_2100_0_PQ.

◆ profileForCsIdWithFallbackImpl()

const KoColorProfile * KoColorSpaceRegistry::profileForCsIdWithFallbackImpl	(	const QString &	csID,
		const QString &	profileName )

◆ profileForInternal()

const KoColorProfile * KoColorSpaceRegistry::profileForInternal	(	const KoColorProfileQuery &	query,
		const bool	generate ) const

private

Definition at line 736 of file KoColorSpaceRegistry.cpp.

{
    if (query.primaries == PRIMARIES_ITU_R_BT_709_5) {
        if (query.transfer == TRC_IEC_61966_2_1) {
            return p709SRGBProfile();
        } else if (query.transfer == TRC_LINEAR) {
            return p709G10Profile();
        }
    }
 
    if (query.primaries == PRIMARIES_ITU_R_BT_2020_2_AND_2100_0) {
        if (query.transfer == TRC_ITU_R_BT_2100_0_PQ
            && query.hdrReferenceWhite
            && qFuzzyCompare(*query.hdrReferenceWhite, 203.0)) {
            return p2020PQProfile();
        } else if (query.transfer == TRC_LINEAR) {
            return p2020G10Profile();
        }
    }
 
    QList<const KoColorProfile*> list = d->profileStorage.profilesFor(query);
    if (!list.empty()) {
        return list.first();
    }
 
    KoColorSpaceEngine *engine = KoColorSpaceEngineRegistry::instance()->get("icc");
 
    if (engine && generate) {
        return engine->getProfile(query);
    }
 
    return nullptr;
}

References d, KoGenericRegistry< T >::get(), KoColorSpaceEngine::getProfile(), KoColorProfileQuery::hdrReferenceWhite, KoColorSpaceEngineRegistry::instance(), p2020G10Profile(), p2020PQProfile(), p709G10Profile(), p709SRGBProfile(), KoColorProfileQuery::primaries, PRIMARIES_ITU_R_BT_2020_2_AND_2100_0, PRIMARIES_ITU_R_BT_709_5, KoColorProfileQuery::transfer, TRC_IEC_61966_2_1, TRC_ITU_R_BT_2100_0_PQ, and TRC_LINEAR.

◆ profileForQColorSpace()

const KoColorProfile * KoColorSpaceRegistry::profileForQColorSpace ( const QColorSpace & space )

profileForQColorSpace Find a KoColorProfile that matches a given QColorSpace. This will use the QColorSpace::IccProfile function as a last resort, preferring to use preexisting profiles in the registry.

Parameters

space – space to return the profile for.

Returns: A Profile for the given QColorSpace, may be null if nothing was found.

Definition at line 793 of file KoColorSpaceRegistry.cpp.

{
    if (!space.isValid()) return p709SRGBProfile();
    const KoColorProfile *profile = nullptr;
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
    ColorPrimaries primaries = mapQColorSpaceColorPrimaries.value(space.primaries(), PRIMARIES_UNSPECIFIED);
    TransferCharacteristics transfer = mapQColorSpaceColorTransfer.value(space.transferFunction(), TRC_UNSPECIFIED);
    if (space.transferFunction() == QColorSpace::TransferFunction::Gamma || (transfer == TRC_UNSPECIFIED && primaries == PRIMARIES_UNSPECIFIED)) {
        // load icc profile.
        QByteArray profileData = space.iccProfile();
        profile = createColorProfile(RGBAColorModelID.id(), Integer8BitsColorDepthID.id(), profileData);
    } else {
        QVector<double> colorants;
        profile = profileFor(KoColorProfileQuery(primaries, transfer));
    }
#else
    // We want to test RGB before testing wether we are dealing with a LUT, because we want to funnel rec2020 pq into loading our profile.
 
    if (space.colorModel() == QColorSpace::ColorModel::Rgb) {
        if (space.transferFunction() == QColorSpace::TransferFunction::Gamma) {
            // load icc profile.
            QByteArray profileData = space.iccProfile();
            profile = createColorProfile(RGBAColorModelID.id(), Integer8BitsColorDepthID.id(), profileData);
        }
        ColorPrimaries primaries = mapQColorSpaceColorPrimaries.value(space.primaries(), PRIMARIES_UNSPECIFIED);
        TransferCharacteristics transfer = mapQColorSpaceColorTransfer.value(space.transferFunction(), TRC_UNSPECIFIED);
        // In qt6.9 we can get the 'primary points'.
        if (!profile && (primaries != PRIMARIES_UNSPECIFIED) && transfer != TRC_UNSPECIFIED) {
            profile = profileFor(KoColorProfileQuery(primaries, transfer));
        }
    } else if (space.colorModel() == QColorSpace::ColorModel::Gray) {
        TransferCharacteristics transfer = mapQColorSpaceColorTransfer.value(space.transferFunction(), TRC_UNSPECIFIED);
        if (space.transferFunction() == QColorSpace::TransferFunction::Gamma) {
            QByteArray profileData = space.iccProfile();
            profile = createColorProfile(GrayAColorModelID.id(), Integer8BitsColorDepthID.id(), profileData);
 
        }
        QVector<double> colorants;
        KoColorProfileQuery query(PRIMARIES_UNSPECIFIED, transfer);
        query.whitePoint = {space.whitePoint().x(), space.whitePoint().y()};
        if (!profile && query.isValid()) {
            profile = profileFor(query);
        }
    }
#endif
    if (!profile) {
        // We might now have a non-qt supported colormodel. Let's load the raw data directly.
        KoColorSpaceEngine *engine = KoColorSpaceEngineRegistry::instance()->get("icc");
        if (engine) {
            QByteArray profileData = space.iccProfile();
            profile = engine->addProfile(profileData);
        }
    }
    if (profile) {
        const KoColorProfile *preExisting = profileByUniqueId(profile->uniqueId());
        if (!preExisting) {
            preExisting = profileByName(profile->name());
        }
        if (preExisting) {
            return preExisting;
        } else {
            addProfile(profile);
        }
    }
 
    return profile;
}

References KoColorSpaceEngine::addProfile(), addProfile(), createColorProfile(), KoGenericRegistry< T >::get(), GrayAColorModelID, KoID::id(), KoColorSpaceEngineRegistry::instance(), Integer8BitsColorDepthID, KoColorProfileQuery::isValid(), mapQColorSpaceColorPrimaries, mapQColorSpaceColorTransfer, KoColorProfile::name, p709SRGBProfile(), PRIMARIES_UNSPECIFIED, profileByName(), profileByUniqueId(), profileFor(), RGBAColorModelID, TRC_UNSPECIFIED, KoColorProfile::uniqueId(), KoColorProfileQuery::whitePoint, and KoColorimetryUtils::xy::x.

◆ profileIsCompatible()

bool KoColorSpaceRegistry::profileIsCompatible	(	const KoColorProfile *	profile,
		const QString &	colorSpaceId )

Definition at line 317 of file KoColorSpaceRegistry.cpp.

{
    QReadLocker l(&d->registrylock);
    KoColorSpaceFactory *csf = d->colorSpaceFactoryRegistry.value(colorSpaceId);
 
    return csf ? csf->profileIsCompatible(profile) : false;
}

References colorSpaceId(), d, and KoColorSpaceFactory::profileIsCompatible().

◆ profilesFor()

QList< const KoColorProfile * > KoColorSpaceRegistry::profilesFor ( const QString & csID ) const

Return the list of profiles for a colorspace with the argument id. Profiles will not work with any color space, you can query which profiles that are registered with this registry can be used in combination with the argument factory.

Parameters

colorSpaceId the colorspace-id with which all the returned profiles will work.

Returns: a list of profiles for the factory

Definition at line 296 of file KoColorSpaceRegistry.cpp.

{
    QReadLocker l(&d->registrylock);
    return d->profileStorage.profilesFor(d->colorSpaceFactoryRegistry.value(csID));
}

References d.

◆ QColorSpaceForProfile()

QColorSpace KoColorSpaceRegistry::QColorSpaceForProfile ( const KoColorProfile * profile ) const

QColorSpaceForProfile Generate a QColorSpace for the given KoColorProfile. Will return sRGB when the profile is null.

Parameters

profile – source profile

Returns: a QColorSpace loaded from the profile. May not be RGB!

Definition at line 861 of file KoColorSpaceRegistry.cpp.

{
    if (!profile) return QColorSpace(QColorSpace::SRgb);
    if (profile == p709SRGBProfile()) {
        return QColorSpace(QColorSpace::SRgb);
    }
#if QT_VERSION >= QT_VERSION_CHECK(6, 8, 0)
    if (profile == p2020PQProfile()
        || (profile->getColorPrimaries() == PRIMARIES_ITU_R_BT_2020_2_AND_2100_0
            && profile->getTransferCharacteristics() == TRC_ITU_R_BT_2100_0_PQ)) {
        return QColorSpace(QColorSpace::Bt2100Pq);
    }
    // TODO: we'll need to fine tune the conversion between non "rec 2100" pq profiles and qcolorspace.
    // Though, arguably, these probably don't show up in a QColorSpace way, and should roundtrip in the icc cicp values.
#endif
    return QColorSpace::fromIccProfile(profile->rawData());
}

References KoColorProfile::getColorPrimaries(), KoColorProfile::getTransferCharacteristics(), p2020PQProfile(), p709SRGBProfile(), PRIMARIES_ITU_R_BT_2020_2_AND_2100_0, KoColorProfile::rawData(), and TRC_ITU_R_BT_2100_0_PQ.

◆ remove()

void KoColorSpaceRegistry::remove ( KoColorSpaceFactory * item )

Remove a color space factory from the registry. Note that it is the responsibility of the caller to ensure that the colorspaces are not used anymore.

Definition at line 252 of file KoColorSpaceRegistry.cpp.

{
    QWriteLocker l(&d->registrylock);
 
    QList<QString> toremove;
    Q_FOREACH (const KoColorSpace * cs, d->csMap) {
        if (cs->id() == item->id()) {
            toremove.push_back(d->idsToCacheName(cs->id(), cs->profile()->name()));
            cs->d->deletability = OwnedByRegistryRegistryDeletes;
        }
    }
 
    Q_FOREACH (const QString& id, toremove) {
        d->csMap.remove(id);
        // TODO: should not it delete the color space when removing it from the map ?
    }
    d->colorSpaceFactoryRegistry.remove(item->id());
}

References KoColorSpace::d, d, KoColorSpace::id, KoColorSpaceFactory::id(), KoColorProfile::name, OwnedByRegistryRegistryDeletes, and KoColorSpace::profile().

◆ removeProfile()

void KoColorSpaceRegistry::removeProfile ( KoColorProfile * profile )

Definition at line 360 of file KoColorSpaceRegistry.cpp.

{
    d->profileStorage.removeProfile(profile);
    // FIXME: how about removing it from conversion system?
}

References d.

◆ removeProfileAlias()

void KoColorSpaceRegistry::removeProfileAlias ( const QString & name )

Remove profile alias name if exists

Definition at line 276 of file KoColorSpaceRegistry.cpp.

{
    d->profileStorage.removeProfileAlias(name);
}

References d.

◆ rgb16() [1/2]

const KoColorSpace * KoColorSpaceRegistry::rgb16 ( const KoColorProfile * profile )

Convenience method to get an RGBA 16bit colorspace with the given profile.

Parameters

profile an RGB profile

Returns: the wanted colorspace, or 0 if the color space and profile can not be combined.

Definition at line 680 of file KoColorSpaceRegistry.cpp.

{
    return d->colorSpace1(KoRgbU16ColorSpace::colorSpaceId(), profile);
}

References KoRgbU16ColorSpace::colorSpaceId(), and d.

◆ rgb16() [2/2]

const KoColorSpace * KoColorSpaceRegistry::rgb16 ( const QString & profileName = QString() )

Convenience method to get an RGBA 16bit colorspace. If a profile is not specified, an sRGB profile will be used.

Parameters

profileName the name of an RGB color profile

Returns: the wanted colorspace, or 0 if the color space and profile can not be combined.

Definition at line 675 of file KoColorSpaceRegistry.cpp.

{
    return d->colorSpace1(KoRgbU16ColorSpace::colorSpaceId(), profileName);
}

References KoRgbU16ColorSpace::colorSpaceId(), and d.

◆ rgb8() [1/2]

const KoColorSpace * KoColorSpaceRegistry::rgb8 ( const KoColorProfile * profile )

Convenience method to get an RGBA 8bit colorspace with the given profile.

Parameters

profile an RGB profile

Returns: the wanted colorspace, or 0 if the color space and profile can not be combined.

Definition at line 663 of file KoColorSpaceRegistry.cpp.

{
    if (profile == 0) {
        if (!d->rgbU8sRGB) {
            d->rgbU8sRGB = d->colorSpace1(KoRgbU8ColorSpace::colorSpaceId());
        }
        Q_ASSERT(d->rgbU8sRGB);
        return d->rgbU8sRGB;
    }
    return d->colorSpace1(KoRgbU8ColorSpace::colorSpaceId(), profile);
}

References KoRgbU8ColorSpace::colorSpaceId(), and d.

◆ rgb8() [2/2]

const KoColorSpace * KoColorSpaceRegistry::rgb8 ( const QString & profileName = QString() )

Convenience method to get an RGBA 8bit colorspace. If a profile is not specified, an sRGB profile will be used.

Parameters

profileName the name of an RGB color profile

Returns: the wanted colorspace, or 0 if the color space and profile can not be combined.

Definition at line 651 of file KoColorSpaceRegistry.cpp.

{
    if (profileName.isEmpty()) {
        if (!d->rgbU8sRGB) {
            d->rgbU8sRGB = d->colorSpace1(KoRgbU8ColorSpace::colorSpaceId());
        }
        Q_ASSERT(d->rgbU8sRGB);
        return d->rgbU8sRGB;
    }
    return d->colorSpace1(KoRgbU8ColorSpace::colorSpaceId(), profileName);
}

References KoRgbU8ColorSpace::colorSpaceId(), and d.

Friends And Related Symbol Documentation

◆ FriendOfColorSpaceRegistry

friend struct FriendOfColorSpaceRegistry

friend

Definition at line 426 of file KoColorSpaceRegistry.h.

◆ KisCrashFilterTest

friend class KisCrashFilterTest

friend

Definition at line 422 of file KoColorSpaceRegistry.h.

◆ KisCsConversionTest

friend class KisCsConversionTest

friend

Definition at line 418 of file KoColorSpaceRegistry.h.

◆ KisIteratorNGTest

friend class KisIteratorNGTest

friend

Definition at line 420 of file KoColorSpaceRegistry.h.

◆ KisIteratorTest

friend class KisIteratorTest

friend

Definition at line 419 of file KoColorSpaceRegistry.h.

◆ KisPainterTest

friend class KisPainterTest

friend

Definition at line 421 of file KoColorSpaceRegistry.h.

◆ KoColorSpacesBenchmark

friend class KoColorSpacesBenchmark

friend

Definition at line 423 of file KoColorSpaceRegistry.h.

◆ TestColorConversionSystem

friend class TestColorConversionSystem

friend

Definition at line 425 of file KoColorSpaceRegistry.h.

◆ TestKoColorSpaceSanity

friend class TestKoColorSpaceSanity

friend

Definition at line 424 of file KoColorSpaceRegistry.h.

◆ TestProfileGeneration

friend class TestProfileGeneration

friend

Definition at line 427 of file KoColorSpaceRegistry.h.

Member Data Documentation

◆ alphaCs

const KoColorSpace* KoColorSpaceRegistry::alphaCs {nullptr}

Definition at line 61 of file KoColorSpaceRegistry.cpp.

61{nullptr};

◆ alphaF32Cs

const KoColorSpace* KoColorSpaceRegistry::alphaF32Cs {nullptr}

Definition at line 66 of file KoColorSpaceRegistry.cpp.

66{nullptr};

◆ alphaU16Cs

const KoColorSpace* KoColorSpaceRegistry::alphaU16Cs {nullptr}

Definition at line 62 of file KoColorSpaceRegistry.cpp.

62{nullptr};

◆ colorConversionCache

KoColorConversionCache * KoColorSpaceRegistry::colorConversionCache {nullptr}

Definition at line 58 of file KoColorSpaceRegistry.cpp.

58{nullptr};

◆ colorConversionSystem

const KoColorConversionSystem * KoColorSpaceRegistry::colorConversionSystem {nullptr}

Definition at line 57 of file KoColorSpaceRegistry.cpp.

57{nullptr};

◆ colorSpaceFactoryRegistry

KoGenericRegistry<KoColorSpaceFactory *> KoColorSpaceRegistry::colorSpaceFactoryRegistry

Definition at line 53 of file KoColorSpaceRegistry.cpp.

◆ conversionSystemInterface

QScopedPointer<ConversionSystemInterface> KoColorSpaceRegistry::conversionSystemInterface

Definition at line 56 of file KoColorSpaceRegistry.cpp.

◆ csMap

QHash<QString, const KoColorSpace *> KoColorSpaceRegistry::csMap

Definition at line 55 of file KoColorSpaceRegistry.cpp.

◆ d

Private* const KoColorSpaceRegistry::d

private

Definition at line 452 of file KoColorSpaceRegistry.h.

◆ lab16sLAB

const KoColorSpace* KoColorSpaceRegistry::lab16sLAB {nullptr}

Definition at line 60 of file KoColorSpaceRegistry.cpp.

60{nullptr};

◆ profileStorage

KoColorProfileStorage KoColorSpaceRegistry::profileStorage

Definition at line 54 of file KoColorSpaceRegistry.cpp.

◆ q

KoColorSpaceRegistry* KoColorSpaceRegistry::q {nullptr}

Definition at line 51 of file KoColorSpaceRegistry.cpp.

51{nullptr};

◆ registrylock

QReadWriteLock KoColorSpaceRegistry::registrylock

Definition at line 67 of file KoColorSpaceRegistry.cpp.

◆ rgbU8sRGB

const KoColorSpace* KoColorSpaceRegistry::rgbU8sRGB {nullptr}

Definition at line 59 of file KoColorSpaceRegistry.cpp.

59{nullptr};

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

libs/pigment/KoColorSpaceRegistry.cpp
libs/pigment/KoColorSpaceRegistry.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ CustomProfileNameAlias

Member Enumeration Documentation

◆ ColorSpaceListProfilesSelection

◆ ColorSpaceListVisibility

Constructor & Destructor Documentation

◆ KoColorSpaceRegistry() [1/2]

◆ ~KoColorSpaceRegistry()

◆ KoColorSpaceRegistry() [2/2]

Member Function Documentation

◆ add()

◆ addProfile() [1/2]

◆ addProfile() [2/2]

◆ addProfileAlias()

◆ addProfileToMap()

◆ allColorSpaces()

◆ alpha16()

◆ alpha32f()

◆ alpha8()

◆ colorConversionCache()

◆ colorConversionSystem()

◆ colorDepthList() [1/2]

◆ colorDepthList() [2/2]

◆ colorModelsList()

◆ colorSpace() [1/3]

◆ colorSpace() [2/3]

◆ colorSpace() [3/3]

◆ colorSpace1() [1/2]

◆ colorSpace1() [2/2]

◆ colorSpaceColorDepthId()

◆ colorSpaceColorModelId()

◆ colorSpaceId() [1/2]

◆ colorSpaceId() [2/2]

◆ colorSpaceIdImpl()

◆ createColorConverter()

◆ createColorConverters()

◆ createColorProfile() [1/2]

◆ createColorProfile() [2/2]

◆ defaultProfileForColorSpace()

◆ defaultProfileForCsIdImpl()

◆ getCachedColorSpaceImpl()

◆ graya16() [1/2]

◆ graya16() [2/2]

◆ graya8() [1/2]

◆ graya8() [2/2]

◆ idsToCacheName()

◆ init()

◆ instance()

◆ lab16() [1/2]

◆ lab16() [2/2]

◆ lazyCreateColorSpaceImpl()

◆ listKeys()

◆ operator=()

◆ p2020G10Profile()

◆ p2020PQProfile()

◆ p709G10Profile()

◆ p709SRGBProfile()

◆ permanentColorspace()

◆ Private()

◆ profileAlias()

◆ profileByName()

◆ profileByUniqueId()

◆ profileFor()

◆ profileForCsIdWithFallbackImpl()

◆ profileForInternal()

◆ profileForQColorSpace()

◆ profileIsCompatible()

◆ profilesFor()

◆ QColorSpaceForProfile()

◆ remove()

◆ removeProfile()

◆ removeProfileAlias()