| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344 |
- /*------------------------------------------------------------------------
- * Copyright 2007-2009 (c) Jeff Brown <spadix@users.sourceforge.net>
- *
- * This file is part of the ZBar Bar Code Reader.
- *
- * The ZBar Bar Code Reader is free software; you can redistribute it
- * and/or modify it under the terms of the GNU Lesser Public License as
- * published by the Free Software Foundation; either version 2.1 of
- * the License, or (at your option) any later version.
- *
- * The ZBar Bar Code Reader is distributed in the hope that it will be
- * useful, but WITHOUT ANY WARRANTY; without even the implied warranty
- * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Lesser Public License for more details.
- *
- * You should have received a copy of the GNU Lesser Public License
- * along with the ZBar Bar Code Reader; if not, write to the Free
- * Software Foundation, Inc., 51 Franklin St, Fifth Floor,
- * Boston, MA 02110-1301 USA
- *
- * http://sourceforge.net/projects/zbar
- *------------------------------------------------------------------------*/
- #ifndef _ZBAR_H_
- #define _ZBAR_H_
- #include "stdio.h"
- #include "stdlib.h"
- #include "string.h"
- #include "zbar_config.h"
- #include "cs_types.h"
- #ifdef WIN32
- typedef unsigned int uint32_t;
- typedef unsigned char uint8_t;
- typedef unsigned short uint16_t;
- typedef unsigned int size_t;
- #define inline
- #define HAVE_INTTYPES_H
- #endif
- /** @file
- * ZBar Barcode Reader C API definition
- */
- /** @mainpage
- *
- * interface to the barcode reader is available at several levels.
- * most applications will want to use the high-level interfaces:
- *
- * @section high-level High-Level Interfaces
- *
- * these interfaces wrap all library functionality into an easy-to-use
- * package for a specific toolkit:
- * - the "GTK+ 2.x widget" may be used with GTK GUI applications. a
- * Python wrapper is included for PyGtk
- * - the @ref zbar::QZBar "Qt4 widget" may be used with Qt GUI
- * applications
- * - the Processor interface (in @ref c-processor "C" or @ref
- * zbar::Processor "C++") adds a scanning window to an application
- * with no GUI.
- *
- * @section mid-level Intermediate Interfaces
- *
- * building blocks used to construct high-level interfaces:
- * - the ImageScanner (in @ref c-imagescanner "C" or @ref
- * zbar::ImageScanner "C++") looks for barcodes in a library defined
- * image object
- * - the Window abstraction (in @ref c-window "C" or @ref
- * zbar::Window "C++") sinks library images, displaying them on the
- * platform display
- * - the Video abstraction (in @ref c-video "C" or @ref zbar::Video
- * "C++") sources library images from a video device
- *
- * @section low-level Low-Level Interfaces
- *
- * direct interaction with barcode scanning and decoding:
- * - the Scanner (in @ref c-scanner "C" or @ref zbar::Scanner "C++")
- * looks for barcodes in a linear intensity sample stream
- * - the Decoder (in @ref c-decoder "C" or @ref zbar::Decoder "C++")
- * extracts barcodes from a stream of bar and space widths
- */
- #define INT_MIN (-1<<30)
- #ifdef __cplusplus
- /** C++ namespace for library interfaces */
- namespace zbar {
- extern "C" {
- #endif
- /** @name Global library interfaces */
- /*@{*/
- /** "color" of element: bar or space. */
- typedef enum zbar_color_e {
- ZBAR_SPACE = 0, /**< light area or space between bars */
- ZBAR_BAR = 1, /**< dark area or colored bar segment */
- } zbar_color_t;
- /** decoded symbol type. */
- typedef enum zbar_symbol_type_e {
- ZBAR_NONE = 0, /**< no symbol decoded */
- ZBAR_PARTIAL = 1, /**< intermediate status */
- ZBAR_EAN8 = 8, /**< EAN-8 */
- ZBAR_UPCE = 9, /**< UPC-E */
- ZBAR_ISBN10 = 10, /**< ISBN-10 (from EAN-13). @since 0.4 */
- ZBAR_UPCA = 12, /**< UPC-A */
- ZBAR_EAN13 = 13, /**< EAN-13 */
- ZBAR_ISBN13 = 14, /**< ISBN-13 (from EAN-13). @since 0.4 */
- ZBAR_I25 = 25, /**< Interleaved 2 of 5. @since 0.4 */
- ZBAR_CODE39 = 39, /**< Code 39. @since 0.4 */
- ZBAR_PDF417 = 57, /**< PDF417. @since 0.6 */
- ZBAR_QRCODE = 64, /**< QR Code. @since 0.10 */
- ZBAR_CODE128 = 128, /**< Code 128 */
- ZBAR_SYMBOL = 0x00ff, /**< mask for base symbol type */
- ZBAR_ADDON2 = 0x0200, /**< 2-digit add-on flag */
- ZBAR_ADDON5 = 0x0500, /**< 5-digit add-on flag */
- ZBAR_ADDON = 0x0700, /**< add-on flag mask */
- } zbar_symbol_type_t;
- /** error codes. */
- typedef enum zbar_error_e {
- ZBAR_OK = 0, /**< no error */
- ZBAR_ERR_NOMEM, /**< out of memory */
- ZBAR_ERR_INTERNAL, /**< internal library error */
- ZBAR_ERR_UNSUPPORTED, /**< unsupported request */
- ZBAR_ERR_INVALID, /**< invalid request */
- ZBAR_ERR_SYSTEM, /**< system error */
- ZBAR_ERR_LOCKING, /**< locking error */
- ZBAR_ERR_BUSY, /**< all resources busy */
- ZBAR_ERR_XDISPLAY, /**< X11 display error */
- ZBAR_ERR_XPROTO, /**< X11 protocol error */
- ZBAR_ERR_CLOSED, /**< output window is closed */
- ZBAR_ERR_WINAPI, /**< windows system error */
- ZBAR_ERR_NUM /**< number of error codes */
- } zbar_error_t;
- /** decoder configuration options.
- * @since 0.4
- */
- typedef enum zbar_config_e {
- ZBAR_CFG_ENABLE = 0, /**< enable symbology/feature */
- ZBAR_CFG_ADD_CHECK, /**< enable check digit when optional */
- ZBAR_CFG_EMIT_CHECK, /**< return check digit when present */
- ZBAR_CFG_ASCII, /**< enable full ASCII character set */
- ZBAR_CFG_NUM, /**< number of boolean decoder configs */
- ZBAR_CFG_MIN_LEN = 0x20, /**< minimum data length for valid decode */
- ZBAR_CFG_MAX_LEN, /**< maximum data length for valid decode */
- ZBAR_CFG_POSITION = 0x80, /**< enable scanner to collect position data */
- ZBAR_CFG_X_DENSITY = 0x100, /**< image scanner vertical scan density */
- ZBAR_CFG_Y_DENSITY, /**< image scanner horizontal scan density */
- } zbar_config_t;
- /** retrieve runtime library version information.
- * @param major set to the running major version (unless NULL)
- * @param minor set to the running minor version (unless NULL)
- * @returns 0
- */
- extern int zbar_version(unsigned *major,
- unsigned *minor);
- /** set global library debug level.
- * @param verbosity desired debug level. higher values create more spew
- */
- extern void zbar_set_verbosity(int verbosity);
- /** increase global library debug level.
- * eg, for -vvvv
- */
- extern void zbar_increase_verbosity(void);
- /** retrieve string name for symbol encoding.
- * @param sym symbol type encoding
- * @returns the static string name for the specified symbol type,
- * or "UNKNOWN" if the encoding is not recognized
- */
- extern const char *zbar_get_symbol_name(zbar_symbol_type_t sym);
- /** retrieve string name for addon encoding.
- * @param sym symbol type encoding
- * @returns static string name for any addon, or the empty string
- * if no addons were decoded
- */
- extern const char *zbar_get_addon_name(zbar_symbol_type_t sym);
- /** parse a configuration string of the form "[symbology.]config[=value]".
- * the config must match one of the recognized names.
- * the symbology, if present, must match one of the recognized names.
- * if symbology is unspecified, it will be set to 0.
- * if value is unspecified it will be set to 1.
- * @returns 0 if the config is parsed successfully, 1 otherwise
- * @since 0.4
- */
- extern int zbar_parse_config(const char *config_string,
- zbar_symbol_type_t *symbology,
- zbar_config_t *config,
- int *value);
- /** @internal type unsafe error API (don't use) */
- extern int _zbar_error_spew(const void *object,
- int verbosity);
- extern const char *_zbar_error_string(const void *object,
- int verbosity);
- extern zbar_error_t _zbar_get_error_code(const void *object);
- /*@}*/
- struct zbar_symbol_s;
- typedef struct zbar_symbol_s zbar_symbol_t;
- struct zbar_symbol_set_s;
- typedef struct zbar_symbol_set_s zbar_symbol_set_t;
- /*------------------------------------------------------------*/
- /** @name Symbol interface
- * decoded barcode symbol result object. stores type, data, and image
- * location of decoded symbol. all memory is owned by the library
- */
- /*@{*/
- /** @typedef zbar_symbol_t
- * opaque decoded symbol object.
- */
- /** symbol reference count manipulation.
- * increment the reference count when you store a new reference to the
- * symbol. decrement when the reference is no longer used. do not
- * refer to the symbol once the count is decremented and the
- * containing image has been recycled or destroyed.
- * @note the containing image holds a reference to the symbol, so you
- * only need to use this if you keep a symbol after the image has been
- * destroyed or reused.
- * @since 0.9
- */
- extern void zbar_symbol_ref(const zbar_symbol_t *symbol,
- int refs);
- /** retrieve type of decoded symbol.
- * @returns the symbol type
- */
- extern zbar_symbol_type_t zbar_symbol_get_type(const zbar_symbol_t *symbol);
- /** retrieve data decoded from symbol.
- * @returns the data string
- */
- extern const char *zbar_symbol_get_data(const zbar_symbol_t *symbol);
- /** retrieve length of binary data.
- * @returns the length of the decoded data
- */
- extern unsigned int zbar_symbol_get_data_length(const zbar_symbol_t *symbol);
- /** retrieve a symbol confidence metric.
- * @returns an unscaled, relative quantity: larger values are better
- * than smaller values, where "large" and "small" are application
- * dependent.
- * @note expect the exact definition of this quantity to change as the
- * metric is refined. currently, only the ordered relationship
- * between two values is defined and will remain stable in the future
- * @since 0.9
- */
- extern int zbar_symbol_get_quality(const zbar_symbol_t *symbol);
- /** retrieve current cache count. when the cache is enabled for the
- * image_scanner this provides inter-frame reliability and redundancy
- * information for video streams.
- * @returns < 0 if symbol is still uncertain.
- * @returns 0 if symbol is newly verified.
- * @returns > 0 for duplicate symbols
- */
- extern int zbar_symbol_get_count(const zbar_symbol_t *symbol);
- /** retrieve the number of points in the location polygon. the
- * location polygon defines the image area that the symbol was
- * extracted from.
- * @returns the number of points in the location polygon
- * @note this is currently not a polygon, but the scan locations
- * where the symbol was decoded
- */
- extern unsigned zbar_symbol_get_loc_size(const zbar_symbol_t *symbol);
- /** retrieve location polygon x-coordinates.
- * points are specified by 0-based index.
- * @returns the x-coordinate for a point in the location polygon.
- * @returns -1 if index is out of range
- */
- extern int zbar_symbol_get_loc_x(const zbar_symbol_t *symbol,
- unsigned index);
- /** retrieve location polygon y-coordinates.
- * points are specified by 0-based index.
- * @returns the y-coordinate for a point in the location polygon.
- * @returns -1 if index is out of range
- */
- extern int zbar_symbol_get_loc_y(const zbar_symbol_t *symbol,
- unsigned index);
- /** iterate the set to which this symbol belongs (there can be only one).
- * @returns the next symbol in the set, or
- * @returns NULL when no more results are available
- */
- extern const zbar_symbol_t *zbar_symbol_next(const zbar_symbol_t *symbol);
- /** retrieve components of a composite result.
- * @returns the symbol set containing the components
- * @returns NULL if the symbol is already a physical symbol
- * @since 0.10
- */
- extern const zbar_symbol_set_t*
- zbar_symbol_get_components(const zbar_symbol_t *symbol);
- /** iterate components of a composite result.
- * @returns the first physical component symbol of a composite result
- * @returns NULL if the symbol is already a physical symbol
- * @since 0.10
- */
- extern const zbar_symbol_t*
- zbar_symbol_first_component(const zbar_symbol_t *symbol);
- /** print XML symbol element representation to user result buffer.
- * @see http://zbar.sourceforge.net/2008/barcode.xsd for the schema.
- * @param symbol is the symbol to print
- * @param buffer is the inout result pointer, it will be reallocated
- * with a larger size if necessary.
- * @param buflen is inout length of the result buffer.
- * @returns the buffer pointer
- * @since 0.6
- */
- extern char *zbar_symbol_xml(const zbar_symbol_t *symbol,
- char **buffer,
- unsigned *buflen);
- /*@}*/
- /*------------------------------------------------------------*/
- /** @name Symbol Set interface
- * container for decoded result symbols associated with an image
- * or a composite symbol.
- * @since 0.10
- */
- /*@{*/
- /** @typedef zbar_symbol_set_t
- * opaque symbol iterator object.
- * @since 0.10
- */
- /** reference count manipulation.
- * increment the reference count when you store a new reference.
- * decrement when the reference is no longer used. do not refer to
- * the object any longer once references have been released.
- * @since 0.10
- */
- extern void zbar_symbol_set_ref(const zbar_symbol_set_t *symbols,
- int refs);
- /** retrieve set size.
- * @returns the number of symbols in the set.
- * @since 0.10
- */
- extern int zbar_symbol_set_get_size(const zbar_symbol_set_t *symbols);
- /** set iterator.
- * @returns the first decoded symbol result in a set
- * @returns NULL if the set is empty
- * @since 0.10
- */
- extern const zbar_symbol_t*
- zbar_symbol_set_first_symbol(const zbar_symbol_set_t *symbols);
- /*@}*/
- /*------------------------------------------------------------*/
- /** @name Image interface
- * stores image data samples along with associated format and size
- * metadata
- */
- /*@{*/
- struct zbar_image_s;
- /** opaque image object. */
- typedef struct zbar_image_s zbar_image_t;
- /** cleanup handler callback function.
- * called to free sample data when an image is destroyed.
- */
- typedef void (zbar_image_cleanup_handler_t)(zbar_image_t *image);
- /** data handler callback function.
- * called when decoded symbol results are available for an image
- */
- typedef void (zbar_image_data_handler_t)(zbar_image_t *image,
- const void *userdata);
- /** new image constructor.
- * @returns a new image object with uninitialized data and format.
- * this image should be destroyed (using zbar_image_destroy()) as
- * soon as the application is finished with it
- */
- extern zbar_image_t *zbar_image_create(void);
- /** image destructor. all images created by or returned to the
- * application should be destroyed using this function. when an image
- * is destroyed, the associated data cleanup handler will be invoked
- * if available
- * @note make no assumptions about the image or the data buffer.
- * they may not be destroyed/cleaned immediately if the library
- * is still using them. if necessary, use the cleanup handler hook
- * to keep track of image data buffers
- */
- extern void zbar_image_destroy(zbar_image_t *image);
- /** image reference count manipulation.
- * increment the reference count when you store a new reference to the
- * image. decrement when the reference is no longer used. do not
- * refer to the image any longer once the count is decremented.
- * zbar_image_ref(image, -1) is the same as zbar_image_destroy(image)
- * @since 0.5
- */
- extern void zbar_image_ref(zbar_image_t *image,
- int refs);
- /** image format conversion. refer to the documentation for supported
- * image formats
- * @returns a @em new image with the sample data from the original image
- * converted to the requested format. the original image is
- * unaffected.
- * @note the converted image size may be rounded (up) due to format
- * constraints
- */
- extern zbar_image_t *zbar_image_convert(const zbar_image_t *image,
- unsigned long format);
- /** image format conversion with crop/pad.
- * if the requested size is larger than the image, the last row/column
- * are duplicated to cover the difference. if the requested size is
- * smaller than the image, the extra rows/columns are dropped from the
- * right/bottom.
- * @returns a @em new image with the sample data from the original
- * image converted to the requested format and size.
- * @note the image is @em not scaled
- * @see zbar_image_convert()
- * @since 0.4
- */
- extern zbar_image_t *zbar_image_convert_resize(const zbar_image_t *image,
- unsigned long format,
- unsigned width,
- unsigned height);
- /** retrieve the image format.
- * @returns the fourcc describing the format of the image sample data
- */
- extern unsigned long zbar_image_get_format(const zbar_image_t *image);
- /** retrieve a "sequence" (page/frame) number associated with this image.
- * @since 0.6
- */
- extern unsigned zbar_image_get_sequence(const zbar_image_t *image);
- /** retrieve the width of the image.
- * @returns the width in sample columns
- */
- extern unsigned zbar_image_get_width(const zbar_image_t *image);
- /** retrieve the height of the image.
- * @returns the height in sample rows
- */
- extern unsigned zbar_image_get_height(const zbar_image_t *image);
- /** return the image sample data. the returned data buffer is only
- * valid until zbar_image_destroy() is called
- */
- extern const void *zbar_image_get_data(const zbar_image_t *image);
- /** return the size of image data.
- * @since 0.6
- */
- extern unsigned long zbar_image_get_data_length(const zbar_image_t *img);
- /** retrieve the decoded results.
- * @returns the (possibly empty) set of decoded symbols
- * @returns NULL if the image has not been scanned
- * @since 0.10
- */
- extern const zbar_symbol_set_t*
- zbar_image_get_symbols(const zbar_image_t *image);
- /** associate the specified symbol set with the image, replacing any
- * existing results. use NULL to release the current results from the
- * image.
- * @see zbar_image_scanner_recycle_image()
- * @since 0.10
- */
- extern void zbar_image_set_symbols(zbar_image_t *image,
- const zbar_symbol_set_t *symbols);
- /** image_scanner decode result iterator.
- * @returns the first decoded symbol result for an image
- * or NULL if no results are available
- */
- extern const zbar_symbol_t*
- zbar_image_first_symbol(const zbar_image_t *image);
- /** specify the fourcc image format code for image sample data.
- * refer to the documentation for supported formats.
- * @note this does not convert the data!
- * (see zbar_image_convert() for that)
- */
- extern void zbar_image_set_format(zbar_image_t *image,
- unsigned long format);
- /** associate a "sequence" (page/frame) number with this image.
- * @since 0.6
- */
- extern void zbar_image_set_sequence(zbar_image_t *image,
- unsigned sequence_num);
- /** specify the pixel size of the image.
- * @note this does not affect the data!
- */
- extern void zbar_image_set_size(zbar_image_t *image,
- unsigned width,
- unsigned height);
- /** specify image sample data. when image data is no longer needed by
- * the library the specific data cleanup handler will be called
- * (unless NULL)
- * @note application image data will not be modified by the library
- */
- extern void zbar_image_set_data(zbar_image_t *image,
- const void *data,
- unsigned long data_byte_length,
- zbar_image_cleanup_handler_t *cleanup_hndlr);
- /** built-in cleanup handler.
- * passes the image data buffer to free()
- */
- extern void zbar_image_free_data(zbar_image_t *image);
- /** associate user specified data value with an image.
- * @since 0.5
- */
- extern void zbar_image_set_userdata(zbar_image_t *image,
- void *userdata);
- /** return user specified data value associated with the image.
- * @since 0.5
- */
- extern void *zbar_image_get_userdata(const zbar_image_t *image);
- /** dump raw image data to a file for debug.
- * the data will be prefixed with a 16 byte header consisting of:
- * - 4 bytes uint = 0x676d697a ("zimg")
- * - 4 bytes format fourcc
- * - 2 bytes width
- * - 2 bytes height
- * - 4 bytes size of following image data in bytes
- * this header can be dumped w/eg:
- * @verbatim
- od -Ax -tx1z -N16 -w4 [file]
- @endverbatim
- * for some formats the image can be displayed/converted using
- * ImageMagick, eg:
- * @verbatim
- display -size 640x480+16 [-depth ?] [-sampling-factor ?x?] \
- {GRAY,RGB,UYVY,YUV}:[file]
- @endverbatim
- *
- * @param image the image object to dump
- * @param filebase base filename, appended with ".XXXX.zimg" where
- * XXXX is the format fourcc
- * @returns 0 on success or a system error code on failure
- */
- extern int zbar_image_write(const zbar_image_t *image,
- const char *filebase);
- /** read back an image in the format written by zbar_image_write()
- * @note TBD
- */
- extern zbar_image_t *zbar_image_read(char *filename);
- /*@}*/
- /*------------------------------------------------------------*/
- /** @name Processor interface
- * @anchor c-processor
- * high-level self-contained image processor.
- * processes video and images for barcodes, optionally displaying
- * images to a library owned output window
- */
- /*@{*/
- struct zbar_processor_s;
- /** opaque standalone processor object. */
- typedef struct zbar_processor_s zbar_processor_t;
- /** constructor.
- * if threaded is set and threading is available the processor
- * will spawn threads where appropriate to avoid blocking and
- * improve responsiveness
- */
- extern zbar_processor_t *zbar_processor_create(int threaded);
- /** destructor. cleans up all resources associated with the processor
- */
- extern void zbar_processor_destroy(zbar_processor_t *processor);
- /** (re)initialization.
- * opens a video input device and/or prepares to display output
- */
- extern int zbar_processor_init(zbar_processor_t *processor,
- const char *video_device,
- int enable_display);
- /** request a preferred size for the video image from the device.
- * the request may be adjusted or completely ignored by the driver.
- * @note must be called before zbar_processor_init()
- * @since 0.6
- */
- extern int zbar_processor_request_size(zbar_processor_t *processor,
- unsigned width,
- unsigned height);
- /** request a preferred video driver interface version for
- * debug/testing.
- * @note must be called before zbar_processor_init()
- * @since 0.6
- */
- extern int zbar_processor_request_interface(zbar_processor_t *processor,
- int version);
- /** request a preferred video I/O mode for debug/testing. You will
- * get errors if the driver does not support the specified mode.
- * @verbatim
- 0 = auto-detect
- 1 = force I/O using read()
- 2 = force memory mapped I/O using mmap()
- 3 = force USERPTR I/O (v4l2 only)
- @endverbatim
- * @note must be called before zbar_processor_init()
- * @since 0.7
- */
- extern int zbar_processor_request_iomode(zbar_processor_t *video,
- int iomode);
- /** force specific input and output formats for debug/testing.
- * @note must be called before zbar_processor_init()
- */
- extern int zbar_processor_force_format(zbar_processor_t *processor,
- unsigned long input_format,
- unsigned long output_format);
- /** setup result handler callback.
- * the specified function will be called by the processor whenever
- * new results are available from the video stream or a static image.
- * pass a NULL value to disable callbacks.
- * @param processor the object on which to set the handler.
- * @param handler the function to call when new results are available.
- * @param userdata is set as with zbar_processor_set_userdata().
- * @returns the previously registered handler
- */
- extern zbar_image_data_handler_t*
- zbar_processor_set_data_handler(zbar_processor_t *processor,
- zbar_image_data_handler_t *handler,
- const void *userdata);
- /** associate user specified data value with the processor.
- * @since 0.6
- */
- extern void zbar_processor_set_userdata(zbar_processor_t *processor,
- void *userdata);
- /** return user specified data value associated with the processor.
- * @since 0.6
- */
- extern void *zbar_processor_get_userdata(const zbar_processor_t *processor);
- /** set config for indicated symbology (0 for all) to specified value.
- * @returns 0 for success, non-0 for failure (config does not apply to
- * specified symbology, or value out of range)
- * @see zbar_decoder_set_config()
- * @since 0.4
- */
- extern int zbar_processor_set_config(zbar_processor_t *processor,
- zbar_symbol_type_t symbology,
- zbar_config_t config,
- int value);
- /** parse configuration string using zbar_parse_config()
- * and apply to processor using zbar_processor_set_config().
- * @returns 0 for success, non-0 for failure
- * @see zbar_parse_config()
- * @see zbar_processor_set_config()
- * @since 0.4
- */
- static inline int zbar_processor_parse_config (zbar_processor_t *processor,
- const char *config_string)
- {
- zbar_symbol_type_t sym;
- zbar_config_t cfg;
- int val;
- return(zbar_parse_config(config_string, &sym, &cfg, &val) ||
- zbar_processor_set_config(processor, sym, cfg, val));
- }
- /** retrieve the current state of the ouput window.
- * @returns 1 if the output window is currently displayed, 0 if not.
- * @returns -1 if an error occurs
- */
- extern int zbar_processor_is_visible(zbar_processor_t *processor);
- /** show or hide the display window owned by the library.
- * the size will be adjusted to the input size
- */
- extern int zbar_processor_set_visible(zbar_processor_t *processor,
- int visible);
- /** control the processor in free running video mode.
- * only works if video input is initialized. if threading is in use,
- * scanning will occur in the background, otherwise this is only
- * useful wrapping calls to zbar_processor_user_wait(). if the
- * library output window is visible, video display will be enabled.
- */
- extern int zbar_processor_set_active(zbar_processor_t *processor,
- int active);
- /** retrieve decode results for last scanned image/frame.
- * @returns the symbol set result container or NULL if no results are
- * available
- * @note the returned symbol set has its reference count incremented;
- * ensure that the count is decremented after use
- * @since 0.10
- */
- extern const zbar_symbol_set_t*
- zbar_processor_get_results(const zbar_processor_t *processor);
- /** wait for input to the display window from the user
- * (via mouse or keyboard).
- * @returns >0 when input is received, 0 if timeout ms expired
- * with no input or -1 in case of an error
- */
- extern int zbar_processor_user_wait(zbar_processor_t *processor,
- int timeout);
- /** process from the video stream until a result is available,
- * or the timeout (in milliseconds) expires.
- * specify a timeout of -1 to scan indefinitely
- * (zbar_processor_set_active() may still be used to abort the scan
- * from another thread).
- * if the library window is visible, video display will be enabled.
- * @note that multiple results may still be returned (despite the
- * name).
- * @returns >0 if symbols were successfully decoded,
- * 0 if no symbols were found (ie, the timeout expired)
- * or -1 if an error occurs
- */
- extern int zbar_process_one(zbar_processor_t *processor,
- int timeout);
- /** process the provided image for barcodes.
- * if the library window is visible, the image will be displayed.
- * @returns >0 if symbols were successfully decoded,
- * 0 if no symbols were found or -1 if an error occurs
- */
- extern int zbar_process_image(zbar_processor_t *processor,
- zbar_image_t *image);
- /** display detail for last processor error to stderr.
- * @returns a non-zero value suitable for passing to exit()
- */
- static inline int
- zbar_processor_error_spew (const zbar_processor_t *processor,
- int verbosity)
- {
- return(_zbar_error_spew(processor, verbosity));
- }
- /** retrieve the detail string for the last processor error. */
- static inline const char*
- zbar_processor_error_string (const zbar_processor_t *processor,
- int verbosity)
- {
- return(_zbar_error_string(processor, verbosity));
- }
- /** retrieve the type code for the last processor error. */
- static inline zbar_error_t
- zbar_processor_get_error_code (const zbar_processor_t *processor)
- {
- return(_zbar_get_error_code(processor));
- }
- /*@}*/
- /*------------------------------------------------------------*/
- /** @name Video interface
- * @anchor c-video
- * mid-level video source abstraction.
- * captures images from a video device
- */
- /*@{*/
- struct zbar_video_s;
- /** opaque video object. */
- typedef struct zbar_video_s zbar_video_t;
- /** constructor. */
- extern zbar_video_t *zbar_video_create(void);
- /** destructor. */
- extern void zbar_video_destroy(zbar_video_t *video);
- /** open and probe a video device.
- * the device specified by platform specific unique name
- * (v4l device node path in *nix eg "/dev/video",
- * DirectShow DevicePath property in windows).
- * @returns 0 if successful or -1 if an error occurs
- */
- extern int zbar_video_open(zbar_video_t *video,
- const char *device);
- /** retrieve file descriptor associated with open *nix video device
- * useful for using select()/poll() to tell when new images are
- * available (NB v4l2 only!!).
- * @returns the file descriptor or -1 if the video device is not open
- * or the driver only supports v4l1
- */
- extern int zbar_video_get_fd(const zbar_video_t *video);
- /** request a preferred size for the video image from the device.
- * the request may be adjusted or completely ignored by the driver.
- * @returns 0 if successful or -1 if the video device is already
- * initialized
- * @since 0.6
- */
- extern int zbar_video_request_size(zbar_video_t *video,
- unsigned width,
- unsigned height);
- /** request a preferred driver interface version for debug/testing.
- * @note must be called before zbar_video_open()
- * @since 0.6
- */
- extern int zbar_video_request_interface(zbar_video_t *video,
- int version);
- /** request a preferred I/O mode for debug/testing. You will get
- * errors if the driver does not support the specified mode.
- * @verbatim
- 0 = auto-detect
- 1 = force I/O using read()
- 2 = force memory mapped I/O using mmap()
- 3 = force USERPTR I/O (v4l2 only)
- @endverbatim
- * @note must be called before zbar_video_open()
- * @since 0.7
- */
- extern int zbar_video_request_iomode(zbar_video_t *video,
- int iomode);
- /** retrieve current output image width.
- * @returns the width or 0 if the video device is not open
- */
- extern int zbar_video_get_width(const zbar_video_t *video);
- /** retrieve current output image height.
- * @returns the height or 0 if the video device is not open
- */
- extern int zbar_video_get_height(const zbar_video_t *video);
- /** initialize video using a specific format for debug.
- * use zbar_negotiate_format() to automatically select and initialize
- * the best available format
- */
- extern int zbar_video_init(zbar_video_t *video,
- unsigned long format);
- /** start/stop video capture.
- * all buffered images are retired when capture is disabled.
- * @returns 0 if successful or -1 if an error occurs
- */
- extern int zbar_video_enable(zbar_video_t *video,
- int enable);
- /** retrieve next captured image. blocks until an image is available.
- * @returns NULL if video is not enabled or an error occurs
- */
- extern zbar_image_t *zbar_video_next_image(zbar_video_t *video);
- /** display detail for last video error to stderr.
- * @returns a non-zero value suitable for passing to exit()
- */
- static inline int zbar_video_error_spew (const zbar_video_t *video,
- int verbosity)
- {
- return(_zbar_error_spew(video, verbosity));
- }
- /** retrieve the detail string for the last video error. */
- static inline const char *zbar_video_error_string (const zbar_video_t *video,
- int verbosity)
- {
- return(_zbar_error_string(video, verbosity));
- }
- /** retrieve the type code for the last video error. */
- static inline zbar_error_t
- zbar_video_get_error_code (const zbar_video_t *video)
- {
- return(_zbar_get_error_code(video));
- }
- /*@}*/
- /*------------------------------------------------------------*/
- /** @name Window interface
- * @anchor c-window
- * mid-level output window abstraction.
- * displays images to user-specified platform specific output window
- */
- /*@{*/
- struct zbar_window_s;
- /** opaque window object. */
- typedef struct zbar_window_s zbar_window_t;
- /** constructor. */
- extern zbar_window_t *zbar_window_create(void);
- /** destructor. */
- extern void zbar_window_destroy(zbar_window_t *window);
- /** associate reader with an existing platform window.
- * This can be any "Drawable" for X Windows or a "HWND" for windows.
- * input images will be scaled into the output window.
- * pass NULL to detach from the resource, further input will be
- * ignored
- */
- extern int zbar_window_attach(zbar_window_t *window,
- void *x11_display_w32_hwnd,
- unsigned long x11_drawable);
- /** control content level of the reader overlay.
- * the overlay displays graphical data for informational or debug
- * purposes. higher values increase the level of annotation (possibly
- * decreasing performance). @verbatim
- 0 = disable overlay
- 1 = outline decoded symbols (default)
- 2 = also track and display input frame rate
- @endverbatim
- */
- extern void zbar_window_set_overlay(zbar_window_t *window,
- int level);
- /** retrieve current content level of reader overlay.
- * @see zbar_window_set_overlay()
- * @since 0.10
- */
- extern int zbar_window_get_overlay(const zbar_window_t *window);
- /** draw a new image into the output window. */
- extern int zbar_window_draw(zbar_window_t *window,
- zbar_image_t *image);
- /** redraw the last image (exposure handler). */
- extern int zbar_window_redraw(zbar_window_t *window);
- /** resize the image window (reconfigure handler).
- * this does @em not update the contents of the window
- * @since 0.3, changed in 0.4 to not redraw window
- */
- extern int zbar_window_resize(zbar_window_t *window,
- unsigned width,
- unsigned height);
- /** display detail for last window error to stderr.
- * @returns a non-zero value suitable for passing to exit()
- */
- static inline int zbar_window_error_spew (const zbar_window_t *window,
- int verbosity)
- {
- return(_zbar_error_spew(window, verbosity));
- }
- /** retrieve the detail string for the last window error. */
- static inline const char*
- zbar_window_error_string (const zbar_window_t *window,
- int verbosity)
- {
- return(_zbar_error_string(window, verbosity));
- }
- /** retrieve the type code for the last window error. */
- static inline zbar_error_t
- zbar_window_get_error_code (const zbar_window_t *window)
- {
- return(_zbar_get_error_code(window));
- }
- /** select a compatible format between video input and output window.
- * the selection algorithm attempts to use a format shared by
- * video input and window output which is also most useful for
- * barcode scanning. if a format conversion is necessary, it will
- * heuristically attempt to minimize the cost of the conversion
- */
- extern int zbar_negotiate_format(zbar_video_t *video,
- zbar_window_t *window);
- /*@}*/
- /*------------------------------------------------------------*/
- /** @name Image Scanner interface
- * @anchor c-imagescanner
- * mid-level image scanner interface.
- * reads barcodes from 2-D images
- */
- /*@{*/
- struct zbar_image_scanner_s;
- /** opaque image scanner object. */
- typedef struct zbar_image_scanner_s zbar_image_scanner_t;
- /** constructor. */
- extern zbar_image_scanner_t *zbar_image_scanner_create(void);
- /** destructor. */
- extern void zbar_image_scanner_destroy(zbar_image_scanner_t *scanner);
- /** setup result handler callback.
- * the specified function will be called by the scanner whenever
- * new results are available from a decoded image.
- * pass a NULL value to disable callbacks.
- * @returns the previously registered handler
- */
- extern zbar_image_data_handler_t*
- zbar_image_scanner_set_data_handler(zbar_image_scanner_t *scanner,
- zbar_image_data_handler_t *handler,
- const void *userdata);
- /** set config for indicated symbology (0 for all) to specified value.
- * @returns 0 for success, non-0 for failure (config does not apply to
- * specified symbology, or value out of range)
- * @see zbar_decoder_set_config()
- * @since 0.4
- */
- extern int zbar_image_scanner_set_config(zbar_image_scanner_t *scanner,
- zbar_symbol_type_t symbology,
- zbar_config_t config,
- int value);
- /** parse configuration string using zbar_parse_config()
- * and apply to image scanner using zbar_image_scanner_set_config().
- * @returns 0 for success, non-0 for failure
- * @see zbar_parse_config()
- * @see zbar_image_scanner_set_config()
- * @since 0.4
- */
- static inline int
- zbar_image_scanner_parse_config (zbar_image_scanner_t *scanner,
- const char *config_string)
- {
- zbar_symbol_type_t sym;
- zbar_config_t cfg;
- int val;
- return(zbar_parse_config(config_string, &sym, &cfg, &val) ||
- zbar_image_scanner_set_config(scanner, sym, cfg, val));
- }
- /** enable or disable the inter-image result cache (default disabled).
- * mostly useful for scanning video frames, the cache filters
- * duplicate results from consecutive images, while adding some
- * consistency checking and hysteresis to the results.
- * this interface also clears the cache
- */
- extern void zbar_image_scanner_enable_cache(zbar_image_scanner_t *scanner,
- int enable);
- /** remove any previously decoded results from the image scanner and the
- * specified image. somewhat more efficient version of
- * zbar_image_set_symbols(image, NULL) which may retain memory for
- * subsequent decodes
- * @since 0.10
- */
- extern void zbar_image_scanner_recycle_image(zbar_image_scanner_t *scanner,
- zbar_image_t *image);
- /** retrieve decode results for last scanned image.
- * @returns the symbol set result container or NULL if no results are
- * available
- * @note the symbol set does not have its reference count adjusted;
- * ensure that the count is incremented if the results may be kept
- * after the next image is scanned
- * @since 0.10
- */
- extern const zbar_symbol_set_t*
- zbar_image_scanner_get_results(const zbar_image_scanner_t *scanner);
- /** scan for symbols in provided image. The image format must be
- * "Y800" or "GRAY".
- * @returns >0 if symbols were successfully decoded from the image,
- * 0 if no symbols were found or -1 if an error occurs
- * @see zbar_image_convert()
- * @since 0.9 - changed to only accept grayscale images
- */
- extern int zbar_scan_image(zbar_image_scanner_t *scanner,
- zbar_image_t *image);
- /*@}*/
- /*------------------------------------------------------------*/
- /** @name Decoder interface
- * @anchor c-decoder
- * low-level bar width stream decoder interface.
- * identifies symbols and extracts encoded data
- */
- /*@{*/
- struct zbar_decoder_s;
- /** opaque decoder object. */
- typedef struct zbar_decoder_s zbar_decoder_t;
- /** decoder data handler callback function.
- * called by decoder when new data has just been decoded
- */
- typedef void (zbar_decoder_handler_t)(zbar_decoder_t *decoder);
- /** constructor. */
- extern zbar_decoder_t *zbar_decoder_create(void);
- /** destructor. */
- extern void zbar_decoder_destroy(zbar_decoder_t *decoder);
- /** set config for indicated symbology (0 for all) to specified value.
- * @returns 0 for success, non-0 for failure (config does not apply to
- * specified symbology, or value out of range)
- * @since 0.4
- */
- extern int zbar_decoder_set_config(zbar_decoder_t *decoder,
- zbar_symbol_type_t symbology,
- zbar_config_t config,
- int value);
- /** parse configuration string using zbar_parse_config()
- * and apply to decoder using zbar_decoder_set_config().
- * @returns 0 for success, non-0 for failure
- * @see zbar_parse_config()
- * @see zbar_decoder_set_config()
- * @since 0.4
- */
- static inline int zbar_decoder_parse_config (zbar_decoder_t *decoder,
- const char *config_string)
- {
- zbar_symbol_type_t sym;
- zbar_config_t cfg;
- int val;
- return(zbar_parse_config(config_string, &sym, &cfg, &val) ||
- zbar_decoder_set_config(decoder, sym, cfg, val));
- }
- /** clear all decoder state.
- * any partial symbols are flushed
- */
- extern void zbar_decoder_reset(zbar_decoder_t *decoder);
- /** mark start of a new scan pass.
- * clears any intra-symbol state and resets color to ::ZBAR_SPACE.
- * any partially decoded symbol state is retained
- */
- extern void zbar_decoder_new_scan(zbar_decoder_t *decoder);
- /** process next bar/space width from input stream.
- * the width is in arbitrary relative units. first value of a scan
- * is ::ZBAR_SPACE width, alternating from there.
- * @returns appropriate symbol type if width completes
- * decode of a symbol (data is available for retrieval)
- * @returns ::ZBAR_PARTIAL as a hint if part of a symbol was decoded
- * @returns ::ZBAR_NONE (0) if no new symbol data is available
- */
- extern zbar_symbol_type_t zbar_decode_width(zbar_decoder_t *decoder,
- unsigned width);
- /** retrieve color of @em next element passed to
- * zbar_decode_width(). */
- extern zbar_color_t zbar_decoder_get_color(const zbar_decoder_t *decoder);
- /** retrieve last decoded data.
- * @returns the data string or NULL if no new data available.
- * the returned data buffer is owned by library, contents are only
- * valid between non-0 return from zbar_decode_width and next library
- * call
- */
- extern const char *zbar_decoder_get_data(const zbar_decoder_t *decoder);
- /** retrieve length of binary data.
- * @returns the length of the decoded data or 0 if no new data
- * available.
- */
- extern unsigned int
- zbar_decoder_get_data_length(const zbar_decoder_t *decoder);
- /** retrieve last decoded symbol type.
- * @returns the type or ::ZBAR_NONE if no new data available
- */
- extern zbar_symbol_type_t
- zbar_decoder_get_type(const zbar_decoder_t *decoder);
- /** setup data handler callback.
- * the registered function will be called by the decoder
- * just before zbar_decode_width() returns a non-zero value.
- * pass a NULL value to disable callbacks.
- * @returns the previously registered handler
- */
- extern zbar_decoder_handler_t*
- zbar_decoder_set_handler(zbar_decoder_t *decoder,
- zbar_decoder_handler_t *handler);
- /** associate user specified data value with the decoder. */
- extern void zbar_decoder_set_userdata(zbar_decoder_t *decoder,
- void *userdata);
- /** return user specified data value associated with the decoder. */
- extern void *zbar_decoder_get_userdata(const zbar_decoder_t *decoder);
- /*@}*/
- /*------------------------------------------------------------*/
- /** @name Scanner interface
- * @anchor c-scanner
- * low-level linear intensity sample stream scanner interface.
- * identifies "bar" edges and measures width between them.
- * optionally passes to bar width decoder
- */
- /*@{*/
- struct zbar_scanner_s;
- /** opaque scanner object. */
- typedef struct zbar_scanner_s zbar_scanner_t;
- /** constructor.
- * if decoder is non-NULL it will be attached to scanner
- * and called automatically at each new edge
- * current color is initialized to ::ZBAR_SPACE
- * (so an initial BAR->SPACE transition may be discarded)
- */
- extern zbar_scanner_t *zbar_scanner_create(zbar_decoder_t *decoder);
- /** destructor. */
- extern void zbar_scanner_destroy(zbar_scanner_t *scanner);
- /** clear all scanner state.
- * also resets an associated decoder
- */
- extern zbar_symbol_type_t zbar_scanner_reset(zbar_scanner_t *scanner);
- /** mark start of a new scan pass. resets color to ::ZBAR_SPACE.
- * also updates an associated decoder.
- * @returns any decode results flushed from the pipeline
- * @note when not using callback handlers, the return value should
- * be checked the same as zbar_scan_y()
- * @note call zbar_scanner_flush() at least twice before calling this
- * method to ensure no decode results are lost
- */
- extern zbar_symbol_type_t zbar_scanner_new_scan(zbar_scanner_t *scanner);
- /** flush scanner processing pipeline.
- * forces current scanner position to be a scan boundary.
- * call multiple times (max 3) to completely flush decoder.
- * @returns any decode/scan results flushed from the pipeline
- * @note when not using callback handlers, the return value should
- * be checked the same as zbar_scan_y()
- * @since 0.9
- */
- extern zbar_symbol_type_t zbar_scanner_flush(zbar_scanner_t *scanner);
- /** process next sample intensity value.
- * intensity (y) is in arbitrary relative units.
- * @returns result of zbar_decode_width() if a decoder is attached,
- * otherwise @returns (::ZBAR_PARTIAL) when new edge is detected
- * or 0 (::ZBAR_NONE) if no new edge is detected
- */
- extern zbar_symbol_type_t zbar_scan_y(zbar_scanner_t *scanner,
- int y);
- /** process next sample from RGB (or BGR) triple. */
- static inline zbar_symbol_type_t zbar_scan_rgb24 (zbar_scanner_t *scanner,
- unsigned char *rgb)
- {
- return(zbar_scan_y(scanner, rgb[0] + rgb[1] + rgb[2]));
- }
- /** retrieve last scanned width. */
- extern unsigned zbar_scanner_get_width(const zbar_scanner_t *scanner);
- /** retrieve sample position of last edge.
- * @since 0.10
- */
- extern unsigned zbar_scanner_get_edge(const zbar_scanner_t *scn,
- unsigned offset,
- int prec);
- /** retrieve last scanned color. */
- extern zbar_color_t zbar_scanner_get_color(const zbar_scanner_t *scanner);
- /*@}*/
- #ifdef __cplusplus
- }
- }
- # include "zbar/Exception.h"
- # include "zbar/Decoder.h"
- # include "zbar/Scanner.h"
- # include "zbar/Symbol.h"
- # include "zbar/Image.h"
- # include "zbar/ImageScanner.h"
- # include "zbar/Video.h"
- # include "zbar/Window.h"
- # include "zbar/Processor.h"
- #endif
- typedef struct
- {
- zbar_image_scanner_t *scanner;
- zbar_image_t *image;
- zbar_symbol_t *symbol;
- }zbar_t;
- zbar_t *zbar_create(void);
- //输入灰度图像点阵,zbar解码,并设置好第一个解出来的数据信息,返回0表示没有解码出数据,其他有数据
- int zbar_run(zbar_t *zbar, int width, int height, void *src);
- //获取解出来的数据,len返回数据长度,函数返回数据内存指针
- char *zbar_get_data_ptr(zbar_t *zbar, unsigned int *len);
- //设置好下一个解出来的数据信息,返回0表示没有数据了,其他有数据
- int zbar_find_next_data(zbar_t *zbar);
- void zbar_destory(zbar_t *zbar);
- void zbar_run_demo(void);
- #endif
|