hci_ocr.h

#ifndef __HCI_OCR_HEADER__ 
#define __HCI_OCR_HEADER__

#include "hci_sys.h"

#ifdef __OBJC__
#include <UIKit/UIImage.h>
#endif

#ifdef __cplusplus
extern "C"              
{
#endif

/* @{ */

    /* @{ */
    
    #define OCR_MODULE    "HCI_OCR"



#pragma pack (push, ocr_api)
#pragma pack (8) 

        typedef struct OCR_IMAGE_T
        {
                _MUST_ _IN_ int nWidth;         
                _MUST_ _IN_ int nHeight;                

                _MUST_ _IN_ int nBitsPerPixel;
                _MUST_ _IN_ unsigned char ** pLines;

                _OPT_ _IN_ int xResolution;     
                _OPT_ _IN_ int yResolution;     
        }OCR_IMAGE;

#pragma pack (pop, ocr_api)

#define CANDIDATE_NUM           5
        
typedef enum _tag_OCR_RECOG_RGNTYPE
{
        OCR_RECOG_RGNTYPE_HORZTEXT = 0,         
        OCR_RECOG_RGNTYPE_VERTTEXT = 1,         
        OCR_RECOG_RGNTYPE_TABLE = 2,            
        OCR_RECOG_RGNTYPE_GRAPH = 3,            
        OCR_RECOG_RGNTYPE_AUTOTEXT = 4,         
}
OCR_RECOG_RGNTYPE;

typedef enum _tag_OCR_RECOG_LANG
{
        //iRead6.0_Text6.0.1.1997  此版本去掉缺省配置
        //OCR_RECOG_LANG_DEFAULT = 0,           ///< 缺省语言，由识别配置串决定
        OCR_RECOG_LANG_ZH_CN = 1,               
        OCR_RECOG_LANG_ZH_HK = 2,               
        OCR_RECOG_LANG_ZH_TW = 3,               
        OCR_RECOG_LANG_EN = 4                   
}
OCR_RECOG_LANG;

typedef enum _tag_OCR_TABLE_LINE_TYPE
{
        LINE_TYPE_UNKNOWN = 0,                          
        LINE_TYPE_REAL,                                         
        LINE_TYPE_DASHED,                                       
        LINE_TYPE_DOTTED,                                       
        LINE_TYPE_VIRTUAL,                                      
        LINE_TYPE_EMPTY         = 0x100,                
}
OCR_TABLE_LINE_TYPE;

typedef enum _tag_OCR_RECOG_NODE_TYPE
{
        OCR_RECOG_NODE_PAGE     = 0,            
        OCR_RECOG_NODE_REGION,                  
        OCR_RECOG_NODE_CELL,                    
        OCR_RECOG_NODE_LINE,                    
        OCR_RECOG_NODE_CHAR,                    
}
OCR_RECOG_NODE_TYPE;

// 数据结构定义

typedef struct _tag_OCR_RECOG_POINT
{
        int x;                  
        int y;                  
}
OCR_RECOG_POINT;

typedef struct _tag_OCR_CORNERS_RESULT
{
        OCR_RECOG_POINT leftTop;                
        OCR_RECOG_POINT rightTop;               
        OCR_RECOG_POINT leftBottom;             
        OCR_RECOG_POINT rightBottom;    
        int     angle;                                          
}
OCR_CORNERS_RESULT;

typedef struct _tag_OCR_RECOG_RECT
{
        int left;               
        int top;                
        int right;              
        int bottom;             
}
OCR_RECOG_RECT;

//----------------------------------------------------------------------------
// 版面相关信息定义

typedef struct _tag_OCR_RECOG_LINESEGMENT 
{
        int nStartX;

        int nStartY;

        int nEndX;

        int nEndY;

        int nThickness;

        OCR_TABLE_LINE_TYPE nType;
} 
OCR_RECOG_LINESEGMENT;

typedef struct _tag_OCR_RECOG_FRAMELINE
{ 
        OCR_RECOG_LINESEGMENT * pSegment;    //对应的表格线小段的第一段的指针

        int nSegmentCount;
} 
OCR_RECOG_FRAMELINE;

typedef struct _tag_OCR_RECOG_TABLECELL 
{
        OCR_RECOG_POINT LT;

        OCR_RECOG_POINT LB;

        OCR_RECOG_POINT RT;

        OCR_RECOG_POINT RB;

        int nCellNo;    
} 
OCR_RECOG_TABLECELL;

typedef struct _tag_OCR_RECOG_TABLE 
{
        OCR_RECOG_FRAMELINE  *HLines;   

        int nHLine;

        OCR_RECOG_FRAMELINE  *VLines;

        int nVLine;

        OCR_RECOG_TABLECELL  *pCell;            

        int nCellNoCount;
}
OCR_RECOG_TABLE;

typedef struct _tag_OCR_RECOG_REGION
{
        OCR_RECOG_RECT  rcBound;        

        OCR_RECOG_RGNTYPE       wRegionType;

        OCR_RECOG_LANG  wRecogLang;
        
        OCR_RECOG_TABLE  * pTable;              
}
OCR_RECOG_REGION;

typedef struct _tag_OCR_RECOG_LAYOUT_RESULT
{
        OCR_RECOG_REGION  * pRegionList;

        int    nRegionCount;
}
OCR_LAYOUT_RESULT;


typedef struct _tag_OCR_RECOG_DESKEW_RESULT
{
        int nSkewAngle;
}
OCR_DESKEW_RESULT;


//----------------------------------------------------------------------------
// 文档结果定义

typedef struct _tag_OCR_RECOG_PAGENODE
{
        int nWidth;

        int nHeight;

        int nSkewAngle;
}
OCR_RECOG_PAGENODE;

typedef struct _tag_OCR_RECOG_REGIONNODE
{
        OCR_RECOG_RECT  rcBound;

        unsigned short  wRegionType;    

        unsigned short  wRecogLang;             
}
OCR_RECOG_REGIONNODE;

typedef struct _tag_OCR_RECOG_CELLNODE
{
        OCR_RECOG_RECT  rcCellBound;    
}
OCR_RECOG_CELLNODE;

typedef struct _tag_OCR_RECOG_LINENODE
{
        int     nBaseLine;
        
        int nLineSize;
        
        int xChar;

        int yChar;
}
OCR_RECOG_LINENODE;

typedef struct _tag_OCR_RECOG_CHARNODE
{   
        char * pszChar;

        char * pszCandidateWords[CANDIDATE_NUM];

        int     nSpaceBefore;

        bool bAccept;

        OCR_RECOG_RECT  rcBlock;
}
OCR_RECOG_CHARNODE;

typedef struct _tag_OCR_RECOG_NODE
{
        OCR_RECOG_NODE_TYPE     wType;                          

        union 
        {
                OCR_RECOG_PAGENODE              nodePage;
                OCR_RECOG_REGIONNODE    nodeRegion;
                OCR_RECOG_CELLNODE              nodeCell;
                OCR_RECOG_LINENODE              nodeLine;
                OCR_RECOG_CHARNODE              nodeChar;
        };
} 
OCR_RECOG_NODE;

typedef struct _tag_OCR_RECOG_RESULT
{
        char *  pTextBuf;                       

        OCR_RECOG_NODE * pNodes;                                

        int             nNodeCount;

        char *  pExportFileBuf;
        int     nExportFileBufLen;      

}
OCR_RECOG_RESULT;

/* @} */
/* @{ */

HCI_ERR_CODE HCIAPI hci_ocr_init(
                _MUST_ _IN_ const char * pszConfig
                );

HCI_ERR_CODE HCIAPI hci_ocr_session_start(
                _MUST_ _IN_ const char * pszConfig,
                _MUST_ _OUT_ int *pnSessionId
                );

HCI_ERR_CODE HCIAPI hci_ocr_deskew(
                _MUST_ _IN_ int nSessionId,
                _OPT_ _IN_ const char * pszConfig,      
                _MUST_ _OUT_ OCR_DESKEW_RESULT * psOcrDeskewResult
                );

HCI_ERR_CODE HCIAPI hci_ocr_free_deskew_result(
                _MUST_ _IN_ OCR_DESKEW_RESULT * psOcrDeskewResult
                );

HCI_ERR_CODE HCIAPI hci_ocr_layout_analysis(
                _MUST_ _IN_ int nSessionId,
                _OPT_ _IN_ const char * pszConfig,      
                _MUST_ _OUT_ OCR_LAYOUT_RESULT * psOcrLayoutResult
                );

HCI_ERR_CODE HCIAPI hci_ocr_free_layout_result(
                _MUST_ _IN_ OCR_LAYOUT_RESULT * psOcrLayoutResult
                );

HCI_ERR_CODE HCIAPI hci_ocr_recog(
                _MUST_ _IN_ int nSessionId,     
                _OPT_ _IN_ const char * pszConfig,                      
                _OPT_ _IN_ const OCR_RECOG_REGION * pRegions, 
                _OPT_ _IN_ unsigned int nRegionCount,
                _MUST_ _OUT_ OCR_RECOG_RESULT * psOcrRecogResult
                );

HCI_ERR_CODE HCIAPI hci_ocr_free_recog_result(
                _MUST_ _IN_ OCR_RECOG_RESULT * psOcrRecogResult
                );

HCI_ERR_CODE HCIAPI hci_ocr_session_stop(
                _MUST_ _IN_ int nSessionId
                );

HCI_ERR_CODE HCIAPI hci_ocr_release();

HCI_ERR_CODE HCIAPI hci_ocr_set_image_buffer(
                _MUST_ _IN_ int nSessionId ,
                _MUST_ _IN_ unsigned char * pImageData, 
                _MUST_ _IN_ unsigned int uiImageDataSize
                );

HCI_ERR_CODE HCIAPI hci_ocr_set_image_file(
                _MUST_ _IN_ int nSessionId ,
                _MUST_ _IN_ const char * pszImageFileName
                );


HCI_ERR_CODE HCIAPI hci_ocr_get_image( 
                        _MUST_ _IN_ int nSessionId,
                        _MUST_ _OUT_ OCR_IMAGE* pImage
                         );

HCI_ERR_CODE HCIAPI hci_ocr_save_image_file( 
                        _MUST_ _IN_ const char * pszImageFileName,
                        _MUST_ _IN_ OCR_IMAGE * pImage
                        );

HCI_ERR_CODE HCIAPI hci_ocr_load_template(
                        _MUST_ _IN_ const char * pszConfig,
                        _MUST_ _IN_ const char *pszTemplateFile, 
                        _MUST_ _OUT_ int *pnTemplateID
                        );




HCI_ERR_CODE HCIAPI hci_ocr_unload_template(
                        _MUST_ _IN_ int nTemplateID
                        );

#define  FMT_I420                                                                                       0                        //YV21
#define  FMT_YV12                                                                                       1
#define  FMT_NV21                                                                                       2                       //当前仅支持NV21格式
#define  FMT_NV12                                                                                       3

HCI_ERR_CODE HCIAPI hci_ocr_set_image_buffer_ex(
                        _MUST_ _IN_ int nSessionId,
                        _MUST_ _IN_ unsigned char * pImageData, 
                        _MUST_ _IN_ unsigned int imageType,
                        _MUST_ _IN_ unsigned int width,
                        _MUST_ _IN_ unsigned int height
                        );


#ifdef __OBJC__

HCI_ERR_CODE HCIAPI hci_ocr_set_image_by_uiImage( 
                _MUST_ _IN_ int nSessionID,
                _MUST_ _IN_ UIImage * image
                );


HCI_ERR_CODE HCIAPI hci_ocr_get_uiImage( 
                _MUST_ _IN_ int nSessionID,
                _MUST_ _OUT_ UIImage ** image
                );

#endif

/* @} */

/* @} */

#ifdef __cplusplus
};
#endif


#endif