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>

SC_EXTERN_C_BEGIN

typedef enum {
    SC_SYMBOLOGY_UNKNOWN = 0,
    SC_SYMBOLOGY_EAN13_UPCA = 1,
    SC_SYMBOLOGY_EAN8 = 2,
    SC_SYMBOLOGY_UPCE = 4,
    SC_SYMBOLOGY_CODE128 = 5,
    SC_SYMBOLOGY_CODE39 = 6,
    SC_SYMBOLOGY_CODE93 = 7,
    SC_SYMBOLOGY_INTERLEAVED_2_OF_5 = 8,
    SC_SYMBOLOGY_QR = 9,
    SC_SYMBOLOGY_DATA_MATRIX = 10,
    SC_SYMBOLOGY_PDF417 = 11,
    SC_SYMBOLOGY_MSI_PLESSEY = 12,
    SC_SYMBOLOGY_GS1_DATABAR = 13,
    SC_SYMBOLOGY_GS1_DATABAR_EXPANDED = 14,
    SC_SYMBOLOGY_CODABAR = 15,
    SC_SYMBOLOGY_AZTEC = 16,
    SC_SYMBOLOGY_TWO_DIGIT_ADD_ON = 17,
    SC_SYMBOLOGY_FIVE_DIGIT_ADD_ON = 18,
    SC_SYMBOLOGY_MAXICODE = 19,
    SC_SYMBOLOGY_CODE11 = 20,
    SC_SYMBOLOGY_GS1_DATABAR_LIMITED = 21,
    SC_SYMBOLOGY_CODE25 = 22,
    SC_SYMBOLOGY_MICRO_PDF417 = 23,
    SC_SYMBOLOGY_ROYAL_MAIL_4STATE = 24,
    SC_SYMBOLOGY_KIX = 25,
    SC_SYMBOLOGY_DOTCODE = 26,
    SC_SYMBOLOGY_MICRO_QR = 27,
    SC_SYMBOLOGY_CODE32 = 28,
    SC_SYMBOLOGY_LAPA4SC = 29,
    SC_SYMBOLOGY_IATA_2_OF_5 = 30,
    SC_SYMBOLOGY_MATRIX_2_OF_5 = 31,
    SC_SYMBOLOGY_USPS_INTELLIGENT_MAIL = 32,
    SC_SYMBOLOGY_ARUCO = 33,
    SC_SYMBOLOGY_UPU_4STATE = 34,
    SC_SYMBOLOGY_AUSTRALIAN_POST_4STATE = 35,
    SC_SYMBOLOGY_FRENCH_POST = 36,
} ScSymbology;

SC_EXPORT
SC_EXTERN
SC_DEPRECATED("use SC_SYMBOLOGY_ROYAL_MAIL_4STATE instead")
ScSymbology const SC_SYMBOLOGY_RM4SCC;

typedef enum {
    SC_COMPOSITE_FLAG_NONE = 0,
    SC_COMPOSITE_FLAG_UNKNOWN = 1,
    SC_COMPOSITE_FLAG_LINKED = 2,
    SC_COMPOSITE_FLAG_GS1_A = 3,
    SC_COMPOSITE_FLAG_GS1_B = 4,
    SC_COMPOSITE_FLAG_GS1_C = 5
} 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);

SC_EXPORT
ScPoint sc_barcode_get_module_counts(ScBarcode const *barcode);

SC_EXPORT
char const *sc_barcode_get_file_id(ScBarcode const *barcode);

SC_EXPORT
int32_t sc_barcode_get_segment_index(ScBarcode const *barcode);

SC_EXPORT
int32_t sc_barcode_get_segment_count(ScBarcode const *barcode);

SC_EXTERN_C_END

#endif // SC_BARCODE_H_