.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "ZBar::Image 3pm"
.TH ZBar::Image 3pm 2024-02-06 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Barcode::ZBar::Image \- image object to scan for bar codes
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use Barcode::ZBar;
\&    
\&    my $image = Barcode::ZBar::Image\->new();
\&    $image\->set_format(\*(Aq422P\*(Aq);
\&    $image\->set_size(114, 80);
\&    $image\->set_data($raw_bits);
\&    
\&    my @symbols = $image\->get_symbols();
.Ve
.SH DESCRIPTION
.IX Header "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)
.SS "Image Formats"
.IX Subsection "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.
.PP
Examples:
.IP \(bu 2
\&'GREY' \- single 8bpp intensity plane
.IP \(bu 2
\&'BGR3' \- 24bpp packed RGB component format
.IP \(bu 2
\&'YUYV' \- 12bpp packed luminance/chrominance (YCbCr) format
.SH REFERENCE
.IX Header "REFERENCE"
.SS Methods
.IX Subsection "Methods"
.IP \fBnew()\fR 4
.IX Item "new()"
Create a new Barcode::ZBar::Image object.  The size, pixel format and
data must be defined before the object may be used.
.IP \fBget_format()\fR 4
.IX Item "get_format()"
.PD 0
.IP set_format(\fIformat\fR) 4
.IX Item "set_format(format)"
.PD
Return/specify the fourcc code corresponding to the image pixel format.
.IP \fBget_sequence()\fR 4
.IX Item "get_sequence()"
.PD 0
.IP set_sequence(\fIseq_num\fR) 4
.IX Item "set_sequence(seq_num)"
.PD
Return/specify the video frame or page number associated with the image.
.IP \fBget_size()\fR 4
.IX Item "get_size()"
.PD 0
.IP "set_size(\fIwidth\fR, \fIheight\fR)" 4
.IX Item "set_size(width, height)"
.PD
Return/specify the (\fIwidth\fR, \fIheight\fR) image size tuple.
.IP \fBget_data()\fR 4
.IX Item "get_data()"
.PD 0
.IP set_data(\fIraw\fR) 4
.IX Item "set_data(raw)"
.PD
Return/specify the raw image data as a binary string.
.IP \fBget_symbols()\fR 4
.IX Item "get_symbols()"
Return a list of scanned Barcode::ZBar::Symbol results attached to
this image.
.IP "convert_resize(\fIformat\fR, \fIwidth\fR, \fIheight\fR)" 4
.IX Item "convert_resize(format, width, height)"
.PD 0
.IP convert(\fIformat\fR) 4
.IX Item "convert(format)"
.PD
Return a new Barcode::ZBar::Image object converted to the indicated
fourcc format.  Returns \f(CW\*(C`undef\*(C'\fR 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.  convert actually calls convert_resize using the
source width and height.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Barcode::ZBar, Barcode::ZBar::Image, Barcode::ZBar::Symbol
.PP
\&\fBzbarimg\fR\|(1), \fBzbarcam\fR\|(1)
.PP
http://zbar.sf.net
.SH AUTHOR
.IX Header "AUTHOR"
Jeff Brown, <spadix@users.sourceforge.net>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2008\-2010 (c) Jeff Brown <spadix@users.sourceforge.net>
.PP
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.