PDFRasterizer.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_CPPPDFRasterizer
#define PDFTRON_H_CPPPDFRasterizer
 
#include <PDF/Page.h>
#include <C/PDF/TRN_PDFRasterizer.h>
#include <PDF/OCG/Context.h>
#ifdef SWIG
#include <PDF/Callback.h>
#endif
#include <C/Common/TRN_Types.h>
 
namespace pdftron { 
    namespace PDF {

enum DownloadedType
{
    e_downloadedtype_page = 0,
    e_downloadedtype_thumb,
    e_downloadedtype_named_dests,
    e_downloadedtype_outline,
    e_downloadedtype_finished,
    e_downloadedtype_failed,
    e_downloadedtype_opened
};
 
class PDFDoc;
typedef void (*DownloadReportHandler) (DownloadedType type, PDFDoc* doc, int page_num, int obj_num, const char* message, void* data);

class Separation : public TRN_separation
{
public:
    Separation();
    ~Separation();
    Separation(const Separation&);
    Separation& operator= (const Separation&);
    UInt8 C() const;
    UInt8 M() const;
    UInt8 Y() const;
    UInt8 K() const;
    UInt32 GetDataSize() const;
    UString GetSeparationName() const;
#ifdef SWIG
    std::vector<unsigned char> GetData() const;
#else
    const UChar* GetData() const;
#endif
 
    UString m_separation_name;
 
private:
    bool m_owner;
};

class PDFRasterizer
{
public:

    enum Type {
        e_BuiltIn,  
        e_GDIPlus   
    }; 

    enum OverprintPreviewMode {
        e_op_off = 0,
        e_op_on,
        e_op_pdfx_on
    };

    PDFRasterizer(Type type = e_BuiltIn);
    ~PDFRasterizer();

#ifndef SWIG
    std::vector<unsigned char> Rasterize(Page& page,
                int width, int height, int stride, 
                int num_comps, bool demult,
                const Common::Matrix2D& device_mtx,
                const Rect* clip = 0,
                const Rect* scrl_clip_regions = 0,
                bool* cancel = 0);
 
    void Rasterize(Page& page, UChar* in_out_image_buffer, 
                int width, int height, int stride, 
                int num_comps, bool demult,
                const Common::Matrix2D& device_mtx,
                const Rect* clip = 0,
                const Rect* scrl_clip_regions = 0,
                bool* cancel = 0);
#else // SWIG
    std::vector<unsigned char> Rasterize(
        Page& page,
        int width,
        int height,
        int stride,
        int num_comps,
        bool demult,
        const Common::Matrix2D& device_mtx,
        const Rect* clip = 0,
        const Rect* scrl_clip_regions = 0
    );
#endif // SWIG

    std::vector<Separation> RasterizeSeparations(
        Page& page,
        int width,
        int height,
        const Common::Matrix2D& mtx,
        const Rect* clip,
        volatile bool* cancel
    );
 
#ifdef _WIN32
    void Rasterize(Page& page, void* hdc, 
        const Common::Matrix2D& device_mtx, 
        const Rect* clip = 0,
        int dpi = -1,
        bool* cancel = 0);
#endif
    void SetDrawAnnotations(bool render_annots);

    void SetHighlightFields(bool highlight_fields);

    void SetDrawUIElements(bool draw_ui_elements);

    void SetAntiAliasing(bool enable_aa);

    void SetPathHinting(bool enable_hinting);

    void SetThinLineAdjustment(bool pixel_grid_fit, bool stroke_adjust);

    void SetThinLineScaling(double scaling);

    void SetNightModeTuning(double contrast, double saturation, double flipness);

    void SetImageSmoothing(bool smoothing_enabled = true, bool hq_image_resampling = false);

    void SetCaching(bool enabled = true);

    void SetGamma(double expgamma);

    void SetOCGContext(OCG::Context* ctx);

    void SetPrintMode(bool is_printing);

    void SetOverprint(OverprintPreviewMode op);

    typedef void (*ErrorReportProc) (const char* message, void* data);

#ifdef SWIG
    void SetErrorReportProc(Callback* instance);
#else
    void SetErrorReportProc(ErrorReportProc error_proc, void* data);
#endif

    void SetRasterizerType (Type type);

    Type GetRasterizerType ();

    enum ColorPostProcessMode
    {
        e_postprocess_none = 0,
        e_postprocess_invert,
        e_postprocess_gradient_map,
        e_postprocess_night_mode
    };
    
     void SetColorPostProcessMode(ColorPostProcessMode mode);

     ColorPostProcessMode GetColorPostProcessMode() const;
 
     void UpdateBuffer();

     void Destroy();
 
// @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
    TRN_PDFRasterizer mp_rast;
private:
    PDFRasterizer(const PDFRasterizer&);
    PDFRasterizer& operator= (const PDFRasterizer&);
#endif
// @endcond
};
 
 
 
#include <Impl/PDFRasterizer.inl>
 
    
    };  // namespace PDF
};  // namespace pdftron
 
#endif // PDFTRON_H_CPPPDFRasterizer