#include "export.h"
#include <stdbool.h>
#include <stdio.h>

Macros
#define	BOOL int

#define	TRUE 1

#define	FALSE 0

Typedefs
typedef struct TessResultRenderer	TessResultRenderer

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 *	TessVersion ()

TESS_API void	TessDeleteText (const char *text)

TESS_API void	TessDeleteTextArray (char **arr)

TESS_API void	TessDeleteIntArray (const int *arr)

TESS_API TessResultRenderer *	TessTextRendererCreate (const char *outputbase)

TESS_API TessResultRenderer *	TessHOcrRendererCreate (const char *outputbase)

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

TESS_API TessResultRenderer *	TessAltoRendererCreate (const char *outputbase)

TESS_API TessResultRenderer *	TessTsvRendererCreate (const char *outputbase)

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

TESS_API TessResultRenderer *	TessUnlvRendererCreate (const char *outputbase)

TESS_API TessResultRenderer *	TessBoxTextRendererCreate (const char *outputbase)

TESS_API TessResultRenderer *	TessLSTMBoxRendererCreate (const char *outputbase)

TESS_API TessResultRenderer *	TessWordStrBoxRendererCreate (const char *outputbase)

TESS_API void	TessDeleteResultRenderer (TessResultRenderer *renderer)

TESS_API void	TessResultRendererInsert (TessResultRenderer renderer, TessResultRenderer next)

TESS_API TessResultRenderer *	TessResultRendererNext (TessResultRenderer *renderer)

TESS_API BOOL	TessResultRendererBeginDocument (TessResultRenderer renderer, const char title)

TESS_API BOOL	TessResultRendererAddImage (TessResultRenderer renderer, TessBaseAPI api)

TESS_API BOOL	TessResultRendererEndDocument (TessResultRenderer *renderer)

TESS_API const char *	TessResultRendererExtention (TessResultRenderer *renderer)

TESS_API const char *	TessResultRendererTitle (TessResultRenderer *renderer)

TESS_API int	TessResultRendererImageNum (TessResultRenderer *renderer)

TESS_API TessBaseAPI *	TessBaseAPICreate ()

TESS_API void	TessBaseAPIDelete (TessBaseAPI *handle)

TESS_API size_t	TessBaseAPIGetOpenCLDevice (TessBaseAPI handle, void *device)

TESS_API void	TessBaseAPISetInputName (TessBaseAPI handle, const char name)

TESS_API const char *	TessBaseAPIGetInputName (TessBaseAPI *handle)

TESS_API void	TessBaseAPISetInputImage (TessBaseAPI handle, struct Pix pix)

TESS_API struct Pix *	TessBaseAPIGetInputImage (TessBaseAPI *handle)

TESS_API int	TessBaseAPIGetSourceYResolution (TessBaseAPI *handle)

TESS_API const char *	TessBaseAPIGetDatapath (TessBaseAPI *handle)

TESS_API void	TessBaseAPISetOutputName (TessBaseAPI handle, const char name)

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

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

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

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

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

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

TESS_API void	TessBaseAPIPrintVariables (const TessBaseAPI handle, FILE fp)

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

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

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

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

TESS_API int	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 int	TessBaseAPIInit5 (TessBaseAPI handle, const char data, int data_size, 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 *	TessBaseAPIGetInitLanguagesAsString (const TessBaseAPI *handle)

TESS_API char **	TessBaseAPIGetLoadedLanguagesAsVector (const TessBaseAPI *handle)

TESS_API char **	TessBaseAPIGetAvailableLanguagesAsVector (const TessBaseAPI *handle)

TESS_API void	TessBaseAPIInitForAnalysePage (TessBaseAPI *handle)

TESS_API void	TessBaseAPIReadConfigFile (TessBaseAPI handle, const char filename)

TESS_API void	TessBaseAPIReadDebugConfigFile (TessBaseAPI handle, const char filename)

TESS_API void	TessBaseAPISetPageSegMode (TessBaseAPI *handle, TessPageSegMode mode)

TESS_API TessPageSegMode	TessBaseAPIGetPageSegMode (const TessBaseAPI *handle)

TESS_API char *	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	TessBaseAPIClearAdaptiveClassifier (TessBaseAPI *handle)

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

TESS_API void	TessBaseAPISetImage2 (TessBaseAPI handle, struct Pix pix)

TESS_API void	TessBaseAPISetSourceResolution (TessBaseAPI *handle, int ppi)

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

TESS_API struct Pix *	TessBaseAPIGetThresholdedImage (TessBaseAPI *handle)

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

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

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

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

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

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

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

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

TESS_API int	TessBaseAPIGetThresholdedImageScaleFactor (const TessBaseAPI *handle)

TESS_API TessPageIterator *	TessBaseAPIAnalyseLayout (TessBaseAPI *handle)

TESS_API int	TessBaseAPIRecognize (TessBaseAPI handle, ETEXT_DESC monitor)

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

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

TESS_API TessResultIterator *	TessBaseAPIGetIterator (TessBaseAPI *handle)

TESS_API TessMutableIterator *	TessBaseAPIGetMutableIterator (TessBaseAPI *handle)

TESS_API char *	TessBaseAPIGetUTF8Text (TessBaseAPI *handle)

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

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

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

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

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

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

TESS_API char *	TessBaseAPIGetUNLVText (TessBaseAPI *handle)

TESS_API int	TessBaseAPIMeanTextConf (TessBaseAPI *handle)

TESS_API int *	TessBaseAPIAllWordConfidences (TessBaseAPI *handle)

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

TESS_API void	TessBaseAPIClear (TessBaseAPI *handle)

TESS_API void	TessBaseAPIEnd (TessBaseAPI *handle)

TESS_API int	TessBaseAPIIsValidWord (TessBaseAPI handle, const char word)

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

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

TESS_API void	TessBaseAPIClearPersistentCache (TessBaseAPI *handle)

TESS_API BOOL	TessBaseAPIDetectOrientationScript (TessBaseAPI handle, int orient_deg, float orient_conf, const char script_name, float script_conf)

TESS_API void	TessBaseAPISetMinOrientationMargin (TessBaseAPI *handle, double margin)

TESS_API int	TessBaseAPINumDawgs (const TessBaseAPI *handle)

TESS_API TessOcrEngineMode	TessBaseAPIOem (const TessBaseAPI *handle)

TESS_API void	TessBaseGetBlockTextOrientations (TessBaseAPI handle, int block_orientation, bool *vertical_writing)

TESS_API void	TessPageIteratorDelete (TessPageIterator *handle)

TESS_API TessPageIterator *	TessPageIteratorCopy (const TessPageIterator *handle)

TESS_API void	TessPageIteratorBegin (TessPageIterator *handle)

TESS_API BOOL	TessPageIteratorNext (TessPageIterator *handle, TessPageIteratorLevel level)

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

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

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

TESS_API TessPolyBlockType	TessPageIteratorBlockType (const TessPageIterator *handle)

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

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

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

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

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

TESS_API void	TessResultIteratorDelete (TessResultIterator *handle)

TESS_API TessResultIterator *	TessResultIteratorCopy (const TessResultIterator *handle)

TESS_API TessPageIterator *	TessResultIteratorGetPageIterator (TessResultIterator *handle)

TESS_API const TessPageIterator *	TessResultIteratorGetPageIteratorConst (const TessResultIterator *handle)

TESS_API TessChoiceIterator *	TessResultIteratorGetChoiceIterator (const TessResultIterator *handle)

TESS_API BOOL	TessResultIteratorNext (TessResultIterator *handle, TessPageIteratorLevel level)

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

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

TESS_API const char *	TessResultIteratorWordRecognitionLanguage (const TessResultIterator *handle)

TESS_API const char *	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	TessResultIteratorWordIsFromDictionary (const TessResultIterator *handle)

TESS_API BOOL	TessResultIteratorWordIsNumeric (const TessResultIterator *handle)

TESS_API BOOL	TessResultIteratorSymbolIsSuperscript (const TessResultIterator *handle)

TESS_API BOOL	TessResultIteratorSymbolIsSubscript (const TessResultIterator *handle)

TESS_API BOOL	TessResultIteratorSymbolIsDropcap (const TessResultIterator *handle)

TESS_API void	TessChoiceIteratorDelete (TessChoiceIterator *handle)

TESS_API BOOL	TessChoiceIteratorNext (TessChoiceIterator *handle)

TESS_API const char *	TessChoiceIteratorGetUTF8Text (const TessChoiceIterator *handle)

TESS_API float	TessChoiceIteratorConfidence (const TessChoiceIterator *handle)

TESS_API ETEXT_DESC *	TessMonitorCreate ()

TESS_API void	TessMonitorDelete (ETEXT_DESC *monitor)

TESS_API void	TessMonitorSetCancelFunc (ETEXT_DESC *monitor, TessCancelFunc cancelFunc)

TESS_API void	TessMonitorSetCancelThis (ETEXT_DESC monitor, void cancelThis)

TESS_API void *	TessMonitorGetCancelThis (ETEXT_DESC *monitor)

TESS_API void	TessMonitorSetProgressFunc (ETEXT_DESC *monitor, TessProgressFunc progressFunc)

TESS_API int	TessMonitorGetProgress (ETEXT_DESC *monitor)

TESS_API void	TessMonitorSetDeadlineMSecs (ETEXT_DESC *monitor, int deadline)

Macro Definition Documentation

◆ BOOL

#define BOOL int

Definition at line 37 of file capi.h.

◆ FALSE

#define FALSE 0

Definition at line 39 of file capi.h.

◆ TRUE

#define TRUE 1

Definition at line 38 of file capi.h.

Typedef Documentation

◆ ETEXT_DESC

typedef struct ETEXT_DESC ETEXT_DESC

Definition at line 135 of file capi.h.

◆ TessBaseAPI

typedef struct TessBaseAPI TessBaseAPI

Definition at line 60 of file capi.h.

◆ TessCancelFunc

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

Definition at line 138 of file capi.h.

◆ TessChoiceIterator

typedef struct TessChoiceIterator TessChoiceIterator

Definition at line 64 of file capi.h.

◆ TessMutableIterator

typedef struct TessMutableIterator TessMutableIterator

Definition at line 63 of file capi.h.

◆ TessOcrEngineMode

typedef enum TessOcrEngineMode TessOcrEngineMode

◆ TessOrientation

typedef enum TessOrientation TessOrientation

◆ TessPageIterator

typedef struct TessPageIterator TessPageIterator

Definition at line 61 of file capi.h.

◆ TessPageIteratorLevel

typedef enum TessPageIteratorLevel TessPageIteratorLevel

◆ TessPageSegMode

typedef enum TessPageSegMode TessPageSegMode

◆ TessParagraphJustification

typedef enum TessParagraphJustification TessParagraphJustification

◆ TessPolyBlockType

typedef enum TessPolyBlockType TessPolyBlockType

◆ TessProgressFunc

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

Definition at line 139 of file capi.h.

◆ TessResultIterator

typedef struct TessResultIterator TessResultIterator

Definition at line 62 of file capi.h.

◆ TessResultRenderer

typedef struct TessResultRenderer TessResultRenderer

Definition at line 59 of file capi.h.

◆ TessTextlineOrder

typedef enum TessTextlineOrder TessTextlineOrder

◆ TessWritingDirection

typedef enum TessWritingDirection TessWritingDirection

Enumeration Type Documentation

◆ TessOcrEngineMode

enum TessOcrEngineMode

Enumerator
OEM_TESSERACT_ONLY
OEM_LSTM_ONLY
OEM_TESSERACT_LSTM_COMBINED
OEM_DEFAULT

Definition at line 65 of file capi.h.

                               {
  OEM_TESSERACT_ONLY,
  OEM_LSTM_ONLY,
  OEM_TESSERACT_LSTM_COMBINED,
  OEM_DEFAULT
} TessOcrEngineMode;

◆ TessOrientation

enum TessOrientation

Enumerator
ORIENTATION_PAGE_UP
ORIENTATION_PAGE_RIGHT
ORIENTATION_PAGE_DOWN
ORIENTATION_PAGE_LEFT

Definition at line 113 of file capi.h.

                             {
  ORIENTATION_PAGE_UP,
  ORIENTATION_PAGE_RIGHT,
  ORIENTATION_PAGE_DOWN,
  ORIENTATION_PAGE_LEFT
} TessOrientation;

◆ TessPageIteratorLevel

enum TessPageIteratorLevel

Enumerator
RIL_BLOCK
RIL_PARA
RIL_TEXTLINE
RIL_WORD
RIL_SYMBOL

Definition at line 88 of file capi.h.

                                   {
  RIL_BLOCK,
  RIL_PARA,
  RIL_TEXTLINE,
  RIL_WORD,
  RIL_SYMBOL
} TessPageIteratorLevel;

◆ TessPageSegMode

enum 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 71 of file capi.h.

                             {
  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
} TessPageSegMode;

◆ TessParagraphJustification

enum TessParagraphJustification

Enumerator
JUSTIFICATION_UNKNOWN
JUSTIFICATION_LEFT
JUSTIFICATION_CENTER
JUSTIFICATION_RIGHT

Definition at line 119 of file capi.h.

                                        {
  JUSTIFICATION_UNKNOWN,
  JUSTIFICATION_LEFT,
  JUSTIFICATION_CENTER,
  JUSTIFICATION_RIGHT
} TessParagraphJustification;

◆ TessPolyBlockType

enum 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 95 of file capi.h.

                               {
  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
} TessPolyBlockType;

◆ TessTextlineOrder

enum TessTextlineOrder

Enumerator
TEXTLINE_ORDER_LEFT_TO_RIGHT
TEXTLINE_ORDER_RIGHT_TO_LEFT
TEXTLINE_ORDER_TOP_TO_BOTTOM

Definition at line 130 of file capi.h.

                               {
  TEXTLINE_ORDER_LEFT_TO_RIGHT,
  TEXTLINE_ORDER_RIGHT_TO_LEFT,
  TEXTLINE_ORDER_TOP_TO_BOTTOM
} TessTextlineOrder;

◆ TessWritingDirection

enum TessWritingDirection

Enumerator
WRITING_DIRECTION_LEFT_TO_RIGHT
WRITING_DIRECTION_RIGHT_TO_LEFT
WRITING_DIRECTION_TOP_TO_BOTTOM

Definition at line 125 of file capi.h.

                                  {
  WRITING_DIRECTION_LEFT_TO_RIGHT,
  WRITING_DIRECTION_RIGHT_TO_LEFT,
  WRITING_DIRECTION_TOP_TO_BOTTOM
} TessWritingDirection;

Function Documentation

◆ TessAltoRendererCreate()

TESS_API TessResultRenderer * TessAltoRendererCreate ( const char * outputbase )

Definition at line 67 of file capi.cpp.

                                                                   {
  return new tesseract::TessAltoRenderer(outputbase);
}

◆ TessBaseAPIAdaptToWordStr()

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

Definition at line 456 of file capi.cpp.

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

◆ TessBaseAPIAllWordConfidences()

TESS_API int * TessBaseAPIAllWordConfidences ( TessBaseAPI * handle )

Definition at line 451 of file capi.cpp.

                                                        {
  return handle->AllWordConfidences();
}

◆ TessBaseAPIAnalyseLayout()

TESS_API TessPageIterator * TessBaseAPIAnalyseLayout ( TessBaseAPI * handle )

Definition at line 387 of file capi.cpp.

                                                                {
  return handle->AnalyseLayout();
}

◆ TessBaseAPIClear()

TESS_API void TessBaseAPIClear ( TessBaseAPI * handle )

Definition at line 461 of file capi.cpp.

                                           {
  handle->Clear();
}

◆ TessBaseAPIClearAdaptiveClassifier()

TESS_API void TessBaseAPIClearAdaptiveClassifier ( TessBaseAPI * handle )

Definition at line 304 of file capi.cpp.

                                                             {
  handle->ClearAdaptiveClassifier();
}

◆ TessBaseAPIClearPersistentCache()

TESS_API void TessBaseAPIClearPersistentCache ( TessBaseAPI * handle )

Definition at line 330 of file capi.cpp.

                                                      {
  TessBaseAPI::ClearPersistentCache();
}

◆ TessBaseAPICreate()

TESS_API TessBaseAPI * TessBaseAPICreate ( )

Definition at line 132 of file capi.cpp.

                                 {
  return new TessBaseAPI;
}

◆ TessBaseAPIDelete()

TESS_API void TessBaseAPIDelete ( TessBaseAPI * handle )

Definition at line 136 of file capi.cpp.

                                            {
  delete handle;
}

◆ TessBaseAPIDetectOrientationScript()

TESS_API BOOL TessBaseAPIDetectOrientationScript	(	TessBaseAPI *	handle,
		int *	orient_deg,
		float *	orient_conf,
		const char **	script_name,
		float *	script_conf
	)

Definition at line 336 of file capi.cpp.

                                                                                      {
  auto success = handle->DetectOrientationScript(orient_deg, orient_conf, script_name, script_conf);
  return static_cast<BOOL>(success);
}

◆ TessBaseAPIEnd()

TESS_API void TessBaseAPIEnd ( TessBaseAPI * handle )

Definition at line 465 of file capi.cpp.

                                         {
  handle->End();
}

◆ TessBaseAPIGetAltoText()

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

Definition at line 423 of file capi.cpp.

                                                                   {
  return handle->GetAltoText(page_number);
}

◆ TessBaseAPIGetAvailableLanguagesAsVector()

TESS_API char ** TessBaseAPIGetAvailableLanguagesAsVector ( const TessBaseAPI * handle )

Definition at line 271 of file capi.cpp.

                                                                           {
  std::vector<std::string> languages;
  handle->GetAvailableLanguagesAsVector(&languages);
  return MakeTextArray(languages);
}

◆ TessBaseAPIGetBoolVariable()

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

Definition at line 184 of file capi.cpp.

                                                                                          {
  bool boolValue;
  bool result = handle->GetBoolVariable(name, &boolValue);
  if (result) {
    *value = static_cast<int>(boolValue);
  }
  return static_cast<int>(result);
}

◆ TessBaseAPIGetBoxText()

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

Definition at line 431 of file capi.cpp.

                                                                  {
  return handle->GetBoxText(page_number);
}

◆ TessBaseAPIGetComponentImages()

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

Definition at line 370 of file capi.cpp.

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

◆ TessBaseAPIGetComponentImages1()

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

Definition at line 375 of file capi.cpp.

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

◆ TessBaseAPIGetConnectedComponents()

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

Definition at line 366 of file capi.cpp.

                                                                                      {
  return handle->GetConnectedComponents(cc);
}

◆ TessBaseAPIGetDatapath()

TESS_API const char * TessBaseAPIGetDatapath ( TessBaseAPI * handle )

Definition at line 164 of file capi.cpp.

                                                        {
  return handle->GetDatapath();
}

◆ TessBaseAPIGetDoubleVariable()

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

Definition at line 193 of file capi.cpp.

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

◆ TessBaseAPIGetHOCRText()

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

Definition at line 419 of file capi.cpp.

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

◆ TessBaseAPIGetInitLanguagesAsString()

TESS_API const char * TessBaseAPIGetInitLanguagesAsString ( const TessBaseAPI * handle )

Definition at line 261 of file capi.cpp.

                                                                           {
  return handle->GetInitLanguagesAsString();
}

◆ TessBaseAPIGetInputImage()

TESS_API struct Pix * TessBaseAPIGetInputImage ( TessBaseAPI * handle )

Definition at line 156 of file capi.cpp.

                                                   {
  return handle->GetInputImage();
}

◆ TessBaseAPIGetInputName()

TESS_API const char * TessBaseAPIGetInputName ( TessBaseAPI * handle )

Definition at line 148 of file capi.cpp.

                                                         {
  return handle->GetInputName();
}

◆ TessBaseAPIGetIntVariable()

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

Definition at line 180 of file capi.cpp.

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

◆ TessBaseAPIGetIterator()

TESS_API TessResultIterator * TessBaseAPIGetIterator ( TessBaseAPI * handle )

Definition at line 407 of file capi.cpp.

                                                                {
  return handle->GetIterator();
}

◆ TessBaseAPIGetLoadedLanguagesAsVector()

TESS_API char ** TessBaseAPIGetLoadedLanguagesAsVector ( const TessBaseAPI * handle )

Definition at line 265 of file capi.cpp.

                                                                        {
  std::vector<std::string> languages;
  handle->GetLoadedLanguagesAsVector(&languages);
  return MakeTextArray(languages);
}

◆ TessBaseAPIGetLSTMBoxText()

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

Definition at line 439 of file capi.cpp.

                                                                      {
  return handle->GetLSTMBoxText(page_number);
}

◆ TessBaseAPIGetMutableIterator()

TESS_API TessMutableIterator * TessBaseAPIGetMutableIterator ( TessBaseAPI * handle )

Definition at line 411 of file capi.cpp.

                                                                        {
  return handle->GetMutableIterator();
}

◆ TessBaseAPIGetOpenCLDevice()

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

Definition at line 140 of file capi.cpp.

                                                                  {
  return TessBaseAPI::getOpenCLDevice(device);
}

◆ TessBaseAPIGetPageSegMode()

TESS_API TessPageSegMode TessBaseAPIGetPageSegMode ( const TessBaseAPI * handle )

Definition at line 293 of file capi.cpp.

                                                                     {
  return handle->GetPageSegMode();
}

◆ TessBaseAPIGetRegions()

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

Definition at line 344 of file capi.cpp.

                                                                            {
  return handle->GetRegions(pixa);
}

◆ TessBaseAPIGetSourceYResolution()

TESS_API int TessBaseAPIGetSourceYResolution ( TessBaseAPI * handle )

Definition at line 160 of file capi.cpp.

                                                         {
  return handle->GetSourceYResolution();
}

◆ TessBaseAPIGetStringVariable()

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

Definition at line 197 of file capi.cpp.

                                                                                      {
  return handle->GetStringVariable(name);
}

◆ TessBaseAPIGetStrips()

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

Definition at line 358 of file capi.cpp.

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

◆ TessBaseAPIGetTextDirection()

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

Definition at line 473 of file capi.cpp.

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

◆ TessBaseAPIGetTextlines()

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

Definition at line 348 of file capi.cpp.

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

◆ TessBaseAPIGetTextlines1()

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

Definition at line 352 of file capi.cpp.

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

◆ TessBaseAPIGetThresholdedImage()

TESS_API struct Pix * TessBaseAPIGetThresholdedImage ( TessBaseAPI * handle )

Definition at line 326 of file capi.cpp.

                                                                {
  return handle->GetThresholdedImage();
}

◆ TessBaseAPIGetThresholdedImageScaleFactor()

TESS_API int TessBaseAPIGetThresholdedImageScaleFactor ( const TessBaseAPI * handle )

Definition at line 383 of file capi.cpp.

                                                                         {
  return handle->GetThresholdedImageScaleFactor();
}

◆ TessBaseAPIGetTsvText()

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

Definition at line 427 of file capi.cpp.

                                                                  {
  return handle->GetTSVText(page_number);
}

◆ TessBaseAPIGetUnichar()

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

Definition at line 477 of file capi.cpp.

                                                                       {
  return handle->GetUnichar(unichar_id);
}

◆ TessBaseAPIGetUNLVText()

TESS_API char * TessBaseAPIGetUNLVText ( TessBaseAPI * handle )

Definition at line 443 of file capi.cpp.

                                                  {
  return handle->GetUNLVText();
}

◆ TessBaseAPIGetUTF8Text()

TESS_API char * TessBaseAPIGetUTF8Text ( TessBaseAPI * handle )

Definition at line 415 of file capi.cpp.

                                                  {
  return handle->GetUTF8Text();
}

◆ TessBaseAPIGetWords()

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

Definition at line 362 of file capi.cpp.

                                                                          {
  return handle->GetWords(pixa);
}

◆ TessBaseAPIGetWordStrBoxText()

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

Definition at line 435 of file capi.cpp.

                                                                         {
  return handle->GetWordStrBoxText(page_number);
}

◆ TessBaseAPIInit1()

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

Definition at line 231 of file capi.cpp.

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

◆ TessBaseAPIInit2()

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

Definition at line 236 of file capi.cpp.

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

◆ TessBaseAPIInit3()

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

Definition at line 241 of file capi.cpp.

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

◆ TessBaseAPIInit4()

TESS_API int 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 215 of file capi.cpp.

                                                                                               {
  std::vector<std::string> varNames;
  std::vector<std::string> varValues;
  if (vars_vec != nullptr && vars_values != nullptr) {
    for (size_t i = 0; i < vars_vec_size; i++) {
      varNames.emplace_back(vars_vec[i]);
      varValues.emplace_back(vars_values[i]);
    }
  }
 
  return handle->Init(datapath, language, mode, configs, configs_size, &varNames, &varValues,
                      set_only_non_debug_params != 0);
}

◆ TessBaseAPIInit5()

TESS_API int TessBaseAPIInit5	(	TessBaseAPI *	handle,
		const char *	data,
		int	data_size,
		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 245 of file capi.cpp.

                                                                                               {
  std::vector<std::string> varNames;
  std::vector<std::string> varValues;
  if (vars_vec != nullptr && vars_values != nullptr) {
    for (size_t i = 0; i < vars_vec_size; i++) {
      varNames.emplace_back(vars_vec[i]);
      varValues.emplace_back(vars_values[i]);
    }
  }
 
  return handle->Init(data, data_size, language, mode, configs, configs_size, &varNames, &varValues,
                      set_only_non_debug_params != 0, nullptr);
}

◆ TessBaseAPIInitForAnalysePage()

TESS_API void TessBaseAPIInitForAnalysePage ( TessBaseAPI * handle )

Definition at line 277 of file capi.cpp.

                                                        {
  handle->InitForAnalysePage();
}

◆ TessBaseAPIIsValidWord()

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

Definition at line 469 of file capi.cpp.

                                                                  {
  return handle->IsValidWord(word);
}

◆ TessBaseAPIMeanTextConf()

TESS_API int TessBaseAPIMeanTextConf ( TessBaseAPI * handle )

Definition at line 447 of file capi.cpp.

                                                 {
  return handle->MeanTextConf();
}

◆ TessBaseAPINumDawgs()

TESS_API int TessBaseAPINumDawgs ( const TessBaseAPI * handle )

Definition at line 485 of file capi.cpp.

                                                   {
  return handle->NumDawgs();
}

◆ TessBaseAPIOem()

TESS_API TessOcrEngineMode TessBaseAPIOem ( const TessBaseAPI * handle )

Definition at line 489 of file capi.cpp.

                                                            {
  return handle->oem();
}

◆ TessBaseAPIPrintVariables()

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

Definition at line 201 of file capi.cpp.

                                                                    {
  handle->PrintVariables(fp);
}

◆ TessBaseAPIPrintVariablesToFile()

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

Definition at line 205 of file capi.cpp.

                                                                                      {
  FILE *fp = fopen(filename, "w");
  if (fp != nullptr) {
    handle->PrintVariables(fp);
    fclose(fp);
    return TRUE;
  }
  return FALSE;
}

◆ TessBaseAPIProcessPage()

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

Definition at line 400 of file capi.cpp.

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

◆ TessBaseAPIProcessPages()

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

Definition at line 395 of file capi.cpp.

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

◆ TessBaseAPIReadConfigFile()

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

Definition at line 281 of file capi.cpp.

                                                                          {
  handle->ReadConfigFile(filename);
}

◆ TessBaseAPIReadDebugConfigFile()

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

Definition at line 285 of file capi.cpp.

                                                                               {
  handle->ReadDebugConfigFile(filename);
}

◆ TessBaseAPIRecognize()

TESS_API int TessBaseAPIRecognize	(	TessBaseAPI *	handle,
		ETEXT_DESC *	monitor
	)

Definition at line 391 of file capi.cpp.

                                                                   {
  return handle->Recognize(monitor);
}

◆ TessBaseAPIRect()

TESS_API char * 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 297 of file capi.cpp.

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

◆ TessBaseAPISetDebugVariable()

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

Definition at line 176 of file capi.cpp.

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

◆ TessBaseAPISetImage()

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

Definition at line 309 of file capi.cpp.

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

◆ TessBaseAPISetImage2()

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

Definition at line 314 of file capi.cpp.

                                                                {
  return handle->SetImage(pix);
}

◆ TessBaseAPISetInputImage()

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

Definition at line 152 of file capi.cpp.

                                                             {
  handle->SetInputImage(pix);
}

◆ TessBaseAPISetInputName()

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

Definition at line 144 of file capi.cpp.

                                                                    {
  handle->SetInputName(name);
}

◆ TessBaseAPISetMinOrientationMargin()

TESS_API void TessBaseAPISetMinOrientationMargin	(	TessBaseAPI *	handle,
		double	margin
	)

Definition at line 481 of file capi.cpp.

                                                                            {
  handle->set_min_orientation_margin(margin);
}

◆ TessBaseAPISetOutputName()

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

Definition at line 168 of file capi.cpp.

                                                                     {
  handle->SetOutputName(name);
}

◆ TessBaseAPISetPageSegMode()

TESS_API void TessBaseAPISetPageSegMode	(	TessBaseAPI *	handle,
		TessPageSegMode	mode
	)

Definition at line 289 of file capi.cpp.

                                                                          {
  handle->SetPageSegMode(mode);
}

◆ TessBaseAPISetRectangle()

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

Definition at line 322 of file capi.cpp.

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

◆ TessBaseAPISetSourceResolution()

TESS_API void TessBaseAPISetSourceResolution	(	TessBaseAPI *	handle,
		int	ppi
	)

Definition at line 318 of file capi.cpp.

                                                                  {
  handle->SetSourceResolution(ppi);
}

◆ TessBaseAPISetVariable()

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

Definition at line 172 of file capi.cpp.

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

◆ TessBaseGetBlockTextOrientations()

TESS_API void TessBaseGetBlockTextOrientations	(	TessBaseAPI *	handle,
		int **	block_orientation,
		bool **	vertical_writing
	)

Definition at line 493 of file capi.cpp.

                                                               {
  handle->GetBlockTextOrientations(block_orientation, vertical_writing);
}

◆ TessBoxTextRendererCreate()

TESS_API TessResultRenderer * TessBoxTextRendererCreate ( const char * outputbase )

Definition at line 84 of file capi.cpp.

                                                                      {
  return new tesseract::TessBoxTextRenderer(outputbase);
}

◆ TessChoiceIteratorConfidence()

TESS_API float TessChoiceIteratorConfidence ( const TessChoiceIterator * handle )

Definition at line 669 of file capi.cpp.

                                                                     {
  return handle->Confidence();
}

◆ TessChoiceIteratorDelete()

TESS_API void TessChoiceIteratorDelete ( TessChoiceIterator * handle )

Definition at line 657 of file capi.cpp.

                                                          {
  delete handle;
}

◆ TessChoiceIteratorGetUTF8Text()

TESS_API const char * TessChoiceIteratorGetUTF8Text ( const TessChoiceIterator * handle )

Definition at line 665 of file capi.cpp.

                                                                            {
  return handle->GetUTF8Text();
}

◆ TessChoiceIteratorNext()

TESS_API BOOL TessChoiceIteratorNext ( TessChoiceIterator * handle )

Definition at line 661 of file capi.cpp.

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

◆ TessDeleteIntArray()

TESS_API void TessDeleteIntArray ( const int * arr )

Definition at line 51 of file capi.cpp.

                                        {
  delete[] arr;
}

◆ TessDeleteResultRenderer()

TESS_API void TessDeleteResultRenderer ( TessResultRenderer * renderer )

Definition at line 96 of file capi.cpp.

                                                            {
  delete renderer;
}

◆ TessDeleteText()

TESS_API void TessDeleteText ( const char * text )

Definition at line 31 of file capi.cpp.

                                      {
  delete[] text;
}

◆ TessDeleteTextArray()

TESS_API void TessDeleteTextArray ( char ** arr )

Definition at line 44 of file capi.cpp.

                                     {
  for (char **pos = arr; *pos != nullptr; ++pos) {
    delete[] * pos;
  }
  delete[] arr;
}

◆ TessHOcrRendererCreate()

TESS_API TessResultRenderer * TessHOcrRendererCreate ( const char * outputbase )

Definition at line 59 of file capi.cpp.

                                                                   {
  return new tesseract::TessHOcrRenderer(outputbase);
}

◆ TessHOcrRendererCreate2()

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

Definition at line 63 of file capi.cpp.

                                                                                    {
  return new tesseract::TessHOcrRenderer(outputbase, font_info != 0);
}

◆ TessLSTMBoxRendererCreate()

TESS_API TessResultRenderer * TessLSTMBoxRendererCreate ( const char * outputbase )

Definition at line 92 of file capi.cpp.

                                                                      {
  return new tesseract::TessLSTMBoxRenderer(outputbase);
}

◆ TessMonitorCreate()

TESS_API ETEXT_DESC * TessMonitorCreate ( )

Definition at line 673 of file capi.cpp.

                                {
  return new ETEXT_DESC();
}

◆ TessMonitorDelete()

TESS_API void TessMonitorDelete ( ETEXT_DESC * monitor )

Definition at line 677 of file capi.cpp.

                                            {
  delete monitor;
}

◆ TessMonitorGetCancelThis()

TESS_API void * TessMonitorGetCancelThis ( ETEXT_DESC * monitor )

Definition at line 689 of file capi.cpp.

                                                    {
  return monitor->cancel_this;
}

◆ TessMonitorGetProgress()

TESS_API int TessMonitorGetProgress ( ETEXT_DESC * monitor )

Definition at line 697 of file capi.cpp.

                                                {
  return monitor->progress;
}

◆ TessMonitorSetCancelFunc()

TESS_API void TessMonitorSetCancelFunc	(	ETEXT_DESC *	monitor,
		TessCancelFunc	cancelFunc
	)

Definition at line 681 of file capi.cpp.

                                                                              {
  monitor->cancel = cancelFunc;
}

◆ TessMonitorSetCancelThis()

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

Definition at line 685 of file capi.cpp.

                                                                     {
  monitor->cancel_this = cancelThis;
}

◆ TessMonitorSetDeadlineMSecs()

TESS_API void TessMonitorSetDeadlineMSecs	(	ETEXT_DESC *	monitor,
		int	deadline
	)

Definition at line 701 of file capi.cpp.

                                                                    {
  monitor->set_deadline_msecs(deadline);
}

◆ TessMonitorSetProgressFunc()

TESS_API void TessMonitorSetProgressFunc	(	ETEXT_DESC *	monitor,
		TessProgressFunc	progressFunc
	)

Definition at line 693 of file capi.cpp.

                                                                                    {
  monitor->progress_callback2 = progressFunc;
}

◆ TessPageIteratorBaseline()

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

Definition at line 542 of file capi.cpp.

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

◆ TessPageIteratorBegin()

TESS_API void TessPageIteratorBegin ( TessPageIterator * handle )

Definition at line 506 of file capi.cpp.

                                                     {
  handle->Begin();
}

◆ TessPageIteratorBlockType()

TESS_API TessPolyBlockType TessPageIteratorBlockType ( const TessPageIterator * handle )

Definition at line 528 of file capi.cpp.

                                                                            {
  return handle->BlockType();
}

◆ TessPageIteratorBoundingBox()

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

Definition at line 523 of file capi.cpp.

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

◆ TessPageIteratorCopy()

TESS_API TessPageIterator * TessPageIteratorCopy ( const TessPageIterator * handle )

Definition at line 502 of file capi.cpp.

                                                                       {
  return new TessPageIterator(*handle);
}

◆ TessPageIteratorDelete()

TESS_API void TessPageIteratorDelete ( TessPageIterator * handle )

Definition at line 498 of file capi.cpp.

                                                      {
  delete handle;
}

◆ TessPageIteratorGetBinaryImage()

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

Definition at line 532 of file capi.cpp.

                                                                        {
  return handle->GetBinaryImage(level);
}

◆ TessPageIteratorGetImage()

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

Definition at line 537 of file capi.cpp.

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

◆ TessPageIteratorIsAtBeginningOf()

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

Definition at line 514 of file capi.cpp.

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

◆ TessPageIteratorIsAtFinalElement()

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

Definition at line 518 of file capi.cpp.

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

◆ TessPageIteratorNext()

TESS_API BOOL TessPageIteratorNext	(	TessPageIterator *	handle,
		TessPageIteratorLevel	level
	)

Definition at line 510 of file capi.cpp.

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

◆ TessPageIteratorOrientation()

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

Definition at line 547 of file capi.cpp.

                                                                                         {
  handle->Orientation(orientation, writing_direction, textline_order, deskew_angle);
}

◆ TessPageIteratorParagraphInfo()

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

Definition at line 553 of file capi.cpp.

                                                                           {
  bool bool_is_list_item;
  bool bool_is_crown;
  handle->ParagraphInfo(justification, &bool_is_list_item, &bool_is_crown, first_line_indent);
  if (is_list_item != nullptr) {
    *is_list_item = static_cast<int>(bool_is_list_item);
  }
  if (is_crown != nullptr) {
    *is_crown = static_cast<int>(bool_is_crown);
  }
}

◆ TessPDFRendererCreate()

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

Definition at line 75 of file capi.cpp.

                                                         {
  return new tesseract::TessPDFRenderer(outputbase, datadir, textonly != 0);
}

◆ TessResultIteratorConfidence()

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

Definition at line 595 of file capi.cpp.

                                                                                                  {
  return handle->Confidence(level);
}

◆ TessResultIteratorCopy()

TESS_API TessResultIterator * TessResultIteratorCopy ( const TessResultIterator * handle )

Definition at line 571 of file capi.cpp.

                                                                             {
  return new TessResultIterator(*handle);
}

◆ TessResultIteratorDelete()

TESS_API void TessResultIteratorDelete ( TessResultIterator * handle )

Definition at line 567 of file capi.cpp.

                                                          {
  delete handle;
}

◆ TessResultIteratorGetChoiceIterator()

TESS_API TessChoiceIterator * TessResultIteratorGetChoiceIterator ( const TessResultIterator * handle )

Definition at line 583 of file capi.cpp.

                                                                                          {
  return new TessChoiceIterator(*handle);
}

◆ TessResultIteratorGetPageIterator()

TESS_API TessPageIterator * TessResultIteratorGetPageIterator ( TessResultIterator * handle )

Definition at line 575 of file capi.cpp.

                                                                                {
  return handle;
}

◆ TessResultIteratorGetPageIteratorConst()

TESS_API const TessPageIterator * TessResultIteratorGetPageIteratorConst ( const TessResultIterator * handle )

Definition at line 579 of file capi.cpp.

                                                                                                 {
  return handle;
}

◆ TessResultIteratorGetUTF8Text()

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

Definition at line 591 of file capi.cpp.

                                                                                                   {
  return handle->GetUTF8Text(level);
}

◆ TessResultIteratorNext()

TESS_API BOOL TessResultIteratorNext	(	TessResultIterator *	handle,
		TessPageIteratorLevel	level
	)

Definition at line 587 of file capi.cpp.

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

◆ TessResultIteratorSymbolIsDropcap()

TESS_API BOOL TessResultIteratorSymbolIsDropcap ( const TessResultIterator * handle )

Definition at line 653 of file capi.cpp.

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

◆ TessResultIteratorSymbolIsSubscript()

TESS_API BOOL TessResultIteratorSymbolIsSubscript ( const TessResultIterator * handle )

Definition at line 649 of file capi.cpp.

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

◆ TessResultIteratorSymbolIsSuperscript()

TESS_API BOOL TessResultIteratorSymbolIsSuperscript ( const TessResultIterator * handle )

Definition at line 645 of file capi.cpp.

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

◆ TessResultIteratorWordFontAttributes()

TESS_API const char * 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 603 of file capi.cpp.

                                                                                                   {
  bool bool_is_bold;
  bool bool_is_italic;
  bool bool_is_underlined;
  bool bool_is_monospace;
  bool bool_is_serif;
  bool bool_is_smallcaps;
  const char *ret = handle->WordFontAttributes(&bool_is_bold, &bool_is_italic, &bool_is_underlined,
                                               &bool_is_monospace, &bool_is_serif,
                                               &bool_is_smallcaps, pointsize, font_id);
  if (is_bold != nullptr) {
    *is_bold = static_cast<int>(bool_is_bold);
  }
  if (is_italic != nullptr) {
    *is_italic = static_cast<int>(bool_is_italic);
  }
  if (is_underlined != nullptr) {
    *is_underlined = static_cast<int>(bool_is_underlined);
  }
  if (is_monospace != nullptr) {
    *is_monospace = static_cast<int>(bool_is_monospace);
  }
  if (is_serif != nullptr) {
    *is_serif = static_cast<int>(bool_is_serif);
  }
  if (is_smallcaps != nullptr) {
    *is_smallcaps = static_cast<int>(bool_is_smallcaps);
  }
  return ret;
}

◆ TessResultIteratorWordIsFromDictionary()

TESS_API BOOL TessResultIteratorWordIsFromDictionary ( const TessResultIterator * handle )

Definition at line 637 of file capi.cpp.

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

◆ TessResultIteratorWordIsNumeric()

TESS_API BOOL TessResultIteratorWordIsNumeric ( const TessResultIterator * handle )

Definition at line 641 of file capi.cpp.

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

◆ TessResultIteratorWordRecognitionLanguage()

TESS_API const char * TessResultIteratorWordRecognitionLanguage ( const TessResultIterator * handle )

Definition at line 599 of file capi.cpp.

                                                                                        {
  return handle->WordRecognitionLanguage();
}

◆ TessResultRendererAddImage()

TESS_API BOOL TessResultRendererAddImage	(	TessResultRenderer *	renderer,
		TessBaseAPI *	api
	)

Definition at line 112 of file capi.cpp.

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

◆ TessResultRendererBeginDocument()

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

Definition at line 108 of file capi.cpp.

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

◆ TessResultRendererEndDocument()

TESS_API BOOL TessResultRendererEndDocument ( TessResultRenderer * renderer )

Definition at line 116 of file capi.cpp.

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

◆ TessResultRendererExtention()

TESS_API const char * TessResultRendererExtention ( TessResultRenderer * renderer )

Definition at line 120 of file capi.cpp.

                                                                      {
  return renderer->file_extension();
}

◆ TessResultRendererImageNum()

TESS_API int TessResultRendererImageNum ( TessResultRenderer * renderer )

Definition at line 128 of file capi.cpp.

                                                             {
  return renderer->imagenum();
}

◆ TessResultRendererInsert()

TESS_API void TessResultRendererInsert	(	TessResultRenderer *	renderer,
		TessResultRenderer *	next
	)

Definition at line 100 of file capi.cpp.

                                                                                      {
  renderer->insert(next);
}

◆ TessResultRendererNext()

TESS_API TessResultRenderer * TessResultRendererNext ( TessResultRenderer * renderer )

Definition at line 104 of file capi.cpp.

                                                                         {
  return renderer->next();
}

◆ TessResultRendererTitle()

TESS_API const char * TessResultRendererTitle ( TessResultRenderer * renderer )

Definition at line 124 of file capi.cpp.

                                                                  {
  return renderer->title();
}

◆ TessTextRendererCreate()

TESS_API TessResultRenderer * TessTextRendererCreate ( const char * outputbase )

Definition at line 55 of file capi.cpp.

                                                                   {
  return new tesseract::TessTextRenderer(outputbase);
}

◆ TessTsvRendererCreate()

TESS_API TessResultRenderer * TessTsvRendererCreate ( const char * outputbase )

Definition at line 71 of file capi.cpp.

                                                                  {
  return new tesseract::TessTsvRenderer(outputbase);
}

◆ TessUnlvRendererCreate()

TESS_API TessResultRenderer * TessUnlvRendererCreate ( const char * outputbase )

Definition at line 80 of file capi.cpp.

                                                                   {
  return new tesseract::TessUnlvRenderer(outputbase);
}

◆ TessVersion()

TESS_API const char * TessVersion ( )

Definition at line 20 of file capi.cpp.

                          {
  return TessBaseAPI::Version();
}

◆ TessWordStrBoxRendererCreate()

TESS_API TessResultRenderer * TessWordStrBoxRendererCreate ( const char * outputbase )

Definition at line 88 of file capi.cpp.

                                                                         {
  return new tesseract::TessWordStrBoxRenderer(outputbase);
}

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

◆ BOOL

◆ FALSE

◆ TRUE

Typedef Documentation

◆ ETEXT_DESC

◆ TessBaseAPI

◆ TessCancelFunc

◆ TessChoiceIterator

◆ TessMutableIterator

◆ TessOcrEngineMode

◆ TessOrientation

◆ TessPageIterator

◆ TessPageIteratorLevel

◆ TessPageSegMode

◆ TessParagraphJustification

◆ TessPolyBlockType

◆ TessProgressFunc

◆ TessResultIterator

◆ TessResultRenderer

◆ TessTextlineOrder

◆ TessWritingDirection

Enumeration Type Documentation

◆ TessOcrEngineMode

◆ TessOrientation

◆ TessPageIteratorLevel

◆ TessPageSegMode

◆ TessParagraphJustification

◆ TessPolyBlockType

◆ TessTextlineOrder

◆ TessWritingDirection

Function Documentation

◆ TessAltoRendererCreate()

◆ TessBaseAPIAdaptToWordStr()

◆ TessBaseAPIAllWordConfidences()

◆ TessBaseAPIAnalyseLayout()

◆ TessBaseAPIClear()

◆ TessBaseAPIClearAdaptiveClassifier()

◆ TessBaseAPIClearPersistentCache()

◆ TessBaseAPICreate()

◆ TessBaseAPIDelete()

◆ TessBaseAPIDetectOrientationScript()

◆ TessBaseAPIEnd()

◆ TessBaseAPIGetAltoText()

◆ TessBaseAPIGetAvailableLanguagesAsVector()

◆ TessBaseAPIGetBoolVariable()

◆ TessBaseAPIGetBoxText()

◆ TessBaseAPIGetComponentImages()

◆ TessBaseAPIGetComponentImages1()

◆ TessBaseAPIGetConnectedComponents()

◆ TessBaseAPIGetDatapath()

◆ TessBaseAPIGetDoubleVariable()

◆ TessBaseAPIGetHOCRText()

◆ TessBaseAPIGetInitLanguagesAsString()

◆ TessBaseAPIGetInputImage()

◆ TessBaseAPIGetInputName()

◆ TessBaseAPIGetIntVariable()

◆ TessBaseAPIGetIterator()

◆ TessBaseAPIGetLoadedLanguagesAsVector()

◆ TessBaseAPIGetLSTMBoxText()

◆ TessBaseAPIGetMutableIterator()

◆ TessBaseAPIGetOpenCLDevice()

◆ TessBaseAPIGetPageSegMode()

◆ TessBaseAPIGetRegions()

◆ TessBaseAPIGetSourceYResolution()

◆ TessBaseAPIGetStringVariable()

◆ TessBaseAPIGetStrips()

◆ TessBaseAPIGetTextDirection()

◆ TessBaseAPIGetTextlines()

◆ TessBaseAPIGetTextlines1()

◆ TessBaseAPIGetThresholdedImage()

◆ TessBaseAPIGetThresholdedImageScaleFactor()

◆ TessBaseAPIGetTsvText()

◆ TessBaseAPIGetUnichar()

◆ TessBaseAPIGetUNLVText()

◆ TessBaseAPIGetUTF8Text()