Image.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2025 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.    
//---------------------------------------------------------------------------------------
#ifndef PDFTRON_H_CPPPDFImage
#define PDFTRON_H_CPPPDFImage
 
#include <PDF/GState.h>
#include <C/PDF/TRN_Image.h>
 
 
namespace pdftron { 
    namespace PDF {
 
class Image
{
public:

     static Image Create(SDF::SDFDoc& doc, const UString& filename, SDF::Obj encoder_hints = 0);

     static Image Create(SDF::SDFDoc& doc,
         const unsigned char* buf,
         size_t buf_size,
        int width,
        int height,
        int bpc, 
        ColorSpace color_space, 
        SDF::Obj encoder_hints = 0);

     static Image Create(SDF::SDFDoc& doc,
        Filters::FilterReader& image_data,
        int width,
        int height,
        int bpc, 
        ColorSpace color_space, 
        SDF::Obj encoder_hints = 0);

     static Image Create(SDF::SDFDoc& doc,
         const unsigned char* buf,
         size_t buf_size,
         SDF::Obj encoder_hints = 0);

     static Image Create(SDF::SDFDoc& doc,
         Filters::Filter image_data,
         SDF::Obj encoder_hints = 0);

    #if defined(_WIN32)
     static Image Create(SDF::SDFDoc& doc, Gdiplus::Bitmap* bmp, SDF::Obj encoder_hints = 0);
    #endif

     static Image CreateImageMask(SDF::SDFDoc& doc,
         const char* buf,
         size_t buf_size,
        int width,
        int height,
        SDF::Obj encoder_hints = 0);
 
     static Image CreateImageMask(SDF::SDFDoc& doc,
        Filters::FilterReader& image_data,                  
        int width,
        int height,
        SDF::Obj encoder_hints = 0);

     static Image CreateSoftMask(SDF::SDFDoc& doc,
         const char* buf,
         size_t buf_size,
        int width,
        int height,
        int bpc, 
        SDF::Obj encoder_hints = 0);
 
     static Image CreateSoftMask(SDF::SDFDoc& doc,
        Filters::FilterReader& image_data,                  
        int width,
        int height,
        int bpc, 
        SDF::Obj encoder_hints = 0);
 
    // ------------------------------------------------
 
    enum InputFilter
    {
        e_none,     // Input stream is not compressed
        e_jpeg,     // Input image is a JPEG image
        e_jp2,      // Input image is a JP2 (JPEG2000) image
        e_flate,    // Input image is a Flate compressed
        e_g3,       // Input image is a G3 stream
        e_g4,       // Input image is a G4 stream
        e_ascii_hex // Input image stream compressed using ASCIIHexDecode filter
    };
 
     static Image Create(SDF::SDFDoc& doc,
         const char* buf,
         size_t buf_size,
        int width, 
        int height, 
        int bpc, 
        ColorSpace color_space,
        InputFilter input_format);
 

     static Image Create(SDF::SDFDoc& doc,
        Filters::FilterReader& image_data,                  
        int width, 
        int height, 
        int bpc, 
        ColorSpace color_space,
        InputFilter input_format);

     Image(SDF::Obj image_xobject = 0);
 
     Image(const Image&);
     Image& operator=(const Image&);

     SDF::Obj GetSDFObj () const;
     
     bool IsValid() const;

     Filters::Filter GetImageData() const;

     int GetImageDataSize() const;

    #if defined(_WIN32)
     Gdiplus::Bitmap* GetBitmap() const;
    #endif

     ColorSpace GetImageColorSpace() const;

     int GetImageWidth() const;

     int GetImageHeight() const;

     SDF::Obj GetDecodeArray() const;

     int GetBitsPerComponent() const;

     int GetComponentNum() const;

     bool IsImageMask() const;

     bool IsImageInterpolate() const; 

     SDF::Obj GetMask() const; 

     void SetMask(Image& image_mask); 
 
     void SetMask(SDF::Obj mask); 

     SDF::Obj GetSoftMask();

     void SetSoftMask(Image& soft_mask);

     GState::RenderingIntent GetImageRenderingIntent() const;
    
     int Export(const UString& filename);

     int Export(Filters::FilterWriter& writer);

     void ExportAsTiff(const UString& filename);

     void ExportAsTiff(Filters::FilterWriter& writer);

     void ExportAsPng(const UString& filename);

     void ExportAsPng(Filters::FilterWriter& writer);
 
 
// @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
    Image(TRN_Image impl);
    TRN_Image mp_image;
#endif
// @endcond
};
 
 
 
#include <Impl/Image.inl>
 
    };  // namespace PDF
};  // namespace pdftron
 
#endif // PDFTRON_H_CPPPDFImage