icolormanager.h

Go to the documentation of this file.

/*
 * Copyright (C) 2009-2025 Global Graphics Software Ltd. All rights reserved.
 */
 
#ifndef ICOLORMANAGER_H
#define ICOLORMANAGER_H
 
#include <edl/iedlfactory.h>
#include <edl/iedlobject.h>
#include <edl/idomresources.h>
#include <edl/idomcolor.h>
#include <edl/idomcolorspace.h>
#include <edl/edlvector.h>
#include <edl/edlsimplebuffer.h>
#include <edl/edlrenderingintent.h>
#include <edl/edltypes.h>
 
_BEGIN_EDL_NAMESPACE
 
#define EDL_CMM_MAX_COMPONENTS 32
 
class IColorManager;
DECL_SMART_PTR(IColorManager);

class CColorManagerConfig : public IRCObject
{
  public:
    CColorManagerConfig()
    {
        mapDeviceGrayToCMYKBlack = eTSUnset;
        convertDeviceGrayUsingCMYKBlack = eTSUnset;
        defaultBlackPointCompensation = eBPCDefault;
    }
    
    static EDL_API CColorManagerConfigPtr create();
    
    EDL_API CColorManagerConfigPtr clone();
    
    EDL_API void updateHash(uint64 &hash);
    
    IDOMColorSpacePtr       deviceGrayIntercept;

    IDOMColorSpacePtr       deviceRGBIntercept;

    IDOMColorSpacePtr       deviceCMYKIntercept;
    
    eTriState               mapDeviceGrayToCMYKBlack;
    
    eTriState               convertDeviceGrayUsingCMYKBlack;
    
    eBlackPointCompensation defaultBlackPointCompensation;
};

class IColorManager : public IEDLObject
{
#define IColorManagerClassID 0x573cc514, 0x821611dc, 0x83140800, 0x200c9a66
  public:
    DECLARE_CLASS_ID(IColorManagerClassID);
    IMPLEMENT_CLASS_ID(IColorManager);
 
    virtual ~IColorManager() {};

    static EDL_API IColorManagerPtr get(IEDLClassFactory *pFactory);
 
#ifdef SWIG
#if SWIGJAVA
    %apply float[] {const float *inColors};
    %apply float[] {float *outColors};
#endif
#if SWIGCSHARP
    %apply float INPUT[]  {const float *inColors};
    %apply float OUTPUT[] {float *outColors};
#endif
#if SWIGPYTHON
    %apply float INPUT[]  {const float *inColors};
    %apply float OUTPUT[] {float *outColors};
#endif
#endif
    virtual void convertColors(int32 numColors,
                               bool hasAlpha,
                               const IDOMColorSpacePtr &sourceSpace,
                               const IDOMColorSpacePtr &destSpace,
                               eRenderingIntent intent,
                               eBlackPointCompensation bpc,
                               const float *inColors,
                               float *outColors,
                               const CColorManagerConfigPtr &overrideConfig = CColorManagerConfigPtr()) = 0;
#ifdef SWIG
    %clear const float *inColors;
    %clear float *outColors;
#endif
 
#ifdef SWIG
#if SWIGJAVA
    %apply char *BYTE {const uint8 *inColors};
    %apply char *BYTE {uint8 *outColors};
#endif
#if SWIGCSHARP
    %apply unsigned char INPUT[]  {const uint8 *inColors};
    %apply unsigned char OUTPUT[] {uint8 *outColors};
#endif
#if SWIGPYTHON
    %apply unsigned char INPUT[]  {const uint8 *inColors};
    %apply unsigned char OUTPUT[] {uint8 *outColors};
#endif
#endif
    virtual void convertColors(int32 numColors,
                               bool hasAlpha,
                               const IDOMColorSpacePtr &sourceSpace,
                               const IDOMColorSpacePtr &destSpace,
                               eRenderingIntent intent,
                               eBlackPointCompensation bpc,
                               const uint8 *inColors,
                               uint8 *outColors,
                               int32 inBPS,
                               int32 outBPS,
                               const CColorManagerConfigPtr &overrideConfig = CColorManagerConfigPtr()) = 0;
#ifdef SWIG
    %clear const uint8 *inColors;
    %clear uint8 *outColors;
#endif

    virtual CEDLVector<float> getOptimizedSpotFromLab(float l, float a, float b,
                                                      const IDOMColorSpacePtr &destSpace) = 0;

    virtual uint8 getNumComponentsForICCBasedSpace(const IDOMColorSpaceICCBasedPtr &space) = 0;

    virtual uint8 getNumComponentsForICCProfile(const IDOMICCProfilePtr &profile) = 0;

    virtual eRenderingIntent getDefaultIntentForICCBasedSpace(const IDOMColorSpaceICCBasedPtr &space) = 0;

    virtual uint32 getProfileColorSpaceForICCBasedSpace(const IDOMColorSpaceICCBasedPtr &space) = 0;
 
#ifdef SWIG
    %apply uint8_t &OUTPUT { uint8 &majorVersion };
    %apply uint8_t &OUTPUT { uint8 &minorVersion };
#endif
    virtual void getProfileVersionForICCBasedSpace(const IDOMColorSpaceICCBasedPtr &space, uint8 &majorVersion, uint8 &minorVersion) = 0;
#ifdef SWIG
    %clear uint8 &majorVersion;
    %clear uint8 &minorVersion;
#endif

    virtual uint32 getProfileClassForICCBasedSpace(const IDOMColorSpaceICCBasedPtr &space) = 0;

    virtual uint32 getProfileConnectionSpaceForICCBasedSpace(const IDOMColorSpaceICCBasedPtr &space) = 0;

    virtual uint32 getNumProfileConnectionSpaceComponentsForICCBasedSpace(const IDOMColorSpaceICCBasedPtr &space) = 0;

    virtual bool getProfileHasSupportForIntentForICCBasedSpace(const IDOMColorSpaceICCBasedPtr &space, eRenderingIntent intent, bool input) = 0;

    virtual void getProfileNameForICCBasedSpace(const IDOMColorSpaceICCBasedPtr &space, EDLSysString &name) = 0;

    virtual CEDLSysStringVect getColorantNamesForICCBasedSpace(const IDOMColorSpaceICCBasedPtr &space) = 0;
   
    virtual IDOMICCProfilePtr getCMYKSWOPProfile() const = 0;

    virtual IDOMICCProfilePtr getsGrayProfile() const = 0;

    virtual IDOMICCProfilePtr getsRGBProfile() const = 0;
    
    virtual IDOMICCProfilePtr getscRGBProfile() const = 0;
    
    virtual IDOMICCProfilePtr createCalibratedGrayProfile(const CEDLVector<double> &whitePoint, double gamma = 1.0, const CEDLVector<double> &blackPoint = CEDLVector<double>()) = 0;

    virtual IDOMICCProfilePtr createGrayProfile(const CEDLVector<double> &whitePoint, CEDLVector<float> &gamma, const CEDLVector<double> &blackPoint = CEDLVector<double>()) = 0;

    virtual IDOMICCProfilePtr createCalibratedRGBProfile(const CEDLVector<double> &whitePoint, const CEDLVector<double> &gamma = CEDLVector<double>(), const CEDLVector<double> &matrix = CEDLVector<double>(), const CEDLVector<double> &blackPoint = CEDLVector<double>()) = 0;

    virtual IDOMICCProfilePtr createXyzProfile(const CEDLVector<double> &whitePoint, const CEDLVector<double> &blackPoint = CEDLVector<double>()) = 0;

    virtual void setMapDeviceGrayToCMYKBlack(bool mapGrayDirectly) = 0;

    virtual bool getMapDeviceGrayToCMYKBlack() const = 0;

    virtual void setDefaultBlackPointCompensation(eBlackPointCompensation defaultBpc) = 0;

    virtual eBlackPointCompensation getDefaultBlackPointCompensation() const = 0;

    virtual void setDefaultBlackPreservation(bool preserveForText, bool preserveForOther) = 0;

    virtual bool getDefaultTextBlackPreservation() const = 0;

    virtual bool getDefaultOtherBlackPreservation() const = 0;

    virtual void setDeviceGrayIntercept(const IDOMColorSpacePtr &space) = 0;

    virtual IDOMColorSpacePtr getDeviceGrayIntercept() = 0;

    virtual void setDeviceRGBIntercept(const IDOMColorSpacePtr &space) = 0;

    virtual IDOMColorSpacePtr getDeviceRGBIntercept() = 0;

    virtual void setDeviceCMYKIntercept(const IDOMColorSpacePtr &space) = 0;

    virtual IDOMColorSpacePtr getDeviceCMYKIntercept() = 0;

    virtual IDOMColorSpacePtr interceptSpace(const IDOMColorSpacePtr &space,
                                             const CColorManagerConfigPtr &overrideConfig = CColorManagerConfigPtr()) = 0;
    
    virtual IDOMICCProfilePtr getProfileForSpace(const IDOMColorSpacePtr &space,
                                                 const CColorManagerConfigPtr &overrideConfig = CColorManagerConfigPtr()) = 0;
    
    virtual void getPostScriptCSAForICCBasedSpace(CEDLSimpleBuffer &csaMemory, const IDOMColorSpaceICCBasedPtr &space, eRenderingIntent intent) = 0;

    virtual bool getEmbeddedPSCSAForICCBasedSpace(CEDLSimpleBuffer &csaMemory, const IDOMColorSpaceICCBasedPtr &space) = 0;
 

    virtual void useDeviceLinkForConversionsBetween(const IDOMColorSpaceICCBasedPtr &sourceSpace, const IDOMColorSpaceICCBasedPtr &destSpace, const IDOMICCProfilePtr &deviceLink) = 0;

    virtual void useDeviceLinkForConversionsBetween(const IDOMICCProfilePtr &sourceProfile, const IDOMICCProfilePtr &destProfile, const IDOMICCProfilePtr &deviceLink) = 0;

    virtual uint32 getNumDeviceLinkICCProfiles() = 0;

    virtual void getDeviceLinkICCProfile(const uint8 index, IDOMColorSpaceICCBasedPtr& sourceSpace, IDOMColorSpaceICCBasedPtr& destSpace, IDOMICCProfilePtr& deviceLink) = 0;

    virtual void deleteDeviceLinkForConversionsBetween(const IDOMColorSpaceICCBasedPtr &sourceSpace, const IDOMColorSpaceICCBasedPtr &destSpace) = 0;

    virtual void deleteDeviceLinkForConversionsBetween(const IDOMICCProfilePtr &sourceProfile, const IDOMICCProfilePtr &destProfile) = 0;
    
#ifdef SWIG
#if SWIGJAVA
    %apply float[] { const float *inColors };
#endif
#if SWIGCSHARP
    %apply float INPUT[] { const float *inColors };
#endif
#if SWIGPYTHON
    %apply float INPUT[] { const float *inColors };
#endif
#endif
    virtual bool testGamut(uint32 numColors,
                           const IDOMColorSpacePtr &sourceSpace,
                           const IDOMColorSpacePtr &destSpace,
                           eRenderingIntent intent,
                           eBlackPointCompensation bpc,
                           const float *inColors,
                           const CColorManagerConfigPtr &overrideConfig = CColorManagerConfigPtr()) = 0;
#ifdef SWIG
    %clear const float *inColors;
    %clear float *outColors;
#endif

    virtual void setConvertDeviceGrayUsingCMYKBlack(bool convertDirectly) = 0;

    virtual bool getConvertDeviceGrayUsingCMYKBlack() const = 0;
};
#define edlobj2IColorManager(src) edl_cast((IColorManager *) nullptr, src)
 
_END_EDL_NAMESPACE
 
#endif