ScRecognitionContext.h

Go to the documentation of this file.

#ifndef SC_RECOGNITION_CONTEXT_H_
#define SC_RECOGNITION_CONTEXT_H_

#include <Scandit/ScConfig.h>
#include <Scandit/ScCommon.h>
#include "Scandit/ScByteArray.h"
#include <Scandit/ScImageDescription.h>

#if SC_PLATFORM_ANDROID
#    include <jni.h>
#endif

SC_EXTERN_C_BEGIN

typedef struct ScOpaqueRecognitionContext ScRecognitionContext;

typedef enum {
    SC_RECOGNITION_CONTEXT_STATUS_UNKNOWN = 0,
    SC_RECOGNITION_CONTEXT_STATUS_SUCCESS = 1,
    SC_RECOGNITION_CONTEXT_STATUS_INTERNAL_ERROR = 2,
    SC_RECOGNITION_CONTEXT_STATUS_FRAME_SEQUENCE_NOT_STARTED = 3,
    SC_RECOGNITION_CONTEXT_STATUS_UNSUPPORTED_IMAGE_DATA = 4,
    SC_RECOGNITION_CONTEXT_STATUS_INCONSISTENT_IMAGE_DATA = 5,
    SC_RECOGNITION_CONTEXT_STATUS_NO_NETWORK_CONNECTION = 6,
    SC_RECOGNITION_CONTEXT_STATUS_LICENSE_VALIDATION_FAILED_403 = 11,
    SC_RECOGNITION_CONTEXT_STATUS_LICENSE_KEY_MISSING = 12,
    SC_RECOGNITION_CONTEXT_STATUS_LICENSE_KEY_EXPIRED = 13,
    SC_RECOGNITION_CONTEXT_STATUS_INVALID_PLATFORM = 14,
    SC_RECOGNITION_CONTEXT_STATUS_INVALID_APP_ID = 15,
    SC_RECOGNITION_CONTEXT_STATUS_INVALID_DEVICE = 16,
    SC_RECOGNITION_CONTEXT_STATUS_INVALID_SDK_VERSION = 17,
    SC_RECOGNITION_CONTEXT_STATUS_LICENSE_KEY_INVALID = 18,
    SC_RECOGNITION_CONTEXT_STATUS_DEVICE_ACTIVATION_FAILED = 19,
    SC_RECOGNITION_CONTEXT_STATUS_TIME_EXCEEDED = 20,
    SC_RECOGNITION_CONTEXT_STATUS_SCANS_EXCEEDED = 21,
    SC_RECOGNITION_CONTEXT_STATUS_REGISTRATION_MANDATORY_BUT_NOT_REGISTERED = 22,
    SC_RECOGNITION_CONTEXT_STATUS_INVALID_EXTERNAL_ID = 23,
    SC_RECOGNITION_CONTEXT_STATUS_UNLICENSED_SYMBOLOGY_ENABLED = 24,
    SC_RECOGNITION_CONTEXT_STATUS_INVALID_LICENSE_KEY_VERSION = 26,
    SC_RECOGNITION_CONTEXT_STATUS_UNLICENSED_SYMBOLOGY_EXTENSION_ENABLED = 27,
    SC_RECOGNITION_CONTEXT_STATUS_MISSING_RESOURCE_ERROR = 28,
    SC_RECOGNITION_CONTEXT_STATUS_UNLICENSED_TEXT_RECOGNIZER = 29,
    SC_RECOGNITION_CONTEXT_STATUS_OCR_ERROR = 30,
    SC_RECOGNITION_CONTEXT_STATUS_UNLICENSED_FEATURE_BEGIN = 255,

    SC_RECOGNITION_CONTEXT_STATUS_UNLICENSED_FEATURE_END = 512

} ScContextStatusFlag;

typedef struct {
    ScContextStatusFlag flag; 
    ScByteArray message;      
} ScContextStatus;

SC_EXPORT
void sc_context_status_free(ScContextStatus status);

typedef struct {
    ScContextStatus status; 
    uint32_t frame_id;      
} ScProcessFrameResult;

SC_EXPORT
void sc_process_frame_result_free(ScProcessFrameResult result);

#if SC_PLATFORM_ANDROID || (defined(SC_GENERATE_DOCS) && SC_GENERATE_DOCS)

SC_EXPORT
ScRecognitionContext *sc_recognition_context_new(char const *license_key,
                                                 char const *writable_data_path,
                                                 JNIEnv *env,
                                                 jobject activity,
                                                 char const *device_name);
#endif

#if SC_PLATFORM_GENERIC || (defined(SC_GENERATE_DOCS) && SC_GENERATE_DOCS)

SC_EXPORT
ScRecognitionContext *sc_recognition_context_new(char const *license_key,
                                                 char const *writable_data_path,
                                                 char const *device_name);
#endif

SC_EXPORT
void sc_recognition_context_retain(ScRecognitionContext const *context);

SC_EXPORT
void sc_recognition_context_release(ScRecognitionContext const *context);

SC_EXPORT
void sc_recognition_context_start_new_frame_sequence(ScRecognitionContext *context);

SC_EXPORT
ScProcessFrameResult sc_recognition_context_process_frame(
        ScRecognitionContext *context,
        ScImageDescription const *image_description,
        uint8_t const *image_data);

SC_EXPORT
void sc_recognition_context_end_frame_sequence(ScRecognitionContext *context);

typedef enum {
    SC_CAMERA_FACING_DIRECTION_UNKNOWN = 0x00,
    SC_CAMERA_FACING_DIRECTION_BACK = 0x01,
    SC_CAMERA_FACING_DIRECTION_FRONT = 0x02
} ScCameraFacingDirection;

typedef struct {
    ScCameraFacingDirection facing_direction; 
    char const *identifier; 
} ScCameraProperties;

SC_EXPORT
void sc_recognition_context_set_camera_properties(ScRecognitionContext *context,
                                                  ScCameraProperties camera_properties);

SC_EXTERN_C_END

#endif // SC_RECOGNITION_CONTEXT_H_