PdfTools_PdfToolsOcr.h

Go to the documentation of this file.

/******************************************************************************
 *
 * File:            PdfTools_PdfToolsOcr.h
 *
 * Description:     Sub Header file for Pdftools SDK
 *
 * Author:          PDF Tools AG
 *
 * Copyright:       Copyright (C) 2023 - 2026 PDF Tools AG, Switzerland
 *                  All rights reserved.
 *
 * Notice:          By downloading and using this artifact, you accept PDF Tools AG's
 *                  [license agreement](https://www.pdf-tools.com/license-agreement/),
 *                  [privacy policy](https://www.pdf-tools.com/privacy-policy/),
 *                  and allow PDF Tools AG to track your usage data.
 *
 *****************************************************************************/
 
#ifndef PDFTOOLS_PDFTOOLSOCR_H__
#define PDFTOOLS_PDFTOOLSOCR_H__
 
#ifndef PDFTOOLS_CALL
#if defined(WIN32)
#define PDFTOOLS_CALL __stdcall
#else
#define PDFTOOLS_CALL
#endif
#endif
 
#include "PdfTools_Types.h"
#include "PdfTools_PdfToolsSys.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#ifdef _UNICODE
#define PdfToolsOcr_Engine_Create PdfToolsOcr_Engine_CreateW
 
#define PdfToolsOcr_Engine_GetLanguages  PdfToolsOcr_Engine_GetLanguagesW
#define PdfToolsOcr_Engine_SetLanguages  PdfToolsOcr_Engine_SetLanguagesW
#define PdfToolsOcr_Engine_GetParameters PdfToolsOcr_Engine_GetParametersW
#define PdfToolsOcr_Engine_SetParameters PdfToolsOcr_Engine_SetParametersW
 
#define TPdfToolsOcr_Processor_Warning             TPdfToolsOcr_Processor_WarningW
#define PdfToolsOcr_Processor_AddWarningHandler    PdfToolsOcr_Processor_AddWarningHandlerW
#define PdfToolsOcr_Processor_RemoveWarningHandler PdfToolsOcr_Processor_RemoveWarningHandlerW
 
#else
#define PdfToolsOcr_Engine_Create PdfToolsOcr_Engine_CreateA
 
#define PdfToolsOcr_Engine_GetLanguages  PdfToolsOcr_Engine_GetLanguagesA
#define PdfToolsOcr_Engine_SetLanguages  PdfToolsOcr_Engine_SetLanguagesA
#define PdfToolsOcr_Engine_GetParameters PdfToolsOcr_Engine_GetParametersA
#define PdfToolsOcr_Engine_SetParameters PdfToolsOcr_Engine_SetParametersA
 
#define TPdfToolsOcr_Processor_Warning             TPdfToolsOcr_Processor_WarningA
#define PdfToolsOcr_Processor_AddWarningHandler    PdfToolsOcr_Processor_AddWarningHandlerA
#define PdfToolsOcr_Processor_RemoveWarningHandler PdfToolsOcr_Processor_RemoveWarningHandlerA
 
#endif
 
typedef void(PDFTOOLS_CALL* TPdfToolsOcr_Processor_WarningA)(void* pContext, const char* szMessage,
                                                             TPdfToolsOcr_WarningCategory iCategory, int iPageNo,
                                                             const char* szContext);
typedef void(PDFTOOLS_CALL* TPdfToolsOcr_Processor_WarningW)(void* pContext, const WCHAR* szMessage,
                                                             TPdfToolsOcr_WarningCategory iCategory, int iPageNo,
                                                             const WCHAR* szContext);
 
/******************************************************************************
 * ImageOptions
 *****************************************************************************/
PDFTOOLS_EXPORT TPdfToolsOcr_ImageOptions* PDFTOOLS_CALL PdfToolsOcr_ImageOptions_New(void);
 
PDFTOOLS_EXPORT TPdfToolsOcr_ImageProcessingMode PDFTOOLS_CALL
PdfToolsOcr_ImageOptions_GetMode(TPdfToolsOcr_ImageOptions* pImageOptions);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_ImageOptions_SetMode(TPdfToolsOcr_ImageOptions*       pImageOptions,
                                                                    TPdfToolsOcr_ImageProcessingMode iMode);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_ImageOptions_GetRotateScan(TPdfToolsOcr_ImageOptions* pImageOptions);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_ImageOptions_SetRotateScan(TPdfToolsOcr_ImageOptions* pImageOptions,
                                                                          BOOL                       bRotateScan);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_ImageOptions_GetDeskewScan(TPdfToolsOcr_ImageOptions* pImageOptions);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_ImageOptions_SetDeskewScan(TPdfToolsOcr_ImageOptions* pImageOptions,
                                                                          BOOL                       bDeskewScan);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
PdfToolsOcr_ImageOptions_GetRemoveOnlyInvisibleOcrText(TPdfToolsOcr_ImageOptions* pImageOptions);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_ImageOptions_SetRemoveOnlyInvisibleOcrText(
    TPdfToolsOcr_ImageOptions* pImageOptions, BOOL bRemoveOnlyInvisibleOcrText);
 
/******************************************************************************
 * TextOptions
 *****************************************************************************/
PDFTOOLS_EXPORT TPdfToolsOcr_TextOptions* PDFTOOLS_CALL PdfToolsOcr_TextOptions_New(void);
 
PDFTOOLS_EXPORT TPdfToolsOcr_TextProcessingMode PDFTOOLS_CALL
PdfToolsOcr_TextOptions_GetMode(TPdfToolsOcr_TextOptions* pTextOptions);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_TextOptions_SetMode(TPdfToolsOcr_TextOptions*       pTextOptions,
                                                                   TPdfToolsOcr_TextProcessingMode iMode);
PDFTOOLS_EXPORT TPdfToolsOcr_TextSkipMode PDFTOOLS_CALL
PdfToolsOcr_TextOptions_GetSkipMode(TPdfToolsOcr_TextOptions* pTextOptions);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_TextOptions_SetSkipMode(TPdfToolsOcr_TextOptions* pTextOptions,
                                                                       TPdfToolsOcr_TextSkipMode iSkipMode);
PDFTOOLS_EXPORT TPdfToolsOcr_UnicodeSource PDFTOOLS_CALL
PdfToolsOcr_TextOptions_GetUnicodeSource(TPdfToolsOcr_TextOptions* pTextOptions);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_TextOptions_SetUnicodeSource(TPdfToolsOcr_TextOptions*  pTextOptions,
                                                                            TPdfToolsOcr_UnicodeSource iUnicodeSource);
 
/******************************************************************************
 * PageOptions
 *****************************************************************************/
PDFTOOLS_EXPORT TPdfToolsOcr_PageOptions* PDFTOOLS_CALL PdfToolsOcr_PageOptions_New(void);
 
PDFTOOLS_EXPORT TPdfToolsOcr_PageProcessingMode PDFTOOLS_CALL
PdfToolsOcr_PageOptions_GetMode(TPdfToolsOcr_PageOptions* pPageOptions);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_PageOptions_SetMode(TPdfToolsOcr_PageOptions*       pPageOptions,
                                                                   TPdfToolsOcr_PageProcessingMode iMode);
PDFTOOLS_EXPORT TPdfToolsOcr_TaggingMode PDFTOOLS_CALL
PdfToolsOcr_PageOptions_GetTagging(TPdfToolsOcr_PageOptions* pPageOptions);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_PageOptions_SetTagging(TPdfToolsOcr_PageOptions* pPageOptions,
                                                                      TPdfToolsOcr_TaggingMode  iTagging);
 
/******************************************************************************
 * OcrOptions
 *****************************************************************************/
PDFTOOLS_EXPORT TPdfToolsOcr_OcrOptions* PDFTOOLS_CALL PdfToolsOcr_OcrOptions_New(void);
 
PDFTOOLS_EXPORT double PDFTOOLS_CALL PdfToolsOcr_OcrOptions_GetDpi(TPdfToolsOcr_OcrOptions* pOcrOptions);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_OcrOptions_SetDpi(TPdfToolsOcr_OcrOptions* pOcrOptions, double dDpi);
PDFTOOLS_EXPORT double PDFTOOLS_CALL PdfToolsOcr_OcrOptions_GetMinDpi(TPdfToolsOcr_OcrOptions* pOcrOptions);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_OcrOptions_SetMinDpi(TPdfToolsOcr_OcrOptions* pOcrOptions,
                                                                    double                   dMinDpi);
PDFTOOLS_EXPORT double PDFTOOLS_CALL PdfToolsOcr_OcrOptions_GetMaxDpi(TPdfToolsOcr_OcrOptions* pOcrOptions);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_OcrOptions_SetMaxDpi(TPdfToolsOcr_OcrOptions* pOcrOptions,
                                                                    double                   dMaxDpi);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_OcrOptions_GetProcessEmbeddedFiles(TPdfToolsOcr_OcrOptions* pOcrOptions);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_OcrOptions_SetProcessEmbeddedFiles(TPdfToolsOcr_OcrOptions* pOcrOptions,
                                                                                  BOOL bProcessEmbeddedFiles);
PDFTOOLS_EXPORT TPdfToolsOcr_ImageOptions* PDFTOOLS_CALL
PdfToolsOcr_OcrOptions_GetImageOptions(TPdfToolsOcr_OcrOptions* pOcrOptions);
PDFTOOLS_EXPORT TPdfToolsOcr_TextOptions* PDFTOOLS_CALL
PdfToolsOcr_OcrOptions_GetTextOptions(TPdfToolsOcr_OcrOptions* pOcrOptions);
PDFTOOLS_EXPORT TPdfToolsOcr_PageOptions* PDFTOOLS_CALL
PdfToolsOcr_OcrOptions_GetPageOptions(TPdfToolsOcr_OcrOptions* pOcrOptions);
 
/******************************************************************************
 * Engine
 *****************************************************************************/
PDFTOOLS_EXPORT TPdfToolsOcr_Engine* PDFTOOLS_CALL PdfToolsOcr_Engine_CreateA(const char* szName);
PDFTOOLS_EXPORT TPdfToolsOcr_Engine* PDFTOOLS_CALL PdfToolsOcr_Engine_CreateW(const WCHAR* szName);
 
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsOcr_Engine_GetLanguagesA(TPdfToolsOcr_Engine* pEngine, char* pBuffer,
                                                                      size_t nBufferSize);
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsOcr_Engine_GetLanguagesW(TPdfToolsOcr_Engine* pEngine, WCHAR* pBuffer,
                                                                      size_t nBufferSize);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_Engine_SetLanguagesA(TPdfToolsOcr_Engine* pEngine,
                                                                    const char*          szLanguages);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_Engine_SetLanguagesW(TPdfToolsOcr_Engine* pEngine,
                                                                    const WCHAR*         szLanguages);
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsOcr_Engine_GetParametersA(TPdfToolsOcr_Engine* pEngine, char* pBuffer,
                                                                       size_t nBufferSize);
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsOcr_Engine_GetParametersW(TPdfToolsOcr_Engine* pEngine, WCHAR* pBuffer,
                                                                       size_t nBufferSize);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_Engine_SetParametersA(TPdfToolsOcr_Engine* pEngine,
                                                                     const char*          szParameters);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_Engine_SetParametersW(TPdfToolsOcr_Engine* pEngine,
                                                                     const WCHAR*         szParameters);
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_Engine_Close(TPdfToolsOcr_Engine* pObject);
/******************************************************************************
 * Processor
 *****************************************************************************/
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_Processor_AddWarningHandlerA(TPdfToolsOcr_Processor*         pProcessor,
                                                                            void*                           pContext,
                                                                            TPdfToolsOcr_Processor_WarningA pFunction);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_Processor_AddWarningHandlerW(TPdfToolsOcr_Processor*         pProcessor,
                                                                            void*                           pContext,
                                                                            TPdfToolsOcr_Processor_WarningW pFunction);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_Processor_RemoveWarningHandlerA(
    TPdfToolsOcr_Processor* pProcessor, void* pContext, TPdfToolsOcr_Processor_WarningA pFunction);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOcr_Processor_RemoveWarningHandlerW(
    TPdfToolsOcr_Processor* pProcessor, void* pContext, TPdfToolsOcr_Processor_WarningW pFunction);
 
PDFTOOLS_EXPORT TPdfToolsOcr_Processor* PDFTOOLS_CALL PdfToolsOcr_Processor_New(void);
 
PDFTOOLS_EXPORT TPdfToolsPdf_Document* PDFTOOLS_CALL
PdfToolsOcr_Processor_Process(TPdfToolsOcr_Processor* pProcessor, TPdfToolsPdf_Document* pDocument,
                              TPdfToolsOcr_Engine* pEngine, const TPdfToolsSys_StreamDescriptor* pOutStreamDesc,
                              TPdfToolsOcr_OcrOptions* pOptions, TPdfToolsPdf_OutputOptions* pOutOptions);
 
#ifdef __cplusplus
}
#endif
 
#endif /* PDFTOOLS_PDFTOOLSOCR_H__ */