Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

barcode::zbar::processor(3pm) [debian man page]

ZBar::Processor(3pm)					User Contributed Perl Documentation				      ZBar::Processor(3pm)

NAME

       Barcode::ZBar::Processor - self-contained bar code reader

SYNOPSIS

       setup:

	   use Barcode::ZBar;

	   my $reader = Barcode::ZBar::Processor->new();
	   $reader->init("/dev/video1", 1);
	   $reader->parse_config('code39.disable');
	   $reader->set_data_handler(&my_handler);

       scan an image:

	   $reader->process_image($image);

       scan from video:

	   $reader->set_visible();
	   $reader->set_active();
	   $reader->user_wait();

DESCRIPTION

       A Barcode::ZBar::Processor may be used to quickly create stand-alone bar code scanning applications.  It has interfaces to scan images or
       video and to optionally display a video/image preview to a window.

       This interface is not well suited for integration with an existing GUI, as the library manages the optional preview window and any user
       interaction.  Use a Barcode::ZBar::ImageScanner or Investigate the avilable widget interfaces for GUI applications.

REFERENCE

   Methods
       new()
	   Create a new bar code reader instance.

       init([video_device], [enable_display])
	   Open a video input device and/or prepare to display output.

       set_data_handler([handler], [closure])
	   Setup a callback to process results whenever new results are available from the video stream or a static image.  The specified callable
	   will be invoked with the associated Barcode::ZBar::Processor object and closure as arguments.  Closure may be achieved either using
	   standard Perl closure or by manually passing a scalar via closure.

       is_visible()
       set_visible([visible])
	   Test/set visibility of the output window.

       set_active([active])
	   Enable/disable video streaming and scanning for bar codes.

       get_results()
	   Return a list of Barcode::ZBar::Symbol results from the last scanned image or video frame.

       user_wait([timeout])
	   Wait for the user to press a key/button or close the window.  Bar codes will continue to be processed if video is active.

       process_one([timeout])
	   Enable video and scan until at least one barcode is found.  Note that multiple results may still be returned.

       process_image([image])
	   Scan a Barcode::ZBar::Image for bar codes.

       parse_config(configstr)
	   Apply a decoder configuration setting.  See the documentation for "zbarcam"/"zbarimg" for available configuration options.

       request_size(width, height)
	   Request a preferred size for the video image from the device.  The request may be adjusted or completely ignored by the driver.  Must
	   be called before "init()"

SEE ALSO

       Barcode::ZBar, Barcode::ZBar::Image, Barcode::ZBar::ImageScanner

       zbarimg(1), zbarcam(1)

       http://zbar.sf.net

AUTHOR

       Jeff Brown, <spadix@users.sourceforge.net>

COPYRIGHT AND LICENSE

       Copyright 2008-2009 (c) Jeff Brown <spadix@users.sourceforge.net>

       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.

perl v5.14.2							    2009-10-23						      ZBar::Processor(3pm)

Check Out this Related Man Page

ZBar::Image(3pm)					User Contributed Perl Documentation					  ZBar::Image(3pm)

NAME

       Barcode::ZBar::Image - image object to scan for bar codes

SYNOPSIS

	   use Barcode::ZBar;

	   my $image = Barcode::ZBar::Image->new();
	   $image->set_format('422P');
	   $image->set_size(114, 80);
	   $image->set_data($raw_bits);

	   my @symbols = $image->get_symbols();

DESCRIPTION

       Barcode::ZBar::Image is used to pass images to the bar code scanner.  It wraps raw image data with the meta-data required to interpret it
       (size, pixel format, etc)

   Image Formats
       Image data formats are represented by (relatively) standard "Four Character Codes" (fourcc), represented by four character strings in Perl.
       A list of supported formats is available on the project wiki.

       Examples:

       o 'GREY' - single 8bpp intensity plane

       o 'BGR3' - 24bpp packed RGB component format

       o 'YUYV' - 12bpp packed luminance/chrominance (YCbCr) format

REFERENCE

   Methods
       new()
	   Create a new Barcode::ZBar::Image object.  The size, pixel format and data must be defined before the object may be used.

       get_format()
       set_format(format)
	   Return/specify the fourcc code corresponding to the image pixel format.

       get_sequence()
       set_sequence(seq_num)
	   Return/specify the video frame or page number associated with the image.

       get_size()
       set_size(width, height)
	   Return/specify the (width, height) image size tuple.

       get_data()
       set_data(raw)
	   Return/specify the raw image data as a binary string.

       get_symbols()
	   Return a list of scanned Barcode::ZBar::Symbol results attached to this image.

       convert(format)
	   Return a new Barcode::ZBar::Image object converted to the indicated fourcc format.  Returns "undef" if the conversion is not supported.
	   Conversion complexity ranges from CPU intensive to trivial depending on the formats involved.  Note that only a few conversions retain
	   color information.

SEE ALSO

       Barcode::ZBar, Barcode::ZBar::Image, Barcode::ZBar::Symbol

       zbarimg(1), zbarcam(1)

       http://zbar.sf.net

AUTHOR

       Jeff Brown, <spadix@users.sourceforge.net>

COPYRIGHT AND LICENSE

       Copyright 2008-2009 (c) Jeff Brown <spadix@users.sourceforge.net>

       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.

perl v5.14.2							    2009-10-23							  ZBar::Image(3pm)
Man Page