RecognizerRunner.h

Go to the documentation of this file.

 
#ifndef RECOGNIZER_RUNNER_H_
#define RECOGNIZER_RUNNER_H_
 
#include "Export.h"
#include "Recognizer.h"
#include "RecognizerError.h"
#include "RecognizerImage.h"
#include "Rectangle.h"
#include "Types.h"
 
#include <stdlib.h>
 
#ifdef __cplusplus
extern "C"
{
#endif
 
struct MBRecognizerRunner;
 
MB_EXPORTED_TYPE typedef struct MBRecognizerRunner MBRecognizerRunner;
 
struct MBRecognizerRunnerSettings;
 
typedef MB_EXPORTED_TYPE struct MBRecognizerRunnerSettings MBRecognizerRunnerSettings;
 
MB_API void MB_CALL recognizerRunnerSettingsDefaultInit( MBRecognizerRunnerSettings * );
 
struct MBRecognizerRunnerSettings
{
    MBBool allowMultipleResults;
 
    MBRecognizerPtr const * recognizers;
 
    size_t numOfRecognizers;
 
#ifdef __cplusplus
    MBRecognizerRunnerSettings()
    {
        recognizerRunnerSettingsDefaultInit( this );
    }
#endif
};
 
struct MBPoint
{
    int x;
    int y;
};
 
typedef MB_EXPORTED_TYPE struct MBPoint MBPoint;
 
struct MBSize
{
    int width;
    int height;
};
 
typedef MB_EXPORTED_TYPE struct MBSize MBSize;
 
enum MBDetectionStatus
{
    DETECTION_STATUS_SUCCESS,
    DETECTION_STATUS_FAIL,
    DETECTION_STATUS_CAMERA_TOO_HIGH,
    DETECTION_STATUS_PARTIAL_OBJECT,
    DETECTION_STATUS_CAMERA_AT_ANGLE,
    DETECTION_STATUS_CAMERA_TOO_NEAR,
    DETECTION_STATUS_DOCUMENT_TOO_CLOSE_TO_EDGE
};
 
typedef MB_EXPORTED_TYPE enum MBDetectionStatus MBDetectionStatus;
 
enum MBShowImageType
{
    SHOW_IMAGE_TYPE_ORIGINAL,
    SHOW_IMAGE_TYPE_DEWARPED,
    SHOW_IMAGE_TYPE_SUCCESSFUL_SCAN
};
 
typedef MB_EXPORTED_TYPE enum MBShowImageType MBShowImageType;
 
struct MBRecognitionCallback;
 
typedef MB_EXPORTED_TYPE struct MBRecognitionCallback MBRecognitionCallback;
 
MB_API void MB_CALL recognitionCallbackDefaultInit( MBRecognitionCallback * );
 
struct MBRecognitionCallback
{
 
    void (*onDetectionStarted)();
 
    void (*onDetectionMidway)( MBPoint const * points, size_t pointsSize );
 
    MBBool (*onDetectedObject)( MBPoint const * points, size_t pointsSize, MBDetectionStatus detectionStatus );
 
    void (*onDetectionFailed)();
 
    void (*onRecognitionStarted)();
 
    void (*onRecognitionFinished)();
 
    void (*onShowImage)( MBRecognizerImage const * image, MBShowImageType showType, char const * name );
 
    void (*onFirstSideResult)();
 
    void (*onGlare)( MBBool hasGlare );
 
#ifdef __cplusplus
    MBRecognitionCallback()
    {
        recognitionCallbackDefaultInit( this );
    }
#endif
};
 
MB_API MBRecognizerErrorStatus MB_CALL recognizerRunnerCreate( MBRecognizerRunner ** recognizerRunner, MBRecognizerRunnerSettings const * settings );
 
MB_API MBRecognizerErrorStatus MB_CALL recognizerRunnerUpdateSettings( MBRecognizerRunner * recognizerRunner, MBRecognizerRunnerSettings const * settings );
 
MB_API MBRecognizerErrorStatus MB_CALL recognizerRunnerDelete( MBRecognizerRunner ** recognizerRunner );
 
MB_API MBRecognizerErrorStatus MB_CALL recognizerRunnerSetROI( MBRecognizerRunner * recognizerRunner, MBRectangle const * regionOfInterest );
 
MB_API MBRecognizerResultState MB_CALL recognizerRunnerRecognizeFromImage
(
    MBRecognizerRunner          * recognizerRunner,
    MBRecognizerImage     const * image,
    MBBool                        imageIsVideoFrame,
    MBRecognitionCallback const * callback
);
 
 
MB_API MBRecognizerResultState MB_CALL recognizerRunnerRecognizeFromString
(
    MBRecognizerRunner          * recognizerRunner,
    char                  const * string,
    MBRecognitionCallback const * callback
);
 
 
MB_API MBRecognizerErrorStatus MB_CALL recognizerRunnerCancelCurrentRecognition( MBRecognizerRunner * recognizerRunner );
 
MB_API MBRecognizerErrorStatus MB_CALL recognizerRunnerReset( MBRecognizerRunner * recognizerRunner );
 
#ifdef __cplusplus
}
#endif
 
#endif