HdrImageWrapper.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/ContainersFwd.h"
#include "CoreMinimal.h"
#include "CoreTypes.h"
#include "IImageWrapper.h"
#include "ImageCore.h"
#include "Internationalization/Text.h"
 
// http://radsite.lbl.gov/radiance/refer/Notes/picture_format.html
// http://paulbourke.net/dataformats/pic/
 
//  does not use ImageWrapperBase , unlike all other imagewrappers
class FHdrImageWrapper : public IImageWrapper
{
public:
 
    // Todo we should have this for all image wrapper.
    IMAGEWRAPPER_API bool SetCompressedFromView(TArrayView64<const uint8> Data);
 
    // IIMageWrapper Interface begin
    IMAGEWRAPPER_API virtual bool SetCompressed(const void* InCompressedData, int64 InCompressedSize) override;
    IMAGEWRAPPER_API virtual bool SetRaw(const void* InRawData, int64 InRawSize, const int32 InWidth, const int32 InHeight, const ERGBFormat InFormat, const int32 InBitDepth, const int32 InBytesPerRow) override;
    IMAGEWRAPPER_API virtual TArray64<uint8> GetCompressed(int32 Quality = 0) override;
    IMAGEWRAPPER_API virtual bool GetRaw(const ERGBFormat InFormat, int32 InBitDepth, TArray64<uint8>& OutRawData) override;
    IMAGEWRAPPER_API virtual bool GetRaw(const ERGBFormat InFormat, int32 InBitDepth, FDecompressedImageOutput& OutDecompressedImage) override;
    
    IMAGEWRAPPER_API virtual bool CanSetRawFormat(const ERGBFormat InFormat, const int32 InBitDepth) const override;
    IMAGEWRAPPER_API virtual ERawImageFormat::Type GetSupportedRawFormat(const ERawImageFormat::Type InFormat) const override;
 
    IMAGEWRAPPER_API virtual int64 GetWidth() const override;
    IMAGEWRAPPER_API virtual int64 GetHeight() const override;
    IMAGEWRAPPER_API virtual int32 GetBitDepth() const override;
    IMAGEWRAPPER_API virtual ERGBFormat GetFormat() const override;
 
    // IImageWrapper Interface end
 
    // GetErrorMessage : nice idea, but not virtual, never called by the standard import path
    IMAGEWRAPPER_API const FText& GetErrorMessage() const;
 
    IMAGEWRAPPER_API void FreeCompressedData();
 
    virtual bool SupportsMetadata() const override;
 
    virtual void AddMetadata(const FString& InKey, const FString& InValue) override;
 
    virtual void GetMetadata(TStringMap& OutMetadata) const override;
 
    using IImageWrapper::GetRaw;
 
private:
    // Helpers for error exits. Set error messages and return false.
    void SetAndLogError(const FText& InText);
    bool FailHeaderParsing(); // also calls FreeCompressData.
    bool FailUnexpectedEOB();
    bool FailMalformedScanline();
 
    bool GetHeaderLine(const uint8*& BufferPos, char Line[256]);
 
    static bool ParseMatchString(const char*& InOutCursor, const char* InExpected);
    static bool ParsePositiveInt(const char*& InOutCursor, int* OutValue);
    static bool ParseImageSize(const char* InLine, int* OutWidth, int* OutHeight);
 
    static bool HaveBytes(const uint8* InCursor, const uint8* InEnd, int InAmount);
 
    bool DecompressScanline(uint8* Out, const uint8*& In, const uint8* InEnd);
 
    bool OldDecompressScanline(uint8* Out, const uint8*& In, const uint8* InEnd, int32 Length, bool bInitialRunAllowed);
 
    bool IsCompressedImageValid() const;
 
    TArrayView64<const uint8> CompressedData;
    const uint8* RGBDataStart = nullptr;
 
    TArray64<uint8> CompressedDataHolder;
    TArray64<uint8> RawDataHolder;
 
    int64 Width = INDEX_NONE;
    int64 Height = INDEX_NONE;
 
    // Reported error
    FText ErrorMessage;
};