hci_ocr_capture.h

#ifndef __HCI_OCR_CAPTURE_HEADER__
#define __HCI_OCR_CAPTURE_HEADER__

#include "hci_sys.h"
#include "hci_ocr.h"

#ifdef __cplusplus
extern "C"
{
#endif
    
    /* @{ */
    
    /* @{ */
    
    #define MODULE_NAME    "HCI_OCR_CAPTURE"

    typedef enum
    {
        CAPTURE_EVENT_CAPTURE_BEGIN,            
        CAPTURE_EVENT_CAPTURE_FINISH,           
        CAPTURE_EVENT_RECOGNIZE_BEGIN,          
        CAPTURE_EVENT_RECOGNIZE_MORE,           
        CAPTURE_EVENT_RECOGNIZE_FINISH,         
        CAPTURE_EVENT_RECOGNIZE_COMPLETE,       
        CAPTURE_EVENT_ENGINE_ERROR,                     
        CAPTURE_EVENT_DEVICE_ERROR,                     
        CAPTURE_EVENT_MALLOC_ERROR,                     
        CAPTURE_EVENT_PREVIEW_BEGIN,        
        CAPTURE_EVENT_PREVIEW_DETECT_CORNER_POINTS_SUCCESS,  
        CAPTURE_EVENT_PREVIEW_DETECT_CAN_BE_RECOGNIZE_SUCCESS,  
        CAPTURE_EVENT_FOCUS_BEGIN,          
        CAPTURE_EVENT_FOCUS_SUCCESS,        
        CAPTURE_EVENT_FOCUS_FAIL,           
        CAPTURE_EVENT_CAPTURE_DETECT_CORNER_POINTS_SUCCESS,    
        CAPTURE_EVENT_CAPTURE_DETECT_CORNER_POINTS_FAIL,       
    } CAPTURE_EVENT;
    
    typedef enum
    {
        CAPTURE_ERR_UNKNOWN = -1,                                       
        CAPTURE_ERR_NONE = 0,                                           
        CAPTURE_ERR_ALREADY_INITED,                 
        CAPTURE_ERR_NOT_INITED,                     
        CAPTURE_ERR_ENGINE_INIT,                                        
        CAPTURE_ERR_DEVICE_INIT,                                        
        CAPTURE_ERR_CAPTURE,                        
        CAPTURE_ERR_LOAD_TEMPLATE,                  
        CAPTURE_ERR_UNLOAD_TEMPLATE,                
        CAPTURE_ERR_SESSION_START,                  
        CAPTURE_ERR_RECOGNIZE,                      
        CAPTURE_ERR_LOAD_IMAGE,                     
        CAPTURE_ERR_UNSUPPORT,                      
        CAPTURE_ERR_RELEASE,                        
        CAPTURE_ERR_BUSY,                           
        CAPTURE_ERR_CAPTUREONE,                     
        CAPTURE_ERR_PARAM_INVALID,                  
        CAPTURE_ERR_OUT_OF_MEMORY,                  
    } CAPTURE_ERR_CODE;
    
    typedef void (HCIAPI * Callback_CaptureEventStateChange)(
                                                             _MUST_ _IN_ CAPTURE_EVENT eCaptureEvent,
                                                             _OPT_ _IN_ void * pUsrParam );
    
    typedef void (HCIAPI * Callback_CaptureCapturing)(
                                                      _MUST_ _IN_ void * pszImageData,
                                                      _MUST_ _IN_ unsigned int uiImageLen,
                                                      _MUST_ _IN_ bool bHasConers,
                                                      _OPT_ _IN_ OCR_CORNERS_RESULT *pCornersResult,
                                                      _OPT_ _IN_ void * pUsrParam);
    
    typedef void (HCIAPI * Callback_CaptureEventRecogFinish)(
                                                             _MUST_ _IN_ CAPTURE_EVENT eCaptureEvent,
                                                             _MUST_ _IN_ OCR_RECOG_RESULT *pRecogResult,
                                                             _OPT_ _IN_ void * pUsrParam );
    
    typedef void (HCIAPI * Callback_CaptureEventError)(
                                                       _MUST_ _IN_ CAPTURE_EVENT eCaptureEvent,
                                                       _MUST_ _IN_ int eErrorCode,
                                                       _OPT_ _IN_ void * pUsrParam );

    typedef struct _CAPTURE_CALLBACK_PARAM {
        Callback_CaptureEventStateChange pfnStateChange;        
        void * pvStateChangeUsrParam;                           
        Callback_CaptureCapturing pfnCapturing;                 
        void * pvCapturingUsrParam;                             
        Callback_CaptureEventRecogFinish pfnRecogFinish;        
        void * pvRecogFinishUsrParam;                           
        Callback_CaptureEventError pfnError;                    
        void *pvErrorUsrParam;                                  
    } CAPTURE_CALLBACK_PARAM;

    /* @} */

    /* @{ */
    
    CAPTURE_ERR_CODE HCIAPI hci_ocr_capture_init(
                                                 _MUST_ _IN_ const char * pszOCRSdkConfig,
                                                 _MUST_ _IN_ CAPTURE_CALLBACK_PARAM *psCallbackParam);
    
    CAPTURE_ERR_CODE HCIAPI hci_ocr_capture_load_template(
                                                          _OPT_ _IN_ const char * pszConfig,
                                                          _MUST_ _IN_ const char * pszTemplateFile,
                                                          _MUST_ _OUT_ int * pnTemplateId
                                                          );
    
    CAPTURE_ERR_CODE HCIAPI hci_ocr_capture_unload_template(
                                                            _MUST_ _IN_  int nTemplateId
                                                            );
    
    CAPTURE_ERR_CODE HCIAPI hci_ocr_capture_start(
                                                  _MUST_ _IN_ const char * pszConfig);
    
    CAPTURE_ERR_CODE HCIAPI hci_ocr_capture_get_preview(void * preview);
    
    CAPTURE_ERR_CODE HCIAPI hci_ocr_capture_stop_and_recog();
    
    CAPTURE_ERR_CODE HCIAPI hci_ocr_capture_stop();
    
    CAPTURE_ERR_CODE HCIAPI hci_ocr_capture_recog(
                                                  _MUST_ _IN_ const char * pszConfig,
                                                  _MUST_ _IN_ unsigned char * pImageData,
                                                  _MUST_ _IN_ unsigned int uiImageLen);
    
    CAPTURE_ERR_CODE HCIAPI hci_ocr_capture_release();

    /* @} */
    /* @} */
    
#ifdef __cplusplus
}
#endif

#endif