FLImage.h

#pragma once
 
#include <string>
 
#include "FLImagePage.h"
#include "MultiVar.h"
 
#include <list>
 
 
namespace FLImaging
{
    namespace Base
    {
        class CFLImageFileWorkStatus;
 
        class FL_EXPORT CFLImage : public CFLBase
        {
        public:
 
            SupportToDuplicateObject(CFLImage,*this);
 
        public:
            CFLImage();
 
            CFLImage(const CFLImage& fli);
 
            CFLImage(const CFLImage* pFli);
 
            explicit CFLImage(const CFLImage& fli, bool bDeepCopy, bool bDeepCopyFigure = true);
 
            explicit CFLImage(const CFLImage* pFli, bool bDeepCopy, bool bDeepCopyFigure = true);
 
            explicit CFLImage(const CFLImage& fliSourceImage, int32_t i32StartPageIndex, int32_t i32PageCount = -1, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            explicit CFLImage(const CFLImage* pFliSourceImage, int32_t i32StartPageIndex, int32_t i32PageCount = -1, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            explicit CFLImage(const CFLImage& fliSourceImage, const CFLArray<int32_t>& flaPageIndices, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            explicit CFLImage(const CFLImage* pFliSourceImage, const CFLArray<int32_t>& flaPageIndices, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            explicit CFLImage(const CFLImagePage& flipSrc, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            explicit CFLImage(const CFLImagePage* pFlipSrc, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            CFLImage(int64_t i64Width, int64_t i64Height, const CMultiVarL flmvFillValue = CMultiVarL(), EPixelFormat ePixelFormat = EPixelFormat_C1_U8, int32_t i32AlignByte = 4, int64_t i64WidthStepByte = 0);
 
            CFLImage(int64_t i64Width, int64_t i64Height, const CMultiVarUL flmvFillValue, EPixelFormat ePixelFormat = EPixelFormat_C1_U8, int32_t i32AlignByte = 4, int64_t i64WidthStepByte = 0);
 
            CFLImage(int64_t i64Width, int64_t i64Height, const CMultiVarLL flmvFillValue, EPixelFormat ePixelFormat = EPixelFormat_C1_U8, int32_t i32AlignByte = 4, int64_t i64WidthStepByte = 0);
 
            CFLImage(int64_t i64Width, int64_t i64Height, const CMultiVarULL flmvFillValue, EPixelFormat ePixelFormat = EPixelFormat_C1_U8, int32_t i32AlignByte = 4, int64_t i64WidthStepByte = 0);
 
            CFLImage(int64_t i64Width, int64_t i64Height, const CMultiVarF flmvFillValue, EPixelFormat ePixelFormat = EPixelFormat_C1_U8, int32_t i32AlignByte = 4, int64_t i64WidthStepByte = 0);
 
            CFLImage(int64_t i64Width, int64_t i64Height, const CMultiVarD flmvFillValue, EPixelFormat ePixelFormat = EPixelFormat_C1_U8, int32_t i32AlignByte = 4, int64_t i64WidthStepByte = 0);
 
            CFLImage(int64_t i64Width, int64_t i64Height, const uint8_t* pU8Buffer, EPixelFormat ePixelFormat = EPixelFormat_C1_U8, int32_t i32AlignByte = 4, int64_t i64WidthStepByte = 0);
 
            const CFLImage& operator=(const CFLImage& fli);
 
            virtual ~CFLImage();
 
            virtual const CResult Load(const wchar_t* pWcsPath, bool bRecursiveIfDirectory = true, CFLImageFileWorkStatus* pIfws = nullptr, bool bFlifCodecWithoutBuffer = true);
 
            virtual const CResult Load(const CFLArray<CFLString<wchar_t> >& flaPathList, bool bRecursiveIfDirectory = true, CFLImageFileWorkStatus* pIfws = nullptr, bool bFlifCodecWithoutBuffer = true);
 
            virtual const CResult LoadInsert(const wchar_t* pWcsPath, int32_t i32PageIndex = -1, bool bRecursiveIfDirectory = true, CFLImageFileWorkStatus* pIfws = nullptr, bool bFlifCodecWithoutBuffer = true);
 
            virtual const CResult LoadBack(const wchar_t* pWcsPath, bool bRecursiveIfDirectory = true, CFLImageFileWorkStatus* pIfws = nullptr, bool bFlifCodecWithoutBuffer = true);
 
            virtual const CResult LoadFront(const wchar_t* pWcsPath, bool bRecursiveIfDirectory = true, CFLImageFileWorkStatus* pIfws = nullptr, bool bFlifCodecWithoutBuffer = true);
 
            virtual const CResult LoadRaw(const wchar_t* pWcsPath, int64_t i64Width, int64_t i64Height, EPixelFormat ePixelFormat = EPixelFormat_C1_U8, int32_t i32AlignByte = 4, int64_t i64OffsetByteFromBegin = 0, int64_t i64OffsetByteFromEnd = 0, CFLImageFileWorkStatus* pIfws = nullptr);
 
            virtual const CResult Save(const wchar_t* pWcsFileName = nullptr, bool bOnlyCurrentPage = false, bool bCompression = false, int32_t i32CompressionLevel = 1, CFLImageFileWorkStatus* pIfws = nullptr) const;
 
            virtual const CResult SavePage(const wchar_t* pWcsFileName, int32_t i32PageIndex = -1, bool bCompression = false, int32_t i32CompressionLevel = 1, CFLImageFileWorkStatus* pIfws = nullptr) const;
 
            virtual const CResult SavePage(const wchar_t* pWcsFileName, int32_t i32PageIndexStart, int32_t i32PageIndexEnd, bool bCompression = false, int32_t i32CompressionLevel = 1, CFLImageFileWorkStatus* pIfws = nullptr) const;
 
            virtual const CResult SavePageRaw(const wchar_t* pWcsPath, int32_t i32PageIndex = -1, CFLImageFileWorkStatus* pIfws = nullptr);
 
            virtual const CResult Assign(const CFLImage& fliSourceImage, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult Assign(const CFLImage* pFliSourceImage, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult Assign(const CFLImage& fliSourceImage, int32_t i32StartPageIndex, int32_t i32PageCount = -1, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult Assign(const CFLImage* pFliSourceImage, int32_t i32StartPageIndex, int32_t i32PageCount = -1, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult Assign(const CFLImage& fliSourceImage, const CFLArray<int32_t>& flaPageIndices, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult Assign(const CFLImage* pFliSourceImage, const CFLArray<int32_t>& flaPageIndices, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult Assign(const CFLImagePage& flipSrc, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult Assign(const CFLImagePage* pFlipSrc, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult Swap(CFLImage& fliImage);
 
            virtual const CResult Swap(CFLImage* pFliImage);
 
            // Page Only Functions
 
            virtual const CResult Clear();
 
            virtual int32_t CreatePage(int32_t i32InsertIndex = -1);
 
 
            virtual const CResult AssignPage(const CFLImage& fliSourceImage, int32_t i32OwnPageIndex = -1, int32_t i32SourcePageIndex = -1, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult AssignPage(const CFLImage* pFliSourceImage, int32_t i32OwnPageIndex = -1, int32_t i32SourcePageIndex = -1, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult AssignPages(const CFLImage& fliSourceImage, int32_t i32StartPageIndex, int32_t i32PageCount = -1, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult AssignPages(const CFLImage* pFliSourceImage, int32_t i32StartPageIndex, int32_t i32PageCount = -1, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult AssignPages(const CFLImage& fliSourceImage, const CFLArray<int32_t>& flaPageIndices, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult AssignPages(const CFLImage* pFliSourceImage, const CFLArray<int32_t>& flaPageIndices, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult PushBackPage(const CFLImage& fliSourceImage, int32_t i32SourcePageIndex = -1, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult PushBackPage(const CFLImage* pFliSourceImage, int32_t i32SourcePageIndex = -1, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult PushBackPages(const CFLImage& fliSourceImage, int32_t i32StartPageIndex = 0, int32_t i32PageCount = -1, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult PushBackPages(const CFLImage* pFliSourceImage, int32_t i32StartPageIndex = 0, int32_t i32PageCount = -1, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult PushBackPages(const CFLImage& fliSourceImage, const CFLArray<int32_t>& flaPageIndices, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult PushBackPages(const CFLImage* pFliSourceImage, const CFLArray<int32_t>& flaPageIndices, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult PushFrontPage(const CFLImage& fliSourceImage, int32_t i32SourcePageIndex = -1, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult PushFrontPage(const CFLImage* pFliSourceImage, int32_t i32SourcePageIndex = -1, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult PushFrontPages(const CFLImage& fliSourceImage, int32_t i32StartPageIndex = 0, int32_t i32PageCount = -1, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult PushFrontPages(const CFLImage* pFliSourceImage, int32_t i32StartPageIndex = 0, int32_t i32PageCount = -1, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult PushFrontPages(const CFLImage& fliSourceImage, const CFLArray<int32_t>& flaPageIndices, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult PushFrontPages(const CFLImage* pFliSourceImage, const CFLArray<int32_t>& flaPageIndices, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult InsertPage(const CFLImage& fliSourceImage, int32_t i32PageIndexToInsert = -1, int32_t i32SourcePageIndex = -1, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult InsertPage(const CFLImage* pFliSourceImage, int32_t i32PageIndexToInsert = -1, int32_t i32SourcePageIndex = -1, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult InsertPages(const CFLImage& fliSourceImage, int32_t i32PageIndexToInsert = -1, int32_t i32StartPageIndex = 0, int32_t i32PageCount = -1, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult InsertPages(const CFLImage* pFliSourceImage, int32_t i32PageIndexToInsert = -1, int32_t i32StartPageIndex = 0, int32_t i32PageCount = -1, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult InsertPages(const CFLImage& fliSourceImage, int32_t i32PageIndexToInsert, const CFLArray<int32_t>& flaPageIndices, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult InsertPages(const CFLImage* pFliSourceImage, int32_t i32PageIndexToInsert, const CFLArray<int32_t>& flaPageIndices, bool bDeepCopy = true, bool bDeepCopyFigure = true);
 
            virtual const CResult ResizePage(int32_t i32Resize);
 
 
            virtual const CResult RemovePage(int32_t i32PageIndex = -1);
 
            virtual const CResult RemovePages(Base::CFLArray<int32_t>& flaPageIndices);
 
            virtual const CResult MovePageAt(int32_t i32TargetPageIndex, int32_t i32SourcePageIndex = -1);
 
            virtual const CResult SwapPage(CFLImage& fliTargetImage, int32_t i32OwnPageIndex = -1, int32_t i32TargetPageIndex = -1);
 
            virtual const CResult SwapPage(CFLImage* pFliTargetImage, int32_t i32OwnPageIndex = -1, int32_t i32TargetPageIndex = -1);
 
            virtual int32_t GetPageCount() const;
 
            virtual int32_t GetSelectedPageIndex() const;
 
            virtual int32_t SelectPage(int32_t i32PageIndex) const;
 
            virtual int32_t MoveToNextPage() const;
 
            virtual int32_t MoveToPreviousPage() const;
 
            virtual wchar_t* GetPageName() const;
 
            virtual const CResult SetPageName(const wchar_t arrWcsPageName[256]);
 
            virtual const CFLImagePage* GetPage(int32_t i32Index = -1) const;
 
            virtual const CFLImagePage* GetSelectedPage() const;
 
 
 
            // Following functions are only applied to own page
 
            virtual const CResult ClearPage(int32_t i32PageIndex = -1);
 
            virtual uint8_t* GetBuffer() const;
 
            virtual int64_t GetImageSizeByte() const;
 
            virtual int64_t GetWidth() const;
 
            virtual int64_t GetHeight() const;
 
            virtual int32_t GetChannels() const;
 
            virtual int32_t GetDepth() const;
 
            virtual int32_t GetAlignByte() const;
 
            virtual int32_t GetPixelSizeBit() const;
 
            virtual int32_t GetPixelSizeByte() const;
 
            virtual int64_t GetWidthStepByte() const;
 
            virtual const int64_t GetSeparatedChannelStepByte() const;
 
            virtual const CResult ClearFileNameWithPath();
 
            virtual const CResult SetFileNameWithPath(const wchar_t* pWcsFileNameWithPath);
 
            virtual const wchar_t* GetFileName() const;
 
            virtual const wchar_t* GetFileNameWithPath() const;
 
            virtual bool IsFloatingPoint() const;
 
            virtual bool IsSigned() const;
 
            virtual bool IsChannelSeparated() const;
 
            virtual bool IsColor() const;
 
            virtual void SetAutoDestroyBuffer(bool bAutoDestroyBuffer);
 
            virtual bool IsAutoDestroyBuffer() const;
 
            virtual const CResult AddExtraData(const CFLImageExtraDataBase& extData);
 
            virtual const CResult AddExtraData(CFLImageExtraDataBase* pExtData);
 
            virtual const CResult DeleteExtraData(int32_t i32Index) const;
 
            virtual CFLImageExtraDataBase* GetExtraData(int32_t i32Index = 0) const;
 
            virtual CFLImageExtraDataBase* GetExtraData(EImageExtraDataType eDataType, int32_t i32Index = 0) const;
 
            virtual void ClearExtraData();
 
            virtual int32_t GetExtraDataCount() const;
 
 
            template <typename T>
            const CResult GetPixel(int64_t i64Column, int64_t i64Row, T& tPixel) const;
 
            template <typename T>
            const CResult GetPixel(int64_t i64Column, int64_t i64Row, T& tPixel0, T& tPixel1, T& tPixel2) const;
 
            template <typename T>
            const CResult GetPixel(int64_t i64Column, int64_t i64Row, CFLArray<T>& flaPixel) const;
 
 
            template <typename T>
            void GetPixelUnsafe(int64_t i64Column, int64_t i64Row, T& tPixel) const;
 
            template <typename T>
            void GetPixelUnsafe(int64_t i64Column, int64_t i64Row, T& tPixel0, T& tPixel1, T& tPixel2) const;
 
            template <typename T>
            void GetPixelUnsafe(int64_t i64Column, int64_t i64Row, CFLArray<T>& flaPixel) const;
 
 
            template <typename T>
            const CResult GetSubPixel(float f32Column, float f32Row, T& tSubPixel) const;
 
            template <typename T>
            const CResult GetSubPixel(float f32Column, float f32Row, T& tSubPixel0, T& tSubPixel1, T& tSubPixel2) const;
 
 
            virtual const CResult Create(int64_t i64Width, int64_t i64Height, const CMultiVarL flmvFillValue = CMultiVarL(), EPixelFormat ePixelFormat = EPixelFormat_C1_U8, int32_t i32AlignByte = 4, int64_t i64WidthStepByte = 0) sealed;
 
            virtual const CResult Create(int64_t i64Width, int64_t i64Height, const CMultiVarUL flmvFillValue, EPixelFormat ePixelFormat = EPixelFormat_C1_U8, int32_t i32AlignByte = 4, int64_t i64WidthStepByte = 0) sealed;
 
            virtual const CResult Create(int64_t i64Width, int64_t i64Height, const CMultiVarLL flmvFillValue, EPixelFormat ePixelFormat = EPixelFormat_C1_U8, int32_t i32AlignByte = 4, int64_t i64WidthStepByte = 0) sealed;
 
            virtual const CResult Create(int64_t i64Width, int64_t i64Height, const CMultiVarULL flmvFillValue, EPixelFormat ePixelFormat = EPixelFormat_C1_U8, int32_t i32AlignByte = 4, int64_t i64WidthStepByte = 0) sealed;
 
            virtual const CResult Create(int64_t i64Width, int64_t i64Height, const CMultiVarF flmvFillValue, EPixelFormat ePixelFormat = EPixelFormat_C1_U8, int32_t i32AlignByte = 4, int64_t i64WidthStepByte = 0) sealed;
 
            virtual const CResult Create(int64_t i64Width, int64_t i64Height, const CMultiVarD flmvFillValue, EPixelFormat ePixelFormat = EPixelFormat_C1_U8, int32_t i32AlignByte = 4, int64_t i64WidthStepByte = 0) sealed;
 
 
            virtual const CResult Create(int64_t i64Width, int64_t i64Height, const uint8_t* pU8Buffer, EPixelFormat ePixelFormat = EPixelFormat_C1_U8, int32_t i32AlignByte = 4, int64_t i64WidthStepByte = 0) sealed;
 
 
            virtual const CResult SetBuffer(const uint8_t* pU8Buffer, int64_t i64Width, int64_t i64Height, EPixelFormat ePixelFormat = EPixelFormat_C1_U8, int32_t i32AlignByte = 4, bool bAutoDestroy = false, bool bClear = true, int64_t i64WidthStepByte = 0) sealed;
 
            virtual EPixelFormat GetPixelFormat() const;
 
            virtual const CResult SetPixelFormat(EPixelFormat ePixelFormat);
 
 
            static EPixelFormat MakePixelFormat(int32_t i32Channel = 1, int32_t i32Depth = 8, EValueType eType = EValueType_Unsigned, bool bSeparatedChannels = false);
 
            virtual EValueType GetValueType() const;
 
 
            virtual int32_t CalculatePixelSizeBit(int32_t i32Channels = 0, int32_t i32Depth = 0) const;
 
            virtual int32_t CalculatePixelSizeByte(int32_t i32Channels = 0, int32_t i32Depth = 0) const;
 
            virtual int32_t CalculatePixelSizeBit(EPixelFormat eFormat) const;
 
            virtual int32_t CalculatePixelSizeByte(EPixelFormat eFormat) const;
 
            virtual int64_t CalculateWidthStep(int64_t i64Width, EPixelFormat ePixelFormat, int32_t i32AlignByte) const;
 
            virtual const CResult GetXOffsetTable(int64_t*& pI64XOffset) const;
 
            virtual const CResult GetYOffsetTable(uint8_t**& ppU8YOffset) const;
 
            virtual int64_t* GetXOffsetTable() const;
 
            virtual uint8_t** GetYOffsetTable() const;
 
 
 
            virtual int32_t GetFigureCount() const;
 
            virtual const wchar_t* GetFigure(int32_t i32Index) const;
 
            virtual int32_t PushBackFigure(const wchar_t* pWcsFigure);
 
            virtual const CResult DeleteFigureAt(int32_t i32Index);
 
            virtual int32_t InsertFigureAt(int32_t i32Index, const wchar_t* pWcsFigure);
 
            virtual int32_t SetFigureAt(int32_t i32Index, const wchar_t* pWcsFigure);
 
            virtual const CResult ClearFigures(int32_t i32PageNumber = -1);
 
            virtual const CResult ClearFiguresAllPages();
 
            virtual const CFLArray<wchar_t*>* GetFigures() const;
 
            virtual bool IsSpecEqual(const CFLImage* pFliTargetImage) const;
 
            virtual bool IsSpecEqual(const CFLImage& fliTargetImage) const;
 
            virtual bool IsPageSpecEqual(const CFLImage* pFliTargetImage, int32_t i32OwnPageIndex = -1, int32_t i32TargetPageIndex = -1) const;
 
            virtual bool IsPageSpecEqual(const CFLImage& fliTargetImage, int32_t i32OwnPageIndex = -1, int32_t i32TargetPageIndex = -1) const;
 
            virtual bool IsPageSpecEqual(const CFLImagePage* pFlipTargetPage, int32_t i32OwnPageIndex = -1) const;
 
            virtual bool IsPageSpecEqual(const CFLImagePage& flipTargetPage, int32_t i32OwnPageIndex = -1) const;
 
            static bool IsImageObjectAlive(CFLImage* pFliImage);
 
            virtual int32_t GetVersion() const;
 
            DeclareGetClassType();
 
 
 
 
        protected:
            virtual const CResult CreateOffsetTable();
            virtual void Init();
            virtual void FreeBuffers();
 
            int32_t m_i32SelectedPageIndex;
            std::vector<CFLImagePage*>* m_pVctPages;
 
            CFLImagePage* m_pFlipSelectedPage;
 
        private:
            const uint64_t m_i64Magic;
        };
    }
}