core/include/fxcodec/fx_codec.h

// Copyright 2014 PDFium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com

#ifndef CORE_INCLUDE_FXCODEC_FX_CODEC_H_
#define CORE_INCLUDE_FXCODEC_FX_CODEC_H_

#include <map>
#include <memory>
#include <vector>

#include "core/fxcrt/include/fx_basic.h"
#include "core/fxcrt/include/fx_coordinates.h"  // For FX_RECT.
#include "core/include/fxcodec/fx_codec_def.h"

class CFX_DIBSource;
class CJPX_Decoder;
class CPDF_ColorSpace;
class CPDF_StreamAcc;
class ICodec_BasicModule;
class ICodec_FaxModule;
class ICodec_FlateModule;
class ICodec_IccModule;
class ICodec_Jbig2Encoder;
class ICodec_Jbig2Module;
class ICodec_JpegModule;
class ICodec_JpxModule;
class ICodec_ScanlineDecoder;

#ifdef PDF_ENABLE_XFA
class ICodec_BmpModule;
class ICodec_GifModule;
class ICodec_PngModule;
class ICodec_ProgressiveDecoder;
class ICodec_TiffModule;
#endif  // PDF_ENABLE_XFA

#ifdef PDF_ENABLE_XFA
class CFX_DIBAttribute {
 public:
  CFX_DIBAttribute();
  ~CFX_DIBAttribute();

  int32_t m_nXDPI;
  int32_t m_nYDPI;
  FX_FLOAT m_fAspectRatio;
  uint16_t m_wDPIUnit;
  CFX_ByteString m_strAuthor;
  uint8_t m_strTime[20];
  int32_t m_nGifLeft;
  int32_t m_nGifTop;
  uint32_t* m_pGifLocalPalette;
  uint32_t m_nGifLocalPalNum;
  int32_t m_nBmpCompressType;
  std::map<uint32_t, void*> m_Exif;
};
#endif  // PDF_ENABLE_XFA

class CCodec_ModuleMgr {
 public:
  CCodec_ModuleMgr();

  ICodec_BasicModule* GetBasicModule() const { return m_pBasicModule.get(); }
  ICodec_FaxModule* GetFaxModule() const { return m_pFaxModule.get(); }
  ICodec_JpegModule* GetJpegModule() const { return m_pJpegModule.get(); }
  ICodec_JpxModule* GetJpxModule() const { return m_pJpxModule.get(); }
  ICodec_Jbig2Module* GetJbig2Module() const { return m_pJbig2Module.get(); }
  ICodec_IccModule* GetIccModule() const { return m_pIccModule.get(); }
  ICodec_FlateModule* GetFlateModule() const { return m_pFlateModule.get(); }

#ifdef PDF_ENABLE_XFA
  ICodec_ProgressiveDecoder* CreateProgressiveDecoder();
  ICodec_PngModule* GetPngModule() const { return m_pPngModule.get(); }
  ICodec_GifModule* GetGifModule() const { return m_pGifModule.get(); }
  ICodec_BmpModule* GetBmpModule() const { return m_pBmpModule.get(); }
  ICodec_TiffModule* GetTiffModule() const { return m_pTiffModule.get(); }
#endif  // PDF_ENABLE_XFA

 protected:
  std::unique_ptr<ICodec_BasicModule> m_pBasicModule;
  std::unique_ptr<ICodec_FaxModule> m_pFaxModule;
  std::unique_ptr<ICodec_JpegModule> m_pJpegModule;
  std::unique_ptr<ICodec_JpxModule> m_pJpxModule;
  std::unique_ptr<ICodec_Jbig2Module> m_pJbig2Module;
  std::unique_ptr<ICodec_IccModule> m_pIccModule;
#ifdef PDF_ENABLE_XFA
  std::unique_ptr<ICodec_PngModule> m_pPngModule;
  std::unique_ptr<ICodec_GifModule> m_pGifModule;
  std::unique_ptr<ICodec_BmpModule> m_pBmpModule;
  std::unique_ptr<ICodec_TiffModule> m_pTiffModule;
#endif  // PDF_ENABLE_XFA
  std::unique_ptr<ICodec_FlateModule> m_pFlateModule;
};
class ICodec_BasicModule {
 public:
  virtual ~ICodec_BasicModule() {}
  virtual FX_BOOL RunLengthEncode(const uint8_t* src_buf,
                                  uint32_t src_size,
                                  uint8_t*& dest_buf,
                                  uint32_t& dest_size) = 0;
  virtual FX_BOOL A85Encode(const uint8_t* src_buf,
                            uint32_t src_size,
                            uint8_t*& dest_buf,
                            uint32_t& dest_size) = 0;
  virtual ICodec_ScanlineDecoder* CreateRunLengthDecoder(const uint8_t* src_buf,
                                                         uint32_t src_size,
                                                         int width,
                                                         int height,
                                                         int nComps,
                                                         int bpc) = 0;
};

class ICodec_ScanlineDecoder {
 public:
  virtual ~ICodec_ScanlineDecoder() {}

  virtual uint32_t GetSrcOffset() = 0;

  virtual void DownScale(int dest_width, int dest_height) = 0;

  virtual const uint8_t* GetScanline(int line) = 0;

  virtual FX_BOOL SkipToScanline(int line, IFX_Pause* pPause) = 0;

  virtual int GetWidth() = 0;

  virtual int GetHeight() = 0;

  virtual int CountComps() = 0;

  virtual int GetBPC() = 0;

  virtual FX_BOOL IsColorTransformed() = 0;

  virtual void ClearImageData() = 0;
};

class ICodec_FlateModule {
 public:
  virtual ~ICodec_FlateModule() {}
  virtual ICodec_ScanlineDecoder* CreateDecoder(const uint8_t* src_buf,
                                                uint32_t src_size,
                                                int width,
                                                int height,
                                                int nComps,
                                                int bpc,
                                                int predictor,
                                                int Colors,
                                                int BitsPerComponent,
                                                int Columns) = 0;
  virtual uint32_t FlateOrLZWDecode(FX_BOOL bLZW,
                                    const uint8_t* src_buf,
                                    uint32_t src_size,
                                    FX_BOOL bEarlyChange,
                                    int predictor,
                                    int Colors,
                                    int BitsPerComponent,
                                    int Columns,
                                    uint32_t estimated_size,
                                    uint8_t*& dest_buf,
                                    uint32_t& dest_size) = 0;
  virtual FX_BOOL Encode(const uint8_t* src_buf,
                         uint32_t src_size,
                         int predictor,
                         int Colors,
                         int BitsPerComponent,
                         int Columns,
                         uint8_t*& dest_buf,
                         uint32_t& dest_size) = 0;
  virtual FX_BOOL Encode(const uint8_t* src_buf,
                         uint32_t src_size,
                         uint8_t*& dest_buf,
                         uint32_t& dest_size) = 0;
};
class ICodec_FaxModule {
 public:
  virtual ~ICodec_FaxModule() {}

  virtual ICodec_ScanlineDecoder* CreateDecoder(const uint8_t* src_buf,
                                                uint32_t src_size,
                                                int width,
                                                int height,
                                                int K,
                                                FX_BOOL EndOfLine,
                                                FX_BOOL EncodedByteAlign,
                                                FX_BOOL BlackIs1,
                                                int Columns,
                                                int Rows) = 0;

  virtual FX_BOOL Encode(const uint8_t* src_buf,
                         int width,
                         int height,
                         int pitch,
                         uint8_t*& dest_buf,
                         uint32_t& dest_size) = 0;
};
class ICodec_JpegModule {
 public:
  virtual ~ICodec_JpegModule() {}

  virtual ICodec_ScanlineDecoder* CreateDecoder(const uint8_t* src_buf,
                                                uint32_t src_size,
                                                int width,
                                                int height,
                                                int nComps,
                                                FX_BOOL ColorTransform) = 0;

  virtual FX_BOOL LoadInfo(const uint8_t* src_buf,
                           uint32_t src_size,
                           int& width,
                           int& height,
                           int& num_components,
                           int& bits_per_components,
                           FX_BOOL& color_transform,
                           uint8_t** icc_buf_ptr = NULL,
                           uint32_t* icc_length = NULL) = 0;

  virtual FX_BOOL Encode(const class CFX_DIBSource* pSource,
                         uint8_t*& dest_buf,
                         FX_STRSIZE& dest_size,
                         int quality = 75,
                         const uint8_t* icc_buf = NULL,
                         uint32_t icc_length = 0) = 0;

  virtual void* Start() = 0;

  virtual void Finish(void* pContext) = 0;

  virtual void Input(void* pContext,
                     const uint8_t* src_buf,
                     uint32_t src_size) = 0;

#ifdef PDF_ENABLE_XFA
  virtual int ReadHeader(void* pContext,
                         int* width,
                         int* height,
                         int* nComps,
                         CFX_DIBAttribute* pAttribute) = 0;
#else   // PDF_ENABLE_XFA
  virtual int ReadHeader(void* pContext,
                         int* width,
                         int* height,
                         int* nComps) = 0;
#endif  // PDF_ENABLE_XFA

  virtual int StartScanline(void* pContext, int down_scale) = 0;

  virtual FX_BOOL ReadScanline(void* pContext, uint8_t* dest_buf) = 0;

  virtual uint32_t GetAvailInput(void* pContext,
                                 uint8_t** avail_buf_ptr = NULL) = 0;
};

class ICodec_JpxModule {
 public:
  virtual ~ICodec_JpxModule() {}

  virtual CJPX_Decoder* CreateDecoder(const uint8_t* src_buf,
                                      uint32_t src_size,
                                      CPDF_ColorSpace* cs) = 0;

  virtual void GetImageInfo(CJPX_Decoder* pDecoder,
                            uint32_t* width,
                            uint32_t* height,
                            uint32_t* components) = 0;

  virtual bool Decode(CJPX_Decoder* pDecoder,
                      uint8_t* dest_data,
                      int pitch,
                      const std::vector<uint8_t>& offsets) = 0;

  virtual void DestroyDecoder(CJPX_Decoder* pDecoder) = 0;
};
#ifdef PDF_ENABLE_XFA
class ICodec_PngModule {
 public:
  virtual ~ICodec_PngModule() {}

  virtual void* Start(void* pModule) = 0;

  virtual void Finish(void* pContext) = 0;

  virtual FX_BOOL Input(void* pContext,
                        const uint8_t* src_buf,
                        uint32_t src_size,
                        CFX_DIBAttribute* pAttribute) = 0;

  FX_BOOL (*ReadHeaderCallback)(void* pModule,
                                int width,
                                int height,
                                int bpc,
                                int pass,
                                int* color_type,
                                double* gamma);

  FX_BOOL (*AskScanlineBufCallback)(void* pModule, int line, uint8_t*& src_buf);

  void (*FillScanlineBufCompletedCallback)(void* pModule, int pass, int line);
};
class ICodec_GifModule {
 public:
  virtual ~ICodec_GifModule() {}

  virtual void* Start(void* pModule) = 0;

  virtual void Finish(void* pContext) = 0;

  virtual uint32_t GetAvailInput(void* pContext,
                                 uint8_t** avail_buf_ptr = NULL) = 0;

  virtual void Input(void* pContext,
                     const uint8_t* src_buf,
                     uint32_t src_size) = 0;

  virtual int32_t ReadHeader(void* pContext,
                             int* width,
                             int* height,
                             int* pal_num,
                             void** pal_pp,
                             int* bg_index,
                             CFX_DIBAttribute* pAttribute) = 0;

  virtual int32_t LoadFrameInfo(void* pContext, int* frame_num) = 0;

  void (*RecordCurrentPositionCallback)(void* pModule, uint32_t& cur_pos);

  uint8_t* (*AskLocalPaletteBufCallback)(void* pModule,
                                         int32_t frame_num,
                                         int32_t pal_size);

  virtual int32_t LoadFrame(void* pContext,
                            int frame_num,
                            CFX_DIBAttribute* pAttribute) = 0;

  FX_BOOL (*InputRecordPositionBufCallback)(void* pModule,
                                            uint32_t rcd_pos,
                                            const FX_RECT& img_rc,
                                            int32_t pal_num,
                                            void* pal_ptr,
                                            int32_t delay_time,
                                            FX_BOOL user_input,
                                            int32_t trans_index,
                                            int32_t disposal_method,
                                            FX_BOOL interlace);

  void (*ReadScanlineCallback)(void* pModule,
                               int32_t row_num,
                               uint8_t* row_buf);
};
class ICodec_BmpModule {
 public:
  virtual ~ICodec_BmpModule() {}

  virtual void* Start(void* pModule) = 0;

  virtual void Finish(void* pContext) = 0;

  virtual uint32_t GetAvailInput(void* pContext,
                                 uint8_t** avail_buf_ptr = NULL) = 0;

  virtual void Input(void* pContext,
                     const uint8_t* src_buf,
                     uint32_t src_size) = 0;

  virtual int32_t ReadHeader(void* pContext,
                             int32_t* width,
                             int32_t* height,
                             FX_BOOL* tb_flag,
                             int32_t* components,
                             int* pal_num,
                             uint32_t** pal_pp,
                             CFX_DIBAttribute* pAttribute) = 0;

  virtual int32_t LoadImage(void* pContext) = 0;

  FX_BOOL (*InputImagePositionBufCallback)(void* pModule, uint32_t rcd_pos);

  void (*ReadScanlineCallback)(void* pModule,
                               int32_t row_num,
                               uint8_t* row_buf);
};
class ICodec_TiffModule {
 public:
  virtual ~ICodec_TiffModule() {}

  virtual void* CreateDecoder(IFX_FileRead* file_ptr) = 0;

  virtual void GetFrames(void* ctx, int32_t& frames) = 0;

  virtual FX_BOOL LoadFrameInfo(void* ctx,
                                int32_t frame,
                                uint32_t& width,
                                uint32_t& height,
                                uint32_t& comps,
                                uint32_t& bpc,
                                CFX_DIBAttribute* pAttribute) = 0;

  virtual FX_BOOL Decode(void* ctx, class CFX_DIBitmap* pDIBitmap) = 0;

  virtual void DestroyDecoder(void* ctx) = 0;
};
#endif

class ICodec_Jbig2Module {
 public:
  virtual ~ICodec_Jbig2Module() {}

  virtual void* CreateJbig2Context() = 0;

  virtual FXCODEC_STATUS StartDecode(void* pJbig2Context,
                                     CFX_PrivateData* pPrivateData,
                                     uint32_t width,
                                     uint32_t height,
                                     CPDF_StreamAcc* src_stream,
                                     CPDF_StreamAcc* global_stream,
                                     uint8_t* dest_buf,
                                     uint32_t dest_pitch,
                                     IFX_Pause* pPause) = 0;

  virtual FXCODEC_STATUS ContinueDecode(void* pJbig2Content,
                                        IFX_Pause* pPause) = 0;
  virtual void DestroyJbig2Context(void* pJbig2Content) = 0;
};
#ifdef PDF_ENABLE_XFA
class ICodec_ProgressiveDecoder {
 public:
  virtual ~ICodec_ProgressiveDecoder() {}

  virtual FXCODEC_STATUS LoadImageInfo(IFX_FileRead* pFile,
                                       FXCODEC_IMAGE_TYPE imageType,
                                       CFX_DIBAttribute* pAttribute) = 0;

  virtual FXCODEC_IMAGE_TYPE GetType() const = 0;
  virtual int32_t GetWidth() const = 0;
  virtual int32_t GetHeight() const = 0;
  virtual int32_t GetNumComponents() const = 0;
  virtual int32_t GetBPC() const = 0;

  virtual void SetClipBox(FX_RECT* clip) = 0;

  virtual FXCODEC_STATUS GetFrames(int32_t& frames,
                                   IFX_Pause* pPause = NULL) = 0;

  virtual FXCODEC_STATUS StartDecode(class CFX_DIBitmap* pDIBitmap,
                                     int32_t start_x,
                                     int32_t start_y,
                                     int32_t size_x,
                                     int32_t size_y,
                                     int32_t frames = 0,
                                     FX_BOOL bInterpol = TRUE) = 0;

  virtual FXCODEC_STATUS ContinueDecode(IFX_Pause* pPause = NULL) = 0;
};
#endif  // PDF_ENABLE_XFA
class ICodec_Jbig2Encoder {
 public:
  virtual ~ICodec_Jbig2Encoder() {}
};

class ICodec_IccModule {
 public:
  enum IccCS {
    IccCS_Unknown = 0,
    IccCS_XYZ,
    IccCS_Lab,
    IccCS_Luv,
    IccCS_YCbCr,
    IccCS_Yxy,
    IccCS_Hsv,
    IccCS_Hls,
    IccCS_Gray,
    IccCS_Rgb,
    IccCS_Cmyk,
    IccCS_Cmy
  };

  struct IccParam {
    uint32_t Version;
    IccCS ColorSpace;
    uint32_t dwProfileType;
    uint32_t dwFormat;
    uint8_t* pProfileData;
    uint32_t dwProfileSize;
    double Gamma;
  };

  virtual ~ICodec_IccModule() {}

  virtual IccCS GetProfileCS(const uint8_t* pProfileData,
                             unsigned int dwProfileSize) = 0;

  virtual IccCS GetProfileCS(IFX_FileRead* pFile) = 0;

  virtual void* CreateTransform(
      ICodec_IccModule::IccParam* pInputParam,
      ICodec_IccModule::IccParam* pOutputParam,
      ICodec_IccModule::IccParam* pProofParam = NULL,
      uint32_t dwIntent = Icc_INTENT_PERCEPTUAL,
      uint32_t dwFlag = Icc_FLAGS_DEFAULT,
      uint32_t dwPrfIntent = Icc_INTENT_ABSOLUTE_COLORIMETRIC,
      uint32_t dwPrfFlag = Icc_FLAGS_SOFTPROOFING) = 0;

  virtual void* CreateTransform_sRGB(
      const uint8_t* pProfileData,
      uint32_t dwProfileSize,
      uint32_t& nComponents,
      int32_t intent = 0,
      uint32_t dwSrcFormat = Icc_FORMAT_DEFAULT) = 0;

  virtual void* CreateTransform_CMYK(
      const uint8_t* pSrcProfileData,
      uint32_t dwSrcProfileSize,
      uint32_t& nSrcComponents,
      const uint8_t* pDstProfileData,
      uint32_t dwDstProfileSize,
      int32_t intent = 0,
      uint32_t dwSrcFormat = Icc_FORMAT_DEFAULT,
      uint32_t dwDstFormat = Icc_FORMAT_DEFAULT) = 0;

  virtual void DestroyTransform(void* pTransform) = 0;

  virtual void Translate(void* pTransform,
                         FX_FLOAT* pSrcValues,
                         FX_FLOAT* pDestValues) = 0;

  virtual void TranslateScanline(void* pTransform,
                                 uint8_t* pDest,
                                 const uint8_t* pSrc,
                                 int pixels) = 0;
  virtual void SetComponents(uint32_t nComponents) = 0;
};

void ReverseRGB(uint8_t* pDestBuf, const uint8_t* pSrcBuf, int pixels);
void sRGB_to_AdobeCMYK(FX_FLOAT R,
                       FX_FLOAT G,
                       FX_FLOAT B,
                       FX_FLOAT& c,
                       FX_FLOAT& m,
                       FX_FLOAT& y,
                       FX_FLOAT& k);
void AdobeCMYK_to_sRGB(FX_FLOAT c,
                       FX_FLOAT m,
                       FX_FLOAT y,
                       FX_FLOAT k,
                       FX_FLOAT& R,
                       FX_FLOAT& G,
                       FX_FLOAT& B);
void AdobeCMYK_to_sRGB1(uint8_t c,
                        uint8_t m,
                        uint8_t y,
                        uint8_t k,
                        uint8_t& R,
                        uint8_t& G,
                        uint8_t& B);
FX_BOOL MD5ComputeID(const void* buf, uint32_t dwSize, uint8_t ID[16]);
void FaxG4Decode(const uint8_t* src_buf,
                 uint32_t src_size,
                 int* pbitpos,
                 uint8_t* dest_buf,
                 int width,
                 int height,
                 int pitch);

#endif  // CORE_INCLUDE_FXCODEC_FX_CODEC_H_