OpenColorIOWrapper.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#if WITH_OCIO
 
#include "CoreTypes.h"
#include "Containers/ContainersFwd.h"
#include "Containers/StaticArray.h"
#include "Math/Vector.h"
#include "Templates/PimplPtr.h"
#include "Templates/UniquePtr.h"
 
#include "ColorManagement/ColorManagementDefines.h"
 
struct FImageView;
enum TextureFilter : int;
 
namespace OpenColorIOWrapper
{
    constexpr const TCHAR* GetWorkingColorSpaceName()
    {
        return TEXT("Working Color Space");
    }
 
    constexpr const TCHAR* GetShaderFunctionName()
    {
        return TEXT("OCIOConvert");
    }
 
    static constexpr uint32 Legacy3dEdgeLength = 65;
 
    OPENCOLORIOWRAPPER_API const TCHAR* GetVersion();
 
    OPENCOLORIOWRAPPER_API uint32 GetVersionHex();
 
    OPENCOLORIOWRAPPER_API void ClearAllCaches();
}
 
 
class FOpenColorIOWrapperConfig
{
public:
 
    enum EAddWorkingColorSpaceOption
    {
        WCS_None,
        // Add the working color space as ACES 2065-1 so that we can target it with an extra conversion from our config if it defines aces_interchange.
        WCS_AsInterchangeSpace
    };
 
    FOpenColorIOWrapperConfig();
 
    OPENCOLORIOWRAPPER_API explicit FOpenColorIOWrapperConfig(FStringView InFilePath, EAddWorkingColorSpaceOption InOption = WCS_None);
 
    virtual ~FOpenColorIOWrapperConfig() = default;
 
    OPENCOLORIOWRAPPER_API bool IsValid() const;
    
    OPENCOLORIOWRAPPER_API int32 GetNumColorSpaces() const;
    
    OPENCOLORIOWRAPPER_API FString GetColorSpaceName(int32 Index) const;
    
    OPENCOLORIOWRAPPER_API int32 GetColorSpaceIndex(const TCHAR* InColorSpaceName);
    
    OPENCOLORIOWRAPPER_API FString GetColorSpaceFamilyName(const TCHAR* InColorSpaceName) const;
 
    OPENCOLORIOWRAPPER_API FString GetColorSpaceDescription(const TCHAR* InColorSpaceName) const;
    
    OPENCOLORIOWRAPPER_API int32 GetNumDisplays() const;
    
    OPENCOLORIOWRAPPER_API FString GetDisplayName(int32 Index) const;
    
    OPENCOLORIOWRAPPER_API int32 GetNumViews(const TCHAR* InDisplayName) const;
    
    OPENCOLORIOWRAPPER_API FString GetViewName(const TCHAR* InDisplayName, int32 Index) const;
 
    OPENCOLORIOWRAPPER_API FString GetDisplayViewTransformName(const TCHAR* InDisplayName, const TCHAR* InViewName) const;
 
    OPENCOLORIOWRAPPER_API FString GetDisplayViewDescription(const TCHAR* InDisplayName, const TCHAR* InViewName) const;
 
    OPENCOLORIOWRAPPER_API FString GetDisplayViewTransformDescription(const TCHAR* InDisplayName, const TCHAR* InViewName) const;
 
    OPENCOLORIOWRAPPER_API TMap<FString, FString> GetCurrentContextStringVars() const;
 
    OPENCOLORIOWRAPPER_API FString GetCacheID() const;
 
    OPENCOLORIOWRAPPER_API FString GetDebugString() const;
 
protected:
 
    TPimplPtr<struct FOpenColorIOConfigPimpl, EPimplPtrMode::DeepCopy> Pimpl;
 
    friend class FOpenColorIOWrapperProcessor;
    friend class FOpenColorIOWrapperGPUProcessor;
};
 
/* Matches FTextureSourceColorSettings in Engine/Texture.h */
struct FOpenColorIOWrapperSourceColorSettings
{
    UE::Color::EEncoding EncodingOverride = UE::Color::EEncoding::None;
 
    UE::Color::EColorSpace ColorSpace = UE::Color::EColorSpace::None;
 
    TOptional<TStaticArray<FVector2d, 4>> ColorSpaceOverride = {};
 
    UE::Color::EChromaticAdaptationMethod ChromaticAdaptationMethod = UE::Color::EChromaticAdaptationMethod::None;
};
 
class FOpenColorIOWrapperEngineConfig : public FOpenColorIOWrapperConfig
{
public:
    FOpenColorIOWrapperEngineConfig();
 
    FOpenColorIOWrapperEngineConfig(FStringView InFilePath, EAddWorkingColorSpaceOption InOption = WCS_None) = delete;
};
 
class FOpenColorIOWrapperProcessor final
{
public:
 
    OPENCOLORIOWRAPPER_API FOpenColorIOWrapperProcessor();
 
    OPENCOLORIOWRAPPER_API explicit FOpenColorIOWrapperProcessor(
        const FOpenColorIOWrapperConfig* InConfig,
        FStringView InSourceColorSpace,
        FStringView InDestinationColorSpace,
        const TMap<FString, FString>& InContextKeyValues = {}
    );
 
    OPENCOLORIOWRAPPER_API explicit FOpenColorIOWrapperProcessor(
        const FOpenColorIOWrapperConfig* InConfig,
        FStringView InSourceColorSpace,
        FStringView InDisplay,
        FStringView InView,
        bool bInverseDirection = false,
        const TMap<FString, FString>& InContextKeyValues = {}
    );
 
    OPENCOLORIOWRAPPER_API explicit FOpenColorIOWrapperProcessor(
        const FOpenColorIOWrapperConfig* InConfig,
        FStringView InNamedTransform,
        bool bInverseDirection = false,
        const TMap<FString, FString>& InContextKeyValues = {}
    );
 
    OPENCOLORIOWRAPPER_API static FOpenColorIOWrapperProcessor CreateTransformToWorkingColorSpace(
        const FOpenColorIOWrapperSourceColorSettings& InSourceColorSettings
    );
 
    OPENCOLORIOWRAPPER_API bool IsValid() const;
 
    OPENCOLORIOWRAPPER_API FString GetCacheID() const;
 
    OPENCOLORIOWRAPPER_API static FString GetTransformToWorkingColorSpaceName(const FOpenColorIOWrapperSourceColorSettings& InSourceColorSettings);
 
    OPENCOLORIOWRAPPER_API bool TransformColor(FLinearColor& InOutColor) const;
 
    OPENCOLORIOWRAPPER_API bool TransformImage(const FImageView& InOutImage) const;
 
    OPENCOLORIOWRAPPER_API bool TransformImage(const FImageView& SrcImage, const FImageView& DestImage) const;
 
private:
 
    TPimplPtr<struct FOpenColorIOProcessorPimpl, EPimplPtrMode::DeepCopy> Pimpl;
 
    friend class FOpenColorIOWrapperGPUProcessor;
};
 
class FOpenColorIOWrapperGPUProcessor final
{
public:
 
    OPENCOLORIOWRAPPER_API explicit FOpenColorIOWrapperGPUProcessor(
        FOpenColorIOWrapperProcessor InProcessor,
        bool bUseLegacy = false
    );
 
    OPENCOLORIOWRAPPER_API bool IsValid() const;
 
    OPENCOLORIOWRAPPER_API bool GetShader(FString& OutShaderCacheID, FString& OutShaderCode) const;
 
    OPENCOLORIOWRAPPER_API uint32 GetNum3DTextures() const;
 
    OPENCOLORIOWRAPPER_API bool Get3DTexture(uint32 InIndex, FName& OutName, uint32& OutEdgeLength, TextureFilter& OutTextureFilter, const float*& OutData) const;
 
    OPENCOLORIOWRAPPER_API uint32 GetNumTextures() const;
 
    OPENCOLORIOWRAPPER_API bool GetTexture(uint32 InIndex, FName& OutName, uint32& OutWidth, uint32& OutHeight, TextureFilter& OutTextureFilter, bool& bOutRedChannelOnly, const float*& OutData) const;
 
    OPENCOLORIOWRAPPER_API FString GetCacheID() const;
 
private:
 
    const FOpenColorIOWrapperProcessor ParentProcessor;
 
    TPimplPtr<struct FOpenColorIOGPUProcessorPimpl, EPimplPtrMode::DeepCopy> GPUPimpl;
};
 
#endif // WITH_OCIO