IImageWrapper.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/ArrayView.h"
#include "CoreTypes.h"
#include "Templates/SharedPointer.h"
#include "ImageCore.h"
#include "ImageWrapperOutputTypes.h"
 
enum class EImageFormat : int8
{
    Invalid = -1,
 
    PNG = 0,
 
    JPEG,
 
    GrayscaleJPEG,  
 
    BMP,
 
    ICO,
 
    EXR,
 
    ICNS,
    
    TGA,
 
    HDR,
 
    TIFF,
 
    DDS,
 
    UEJPEG,
 
    GrayscaleUEJPEG,
};
 
 
enum class ERGBFormat : int8
{
    Invalid = -1,
 
    // Red, Green, Blue and Alpha ; requires RB swap from FColor
    RGBA =  0,
 
    // Blue, Green, Red and Alpha ; is ERawImageFormat::BGRA8 and Fcolor
    BGRA =  1,
 
    // Gray scale
    Gray =  2,
 
    // Red, Green, Blue and Alpha using IEEE Floating-Point Arithmetic (see IEEE754). The format is always binary.
    RGBAF = 3,
 
    // Blue, Green, Red and Exponent (Similar to the RGBE format from radiance but with the blue and red channel inversed)
    BGRE =  4,
 
    // Gray scale using IEEE Floating-Point Arithmetic (see IEEE754). The format is always binary.
    GrayF = 5,
};
 
 
enum class EImageCompressionQuality : int8
{
    Default = 0,
    Uncompressed = 1,
    Max = 100,
};
 
 
class IImageWrapper
{
protected:
    // debug image name string for any errors or warnings
    const TCHAR* DebugImageName =  nullptr;
 
public:
 
 
    virtual bool SetCompressed(const void* InCompressedData, int64 InCompressedSize) = 0;
 
    virtual bool SetRaw(const void* InRawData, int64 InRawSize, const int32 InWidth, const int32 InHeight, const ERGBFormat InFormat, const int32 InBitDepth, const int32 InBytesPerRow = 0) = 0;
 
    virtual bool CanSetRawFormat(const ERGBFormat InFormat, const int32 InBitDepth) const = 0;
 
    virtual ERawImageFormat::Type GetSupportedRawFormat(const ERawImageFormat::Type InFormat) const = 0;
 
 
    virtual TArray64<uint8> GetCompressed(int32 Quality = 0) = 0;
 
    virtual TArray64<uint8> GetExportData(int32 Quality = 0)
    {
        return GetCompressed(Quality);
    }
 
    bool GetRaw(TArray64<uint8>& OutRawData)
    {
        ERGBFormat Format = GetFormat();
        int32 BitDepth = GetBitDepth();
 
        // Format and BitDepth should have been set by SetCompressed
        if ( Format == ERGBFormat::Invalid || BitDepth == 0 )
        {
            return false;
        }
 
        return GetRaw(Format,BitDepth,OutRawData);
    }
 
    bool GetRaw(FDecompressedImageOutput& OutDecompressedImage)
    {
        ERGBFormat Format = GetFormat();
        int32 BitDepth = GetBitDepth();
 
        // Format and BitDepth should have been set by SetCompressed
        if (Format == ERGBFormat::Invalid || BitDepth == 0)
        {
            return false;
        }
 
        return GetRaw(Format, BitDepth, OutDecompressedImage);
    }
    
    bool GetRawImage(FImage & OutImage);
 
    bool GetRawImage(FDecompressedImageOutput& OutDecompressedImage);
 
    
    virtual bool GetRaw(const ERGBFormat InFormat, int32 InBitDepth, TArray64<uint8>& OutRawData) = 0;
 
    virtual bool GetRaw(const ERGBFormat InFormat, int32 InBitDepth, FDecompressedImageOutput& OutDecompressedImage) = 0;
        
    bool GetRaw(const ERGBFormat InFormat, int32 InBitDepth, TArray<uint8>& OutRawData)
    {
        TArray64<uint8> TmpRawData;
        if (GetRaw(InFormat, InBitDepth, TmpRawData) && ensureMsgf(TmpRawData.Num() == (int32)TmpRawData.Num(), TEXT("Tried to get %" INT64_FMT "x%" INT64_FMT " %dbpp image with format %d into 32-bit TArray (%lld bytes)"), GetWidth(), GetHeight(), InBitDepth, InFormat, (long long int)TmpRawData.Num()))
        {
            OutRawData = MoveTemp(TmpRawData);
            return true;
        }
        else
        {
            return false;
        }
    }
    
    bool GetRaw(const ERGBFormat InFormat, int32 InBitDepth, TArrayView64<uint8> OutRawData)
    {
        TArray64<uint8> TmpRawData;
        if (GetRaw(InFormat, InBitDepth, TmpRawData))
        {
            if (ensureMsgf(TmpRawData.Num() == OutRawData.Num(), TEXT("The view doesn't have the proper size to receive the texture.")))
            {
                FPlatformMemory::Memcpy(OutRawData.GetData(), TmpRawData.GetData(), OutRawData.Num());
                return true;
            }
        }
 
        return false;
    }
 
    virtual int64 GetWidth() const = 0;
 
    virtual int64 GetHeight() const = 0;
 
    virtual int32 GetBitDepth() const = 0;
 
    virtual ERGBFormat GetFormat() const = 0;
    
    
    /* Should the pixels be treated as sRGB encoded? (or Linear)
    * 
    * note: ImageWrapper Format does not track if pixels are Gamma/SRGB or not
    * assume they are ERawImageFormat::GetDefaultGammaSpace gammaspace
    * eg. U8 is SRGB and everything else is Linear
    */
    bool GetSRGB() const
    {
        // sRGB is guessed from bit depth
        // 8 = on (except BGRE)
        // must match ERawImageFormat::GetDefaultGammaSpace
        return GetBitDepth() == 8 && GetFormat() != ERGBFormat::BGRE;
    }
 
    // external users call these from ImageWrapperModule.h , see documentation there
    IMAGEWRAPPER_API static void ConvertRawImageFormat(ERawImageFormat::Type RawFormat, ERGBFormat & OutFormat,int & OutBitDepth);
    IMAGEWRAPPER_API static ERawImageFormat::Type ConvertRGBFormat(ERGBFormat RGBFormat,int BitDepth,bool * bIsExactMatch = nullptr);
    
    IMAGEWRAPPER_API static int64 GetRGBFormatBytesPerPel(ERGBFormat RGBFormat,int BitDepth);
 
    /* get the current image format, mapped to an ERawImageFormat
     * if ! *bIsExactMatch , conversion is needed
     * can call after SetCompressed()
     */
    ERawImageFormat::Type GetClosestRawImageFormat(bool * bIsExactMatch = nullptr) const
    {
        ERGBFormat Format = GetFormat();
        int BitDepth = GetBitDepth();
        ERawImageFormat::Type Ret = ConvertRGBFormat(Format,BitDepth,bIsExactMatch);
        return Ret;
    }
 
    /* Set the debug image name
     */
    void SetDebugImageName(const TCHAR* InDebugImageName)
    {
        DebugImageName = InDebugImageName;
    }
 
    virtual bool SupportsMetadata() const = 0;
 
    virtual void AddMetadata(const FString& InKey, const FString& InValue) = 0;
 
    using TStringMap = TMap<FString, FString>;
    virtual void GetMetadata(TStringMap& OutMetadata) const = 0;
 
public:
 
    virtual ~IImageWrapper() { }
};