1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
#------------------------------------------------------------------------
# Copyright 2008-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
#------------------------------------------------------------------------
=pod
=head1 NAME
Barcode::ZBar::Processor - self-contained bar code reader
=head1 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();
=head1 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
available widget interfaces for GUI applications.
=head1 REFERENCE
=head2 Methods
=over 4
=item new()
Create a new bar code reader instance.
=item init([I<video_device>], [I<enable_display>])
Open a video input device and/or prepare to display output.
=item set_data_handler([I<handler>], [I<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
I<closure> as arguments. Closure may be achieved either using
standard Perl closure or by manually passing a scalar via I<closure>.
=item is_visible()
=item set_visible([I<visible>])
Test/set visibility of the output window.
=item set_active([I<active>])
Enable/disable video streaming and scanning for bar codes.
=item get_results()
Return a list of Barcode::ZBar::Symbol results from the last scanned
image or video frame.
=item user_wait([I<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.
=item process_one([I<timeout>])
Enable video and scan until at least one barcode is found. Note that
multiple results may still be returned.
=item process_image([I<image>])
Scan a Barcode::ZBar::Image for bar codes.
=item parse_config(I<configstr>)
Apply a decoder configuration setting. See the documentation for
C<zbarcam>/C<zbarimg> for available configuration options.
=item request_size(I<width>, I<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 C<init()>
=item force_format(I<input>, I<output>)
force specific input and output formats for debug/testing.
=item set_config(I<symbology>, I<config>, I<value>)
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)
=back
=head1 SEE ALSO
Barcode::ZBar, Barcode::ZBar::Image, Barcode::ZBar::ImageScanner
zbarimg(1), zbarcam(1)
http://zbar.sf.net
=head1 AUTHOR
Jeff Brown, E<lt>spadix@users.sourceforge.netE<gt>
=head1 COPYRIGHT AND LICENSE
Copyright 2008-2010 (c) Jeff Brown E<lt>spadix@users.sourceforge.netE<gt>
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.
=cut
|
