fs_image.h

Go to the documentation of this file.

#ifndef FS_IMAGE_H_
#define FS_IMAGE_H_

#include "common/fs_common.h"
#include "common/file/fs_file.h"

namespace foxit {
namespace common {
class Bitmap FS_FINAL : public Base {
 public:
  typedef enum _DIBFormat {
    e_DIBInvalid = 0,
    e_DIB1bpp = 0x001,
    e_DIBRgb = 0x018,
    e_DIBRgb32 = 0x020,
    e_DIBArgb = 0x220,
    e_DIBCmyk = 0x420,
    e_DIB8bppMask = 0x108,
    e_DIB8bpp = 0x008,
    e_DIB8bppGray = 0x1008,
    e_DIBAbgr = 0x222,
    e_DIBRgb565 = 0x565
  } DIBFormat;
  
  typedef enum _InterpolationFlag {
    e_Downsample = 0x01,
    e_Quadratic = 0x02,
    e_Bicubic = 0x04
  } InterpolationFlag;
  

  Bitmap(int width, int height, DIBFormat format, uint8* buffer = NULL, int pitch = 0);
  Bitmap(const Bitmap& other);
  Bitmap();

  ~Bitmap();

  Bitmap& operator = (const Bitmap& other);
  bool operator == (const Bitmap& other) const;
  bool operator != (const Bitmap& other) const;

  bool IsEmpty() const;

  Bitmap Clone(const RectI* clip_rect = NULL) const;

  int GetWidth() const;
  int GetHeight() const;
  int GetPitch() const;
  int GetBpp() const;
  const uint8* GetBuffer() const;
  DIBFormat GetFormat() const;

  void FillRect(ARGB color, const RectI* rect = NULL);

  Bitmap& ConvertFormat(DIBFormat format, void* icc_transform = NULL);

  RectI CalculateBBoxByColor(ARGB backgroud_color);

  RectI DetectBBoxByColorDiffer(int detection_size, int color_differ = 64);

  Bitmap SwapXY(bool is_flip_horz, bool is_flip_vert, const RectI* clip_rect = NULL);

  Bitmap Flip(bool is_flip_horz, bool is_flip_vert);

  Bitmap StretchTo(int dest_width, int dest_height, InterpolationFlag flag,
                   const RectI* clip_rect = NULL);

  Bitmap TransformTo(const Matrix& matrix, InterpolationFlag flag,
                     int& out_left, int &out_top, const RectI* clip_rect = NULL);

  Bitmap GetMask(const RectI* clip_rect = NULL);

  Bitmap ConvertToMono();

  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
  explicit Bitmap(FS_HANDLE handle);
};

class Image FS_FINAL : public Base {
 public:
  typedef enum _Type {
    e_Unknown  =  -1,
    e_None  =  0,
    e_BMP  =  1,
    e_JPG  =  2,
    e_PNG  =  3,
    e_GIF  =  4,
    e_TIF  =  5,
    e_JPX  =  6,
    e_JBIG2  =  8,
    e_WEBP  =  9
  } Type;
  
  typedef enum _Orientation {
    e_OrientationNone = 0,
    e_OrientationNormal = 1,
    e_OrientationFlipH = 2,
    e_OrientationRotate180 = 3,
    e_OrientationFlipV = 4,
    e_OrientationRotate90FlipH = 5,
    e_OrientationRotate90 = 6,
    e_OrientationRotate270FlipH = 7,
    e_OrientationRotate270 = 8
  } Orientation;
  

  Image();

  explicit Image(const char* path);

  explicit Image(const wchar_t* path);

  explicit Image(const void* buffer, size_t length);

  explicit Image(foxit::common::file::ReaderCallback* file_read);

  ~Image();

  Image(const Image& other);

  Image& operator = (const Image& other);

  bool IsEmpty() const;

  bool operator == (const Image& other) const;
  bool operator != (const Image& other) const;

  Type GetType() const;

  int GetWidth() const;

  int GetHeight() const;

  int GetFrameCount() const;

  Bitmap GetFrameBitmap(int index) const;

  int GetXDPI() const;

  int GetYDPI() const;

  bool AddFrame(const Bitmap& bitmap);

  void SetDPIs(int x_dpi, int y_dpi);

  bool SaveAs(const char* file_path);

  bool SaveAs(const wchar_t* file_path);

  bool SaveAs(foxit::common::file::StreamCallback* file, const wchar_t* file_extension);

  Orientation GetOrientation() const;

  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
  explicit Image(FS_HANDLE handle);
    
};
}  // namespace common
}  // namespace foxit
#endif  // FS_IMAGE_H_