Pdftools SDK
Loading...
Searching...
No Matches
PdfTools_PdfToolsOptimization.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * File: PdfTools_PdfToolsOptimization.h
4 *
5 * Description: Sub Header file for Pdftools SDK
6 *
7 * Author: PDF Tools AG
8 *
9 * Copyright: Copyright (C) 2023 - 2024 PDF Tools AG, Switzerland
10 * All rights reserved.
11 *
12 * Notice: By downloading and using this artifact, you accept PDF Tools AG's
13 * [license agreement](https://www.pdf-tools.com/license-agreement/),
14 * [privacy policy](https://www.pdf-tools.com/privacy-policy/),
15 * and allow PDF Tools AG to track your usage data.
16 *
17 *****************************************************************************/
18
19#ifndef PDFTOOLS_PDFTOOLSOPTIMIZATION_H__
20#define PDFTOOLS_PDFTOOLSOPTIMIZATION_H__
21
22#ifndef PDFTOOLS_CALL
23#if defined(WIN32)
24#define PDFTOOLS_CALL __stdcall
25#else
26#define PDFTOOLS_CALL
27#endif
28#endif
29
30#include "PdfTools_Types.h"
31#include "PdfTools_PdfToolsSys.h"
32
33#ifdef __cplusplus
34extern "C"
35{
36#endif
37
38#ifdef _UNICODE
39#else
40#endif
41
42/******************************************************************************
43 * ImageRecompressionOptions
44 *****************************************************************************/
79PDFTOOLS_EXPORT TPdfToolsOptimization_CompressionAlgorithmSelection PDFTOOLS_CALL
80PdfToolsOptimization_ImageRecompressionOptions_GetAlgorithmSelection(
81 TPdfToolsOptimization_ImageRecompressionOptions* pImageRecompressionOptions);
117PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_ImageRecompressionOptions_SetAlgorithmSelection(
118 TPdfToolsOptimization_ImageRecompressionOptions* pImageRecompressionOptions,
119 TPdfToolsOptimization_CompressionAlgorithmSelection iAlgorithmSelection);
149PDFTOOLS_EXPORT double PDFTOOLS_CALL PdfToolsOptimization_ImageRecompressionOptions_GetCompressionQuality(
150 TPdfToolsOptimization_ImageRecompressionOptions* pImageRecompressionOptions);
181PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_ImageRecompressionOptions_SetCompressionQuality(
182 TPdfToolsOptimization_ImageRecompressionOptions* pImageRecompressionOptions, double dCompressionQuality);
183
184/******************************************************************************
185 * FontOptions
186 *****************************************************************************/
213PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
214PdfToolsOptimization_FontOptions_GetMerge(TPdfToolsOptimization_FontOptions* pFontOptions);
241PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
242PdfToolsOptimization_FontOptions_SetMerge(TPdfToolsOptimization_FontOptions* pFontOptions, BOOL bMerge);
283PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
284PdfToolsOptimization_FontOptions_GetRemoveStandardFonts(TPdfToolsOptimization_FontOptions* pFontOptions);
325PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_FontOptions_SetRemoveStandardFonts(
326 TPdfToolsOptimization_FontOptions* pFontOptions, BOOL bRemoveStandardFonts);
327
328/******************************************************************************
329 * RemovalOptions
330 *****************************************************************************/
347PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
348PdfToolsOptimization_RemovalOptions_GetRemoveAlternateImages(TPdfToolsOptimization_RemovalOptions* pRemovalOptions);
365PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetRemoveAlternateImages(
366 TPdfToolsOptimization_RemovalOptions* pRemovalOptions, BOOL bRemoveAlternateImages);
383PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
384PdfToolsOptimization_RemovalOptions_GetRemoveArticleThreads(TPdfToolsOptimization_RemovalOptions* pRemovalOptions);
401PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetRemoveArticleThreads(
402 TPdfToolsOptimization_RemovalOptions* pRemovalOptions, BOOL bRemoveArticleThreads);
423PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
424PdfToolsOptimization_RemovalOptions_GetRemoveMetadata(TPdfToolsOptimization_RemovalOptions* pRemovalOptions);
445PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetRemoveMetadata(
446 TPdfToolsOptimization_RemovalOptions* pRemovalOptions, BOOL bRemoveMetadata);
468PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
469PdfToolsOptimization_RemovalOptions_GetRemoveOutputIntents(TPdfToolsOptimization_RemovalOptions* pRemovalOptions);
491PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetRemoveOutputIntents(
492 TPdfToolsOptimization_RemovalOptions* pRemovalOptions, BOOL bRemoveOutputIntents);
513PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
514PdfToolsOptimization_RemovalOptions_GetRemovePieceInfo(TPdfToolsOptimization_RemovalOptions* pRemovalOptions);
535PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetRemovePieceInfo(
536 TPdfToolsOptimization_RemovalOptions* pRemovalOptions, BOOL bRemovePieceInfo);
560PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
561PdfToolsOptimization_RemovalOptions_GetRemoveStructureTree(TPdfToolsOptimization_RemovalOptions* pRemovalOptions);
585PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetRemoveStructureTree(
586 TPdfToolsOptimization_RemovalOptions* pRemovalOptions, BOOL bRemoveStructureTree);
603PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
604PdfToolsOptimization_RemovalOptions_GetRemoveThumbnails(TPdfToolsOptimization_RemovalOptions* pRemovalOptions);
621PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetRemoveThumbnails(
622 TPdfToolsOptimization_RemovalOptions* pRemovalOptions, BOOL bRemoveThumbnails);
654PDFTOOLS_EXPORT TPdfToolsOptimization_RemovalStrategy PDFTOOLS_CALL
655PdfToolsOptimization_RemovalOptions_GetRemoveSignatureAppearances(
656 TPdfToolsOptimization_RemovalOptions* pRemovalOptions);
689PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetRemoveSignatureAppearances(
690 TPdfToolsOptimization_RemovalOptions* pRemovalOptions,
691 TPdfToolsOptimization_RemovalStrategy iRemoveSignatureAppearances);
724PDFTOOLS_EXPORT TPdfToolsOptimization_ConversionStrategy PDFTOOLS_CALL
725PdfToolsOptimization_RemovalOptions_GetAnnotations(TPdfToolsOptimization_RemovalOptions* pRemovalOptions);
759PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetAnnotations(
760 TPdfToolsOptimization_RemovalOptions* pRemovalOptions, TPdfToolsOptimization_ConversionStrategy iAnnotations);
776PDFTOOLS_EXPORT TPdfToolsOptimization_ConversionStrategy PDFTOOLS_CALL
777PdfToolsOptimization_RemovalOptions_GetFormFields(TPdfToolsOptimization_RemovalOptions* pRemovalOptions);
794PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetFormFields(
795 TPdfToolsOptimization_RemovalOptions* pRemovalOptions, TPdfToolsOptimization_ConversionStrategy iFormFields);
811PDFTOOLS_EXPORT TPdfToolsOptimization_ConversionStrategy PDFTOOLS_CALL
812PdfToolsOptimization_RemovalOptions_GetLinks(TPdfToolsOptimization_RemovalOptions* pRemovalOptions);
829PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetLinks(
830 TPdfToolsOptimization_RemovalOptions* pRemovalOptions, TPdfToolsOptimization_ConversionStrategy iLinks);
831
832/******************************************************************************
833 * Optimizer
834 *****************************************************************************/
843PDFTOOLS_EXPORT TPdfToolsOptimization_Optimizer* PDFTOOLS_CALL PdfToolsOptimization_Optimizer_New(void);
844
881PDFTOOLS_EXPORT TPdfToolsPdf_Document* PDFTOOLS_CALL PdfToolsOptimization_Optimizer_OptimizeDocument(
882 TPdfToolsOptimization_Optimizer* pOptimizer, TPdfToolsPdf_Document* pInDoc,
883 const TPdfToolsSys_StreamDescriptor* pOutStreamDesc, TPdfToolsOptimizationProfiles_Profile* pProfile,
884 TPdfToolsPdf_OutputOptions* pOutOptions);
885
886#ifdef __cplusplus
887}
888#endif
889
890#endif /* PDFTOOLS_PDFTOOLSOPTIMIZATION_H__ */
PdfToolsOptimization_RemovalOptions_SetLinks
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetLinks(TPdfToolsOptimization_RemovalOptions *pRemovalOptions, TPdfToolsOptimization_ConversionStrategy iLinks)
The conversion strategy for links Default: ePdfToolsOptimization_ConversionStrategy_Copy in all profi...
PdfToolsOptimization_ImageRecompressionOptions_GetAlgorithmSelection
PDFTOOLS_EXPORT TPdfToolsOptimization_CompressionAlgorithmSelection PDFTOOLS_CALL PdfToolsOptimization_ImageRecompressionOptions_GetAlgorithmSelection(TPdfToolsOptimization_ImageRecompressionOptions *pImageRecompressionOptions)
The strategy for image recompression.
PdfToolsOptimization_RemovalOptions_GetRemovePieceInfo
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_GetRemovePieceInfo(TPdfToolsOptimization_RemovalOptions *pRemovalOptions)
Whether to remove the piece-info dictionary (private PDF processor data)
PdfToolsOptimization_RemovalOptions_GetLinks
PDFTOOLS_EXPORT TPdfToolsOptimization_ConversionStrategy PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_GetLinks(TPdfToolsOptimization_RemovalOptions *pRemovalOptions)
The conversion strategy for links Default: ePdfToolsOptimization_ConversionStrategy_Copy in all profi...
PdfToolsOptimization_ImageRecompressionOptions_GetCompressionQuality
PDFTOOLS_EXPORT double PDFTOOLS_CALL PdfToolsOptimization_ImageRecompressionOptions_GetCompressionQuality(TPdfToolsOptimization_ImageRecompressionOptions *pImageRecompressionOptions)
The compression quality for lossy image compression algorithms.
PdfToolsOptimization_RemovalOptions_GetRemoveMetadata
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_GetRemoveMetadata(TPdfToolsOptimization_RemovalOptions *pRemovalOptions)
Whether to remove document's XMP metadata Default:
PdfToolsOptimization_RemovalOptions_SetRemoveMetadata
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetRemoveMetadata(TPdfToolsOptimization_RemovalOptions *pRemovalOptions, BOOL bRemoveMetadata)
Whether to remove document's XMP metadata Default:
PdfToolsOptimization_RemovalOptions_SetAnnotations
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetAnnotations(TPdfToolsOptimization_RemovalOptions *pRemovalOptions, TPdfToolsOptimization_ConversionStrategy iAnnotations)
The conversion strategy for annotations.
PdfToolsOptimization_ImageRecompressionOptions_SetAlgorithmSelection
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_ImageRecompressionOptions_SetAlgorithmSelection(TPdfToolsOptimization_ImageRecompressionOptions *pImageRecompressionOptions, TPdfToolsOptimization_CompressionAlgorithmSelection iAlgorithmSelection)
The strategy for image recompression.
PdfToolsOptimization_RemovalOptions_GetRemoveStructureTree
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_GetRemoveStructureTree(TPdfToolsOptimization_RemovalOptions *pRemovalOptions)
Whether to remove the data describing the logical structure of a PDF.
PdfToolsOptimization_FontOptions_GetMerge
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_FontOptions_GetMerge(TPdfToolsOptimization_FontOptions *pFontOptions)
Whether to merge fonts and font programs.
PdfToolsOptimization_FontOptions_SetRemoveStandardFonts
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_FontOptions_SetRemoveStandardFonts(TPdfToolsOptimization_FontOptions *pFontOptions, BOOL bRemoveStandardFonts)
Whether to remove standard fonts.
PdfToolsOptimization_ImageRecompressionOptions_SetCompressionQuality
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_ImageRecompressionOptions_SetCompressionQuality(TPdfToolsOptimization_ImageRecompressionOptions *pImageRecompressionOptions, double dCompressionQuality)
The compression quality for lossy image compression algorithms.
PdfToolsOptimization_RemovalOptions_GetRemoveAlternateImages
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_GetRemoveAlternateImages(TPdfToolsOptimization_RemovalOptions *pRemovalOptions)
Whether to remove additional or alternative versions of images Default: FALSE except in the profile T...
PdfToolsOptimization_RemovalOptions_GetRemoveSignatureAppearances
PDFTOOLS_EXPORT TPdfToolsOptimization_RemovalStrategy PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_GetRemoveSignatureAppearances(TPdfToolsOptimization_RemovalOptions *pRemovalOptions)
Whether to remove or flatten signature appearances.
PdfToolsOptimization_RemovalOptions_SetRemoveOutputIntents
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetRemoveOutputIntents(TPdfToolsOptimization_RemovalOptions *pRemovalOptions, BOOL bRemoveOutputIntents)
Whether to remove all output intents.
PdfToolsOptimization_RemovalOptions_SetRemoveArticleThreads
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetRemoveArticleThreads(TPdfToolsOptimization_RemovalOptions *pRemovalOptions, BOOL bRemoveArticleThreads)
Whether to remove the sequential flows (threads) of articles Default: TRUE except in the profile TPdf...
PdfToolsOptimization_RemovalOptions_GetRemoveThumbnails
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_GetRemoveThumbnails(TPdfToolsOptimization_RemovalOptions *pRemovalOptions)
Whether to remove thumbnail images which represent the PDF pages in miniature form Default: TRUE in a...
PdfToolsOptimization_Optimizer_OptimizeDocument
PDFTOOLS_EXPORT TPdfToolsPdf_Document *PDFTOOLS_CALL PdfToolsOptimization_Optimizer_OptimizeDocument(TPdfToolsOptimization_Optimizer *pOptimizer, TPdfToolsPdf_Document *pInDoc, const TPdfToolsSys_StreamDescriptor *pOutStreamDesc, TPdfToolsOptimizationProfiles_Profile *pProfile, TPdfToolsPdf_OutputOptions *pOutOptions)
Optimize the PDF document.
PdfToolsOptimization_FontOptions_SetMerge
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_FontOptions_SetMerge(TPdfToolsOptimization_FontOptions *pFontOptions, BOOL bMerge)
Whether to merge fonts and font programs.
PdfToolsOptimization_RemovalOptions_GetAnnotations
PDFTOOLS_EXPORT TPdfToolsOptimization_ConversionStrategy PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_GetAnnotations(TPdfToolsOptimization_RemovalOptions *pRemovalOptions)
The conversion strategy for annotations.
PdfToolsOptimization_RemovalOptions_SetRemoveThumbnails
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetRemoveThumbnails(TPdfToolsOptimization_RemovalOptions *pRemovalOptions, BOOL bRemoveThumbnails)
Whether to remove thumbnail images which represent the PDF pages in miniature form Default: TRUE in a...
PDFTOOLS_CALL
#define PDFTOOLS_CALL
Definition PdfTools_PdfToolsOptimization.h:26
PdfToolsOptimization_RemovalOptions_SetFormFields
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetFormFields(TPdfToolsOptimization_RemovalOptions *pRemovalOptions, TPdfToolsOptimization_ConversionStrategy iFormFields)
The conversion strategy for interactive forms Default: ePdfToolsOptimization_ConversionStrategy_Copy ...
PdfToolsOptimization_RemovalOptions_GetFormFields
PDFTOOLS_EXPORT TPdfToolsOptimization_ConversionStrategy PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_GetFormFields(TPdfToolsOptimization_RemovalOptions *pRemovalOptions)
The conversion strategy for interactive forms Default: ePdfToolsOptimization_ConversionStrategy_Copy ...
PdfToolsOptimization_RemovalOptions_GetRemoveArticleThreads
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_GetRemoveArticleThreads(TPdfToolsOptimization_RemovalOptions *pRemovalOptions)
Whether to remove the sequential flows (threads) of articles Default: TRUE except in the profile TPdf...
PdfToolsOptimization_Optimizer_New
PDFTOOLS_EXPORT TPdfToolsOptimization_Optimizer *PDFTOOLS_CALL PdfToolsOptimization_Optimizer_New(void)
PdfToolsOptimization_RemovalOptions_SetRemoveAlternateImages
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetRemoveAlternateImages(TPdfToolsOptimization_RemovalOptions *pRemovalOptions, BOOL bRemoveAlternateImages)
Whether to remove additional or alternative versions of images Default: FALSE except in the profile T...
PdfToolsOptimization_RemovalOptions_SetRemoveStructureTree
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetRemoveStructureTree(TPdfToolsOptimization_RemovalOptions *pRemovalOptions, BOOL bRemoveStructureTree)
Whether to remove the data describing the logical structure of a PDF.
PdfToolsOptimization_RemovalOptions_GetRemoveOutputIntents
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_GetRemoveOutputIntents(TPdfToolsOptimization_RemovalOptions *pRemovalOptions)
Whether to remove all output intents.
PdfToolsOptimization_RemovalOptions_SetRemovePieceInfo
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetRemovePieceInfo(TPdfToolsOptimization_RemovalOptions *pRemovalOptions, BOOL bRemovePieceInfo)
Whether to remove the piece-info dictionary (private PDF processor data)
PdfToolsOptimization_FontOptions_GetRemoveStandardFonts
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_FontOptions_GetRemoveStandardFonts(TPdfToolsOptimization_FontOptions *pFontOptions)
Whether to remove standard fonts.
PdfToolsOptimization_RemovalOptions_SetRemoveSignatureAppearances
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimization_RemovalOptions_SetRemoveSignatureAppearances(TPdfToolsOptimization_RemovalOptions *pRemovalOptions, TPdfToolsOptimization_RemovalStrategy iRemoveSignatureAppearances)
Whether to remove or flatten signature appearances.
PdfTools_PdfToolsSys.h
PDFTOOLS_EXPORT
#define PDFTOOLS_EXPORT
Definition PdfTools_Platform.h:143
PdfTools_Types.h
TPdfToolsOptimization_ConversionStrategy
TPdfToolsOptimization_ConversionStrategy
The conversion strategy for PDF objects.
Definition PdfTools_Types.h:344
TPdfToolsOptimization_CompressionAlgorithmSelection
TPdfToolsOptimization_CompressionAlgorithmSelection
The strategy for recompressing images The strategy expresses the broad goal when recompressing images...
Definition PdfTools_Types.h:382
TPdfToolsOptimization_RemovalStrategy
TPdfToolsOptimization_RemovalStrategy
The removal strategy for PDF objects.
Definition PdfTools_Types.h:362
BOOL
#define BOOL
Definition PdfTools_Types.h:23
TPdfToolsOptimization_FontOptions
The parameters for font optimization.
TPdfToolsOptimization_ImageRecompressionOptions
The parameters for image recompression.
TPdfToolsOptimization_Optimizer
The class to optimize PDF documents.
TPdfToolsOptimization_RemovalOptions
The parameters defining the optional data to remove or flatten.
TPdfToolsOptimizationProfiles_Profile
The base class for PDF optimization profiles The profile defines the optimization parameters suitable...
TPdfToolsPdf_Document
The PDF document PDF documents are either opened using PdfToolsPdf_Document_Open or the result of an ...
TPdfToolsPdf_OutputOptions
The parameters for document-level features of output PDFs Output options are used in many operations ...
TPdfToolsSys_StreamDescriptor
Structure that groups a set of callbacks that model streams.
Definition PdfTools_PdfToolsSys.h:49
Generated by doxygen 1.10.0