distiller.h

Go to the documentation of this file.

/*
 * Copyright (C) 2021-2026 Hybrid Software Helix Ltd. All rights reserved.
 */
 
#ifndef JAWSMAKO_DISTILLER_H
#define JAWSMAKO_DISTILLER_H

 
#include <memory>
#include <jawsmako/jawsmako.h>
 
namespace JawsMako
{
    using namespace EDL;
 
    class IDistiller;
    DECL_SMART_PTR(IDistiller);
    class IPSCommentMonitor;
    class IPSOutputHandler;
    typedef std::shared_ptr<IPSOutputHandler> IPSOutputHandlerPtr;

    class IDistiller : public IRCObject
    {
      public:
        ~IDistiller() override = default;

        virtual void setParameter(const U8String &param, const U8String &value) = 0;
 
        #define DIST_MAKE_PDF_VERSION(major,minor)     (((major) << 4) | (minor))
        #define DIST_GET_PDF_VERSION_MAJOR(pdfVersion) (((pdfVersion) >> 4) & 0x0f)
        #define DIST_GET_PDF_VERSION_MINOR(pdfVersion) (((pdfVersion) >> 0) & 0x0f)

        typedef enum
        {
            ePDF1_3 = DIST_MAKE_PDF_VERSION(1, 3),  
            ePDF1_4 = DIST_MAKE_PDF_VERSION(1, 4),  
            ePDF1_5 = DIST_MAKE_PDF_VERSION(1, 5),  
            ePDF1_6 = DIST_MAKE_PDF_VERSION(1, 6),  
            ePDF1_7 = DIST_MAKE_PDF_VERSION(1, 7),  
        } ePDFVersion;

        virtual void setPdfVersion(ePDFVersion version) = 0;

        virtual void setCompressPages(bool compressPages) = 0;

        virtual void setAutoRotatePages(bool autoRotatePages) = 0;

        virtual void setSubsetFonts(bool subset) = 0;

        virtual void setEmbedFonts(bool embed) = 0;

        virtual void setEmbedBase14Fonts(bool embed) = 0;

        virtual void setEmbedDiskBasedCidFonts(bool embed) = 0;

        virtual void setResolution(float resolution) = 0;

        typedef enum
        {
            eTRApply,   
            eTRRemove,  
            eTRPreserve 
        } eTransferFunctionMethod;

        virtual void setTransfers(eTransferFunctionMethod transfers) = 0;

        typedef enum
        {
            eICNone,         
            eICAuto,         
            eICFlate,        
            eICFlatePredict, 
            eICDCT,          
            eICLZW,          
            eICCCITT         
        } eImageCompression;

        virtual void setColorImageCompression(eImageCompression compression) = 0;

        virtual void setGrayImageCompression(eImageCompression compression) = 0;

        virtual void setMonoImageCompression(eImageCompression compression) = 0;

        typedef enum
        {
            eJQLow,    
            eJQMedium, 
            eJQHigh,   
            eJQUser    
        } eJpegQuality;

        virtual void setColorJPEGQuality(eJpegQuality quality) = 0;

        virtual void setColorQFactor(float qfactor) = 0;

        virtual void setGrayJPEGQuality(eJpegQuality quality) = 0;

        virtual void setGrayQFactor(float qfactor) = 0;

        typedef enum
        {
            eIDNone,                
            eIDSubsample,           
            eIDAverage,             
            eIDBicubic,             
        } eImageDownsamplingMethod;

        virtual void setColorImageDownsampling(eImageDownsamplingMethod method) = 0;

        virtual void setGrayImageDownsampling(eImageDownsamplingMethod method) = 0;

        virtual void setMonoImageDownsampling(eImageDownsamplingMethod method) = 0;

        virtual void setColorImageResolution(float resolution) = 0;

        virtual void setGrayImageResolution(float resolution) = 0;

        virtual void setMonoImageResolution(float resolution) = 0;

        virtual void setConvertCMYKImagesToRGB(bool convert) = 0;

        virtual void setProlog(const IInputStreamPtr &prolog) = 0;

        virtual void setEpilog(const IInputStreamPtr &epilog) = 0;

        virtual void setDefaultPanoseStyle(const U8String &defaultPanoseStyle) = 0;

        virtual void setPanose(const IInputStreamPtr &panose) = 0;

        virtual void getFontNames(const U8String &font, CU8StringVect &names) = 0;

        virtual void addFont(const U8String &font) = 0;

        virtual void addFonts(const CU8StringVect &fonts) = 0;

        virtual void removeFont(const U8String &fontName) = 0;

        virtual void setFontDevicePath(const U8String &path) = 0;

        virtual void setResourceDevicePath(const U8String &path) = 0;

        virtual void setTrimToBBox(bool trimToBBox) = 0;

        virtual void setCropToBBox(bool cropToBBox) = 0;

        virtual void setHiResBBox(bool hiResBBox) = 0;

        virtual void setCompressObjects(bool compressObjects) = 0;

        virtual void setPageFilterLow(uint64 pageLow) = 0;

        virtual void setPageFilterHigh(uint64 pageHigh) = 0;

        virtual void setPageFilterRange(uint64 pageLow, uint64 pageHigh) = 0;

        typedef enum eDocumentInfo
        {
            eDIAuthor = 0, 
            eDISubject,    
            eDITitle,      
            eDICreator,    
            eDIN           
        } eDocumentInfo;

        virtual void setDocumentInformationString(eDocumentInfo key, const U8String &value) = 0;

        virtual void setEncryption(const U8String &ownerPassword, const U8String &userPassword = "", uint32 permissions = 0) = 0;

        virtual void setOverprint(bool overprint) = 0;

        virtual void setOverprintMode(bool overprintMode) = 0;

        virtual void setHalftone(bool halftone) = 0;

        virtual void setOPI(bool opi) = 0;

        virtual void setAscii85EncodePages(bool ascii85EncodePages) = 0;

        virtual void setLinearize(bool linearize) = 0;

        virtual void setJobTicket(bool jobTicket) = 0;

        typedef enum eThumbnailType
        {
            eTHNone = 0, 
            eTHColor,    
            eTHMono      
        } eThumbnailType;

        virtual void setThumbnails(eThumbnailType thumbnails) = 0;

        virtual void setUseDeviceDependentColor(bool useDeviceDependentColor) = 0;

        virtual void setCommentMonitor(IPSCommentMonitor *commentMonitor) = 0;

        virtual void setOutputHandler(IPSOutputHandlerPtr outputHandler) = 0;

        virtual void distill(const IInputStreamPtr &inputStream, const IOutputStreamPtr &outputStream, const IProgressMonitorPtr &progressMonitor = IProgressMonitorPtr()) = 0;

        static JAWSMAKO_API IDistillerPtr create(const IJawsMakoPtr &jawsMako);
    };
    #define obj2IDistiller(obj) IDistillerPtr(dynamic_cast<IDistiller *>((IRCObject *) (obj)), true)

    class IPSCommentMonitor
    {
      public:
        virtual ~IPSCommentMonitor() = default;

        virtual const CRawStringVect &getComments() const = 0;

        virtual void comment(const RawString &comment) = 0;
    };

    class IPSOutputHandler
    {
      public:
        virtual ~IPSOutputHandler() = default;

        virtual void output(const RawString &outputString) = 0;

        virtual void error(const RawString &errorString) = 0;
    };
}
#endif