tesseract 4.1.1
Loading...
Searching...
No Matches
capi.h File Reference
#include <stdbool.h>
#include <stdio.h>
#include "platform.h"

Go to the source code of this file.

Macros

#define TESS_CALL
 
#define BOOL   int
 
#define TRUE   1
 
#define FALSE   0
 

Typedefs

typedef struct TessResultRenderer TessResultRenderer
 
typedef struct TessTextRenderer TessTextRenderer
 
typedef struct TessHOcrRenderer TessHOcrRenderer
 
typedef struct TessPDFRenderer TessPDFRenderer
 
typedef struct TessUnlvRenderer TessUnlvRenderer
 
typedef struct TessBoxTextRenderer TessBoxTextRenderer
 
typedef struct TessBaseAPI TessBaseAPI
 
typedef struct TessPageIterator TessPageIterator
 
typedef struct TessResultIterator TessResultIterator
 
typedef struct TessMutableIterator TessMutableIterator
 
typedef struct TessChoiceIterator TessChoiceIterator
 
typedef enum TessOcrEngineMode TessOcrEngineMode
 
typedef enum TessPageSegMode TessPageSegMode
 
typedef enum TessPageIteratorLevel TessPageIteratorLevel
 
typedef enum TessPolyBlockType TessPolyBlockType
 
typedef enum TessOrientation TessOrientation
 
typedef enum TessParagraphJustification TessParagraphJustification
 
typedef enum TessWritingDirection TessWritingDirection
 
typedef enum TessTextlineOrder TessTextlineOrder
 
typedef struct ETEXT_DESC ETEXT_DESC
 
typedef bool(* TessCancelFunc) (void *cancel_this, int words)
 
typedef bool(* TessProgressFunc) (ETEXT_DESC *ths, int left, int right, int top, int bottom)
 

Enumerations

enum  TessOcrEngineMode { OEM_TESSERACT_ONLY , OEM_LSTM_ONLY , OEM_TESSERACT_LSTM_COMBINED , OEM_DEFAULT }
 
enum  TessPageSegMode {
  PSM_OSD_ONLY , PSM_AUTO_OSD , PSM_AUTO_ONLY , PSM_AUTO ,
  PSM_SINGLE_COLUMN , PSM_SINGLE_BLOCK_VERT_TEXT , PSM_SINGLE_BLOCK , PSM_SINGLE_LINE ,
  PSM_SINGLE_WORD , PSM_CIRCLE_WORD , PSM_SINGLE_CHAR , PSM_SPARSE_TEXT ,
  PSM_SPARSE_TEXT_OSD , PSM_RAW_LINE , PSM_COUNT
}
 
enum  TessPageIteratorLevel {
  RIL_BLOCK , RIL_PARA , RIL_TEXTLINE , RIL_WORD ,
  RIL_SYMBOL
}
 
enum  TessPolyBlockType {
  PT_UNKNOWN , PT_FLOWING_TEXT , PT_HEADING_TEXT , PT_PULLOUT_TEXT ,
  PT_EQUATION , PT_INLINE_EQUATION , PT_TABLE , PT_VERTICAL_TEXT ,
  PT_CAPTION_TEXT , PT_FLOWING_IMAGE , PT_HEADING_IMAGE , PT_PULLOUT_IMAGE ,
  PT_HORZ_LINE , PT_VERT_LINE , PT_NOISE , PT_COUNT
}
 
enum  TessOrientation { ORIENTATION_PAGE_UP , ORIENTATION_PAGE_RIGHT , ORIENTATION_PAGE_DOWN , ORIENTATION_PAGE_LEFT }
 
enum  TessParagraphJustification { JUSTIFICATION_UNKNOWN , JUSTIFICATION_LEFT , JUSTIFICATION_CENTER , JUSTIFICATION_RIGHT }
 
enum  TessWritingDirection { WRITING_DIRECTION_LEFT_TO_RIGHT , WRITING_DIRECTION_RIGHT_TO_LEFT , WRITING_DIRECTION_TOP_TO_BOTTOM }
 
enum  TessTextlineOrder { TEXTLINE_ORDER_LEFT_TO_RIGHT , TEXTLINE_ORDER_RIGHT_TO_LEFT , TEXTLINE_ORDER_TOP_TO_BOTTOM }
 

Functions

TESS_API const char *TESS_CALL TessVersion ()
 
TESS_API void TESS_CALL TessDeleteText (const char *text)
 
TESS_API void TESS_CALL TessDeleteTextArray (char **arr)
 
TESS_API void TESS_CALL TessDeleteIntArray (const int *arr)
 
TESS_API TessResultRenderer *TESS_CALL TessTextRendererCreate (const char *outputbase)
 
TESS_API TessResultRenderer *TESS_CALL TessHOcrRendererCreate (const char *outputbase)
 
TESS_API TessResultRenderer *TESS_CALL TessHOcrRendererCreate2 (const char *outputbase, BOOL font_info)
 
TESS_API TessResultRenderer *TESS_CALL TessAltoRendererCreate (const char *outputbase)
 
TESS_API TessResultRenderer *TESS_CALL TessTsvRendererCreate (const char *outputbase)
 
TESS_API TessResultRenderer *TESS_CALL TessPDFRendererCreate (const char *outputbase, const char *datadir, BOOL textonly)
 
TESS_API TessResultRenderer *TESS_CALL TessUnlvRendererCreate (const char *outputbase)
 
TESS_API TessResultRenderer *TESS_CALL TessBoxTextRendererCreate (const char *outputbase)
 
TESS_API TessResultRenderer *TESS_CALL TessLSTMBoxRendererCreate (const char *outputbase)
 
TESS_API TessResultRenderer *TESS_CALL TessWordStrBoxRendererCreate (const char *outputbase)
 
TESS_API void TESS_CALL TessDeleteResultRenderer (TessResultRenderer *renderer)
 
TESS_API void TESS_CALL TessResultRendererInsert (TessResultRenderer *renderer, TessResultRenderer *next)
 
TESS_API TessResultRenderer *TESS_CALL TessResultRendererNext (TessResultRenderer *renderer)
 
TESS_API BOOL TESS_CALL TessResultRendererBeginDocument (TessResultRenderer *renderer, const char *title)
 
TESS_API BOOL TESS_CALL TessResultRendererAddImage (TessResultRenderer *renderer, TessBaseAPI *api)
 
TESS_API BOOL TESS_CALL TessResultRendererEndDocument (TessResultRenderer *renderer)
 
TESS_API const char *TESS_CALL TessResultRendererExtention (TessResultRenderer *renderer)
 
TESS_API const char *TESS_CALL TessResultRendererTitle (TessResultRenderer *renderer)
 
TESS_API int TESS_CALL TessResultRendererImageNum (TessResultRenderer *renderer)
 
TESS_API TessBaseAPI *TESS_CALL TessBaseAPICreate ()
 
TESS_API void TESS_CALL TessBaseAPIDelete (TessBaseAPI *handle)
 
TESS_API size_t TESS_CALL TessBaseAPIGetOpenCLDevice (TessBaseAPI *handle, void **device)
 
TESS_API void TESS_CALL TessBaseAPISetInputName (TessBaseAPI *handle, const char *name)
 
TESS_API const char *TESS_CALL TessBaseAPIGetInputName (TessBaseAPI *handle)
 
TESS_API void TESS_CALL TessBaseAPISetInputImage (TessBaseAPI *handle, struct Pix *pix)
 
TESS_API struct Pix *TESS_CALL TessBaseAPIGetInputImage (TessBaseAPI *handle)
 
TESS_API int TESS_CALL TessBaseAPIGetSourceYResolution (TessBaseAPI *handle)
 
TESS_API const char *TESS_CALL TessBaseAPIGetDatapath (TessBaseAPI *handle)
 
TESS_API void TESS_CALL TessBaseAPISetOutputName (TessBaseAPI *handle, const char *name)
 
TESS_API BOOL TESS_CALL TessBaseAPISetVariable (TessBaseAPI *handle, const char *name, const char *value)
 
TESS_API BOOL TESS_CALL TessBaseAPISetDebugVariable (TessBaseAPI *handle, const char *name, const char *value)
 
TESS_API BOOL TESS_CALL TessBaseAPIGetIntVariable (const TessBaseAPI *handle, const char *name, int *value)
 
TESS_API BOOL TESS_CALL TessBaseAPIGetBoolVariable (const TessBaseAPI *handle, const char *name, BOOL *value)
 
TESS_API BOOL TESS_CALL TessBaseAPIGetDoubleVariable (const TessBaseAPI *handle, const char *name, double *value)
 
TESS_API const char *TESS_CALL TessBaseAPIGetStringVariable (const TessBaseAPI *handle, const char *name)
 
TESS_API void TESS_CALL TessBaseAPIPrintVariables (const TessBaseAPI *handle, FILE *fp)
 
TESS_API BOOL TESS_CALL TessBaseAPIPrintVariablesToFile (const TessBaseAPI *handle, const char *filename)
 
TESS_API int TESS_CALL TessBaseAPIInit1 (TessBaseAPI *handle, const char *datapath, const char *language, TessOcrEngineMode oem, char **configs, int configs_size)
 
TESS_API int TESS_CALL TessBaseAPIInit2 (TessBaseAPI *handle, const char *datapath, const char *language, TessOcrEngineMode oem)
 
TESS_API int TESS_CALL TessBaseAPIInit3 (TessBaseAPI *handle, const char *datapath, const char *language)
 
TESS_API int TESS_CALL TessBaseAPIInit4 (TessBaseAPI *handle, const char *datapath, const char *language, TessOcrEngineMode mode, char **configs, int configs_size, char **vars_vec, char **vars_values, size_t vars_vec_size, BOOL set_only_non_debug_params)
 
TESS_API const char *TESS_CALL TessBaseAPIGetInitLanguagesAsString (const TessBaseAPI *handle)
 
TESS_API char **TESS_CALL TessBaseAPIGetLoadedLanguagesAsVector (const TessBaseAPI *handle)
 
TESS_API char **TESS_CALL TessBaseAPIGetAvailableLanguagesAsVector (const TessBaseAPI *handle)
 
TESS_API int TESS_CALL TessBaseAPIInitLangMod (TessBaseAPI *handle, const char *datapath, const char *language)
 
TESS_API void TESS_CALL TessBaseAPIInitForAnalysePage (TessBaseAPI *handle)
 
TESS_API void TESS_CALL TessBaseAPIReadConfigFile (TessBaseAPI *handle, const char *filename)
 
TESS_API void TESS_CALL TessBaseAPIReadDebugConfigFile (TessBaseAPI *handle, const char *filename)
 
TESS_API void TESS_CALL TessBaseAPISetPageSegMode (TessBaseAPI *handle, TessPageSegMode mode)
 
TESS_API TessPageSegMode TESS_CALL TessBaseAPIGetPageSegMode (const TessBaseAPI *handle)
 
TESS_API char *TESS_CALL TessBaseAPIRect (TessBaseAPI *handle, const unsigned char *imagedata, int bytes_per_pixel, int bytes_per_line, int left, int top, int width, int height)
 
TESS_API void TESS_CALL TessBaseAPIClearAdaptiveClassifier (TessBaseAPI *handle)
 
TESS_API void TESS_CALL TessBaseAPISetImage (TessBaseAPI *handle, const unsigned char *imagedata, int width, int height, int bytes_per_pixel, int bytes_per_line)
 
TESS_API void TESS_CALL TessBaseAPISetImage2 (TessBaseAPI *handle, struct Pix *pix)
 
TESS_API void TESS_CALL TessBaseAPISetSourceResolution (TessBaseAPI *handle, int ppi)
 
TESS_API void TESS_CALL TessBaseAPISetRectangle (TessBaseAPI *handle, int left, int top, int width, int height)
 
TESS_API struct Pix *TESS_CALL TessBaseAPIGetThresholdedImage (TessBaseAPI *handle)
 
TESS_API struct Boxa *TESS_CALL TessBaseAPIGetRegions (TessBaseAPI *handle, struct Pixa **pixa)
 
TESS_API struct Boxa *TESS_CALL TessBaseAPIGetTextlines (TessBaseAPI *handle, struct Pixa **pixa, int **blockids)
 
TESS_API struct Boxa *TESS_CALL TessBaseAPIGetTextlines1 (TessBaseAPI *handle, BOOL raw_image, int raw_padding, struct Pixa **pixa, int **blockids, int **paraids)
 
TESS_API struct Boxa *TESS_CALL TessBaseAPIGetStrips (TessBaseAPI *handle, struct Pixa **pixa, int **blockids)
 
TESS_API struct Boxa *TESS_CALL TessBaseAPIGetWords (TessBaseAPI *handle, struct Pixa **pixa)
 
TESS_API struct Boxa *TESS_CALL TessBaseAPIGetConnectedComponents (TessBaseAPI *handle, struct Pixa **cc)
 
TESS_API struct Boxa *TESS_CALL TessBaseAPIGetComponentImages (TessBaseAPI *handle, TessPageIteratorLevel level, BOOL text_only, struct Pixa **pixa, int **blockids)
 
TESS_API struct Boxa *TESS_CALL TessBaseAPIGetComponentImages1 (TessBaseAPI *handle, TessPageIteratorLevel level, BOOL text_only, BOOL raw_image, int raw_padding, struct Pixa **pixa, int **blockids, int **paraids)
 
TESS_API int TESS_CALL TessBaseAPIGetThresholdedImageScaleFactor (const TessBaseAPI *handle)
 
TESS_API TessPageIterator *TESS_CALL TessBaseAPIAnalyseLayout (TessBaseAPI *handle)
 
TESS_API int TESS_CALL TessBaseAPIRecognize (TessBaseAPI *handle, ETEXT_DESC *monitor)
 
TESS_API int TESS_CALL TessBaseAPIRecognizeForChopTest (TessBaseAPI *handle, ETEXT_DESC *monitor)
 
TESS_API BOOL TESS_CALL TessBaseAPIProcessPages (TessBaseAPI *handle, const char *filename, const char *retry_config, int timeout_millisec, TessResultRenderer *renderer)
 
TESS_API BOOL TESS_CALL TessBaseAPIProcessPage (TessBaseAPI *handle, struct Pix *pix, int page_index, const char *filename, const char *retry_config, int timeout_millisec, TessResultRenderer *renderer)
 
TESS_API TessResultIterator *TESS_CALL TessBaseAPIGetIterator (TessBaseAPI *handle)
 
TESS_API TessMutableIterator *TESS_CALL TessBaseAPIGetMutableIterator (TessBaseAPI *handle)
 
TESS_API char *TESS_CALL TessBaseAPIGetUTF8Text (TessBaseAPI *handle)
 
TESS_API char *TESS_CALL TessBaseAPIGetHOCRText (TessBaseAPI *handle, int page_number)
 
TESS_API char *TESS_CALL TessBaseAPIGetAltoText (TessBaseAPI *handle, int page_number)
 
TESS_API char *TESS_CALL TessBaseAPIGetTsvText (TessBaseAPI *handle, int page_number)
 
TESS_API char *TESS_CALL TessBaseAPIGetBoxText (TessBaseAPI *handle, int page_number)
 
TESS_API char *TESS_CALL TessBaseAPIGetLSTMBoxText (TessBaseAPI *handle, int page_number)
 
TESS_API char *TESS_CALL TessBaseAPIGetWordStrBoxText (TessBaseAPI *handle, int page_number)
 
TESS_API char *TESS_CALL TessBaseAPIGetUNLVText (TessBaseAPI *handle)
 
TESS_API int TESS_CALL TessBaseAPIMeanTextConf (TessBaseAPI *handle)
 
TESS_API int *TESS_CALL TessBaseAPIAllWordConfidences (TessBaseAPI *handle)
 
TESS_API BOOL TESS_CALL TessBaseAPIAdaptToWordStr (TessBaseAPI *handle, TessPageSegMode mode, const char *wordstr)
 
TESS_API void TESS_CALL TessBaseAPIClear (TessBaseAPI *handle)
 
TESS_API void TESS_CALL TessBaseAPIEnd (TessBaseAPI *handle)
 
TESS_API int TESS_CALL TessBaseAPIIsValidWord (TessBaseAPI *handle, const char *word)
 
TESS_API BOOL TESS_CALL TessBaseAPIGetTextDirection (TessBaseAPI *handle, int *out_offset, float *out_slope)
 
TESS_API const char *TESS_CALL TessBaseAPIGetUnichar (TessBaseAPI *handle, int unichar_id)
 
TESS_API void TESS_CALL TessBaseAPISetMinOrientationMargin (TessBaseAPI *handle, double margin)
 
TESS_API void TESS_CALL TessPageIteratorDelete (TessPageIterator *handle)
 
TESS_API TessPageIterator *TESS_CALL TessPageIteratorCopy (const TessPageIterator *handle)
 
TESS_API void TESS_CALL TessPageIteratorBegin (TessPageIterator *handle)
 
TESS_API BOOL TESS_CALL TessPageIteratorNext (TessPageIterator *handle, TessPageIteratorLevel level)
 
TESS_API BOOL TESS_CALL TessPageIteratorIsAtBeginningOf (const TessPageIterator *handle, TessPageIteratorLevel level)
 
TESS_API BOOL TESS_CALL TessPageIteratorIsAtFinalElement (const TessPageIterator *handle, TessPageIteratorLevel level, TessPageIteratorLevel element)
 
TESS_API BOOL TESS_CALL TessPageIteratorBoundingBox (const TessPageIterator *handle, TessPageIteratorLevel level, int *left, int *top, int *right, int *bottom)
 
TESS_API TessPolyBlockType TESS_CALL TessPageIteratorBlockType (const TessPageIterator *handle)
 
TESS_API struct Pix *TESS_CALL TessPageIteratorGetBinaryImage (const TessPageIterator *handle, TessPageIteratorLevel level)
 
TESS_API struct Pix *TESS_CALL TessPageIteratorGetImage (const TessPageIterator *handle, TessPageIteratorLevel level, int padding, struct Pix *original_image, int *left, int *top)
 
TESS_API BOOL TESS_CALL TessPageIteratorBaseline (const TessPageIterator *handle, TessPageIteratorLevel level, int *x1, int *y1, int *x2, int *y2)
 
TESS_API void TESS_CALL TessPageIteratorOrientation (TessPageIterator *handle, TessOrientation *orientation, TessWritingDirection *writing_direction, TessTextlineOrder *textline_order, float *deskew_angle)
 
TESS_API void TESS_CALL TessPageIteratorParagraphInfo (TessPageIterator *handle, TessParagraphJustification *justification, BOOL *is_list_item, BOOL *is_crown, int *first_line_indent)
 
TESS_API void TESS_CALL TessResultIteratorDelete (TessResultIterator *handle)
 
TESS_API TessResultIterator *TESS_CALL TessResultIteratorCopy (const TessResultIterator *handle)
 
TESS_API TessPageIterator *TESS_CALL TessResultIteratorGetPageIterator (TessResultIterator *handle)
 
TESS_API const TessPageIterator *TESS_CALL TessResultIteratorGetPageIteratorConst (const TessResultIterator *handle)
 
TESS_API TessChoiceIterator *TESS_CALL TessResultIteratorGetChoiceIterator (const TessResultIterator *handle)
 
TESS_API BOOL TESS_CALL TessResultIteratorNext (TessResultIterator *handle, TessPageIteratorLevel level)
 
TESS_API char *TESS_CALL TessResultIteratorGetUTF8Text (const TessResultIterator *handle, TessPageIteratorLevel level)
 
TESS_API float TESS_CALL TessResultIteratorConfidence (const TessResultIterator *handle, TessPageIteratorLevel level)
 
TESS_API const char *TESS_CALL TessResultIteratorWordRecognitionLanguage (const TessResultIterator *handle)
 
TESS_API const char *TESS_CALL TessResultIteratorWordFontAttributes (const TessResultIterator *handle, BOOL *is_bold, BOOL *is_italic, BOOL *is_underlined, BOOL *is_monospace, BOOL *is_serif, BOOL *is_smallcaps, int *pointsize, int *font_id)
 
TESS_API BOOL TESS_CALL TessResultIteratorWordIsFromDictionary (const TessResultIterator *handle)
 
TESS_API BOOL TESS_CALL TessResultIteratorWordIsNumeric (const TessResultIterator *handle)
 
TESS_API BOOL TESS_CALL TessResultIteratorSymbolIsSuperscript (const TessResultIterator *handle)
 
TESS_API BOOL TESS_CALL TessResultIteratorSymbolIsSubscript (const TessResultIterator *handle)
 
TESS_API BOOL TESS_CALL TessResultIteratorSymbolIsDropcap (const TessResultIterator *handle)
 
TESS_API void TESS_CALL TessChoiceIteratorDelete (TessChoiceIterator *handle)
 
TESS_API BOOL TESS_CALL TessChoiceIteratorNext (TessChoiceIterator *handle)
 
TESS_API const char *TESS_CALL TessChoiceIteratorGetUTF8Text (const TessChoiceIterator *handle)
 
TESS_API float TESS_CALL TessChoiceIteratorConfidence (const TessChoiceIterator *handle)
 
TESS_API ETEXT_DESC *TESS_CALL TessMonitorCreate ()
 
TESS_API void TESS_CALL TessMonitorDelete (ETEXT_DESC *monitor)
 
TESS_API void TESS_CALL TessMonitorSetCancelFunc (ETEXT_DESC *monitor, TessCancelFunc cancelFunc)
 
TESS_API void TESS_CALL TessMonitorSetCancelThis (ETEXT_DESC *monitor, void *cancelThis)
 
TESS_API void *TESS_CALL TessMonitorGetCancelThis (ETEXT_DESC *monitor)
 
TESS_API void TESS_CALL TessMonitorSetProgressFunc (ETEXT_DESC *monitor, TessProgressFunc progressFunc)
 
TESS_API int TESS_CALL TessMonitorGetProgress (ETEXT_DESC *monitor)
 
TESS_API void TESS_CALL TessMonitorSetDeadlineMSecs (ETEXT_DESC *monitor, int deadline)
 

Macro Definition Documentation

◆ BOOL

#define BOOL   int

Definition at line 50 of file capi.h.

◆ FALSE

#define FALSE   0

Definition at line 52 of file capi.h.

◆ TESS_CALL

#define TESS_CALL

Definition at line 45 of file capi.h.

◆ TRUE

#define TRUE   1

Definition at line 51 of file capi.h.

Typedef Documentation

◆ ETEXT_DESC

typedef struct ETEXT_DESC ETEXT_DESC

Definition at line 168 of file capi.h.

◆ TessBaseAPI

typedef struct TessBaseAPI TessBaseAPI

Definition at line 93 of file capi.h.

◆ TessBoxTextRenderer

Definition at line 92 of file capi.h.

◆ TessCancelFunc

typedef bool(* TessCancelFunc) (void *cancel_this, int words)

Definition at line 171 of file capi.h.

◆ TessChoiceIterator

Definition at line 97 of file capi.h.

◆ TessHOcrRenderer

Definition at line 89 of file capi.h.

◆ TessMutableIterator

Definition at line 96 of file capi.h.

◆ TessOcrEngineMode

◆ TessOrientation

◆ TessPageIterator

Definition at line 94 of file capi.h.

◆ TessPageIteratorLevel

◆ TessPageSegMode

◆ TessParagraphJustification

◆ TessPDFRenderer

Definition at line 90 of file capi.h.

◆ TessPolyBlockType

◆ TessProgressFunc

typedef bool(* TessProgressFunc) (ETEXT_DESC *ths, int left, int right, int top, int bottom)

Definition at line 172 of file capi.h.

◆ TessResultIterator

Definition at line 95 of file capi.h.

◆ TessResultRenderer

Definition at line 87 of file capi.h.

◆ TessTextlineOrder

◆ TessTextRenderer

Definition at line 88 of file capi.h.

◆ TessUnlvRenderer

Definition at line 91 of file capi.h.

◆ TessWritingDirection

Enumeration Type Documentation

◆ TessOcrEngineMode

Enumerator
OEM_TESSERACT_ONLY 
OEM_LSTM_ONLY 
OEM_TESSERACT_LSTM_COMBINED 
OEM_DEFAULT 

Definition at line 98 of file capi.h.

98 {
TessOcrEngineMode
Definition: capi.h:98
@ OEM_DEFAULT
Definition: capi.h:102
@ OEM_TESSERACT_ONLY
Definition: capi.h:99
@ OEM_LSTM_ONLY
Definition: capi.h:100
@ OEM_TESSERACT_LSTM_COMBINED
Definition: capi.h:101

◆ TessOrientation

Enumerator
ORIENTATION_PAGE_UP 
ORIENTATION_PAGE_RIGHT 
ORIENTATION_PAGE_DOWN 
ORIENTATION_PAGE_LEFT 

Definition at line 146 of file capi.h.

146 {
TessOrientation
Definition: capi.h:146
@ ORIENTATION_PAGE_DOWN
Definition: capi.h:149
@ ORIENTATION_PAGE_RIGHT
Definition: capi.h:148
@ ORIENTATION_PAGE_UP
Definition: capi.h:147
@ ORIENTATION_PAGE_LEFT
Definition: capi.h:150

◆ TessPageIteratorLevel

Enumerator
RIL_BLOCK 
RIL_PARA 
RIL_TEXTLINE 
RIL_WORD 
RIL_SYMBOL 

Definition at line 121 of file capi.h.

121 {
122 RIL_BLOCK,
123 RIL_PARA,
125 RIL_WORD,
TessPageIteratorLevel
Definition: capi.h:121
@ RIL_TEXTLINE
Definition: capi.h:124
@ RIL_PARA
Definition: capi.h:123
@ RIL_BLOCK
Definition: capi.h:122
@ RIL_WORD
Definition: capi.h:125
@ RIL_SYMBOL
Definition: capi.h:126

◆ TessPageSegMode

Enumerator
PSM_OSD_ONLY 
PSM_AUTO_OSD 
PSM_AUTO_ONLY 
PSM_AUTO 
PSM_SINGLE_COLUMN 
PSM_SINGLE_BLOCK_VERT_TEXT 
PSM_SINGLE_BLOCK 
PSM_SINGLE_LINE 
PSM_SINGLE_WORD 
PSM_CIRCLE_WORD 
PSM_SINGLE_CHAR 
PSM_SPARSE_TEXT 
PSM_SPARSE_TEXT_OSD 
PSM_RAW_LINE 
PSM_COUNT 

Definition at line 104 of file capi.h.

104 {
108 PSM_AUTO,
TessPageSegMode
Definition: capi.h:104
@ PSM_AUTO
Definition: capi.h:108
@ PSM_OSD_ONLY
Definition: capi.h:105
@ PSM_SINGLE_CHAR
Definition: capi.h:115
@ PSM_AUTO_OSD
Definition: capi.h:106
@ PSM_CIRCLE_WORD
Definition: capi.h:114
@ PSM_SINGLE_BLOCK_VERT_TEXT
Definition: capi.h:110
@ PSM_SINGLE_COLUMN
Definition: capi.h:109
@ PSM_SPARSE_TEXT
Definition: capi.h:116
@ PSM_COUNT
Definition: capi.h:119
@ PSM_SINGLE_LINE
Definition: capi.h:112
@ PSM_SINGLE_BLOCK
Definition: capi.h:111
@ PSM_RAW_LINE
Definition: capi.h:118
@ PSM_AUTO_ONLY
Definition: capi.h:107
@ PSM_SINGLE_WORD
Definition: capi.h:113
@ PSM_SPARSE_TEXT_OSD
Definition: capi.h:117

◆ TessParagraphJustification

Enumerator
JUSTIFICATION_UNKNOWN 
JUSTIFICATION_LEFT 
JUSTIFICATION_CENTER 
JUSTIFICATION_RIGHT 

Definition at line 152 of file capi.h.

152 {
TessParagraphJustification
Definition: capi.h:152
@ JUSTIFICATION_LEFT
Definition: capi.h:154
@ JUSTIFICATION_RIGHT
Definition: capi.h:156
@ JUSTIFICATION_CENTER
Definition: capi.h:155
@ JUSTIFICATION_UNKNOWN
Definition: capi.h:153

◆ TessPolyBlockType

Enumerator
PT_UNKNOWN 
PT_FLOWING_TEXT 
PT_HEADING_TEXT 
PT_PULLOUT_TEXT 
PT_EQUATION 
PT_INLINE_EQUATION 
PT_TABLE 
PT_VERTICAL_TEXT 
PT_CAPTION_TEXT 
PT_FLOWING_IMAGE 
PT_HEADING_IMAGE 
PT_PULLOUT_IMAGE 
PT_HORZ_LINE 
PT_VERT_LINE 
PT_NOISE 
PT_COUNT 

Definition at line 128 of file capi.h.

128 {
135 PT_TABLE,
143 PT_NOISE,
TessPolyBlockType
Definition: capi.h:128
@ PT_VERT_LINE
Definition: capi.h:142
@ PT_PULLOUT_TEXT
Definition: capi.h:132
@ PT_COUNT
Definition: capi.h:144
@ PT_HEADING_TEXT
Definition: capi.h:131
@ PT_TABLE
Definition: capi.h:135
@ PT_NOISE
Definition: capi.h:143
@ PT_PULLOUT_IMAGE
Definition: capi.h:140
@ PT_HEADING_IMAGE
Definition: capi.h:139
@ PT_INLINE_EQUATION
Definition: capi.h:134
@ PT_FLOWING_TEXT
Definition: capi.h:130
@ PT_UNKNOWN
Definition: capi.h:129
@ PT_HORZ_LINE
Definition: capi.h:141
@ PT_VERTICAL_TEXT
Definition: capi.h:136
@ PT_EQUATION
Definition: capi.h:133
@ PT_FLOWING_IMAGE
Definition: capi.h:138
@ PT_CAPTION_TEXT
Definition: capi.h:137

◆ TessTextlineOrder

Enumerator
TEXTLINE_ORDER_LEFT_TO_RIGHT 
TEXTLINE_ORDER_RIGHT_TO_LEFT 
TEXTLINE_ORDER_TOP_TO_BOTTOM 

Definition at line 163 of file capi.h.

163 {
TessTextlineOrder
Definition: capi.h:163
@ TEXTLINE_ORDER_TOP_TO_BOTTOM
Definition: capi.h:166
@ TEXTLINE_ORDER_RIGHT_TO_LEFT
Definition: capi.h:165
@ TEXTLINE_ORDER_LEFT_TO_RIGHT
Definition: capi.h:164

◆ TessWritingDirection

Enumerator
WRITING_DIRECTION_LEFT_TO_RIGHT 
WRITING_DIRECTION_RIGHT_TO_LEFT 
WRITING_DIRECTION_TOP_TO_BOTTOM 

Definition at line 158 of file capi.h.

158 {
TessWritingDirection
Definition: capi.h:158
@ WRITING_DIRECTION_RIGHT_TO_LEFT
Definition: capi.h:160
@ WRITING_DIRECTION_TOP_TO_BOTTOM
Definition: capi.h:161
@ WRITING_DIRECTION_LEFT_TO_RIGHT
Definition: capi.h:159

Function Documentation

◆ TessAltoRendererCreate()

TESS_API TessResultRenderer *TESS_CALL TessAltoRendererCreate ( const char *  outputbase)

Definition at line 66 of file capi.cpp.

66 {
67 return new TessAltoRenderer(outputbase);
68}

◆ TessBaseAPIAdaptToWordStr()

TESS_API BOOL TESS_CALL TessBaseAPIAdaptToWordStr ( TessBaseAPI handle,
TessPageSegMode  mode,
const char *  wordstr 
)

Definition at line 548 of file capi.cpp.

550 {
551 return static_cast<int>(handle->AdaptToWordStr(mode, wordstr));
552}

◆ TessBaseAPIAllWordConfidences()

TESS_API int *TESS_CALL TessBaseAPIAllWordConfidences ( TessBaseAPI handle)

Definition at line 543 of file capi.cpp.

543 {
544 return handle->AllWordConfidences();
545}

◆ TessBaseAPIAnalyseLayout()

TESS_API TessPageIterator *TESS_CALL TessBaseAPIAnalyseLayout ( TessBaseAPI handle)

Definition at line 456 of file capi.cpp.

456 {
457 return handle->AnalyseLayout();
458}

◆ TessBaseAPIClear()

TESS_API void TESS_CALL TessBaseAPIClear ( TessBaseAPI handle)

Definition at line 555 of file capi.cpp.

555 {
556 handle->Clear();
557}

◆ TessBaseAPIClearAdaptiveClassifier()

TESS_API void TESS_CALL TessBaseAPIClearAdaptiveClassifier ( TessBaseAPI handle)

Definition at line 361 of file capi.cpp.

361 {
362 handle->ClearAdaptiveClassifier();
363}

◆ TessBaseAPICreate()

TESS_API TessBaseAPI *TESS_CALL TessBaseAPICreate ( )

Definition at line 144 of file capi.cpp.

144 {
145 return new TessBaseAPI;
146}
struct TessBaseAPI TessBaseAPI
Definition: capi.h:93

◆ TessBaseAPIDelete()

TESS_API void TESS_CALL TessBaseAPIDelete ( TessBaseAPI handle)

Definition at line 148 of file capi.cpp.

148 {
149 delete handle;
150}

◆ TessBaseAPIEnd()

TESS_API void TESS_CALL TessBaseAPIEnd ( TessBaseAPI handle)

Definition at line 559 of file capi.cpp.

559 {
560 handle->End();
561}

◆ TessBaseAPIGetAltoText()

TESS_API char *TESS_CALL TessBaseAPIGetAltoText ( TessBaseAPI handle,
int  page_number 
)

Definition at line 510 of file capi.cpp.

511 {
512 return handle->GetAltoText(page_number);
513}

◆ TessBaseAPIGetAvailableLanguagesAsVector()

TESS_API char **TESS_CALL TessBaseAPIGetAvailableLanguagesAsVector ( const TessBaseAPI handle)

Definition at line 307 of file capi.cpp.

307 {
308 GenericVector<STRING> languages;
309 handle->GetAvailableLanguagesAsVector(&languages);
310 char** arr = new char*[languages.size() + 1];
311 for (int index = 0; index < languages.size(); ++index) {
312 arr[index] = languages[index].strdup();
313 }
314 arr[languages.size()] = nullptr;
315 return arr;
316}
int size() const
Definition: genericvector.h:72

◆ TessBaseAPIGetBoolVariable()

TESS_API BOOL TESS_CALL TessBaseAPIGetBoolVariable ( const TessBaseAPI handle,
const char *  name,
BOOL value 
)

Definition at line 206 of file capi.cpp.

208 {
209 bool boolValue;
210 bool result = handle->GetBoolVariable(name, &boolValue);
211 if (result) {
212 *value = static_cast<int>(boolValue);
213 }
214 return static_cast<int>(result);
215}

◆ TessBaseAPIGetBoxText()

TESS_API char *TESS_CALL TessBaseAPIGetBoxText ( TessBaseAPI handle,
int  page_number 
)

Definition at line 520 of file capi.cpp.

521 {
522 return handle->GetBoxText(page_number);
523}

◆ TessBaseAPIGetComponentImages()

TESS_API struct Boxa *TESS_CALL TessBaseAPIGetComponentImages ( TessBaseAPI handle,
TessPageIteratorLevel  level,
BOOL  text_only,
struct Pixa **  pixa,
int **  blockids 
)

Definition at line 434 of file capi.cpp.

436 {
437 return handle->GetComponentImages(level, static_cast<bool>(text_only), pixa,
438 blockids);
439}

◆ TessBaseAPIGetComponentImages1()

TESS_API struct Boxa *TESS_CALL TessBaseAPIGetComponentImages1 ( TessBaseAPI handle,
TessPageIteratorLevel  level,
BOOL  text_only,
BOOL  raw_image,
int  raw_padding,
struct Pixa **  pixa,
int **  blockids,
int **  paraids 
)

Definition at line 441 of file capi.cpp.

444 {
445 return handle->GetComponentImages(level, static_cast<bool>(text_only),
446 raw_image != 0, raw_padding, pixa, blockids,
447 paraids);
448}

◆ TessBaseAPIGetConnectedComponents()

TESS_API struct Boxa *TESS_CALL TessBaseAPIGetConnectedComponents ( TessBaseAPI handle,
struct Pixa **  cc 
)

Definition at line 430 of file capi.cpp.

430 {
431 return handle->GetConnectedComponents(cc);
432}

◆ TessBaseAPIGetDatapath()

TESS_API const char *TESS_CALL TessBaseAPIGetDatapath ( TessBaseAPI handle)

Definition at line 179 of file capi.cpp.

179 {
180 return handle->GetDatapath();
181}

◆ TessBaseAPIGetDoubleVariable()

TESS_API BOOL TESS_CALL TessBaseAPIGetDoubleVariable ( const TessBaseAPI handle,
const char *  name,
double *  value 
)

Definition at line 217 of file capi.cpp.

219 {
220 return static_cast<int>(handle->GetDoubleVariable(name, value));
221}

◆ TessBaseAPIGetHOCRText()

TESS_API char *TESS_CALL TessBaseAPIGetHOCRText ( TessBaseAPI handle,
int  page_number 
)

Definition at line 505 of file capi.cpp.

506 {
507 return handle->GetHOCRText(nullptr, page_number);
508}

◆ TessBaseAPIGetInitLanguagesAsString()

TESS_API const char *TESS_CALL TessBaseAPIGetInitLanguagesAsString ( const TessBaseAPI handle)

Definition at line 290 of file capi.cpp.

290 {
291 return handle->GetInitLanguagesAsString();
292}

◆ TessBaseAPIGetInputImage()

TESS_API struct Pix *TESS_CALL TessBaseAPIGetInputImage ( TessBaseAPI handle)

Definition at line 171 of file capi.cpp.

171 {
172 return handle->GetInputImage();
173}

◆ TessBaseAPIGetInputName()

TESS_API const char *TESS_CALL TessBaseAPIGetInputName ( TessBaseAPI handle)

Definition at line 162 of file capi.cpp.

162 {
163 return handle->GetInputName();
164}

◆ TessBaseAPIGetIntVariable()

TESS_API BOOL TESS_CALL TessBaseAPIGetIntVariable ( const TessBaseAPI handle,
const char *  name,
int *  value 
)

Definition at line 200 of file capi.cpp.

202 {
203 return static_cast<int>(handle->GetIntVariable(name, value));
204}

◆ TessBaseAPIGetIterator()

TESS_API TessResultIterator *TESS_CALL TessBaseAPIGetIterator ( TessBaseAPI handle)

Definition at line 492 of file capi.cpp.

492 {
493 return handle->GetIterator();
494}

◆ TessBaseAPIGetLoadedLanguagesAsVector()

TESS_API char **TESS_CALL TessBaseAPIGetLoadedLanguagesAsVector ( const TessBaseAPI handle)

Definition at line 295 of file capi.cpp.

295 {
296 GenericVector<STRING> languages;
297 handle->GetLoadedLanguagesAsVector(&languages);
298 char** arr = new char*[languages.size() + 1];
299 for (int index = 0; index < languages.size(); ++index) {
300 arr[index] = languages[index].strdup();
301 }
302 arr[languages.size()] = nullptr;
303 return arr;
304}

◆ TessBaseAPIGetLSTMBoxText()

TESS_API char *TESS_CALL TessBaseAPIGetLSTMBoxText ( TessBaseAPI handle,
int  page_number 
)

Definition at line 530 of file capi.cpp.

531 {
532 return handle->GetLSTMBoxText(page_number);
533}

◆ TessBaseAPIGetMutableIterator()

TESS_API TessMutableIterator *TESS_CALL TessBaseAPIGetMutableIterator ( TessBaseAPI handle)

Definition at line 497 of file capi.cpp.

497 {
498 return handle->GetMutableIterator();
499}

◆ TessBaseAPIGetOpenCLDevice()

TESS_API size_t TESS_CALL TessBaseAPIGetOpenCLDevice ( TessBaseAPI handle,
void **  device 
)

Definition at line 152 of file capi.cpp.

153 {
154 return TessBaseAPI::getOpenCLDevice(device);
155}

◆ TessBaseAPIGetPageSegMode()

TESS_API TessPageSegMode TESS_CALL TessBaseAPIGetPageSegMode ( const TessBaseAPI handle)

Definition at line 346 of file capi.cpp.

346 {
347 return handle->GetPageSegMode();
348}

◆ TessBaseAPIGetRegions()

TESS_API struct Boxa *TESS_CALL TessBaseAPIGetRegions ( TessBaseAPI handle,
struct Pixa **  pixa 
)

Definition at line 400 of file capi.cpp.

401 {
402 return handle->GetRegions(pixa);
403}

◆ TessBaseAPIGetSourceYResolution()

TESS_API int TESS_CALL TessBaseAPIGetSourceYResolution ( TessBaseAPI handle)

Definition at line 175 of file capi.cpp.

175 {
176 return handle->GetSourceYResolution();
177}

◆ TessBaseAPIGetStringVariable()

TESS_API const char *TESS_CALL TessBaseAPIGetStringVariable ( const TessBaseAPI handle,
const char *  name 
)

Definition at line 224 of file capi.cpp.

224 {
225 return handle->GetStringVariable(name);
226}

◆ TessBaseAPIGetStrips()

TESS_API struct Boxa *TESS_CALL TessBaseAPIGetStrips ( TessBaseAPI handle,
struct Pixa **  pixa,
int **  blockids 
)

Definition at line 418 of file capi.cpp.

420 {
421 return handle->GetStrips(pixa, blockids);
422}

◆ TessBaseAPIGetTextDirection()

TESS_API BOOL TESS_CALL TessBaseAPIGetTextDirection ( TessBaseAPI handle,
int *  out_offset,
float *  out_slope 
)

Definition at line 568 of file capi.cpp.

570 {
571 return static_cast<int>(handle->GetTextDirection(out_offset, out_slope));
572}

◆ TessBaseAPIGetTextlines()

TESS_API struct Boxa *TESS_CALL TessBaseAPIGetTextlines ( TessBaseAPI handle,
struct Pixa **  pixa,
int **  blockids 
)

Definition at line 405 of file capi.cpp.

407 {
408 return handle->GetTextlines(pixa, blockids);
409}

◆ TessBaseAPIGetTextlines1()

TESS_API struct Boxa *TESS_CALL TessBaseAPIGetTextlines1 ( TessBaseAPI handle,
BOOL  raw_image,
int  raw_padding,
struct Pixa **  pixa,
int **  blockids,
int **  paraids 
)

Definition at line 411 of file capi.cpp.

413 {
414 return handle->GetTextlines(raw_image != 0, raw_padding, pixa, blockids,
415 paraids);
416}

◆ TessBaseAPIGetThresholdedImage()

TESS_API struct Pix *TESS_CALL TessBaseAPIGetThresholdedImage ( TessBaseAPI handle)

Definition at line 396 of file capi.cpp.

396 {
397 return handle->GetThresholdedImage();
398}

◆ TessBaseAPIGetThresholdedImageScaleFactor()

TESS_API int TESS_CALL TessBaseAPIGetThresholdedImageScaleFactor ( const TessBaseAPI handle)

Definition at line 451 of file capi.cpp.

451 {
452 return handle->GetThresholdedImageScaleFactor();
453}

◆ TessBaseAPIGetTsvText()

TESS_API char *TESS_CALL TessBaseAPIGetTsvText ( TessBaseAPI handle,
int  page_number 
)

Definition at line 515 of file capi.cpp.

516 {
517 return handle->GetTSVText(page_number);
518}

◆ TessBaseAPIGetUnichar()

TESS_API const char *TESS_CALL TessBaseAPIGetUnichar ( TessBaseAPI handle,
int  unichar_id 
)

Definition at line 621 of file capi.cpp.

622 {
623 return handle->GetUnichar(unichar_id);
624}

◆ TessBaseAPIGetUNLVText()

TESS_API char *TESS_CALL TessBaseAPIGetUNLVText ( TessBaseAPI handle)

Definition at line 535 of file capi.cpp.

535 {
536 return handle->GetUNLVText();
537}

◆ TessBaseAPIGetUTF8Text()

TESS_API char *TESS_CALL TessBaseAPIGetUTF8Text ( TessBaseAPI handle)

Definition at line 501 of file capi.cpp.

501 {
502 return handle->GetUTF8Text();
503}

◆ TessBaseAPIGetWords()

TESS_API struct Boxa *TESS_CALL TessBaseAPIGetWords ( TessBaseAPI handle,
struct Pixa **  pixa 
)

Definition at line 424 of file capi.cpp.

425 {
426 return handle->GetWords(pixa);
427}

◆ TessBaseAPIGetWordStrBoxText()

TESS_API char *TESS_CALL TessBaseAPIGetWordStrBoxText ( TessBaseAPI handle,
int  page_number 
)

Definition at line 525 of file capi.cpp.

526 {
527 return handle->GetWordStrBoxText(page_number);
528}

◆ TessBaseAPIInit1()

TESS_API int TESS_CALL TessBaseAPIInit1 ( TessBaseAPI handle,
const char *  datapath,
const char *  language,
TessOcrEngineMode  oem,
char **  configs,
int  configs_size 
)

Definition at line 267 of file capi.cpp.

271 {
272 return handle->Init(datapath, language, oem, configs, configs_size, nullptr,
273 nullptr, false);
274}

◆ TessBaseAPIInit2()

TESS_API int TESS_CALL TessBaseAPIInit2 ( TessBaseAPI handle,
const char *  datapath,
const char *  language,
TessOcrEngineMode  oem 
)

Definition at line 276 of file capi.cpp.

279 {
280 return handle->Init(datapath, language, oem);
281}

◆ TessBaseAPIInit3()

TESS_API int TESS_CALL TessBaseAPIInit3 ( TessBaseAPI handle,
const char *  datapath,
const char *  language 
)

Definition at line 283 of file capi.cpp.

285 {
286 return handle->Init(datapath, language);
287}

◆ TessBaseAPIInit4()

TESS_API int TESS_CALL TessBaseAPIInit4 ( TessBaseAPI handle,
const char *  datapath,
const char *  language,
TessOcrEngineMode  mode,
char **  configs,
int  configs_size,
char **  vars_vec,
char **  vars_values,
size_t  vars_vec_size,
BOOL  set_only_non_debug_params 
)

Definition at line 250 of file capi.cpp.

253 {
254 GenericVector<STRING> varNames;
255 GenericVector<STRING> varValues;
256 if (vars_vec != nullptr && vars_values != nullptr) {
257 for (size_t i = 0; i < vars_vec_size; i++) {
258 varNames.push_back(STRING(vars_vec[i]));
259 varValues.push_back(STRING(vars_values[i]));
260 }
261 }
262
263 return handle->Init(datapath, language, mode, configs, configs_size,
264 &varNames, &varValues, set_only_non_debug_params != 0);
265}
int push_back(T object)
Definition: strngs.h:45

◆ TessBaseAPIInitForAnalysePage()

TESS_API void TESS_CALL TessBaseAPIInitForAnalysePage ( TessBaseAPI handle)

Definition at line 326 of file capi.cpp.

326 {
327 handle->InitForAnalysePage();
328}

◆ TessBaseAPIInitLangMod()

TESS_API int TESS_CALL TessBaseAPIInitLangMod ( TessBaseAPI handle,
const char *  datapath,
const char *  language 
)

Definition at line 319 of file capi.cpp.

321 {
322 return handle->InitLangMod(datapath, language);
323}

◆ TessBaseAPIIsValidWord()

TESS_API int TESS_CALL TessBaseAPIIsValidWord ( TessBaseAPI handle,
const char *  word 
)

Definition at line 563 of file capi.cpp.

564 {
565 return handle->IsValidWord(word);
566}

◆ TessBaseAPIMeanTextConf()

TESS_API int TESS_CALL TessBaseAPIMeanTextConf ( TessBaseAPI handle)

Definition at line 539 of file capi.cpp.

539 {
540 return handle->MeanTextConf();
541}

◆ TessBaseAPIPrintVariables()

TESS_API void TESS_CALL TessBaseAPIPrintVariables ( const TessBaseAPI handle,
FILE *  fp 
)

Definition at line 228 of file capi.cpp.

229 {
230 handle->PrintVariables(fp);
231}

◆ TessBaseAPIPrintVariablesToFile()

TESS_API BOOL TESS_CALL TessBaseAPIPrintVariablesToFile ( const TessBaseAPI handle,
const char *  filename 
)

Definition at line 233 of file capi.cpp.

234 {
235 FILE* fp = fopen(filename, "w");
236 if (fp != nullptr) {
237 handle->PrintVariables(fp);
238 fclose(fp);
239 return TRUE;
240 }
241 return FALSE;
242}
#define TRUE
Definition: capi.h:51
#define FALSE
Definition: capi.h:52

◆ TessBaseAPIProcessPage()

TESS_API BOOL TESS_CALL TessBaseAPIProcessPage ( TessBaseAPI handle,
struct Pix *  pix,
int  page_index,
const char *  filename,
const char *  retry_config,
int  timeout_millisec,
TessResultRenderer renderer 
)

Definition at line 481 of file capi.cpp.

486 {
487 return static_cast<int>(handle->ProcessPage(
488 pix, page_index, filename, retry_config, timeout_millisec, renderer));
489}

◆ TessBaseAPIProcessPages()

TESS_API BOOL TESS_CALL TessBaseAPIProcessPages ( TessBaseAPI handle,
const char *  filename,
const char *  retry_config,
int  timeout_millisec,
TessResultRenderer renderer 
)

Definition at line 472 of file capi.cpp.

476 {
477 return static_cast<int>(
478 handle->ProcessPages(filename, retry_config, timeout_millisec, renderer));
479}

◆ TessBaseAPIReadConfigFile()

TESS_API void TESS_CALL TessBaseAPIReadConfigFile ( TessBaseAPI handle,
const char *  filename 
)

Definition at line 330 of file capi.cpp.

331 {
332 handle->ReadConfigFile(filename);
333}

◆ TessBaseAPIReadDebugConfigFile()

TESS_API void TESS_CALL TessBaseAPIReadDebugConfigFile ( TessBaseAPI handle,
const char *  filename 
)

Definition at line 335 of file capi.cpp.

336 {
337 handle->ReadDebugConfigFile(filename);
338}

◆ TessBaseAPIRecognize()

TESS_API int TESS_CALL TessBaseAPIRecognize ( TessBaseAPI handle,
ETEXT_DESC monitor 
)

Definition at line 460 of file capi.cpp.

461 {
462 return handle->Recognize(monitor);
463}

◆ TessBaseAPIRecognizeForChopTest()

TESS_API int TESS_CALL TessBaseAPIRecognizeForChopTest ( TessBaseAPI handle,
ETEXT_DESC monitor 
)

Definition at line 466 of file capi.cpp.

467 {
468 return handle->RecognizeForChopTest(monitor);
469}

◆ TessBaseAPIRect()

TESS_API char *TESS_CALL TessBaseAPIRect ( TessBaseAPI handle,
const unsigned char *  imagedata,
int  bytes_per_pixel,
int  bytes_per_line,
int  left,
int  top,
int  width,
int  height 
)

Definition at line 350 of file capi.cpp.

354 {
355 return handle->TesseractRect(imagedata, bytes_per_pixel, bytes_per_line, left,
356 top, width, height);
357}

◆ TessBaseAPISetDebugVariable()

TESS_API BOOL TESS_CALL TessBaseAPISetDebugVariable ( TessBaseAPI handle,
const char *  name,
const char *  value 
)

Definition at line 194 of file capi.cpp.

196 {
197 return static_cast<int>(handle->SetDebugVariable(name, value));
198}

◆ TessBaseAPISetImage()

TESS_API void TESS_CALL TessBaseAPISetImage ( TessBaseAPI handle,
const unsigned char *  imagedata,
int  width,
int  height,
int  bytes_per_pixel,
int  bytes_per_line 
)

Definition at line 366 of file capi.cpp.

370 {
371 handle->SetImage(imagedata, width, height, bytes_per_pixel, bytes_per_line);
372}

◆ TessBaseAPISetImage2()

TESS_API void TESS_CALL TessBaseAPISetImage2 ( TessBaseAPI handle,
struct Pix *  pix 
)

Definition at line 374 of file capi.cpp.

375 {
376 return handle->SetImage(pix);
377}

◆ TessBaseAPISetInputImage()

TESS_API void TESS_CALL TessBaseAPISetInputImage ( TessBaseAPI handle,
struct Pix *  pix 
)

Definition at line 166 of file capi.cpp.

167 {
168 handle->SetInputImage(pix);
169}

◆ TessBaseAPISetInputName()

TESS_API void TESS_CALL TessBaseAPISetInputName ( TessBaseAPI handle,
const char *  name 
)

Definition at line 157 of file capi.cpp.

158 {
159 handle->SetInputName(name);
160}

◆ TessBaseAPISetMinOrientationMargin()

TESS_API void TESS_CALL TessBaseAPISetMinOrientationMargin ( TessBaseAPI handle,
double  margin 
)

Definition at line 660 of file capi.cpp.

661 {
662 handle->set_min_orientation_margin(margin);
663}

◆ TessBaseAPISetOutputName()

TESS_API void TESS_CALL TessBaseAPISetOutputName ( TessBaseAPI handle,
const char *  name 
)

Definition at line 183 of file capi.cpp.

184 {
185 handle->SetOutputName(name);
186}

◆ TessBaseAPISetPageSegMode()

TESS_API void TESS_CALL TessBaseAPISetPageSegMode ( TessBaseAPI handle,
TessPageSegMode  mode 
)

Definition at line 340 of file capi.cpp.

341 {
342 handle->SetPageSegMode(mode);
343}

◆ TessBaseAPISetRectangle()

TESS_API void TESS_CALL TessBaseAPISetRectangle ( TessBaseAPI handle,
int  left,
int  top,
int  width,
int  height 
)

Definition at line 384 of file capi.cpp.

386 {
387 handle->SetRectangle(left, top, width, height);
388}

◆ TessBaseAPISetSourceResolution()

TESS_API void TESS_CALL TessBaseAPISetSourceResolution ( TessBaseAPI handle,
int  ppi 
)

Definition at line 379 of file capi.cpp.

380 {
381 handle->SetSourceResolution(ppi);
382}

◆ TessBaseAPISetVariable()

TESS_API BOOL TESS_CALL TessBaseAPISetVariable ( TessBaseAPI handle,
const char *  name,
const char *  value 
)

Definition at line 188 of file capi.cpp.

190 {
191 return static_cast<int>(handle->SetVariable(name, value));
192}

◆ TessBoxTextRendererCreate()

TESS_API TessResultRenderer *TESS_CALL TessBoxTextRendererCreate ( const char *  outputbase)

Definition at line 86 of file capi.cpp.

86 {
87 return new TessBoxTextRenderer(outputbase);
88}
struct TessBoxTextRenderer TessBoxTextRenderer
Definition: capi.h:92

◆ TessChoiceIteratorConfidence()

TESS_API float TESS_CALL TessChoiceIteratorConfidence ( const TessChoiceIterator handle)

Definition at line 875 of file capi.cpp.

875 {
876 return handle->Confidence();
877}

◆ TessChoiceIteratorDelete()

TESS_API void TESS_CALL TessChoiceIteratorDelete ( TessChoiceIterator handle)

Definition at line 861 of file capi.cpp.

861 {
862 delete handle;
863}

◆ TessChoiceIteratorGetUTF8Text()

TESS_API const char *TESS_CALL TessChoiceIteratorGetUTF8Text ( const TessChoiceIterator handle)

Definition at line 870 of file capi.cpp.

870 {
871 return handle->GetUTF8Text();
872}

◆ TessChoiceIteratorNext()

TESS_API BOOL TESS_CALL TessChoiceIteratorNext ( TessChoiceIterator handle)

Definition at line 865 of file capi.cpp.

865 {
866 return static_cast<int>(handle->Next());
867}

◆ TessDeleteIntArray()

TESS_API void TESS_CALL TessDeleteIntArray ( const int *  arr)

Definition at line 40 of file capi.cpp.

40 {
41 delete[] arr;
42}

◆ TessDeleteResultRenderer()

TESS_API void TESS_CALL TessDeleteResultRenderer ( TessResultRenderer renderer)

Definition at line 100 of file capi.cpp.

100 {
101 delete renderer;
102}

◆ TessDeleteText()

TESS_API void TESS_CALL TessDeleteText ( const char *  text)

Definition at line 29 of file capi.cpp.

29 {
30 delete[] text;
31}

◆ TessDeleteTextArray()

TESS_API void TESS_CALL TessDeleteTextArray ( char **  arr)

Definition at line 33 of file capi.cpp.

33 {
34 for (char** pos = arr; *pos != nullptr; ++pos) {
35 delete[] * pos;
36 }
37 delete[] arr;
38}

◆ TessHOcrRendererCreate()

TESS_API TessResultRenderer *TESS_CALL TessHOcrRendererCreate ( const char *  outputbase)

Definition at line 56 of file capi.cpp.

56 {
57 return new TessHOcrRenderer(outputbase);
58}
struct TessHOcrRenderer TessHOcrRenderer
Definition: capi.h:89

◆ TessHOcrRendererCreate2()

TESS_API TessResultRenderer *TESS_CALL TessHOcrRendererCreate2 ( const char *  outputbase,
BOOL  font_info 
)

Definition at line 61 of file capi.cpp.

61 {
62 return new TessHOcrRenderer(outputbase, font_info != 0);
63}

◆ TessLSTMBoxRendererCreate()

TESS_API TessResultRenderer *TESS_CALL TessLSTMBoxRendererCreate ( const char *  outputbase)

Definition at line 96 of file capi.cpp.

96 {
97 return new TessLSTMBoxRenderer(outputbase);
98}

◆ TessMonitorCreate()

TESS_API ETEXT_DESC *TESS_CALL TessMonitorCreate ( )

Definition at line 879 of file capi.cpp.

879 {
880 return new ETEXT_DESC();
881}

◆ TessMonitorDelete()

TESS_API void TESS_CALL TessMonitorDelete ( ETEXT_DESC monitor)

Definition at line 883 of file capi.cpp.

883 {
884 delete monitor;
885}

◆ TessMonitorGetCancelThis()

TESS_API void *TESS_CALL TessMonitorGetCancelThis ( ETEXT_DESC monitor)

Definition at line 897 of file capi.cpp.

897 {
898 return monitor->cancel_this;
899}
void * cancel_this
monitor-aware progress callback
Definition: ocrclass.h:116

◆ TessMonitorGetProgress()

TESS_API int TESS_CALL TessMonitorGetProgress ( ETEXT_DESC monitor)

Definition at line 906 of file capi.cpp.

906 {
907 return monitor->progress;
908}
int16_t progress
chars in this buffer(0)
Definition: ocrclass.h:105

◆ TessMonitorSetCancelFunc()

TESS_API void TESS_CALL TessMonitorSetCancelFunc ( ETEXT_DESC monitor,
TessCancelFunc  cancelFunc 
)

Definition at line 887 of file capi.cpp.

888 {
889 monitor->cancel = cancelFunc;
890}
CANCEL_FUNC cancel
for errcode use
Definition: ocrclass.h:112

◆ TessMonitorSetCancelThis()

TESS_API void TESS_CALL TessMonitorSetCancelThis ( ETEXT_DESC monitor,
void *  cancelThis 
)

Definition at line 892 of file capi.cpp.

893 {
894 monitor->cancel_this = cancelThis;
895}

◆ TessMonitorSetDeadlineMSecs()

TESS_API void TESS_CALL TessMonitorSetDeadlineMSecs ( ETEXT_DESC monitor,
int  deadline 
)

Definition at line 910 of file capi.cpp.

911 {
912 monitor->set_deadline_msecs(deadline);
913}
void set_deadline_msecs(int32_t deadline_msecs)
Definition: ocrclass.h:129

◆ TessMonitorSetProgressFunc()

TESS_API void TESS_CALL TessMonitorSetProgressFunc ( ETEXT_DESC monitor,
TessProgressFunc  progressFunc 
)

Definition at line 902 of file capi.cpp.

902 {
903 monitor->progress_callback2 = progressFunc;
904}
PROGRESS_FUNC2 progress_callback2
called whenever progress increases
Definition: ocrclass.h:115

◆ TessPageIteratorBaseline()

TESS_API BOOL TESS_CALL TessPageIteratorBaseline ( const TessPageIterator handle,
TessPageIteratorLevel  level,
int *  x1,
int *  y1,
int *  x2,
int *  y2 
)

Definition at line 728 of file capi.cpp.

731 {
732 return static_cast<int>(handle->Baseline(level, x1, y1, x2, y2));
733}

◆ TessPageIteratorBegin()

TESS_API void TESS_CALL TessPageIteratorBegin ( TessPageIterator handle)

Definition at line 686 of file capi.cpp.

686 {
687 handle->Begin();
688}

◆ TessPageIteratorBlockType()

TESS_API TessPolyBlockType TESS_CALL TessPageIteratorBlockType ( const TessPageIterator handle)

Definition at line 713 of file capi.cpp.

713 {
714 return handle->BlockType();
715}

◆ TessPageIteratorBoundingBox()

TESS_API BOOL TESS_CALL TessPageIteratorBoundingBox ( const TessPageIterator handle,
TessPageIteratorLevel  level,
int *  left,
int *  top,
int *  right,
int *  bottom 
)

Definition at line 706 of file capi.cpp.

708 {
709 return static_cast<int>(handle->BoundingBox(level, left, top, right, bottom));
710}

◆ TessPageIteratorCopy()

TESS_API TessPageIterator *TESS_CALL TessPageIteratorCopy ( const TessPageIterator handle)

Definition at line 682 of file capi.cpp.

682 {
683 return new TessPageIterator(*handle);
684}
struct TessPageIterator TessPageIterator
Definition: capi.h:94

◆ TessPageIteratorDelete()

TESS_API void TESS_CALL TessPageIteratorDelete ( TessPageIterator handle)

Definition at line 677 of file capi.cpp.

677 {
678 delete handle;
679}

◆ TessPageIteratorGetBinaryImage()

TESS_API struct Pix *TESS_CALL TessPageIteratorGetBinaryImage ( const TessPageIterator handle,
TessPageIteratorLevel  level 
)

Definition at line 717 of file capi.cpp.

718 {
719 return handle->GetBinaryImage(level);
720}

◆ TessPageIteratorGetImage()

TESS_API struct Pix *TESS_CALL TessPageIteratorGetImage ( const TessPageIterator handle,
TessPageIteratorLevel  level,
int  padding,
struct Pix *  original_image,
int *  left,
int *  top 
)

Definition at line 722 of file capi.cpp.

724 {
725 return handle->GetImage(level, padding, original_image, left, top);
726}

◆ TessPageIteratorIsAtBeginningOf()

TESS_API BOOL TESS_CALL TessPageIteratorIsAtBeginningOf ( const TessPageIterator handle,
TessPageIteratorLevel  level 
)

Definition at line 695 of file capi.cpp.

696 {
697 return static_cast<int>(handle->IsAtBeginningOf(level));
698}

◆ TessPageIteratorIsAtFinalElement()

TESS_API BOOL TESS_CALL TessPageIteratorIsAtFinalElement ( const TessPageIterator handle,
TessPageIteratorLevel  level,
TessPageIteratorLevel  element 
)

Definition at line 700 of file capi.cpp.

702 {
703 return static_cast<int>(handle->IsAtFinalElement(level, element));
704}

◆ TessPageIteratorNext()

TESS_API BOOL TESS_CALL TessPageIteratorNext ( TessPageIterator handle,
TessPageIteratorLevel  level 
)

Definition at line 690 of file capi.cpp.

691 {
692 return static_cast<int>(handle->Next(level));
693}

◆ TessPageIteratorOrientation()

TESS_API void TESS_CALL TessPageIteratorOrientation ( TessPageIterator handle,
TessOrientation orientation,
TessWritingDirection writing_direction,
TessTextlineOrder textline_order,
float *  deskew_angle 
)

Definition at line 735 of file capi.cpp.

738 {
739 handle->Orientation(orientation, writing_direction, textline_order,
740 deskew_angle);
741}

◆ TessPageIteratorParagraphInfo()

TESS_API void TESS_CALL TessPageIteratorParagraphInfo ( TessPageIterator handle,
TessParagraphJustification justification,
BOOL is_list_item,
BOOL is_crown,
int *  first_line_indent 
)

Definition at line 743 of file capi.cpp.

745 {
746 bool bool_is_list_item;
747 bool bool_is_crown;
748 handle->ParagraphInfo(justification, &bool_is_list_item, &bool_is_crown,
749 first_line_indent);
750 if (is_list_item != nullptr) {
751 *is_list_item = static_cast<int>(bool_is_list_item);
752 }
753 if (is_crown != nullptr) {
754 *is_crown = static_cast<int>(bool_is_crown);
755 }
756}

◆ TessPDFRendererCreate()

TESS_API TessResultRenderer *TESS_CALL TessPDFRendererCreate ( const char *  outputbase,
const char *  datadir,
BOOL  textonly 
)

Definition at line 75 of file capi.cpp.

76 {
77 return new TessPDFRenderer(outputbase, datadir, textonly != 0);
78}
struct TessPDFRenderer TessPDFRenderer
Definition: capi.h:90

◆ TessResultIteratorConfidence()

TESS_API float TESS_CALL TessResultIteratorConfidence ( const TessResultIterator handle,
TessPageIteratorLevel  level 
)

Definition at line 792 of file capi.cpp.

793 {
794 return handle->Confidence(level);
795}

◆ TessResultIteratorCopy()

TESS_API TessResultIterator *TESS_CALL TessResultIteratorCopy ( const TessResultIterator handle)

Definition at line 763 of file capi.cpp.

763 {
764 return new TessResultIterator(*handle);
765}
struct TessResultIterator TessResultIterator
Definition: capi.h:95

◆ TessResultIteratorDelete()

TESS_API void TESS_CALL TessResultIteratorDelete ( TessResultIterator handle)

Definition at line 758 of file capi.cpp.

758 {
759 delete handle;
760}

◆ TessResultIteratorGetChoiceIterator()

TESS_API TessChoiceIterator *TESS_CALL TessResultIteratorGetChoiceIterator ( const TessResultIterator handle)

Definition at line 778 of file capi.cpp.

778 {
779 return new TessChoiceIterator(*handle);
780}
struct TessChoiceIterator TessChoiceIterator
Definition: capi.h:97

◆ TessResultIteratorGetPageIterator()

TESS_API TessPageIterator *TESS_CALL TessResultIteratorGetPageIterator ( TessResultIterator handle)

Definition at line 768 of file capi.cpp.

768 {
769 return handle;
770}

◆ TessResultIteratorGetPageIteratorConst()

TESS_API const TessPageIterator *TESS_CALL TessResultIteratorGetPageIteratorConst ( const TessResultIterator handle)

Definition at line 773 of file capi.cpp.

773 {
774 return handle;
775}

◆ TessResultIteratorGetUTF8Text()

TESS_API char *TESS_CALL TessResultIteratorGetUTF8Text ( const TessResultIterator handle,
TessPageIteratorLevel  level 
)

Definition at line 787 of file capi.cpp.

788 {
789 return handle->GetUTF8Text(level);
790}

◆ TessResultIteratorNext()

TESS_API BOOL TESS_CALL TessResultIteratorNext ( TessResultIterator handle,
TessPageIteratorLevel  level 
)

Definition at line 782 of file capi.cpp.

783 {
784 return static_cast<int>(handle->Next(level));
785}

◆ TessResultIteratorSymbolIsDropcap()

TESS_API BOOL TESS_CALL TessResultIteratorSymbolIsDropcap ( const TessResultIterator handle)

Definition at line 857 of file capi.cpp.

857 {
858 return static_cast<int>(handle->SymbolIsDropcap());
859}

◆ TessResultIteratorSymbolIsSubscript()

TESS_API BOOL TESS_CALL TessResultIteratorSymbolIsSubscript ( const TessResultIterator handle)

Definition at line 852 of file capi.cpp.

852 {
853 return static_cast<int>(handle->SymbolIsSubscript());
854}

◆ TessResultIteratorSymbolIsSuperscript()

TESS_API BOOL TESS_CALL TessResultIteratorSymbolIsSuperscript ( const TessResultIterator handle)

Definition at line 847 of file capi.cpp.

847 {
848 return static_cast<int>(handle->SymbolIsSuperscript());
849}

◆ TessResultIteratorWordFontAttributes()

TESS_API const char *TESS_CALL TessResultIteratorWordFontAttributes ( const TessResultIterator handle,
BOOL is_bold,
BOOL is_italic,
BOOL is_underlined,
BOOL is_monospace,
BOOL is_serif,
BOOL is_smallcaps,
int *  pointsize,
int *  font_id 
)

Definition at line 802 of file capi.cpp.

805 {
806 bool bool_is_bold;
807 bool bool_is_italic;
808 bool bool_is_underlined;
809 bool bool_is_monospace;
810 bool bool_is_serif;
811 bool bool_is_smallcaps;
812 const char* ret = handle->WordFontAttributes(
813 &bool_is_bold, &bool_is_italic, &bool_is_underlined, &bool_is_monospace,
814 &bool_is_serif, &bool_is_smallcaps, pointsize, font_id);
815 if (is_bold != nullptr) {
816 *is_bold = static_cast<int>(bool_is_bold);
817 }
818 if (is_italic != nullptr) {
819 *is_italic = static_cast<int>(bool_is_italic);
820 }
821 if (is_underlined != nullptr) {
822 *is_underlined = static_cast<int>(bool_is_underlined);
823 }
824 if (is_monospace != nullptr) {
825 *is_monospace = static_cast<int>(bool_is_monospace);
826 }
827 if (is_serif != nullptr) {
828 *is_serif = static_cast<int>(bool_is_serif);
829 }
830 if (is_smallcaps != nullptr) {
831 *is_smallcaps = static_cast<int>(bool_is_smallcaps);
832 }
833 return ret;
834}

◆ TessResultIteratorWordIsFromDictionary()

TESS_API BOOL TESS_CALL TessResultIteratorWordIsFromDictionary ( const TessResultIterator handle)

Definition at line 837 of file capi.cpp.

837 {
838 return static_cast<int>(handle->WordIsFromDictionary());
839}

◆ TessResultIteratorWordIsNumeric()

TESS_API BOOL TESS_CALL TessResultIteratorWordIsNumeric ( const TessResultIterator handle)

Definition at line 842 of file capi.cpp.

842 {
843 return static_cast<int>(handle->WordIsNumeric());
844}

◆ TessResultIteratorWordRecognitionLanguage()

TESS_API const char *TESS_CALL TessResultIteratorWordRecognitionLanguage ( const TessResultIterator handle)

Definition at line 798 of file capi.cpp.

798 {
799 return handle->WordRecognitionLanguage();
800}

◆ TessResultRendererAddImage()

TESS_API BOOL TESS_CALL TessResultRendererAddImage ( TessResultRenderer renderer,
TessBaseAPI api 
)

Definition at line 119 of file capi.cpp.

120 {
121 return static_cast<int>(renderer->AddImage(api));
122}

◆ TessResultRendererBeginDocument()

TESS_API BOOL TESS_CALL TessResultRendererBeginDocument ( TessResultRenderer renderer,
const char *  title 
)

Definition at line 114 of file capi.cpp.

115 {
116 return static_cast<int>(renderer->BeginDocument(title));
117}

◆ TessResultRendererEndDocument()

TESS_API BOOL TESS_CALL TessResultRendererEndDocument ( TessResultRenderer renderer)

Definition at line 125 of file capi.cpp.

125 {
126 return static_cast<int>(renderer->EndDocument());
127}

◆ TessResultRendererExtention()

TESS_API const char *TESS_CALL TessResultRendererExtention ( TessResultRenderer renderer)

Definition at line 130 of file capi.cpp.

130 {
131 return renderer->file_extension();
132}

◆ TessResultRendererImageNum()

TESS_API int TESS_CALL TessResultRendererImageNum ( TessResultRenderer renderer)

Definition at line 140 of file capi.cpp.

140 {
141 return renderer->imagenum();
142}

◆ TessResultRendererInsert()

TESS_API void TESS_CALL TessResultRendererInsert ( TessResultRenderer renderer,
TessResultRenderer next 
)

Definition at line 104 of file capi.cpp.

105 {
106 renderer->insert(next);
107}

◆ TessResultRendererNext()

TESS_API TessResultRenderer *TESS_CALL TessResultRendererNext ( TessResultRenderer renderer)

Definition at line 110 of file capi.cpp.

110 {
111 return renderer->next();
112}

◆ TessResultRendererTitle()

TESS_API const char *TESS_CALL TessResultRendererTitle ( TessResultRenderer renderer)

Definition at line 135 of file capi.cpp.

135 {
136 return renderer->title();
137}

◆ TessTextRendererCreate()

TESS_API TessResultRenderer *TESS_CALL TessTextRendererCreate ( const char *  outputbase)

Definition at line 51 of file capi.cpp.

51 {
52 return new TessTextRenderer(outputbase);
53}
struct TessTextRenderer TessTextRenderer
Definition: capi.h:88

◆ TessTsvRendererCreate()

TESS_API TessResultRenderer *TESS_CALL TessTsvRendererCreate ( const char *  outputbase)

Definition at line 71 of file capi.cpp.

71 {
72 return new TessTsvRenderer(outputbase);
73}

◆ TessUnlvRendererCreate()

TESS_API TessResultRenderer *TESS_CALL TessUnlvRendererCreate ( const char *  outputbase)

Definition at line 81 of file capi.cpp.

81 {
82 return new TessUnlvRenderer(outputbase);
83}
struct TessUnlvRenderer TessUnlvRenderer
Definition: capi.h:91

◆ TessVersion()

TESS_API const char *TESS_CALL TessVersion ( )

Definition at line 25 of file capi.cpp.

25 {
26 return TessBaseAPI::Version();
27}

◆ TessWordStrBoxRendererCreate()

TESS_API TessResultRenderer *TESS_CALL TessWordStrBoxRendererCreate ( const char *  outputbase)

Definition at line 91 of file capi.cpp.

91 {
92 return new TessWordStrBoxRenderer(outputbase);
93}