ScanbotSDK.h

Go to the documentation of this file.

 
#pragma once
#ifndef SCANBOTSDK_H
#define SCANBOTSDK_H
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifdef _WIN32
#ifdef SBSDK_GIT_VERSION
#define SBSDK_API __declspec(dllexport)
#else
#define SBSDK_API __declspec(dllimport)
#endif
#else
#define SBSDK_API
#endif
 
typedef enum scanbotsdk_error_code_t {
    SCANBOTSDK_OK = 0,
 
    SCANBOTSDK_ERROR,
 
    SCANBOTSDK_ERROR_INVALID_LICENSE_STATUS,
 
    SCANBOTSDK_ERROR_NULL_POINTER,
 
    SCANBOTSDK_ERROR_INVALID_ARGUMENT,
 
    SCANBOTSDK_ERROR_INVALID_IMAGE
} scanbotsdk_error_code_t;
 
typedef enum scanbotsdk_license_status_t {
    SCANBOTSDK_LICENSE_STATUS_OK = 0,
    SCANBOTSDK_LICENSE_STATUS_FAILURE_CORRUPTED,
    SCANBOTSDK_LICENSE_STATUS_FAILURE_WRONG_OS,
    SCANBOTSDK_LICENSE_STATUS_FAILURE_APP_ID_MISMATCH,
    SCANBOTSDK_LICENSE_STATUS_FAILURE_EXPIRED,
    SCANBOTSDK_LICENSE_STATUS_FAILURE_UNKNOWN,
} scanbotsdk_license_status_t;
 
typedef enum scanbotsdk_barcode_format_t {
    SCANBOTSDK_BARCODE_FORMAT_UNKNOWN = 0,
    SCANBOTSDK_BARCODE_FORMAT_AZTEC,
    SCANBOTSDK_BARCODE_FORMAT_CODABAR,
    SCANBOTSDK_BARCODE_FORMAT_CODE_39,
    SCANBOTSDK_BARCODE_FORMAT_CODE_93,
    SCANBOTSDK_BARCODE_FORMAT_CODE_128,
    SCANBOTSDK_BARCODE_FORMAT_DATA_MATRIX,
    SCANBOTSDK_BARCODE_FORMAT_EAN_8,
    SCANBOTSDK_BARCODE_FORMAT_EAN_13,
    SCANBOTSDK_BARCODE_FORMAT_ITF,
    SCANBOTSDK_BARCODE_FORMAT_PDF_417,
    SCANBOTSDK_BARCODE_FORMAT_QR_CODE,
    SCANBOTSDK_BARCODE_FORMAT_RSS_14,
    SCANBOTSDK_BARCODE_FORMAT_RSS_EXPANDED,
    SCANBOTSDK_BARCODE_FORMAT_UPC_A,
    SCANBOTSDK_BARCODE_FORMAT_UPC_E,
    SCANBOTSDK_BARCODE_FORMAT_UPC_EAN_EXTENSION,
    SCANBOTSDK_BARCODE_FORMAT_MSI_PLESSEY,
    SCANBOTSDK_BARCODE_FORMAT_IATA_2_OF_5,
    SCANBOTSDK_BARCODE_FORMAT_INDUSTRIAL_2_OF_5,
 
    SCANBOTSDK_BARCODE_FORMAT_ONE_D,
} scanbotsdk_barcode_format_t;
 
typedef enum scanbotsdk_barcode_engine_mode_t {
    SCANBOTSDK_BARCODE_ENGINE_MODE_LEGACY_FAST = 0,
    SCANBOTSDK_BARCODE_ENGINE_MODE_FASTEST,
    SCANBOTSDK_BARCODE_ENGINE_MODE_FAST,
    SCANBOTSDK_BARCODE_ENGINE_MODE_BALANCED,
    SCANBOTSDK_BARCODE_ENGINE_MODE_BEST
} scanbotsdk_barcode_engine_mode_t;
 
typedef struct scanbotsdk_barcode_recognizer_init_params_t {
    scanbotsdk_barcode_engine_mode_t engine_mode;
 
    const scanbotsdk_barcode_format_t* formats;
 
    int formats_count;
 
    bool use_tensorrt;
 
    int tensorrt_max_input_width;
 
    int tensorrt_max_input_height;
 
    size_t tensorrt_max_workspace_size;
} scanbotsdk_barcode_recognizer_init_params_t;
 
typedef struct scanbotsdk_image_t {
    void* buffer;
 
    int width;
 
    int height;
 
    int channels;
 
    int stride;
} scanbotsdk_image_t;
 
typedef struct scanbotsdk_barcode_recognizer_t scanbotsdk_barcode_recognizer_t;
typedef struct scanbotsdk_barcode_result_t scanbotsdk_barcode_result_t;
 
typedef struct scanbotsdk_init_params_t {
    const char* license_key;
} scanbotsdk_init_params_t;
 
SBSDK_API const char* scanbotsdk_get_git_version();
 
SBSDK_API scanbotsdk_error_code_t
scanbotsdk_initialize(const scanbotsdk_init_params_t* init_params);
 
SBSDK_API scanbotsdk_error_code_t
scanbotsdk_get_license_status(scanbotsdk_license_status_t* status);
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_set_logging(bool enable);
 
SBSDK_API scanbotsdk_error_code_t
scanbotsdk_set_log_handler(void (*log_handler)(const char* message));
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_reset_log_handler();
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_log_error(const char* message);
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_recognizer_create(
    const scanbotsdk_barcode_recognizer_init_params_t* params,
    scanbotsdk_barcode_recognizer_t** recognizer);
 
SBSDK_API scanbotsdk_error_code_t
scanbotsdk_barcode_recognizer_free(scanbotsdk_barcode_recognizer_t* recognizer);
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_recognizer_recognize(
    scanbotsdk_barcode_recognizer_t* recognizer,
    const scanbotsdk_image_t* input,
    scanbotsdk_barcode_result_t** result);
 
SBSDK_API scanbotsdk_error_code_t
scanbotsdk_barcode_result_free(scanbotsdk_barcode_result_t* result);
 
SBSDK_API scanbotsdk_error_code_t
scanbotsdk_barcode_result_get_count(const scanbotsdk_barcode_result_t* result, int* count);
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_result_get_format(
    const scanbotsdk_barcode_result_t* result,
    int index,
    scanbotsdk_barcode_format_t* format);
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_result_get_text(
    const scanbotsdk_barcode_result_t* result,
    int index,
    const char** text);
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_result_get_quad(
    const scanbotsdk_barcode_result_t* result,
    int barcode_index,
    int* quad);
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_result_get_raw_bytes(
    const scanbotsdk_barcode_result_t* result,
    int index,
    const unsigned char** raw_bytes,
    int* length);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* SCANBOTSDK_H */