/**
* @file BarcodeScanner.h
* @brief Barcode Decoders Library
* @n Copyright (C) Cognex Corporation
*
* \ifnot MWBSDK
* Cognex Mobile Barcode SDK's easy API is preferred instead of this header file and its associated legacy API.
* Unless explicitly directed to use this header/API, all new applications should now only be using ReaderDevice.
* Applications that use this API, may still use it, there is no need for migraton as it will be not removed
* without further notice.
* \endif
*/
#ifndef _BARCODESCANNER_H_
#define _BARCODESCANNER_H_
#ifdef __cplusplus
extern "C" {
#endif
#ifndef uint32_t
typedef unsigned int uint32_t;
typedef unsigned char uint8_t;
#endif
/**
* @name General configuration
** @{
*/
/** @name Grayscale image size range
** @{ */
#define MWB_GRAYSCALE_LENX_MIN 25
#define MWB_GRAYSCALE_LENX_MAX 5000
#define MWB_GRAYSCALE_LENY_MIN 25
#define MWB_GRAYSCALE_LENY_MAX 5000
/** @} */
/**
* @name Basic return values for API functions
* @{
*/
#define MWB_RT_OK 0
#define MWB_RT_FAIL -1
#define MWB_RT_NOT_SUPPORTED -2
#define MWB_RT_BAD_PARAM -3
#define MWB_RT_INVALID_SCANNING_RECTANGLE -4
/** @} */
/**
* @name Basic return values for RegisterSDK function
* @{
*/
#define MWB_RTREG_OK 0
#define MWB_RTREG_INVALID_KEY -1
#define MWB_RTREG_INVALID_CHECKSUM -2
#define MWB_RTREG_INVALID_APPLICATION -3
#define MWB_RTREG_INVALID_SDK_VERSION -4
#define MWB_RTREG_INVALID_KEY_VERSION -5
#define MWB_RTREG_INVALID_PLATFORM -6
#define MWB_RTREG_KEY_EXPIRED -7
#define MWB_RTREG_AIMER_REQUIRED -8
#define MWB_RTREG_AIMER_NOT_DETECTED -9
//Warnings
#define MWB_RTREG_CUSTOM_SIZE_EXCEEDED -100
/** @} */
/**
** @name Configuration values for use with MWB_setFlags
** @{ */
/** @brief Global decoder flags value: apply sharpening on input image
*/
#define MWB_CFG_GLOBAL_HORIZONTAL_SHARPENING 0x01
#define MWB_CFG_GLOBAL_VERTICAL_SHARPENING 0x02
#define MWB_CFG_GLOBAL_SHARPENING 0x03
/** @brief Global decoder flags value: apply rotation on input image
*/
#define MWB_CFG_GLOBAL_ROTATE90 0x04
#define MWB_CFG_GLOBAL_ROTATE180 0x08
/** @brief Global decoder flags value: calculate location for 1D barcodeTypes (Code128, Code93, Code39 supported)
*/
#define MWB_CFG_GLOBAL_CALCULATE_1D_LOCATION 0x10
/** @brief Global decoder flags value: fail 1D decode if result is not confirmed by location expanding (Code128, Code93, Code39 supported)
*/
#define MWB_CFG_GLOBAL_VERIFY_1D_LOCATION 0x20
/** @brief Global decoder flags value: fail decode if result is not touching the center of viewfinder (2D + Code128, Code93, Code39 supported)
* 1D locaiton flags will be enabled automatically with this one
*/
#define MWB_CFG_GLOBAL_USE_CENTRIC_SCANNING 0x40
/** @brief Global decoder flags value: disable some image pre=processing, suitable for devices with weak CPU
*/
#define MWB_CFG_GLOBAL_DISABLE_PREPROCESSING 0x80
/** @brief Global decoder flags value: Enable multiple barcode detection in single image
*/
#define MWB_CFG_GLOBAL_ENABLE_MULTI 0x100
/** @brief Global decoder flagss value: mulyiple scan lines density
*/
#define MWB_CFG_GLOBAL_SCANLINESx2 0x200
#define MWB_CFG_GLOBAL_SCANLINESx4 0x400
#define MWB_CFG_GLOBAL_SCANLINESx8 0x800
/** @brief Code39 decoder flags value: require checksum check
*/
#define MWB_CFG_CODE39_REQ_CHKSUM 0x2
/**/
/** @brief Code39 decoder flags value: don't require stop symbol - can lead to false results
*/
#define MWB_CFG_CODE39_DONT_REQUIRE_STOP 0x4
/**/
/** @brief Code39 decoder flags value: decode full ASCII
*/
#define MWB_CFG_CODE39_EXTENDED_MODE 0x8
/**/
/** @brief Code39 decoder flags value: Try decoding result to CODE32. if failed, Code39 will return
*/
#define MWB_CFG_CODE39_CODE32_ENABLED 0x10
/**/
/** @brief Code39 decoder flags value: ADD 'A' prefix to Code32 result
*/
#define MWB_CFG_CODE39_CODE32_PREFIX 0x20
/**/
/** @brief Code93 decoder flags value: decode full ASCII
*/
#define MWB_CFG_CODE93_EXTENDED_MODE 0x8
/**/
/** @brief UPC/EAN decoder disable addons detection
*/
#define MWB_CFG_EANUPC_DISABLE_ADDON 0x1
/**/
/** @brief UPC/EAN disable UPC-E expanding to UPC-A
*/
#define MWB_CFG_EANUPC_DONT_EXPAND_UPCE 0x2
/**/
/** @brief Code25 decoder flags value: require checksum check
* MWB_CFG_CODE25_REQ_CHKSUM is deprecated and shouldn't be used in combination with other checksum flags
*/
#define MWB_CFG_CODE25_REQ_CHKSUM 0x01
#define MWB_CFG_CODE25_REQ_CHKSUM_STANDARD 0x02
#define MWB_CFG_CODE25_REQ_CHKSUM_INTERLEAVED 0x04
#define MWB_CFG_CODE25_REQ_CHKSUM_IATA 0x08
#define MWB_CFG_CODE25_REQ_CHKSUM_MATRIX 0x10
#define MWB_CFG_CODE25_REQ_CHKSUM_COOP 0x20
#define MWB_CFG_CODE25_REQ_CHKSUM_INVERTED 0x40
/**/
/** @brief Code11 decoder flags value: require checksum check
* MWB_CFG_CODE11_REQ_SINGLE_CHKSUM is set by default
*/
#define MWB_CFG_CODE11_REQ_SINGLE_CHKSUM 0x1
#define MWB_CFG_CODE11_REQ_DOUBLE_CHKSUM 0x2
/**/
/** @brief MSI Plessey decoder flags value: require checksum check
* MWB_CFG_MSI_REQ_10_CHKSUM is set by default
*/
#define MWB_CFG_MSI_REQ_10_CHKSUM 0x01
#define MWB_CFG_MSI_REQ_1010_CHKSUM 0x02
#define MWB_CFG_MSI_REQ_11_IBM_CHKSUM 0x04
#define MWB_CFG_MSI_REQ_11_NCR_CHKSUM 0x08
#define MWB_CFG_MSI_REQ_1110_IBM_CHKSUM 0x10
#define MWB_CFG_MSI_REQ_1110_NCR_CHKSUM 0x20
/**/
/** @brief Codabar decoder flags value: include start/stop symbols in result
*/
#define MWB_CFG_CODABAR_INCLUDE_STARTSTOP 0x1
/**/
/** @brief Datamatrix decoder flags value: enable DPM mode
*/
#define MWB_CFG_DM_DPM_MODE 0x2
/**/
/** @brief Telepen decoder flags
*/
#define MWB_CFG_TELEPEN_FORCE_NUMERIC 0x1
/**/
/** @brief Barcode decoder param types
*/
#define MWB_PAR_ID_ECI_MODE 0x08
#define MWB_PAR_ID_RESULT_PREFIX 0x10
#define MWB_PAR_ID_VERIFY_LOCATION 0x20
// working for Datamatrix currently
#define MWB_PAR_ID_SCAN_COLOR 0x40
//set safe zone scale factor for 1D barcode type in range 0 - 100%
#define MWB_PAR_ID_SAFE_ZONE_SCALE 0x80
/**/
/** @brief Barcode param values
*/
#define MWB_PAR_VALUE_ECI_DISABLED 0x00 //default
#define MWB_PAR_VALUE_ECI_ENABLED 0x01
#define MWB_PAR_VALUE_RESULT_PREFIX_NEVER 0x00 // default
#define MWB_PAR_VALUE_RESULT_PREFIX_ALWAYS 0x01
#define MWB_PAR_VALUE_RESULT_PREFIX_DEFAULT 0x02
#define MWB_PAR_VALUE_VERIFY_LOCATION_OFF 0x00
#define MWB_PAR_VALUE_VERIFY_LOCATION_ON 0x01
#define MWB_PAR_VALUE_VERIFY_LOCATION_STRICT 0x02
#define MWB_PAR_VALUE_COLOR_NORMAL 0x01
#define MWB_PAR_VALUE_COLOR_INVERTED 0x02
#define MWB_PAR_VALUE_COLOR_BOTH 0x04 //default
/**/
/** @} */
/**
* @name Bit mask identifiers for supported decoder types
* @{ */
#define MWB_CODE_MASK_NONE 0x00000000u
#define MWB_CODE_MASK_QR 0x00000001u
#define MWB_CODE_MASK_DM 0x00000002u
#define MWB_CODE_MASK_RSS 0x00000004u
#define MWB_CODE_MASK_39 0x00000008u
#define MWB_CODE_MASK_EANUPC 0x00000010u
#define MWB_CODE_MASK_128 0x00000020u
#define MWB_CODE_MASK_PDF 0x00000040u
#define MWB_CODE_MASK_AZTEC 0x00000080u
#define MWB_CODE_MASK_25 0x00000100u
#define MWB_CODE_MASK_93 0x00000200u
#define MWB_CODE_MASK_CODABAR 0x00000400u
#define MWB_CODE_MASK_DOTCODE 0x00000800u
#define MWB_CODE_MASK_11 0x00001000u
#define MWB_CODE_MASK_MSI 0x00002000u
#define MWB_CODE_MASK_MAXICODE 0x00004000u
#define MWB_CODE_MASK_POSTAL 0x00008000u
#define MWB_CODE_MASK_TELEPEN 0x00010000u
#define MWB_CODE_MASK_ALL 0x00ffffffu
/** @} */
/**
* @name Bit mask identifiers for RSS decoder types
* @{ */
#define MWB_SUBC_MASK_RSS_14 0x00000001u
#define MWB_SUBC_MASK_RSS_14_STACK 0x00000002u
#define MWB_SUBC_MASK_RSS_LIM 0x00000004u
#define MWB_SUBC_MASK_RSS_EXP 0x00000008u
/** @} */
/**
* @name Bit mask identifiers for QR decoder types
* @{ */
#define MWB_SUBC_MASK_QR_STANDARD 0x00000001u
#define MWB_SUBC_MASK_QR_MICRO 0x00000002u
/** @} */
/**
* @name Bit mask identifiers for PDF decoder types
* @{ */
#define MWB_SUBC_MASK_PDF_STANDARD 0x00000001u
#define MWB_SUBC_MASK_PDF_MICRO 0x00000002u
/** @} */
/**
* @name Bit mask identifiers for 2 of 5 decoder types
* @{ */
#define MWB_SUBC_MASK_C25_INTERLEAVED 0x00000001u
#define MWB_SUBC_MASK_C25_STANDARD 0x00000002u
#define MWB_SUBC_MASK_C25_ITF14 0x00000004u
#define MWB_SUBC_MASK_C25_IATA 0x00000008u
#define MWB_SUBC_MASK_C25_MATRIX 0x00000010u
#define MWB_SUBC_MASK_C25_COOP 0x00000020u
#define MWB_SUBC_MASK_C25_INVERTED 0x00000040u
/** @} */
/**
* @name Bit mask identifiers for POSTAL decoder types
* @{ */
#define MWB_SUBC_MASK_POSTAL_POSTNET 0x00000001u
#define MWB_SUBC_MASK_POSTAL_PLANET 0x00000002u
#define MWB_SUBC_MASK_POSTAL_IM 0x00000004u
#define MWB_SUBC_MASK_POSTAL_ROYAL 0x00000008u
#define MWB_SUBC_MASK_POSTAL_AUSTRALIAN 0x00000010u
/** @} */
/**
* @name Bit mask identifiers for UPC/EAN decoder types
* @{ */
#define MWB_SUBC_MASK_EANUPC_EAN_13 0x00000001u
#define MWB_SUBC_MASK_EANUPC_EAN_8 0x00000002u
#define MWB_SUBC_MASK_EANUPC_UPC_A 0x00000004u
#define MWB_SUBC_MASK_EANUPC_UPC_E 0x00000008u
#define MWB_SUBC_MASK_EANUPC_UPC_E1 0x00000010u
/** @} */
/**
* @name Bit mask identifiers for 1D scanning direction
* @{ */
#define MWB_SCANDIRECTION_HORIZONTAL 0x00000001u
#define MWB_SCANDIRECTION_VERTICAL 0x00000002u
#define MWB_SCANDIRECTION_OMNI 0x00000004u
#define MWB_SCANDIRECTION_AUTODETECT 0x00000008u
#define MWB_SCANDIRECTION_CUSTOM 0x00000010u
/** @} */
/**
* @name Result values for all code types
* @{ */
enum res_types {
FOUND_NONE = 0,
FOUND_DM,
FOUND_39,
FOUND_RSS_14,
FOUND_RSS_14_STACK,
FOUND_RSS_LIM,
FOUND_RSS_EXP,
FOUND_EAN_13,
FOUND_EAN_8,
FOUND_UPC_A,
FOUND_UPC_E,
FOUND_128,
FOUND_PDF,
FOUND_QR,
FOUND_AZTEC,
FOUND_25_INTERLEAVED,
FOUND_25_STANDARD,
FOUND_93,
FOUND_CODABAR,
FOUND_DOTCODE,
FOUND_128_GS1,
FOUND_ITF14,
FOUND_11,
FOUND_MSI,
FOUND_25_IATA,
FOUND_25_MATRIX,
FOUND_25_COOP,
FOUND_25_INVERTED,
FOUND_QR_MICRO,
FOUND_MAXICODE,
FOUND_POSTNET,
FOUND_PLANET,
FOUND_IMB,
FOUND_ROYALMAIL,
FOUND_MICRO_PDF,
FOUND_32,
FOUND_AUSTRALIAN,
FOUND_TELEPEN,
};
/** @} */
/** @} */
/**
* @name Result structure constants
* @{ */
/**
* @name Identifiers for result types
* @{ */
#define MWB_RESULT_TYPE_RAW 0x00000001u
#define MWB_RESULT_TYPE_MW 0x00000002u
//#define MWB_RESULT_TYPE_JSON 0x00000003u //not yet implemented
/** @} */
/**
* @name Identifiers for result fields types
* @{ */
#define MWB_RESULT_FT_BYTES 0x00000001u
#define MWB_RESULT_FT_TEXT 0x00000002u
#define MWB_RESULT_FT_TYPE 0x00000003u
#define MWB_RESULT_FT_SUBTYPE 0x00000004u
#define MWB_RESULT_FT_SUCCESS 0x00000005u
#define MWB_RESULT_FT_ISGS1 0x00000006u
#define MWB_RESULT_FT_LOCATION 0x00000007u
#define MWB_RESULT_FT_IMAGE_WIDTH 0x00000008u
#define MWB_RESULT_FT_IMAGE_HEIGHT 0x00000009u
#define MWB_RESULT_FT_PARSER_BYTES 0x0000000Au
#define MWB_RESULT_FT_MODULES_COUNT_X 0x0000000Bu
#define MWB_RESULT_FT_MODULES_COUNT_Y 0x0000000Cu
#define MWB_RESULT_FT_MODULE_SIZE_X 0x0000000Du
#define MWB_RESULT_FT_MODULE_SIZE_Y 0x0000000Eu
#define MWB_RESULT_FT_SKEW 0x0000000Fu
#define MWB_RESULT_FT_KANJI 0x00000010u
#define MWB_RESULT_FT_BARCODE_WIDTH 0x00000011u
#define MWB_RESULT_FT_BARCODE_HEIGHT 0x00000012u
#define MWB_RESULT_FT_TEXT_ENCODING 0x00000013u
#define MWB_RESULT_FT_PDF_ROWS 0x00000020u
#define MWB_RESULT_FT_PDF_COLUMNS 0x00000021u
#define MWB_RESULT_FT_PDF_TRUNCATED 0x00000022u
#define MWB_RESULT_FT_PDF_ECLEVEL 0x00000023u
#define MWB_RESULT_FT_PDF_CODEWORDS 0x00000024u
/** @} */
/**
* @name Descriptive names of result field types
* @{ */
#define MWB_RESULT_FNAME_BYTES "Bytes"
#define MWB_RESULT_FNAME_TEXT "Text"
#define MWB_RESULT_FNAME_TYPE "Type"
#define MWB_RESULT_FNAME_SUBTYPE "Subtype"
#define MWB_RESULT_FNAME_SUCCESS "Success"
#define MWB_RESULT_FNAME_ISGS1 "GS1 compliance"
#define MWB_RESULT_FNAME_KANJI "Kanji encoding"
#define MWB_RESULT_FNAME_TEXT_ENCODING "Text encoding"
#define MWB_RESULT_FNAME_LOCATION "Location"
#define MWB_RESULT_FNAME_IMAGE_WIDTH "Image Width"
#define MWB_RESULT_FNAME_IMAGE_HEIGHT "Image Height"
#define MWB_RESULT_FNAME_PARSER_BYTES "Parser Input"
#define MWB_RESULT_FNAME_MODULES_COUNT_X "Modules Count X"
#define MWB_RESULT_FNAME_MODULES_COUNT_Y "Modules Count Y"
#define MWB_RESULT_FNAME_MODULE_SIZE_X "Module Size X"
#define MWB_RESULT_FNAME_MODULE_SIZE_Y "Module Size Y"
#define MWB_RESULT_FNAME_SKEW "Skew"
#define MWB_RESULT_FNAME_BARCODE_WIDTH "Barcode Width"
#define MWB_RESULT_FNAME_BARCODE_HEIGHT "Barcode Height"
#define MWB_RESULT_FNAME_PDF_ROWS "PDF417 Rows Count"
#define MWB_RESULT_FNAME_PDF_COLUMNS "PDF417 Columns Count"
#define MWB_RESULT_FNAME_PDF_TRUNCATED "PDF417 is Truncated"
#define MWB_RESULT_FNAME_PDF_ECLEVEL "PDF417 EC Level"
#define MWB_RESULT_FNAME_PDF_CODEWORDS "PDF417 Codewords"
/** @} */
/** @} */
/**
* @name User API function headers
* @{ */
/**
* Returns version code of Barcode Scanner Library.
*
* @return 32-bit version code in x.y.z format.
* @n Byte 3 (most significant byte): reserved (0)
* @n Byte 2: value x
* @n Byte 1: value y
* @n Byte 0 (least significant byte): value z
*/
extern unsigned int MWB_getLibVersion(void);
/*
* Returns textual version of Barcode Scanner Library.
*
* @retval char array with version string
*/
extern char* MWB_getLibVersionText(void);
/**
* Returns supported decoders in this library release.
*
* @returns 32-bit bit mask where each non-zero bit represents
* supported decoder according to MWB_CODE_MASK_... values
* defined in BarcodeScanner.h header file.
*/
extern unsigned int MWB_getSupportedCodes(void);
/**
* Sets rectangular area for barcode scanning with selected single decoder type.
* After MWB_setScanningRect() call, all subseqent scans will be restricted
* to this region. If rectangle is not set, whole image is scanned.
* Also, if width or height is zero, whole image is scanned.
*
* Parameters are interpreted as percentage of image dimensions, i.e. ranges are
* 0 - 100 for all parameters.
*
* @param[in] codeMask Single decoder type selector (MWB_CODE_MASK_...)
* @param[in] left X coordinate of left edge (percentage)
* @param[in] top Y coordinate of top edge (percentage)
* @param[in] width Rectangle witdh (x axis) (percentage)
* @param[in] height Rectangle height (y axis) (percentage)
*
* @retval MWB_RT_OK Rectangle set successfully
* @retval MWB_RT_BAD_PARAM Rectange percentages invalid (out of range)
*/
extern int MWB_setScanningRect(const uint32_t codeMask, float left, float top, float width, float height);
/**
* Sets rectangular area for targeted barcode scanning.
* If rectangle size is greater than zero, decoder will discard all barcodes
* which location doesn't interleave with this rectangle
* If width or height is zero, targeted scanning is disabled
*
* Parameters are interpreted as percentage of image dimensions, i.e. ranges are
* 0 - 100 for all parameters.
*
* @param[in] left X coordinate of left edge (percentage)
* @param[in] top Y coordinate of top edge (percentage)
* @param[in] width Rectangle witdh (x axis) (percentage)
* @param[in] height Rectangle height (y axis) (percentage)
*
* @retval MWB_RT_OK Rectangle set successfully
* @retval MWB_RT_BAD_PARAM Rectange percentages invalid (out of range)
*/
extern int MWB_setTargetRect(float left, float top, float width, float height);
/**
* Get rectangular area for barcode scanning with selected single or multiple decoder type(s).
* If codeMask is 0, union rectangle of all ACTIVE barcode types will be returned
* Output values are in percentages of screeen width and height (range 0 - 100)
*
* @param[in] codeMask Single decoder type selector (MWB_CODE_MASK_...) or 0
* @param[out] left X coordinate of left edge
* @param[out] top Y coordinate of top edge
* @param[out] width Rectangle witdh (x axis)
* @param[out] height Rectangle height (y axis)
*
* @retval MWB_RT_OK Rectangle get successfully
* @retval MWB_RT_NOT_SUPPORTED Rectangle get failed
*/
extern int MWB_getScanningRect(const uint32_t codeMask, float *left, float *top, float *width, float *height);
/**
* Get rectangular area for targeted barcode scanning
* Output values are in percentages of screeen width and height (range 0 - 100)
*
* @param[out] left X coordinate of left edge
* @param[out] top Y coordinate of top edge
* @param[out] width Rectangle witdh (x axis)
* @param[out] height Rectangle height (y axis)
*
* @retval MWB_RT_OK Rectangle get successfully
* @retval MWB_RT_NOT_SUPPORTED Rectangle get failed
*/
extern int MWB_getTargetRect(float *left, float *top, float *width, float *height);
/**
* Registers licensing information for all SDK functionality.
* It should be called just before scanning is going to be used.
*
* @param[in] key License key string
*
* @retval MWB_RT_OK Registration successful
* @retval < 0 Error code - see MWB_RTREG values
*/
extern int MWB_registerSDK(const char * key);
/**
* Same as RegisterSDK with addition of custom string to be sent along with tracking info.
* It should be called just before scanning is going to be used.
*
* @param[in] key License key string
* @param[in] customData Custom string
*
* @retval MWB_RT_OK Registration successful
* @retval < 0 Error code - see MWB_RTREG values
*/
extern int MWB_registerSDKCustom(const char * key, const char* customData);
/**
* Get device ID
* It should be called after registering call, and works only on iOS and Android
*
*
* @retval non NULL ID of device
* @retval NULL ID can't be retrieved
*/
extern char* MWB_getDeviceID(void);
/**
* Get license string for retrieving remaining devices
* It should be called after registering call, and works only on iOS and Android
*
*
* @retval non NULL encrypted licenseString
* @retval NULL ID can't be retrieved
*/
extern char* MWB_getLicenseString(void);
/**
* Sets active or inactive status of decoder types and updates decoder execution priority list.
* Upon library load, all decoder types are inactive by default. User must call this function
* at least once to choose active set of active decoders.
*
* @param[in] codeMask ORed bit flags (MWB_CODE_MASK_...) of decoder types
* to be activated.
* Bit value '1' activates corresponding decoder, while bit value
* deactivates it.
*
* @retval MWB_RT_OK All requested decoder types supported and activated.
* @retval MWB_RT_NOT_SUPPORTED One or more requested decoder types is not
* supported in this library release. On this error,
* activation status of all supported types will not be changed.
*/
extern int MWB_setActiveCodes(const uint32_t codeMask);
/**
* Get active decoder types
*
* @retval Active decoder types
*/
extern int MWB_getActiveCodes(void);
/**
* Enable decoder type
* Upon library load, all decoder types are inactive by default. User must call this function
* at least once to choose active decoder.
*
* @param[in] codeMask Bit flags (MWB_CODE_MASK_...) of decoder type
* to be activated.
*
* @retval MWB_RT_OK Requested decoder type supported and activated.
* @retval MWB_RT_NOT_SUPPORTED Requested decoder type is not supported in this library release
*/
extern int MWB_enableCode(const uint32_t codeMask);
/**
* Disable decoder type
* Remove barcode type from set of enabled types
*
* @param[in] codeMask Bit flags (MWB_CODE_MASK_...) of decoder type
* to be deactivated.
*
* @retval MWB_RT_OK Requested decoder type supported and deactivated.
* @retval MWB_RT_NOT_SUPPORTED Requested decoder type is not supported in this library release
*/
extern int MWB_disableCode(const uint32_t codeMask);
/**
* Set active subcodes for given code group flag.
* Subcodes under some decoder type are all activated by default.
*
* @param[in] codeMask Single decoder type/group (MWB_CODE_MASK_...)
* @param[in] subMask ORed bit flags of requested decoder subtypes (MWB_SUBC_MASK_)
*
* @retval MWB_RT_OK Activation successful
* @retval MWB_RT_BAD_PARAM No decoder group selected
* @retval MWB_RT_NOT_SUPPORTED Decoder group or subtype not supported
*/
extern int MWB_setActiveSubcodes(const uint32_t codeMask, const uint32_t subMask);
/**
* Get active subcodes for given code group flag.
*
* @param[in] codeMask Single decoder type/group (MWB_CODE_MASK_...)
*
* @retval >= 0 Acctive subtypes for given code mask
* @retval MWB_RT_BAD_PARAM No decoder group selected
* @retval MWB_RT_NOT_SUPPORTED Decoder group or subtype not supported
*/
extern int MWB_getActiveSubcodes(const uint32_t codeMask);
/**
* enable subcode for given code group flag.
* Subcodes under some decoder type are all activated by default.
*
* @param[in] codeMask Single decoder type/group (MWB_CODE_MASK_...)
* @param[in] subMask Flag of requested decoder subtype (MWB_SUBC_MASK_)
*
* @retval MWB_RT_OK Activation successful
* @retval MWB_RT_BAD_PARAM No decoder group selected
* @retval MWB_RT_NOT_SUPPORTED Decoder group or subtype not supported
*/
extern int MWB_enableSubcode(const uint32_t codeMask, const uint32_t subMask);
/**
* Disable subcode for given code group flag.
*
* @param[in] codeMask Single decoder type/group (MWB_CODE_MASK_...)
* @param[in] subMask Flag of requested decoder subtype (MWB_SUBC_MASK_)
*
* @retval MWB_RT_OK Deactivation successful
* @retval MWB_RT_BAD_PARAM No decoder group selected
* @retval MWB_RT_NOT_SUPPORTED Decoder group or subtype not supported
*/
extern int MWB_disableSubcode(const uint32_t codeMask, const uint32_t subMask);
/**
* @brief Sets code priority level for selected decoder group or groups.
* @details If this library release supports multiple decoder types, user
* can activate more than one type to be invoked when main scan image
* function is called by user. MWB_setCodePriority enables user to
* control order by which decoders will be called.
*
* @param[in] codeMask Single decoder type/group (MWB_CODE_MASK_...)
* @param[in] priority Priority level
*
* @retval MWB_RT_OK Success
* @retval MWB_RT_NOT_SUPPORTED Decoder group not supported
*/
extern int MWB_setCodePriority(const uint32_t codeMask, const uint8_t priority);
/**
* Free memory resources allocated by library.
* Should be invoked when library is not needed anymore, which is typically
* at application closing time.
* This cleanup is not necessary on most platforms, as memory resources are
* deallocated automatically by operating system.
*
* @retval MWB_RT_OK Success
*/
extern int MWB_cleanupLib(void);
/**
* Retrieves actual detected code type after successful MWB_scanGrayscaleImage
* call. If last call was not successful, it will return FOUND_NONE.
*
* @retval res_types Last decoded type
* @retval MWB_RT_FAIL Library error
*/
int MWB_getLastType(void);
/**
* Retrieves is result of GS1 type
*
* @retval 1 true
* @retval 0 false
* @retval MWB_RT_FAIL Library error
*/
int MWB_isLastGS1(void);
/**
* Main scan function. Invokes all activated decoders by priority.
* For successful scan, allocates pp_data buffer and pass it to user.
* User should deallocate *pp_data pointer when no more needed.
*
* @param[in] pp_image Byte array representing grayscale value of image pixels.
* Array shold be stored in row after row fashion, starting with top row.
* @param[in] lenX X axis size (width) of image.
* @param[in] lenY Y axis size (length) of image.
* @param[out] pp_data On successful decode, library allocates new byte array where it stores decoded
* string result. Pointer to string is passed here. User application is responsible
* for deallocating this buffer after use.
*
* @retval >0 Result string length for successful decode
* @retval MWB_RT_BAD_PARAM Null pointer or out of range parameters
* @retval MWB_RT_NOT_SUPPORTED Unsupported decoder found in execution list - library error
*/
extern int MWB_scanGrayscaleImage(uint8_t* pp_image, int lenX, int lenY, uint8_t **pp_data);
/**
* Multi-regions scan function. Invokes all activated decoders by priority.
* For successful scan, allocates pp_data buffer and pass it to user.
* User should deallocate *pp_data pointer when no more needed.
*
* @param[in] pp_image Byte array representing grayscale value of image pixels.
* Array shold be stored in row after row fashion, starting with top row.
* @param[in] lenX X axis size (width) of image.
* @param[in] lenY Y axis size (length) of image.
* @param[in] regionsData Rectangles data in form of continuous array of left, top, width, height expressed
* in percentages of image size
* @param[in] numberOfRegions Number of rectangles provided in regionsData array
* @param[in] maxThreads Maximum number of threads to be used in decoding
* @param[out] pp_data On successful decode, library allocates new byte array where it stores decoded
* string result. Pointer to string is passed here. User application is responsible
* for deallocating this buffer after use.
*
* @retval >0 Result string length for successful decode
* @retval MWB_RT_BAD_PARAM Null pointer or out of range parameters
* @retval MWB_RT_NOT_SUPPORTED Unsupported decoder found in execution list - library error
* @retval MWB_RT_INVALID_SCANNING_RECTANGLE Scanning rectangle for all active barcodes must be set to 0,0,100,100
*/
extern int MWB_scanGrayscaleRegions(uint8_t* pp_image, int lenX, int lenY, float* regionsData, int numberOfRegions, int maxThreads, uint8_t **pp_data);
/**
* Create multiple regions based on number of tiles by X and Y axes
*
* @param[in] tilesX Number of tiles by X axis
* @param[in] tilesY Number of tiles by Y axis
* @param[in] overlap How much each region should overlap neighbour one, expressed in percentage of image size
* @param[out] regionsData pre-allocated array for regions rectangles, must be of size tilesX * tilesY * 4 at least
*
* @retval >0 Number of regions created
* @retval MWB_RT_BAD_PARAM Null pointer or out of range parameters
*/
extern int MWB_createRegionsFromTiles(int tilesX, int tilesY, int overlap, float *regionsData);
/**
* @brief Configure options for single barcode type.
* @details MWB_setFlags configures options (if any) for decoder type specified in \a codeMask.
* Options are given in \a flags as bitwise OR of option bits. Available options depend on selected decoder type.
* @param[in] codeMask Single decoder type (MWB_CODE_MASK_...)
* @param[in] flags ORed bit mask of selected decoder type options (MWB_FLAG_...)
* @n RSS decoder - no configuration options
* @n Code39 decoder
* @n - MWB_CFG_CODE39_REQ_CHKSUM - Checksum check mandatory
*
* @retval MWB_RT_OK Success
* @retval MWB_RT_FAIL No code found in image
* @retval MWB_RT_BAD_PARAM Flag values out of range
* @retval MWB_RT_NOT_SUPPORTED Flag values not supported for selected decoder
*/
extern int MWB_setFlags(const uint32_t codeMask, const uint32_t flags);
/**
* @brief Enable option for single barcode type (or global one).
* @details MWB_enableFlag configures option (if any) for decoder type specified in \a codeMask.
* Available options depend on selected decoder type.
* @param[in] codeMask Single decoder type (MWB_CODE_MASK_...)
* @param[in] flag Selected decoder type option (MWB_FLAG_...)
* @n RSS decoder - no configuration options
* @n Code39 decoder
* @n - MWB_CFG_CODE39_REQ_CHKSUM - Checksum check mandatory
*
* @retval MWB_RT_OK Success
* @retval MWB_RT_BAD_PARAM Flag value out of range
* @retval MWB_RT_NOT_SUPPORTED Flag value not supported for selected decoder
*/
extern int MWB_enableFlag(const uint32_t codeMask, const uint32_t flag);
/**
* @brief Disable option for single barcode type (or global one).
* @details MWB_disableFlag disable option (if any) for decoder type specified in \a codeMask.
* Available options depend on selected decoder type.
* @param[in] codeMask Single decoder type (MWB_CODE_MASK_...)
* @param[in] flag Selected decoder type option (MWB_FLAG_...)
* @n RSS decoder - no configuration options
* @n Code39 decoder
* @n - MWB_CFG_CODE39_REQ_CHKSUM - Checksum check mandatory
*
* @retval MWB_RT_OK Success
* @retval MWB_RT_BAD_PARAM Flag value out of range
* @retval MWB_RT_NOT_SUPPORTED Flag value not supported for selected decoder
*/
extern int MWB_disableFlag(const uint32_t codeMask, const uint32_t flag);
/**
* @brief Get active flags for single barcode type.
* @details Get active flags for single barcode type.
* @param[in] codeMask Single decoder type (MWB_CODE_MASK_...) or 0 for global flags
*
* @retval MWB_RT_OK Success
*/
extern int MWB_getFlags(const uint32_t codeMask);
/**
* @brief Configure global library effort level
* @details Barcode detector relies on image processing and geometry inerpolation for
* extracting optimal data for decoding. Higher effort level involves more processing
* and intermediate parameter values, thus increasing probability of successful
* detection with low quality images, but also consuming more CPU time.
* Although level is global on library level, each decoder type has its
* own parameter set for each level.
*
* @param[in] level Effort level - available values are 1, 2, 3, 4 and 5.
*
* @retval MWB_RT_OK Success
* @retval MWB_RT_BAD_PARAM Level out of range for selected decoder
*/
extern int MWB_setLevel(const int level);
/**
* @brief Configure scanning direction for 1D barcodes
* @details This function enables some control over scanning lines choice
* for 1D barcodes. By ORing available bit-masks user can add
* one or more direction options to scanning lines set.
* Density of lines and angle step for omni scan can be controlled
* with MWB_setLevel API function. Available options are:
* @n - MWB_SCANDIRECTION_HORIZONTAL - horizontal lines
* @n - MWB_SCANDIRECTION_VERTICAL - vertical lines
* @n - MWB_SCANDIRECTION_OMNI - omnidirectional lines
* @n - MWB_SCANDIRECTION_AUTODETECT - enables BarcodeScanner's
* autodetection of barcode direction
*
* @param[in] direction ORed bit mask of direction modes given with
* MWB_SCANDIRECTION_... bit-masks
*
* @retval MWB_RT_OK Success
* @retval MWB_RT_BAD_PARAM Direction out of range
*/
extern int MWB_setDirection(const uint32_t direction);
/**
* @brief Set minimum result length for single barcode type.
* @details MWB_setMinLength set minimum acceptable result length for decoder type specified in \a codeMask.
* @param[in] codeMask Single decoder type (MWB_CODE_MASK_...)
* @param[in] minLength Minimum length of result
* @n Function is applicable to 1D barcode types with low or non existent error
* @n protection like Code39, Code25, Code 11, Codabar to preven false results
* @n from short bars fragments
*
* @retval MWB_RT_OK Success
* @retval MWB_RT_BAD_PARAM Invalid parameter specified
* @retval MWB_RT_NOT_SUPPORTED Function not supported for specified codeMask
*/
extern int MWB_setMinLength(const uint32_t codeMask, const uint32_t minLength);
/**
* @brief Set custom decoder param.
* @details MWB_setParam set custom decoder param id/value pair for decoder type specified in \a codeMask.
* @param[in] codeMask Single decoder type (MWB_CODE_MASK_...)
* @param[in] paramId ID of param
* @param[in] paramValue Integer value of param
*
* @retval MWB_RT_OK Success
* @retval MWB_RT_BAD_PARAM Invalid parameter specified
* @retval MWB_RT_NOT_SUPPORTED Function not supported for specified codeMask
*/
extern int MWB_setParam(const uint32_t codeMask, const uint32_t paramId, const uint32_t paramValue);
/**
* @brief Get specified decoder param.
* @details MWB_setParam gets specified decoder param id/value pair for decoder type specified in \a codeMask.
* @param[in] codeMask Single decoder type (MWB_CODE_MASK_...)
* @param[in] paramId ID of param
*
* @retval >= 0 Param value
* @retval MWB_RT_BAD_PARAM Invalid parameter specified
* @retval MWB_RT_NOT_SUPPORTED Function not supported for specified codeMask
*/
extern int MWB_getParam(const uint32_t codeMask, const uint32_t paramId);
/**
* Get active scanning direction
*
* @retval ORed bit flags of active scanning directions given with
* MWB_SCANDIRECTION_... bit-masks
*/
extern int MWB_getDirection(void);
/**
* @brief VIN validator
* @details Checks if the input is a valid Vehicle Identification Number
* @param[in] vin String that should be validated
* @param[in] length Length of the string
*
* @retval MWB_RT_OK Valid VIN
* @retval MWB_RT_FAIL Not a valid VIN
*/
extern int MWB_validateVIN(char *vin, int length);
/**
* @brief Barcode location points .
* @details Returns quad points of detected barcode. Currently Works for PDF 417,
* QR, Datamatrix, Aztec and Dotcode
* @param[out] points User provided float buffer to be filled with
* coordinates in order - X1, Y1, X2, Y2, X3, Y3, X4, Y4
* @retval MWB_RT_OK Barcode location points returned
* @retval MWB_RT_FAIL Barcode location points not available
*/
extern int MWB_getBarcodeLocation(float *points);
/**
* @brief Set result type from MWB_scanGrayscaleImage
* @details Users now can choose between getting raw result bytes as a resulf of image scan, or
* byte representation of complex result structure containing all information about the
* scanned barcode.
* @param[in] resultType Type of result returned:
* MWB_RESULT_TYPE_RAW - return raw result bytes
* MWB_RESULT_TYPE_MW - return bytes of MWResult structure - should be
* converted to MWResult object.
*
* @retval MWB_RT_OK Result type set successfuly
* @retval MWB_RT_FAIL Invalid result type specified
*/
extern int MWB_setResultType(const uint32_t resultType);
/**
* @brief Get currently active result type
*/
extern int MWB_getResultType(void);
/*
* Set time in seconds in which decoder will ignore same barcode detected
*/
extern int MWB_setDuplicatesTimeout(uint32_t timeout);
/*
* Set code which would be check for a duplicate
*/
extern void MWB_setDuplicate(uint8_t* barcode, int length);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* _BARCODESCANNER_H_ */