ScBarcode.h

Go to the documentation of this file.

#ifndef SC_BARCODE_H_
#define SC_BARCODE_H_

#include <Scandit/ScByteArray.h>
#include <Scandit/ScEncodingArray.h>
#include <Scandit/ScConfig.h>
#include <Scandit/ScCommon.h>

#if defined(__cplusplus)
extern "C" {
#endif

typedef enum {
    SC_SYMBOLOGY_UNKNOWN = 0x0000000,
    SC_SYMBOLOGY_EAN13 = 0x0000001,
    SC_SYMBOLOGY_EAN8 = 0x0000002,
    SC_SYMBOLOGY_UPCA = 0x0000004,
    SC_SYMBOLOGY_UPCE = 0x0000008,
    SC_SYMBOLOGY_CODE128 = 0x0000010,
    SC_SYMBOLOGY_CODE39 = 0x0000020,
    SC_SYMBOLOGY_CODE93 = 0x0000040,
    SC_SYMBOLOGY_INTERLEAVED_2_OF_5 = 0x0000080,
    SC_SYMBOLOGY_QR = 0x0000100,
    SC_SYMBOLOGY_DATA_MATRIX = 0x0000200,
    SC_SYMBOLOGY_PDF417 = 0x0000400,
    SC_SYMBOLOGY_MSI_PLESSEY = 0x0000800,
    SC_SYMBOLOGY_GS1_DATABAR = 0x0001000,
    SC_SYMBOLOGY_GS1_DATABAR_EXPANDED = 0x0002000,
    SC_SYMBOLOGY_CODABAR = 0x0004000,
    SC_SYMBOLOGY_AZTEC = 0x0008000,
    SC_SYMBOLOGY_TWO_DIGIT_ADD_ON = 0x0010000,
    SC_SYMBOLOGY_FIVE_DIGIT_ADD_ON = 0x0020000,
    SC_SYMBOLOGY_MAXICODE = 0x0040000,
    SC_SYMBOLOGY_CODE11 = 0x0080000,
    SC_SYMBOLOGY_GS1_DATABAR_LIMITED = 0x0100000,
    SC_SYMBOLOGY_CODE25 = 0x0200000,
    SC_SYMBOLOGY_MICRO_PDF417 = 0x0400000,

    SC_SYMBOLOGY_RM4SCC = 0x0800000,
    SC_SYMBOLOGY_KIX = 0x1000000,
    SC_SYMBOLOGY_DOTCODE = 0x2000000,
    SC_SYMBOLOGY_MICRO_QR = 0x4000000,
    SC_SYMBOLOGY_CODE32 = 0x8000000,
    SC_SYMBOLOGY_LAPA4SC = 0x10000000,
    SC_SYMBOLOGY_IATA_2_OF_5 = 0x20000000,
    SC_SYMBOLOGY_MATRIX_2_OF_5 = 0x40000000,
    SC_SYMBOLOGY_USPS_INTELLIGENT_MAIL = 0x40000001,
    SC_SYMBOLOGY_ARUCO = 0x80000000,
    SC_SYMBOLOGY_UPU_4STATE = 0x100000000,
    SC_SYMBOLOGY_AUSTRALIAN_POST_4STATE = 0x100000001,
} ScSymbology;

typedef enum {
    SC_COMPOSITE_FLAG_NONE = 0x0000000,
    SC_COMPOSITE_FLAG_UNKNOWN = 0x0000001,
    SC_COMPOSITE_FLAG_LINKED = 0x0000002,
    SC_COMPOSITE_FLAG_GS1_A = 0x0000004,
    SC_COMPOSITE_FLAG_GS1_B = 0x0000008,
    SC_COMPOSITE_FLAG_GS1_C = 0x0000010
} ScCompositeFlag;

SC_EXPORT
SC_EXTERN
ScSymbology const SC_ALL_SYMBOLOGIES[];

SC_EXPORT
SC_EXTERN
uint16_t const SC_ALL_SYMBOLOGIES_COUNT;

SC_EXPORT
char const *sc_symbology_to_string(ScSymbology symbology);

SC_EXPORT
ScSymbology sc_symbology_from_string(char const *symbology_string);

typedef struct ScOpaqueBarcode ScBarcode;

SC_EXPORT
ScByteArray sc_barcode_get_data(ScBarcode const *barcode);

SC_EXPORT
ScEncodingArray sc_barcode_get_data_encoding(ScBarcode const *barcode);

SC_EXPORT
void sc_barcode_retain(ScBarcode *barcode);

SC_EXPORT
void sc_barcode_release(ScBarcode *barcode);

SC_EXPORT
ScSymbology sc_barcode_get_symbology(ScBarcode const *barcode);

SC_EXPORT
ScBool sc_barcode_is_gs1_data_carrier(ScBarcode const *barcode);

SC_EXPORT
ScCompositeFlag sc_barcode_get_composite_flag(ScBarcode const *barcode);

SC_EXPORT
ScBool sc_barcode_is_recognized(ScBarcode const *barcode);

SC_EXPORT
ScQuadrilateral sc_barcode_get_location(ScBarcode const *barcode);

SC_EXPORT
uint32_t sc_barcode_get_frame_id(ScBarcode const *barcode);

SC_EXPORT
int32_t sc_barcode_get_symbol_count(ScBarcode const *barcode);

SC_EXPORT
ScBool sc_barcode_is_color_inverted(ScBarcode const *barcode);

#if defined(__cplusplus)
}
#endif

#endif // SC_BARCODE_H_