vvxtrDefs.h

Go to the documentation of this file.

#ifndef VVXTRDEFS_H
#define VVXTRDEFS_H 1

#include <vvutil/vvError.h>
#include <vvutil/vvLog.h>
#include <vvutil/vvConstants.h>

#include <vvlicense/vvLicenseClient.h>


#define VV_DEBUG 1

typedef enum vvxtr_dataType {
    vvxtr_none=0,   
    vvxtr_int,      
    vvxtr_string,   
    vvxtr_pib,      
    vvxtr_ptr       
} VVXTR_DATATYPE;


typedef signed long int vvxtr_state;

typedef signed long int vvxtr_cond;

typedef signed long int vvxtrStatus;

typedef void * vvxtr_stdarg;


enum vvxtrResponseEnum {
    vvNo        = 0,    
    vvYes       = 1,    
    vvAuto      = 2,    
    vvDetect    = 3,    
    vvCorrect   = 4,    
    vvManual    = 5     
};

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

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


enum vvxtrFocusAreaEnum {
    vvFocusAreaPage     = 0,    
    vvFocusAreaRegion   = 1     
};

enum vvxtrVerifierModeEnum {
    vvVerifierModeWord  = 1,    
    vvVerifierModeChar  = 0     
};

enum vvxtrRecModeEnum {
    vvRecModeUnspecified    = 1,    
    vvRecModeStandard       = 2,    
    vvRecModeDegraded       = 3     
};

enum vvxtrTextOutNewlineEnum {
    vvTextOutNewlineUnix    = 1,    
    vvTextOutNewlineMac     = 2,    
    vvTextOutNewlinePC      = 3     
};

enum vvxtrPDFFormatEnum {
    vvPDFFormatNormal   = 1,    
    vvPDFFormatText     = 2,    
    vvPDFFormatImgOnly  = 3     
};

enum vvxtrRegionTypeEnum {
    vvRegionTypeAny         = 3511,     
    vvRegionTypeIgnore      = 3512,     
    vvRegionTypeText        = 3513,     
    vvRegionTypeImage       = 3514,     
    vvRegionTypeVrule       = 3515,     
    vvRegionTypeHrule       = 3516,     
    vvRegionTypeHidden      = 3517,     
    vvRegionTypeRevid       = 3518,     
    vvRegionTypeHiddenimage = 3519      
};

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

enum vvxtrRegionGrammarModeEnum {
    vvRegGrammarModeWord    = 0,    
    vvRegGrammarModeLine    = 1     
};

enum vvxtrRegionLexmodeEnum {
    vvRegionLexmodeNolex        = 0,    
    vvRegionLexmodePreference   = 1,    
    vvRegionLexmodeAbsolute     = 2     
};


enum vvxtrRegionForegroundEnum {
    vvRegionForegroundBlack     = 0,    
    vvRegionForegroundWhite     = 1,    
    vvRegionForegroundUnknown   = 2     
};

enum vvxtrRegionOpacityEnum {
    vvRegionOpacityOpaque       = 0,    
    vvRegionOpacityTransparent  = 1     
};

enum vvxtrRegionAbutmentEnum {
    vvRegionAbutmentUnknown         = -1,   
    vvRegionAbutmentNone            = 0,    
    vvRegionAbutmentLeft            = 1,    
    vvRegionAbutmentRight           = 2,    
    vvRegionAbutmentLeftAndRight    = 3     
};

enum vvxtrLexicalConstraintModeEnum {
    vvLexConstraintModeReplace = 0, 
    vvLexConstraintModeAdd = 1      
};

enum vvxtrDisplayAlignmentEnum {
  vvAlign8  = 8,    
  vvAlign16 = 16,   
  vvAlign32 = 32,   
  vvAlign64 = 64    
};

enum vvxtrVersionLocationEnum {
  vvLocal = 0,      
  vvRemote = 1      
};

enum vvxtrImageSpecificationEnum {
    vvInputImage        = 0,    
    vvProcessedImage    = 1     
};
#ifndef DOXYGEN
/*
 * When dm_coord_space is implemented, add:
 *
 * Used with ::dm_coord_space and ::dm_output_img_source.
 */
#endif

#define C_READY         0x400   
#define C_OCRSESOPEN    0x200   
#define C_OUTDOCOPEN    0x100   
#define C_FILEOPEN      0x080   
#define C_IMAGELOADED   0x040   
#define C_PREPROCDONE   0x020   
#define C_RECOGDONE     0x010   
#define C_DOCREADY      0x008   
#define C_SUBIMAGEREADY 0x004   
#define C_ENGINEBUSY    0x002   
#define C_ERROR         0x001   


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 ) 
};


#define VVXTR_KILL_PROCESS                  -1000   
#define VVXTR_PREVIOUS_ERROR                -1001   
#define VVXTR_ERR                   -1  
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 =
            VVLIC_ERR_NO_LICENSE,           
    VVXTR_ERR_NO_LICENSE_MANAGER = 
            VVLIC_ERR_NO_LICENSE_MANAGER,   
    VVXTR_ERR_LICENSE_COMM_ERROR = 
            VVLIC_ERR_COMMUNICATION,        
    VVXTR_ERR_NO_FEATURE=
            VVLIC_ERR_NO_FEATURE,           
};

enum vvxtrHint
{
    vvHintLocalFilesystem,                  
    vvNumberOfHints
};


#undef tablemacro
#define tablemacro(key, value, type, kernelFunc, defaultUsed, defaultVal, kernelVal, write) \
    dm_##key,

enum vvxtrEngineVariables {
#include "vvocr/dataTable.table"
    VVXTR_ENGINE_VARIABLE_COUNT
};

#ifndef DOXYGEN

#undef statustable
#define statustable(psKey, handler, addlKey) psKey,

enum vvxtrEngineStatus
{
#include "vvocr/statusTable.table"
    VVXTR_ENGINE_STATUS_COUNT           /* use as list length */
};

#undef actiontable
#define actiontable( key, action ) \
    dm_##key, 
    
enum vvxtrActions
{
#include "vvocr/actions.table"
    VVXTR_ACTION_COUNT          /* use as list length */
};


#undef commandtable
#define commandtable( command, func, type ) \
    vvxtrCommand_##command, 
    
enum vvxtrCommands
{
#include "vvocr/commandKey.table"
    VVXTR_COMMAND_COUNT         /* use as list length */
};
#endif

#endif

---