|
Defines for conditions |
| Used to construct the vvxtr_state bitstring.
- State is a bit string corresponding to a bitwise OR of all conditions.
- Used in vvEngAPI::vvGetCond function.
|
|
#define | C_READY 0x400 |
| | ready
|
|
#define | C_OCRSESOPEN 0x200 |
| | OCR session is open.
|
|
#define | C_OUTDOCOPEN 0x100 |
| | output document is open
|
|
#define | C_FILEOPEN 0x080 |
| | input image is open
|
|
#define | C_IMAGELOADED 0x040 |
| | input page is open
|
|
#define | C_PREPROCDONE 0x020 |
| | preprocessing has been run on the current page
|
|
#define | C_RECOGDONE 0x010 |
| | recognition has been run on the current page
|
|
#define | C_DOCREADY 0x008 |
| | output document is ready for aquisition
|
|
#define | C_SUBIMAGEREADY 0x004 |
| | output subimage is ready for aquisition
|
|
#define | C_ENGINEBUSY 0x002 |
| | engine is currently busy
|
|
#define | C_ERROR 0x001 |
| | error
|
Defines for Error codes |
These codes are returned as a vvxtrStatus value when there is an error.
|
| #define | VVXTR_KILL_PROCESS -1000 |
| | Time for the daemon to die.
|
|
#define | VVXTR_PREVIOUS_ERROR -1001 |
| | Requesting information on the last error.
|
|
#define | VVXTR_ERR -1 |
| | General error.
|
| enum | vvxtrErrorCodes {
VVXTR_ERR_INVALID_SYNTAX = 1001,
VVXTR_ERR_NO_INPUT,
VVXTR_ERR_INVALID_STATE,
VVXTR_ERR_INITINSTANCE_FAILURE,
VVXTR_ERR_ENDINSTANCE_FAILURE,
VVXTR_ERR_NO_INPUT_FILE_SPECIFIED,
VVXTR_ERR_UNABLE_TO_LOAD_IMAGE_FILE,
VVXTR_ERR_IMG_ACQ_FAILED,
VVXTR_ERR_START_SESSION_FAILED,
VVXTR_ERR_RECOGNITION_FAILED,
VVXTR_ERR_OPEN_CHAR_SET_FAILURE,
VVXTR_ERR_INVALID_SHAPE_PACK_PATH,
VVXTR_ERR_BAD_LANGUAGE,
VVXTR_ERR_OPENING_LANG_PACK,
VVXTR_ERR_LOAD_LANG_FAILED,
VVXTR_ERR_CREATE_LANG_GROUP,
VVXTR_ERR_LANG_NOT_LICENSED,
VVXTR_ERR_SET_DEF_LEX_CONSTRAINTS,
VVXTR_ERR_WRITE_OUTPUT_FAILED,
VVXTR_ERR_OPENING_OUTPUT_FILE,
VVXTR_ERR_REGION_ECLIPSED,
VVXTR_ERR_COULD_NOT_CONVERT_DEPTH,
VVXTR_ERR_GETTING_IMG_REGION,
VVXTR_ERR_END_SESSION_FAILED,
VVXTR_ERR_OUTPUT_INV_REGION,
VVXTR_ERR_NOT_IMPLEMENTED,
VVXTR_ERR_INV_PDF_FORMAT,
VVXTR_ERR_PDF_IMG_OUTPUT,
VVXTR_ERR_PDF_END_OUTPUT,
VVXTR_ERR_UNABLE_TO_WRITE_PDF,
VVXTR_ERR_HOST_LOOKUP_FAILED,
VVXTR_ERR_CONNECTION_FAILED,
VVXTR_ERR_TRANSFER_FAILED,
VVXTR_ERR_NO_SUBIMAGE,
VVXTR_ERR_PP_FAILED,
VVXTR_ERR_SET_OPTIONS_FAILED,
VVXTR_ERR_REMOVE_FILE_FAILED,
VVXTR_ERR_NO_DOC,
VVXTR_ERR_INV_SUBIMG_FORMAT,
VVXTR_ERR_SYNCHRONIZATION,
VVXTR_ERR_NOENGINE,
VVXTR_ERR_BUFFER_TOO_SMALL,
VVXTR_ERR_INVALID_PAGE,
VVXTR_ERR_MISSING_LANG,
VVXTR_ERR_ENG_OUT_OF_MEMORY,
VVXTR_ERR_INVALID_UOR_COUNT,
VVXTR_ERR_INVALID_UOR_STRING,
VVXTR_ERR_READONLY_VALUE,
VVXTR_ERR_INVALID_REGION_ID,
VVXTR_ERR_SET_REGION_UNSUCCESSFUL,
VVXTR_ERR_REGION_HANDLER,
VVXTR_ERR_ENGINE_KILLED,
VVXTR_ERR_NO_LICENSE,
VVXTR_ERR_NO_LICENSE_MANAGER,
VVXTR_ERR_LICENSE_COMM_ERROR,
VVXTR_ERR_NO_FEATURE
} |
| | Time for the daemon to die. More...
|
Defines |
|
#define | VVXTRDEFS_H 1 |
|
#define | VV_DEBUG 1 |
| | To turn on debug messages.
|
|
#define | tablemacro(key, value, type, kernelFunc, defaultUsed, defaultVal, kernelVal, write) dm_##key, |
Typedefs |
|
typedef enum vvxtr_dataType | VVXTR_DATATYPE |
| | Generic XTR datatype.
|
| typedef signed long int | vvxtr_state |
| | Representation of the state as a bit-string.
|
|
typedef signed long int | vvxtr_cond |
| | Representation of a single condition in the state bit-string.
|
|
typedef signed long int | vvxtrStatus |
| | Representation of the engine status.
|
|
typedef void * | vvxtr_stdarg |
| | A generic argument in the XTR API.
|
Enumerations |
| enum | vvxtr_dataType { vvxtr_none = 0,
vvxtr_int,
vvxtr_string,
vvxtr_pib,
vvxtr_ptr
} |
| | Generic XTR datatype. More...
|
| enum | vvxtrResponseEnum { vvNo = 0,
vvYes = 1,
vvAuto = 2,
vvDetect = 3,
vvCorrect = 4,
vvManual = 5
} |
| | Generic settings used for many different options. More...
|
| enum | vvxtrOutTextFormatEnum {
vvTextFormatDefault = -1,
vvTextFormatNone = 0,
vvTextFormatXdoc = 1,
vvTextFormatXdoclite = 3,
vvTextFormatXdocplus = 4,
vvTextFormatPost = 13,
vvTextFormatIso = 102,
vvTextFormatPdf = 104,
vvTextFormat8bit = 105,
vvTextFormatUnicode = 106,
vvTextFormatHtmlWysiwygP = 107,
vvTextFormatHtmlWysiwygS = 108,
vvTextFormatHtmlTable = 109,
vvTextFormatHtmlSimple = 110
} |
| | Output text formats. More...
|
| enum | vvxtrOutGraphicsFormatEnum {
vvSubimageFormatNone = -1,
vvSubimageFormatTiff = 0,
vvSubimageFormatRas = 1,
vvSubimageFormatEpsf = 2,
vvSubimageFormatX11 = 3,
vvSubimageFormatTiffpack = 4,
vvSubimageFormatTiffg31d = 5,
vvSubimageFormatTiffg32d = 6,
vvSubimageFormatTiffg42d = 7,
vvSubimageFormatTifflzw = 8,
vvSubimageFormatPaltiff = 31,
vvSubimageFormatGif = 17,
vvSubimageFormatJpeg = 19,
vvSubimageFormatPng = 21,
vvSubimageFormatXwd = 22,
vvSubimageFormatRgb = 23,
vvSubimageFormatRgbrle = 24,
vvSubimageFormatEPdf = 28,
vvSubimageFormatVvxtrImage = 30
} |
| | Output graphics formats. More...
|
| enum | vvxtrFocusAreaEnum { vvFocusAreaPage = 0,
vvFocusAreaRegion = 1
} |
| | How to specify the document area on which to focus. More...
|
| enum | vvxtrVerifierModeEnum { vvVerifierModeWord = 1,
vvVerifierModeChar = 0
} |
| | Verifier mode. More...
|
| enum | vvxtrRecModeEnum { vvRecModeUnspecified = 1,
vvRecModeStandard = 2,
vvRecModeDegraded = 3
} |
| | Recognition mode. More...
|
| enum | vvxtrTextOutNewlineEnum { vvTextOutNewlineUnix = 1,
vvTextOutNewlineMac = 2,
vvTextOutNewlinePC = 3
} |
| | Newline designation. More...
|
| enum | vvxtrPDFFormatEnum { vvPDFFormatNormal = 1,
vvPDFFormatText = 2,
vvPDFFormatImgOnly = 3
} |
| | PDF format. More...
|
| enum | vvxtrRegionTypeEnum {
vvRegionTypeAny = 3511,
vvRegionTypeIgnore = 3512,
vvRegionTypeText = 3513,
vvRegionTypeImage = 3514,
vvRegionTypeVrule = 3515,
vvRegionTypeHrule = 3516,
vvRegionTypeHidden = 3517,
vvRegionTypeRevid = 3518,
vvRegionTypeHiddenimage = 3519
} |
| | Region types. More...
|
| enum | vvxtrRegionSubtypeEnum {
vvRegionSubtypeUnflavored = 0,
vvRegionSubtypeTable = 1,
vvRegionSubtypeTable_inset = 2,
vvRegionSubtypeHeadline = 3,
vvRegionSubtypeTimestamp = 4,
vvRegionSubtypeLineart = 5,
vvRegionSubtypeHalftone = 6,
vvRegionSubtypeInset = 7,
vvRegionSubtypeCaption = 8,
vvRegionSubtypePage_footer = 9,
vvRegionSubtypePage_header = 10,
vvRegionSubtypeVruling = 11,
vvRegionSubtypeHruling = 12,
vvRegionSubtypeNoise = 13,
vvRegionSubtypeIpcorePictureMask = 14
} |
| | Region subtypes. More...
|
| enum | vvxtrRegionGrammarModeEnum { vvRegGrammarModeWord = 0,
vvRegGrammarModeLine = 1
} |
| | Region grammar modes. More...
|
| enum | vvxtrRegionLexmodeEnum { vvRegionLexmodeNolex = 0,
vvRegionLexmodePreference = 1,
vvRegionLexmodeAbsolute = 2
} |
| | Region lexical mode. More...
|
| enum | vvxtrRegionForegroundEnum { vvRegionForegroundBlack = 0,
vvRegionForegroundWhite = 1,
vvRegionForegroundUnknown = 2
} |
| | Region foreground specification. More...
|
| enum | vvxtrRegionOpacityEnum { vvRegionOpacityOpaque = 0,
vvRegionOpacityTransparent = 1
} |
| | Region opacity. More...
|
| enum | vvxtrRegionAbutmentEnum { vvRegionAbutmentUnknown = -1,
vvRegionAbutmentNone = 0,
vvRegionAbutmentLeft = 1,
vvRegionAbutmentRight = 2,
vvRegionAbutmentLeftAndRight = 3
} |
| | Region abutment. More...
|
| enum | vvxtrLexicalConstraintModeEnum { vvLexConstraintModeReplace = 0,
vvLexConstraintModeAdd = 1
} |
| | Lexical constraint mode. More...
|
| enum | vvxtrDisplayAlignmentEnum { vvAlign8 = 8,
vvAlign16 = 16,
vvAlign32 = 32,
vvAlign64 = 64
} |
| | Bit alignment of display. More...
|
| enum | vvxtrVersionLocationEnum { vvLocal = 0,
vvRemote = 1
} |
| | Version location. More...
|
| enum | vvxtrImageSpecificationEnum { vvInputImage = 0,
vvProcessedImage = 1
} |
| | Specify the original or processed image. More...
|
| enum | vvInternalEngineState {
vvS_NONE = 0x00000000,
vvS_IDLE = 0x00000001,
vvS_SESSION = 0x00000002,
vvS_CANCEL = 0x00000004,
vvS_PGCAN = 0x00000008,
vvS_ACQUISITION_READY = 0x00000010,
vvS_ACQUIRING = 0x00000020,
vvS_RECOGNITION_READY = 0x00000040,
vvS_RECOGNIZING = 0x00000080,
vvS_PREPROCESS = 0x00000100,
vvS_TEXT_OUTPUT = 0x00000200,
vvS_REGION_MAPPING = 0x00000400,
vvS_SHAPES_LOADED = 0x00000800,
vvS_AWAITING_DRAW = 0x00001000,
vvS_AWAITING_VERIFIER = 0x00002000,
vvS_PATTERN_LOADED = 0x00008000,
vvS_BUFFER_FULL = 0x00010000,
vvS_UNUSED_2 = 0x00020000,
vvS_UNUSED_3 = 0x00040000,
vvS_XDOC_LOADED = 0x00080000,
vvS_PAGE_ANALYZED = 0x00200000,
vvS_ANALYZING_PAGE = 0x00400000,
vvS_PAGE_LAID_OUT = 0x00800000,
vvS_CHARSET_TABLE_LOADED = 0x02000000,
vvS_ANY = 0x00ffffff,
vvS_ERROR = 0x01000000,
vvS_BLOCKED = (vvS_AWAITING_DRAW | vvS_AWAITING_VERIFIER),
vvS_READY = (vvS_ACQUISITION_READY | vvS_RECOGNITION_READY),
vvS_RECOGNITION = (vvS_RECOGNITION_READY | vvS_RECOGNIZING),
vvS_ACQUISITION = (vvS_ACQUISITION_READY | vvS_ACQUIRING),
vvS_PROCESSING = (vvS_ACQUIRING | vvS_PREPROCESS | vvS_RECOGNIZING | vvS_REGION_MAPPING | vvS_TEXT_OUTPUT )
} |
| | The internal engine state bit field values. More...
|
| enum | vvxtrHint { vvHintLocalFilesystem,
vvNumberOfHints
} |
| | Hints to improve engine performance. More...
|
| enum | vvxtrEngineVariables {
dm_min_point,
dm_max_point,
dm_accept_thresh,
dm_quest_thresh,
dm_recmode,
dm_recomp,
dm_no_sloppy_manual,
dm_no_hdr_ftr,
dm_user_specified_order,
dm_user_specified_regions,
dm_find_headlines,
dm_text_out_newline,
dm_xdc_wconf,
dm_xdc_cconf,
dm_xdc_wbox,
dm_xdc_cbox,
dm_xdc_wbox_pixels,
dm_metric,
dm_pdf_format,
dm_pdf_imgthresh,
dm_pdf_img_nodict,
dm_pdf_img_alphanum,
dm_ls_quote,
dm_rs_quote,
dm_ld_quote,
dm_rd_quote,
dm_document_name,
dm_questionable,
dm_unrecognized,
dm_force_single_col,
dm_one_line_table_cells,
dm_improved_single_col_detect,
dm_region_type,
dm_region_subtype,
dm_region_stacking,
dm_region_grammar_mode,
dm_region_lexical_constraint_id,
dm_region_lexmode,
dm_region_foreground,
dm_region_out_order,
dm_region_name,
dm_region_frame_left,
dm_region_frame_right,
dm_region_frame_top,
dm_region_frame_bot,
dm_region_uor_string,
dm_region_uor_count,
dm_black_threshold,
dm_in_xres,
dm_in_yres,
dm_language,
dm_english_chars,
dm_char_set,
dm_word_lexicon_id,
dm_format_analysis,
dm_double_dimension,
dm_current_region,
dm_focus_area,
dm_pp_remove_halftone,
dm_pp_auto_segment,
dm_pp_rotate,
dm_pp_fax_filter,
dm_pp_auto_orient,
dm_pp_invert,
dm_pp_newspaper_filter,
dm_pp_deskew,
dm_pp_photometric_interp,
dm_pp_dotmatrix_filter,
dm_pp_autosetdegrade,
dm_pp_recognition,
dm_pp_segment_lineart,
dm_pp_reverse_video,
dm_pp_analyze_layout,
dm_auto_flip,
dm_in_filename,
dm_in_curr_page,
dm_in_num_pages,
dm_in_format,
dm_region_ids,
dm_region_ids_text,
dm_region_ids_image,
dm_out_text_format,
dm_out_graphics_format,
dm_doc_memory_size,
dm_subimage_memory_size,
dm_coord_space,
dm_output_img_source,
dm_recognize_timeout,
dm_preprocess_timeout,
VVXTR_ENGINE_VARIABLE_COUNT
} |
| | Data values. More...
|
1.3.2