X-Git-Url: http://git.imager.perl.org/imager.git/blobdiff_plain/5df0fac7713f1a2e8c2e5381e8806f372797bbc1..dc96e46cbbdfd9f0997dc12ddac6dfcf55412ff2:/Imager.pm diff --git a/Imager.pm b/Imager.pm index 180e4bfb..0f684aec 100644 --- a/Imager.pm +++ b/Imager.pm @@ -1,7 +1,7 @@ package Imager; use strict; -use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS %formats $DEBUG %filters %DSOs $ERRSTR $fontstate %OPCODES $I2P $FORMATGUESS); +use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS %formats $DEBUG %filters %DSOs $ERRSTR $fontstate %OPCODES $I2P $FORMATGUESS $warn_obsolete); use IO::File; use Imager::Color; @@ -35,7 +35,7 @@ use Imager::Font; i_img_setmask i_img_getmask - i_draw + i_line i_line_aa i_box i_box_filled @@ -145,11 +145,17 @@ use Imager::Font; BEGIN { require Exporter; - require DynaLoader; - - $VERSION = '0.39'; - @ISA = qw(Exporter DynaLoader); - bootstrap Imager $VERSION; + @ISA = qw(Exporter); + $VERSION = '0.48'; + eval { + require XSLoader; + XSLoader::load(Imager => $VERSION); + 1; + } or do { + require DynaLoader; + push @ISA, 'DynaLoader'; + bootstrap Imager $VERSION; + } } BEGIN { @@ -221,17 +227,40 @@ BEGIN { callsub => sub { my %hsh=@_; i_conv($hsh{image},$hsh{coef}); } }; - $filters{gradgen} ={ - callseq => ['image', 'xo', 'yo', 'colors', 'dist'], - defaults => { }, - callsub => sub { my %hsh=@_; i_gradgen($hsh{image}, $hsh{xo}, $hsh{yo}, $hsh{colors}, $hsh{dist}); } - }; + $filters{gradgen} = + { + callseq => ['image', 'xo', 'yo', 'colors', 'dist'], + defaults => { dist => 0 }, + callsub => + sub { + my %hsh=@_; + my @colors = @{$hsh{colors}}; + $_ = _color($_) + for @colors; + i_gradgen($hsh{image}, $hsh{xo}, $hsh{yo}, \@colors, $hsh{dist}); + } + }; - $filters{nearest_color} ={ - callseq => ['image', 'xo', 'yo', 'colors', 'dist'], - defaults => { }, - callsub => sub { my %hsh=@_; i_nearest_color($hsh{image}, $hsh{xo}, $hsh{yo}, $hsh{colors}, $hsh{dist}); } - }; + $filters{nearest_color} = + { + callseq => ['image', 'xo', 'yo', 'colors', 'dist'], + defaults => { }, + callsub => + sub { + my %hsh=@_; + # make sure the segments are specified with colors + my @colors; + for my $color (@{$hsh{colors}}) { + my $new_color = _color($color) + or die $Imager::ERRSTR."\n"; + push @colors, $new_color; + } + + i_nearest_color($hsh{image}, $hsh{xo}, $hsh{yo}, \@colors, + $hsh{dist}) + or die Imager->_error_as_msg() . "\n"; + }, + }; $filters{gaussian} = { callseq => [ 'image', 'stddev' ], defaults => { }, @@ -346,9 +375,20 @@ BEGIN { callsub => sub { my %hsh = @_; + + # make sure the segments are specified with colors + my @segments; + for my $segment (@{$hsh{segments}}) { + my @new_segment = @$segment; + + $_ = _color($_) or die $Imager::ERRSTR."\n" for @new_segment[3,4]; + push @segments, \@new_segment; + } + i_fountain($hsh{image}, $hsh{xa}, $hsh{ya}, $hsh{xb}, $hsh{yb}, $hsh{ftype}, $hsh{repeat}, $hsh{combine}, $hsh{super_sample}, - $hsh{ssample_param}, $hsh{segments}); + $hsh{ssample_param}, \@segments) + or die Imager->_error_as_msg() . "\n"; }, }; $filters{unsharpmask} = @@ -363,6 +403,8 @@ BEGIN { }; $FORMATGUESS=\&def_guess_type; + + $warn_obsolete = 1; } # @@ -380,17 +422,30 @@ BEGIN { # print Dumper(@_); #} +sub init_log { + m_init_log($_[0],$_[1]); + log_entry("Imager $VERSION starting\n", 1); +} + + sub init { my %parms=(loglevel=>1,@_); if ($parms{'log'}) { init_log($parms{'log'},$parms{'loglevel'}); } + if (exists $parms{'warn_obsolete'}) { + $warn_obsolete = $parms{'warn_obsolete'}; + } + # if ($parms{T1LIB_CONFIG}) { $ENV{T1LIB_CONFIG}=$parms{T1LIB_CONFIG}; } # if ( $ENV{T1LIB_CONFIG} and ( $fontstate eq 'missing conf' )) { # i_init_fonts(); # $fontstate='ok'; # } + if (exists $parms{'t1log'}) { + i_init_fonts($parms{'t1log'}); + } } END { @@ -456,6 +511,11 @@ sub _error_as_msg { sub _color { my $arg = shift; + # perl 5.6.0 seems to do weird things to $arg if we don't make an + # explicitly stringified copy + # I vaguely remember a bug on this on p5p, but couldn't find it + # through bugs.perl.org (I had trouble getting it to find any bugs) + my $copy = $arg . ""; my $result; if (ref $arg) { @@ -464,10 +524,10 @@ sub _color { $result = $arg; } else { - if ($arg =~ /^HASH\(/) { + if ($copy =~ /^HASH\(/) { $result = Imager::Color->new(%$arg); } - elsif ($arg =~ /^ARRAY\(/) { + elsif ($copy =~ /^ARRAY\(/) { if (grep $_ > 1, @$arg) { $result = Imager::Color->new(@$arg); } @@ -506,7 +566,12 @@ sub new { $self->{ERRSTR}=undef; # $self->{DEBUG}=$DEBUG; $self->{DEBUG} && print "Initialized Imager\n"; - if ($hsh{xsize} && $hsh{ysize}) { $self->img_set(%hsh); } + if (defined $hsh{xsize} && defined $hsh{ysize}) { + unless ($self->img_set(%hsh)) { + $Imager::ERRSTR = $self->{ERRSTR}; + return; + } + } return $self; } @@ -517,9 +582,14 @@ sub copy { my $self = shift; unless ($self->{IMG}) { $self->{ERRSTR}='empty input image'; return undef; } + unless (defined wantarray) { + my @caller = caller; + warn "copy() called in void context - copy() returns the copied image at $caller[1] line $caller[2]\n"; + return; + } + my $newcopy=Imager->new(); - $newcopy->{IMG}=i_img_new(); - i_copy($newcopy->{IMG},$self->{IMG}); + $newcopy->{IMG} = i_copy($self->{IMG}); return $newcopy; } @@ -527,19 +597,68 @@ sub copy { sub paste { my $self = shift; - unless ($self->{IMG}) { $self->{ERRSTR}='empty input image'; return undef; } - my %input=(left=>0, top=>0, @_); - unless($input{img}) { - $self->{ERRSTR}="no source image"; + + unless ($self->{IMG}) { + $self->_set_error('empty input image'); + return; + } + my %input=(left=>0, top=>0, src_minx => 0, src_miny => 0, @_); + my $src = $input{img} || $input{src}; + unless($src) { + $self->_set_error("no source image"); return; } $input{left}=0 if $input{left} <= 0; $input{top}=0 if $input{top} <= 0; - my $src=$input{img}; + my($r,$b)=i_img_info($src->{IMG}); + my ($src_left, $src_top) = @input{qw/src_minx src_miny/}; + my ($src_right, $src_bottom); + if ($input{src_coords}) { + ($src_left, $src_top, $src_right, $src_bottom) = @{$input{src_coords}} + } + else { + if (defined $input{src_maxx}) { + $src_right = $input{src_maxx}; + } + elsif (defined $input{width}) { + if ($input{width} <= 0) { + $self->_set_error("paste: width must me positive"); + return; + } + $src_right = $src_left + $input{width}; + } + else { + $src_right = $r; + } + if (defined $input{src_maxx}) { + $src_bottom = $input{src_maxy}; + } + elsif (defined $input{height}) { + if ($input{height} < 0) { + $self->_set_error("paste: height must be positive"); + return; + } + $src_bottom = $src_top + $input{height}; + } + else { + $src_bottom = $b; + } + } + + $src_right > $r and $src_right = $r; + $src_bottom > $r and $src_bottom = $b; + + if ($src_right <= $src_left + || $src_bottom < $src_top) { + $self->_set_error("nothing to paste"); + return; + } i_copyto($self->{IMG}, $src->{IMG}, - 0,0, $r, $b, $input{left}, $input{top}); + $src_left, $src_top, $src_right, $src_bottom, + $input{left}, $input{top}); + return $self; # What should go here?? } @@ -548,46 +667,111 @@ sub paste { sub crop { my $self=shift; unless ($self->{IMG}) { $self->{ERRSTR}='empty input image'; return undef; } - my %hsh=(left=>0,right=>0,top=>0,bottom=>0,@_); + + unless (defined wantarray) { + my @caller = caller; + warn "crop() called in void context - crop() returns the cropped image at $caller[1] line $caller[2]\n"; + return; + } - my ($w,$h,$l,$r,$b,$t)=($self->getwidth(),$self->getheight(), - @hsh{qw(left right bottom top)}); - $l=0 if not defined $l; - $t=0 if not defined $t; + my %hsh=@_; - $r||=$l+delete $hsh{'width'} if defined $l and exists $hsh{'width'}; - $b||=$t+delete $hsh{'height'} if defined $t and exists $hsh{'height'}; - $l||=$r-delete $hsh{'width'} if defined $r and exists $hsh{'width'}; - $t||=$b-delete $hsh{'height'} if defined $b and exists $hsh{'height'}; + my ($w, $h, $l, $r, $b, $t) = + @hsh{qw(width height left right bottom top)}; - $r=$self->getwidth if not defined $r; - $b=$self->getheight if not defined $b; + # work through the various possibilities + if (defined $l) { + if (defined $w) { + $r = $l + $w; + } + elsif (!defined $r) { + $r = $self->getwidth; + } + } + elsif (defined $r) { + if (defined $w) { + $l = $r - $w; + } + else { + $l = 0; + } + } + elsif (defined $w) { + $l = int(0.5+($self->getwidth()-$w)/2); + $r = $l + $w; + } + else { + $l = 0; + $r = $self->getwidth; + } + if (defined $t) { + if (defined $h) { + $b = $t + $h; + } + elsif (!defined $b) { + $b = $self->getheight; + } + } + elsif (defined $b) { + if (defined $h) { + $t = $b - $h; + } + else { + $t = 0; + } + } + elsif (defined $h) { + $t=int(0.5+($self->getheight()-$h)/2); + $b=$t+$h; + } + else { + $t = 0; + $b = $self->getheight; + } ($l,$r)=($r,$l) if $l>$r; ($t,$b)=($b,$t) if $t>$b; - if ($hsh{'width'}) { - $l=int(0.5+($w-$hsh{'width'})/2); - $r=$l+$hsh{'width'}; - } else { - $hsh{'width'}=$r-$l; - } - if ($hsh{'height'}) { - $b=int(0.5+($h-$hsh{'height'})/2); - $t=$h+$hsh{'height'}; - } else { - $hsh{'height'}=$b-$t; - } + $l < 0 and $l = 0; + $r > $self->getwidth and $r = $self->getwidth; + $t < 0 and $t = 0; + $b > $self->getheight and $b = $self->getheight; -# print "l=$l, r=$r, h=$hsh{'width'}\n"; -# print "t=$t, b=$b, w=$hsh{'height'}\n"; + if ($l == $r || $t == $b) { + $self->_set_error("resulting image would have no content"); + return; + } - my $dst=Imager->new(xsize=>$hsh{'width'}, ysize=>$hsh{'height'}, channels=>$self->getchannels()); + my $dst = $self->_sametype(xsize=>$r-$l, ysize=>$b-$t); i_copyto($dst->{IMG},$self->{IMG},$l,$t,$r,$b,0,0); return $dst; } +sub _sametype { + my ($self, %opts) = @_; + + $self->{IMG} or return $self->_set_error("Not a valid image"); + + my $x = $opts{xsize} || $self->getwidth; + my $y = $opts{ysize} || $self->getheight; + my $channels = $opts{channels} || $self->getchannels; + + my $out = Imager->new; + if ($channels == $self->getchannels) { + $out->{IMG} = i_sametype($self->{IMG}, $x, $y); + } + else { + $out->{IMG} = i_sametype_chans($self->{IMG}, $x, $y, $channels); + } + unless ($out->{IMG}) { + $self->{ERRSTR} = $self->_error_as_msg; + return; + } + + return $out; +} + # Sets an image to a certain size and channel number # if there was previously data in the image it is discarded @@ -617,6 +801,13 @@ sub img_set { $self->{IMG}=Imager::ImgRaw::new($hsh{'xsize'}, $hsh{'ysize'}, $hsh{'channels'}); } + + unless ($self->{IMG}) { + $self->{ERRSTR} = Imager->_error_as_msg(); + return; + } + + $self; } # created a masked version of the current image @@ -653,14 +844,24 @@ sub to_paletted { $opts = shift; } + unless (defined wantarray) { + my @caller = caller; + warn "to_paletted() called in void context - to_paletted() returns the converted image at $caller[1] line $caller[2]\n"; + return; + } + my $result = Imager->new; $result->{IMG} = i_img_to_pal($self->{IMG}, $opts); #print "Type ", i_img_type($result->{IMG}), "\n"; - $result->{IMG} or undef $result; - - return $result; + if ($result->{IMG}) { + return $result; + } + else { + $self->{ERRSTR} = $self->_error_as_msg; + return; + } } # convert a paletted (or any image) to an 8-bit/channel RGB images @@ -668,6 +869,12 @@ sub to_rgb8 { my $self = shift; my $result; + unless (defined wantarray) { + my @caller = caller; + warn "to_rgb8() called in void context - to_rgb8() returns the cropped image at $caller[1] line $caller[2]\n"; + return; + } + if ($self->{IMG}) { $result = Imager->new; $result->{IMG} = i_img_to_rgb($self->{IMG}) @@ -854,14 +1061,30 @@ sub deltag { } } -my @needseekcb = qw/tiff/; -my %needseekcb = map { $_, $_ } @needseekcb; +sub settag { + my ($self, %opts) = @_; + + if ($opts{name}) { + $self->deltag(name=>$opts{name}); + return $self->addtag(name=>$opts{name}, value=>$opts{value}); + } + elsif (defined $opts{code}) { + $self->deltag(code=>$opts{code}); + return $self->addtag(code=>$opts{code}, value=>$opts{value}); + } + else { + return undef; + } +} sub _get_reader_io { - my ($self, $input, $type) = @_; + my ($self, $input) = @_; - if ($input->{fd}) { + if ($input->{io}) { + return $input->{io}, undef; + } + elsif ($input->{fd}) { return io_new_fd($input->{fd}); } elsif ($input->{fh}) { @@ -885,8 +1108,8 @@ sub _get_reader_io { return io_new_buffer($input->{data}); } elsif ($input->{callback} || $input->{readcb}) { - if ($needseekcb{$type} && !$input->{seekcb}) { - $self->_set_error("Format $type needs a seekcb parameter"); + if (!$input->{seekcb}) { + $self->_set_error("Need a seekcb parameter"); } if ($input->{maxbuffer}) { return io_new_cb($input->{writecb}, @@ -918,6 +1141,11 @@ sub _get_writer_io { $self->_set_error("Handle in fh option not opened"); return; } + # flush it + my $oldfh = select($input->{fh}); + # flush anything that's buffered, and make sure anything else is flushed + $| = 1; + select($oldfh); return io_new_fd($fd); } elsif ($input->{file}) { @@ -964,210 +1192,244 @@ sub read { undef($self->{IMG}); } - # FIXME: Find the format here if not specified - # yes the code isn't here yet - next week maybe? - # Next week? Are you high or something? That comment - # has been there for half a year dude. - # Look, i just work here, ok? + my ($IO, $fh) = $self->_get_reader_io(\%input) or return; - if (!$input{'type'} and $input{file}) { - $input{'type'}=$FORMATGUESS->($input{file}); + unless ($input{'type'}) { + $input{'type'} = i_test_format_probe($IO, -1); } + unless ($input{'type'}) { - $self->_set_error('type parameter missing and not possible to guess from extension'); + $self->_set_error('type parameter missing and not possible to guess from extension'); return undef; } - if (!$formats{$input{'type'}}) { - $self->{ERRSTR}='format not supported'; return undef; - } - my %iolready=(jpeg=>1, png=>1, tiff=>1, pnm=>1, raw=>1, bmp=>1, tga=>1, rgb=>1, gif=>1); - - if ($iolready{$input{'type'}}) { - # Setup data source - my ($IO, $fh) = $self->_get_reader_io(\%input, $input{'type'}) - or return; + unless ($formats{$input{'type'}}) { + $self->_set_error("format '$input{'type'}' not supported"); + return; + } - if ( $input{'type'} eq 'jpeg' ) { - ($self->{IMG},$self->{IPTCRAW})=i_readjpeg_wiol( $IO ); - if ( !defined($self->{IMG}) ) { - $self->{ERRSTR}='unable to read jpeg image'; return undef; - } - $self->{DEBUG} && print "loading a jpeg file\n"; - return $self; + # Setup data source + if ( $input{'type'} eq 'jpeg' ) { + ($self->{IMG},$self->{IPTCRAW}) = i_readjpeg_wiol( $IO ); + if ( !defined($self->{IMG}) ) { + $self->{ERRSTR}=$self->_error_as_msg(); return undef; } + $self->{DEBUG} && print "loading a jpeg file\n"; + return $self; + } - if ( $input{'type'} eq 'tiff' ) { - $self->{IMG}=i_readtiff_wiol( $IO, -1 ); # Fixme, check if that length parameter is ever needed - if ( !defined($self->{IMG}) ) { - $self->{ERRSTR}=$self->_error_as_msg(); return undef; - } - $self->{DEBUG} && print "loading a tiff file\n"; - return $self; + if ( $input{'type'} eq 'tiff' ) { + my $page = $input{'page'}; + defined $page or $page = 0; + # Fixme, check if that length parameter is ever needed + $self->{IMG}=i_readtiff_wiol( $IO, -1, $page ); + if ( !defined($self->{IMG}) ) { + $self->{ERRSTR}=$self->_error_as_msg(); return undef; } + $self->{DEBUG} && print "loading a tiff file\n"; + return $self; + } - if ( $input{'type'} eq 'pnm' ) { - $self->{IMG}=i_readpnm_wiol( $IO, -1 ); # Fixme, check if that length parameter is ever needed - if ( !defined($self->{IMG}) ) { - $self->{ERRSTR}='unable to read pnm image: '._error_as_msg(); return undef; - } - $self->{DEBUG} && print "loading a pnm file\n"; - return $self; + if ( $input{'type'} eq 'pnm' ) { + $self->{IMG}=i_readpnm_wiol( $IO, -1 ); # Fixme, check if that length parameter is ever needed + if ( !defined($self->{IMG}) ) { + $self->{ERRSTR}='unable to read pnm image: '._error_as_msg(); + return undef; } + $self->{DEBUG} && print "loading a pnm file\n"; + return $self; + } - if ( $input{'type'} eq 'png' ) { - $self->{IMG}=i_readpng_wiol( $IO, -1 ); # Fixme, check if that length parameter is ever needed - if ( !defined($self->{IMG}) ) { - $self->{ERRSTR}='unable to read png image'; - return undef; - } - $self->{DEBUG} && print "loading a png file\n"; + if ( $input{'type'} eq 'png' ) { + $self->{IMG}=i_readpng_wiol( $IO, -1 ); # Fixme, check if that length parameter is ever needed + if ( !defined($self->{IMG}) ) { + $self->{ERRSTR} = $self->_error_as_msg(); + return undef; } + $self->{DEBUG} && print "loading a png file\n"; + } - if ( $input{'type'} eq 'bmp' ) { - $self->{IMG}=i_readbmp_wiol( $IO ); - if ( !defined($self->{IMG}) ) { - $self->{ERRSTR}=$self->_error_as_msg(); - return undef; - } - $self->{DEBUG} && print "loading a bmp file\n"; + if ( $input{'type'} eq 'bmp' ) { + $self->{IMG}=i_readbmp_wiol( $IO ); + if ( !defined($self->{IMG}) ) { + $self->{ERRSTR}=$self->_error_as_msg(); + return undef; } + $self->{DEBUG} && print "loading a bmp file\n"; + } - if ( $input{'type'} eq 'gif' ) { - if ($input{colors} && !ref($input{colors})) { - # must be a reference to a scalar that accepts the colour map - $self->{ERRSTR} = "option 'colors' must be a scalar reference"; - return undef; - } + if ( $input{'type'} eq 'gif' ) { + if ($input{colors} && !ref($input{colors})) { + # must be a reference to a scalar that accepts the colour map + $self->{ERRSTR} = "option 'colors' must be a scalar reference"; + return undef; + } + if ($input{'gif_consolidate'}) { if ($input{colors}) { - my $colors; - ($self->{IMG}, $colors) =i_readgif_wiol( $IO ); - if ($colors) { - ${ $input{colors} } = [ map { NC(@$_) } @$colors ]; - } + my $colors; + ($self->{IMG}, $colors) =i_readgif_wiol( $IO ); + if ($colors) { + ${ $input{colors} } = [ map { NC(@$_) } @$colors ]; + } } else { - $self->{IMG} =i_readgif_wiol( $IO ); - } - if ( !defined($self->{IMG}) ) { - $self->{ERRSTR}=$self->_error_as_msg(); - return undef; + $self->{IMG} =i_readgif_wiol( $IO ); } - $self->{DEBUG} && print "loading a gif file\n"; } - - if ( $input{'type'} eq 'tga' ) { - $self->{IMG}=i_readtga_wiol( $IO, -1 ); # Fixme, check if that length parameter is ever needed - if ( !defined($self->{IMG}) ) { - $self->{ERRSTR}=$self->_error_as_msg(); - return undef; + else { + my $page = $input{'page'}; + defined $page or $page = 0; + $self->{IMG} = i_readgif_single_wiol( $IO, $page ); + if ($input{colors}) { + ${ $input{colors} } = + [ i_getcolors($self->{IMG}, 0, i_colorcount($self->{IMG})) ]; } - $self->{DEBUG} && print "loading a tga file\n"; } - if ( $input{'type'} eq 'rgb' ) { - $self->{IMG}=i_readrgb_wiol( $IO, -1 ); # Fixme, check if that length parameter is ever needed - if ( !defined($self->{IMG}) ) { - $self->{ERRSTR}=$self->_error_as_msg(); - return undef; - } - $self->{DEBUG} && print "loading a tga file\n"; + if ( !defined($self->{IMG}) ) { + $self->{ERRSTR}=$self->_error_as_msg(); + return undef; } + $self->{DEBUG} && print "loading a gif file\n"; + } - - if ( $input{'type'} eq 'raw' ) { - my %params=(datachannels=>3,storechannels=>3,interleave=>1,%input); - - if ( !($params{xsize} && $params{ysize}) ) { - $self->{ERRSTR}='missing xsize or ysize parameter for raw'; - return undef; - } - - $self->{IMG} = i_readraw_wiol( $IO, - $params{xsize}, - $params{ysize}, - $params{datachannels}, - $params{storechannels}, - $params{interleave}); - if ( !defined($self->{IMG}) ) { - $self->{ERRSTR}='unable to read raw image'; - return undef; - } - $self->{DEBUG} && print "loading a raw file\n"; + if ( $input{'type'} eq 'tga' ) { + $self->{IMG}=i_readtga_wiol( $IO, -1 ); # Fixme, check if that length parameter is ever needed + if ( !defined($self->{IMG}) ) { + $self->{ERRSTR}=$self->_error_as_msg(); + return undef; } + $self->{DEBUG} && print "loading a tga file\n"; + } - } else { + if ( $input{'type'} eq 'rgb' ) { + $self->{IMG}=i_readrgb_wiol( $IO, -1 ); # Fixme, check if that length parameter is ever needed + if ( !defined($self->{IMG}) ) { + $self->{ERRSTR}=$self->_error_as_msg(); + return undef; + } + $self->{DEBUG} && print "loading a tga file\n"; + } - # Old code for reference while changing the new stuff - if (!$input{'type'} and $input{file}) { - $input{'type'}=$FORMATGUESS->($input{file}); - } + if ( $input{'type'} eq 'raw' ) { + my %params=(datachannels=>3,storechannels=>3,interleave=>1,%input); - if (!$input{'type'}) { - $self->{ERRSTR}='type parameter missing and not possible to guess from extension'; return undef; + if ( !($params{xsize} && $params{ysize}) ) { + $self->{ERRSTR}='missing xsize or ysize parameter for raw'; + return undef; } - if (!$formats{$input{'type'}}) { - $self->{ERRSTR}='format not supported'; + $self->{IMG} = i_readraw_wiol( $IO, + $params{xsize}, + $params{ysize}, + $params{datachannels}, + $params{storechannels}, + $params{interleave}); + if ( !defined($self->{IMG}) ) { + $self->{ERRSTR}=$self->_error_as_msg(); return undef; } + $self->{DEBUG} && print "loading a raw file\n"; + } - my ($fh, $fd); - if ($input{file}) { - $fh = new IO::File($input{file},"r"); - if (!defined $fh) { - $self->{ERRSTR}='Could not open file'; - return undef; - } - binmode($fh); - $fd = $fh->fileno(); - } + return $self; +} - if ($input{fd}) { - $fd=$input{fd}; - } +sub _fix_gif_positions { + my ($opts, $opt, $msg, @imgs) = @_; - if ( $input{'type'} eq 'gif' ) { - my $colors; - if ($input{colors} && !ref($input{colors})) { - # must be a reference to a scalar that accepts the colour map - $self->{ERRSTR} = "option 'colors' must be a scalar reference"; - return undef; + my $positions = $opts->{'gif_positions'}; + my $index = 0; + for my $pos (@$positions) { + my ($x, $y) = @$pos; + my $img = $imgs[$index++]; + $img->settag(name=>'gif_left', value=>$x); + $img->settag(name=>'gif_top', value=>$y) if defined $y; + } + $$msg .= "replaced with the gif_left and gif_top tags"; +} + +my %obsolete_opts = + ( + gif_each_palette=>'gif_local_map', + interlace => 'gif_interlace', + gif_delays => 'gif_delay', + gif_positions => \&_fix_gif_positions, + gif_loop_count => 'gif_loop', + ); + +sub _set_opts { + my ($self, $opts, $prefix, @imgs) = @_; + + for my $opt (keys %$opts) { + my $tagname = $opt; + if ($obsolete_opts{$opt}) { + my $new = $obsolete_opts{$opt}; + my $msg = "Obsolete option $opt "; + if (ref $new) { + $new->($opts, $opt, \$msg, @imgs); } - if (exists $input{data}) { - if ($input{colors}) { - ($self->{IMG}, $colors) = i_readgif_scalar($input{data}); - } else { - $self->{IMG}=i_readgif_scalar($input{data}); - } - } else { - if ($input{colors}) { - ($self->{IMG}, $colors) = i_readgif( $fd ); - } else { - $self->{IMG} = i_readgif( $fd ) - } + else { + $msg .= "replaced with the $new tag "; + $tagname = $new; } - if ($colors) { - # we may or may not change i_readgif to return blessed objects... - ${ $input{colors} } = [ map { NC(@$_) } @$colors ]; + $msg .= "line ".(caller(2))[2]." of file ".(caller(2))[1]; + warn $msg if $warn_obsolete && $^W; + } + next unless $tagname =~ /^\Q$prefix/; + my $value = $opts->{$opt}; + if (ref $value) { + if (UNIVERSAL::isa($value, "Imager::Color")) { + my $tag = sprintf("color(%d,%d,%d,%d)", $value->rgba); + for my $img (@imgs) { + $img->settag(name=>$tagname, value=>$tag); + } } - if ( !defined($self->{IMG}) ) { - $self->{ERRSTR}= 'reading GIF:'._error_as_msg(); - return undef; + elsif (ref($value) eq 'ARRAY') { + for my $i (0..$#$value) { + my $val = $value->[$i]; + if (ref $val) { + if (UNIVERSAL::isa($val, "Imager::Color")) { + my $tag = sprintf("color(%d,%d,%d,%d)", $value->rgba); + $i < @imgs and + $imgs[$i]->settag(name=>$tagname, value=>$tag); + } + else { + $self->_set_error("Unknown reference type " . ref($value) . + " supplied in array for $opt"); + return; + } + } + else { + $i < @imgs + and $imgs[$i]->settag(name=>$tagname, value=>$val); + } + } + } + else { + $self->_set_error("Unknown reference type " . ref($value) . + " supplied for $opt"); + return; + } + } + else { + # set it as a tag for every image + for my $img (@imgs) { + $img->settag(name=>$tagname, value=>$value); } - $self->{DEBUG} && print "loading a gif file\n"; } } - return $self; + + return 1; } # Write an image to file sub write { my $self = shift; - my %input=(jpegquality=>75, - gifquant=>'mc', - lmdither=>6.0, + my %input=(jpegquality=>75, + gifquant=>'mc', + lmdither=>6.0, lmfixed=>[], idstring=>"", compress=>1, @@ -1175,8 +1437,8 @@ sub write { fax_fine=>1, @_); my $rc; - my %iolready=( tiff=>1, raw=>1, png=>1, pnm=>1, bmp=>1, jpeg=>1, tga=>1, - gif=>1 ); # this will be SO MUCH BETTER once they are all in there + $self->_set_opts(\%input, "i_", $self) + or return undef; unless ($self->{IMG}) { $self->{ERRSTR}='empty input image'; return undef; } @@ -1193,84 +1455,102 @@ sub write { my ($IO, $fh) = $self->_get_writer_io(\%input, $input{'type'}) or return undef; - # this conditional is probably obsolete - if ($iolready{$input{'type'}}) { + if ($input{'type'} eq 'tiff') { + $self->_set_opts(\%input, "tiff_", $self) + or return undef; + $self->_set_opts(\%input, "exif_", $self) + or return undef; - if ($input{'type'} eq 'tiff') { - if (defined $input{class} && $input{class} eq 'fax') { - if (!i_writetiff_wiol_faxable($self->{IMG}, $IO, $input{fax_fine})) { - $self->{ERRSTR}='Could not write to buffer'; - return undef; - } - } else { - if (!i_writetiff_wiol($self->{IMG}, $IO)) { - $self->{ERRSTR}='Could not write to buffer'; - return undef; - } - } - } elsif ( $input{'type'} eq 'pnm' ) { - if ( ! i_writeppm_wiol($self->{IMG},$IO) ) { - $self->{ERRSTR}='unable to write pnm image'; - return undef; - } - $self->{DEBUG} && print "writing a pnm file\n"; - } elsif ( $input{'type'} eq 'raw' ) { - if ( !i_writeraw_wiol($self->{IMG},$IO) ) { - $self->{ERRSTR}='unable to write raw image'; - return undef; - } - $self->{DEBUG} && print "writing a raw file\n"; - } elsif ( $input{'type'} eq 'png' ) { - if ( !i_writepng_wiol($self->{IMG}, $IO) ) { - $self->{ERRSTR}='unable to write png image'; - return undef; - } - $self->{DEBUG} && print "writing a png file\n"; - } elsif ( $input{'type'} eq 'jpeg' ) { - if ( !i_writejpeg_wiol($self->{IMG}, $IO, $input{jpegquality})) { - $self->{ERRSTR} = $self->_error_as_msg(); - return undef; - } - $self->{DEBUG} && print "writing a jpeg file\n"; - } elsif ( $input{'type'} eq 'bmp' ) { - if ( !i_writebmp_wiol($self->{IMG}, $IO) ) { - $self->{ERRSTR}='unable to write bmp image'; + if (defined $input{class} && $input{class} eq 'fax') { + if (!i_writetiff_wiol_faxable($self->{IMG}, $IO, $input{fax_fine})) { + $self->{ERRSTR} = $self->_error_as_msg(); return undef; } - $self->{DEBUG} && print "writing a bmp file\n"; - } elsif ( $input{'type'} eq 'tga' ) { - - if ( !i_writetga_wiol($self->{IMG}, $IO, $input{wierdpack}, $input{compress}, $input{idstring}) ) { - $self->{ERRSTR}=$self->_error_as_msg(); + } else { + if (!i_writetiff_wiol($self->{IMG}, $IO)) { + $self->{ERRSTR} = $self->_error_as_msg(); return undef; } - $self->{DEBUG} && print "writing a tga file\n"; - } elsif ( $input{'type'} eq 'gif' ) { - # compatibility with the old interfaces - if ($input{gifquant} eq 'lm') { - $input{make_colors} = 'addi'; - $input{translate} = 'perturb'; - $input{perturb} = $input{lmdither}; - } elsif ($input{gifquant} eq 'gen') { - # just pass options through - } else { - $input{make_colors} = 'webmap'; # ignored - $input{translate} = 'giflib'; - } - $rc = i_writegif_wiol($IO, \%input, $self->{IMG}); } + } elsif ( $input{'type'} eq 'pnm' ) { + $self->_set_opts(\%input, "pnm_", $self) + or return undef; + if ( ! i_writeppm_wiol($self->{IMG},$IO) ) { + $self->{ERRSTR} = $self->_error_as_msg(); + return undef; + } + $self->{DEBUG} && print "writing a pnm file\n"; + } elsif ( $input{'type'} eq 'raw' ) { + $self->_set_opts(\%input, "raw_", $self) + or return undef; + if ( !i_writeraw_wiol($self->{IMG},$IO) ) { + $self->{ERRSTR} = $self->_error_as_msg(); + return undef; + } + $self->{DEBUG} && print "writing a raw file\n"; + } elsif ( $input{'type'} eq 'png' ) { + $self->_set_opts(\%input, "png_", $self) + or return undef; + if ( !i_writepng_wiol($self->{IMG}, $IO) ) { + $self->{ERRSTR}='unable to write png image'; + return undef; + } + $self->{DEBUG} && print "writing a png file\n"; + } elsif ( $input{'type'} eq 'jpeg' ) { + $self->_set_opts(\%input, "jpeg_", $self) + or return undef; + $self->_set_opts(\%input, "exif_", $self) + or return undef; + if ( !i_writejpeg_wiol($self->{IMG}, $IO, $input{jpegquality})) { + $self->{ERRSTR} = $self->_error_as_msg(); + return undef; + } + $self->{DEBUG} && print "writing a jpeg file\n"; + } elsif ( $input{'type'} eq 'bmp' ) { + $self->_set_opts(\%input, "bmp_", $self) + or return undef; + if ( !i_writebmp_wiol($self->{IMG}, $IO) ) { + $self->{ERRSTR}='unable to write bmp image'; + return undef; + } + $self->{DEBUG} && print "writing a bmp file\n"; + } elsif ( $input{'type'} eq 'tga' ) { + $self->_set_opts(\%input, "tga_", $self) + or return undef; - if (exists $input{'data'}) { - my $data = io_slurp($IO); - if (!$data) { - $self->{ERRSTR}='Could not slurp from buffer'; - return undef; - } - ${$input{data}} = $data; + if ( !i_writetga_wiol($self->{IMG}, $IO, $input{wierdpack}, $input{compress}, $input{idstring}) ) { + $self->{ERRSTR}=$self->_error_as_msg(); + return undef; + } + $self->{DEBUG} && print "writing a tga file\n"; + } elsif ( $input{'type'} eq 'gif' ) { + $self->_set_opts(\%input, "gif_", $self) + or return undef; + # compatibility with the old interfaces + if ($input{gifquant} eq 'lm') { + $input{make_colors} = 'addi'; + $input{translate} = 'perturb'; + $input{perturb} = $input{lmdither}; + } elsif ($input{gifquant} eq 'gen') { + # just pass options through + } else { + $input{make_colors} = 'webmap'; # ignored + $input{translate} = 'giflib'; + } + if (!i_writegif_wiol($IO, \%input, $self->{IMG})) { + $self->{ERRSTR} = $self->_error_as_msg; + return; } - return $self; } + if (exists $input{'data'}) { + my $data = io_slurp($IO); + if (!$data) { + $self->{ERRSTR}='Could not slurp from buffer'; + return undef; + } + ${$input{data}} = $data; + } return $self; } @@ -1289,10 +1569,14 @@ sub write_multi { $class->_set_error('Usage: Imager->write_multi({ options }, @images)'); return 0; } + $class->_set_opts($opts, "i_", @images) + or return; my @work = map $_->{IMG}, @images; my ($IO, $file) = $class->_get_writer_io($opts, $opts->{'type'}) or return undef; if ($opts->{'type'} eq 'gif') { + $class->_set_opts($opts, "gif_", @images) + or return; my $gif_delays = $opts->{gif_delays}; local $opts->{gif_delays} = $gif_delays; if ($opts->{gif_delays} && !ref $opts->{gif_delays}) { @@ -1304,6 +1588,10 @@ sub write_multi { return $res; } elsif ($opts->{'type'} eq 'tiff') { + $class->_set_opts($opts, "tiff_", @images) + or return; + $class->_set_opts($opts, "exif_", @images) + or return; my $res; $opts->{fax_fine} = 1 unless exists $opts->{fax_fine}; if ($opts->{'class'} && $opts->{'class'} eq 'fax') { @@ -1408,9 +1696,14 @@ sub filter { } } if (defined($filters{$input{'type'}}{defaults})) { - %hsh=('image',$self->{IMG},%{$filters{$input{'type'}}{defaults}},%input); + %hsh=( image => $self->{IMG}, + imager => $self, + %{$filters{$input{'type'}}{defaults}}, + %input ); } else { - %hsh=('image',$self->{IMG},%input); + %hsh=( image => $self->{IMG}, + imager => $self, + %input ); } my @cs=@{$filters{$input{'type'}}{callseq}}; @@ -1421,7 +1714,14 @@ sub filter { } } - &{$filters{$input{'type'}}{callsub}}(%hsh); + eval { + local $SIG{__DIE__}; # we don't want this processed by confess, etc + &{$filters{$input{'type'}}{callsub}}(%hsh); + }; + if ($@) { + chomp($self->{ERRSTR} = $@); + return; + } my @b=keys %hsh; @@ -1431,6 +1731,25 @@ sub filter { return $self; } +sub register_filter { + my $class = shift; + my %hsh = ( defaults => {}, @_ ); + + defined $hsh{type} + or die "register_filter() with no type\n"; + defined $hsh{callsub} + or die "register_filter() with no callsub\n"; + defined $hsh{callseq} + or die "register_filter() with no callseq\n"; + + exists $filters{$hsh{type}} + and return; + + $filters{$hsh{type}} = \%hsh; + + return 1; +} + # Scale an image to requested size and return the scaled version sub scale { @@ -1439,69 +1758,155 @@ sub scale { my $img = Imager->new(); my $tmp = Imager->new(); - unless ($self->{IMG}) { $self->{ERRSTR}='empty input image'; return undef; } + my $scalefactor = $opts{scalefactor}; + + unless (defined wantarray) { + my @caller = caller; + warn "scale() called in void context - scale() returns the scaled image at $caller[1] line $caller[2]\n"; + return; + } + + unless ($self->{IMG}) { + $self->_set_error('empty input image'); + return undef; + } + # work out the scaling if ($opts{xpixels} and $opts{ypixels} and $opts{'type'}) { - my ($xpix,$ypix)=( $opts{xpixels}/$self->getwidth() , $opts{ypixels}/$self->getheight() ); - if ($opts{'type'} eq 'min') { $opts{scalefactor}=min($xpix,$ypix); } - if ($opts{'type'} eq 'max') { $opts{scalefactor}=max($xpix,$ypix); } - } elsif ($opts{xpixels}) { $opts{scalefactor}=$opts{xpixels}/$self->getwidth(); } - elsif ($opts{ypixels}) { $opts{scalefactor}=$opts{ypixels}/$self->getheight(); } + my ($xpix, $ypix)=( $opts{xpixels} / $self->getwidth() , + $opts{ypixels} / $self->getheight() ); + if ($opts{'type'} eq 'min') { + $scalefactor = min($xpix,$ypix); + } + elsif ($opts{'type'} eq 'max') { + $scalefactor = max($xpix,$ypix); + } + else { + $self->_set_error('invalid value for type parameter'); + return undef; + } + } elsif ($opts{xpixels}) { + $scalefactor = $opts{xpixels} / $self->getwidth(); + } + elsif ($opts{ypixels}) { + $scalefactor = $opts{ypixels}/$self->getheight(); + } + elsif ($opts{constrain} && ref $opts{constrain} + && $opts{constrain}->can('constrain')) { + # we've been passed an Image::Math::Constrain object or something + # that looks like one + (undef, undef, $scalefactor) + = $opts{constrain}->constrain($self->getwidth, $self->getheight); + unless ($scalefactor) { + $self->_set_error('constrain method failed on constrain parameter'); + return undef; + } + } if ($opts{qtype} eq 'normal') { - $tmp->{IMG}=i_scaleaxis($self->{IMG},$opts{scalefactor},0); - if ( !defined($tmp->{IMG}) ) { $self->{ERRSTR}='unable to scale image'; return undef; } - $img->{IMG}=i_scaleaxis($tmp->{IMG},$opts{scalefactor},1); - if ( !defined($img->{IMG}) ) { $self->{ERRSTR}='unable to scale image'; return undef; } + $tmp->{IMG} = i_scaleaxis($self->{IMG}, $scalefactor, 0); + if ( !defined($tmp->{IMG}) ) { + $self->{ERRSTR} = 'unable to scale image'; + return undef; + } + $img->{IMG}=i_scaleaxis($tmp->{IMG}, $scalefactor, 1); + if ( !defined($img->{IMG}) ) { + $self->{ERRSTR}='unable to scale image'; + return undef; + } + return $img; } - if ($opts{'qtype'} eq 'preview') { - $img->{IMG}=i_scale_nn($self->{IMG},$opts{'scalefactor'},$opts{'scalefactor'}); - if ( !defined($img->{IMG}) ) { $self->{ERRSTR}='unable to scale image'; return undef; } + elsif ($opts{'qtype'} eq 'preview') { + $img->{IMG} = i_scale_nn($self->{IMG}, $scalefactor, $scalefactor); + if ( !defined($img->{IMG}) ) { + $self->{ERRSTR}='unable to scale image'; + return undef; + } return $img; } - $self->{ERRSTR}='scale: invalid value for qtype'; return undef; + else { + $self->_set_error('invalid value for qtype parameter'); + return undef; + } } # Scales only along the X axis sub scaleX { - my $self=shift; - my %opts=(scalefactor=>0.5,@_); + my $self = shift; + my %opts = ( scalefactor=>0.5, @_ ); - unless ($self->{IMG}) { $self->{ERRSTR}='empty input image'; return undef; } + unless (defined wantarray) { + my @caller = caller; + warn "scaleX() called in void context - scaleX() returns the scaled image at $caller[1] line $caller[2]\n"; + return; + } + + unless ($self->{IMG}) { + $self->{ERRSTR} = 'empty input image'; + return undef; + } my $img = Imager->new(); - if ($opts{pixels}) { $opts{scalefactor}=$opts{pixels}/$self->getwidth(); } + my $scalefactor = $opts{scalefactor}; - unless ($self->{IMG}) { $self->{ERRSTR}='empty input image'; return undef; } - $img->{IMG}=i_scaleaxis($self->{IMG},$opts{scalefactor},0); + if ($opts{pixels}) { + $scalefactor = $opts{pixels} / $self->getwidth(); + } + + unless ($self->{IMG}) { + $self->{ERRSTR}='empty input image'; + return undef; + } + + $img->{IMG} = i_scaleaxis($self->{IMG}, $scalefactor, 0); + + if ( !defined($img->{IMG}) ) { + $self->{ERRSTR} = 'unable to scale image'; + return undef; + } - if ( !defined($img->{IMG}) ) { $self->{ERRSTR}='unable to scale image'; return undef; } return $img; } # Scales only along the Y axis sub scaleY { - my $self=shift; - my %opts=(scalefactor=>0.5,@_); + my $self = shift; + my %opts = ( scalefactor => 0.5, @_ ); + + unless (defined wantarray) { + my @caller = caller; + warn "scaleY() called in void context - scaleY() returns the scaled image at $caller[1] line $caller[2]\n"; + return; + } unless ($self->{IMG}) { $self->{ERRSTR}='empty input image'; return undef; } my $img = Imager->new(); - if ($opts{pixels}) { $opts{scalefactor}=$opts{pixels}/$self->getheight(); } + my $scalefactor = $opts{scalefactor}; - unless ($self->{IMG}) { $self->{ERRSTR}='empty input image'; return undef; } - $img->{IMG}=i_scaleaxis($self->{IMG},$opts{scalefactor},1); + if ($opts{pixels}) { + $scalefactor = $opts{pixels} / $self->getheight(); + } + + unless ($self->{IMG}) { + $self->{ERRSTR} = 'empty input image'; + return undef; + } + $img->{IMG}=i_scaleaxis($self->{IMG}, $scalefactor, 1); + + if ( !defined($img->{IMG}) ) { + $self->{ERRSTR} = 'unable to scale image'; + return undef; + } - if ( !defined($img->{IMG}) ) { $self->{ERRSTR}='unable to scale image'; return undef; } return $img; } - # Transform returns a spatial transformation of the input image # this moves pixels to a new location in the returned image. # NOTE - should make a utility function to check transforms for @@ -1639,9 +2044,14 @@ sub transform2 { $Imager::ERRSTR = Imager::Expr::error(); return; } + my $channels = $opts->{channels} || 3; + unless ($channels >= 1 && $channels <= 4) { + return Imager->_set_error("channels must be an integer between 1 and 4"); + } my $img = Imager->new(); - $img->{IMG} = i_transform2($opts->{width}, $opts->{height}, $code->code(), + $img->{IMG} = i_transform2($opts->{width}, $opts->{height}, + $channels, $code->code(), $code->nregs(), $code->cregs(), [ map { $_->{IMG} } @imgs ]); if (!defined $img->{IMG}) { @@ -1654,13 +2064,27 @@ sub transform2 { sub rubthrough { my $self=shift; - my %opts=(tx=>0,ty=>0,@_); + my %opts=(tx => 0,ty => 0, @_); - unless ($self->{IMG}) { $self->{ERRSTR}='empty input image'; return undef; } - unless ($opts{src} && $opts{src}->{IMG}) { $self->{ERRSTR}='empty input image for source'; return undef; } + unless ($self->{IMG}) { + $self->{ERRSTR}='empty input image'; + return undef; + } + unless ($opts{src} && $opts{src}->{IMG}) { + $self->{ERRSTR}='empty input image for src'; + return undef; + } + + %opts = (src_minx => 0, + src_miny => 0, + src_maxx => $opts{src}->getwidth(), + src_maxy => $opts{src}->getheight(), + %opts); - unless (i_rubthru($self->{IMG}, $opts{src}->{IMG}, $opts{tx},$opts{ty})) { - $self->{ERRSTR} = $self->_error_as_msg(); + unless (i_rubthru($self->{IMG}, $opts{src}->{IMG}, $opts{tx}, $opts{ty}, + $opts{src_minx}, $opts{src_miny}, + $opts{src_maxx}, $opts{src_maxy})) { + $self->_set_error($self->_error_as_msg()); return undef; } return $self; @@ -1681,6 +2105,13 @@ sub flip { sub rotate { my $self = shift; my %opts = @_; + + unless (defined wantarray) { + my @caller = caller; + warn "rotate() called in void context - rotate() returns the rotated image at $caller[1] line $caller[2]\n"; + return; + } + if (defined $opts{right}) { my $degrees = $opts{right}; if ($degrees < 0) { @@ -1708,8 +2139,21 @@ sub rotate { elsif (defined $opts{radians} || defined $opts{degrees}) { my $amount = $opts{radians} || $opts{degrees} * 3.1415926535 / 180; + my $back = $opts{back}; my $result = Imager->new; - if ($result->{IMG} = i_rotate_exact($self->{IMG}, $amount)) { + if ($back) { + $back = _color($back); + unless ($back) { + $self->_set_error(Imager->errstr); + return undef; + } + + $result->{IMG} = i_rotate_exact($self->{IMG}, $amount, $back); + } + else { + $result->{IMG} = i_rotate_exact($self->{IMG}, $amount); + } + if ($result->{IMG}) { return $result; } else { @@ -1718,7 +2162,7 @@ sub rotate { } } else { - $self->{ERRSTR} = "Only the 'right' parameter is available"; + $self->{ERRSTR} = "Only the 'right', 'radians' and 'degrees' parameters are available"; return undef; } } @@ -1727,14 +2171,27 @@ sub matrix_transform { my $self = shift; my %opts = @_; + unless (defined wantarray) { + my @caller = caller; + warn "copy() called in void context - copy() returns the copied image at $caller[1] line $caller[2]\n"; + return; + } + if ($opts{matrix}) { my $xsize = $opts{xsize} || $self->getwidth; my $ysize = $opts{ysize} || $self->getheight; my $result = Imager->new; - $result->{IMG} = i_matrix_transform($self->{IMG}, $xsize, $ysize, - $opts{matrix}) - or return undef; + if ($opts{back}) { + $result->{IMG} = i_matrix_transform($self->{IMG}, $xsize, $ysize, + $opts{matrix}, $opts{back}) + or return undef; + } + else { + $result->{IMG} = i_matrix_transform($self->{IMG}, $xsize, $ysize, + $opts{matrix}) + or return undef; + } return $result; } @@ -1792,11 +2249,11 @@ sub box { i_box_cfill($self->{IMG},$opts{xmin},$opts{ymin},$opts{xmax}, $opts{ymax},$opts{fill}{fill}); } - else { + else { my $color = _color($opts{'color'}); unless ($color) { - $self->{ERRSTR} = $Imager::ERRSTR; - return; + $self->{ERRSTR} = $Imager::ERRSTR; + return; } i_box($self->{IMG},$opts{xmin},$opts{ymin},$opts{xmax},$opts{ymax}, $color); @@ -1804,8 +2261,6 @@ sub box { return $self; } -# Draws an arc - this routine SUCKS and is buggy - it sometimes doesn't work when the arc is a convex polygon - sub arc { my $self=shift; unless ($self->{IMG}) { $self->{ERRSTR}='empty input image'; return undef; } @@ -1815,68 +2270,90 @@ sub arc { 'x'=>$self->getwidth()/2, 'y'=>$self->getheight()/2, 'd1'=>0, 'd2'=>361, @_); - if ($opts{fill}) { - unless (UNIVERSAL::isa($opts{fill}, 'Imager::Fill')) { - # assume it's a hash ref - require 'Imager/Fill.pm'; - unless ($opts{fill} = Imager::Fill->new(%{$opts{fill}})) { - $self->{ERRSTR} = $Imager::ERRSTR; - return; + if ($opts{aa}) { + if ($opts{fill}) { + unless (UNIVERSAL::isa($opts{fill}, 'Imager::Fill')) { + # assume it's a hash ref + require 'Imager/Fill.pm'; + unless ($opts{fill} = Imager::Fill->new(%{$opts{fill}})) { + $self->{ERRSTR} = $Imager::ERRSTR; + return; + } + } + i_arc_aa_cfill($self->{IMG},$opts{'x'},$opts{'y'},$opts{'r'},$opts{'d1'}, + $opts{'d2'}, $opts{fill}{fill}); + } + else { + my $color = _color($opts{'color'}); + unless ($color) { + $self->{ERRSTR} = $Imager::ERRSTR; + return; + } + if ($opts{d1} == 0 && $opts{d2} == 361 && $opts{aa}) { + i_circle_aa($self->{IMG}, $opts{'x'}, $opts{'y'}, $opts{'r'}, + $color); + } + else { + i_arc_aa($self->{IMG},$opts{'x'},$opts{'y'},$opts{'r'}, + $opts{'d1'}, $opts{'d2'}, $color); } } - i_arc_cfill($self->{IMG},$opts{'x'},$opts{'y'},$opts{'r'},$opts{'d1'}, - $opts{'d2'}, $opts{fill}{fill}); } else { - my $color = _color($opts{'color'}); - unless ($color) { - $self->{ERRSTR} = $Imager::ERRSTR; - return; - } - if ($opts{d1} == 0 && $opts{d2} == 361 && $opts{aa}) { - i_circle_aa($self->{IMG}, $opts{'x'}, $opts{'y'}, $opts{'r'}, - $color); + if ($opts{fill}) { + unless (UNIVERSAL::isa($opts{fill}, 'Imager::Fill')) { + # assume it's a hash ref + require 'Imager/Fill.pm'; + unless ($opts{fill} = Imager::Fill->new(%{$opts{fill}})) { + $self->{ERRSTR} = $Imager::ERRSTR; + return; + } + } + i_arc_cfill($self->{IMG},$opts{'x'},$opts{'y'},$opts{'r'},$opts{'d1'}, + $opts{'d2'}, $opts{fill}{fill}); } else { - if ($opts{'d1'} <= $opts{'d2'}) { - i_arc($self->{IMG},$opts{'x'},$opts{'y'},$opts{'r'}, - $opts{'d1'}, $opts{'d2'}, $color); - } - else { - i_arc($self->{IMG},$opts{'x'},$opts{'y'},$opts{'r'}, - $opts{'d1'}, 361, $color); - i_arc($self->{IMG},$opts{'x'},$opts{'y'},$opts{'r'}, - 0, $opts{'d2'}, $color); + my $color = _color($opts{'color'}); + unless ($color) { + $self->{ERRSTR} = $Imager::ERRSTR; + return; } + i_arc($self->{IMG},$opts{'x'},$opts{'y'},$opts{'r'}, + $opts{'d1'}, $opts{'d2'}, $color); } } return $self; } -# Draws a line from one point to (but not including) the destination point +# Draws a line from one point to the other +# the endpoint is set if the endp parameter is set which it is by default. +# to turn of the endpoint being set use endp=>0 when calling line. sub line { my $self=shift; my $dflcl=i_color_new(0,0,0,0); - my %opts=(color=>$dflcl,@_); + my %opts=(color=>$dflcl, + endp => 1, + @_); unless ($self->{IMG}) { $self->{ERRSTR}='empty input image'; return undef; } unless (exists $opts{x1} and exists $opts{y1}) { $self->{ERRSTR}='missing begining coord'; return undef; } unless (exists $opts{x2} and exists $opts{y2}) { $self->{ERRSTR}='missing ending coord'; return undef; } my $color = _color($opts{'color'}); - unless ($color) { - $self->{ERRSTR} = $Imager::ERRSTR; - return; + unless ($color) { + $self->{ERRSTR} = $Imager::ERRSTR; + return; } + $opts{antialias} = $opts{aa} if defined $opts{aa}; if ($opts{antialias}) { - i_line_aa($self->{IMG},$opts{x1}, $opts{y1}, $opts{x2}, $opts{y2}, - $color); + i_line_aa($self->{IMG},$opts{x1}, $opts{y1}, $opts{x2}, $opts{y2}, + $color, $opts{endp}); } else { - i_draw($self->{IMG},$opts{x1}, $opts{y1}, $opts{x2}, $opts{y2}, - $color); + i_line($self->{IMG},$opts{x1}, $opts{y1}, $opts{x2}, $opts{y2}, + $color, $opts{endp}); } return $self; } @@ -1908,14 +2385,14 @@ sub polyline { if ($opts{antialias}) { for $pt(@points) { if (defined($ls)) { - i_line_aa($self->{IMG},$ls->[0],$ls->[1],$pt->[0],$pt->[1],$color); + i_line_aa($self->{IMG},$ls->[0],$ls->[1],$pt->[0],$pt->[1],$color, 1); } $ls=$pt; } } else { for $pt(@points) { if (defined($ls)) { - i_draw($self->{IMG},$ls->[0],$ls->[1],$pt->[0],$pt->[1],$color); + i_line($self->{IMG},$ls->[0],$ls->[1],$pt->[0],$pt->[1],$color,1); } $ls=$pt; } @@ -2000,6 +2477,7 @@ sub polybezier { sub flood_fill { my $self = shift; my %opts = ( color=>Imager::Color->new(255, 255, 255), @_ ); + my $rc; unless (exists $opts{'x'} && exists $opts{'y'}) { $self->{ERRSTR} = "missing seed x and y parameters"; @@ -2015,20 +2493,208 @@ sub flood_fill { return; } } - i_flood_cfill($self->{IMG}, $opts{'x'}, $opts{'y'}, $opts{fill}{fill}); + $rc = i_flood_cfill($self->{IMG}, $opts{'x'}, $opts{'y'}, $opts{fill}{fill}); } else { my $color = _color($opts{'color'}); - unless ($color) { - $self->{ERRSTR} = $Imager::ERRSTR; - return; + unless ($color) { + $self->{ERRSTR} = $Imager::ERRSTR; + return; + } + $rc = i_flood_fill($self->{IMG}, $opts{'x'}, $opts{'y'}, $color); + } + if ($rc) { $self; } else { $self->{ERRSTR} = $self->_error_as_msg(); return (); } +} + +sub setpixel { + my $self = shift; + + my %opts = ( color=>$self->{fg} || NC(255, 255, 255), @_); + + unless (exists $opts{'x'} && exists $opts{'y'}) { + $self->{ERRSTR} = 'missing x and y parameters'; + return undef; + } + + my $x = $opts{'x'}; + my $y = $opts{'y'}; + my $color = _color($opts{color}) + or return undef; + if (ref $x && ref $y) { + unless (@$x == @$y) { + $self->{ERRSTR} = 'length of x and y mismatch'; + return undef; + } + if ($color->isa('Imager::Color')) { + for my $i (0..$#{$opts{'x'}}) { + i_ppix($self->{IMG}, $x->[$i], $y->[$i], $color); + } + } + else { + for my $i (0..$#{$opts{'x'}}) { + i_ppixf($self->{IMG}, $x->[$i], $y->[$i], $color); + } + } + } + else { + if ($color->isa('Imager::Color')) { + i_ppix($self->{IMG}, $x, $y, $color); + } + else { + i_ppixf($self->{IMG}, $x, $y, $color); + } + } + + $self; +} + +sub getpixel { + my $self = shift; + + my %opts = ( "type"=>'8bit', @_); + + unless (exists $opts{'x'} && exists $opts{'y'}) { + $self->{ERRSTR} = 'missing x and y parameters'; + return undef; + } + + my $x = $opts{'x'}; + my $y = $opts{'y'}; + if (ref $x && ref $y) { + unless (@$x == @$y) { + $self->{ERRSTR} = 'length of x and y mismatch'; + return undef; + } + my @result; + if ($opts{"type"} eq '8bit') { + for my $i (0..$#{$opts{'x'}}) { + push(@result, i_get_pixel($self->{IMG}, $x->[$i], $y->[$i])); + } + } + else { + for my $i (0..$#{$opts{'x'}}) { + push(@result, i_gpixf($self->{IMG}, $x->[$i], $y->[$i])); + } + } + return wantarray ? @result : \@result; + } + else { + if ($opts{"type"} eq '8bit') { + return i_get_pixel($self->{IMG}, $x, $y); + } + else { + return i_gpixf($self->{IMG}, $x, $y); } - i_flood_fill($self->{IMG}, $opts{'x'}, $opts{'y'}, $color); } $self; } +sub getscanline { + my $self = shift; + my %opts = ( type => '8bit', x=>0, @_); + + defined $opts{width} or $opts{width} = $self->getwidth - $opts{x}; + + unless (defined $opts{'y'}) { + $self->_set_error("missing y parameter"); + return; + } + + if ($opts{type} eq '8bit') { + return i_glin($self->{IMG}, $opts{x}, $opts{x}+$opts{width}, + $opts{y}); + } + elsif ($opts{type} eq 'float') { + return i_glinf($self->{IMG}, $opts{x}, $opts{x}+$opts{width}, + $opts{y}); + } + else { + $self->_set_error("invalid type parameter - must be '8bit' or 'float'"); + return; + } +} + +sub setscanline { + my $self = shift; + my %opts = ( x=>0, @_); + + unless (defined $opts{'y'}) { + $self->_set_error("missing y parameter"); + return; + } + + if (!$opts{type}) { + if (ref $opts{pixels} && @{$opts{pixels}}) { + # try to guess the type + if ($opts{pixels}[0]->isa('Imager::Color')) { + $opts{type} = '8bit'; + } + elsif ($opts{pixels}[0]->isa('Imager::Color::Float')) { + $opts{type} = 'float'; + } + else { + $self->_set_error("missing type parameter and could not guess from pixels"); + return; + } + } + else { + # default + $opts{type} = '8bit'; + } + } + + if ($opts{type} eq '8bit') { + if (ref $opts{pixels}) { + return i_plin($self->{IMG}, $opts{x}, $opts{'y'}, @{$opts{pixels}}); + } + else { + return i_plin($self->{IMG}, $opts{x}, $opts{'y'}, $opts{pixels}); + } + } + elsif ($opts{type} eq 'float') { + if (ref $opts{pixels}) { + return i_plinf($self->{IMG}, $opts{x}, $opts{'y'}, @{$opts{pixels}}); + } + else { + return i_plinf($self->{IMG}, $opts{x}, $opts{'y'}, $opts{pixels}); + } + } + else { + $self->_set_error("invalid type parameter - must be '8bit' or 'float'"); + return; + } +} + +sub getsamples { + my $self = shift; + my %opts = ( type => '8bit', x=>0, @_); + + defined $opts{width} or $opts{width} = $self->getwidth - $opts{x}; + + unless (defined $opts{'y'}) { + $self->_set_error("missing y parameter"); + return; + } + + unless ($opts{channels}) { + $opts{channels} = [ 0 .. $self->getchannels()-1 ]; + } + + if ($opts{type} eq '8bit') { + return i_gsamp($self->{IMG}, $opts{x}, $opts{x}+$opts{width}, + $opts{y}, @{$opts{channels}}); + } + elsif ($opts{type} eq 'float') { + return i_gsampf($self->{IMG}, $opts{x}, $opts{x}+$opts{width}, + $opts{y}, @{$opts{channels}}); + } + else { + $self->_set_error("invalid type parameter - must be '8bit' or 'float'"); + return; + } +} + # make an identity matrix of the given size sub _identity { my ($size) = @_; @@ -2045,6 +2711,12 @@ sub convert { my ($self, %opts) = @_; my $matrix; + unless (defined wantarray) { + my @caller = caller; + warn "convert() called in void context - convert() returns the converted image at $caller[1] line $caller[2]\n"; + return; + } + # the user can either specify a matrix or preset # the matrix overrides the preset if (!exists($opts{matrix})) { @@ -2164,6 +2836,27 @@ sub map { return $self; } +sub difference { + my ($self, %opts) = @_; + + defined $opts{mindist} or $opts{mindist} = 0; + + defined $opts{other} + or return $self->_set_error("No 'other' parameter supplied"); + defined $opts{other}{IMG} + or return $self->_set_error("No image data in 'other' image"); + + $self->{IMG} + or return $self->_set_error("No image data"); + + my $result = Imager->new; + $result->{IMG} = i_diff_image($self->{IMG}, $opts{other}{IMG}, + $opts{mindist}) + or return $self->_set_error($self->_error_as_msg()); + + return $result; +} + # destructive border - image is shrunk by one pixel all around sub border { @@ -2210,8 +2903,17 @@ sub getmask { sub setmask { my $self = shift; my %opts = @_; - if (!defined($self->{IMG})) { $self->{ERRSTR} = 'image is empty'; return undef; } + if (!defined($self->{IMG})) { + $self->{ERRSTR} = 'image is empty'; + return undef; + } + unless (defined $opts{mask}) { + $self->_set_error("mask parameter required"); + return; + } i_img_setmask( $self->{IMG} , $opts{mask} ); + + 1; } # Get number of colors in an image @@ -2233,7 +2935,7 @@ sub string { my %input=('x'=>0, 'y'=>0, @_); $input{string}||=$input{text}; - unless(exists $input{string}) { + unless(defined $input{string}) { $self->{ERRSTR}="missing required parameter 'string'"; return; } @@ -2244,13 +2946,74 @@ sub string { } unless ($input{font}->draw(image=>$self, %input)) { - $self->{ERRSTR} = $self->_error_as_msg(); return; } return $self; } +sub align_string { + my $self = shift; + + my $img; + if (ref $self) { + unless ($self->{IMG}) { + $self->{ERRSTR}='empty input image'; + return; + } + $img = $self; + } + else { + $img = undef; + } + + my %input=('x'=>0, 'y'=>0, @_); + $input{string}||=$input{text}; + + unless(exists $input{string}) { + $self->_set_error("missing required parameter 'string'"); + return; + } + + unless($input{font}) { + $self->_set_error("missing required parameter 'font'"); + return; + } + + my @result; + unless (@result = $input{font}->align(image=>$img, %input)) { + return; + } + + return wantarray ? @result : $result[0]; +} + +my @file_limit_names = qw/width height bytes/; + +sub set_file_limits { + shift; + + my %opts = @_; + my %values; + + if ($opts{reset}) { + @values{@file_limit_names} = (0) x @file_limit_names; + } + else { + @values{@file_limit_names} = i_get_image_file_limits(); + } + + for my $key (keys %values) { + defined $opts{$key} and $values{$key} = $opts{$key}; + } + + i_set_image_file_limits($values{width}, $values{height}, $values{bytes}); +} + +sub get_file_limits { + i_get_image_file_limits(); +} + # Shortcuts that can be exported sub newcolor { Imager::Color->new(@_); } @@ -2278,6 +3041,7 @@ sub _set_error { else { $ERRSTR = $msg; } + return; } # Default guess for the type of an image from extension @@ -2344,19 +3108,19 @@ sub parseiptc { if (/^\004\004/) { @sar=split(/\034\002/); foreach $item (@sar) { - if ($item =~ m/^x/) { + if ($item =~ m/^x/) { $caption=&clean($item); $i++; } - if ($item =~ m/^P/) { + if ($item =~ m/^P/) { $photogr=&clean($item); $i++; } - if ($item =~ m/^i/) { + if ($item =~ m/^i/) { $headln=&clean($item); $i++; } - if ($item =~ m/^n/) { + if ($item =~ m/^n/) { $credit=&clean($item); $i++; } @@ -2366,7 +3130,15 @@ sub parseiptc { return (caption=>$caption,photogr=>$photogr,headln=>$headln,credit=>$credit); } -# Autoload methods go after =cut, and are processed by the autosplit program. +sub Inline { + my ($lang) = @_; + + $lang eq 'C' + or die "Only C language supported"; + + require Imager::ExtUtils; + return Imager::ExtUtils->inline_config; +} 1; __END__ @@ -2378,1548 +3150,511 @@ Imager - Perl extension for Generating 24 bit Images =head1 SYNOPSIS - use Imager; - - $img = Imager->new(); - $img->open(file=>'image.ppm',type=>'pnm') - || print "failed: ",$img->{ERRSTR},"\n"; - $scaled=$img->scale(xpixels=>400,ypixels=>400); - $scaled->write(file=>'sc_image.ppm',type=>'pnm') - || print "failed: ",$scaled->{ERRSTR},"\n"; - -=head1 DESCRIPTION - -Imager is a module for creating and altering images - It is not meant -as a replacement or a competitor to ImageMagick or GD. Both are -excellent packages and well supported. - -=head2 Overview of documentation - -=over - -=item Imager - -This document - Table of Contents, Example and Overview - -=item Imager::ImageTypes - -Direct type/virtual images, RGB(A)/paletted images, 8/16/double -bits/channel, image tags, and channel masks. - -=item Imager::Files - -IO interaction, reading/writing images, format specific tags. - -=item Imager::Draw - -Drawing Primitives, lines boxes, circles, flood fill. - -=item Imager::Color - -Color specification. - -=item Imager::Font - -General font rendering. - -=item Imager::Transformations - -Copying, scaling, cropping, flipping, blending, pasting, [convert and map.] - -=item Imager::Engines - -transform2 and matrix_transform. - -=item Imager::Filters - -Filters, sharpen, blur, noise, convolve etc. and plugins. - -=item Imager::Expr - -Expressions for evaluation engine used by transform2(). - -=item Imager::Matrix2d - -Helper class for affine transformations. - -=item Imager::Fountain - -Helper for making gradient profiles. - -=back - - - - - - - - -Almost all functions take the parameters in the hash fashion. -Example: - - $img->open(file=>'lena.png',type=>'png'); - -or just: - - $img->open(file=>'lena.png'); - -=head2 Basic concept - -An Image object is created with C<$img = Imager-Enew()> Should -this fail for some reason an explanation can be found in -C<$Imager::ERRSTR> usually error messages are stored in -C<$img-E{ERRSTR}>, but since no object is created this is the only -way to give back errors. C<$Imager::ERRSTR> is also used to report -all errors not directly associated with an image object. Examples: - - $img=Imager->new(); # This is an empty image (size is 0 by 0) - $img->open(file=>'lena.png',type=>'png'); # initializes from file - -or if you want to create an empty image: - - $img=Imager->new(xsize=>400,ysize=>300,channels=>4); - -This example creates a completely black image of width 400 and -height 300 and 4 channels. - -If you have an existing image, use img_set() to change it's dimensions -- this will destroy any existing image data: - - $img->img_set(xsize=>500, ysize=>500, channels=>4); - -To create paletted images, set the 'type' parameter to 'paletted': - - $img = Imager->new(xsize=>200, ysize=>200, channels=>3, type=>'paletted'); - -which creates an image with a maxiumum of 256 colors, which you can -change by supplying the C parameter. - -You can create a new paletted image from an existing image using the -to_paletted() method: - - $palimg = $img->to_paletted(\%opts) - -where %opts contains the options specified under L. - -You can convert a paletted image (or any image) to an 8-bit/channel -RGB image with: - - $rgbimg = $img->to_rgb8; - -Warning: if you draw on a paletted image with colors that aren't in -the palette, the image will be internally converted to a normal image. - -For improved color precision you can use the bits parameter to specify -16 bit per channel: - - $img = Imager->new(xsize=>200, ysize=>200, channels=>3, bits=>16); - -or for even more precision: - - $img = Imager->new(xsize=>200, ysize=>200, channels=>3, bits=>'double'); - -to get an image that uses a double for each channel. - -Note that as of this writing all functions should work on images with -more than 8-bits/channel, but many will only work at only -8-bit/channel precision. - -Currently only 8-bit, 16-bit, and double per channel image types are -available, this may change later. - -Color objects are created by calling the Imager::Color->new() -method: - - $color = Imager::Color->new($red, $green, $blue); - $color = Imager::Color->new($red, $green, $blue, $alpha); - $color = Imager::Color->new("#C0C0FF"); # html color specification - -This object can then be passed to functions that require a color parameter. - -Coordinates in Imager have the origin in the upper left corner. The -horizontal coordinate increases to the right and the vertical -downwards. - -=head2 Reading and writing images - -You can read and write a variety of images formats, assuming you have -the appropriate libraries, and images can be read or written to/from -files, file handles, file descriptors, scalars, or through callbacks. - -To see which image formats Imager is compiled to support the following -code snippet is sufficient: - - use Imager; - print join " ", keys %Imager::formats; - -This will include some other information identifying libraries rather -than file formats. - -Reading writing to and from files is simple, use the C -method to read an image: - - my $img = Imager->new; - $img->read(file=>$filename, type=>$type) - or die "Cannot read $filename: ", $img->errstr; - -and the C method to write an image: - - $img->write(file=>$filename, type=>$type) - or die "Cannot write $filename: ", $img->errstr; - -If the I includes an extension that Imager recognizes, then -you don't need the I, but you may want to provide one anyway. -Imager currently does not check the files magic to determine the -format. It is possible to override the method for determining the -filetype from the filename. If the data is given in another form than -a file name a - -When you read an image, Imager may set some tags, possibly including -information about the spatial resolution, textual information, and -animation information. See L for specifics. - -When reading or writing you can specify one of a variety of sources or -targets: - -=over - -=item file - -The C parameter is the name of the image file to be written to -or read from. If Imager recognizes the extension of the file you do -not need to supply a C. - -=item fh - -C is a file handle, typically either returned from -C<new()>>, or a glob from an C call. You should call -C on the handle before passing it to Imager. - -=item fd - -C is a file descriptor. You can get this by calling the -C function on a file handle, or by using one of the standard -file descriptor numbers. - -=item data - -When reading data, C is a scalar containing the image file data, -when writing, C is a reference to the scalar to save the image -file data too. For GIF images you will need giflib 4 or higher, and -you may need to patch giflib to use this option for writing. - -=item callback - -Imager will make calls back to your supplied coderefs to read, write -and seek from/to/through the image file. - -When reading from a file you can use either C or C -to supply the read callback, and when writing C or -C to supply the write callback. - -When writing you can also supply the C option to set the -maximum amount of data that will be buffered before your write -callback is called. Note: the amount of data supplied to your -callback can be smaller or larger than this size. - -The read callback is called with 2 parameters, the minimum amount of -data required, and the maximum amount that Imager will store in it's C -level buffer. You may want to return the minimum if you have a slow -data source, or the maximum if you have a fast source and want to -prevent many calls to your perl callback. The read data should be -returned as a scalar. - -Your write callback takes exactly one parameter, a scalar containing -the data to be written. Return true for success. - -The seek callback takes 2 parameters, a I, and a I, -defined in the same way as perl's seek function. - -You can also supply a C which is called with no parameters -when there is no more data to be written. This could be used to flush -buffered data. - -=back - -C<$img-Eread()> generally takes two parameters, 'file' and 'type'. -If the type of the file can be determined from the suffix of the file -it can be omitted. Format dependant parameters are: For images of -type 'raw' two extra parameters are needed 'xsize' and 'ysize', if the -'channel' parameter is omitted for type 'raw' it is assumed to be 3. -gif and png images might have a palette are converted to truecolor bit -when read. Alpha channel is preserved for png images irregardless of -them being in RGB or gray colorspace. Similarly grayscale jpegs are -one channel images after reading them. For jpeg images the iptc -header information (stored in the APP13 header) is avaliable to some -degree. You can get the raw header with C<$img-E{IPTCRAW}>, but -you can also retrieve the most basic information with -C<%hsh=$img-Eparseiptc()> as always patches are welcome. pnm has no -extra options. Examples: - - $img = Imager->new(); - $img->read(file=>"cover.jpg") or die $img->errstr; # gets type from name - - $img = Imager->new(); - { local(*FH,$/); open(FH,"file.gif") or die $!; $a=; } - $img->read(data=>$a,type=>'gif') or die $img->errstr; - -The second example shows how to read an image from a scalar, this is -usefull if your data originates from somewhere else than a filesystem -such as a database over a DBI connection. - -When writing to a tiff image file you can also specify the 'class' -parameter, which can currently take a single value, "fax". If class -is set to fax then a tiff image which should be suitable for faxing -will be written. For the best results start with a grayscale image. -By default the image is written at fine resolution you can override -this by setting the "fax_fine" parameter to 0. - -If you are reading from a gif image file, you can supply a 'colors' -parameter which must be a reference to a scalar. The referenced -scalar will receive an array reference which contains the colors, each -represented as an Imager::Color object. - -If you already have an open file handle, for example a socket or a -pipe, you can specify the 'fd' parameter instead of supplying a -filename. Please be aware that you need to use fileno() to retrieve -the file descriptor for the file: - - $img->read(fd=>fileno(FILE), type=>'gif') or die $img->errstr; - -For writing using the 'fd' option you will probably want to set $| for -that descriptor, since the writes to the file descriptor bypass Perl's -(or the C libraries) buffering. Setting $| should avoid out of order -output. For example a common idiom when writing a CGI script is: - - # the $| _must_ come before you send the content-type - $| = 1; - print "Content-Type: image/jpeg\n\n"; - $img->write(fd=>fileno(STDOUT), type=>'jpeg') or die $img->errstr; - -*Note that load() is now an alias for read but will be removed later* - -C<$img-Ewrite> has the same interface as C. The earlier -comments on C for autodetecting filetypes apply. For jpegs -quality can be adjusted via the 'jpegquality' parameter (0-100). The -number of colorplanes in gifs are set with 'gifplanes' and should be -between 1 (2 color) and 8 (256 colors). It is also possible to choose -between two quantizing methods with the parameter 'gifquant'. If set -to mc it uses the mediancut algorithm from either giflibrary. If set -to lm it uses a local means algorithm. It is then possible to give -some extra settings. lmdither is the dither deviation amount in pixels -(manhattan distance). lmfixed can be an array ref who holds an array -of Imager::Color objects. Note that the local means algorithm needs -much more cpu time but also gives considerable better results than the -median cut algorithm. - -When storing targa images rle compression can be activated with the -'compress' parameter, the 'idstring' parameter can be used to set the -targa comment field and the 'wierdpack' option can be used to use the -15 and 16 bit targa formats for rgb and rgba data. The 15 bit format -has 5 of each red, green and blue. The 16 bit format in addition -allows 1 bit of alpha. The most significant bits are used for each -channel. - -Currently just for gif files, you can specify various options for the -conversion from Imager's internal RGB format to the target's indexed -file format. If you set the gifquant option to 'gen', you can use the -options specified under L. - -To see what Imager is compiled to support the following code snippet -is sufficient: + # Thumbnail example + #!/usr/bin/perl -w + use strict; use Imager; - print "@{[keys %Imager::formats]}"; - -When reading raw images you need to supply the width and height of the -image in the xsize and ysize options: - - $img->read(file=>'foo.raw', xsize=>100, ysize=>100) - or die "Cannot read raw image\n"; - -If your input file has more channels than you want, or (as is common), -junk in the fourth channel, you can use the datachannels and -storechannels options to control the number of channels in your input -file and the resulting channels in your image. For example, if your -input image uses 32-bits per pixel with red, green, blue and junk -values for each pixel you could do: - - $img->read(file=>'foo.raw', xsize=>100, ysize=>100, datachannels=>4, - storechannels=>3) - or die "Cannot read raw image\n"; - -Normally the raw image is expected to have the value for channel 1 -immediately following channel 0 and channel 2 immediately following -channel 1 for each pixel. If your input image has all the channel 0 -values for the first line of the image, followed by all the channel 1 -values for the first line and so on, you can use the interleave option: - - $img->read(file=>'foo.raw', xsize=100, ysize=>100, interleave=>1) - or die "Cannot read raw image\n"; - -=head2 Multi-image files - -Currently just for gif files, you can create files that contain more -than one image. - -To do this: - - Imager->write_multi(\%opts, @images) -Where %opts describes 4 possible types of outputs: + die "Usage: thumbmake.pl filename\n" if !-f $ARGV[0]; + my $file = shift; -=over 5 + my $format; -=item type - -This is C for gif animations. - -=item callback - -A code reference which is called with a single parameter, the data to -be written. You can also specify $opts{maxbuffer} which is the -maximum amount of data buffered. Note that there can be larger writes -than this if the file library writes larger blocks. A smaller value -maybe useful for writing to a socket for incremental display. - -=item fd - -The file descriptor to save the images to. - -=item file - -The name of the file to write to. - -%opts may also include the keys from L and L. + my $img = Imager->new(); + # see Imager::Files for information on the read() method + $img->read(file=>$file) or die $img->errstr(); -=back + $file =~ s/\.[^.]*$//; -You must also specify the file format using the 'type' option. + # Create smaller version + # documented in Imager::Transformations + my $thumb = $img->scale(scalefactor=>.3); -The current aim is to support other multiple image formats in the -future, such as TIFF, and to support reading multiple images from a -single file. + # Autostretch individual channels + $thumb->filter(type=>'autolevels'); -A simple example: + # try to save in one of these formats + SAVE: - my @images; - # ... code to put images in @images - Imager->write_multi({type=>'gif', - file=>'anim.gif', - gif_delays=>[ (10) x @images ] }, - @images) - or die "Oh dear!"; + for $format ( qw( png gif jpg tiff ppm ) ) { + # Check if given format is supported + if ($Imager::formats{$format}) { + $file.="_low.$format"; + print "Storing image as: $file\n"; + # documented in Imager::Files + $thumb->write(file=>$file) or + die $thumb->errstr; + last SAVE; + } + } -You can read multi-image files (currently only GIF files) using the -read_multi() method: +=head1 DESCRIPTION - my @imgs = Imager->read_multi(file=>'foo.gif') - or die "Cannot read images: ",Imager->errstr; +Imager is a module for creating and altering images. It can read and +write various image formats, draw primitive shapes like lines,and +polygons, blend multiple images together in various ways, scale, crop, +render text and more. -The possible parameters for read_multi() are: +=head2 Overview of documentation =over -=item file - -The name of the file to read in. - -=item fh - -A filehandle to read in. This can be the name of a filehandle, but it -will need the package name, no attempt is currently made to adjust -this to the caller's package. - -=item fd - -The numeric file descriptor of an open file (or socket). - -=item callback - -A function to be called to read in data, eg. reading a blob from a -database incrementally. - -=item data - -The data of the input file in memory. - -=item type - -The type of file. If the file is parameter is given and provides -enough information to guess the type, then this parameter is optional. - -=back - -Note: you cannot use the callback or data parameter with giflib -versions before 4.0. - -When reading from a GIF file with read_multi() the images are returned -as paletted images. - -=head2 Gif options - -These options can be specified when calling write_multi() for gif -files, when writing a single image with the gifquant option set to -'gen', or for direct calls to i_writegif_gen and i_writegif_callback. - -Note that some viewers will ignore some of these options -(gif_user_input in particular). - -=over 4 +=item * -=item gif_each_palette +Imager - This document - Synopsis Example, Table of Contents and +Overview. -Each image in the gif file has it's own palette if this is non-zero. -All but the first image has a local colour table (the first uses the -global colour table. +=item * -=item interlace +L - a brief introduction to Imager. -The images are written interlaced if this is non-zero. +=item * -=item gif_delays +L - how to do various things with Imager. -A reference to an array containing the delays between images, in 1/100 -seconds. +=item * -If you want the same delay for every frame you can simply set this to -the delay in 1/100 seconds. +L - Basics of constructing image objects with +C: Direct type/virtual images, RGB(A)/paletted images, +8/16/double bits/channel, color maps, channel masks, image tags, color +quantization. Also discusses basic image information methods. -=item gif_user_input +=item * -A reference to an array contains user input flags. If the given flag -is non-zero the image viewer should wait for input before displaying -the next image. +L - IO interaction, reading/writing images, format +specific tags. -=item gif_disposal +=item * -A reference to an array of image disposal methods. These define what -should be done to the image before displaying the next one. These are -integers, where 0 means unspecified, 1 means the image should be left -in place, 2 means restore to background colour and 3 means restore to -the previous value. +L - Drawing Primitives, lines, boxes, circles, arcs, +flood fill. -=item gif_tran_color +=item * -A reference to an Imager::Color object, which is the colour to use for -the palette entry used to represent transparency in the palette. You -need to set the transp option (see L) for this -value to be used. +L - Color specification. -=item gif_positions +=item * -A reference to an array of references to arrays which represent screen -positions for each image. +L - Fill pattern specification. -=item gif_loop_count +=item * -If this is non-zero the Netscape loop extension block is generated, -which makes the animation of the images repeat. +L - General font rendering, bounding boxes and font +metrics. -This is currently unimplemented due to some limitations in giflib. +=item * -=item gif_eliminate_unused +L - Copying, scaling, cropping, flipping, +blending, pasting, convert and map. -If this is true, when you write a paletted image any unused colors -will be eliminated from its palette. This is set by default. +=item * -=back +L - Programmable transformations through +C, C and C. -=head2 Quantization options +=item * -These options can be specified when calling write_multi() for gif -files, when writing a single image with the gifquant option set to -'gen', or for direct calls to i_writegif_gen and i_writegif_callback. +L - Filters, sharpen, blur, noise, convolve etc. and +filter plugins. -=over 4 +=item * -=item colors +L - Expressions for evaluation engine used by +transform2(). -A arrayref of colors that are fixed. Note that some color generators -will ignore this. +=item * -=item transp +L - Helper class for affine transformations. -The type of transparency processing to perform for images with an -alpha channel where the output format does not have a proper alpha -channel (eg. gif). This can be any of: +=item * -=over 4 +L - Helper for making gradient profiles. -=item none +=item * -No transparency processing is done. (default) +L - using Imager's C API -=item threshold +=item * -Pixels more transparent that tr_threshold are rendered as transparent. +L - API function reference -=item errdiff +=item * -An error diffusion dither is done on the alpha channel. Note that -this is independent of the translation performed on the colour -channels, so some combinations may cause undesired artifacts. +L - using Imager's C API from Inline::C -=item ordered +=item * -The ordered dither specified by tr_orddith is performed on the alpha -channel. +L - tools to get access to Imager's C API. =back -This will only be used if the image has an alpha channel, and if there -is space in the palette for a transparency colour. - -=item tr_threshold - -The highest alpha value at which a pixel will be made transparent when -transp is 'threshold'. (0-255, default 127) - -=item tr_errdiff +=head2 Basic Overview -The type of error diffusion to perform on the alpha channel when -transp is 'errdiff'. This can be any defined error diffusion type -except for custom (see errdiff below). +An Image object is created with C<$img = Imager-Enew()>. +Examples: -=item tr_orddith + $img=Imager->new(); # create empty image + $img->read(file=>'lena.png',type=>'png') or # read image from file + die $img->errstr(); # give an explanation + # if something failed -The type of ordered dither to perform on the alpha channel when transp -is 'ordered'. Possible values are: +or if you want to create an empty image: -=over 4 + $img=Imager->new(xsize=>400,ysize=>300,channels=>4); -=item random +This example creates a completely black image of width 400 and height +300 and 4 channels. -A semi-random map is used. The map is the same each time. +When an operation fails which can be directly associated with an image +the error message is stored can be retrieved with +C<$img-Eerrstr()>. -=item dot8 +In cases where no image object is associated with an operation +C<$Imager::ERRSTR> is used to report errors not directly associated +with an image object. You can also call Cerrstr> to get this +value. -8x8 dot dither. +The Cnew> method is described in detail in +L. -=item dot4 +=head1 METHOD INDEX -4x4 dot dither +Where to find information on methods for Imager class objects. -=item hline +addcolors() - L -horizontal line dither. +addtag() - L - add image tags -=item vline +arc() - L -vertical line dither. +align_string() - L -=item "/line" +bits() - L - number of bits per sample for the +image -=item slashline +box() - L -diagonal line dither +circle() - L -=item '\line' +colorcount() - L -=item backline +convert() - L - +transform the color space -diagonal line dither +copy() - L -=item tiny +crop() - L - extract part of an image -dot matrix dither (currently the default). This is probably the best -for displays (like web pages). +deltag() - L - delete image tags -=item custom +difference() - L -A custom dither matrix is used - see tr_map +errstr() - L<"Basic Overview"> -=back +filter() - L -=item tr_map +findcolor() - L - search the image palette, if it +has one -When tr_orddith is custom this defines an 8 x 8 matrix of integers -representing the transparency threshold for pixels corresponding to -each position. This should be a 64 element array where the first 8 -entries correspond to the first row of the matrix. Values should be -betweern 0 and 255. +flip() - L -=item make_colors +flood_fill() - L -Defines how the quantization engine will build the palette(s). -Currently this is ignored if 'translate' is 'giflib', but that may -change. Possible values are: +getchannels() - L -=over 4 +getcolorcount() - L -=item none +getcolors() - L - get colors from the image +palette, if it has one -Only colors supplied in 'colors' are used. +get_file_limits() - L -=item webmap +getheight() - L -The web color map is used (need url here.) +getpixel() - L -=item addi +getsamples() - L -The original code for generating the color map (Addi's code) is used. +getscanline() - L -=back +getwidth() - L -Other methods may be added in the future. +img_set() - L -=item colors +line() - L -A arrayref containing Imager::Color objects, which represents the -starting set of colors to use in translating the images. webmap will -ignore this. The final colors used are copied back into this array -(which is expanded if necessary.) +map() - L - remap color +channel values -=item max_colors +masked() - L - make a masked image -The maximum number of colors to use in the image. +matrix_transform() - L -=item translate +maxcolors() - L -The method used to translate the RGB values in the source image into -the colors selected by make_colors. Note that make_colors is ignored -whene translate is 'giflib'. +new() - L -Possible values are: +open() - L - an alias for read() -=over 4 +paste() - L - draw an image onto an image -=item giflib +polygon() - L -The giflib native quantization function is used. +polyline() - L -=item closest +read() - L - read a single image from an image file -The closest color available is used. +read_multi() - L - read multiple images from an image +file -=item perturb +rotate() - L -The pixel color is modified by perturb, and the closest color is chosen. +rubthrough() - L - draw an image onto an +image and use the alpha channel -=item errdiff +scale() - L -An error diffusion dither is performed. +scaleX() - L -=back +scaleY() - L -It's possible other transate values will be added. +setcolors() - L - set palette colors in +a paletted image -=item errdiff +setpixel() - L -The type of error diffusion dither to perform. These values (except -for custom) can also be used in tr_errdif. +setscanline() - L -=over 4 +settag() - L -=item floyd +set_file_limits() - L -Floyd-Steinberg dither +string() - L - draw text on an image -=item jarvis +tags() - L - fetch image tags -Jarvis, Judice and Ninke dither +to_paletted() - L -=item stucki +to_rgb8() - L -Stucki dither +transform() - L -=item custom +transform2() - L -Custom. If you use this you must also set errdiff_width, -errdiff_height and errdiff_map. +type() - L - type of image (direct vs paletted) -=back +virtual() - L - whether the image has it's own +data -=item errdiff_width +write() - L - write an image to a file -=item errdiff_height +write_multi() - L - write multiple image to an image +file. -=item errdiff_orig +=head1 CONCEPT INDEX -=item errdiff_map +animated GIF - L -When translate is 'errdiff' and errdiff is 'custom' these define a -custom error diffusion map. errdiff_width and errdiff_height define -the size of the map in the arrayref in errdiff_map. errdiff_orig is -an integer which indicates the current pixel position in the top row -of the map. +aspect ratio - L, +L, L -=item perturb +blend - alpha blending one image onto another +L -When translate is 'perturb' this is the magnitude of the random bias -applied to each channel of the pixel before it is looked up in the -color table. +blur - L, L -=back +boxes, drawing - L +changes between image - L +color - L -=head2 Filters +color names - L, L -A special image method is the filter method. An example is: +combine modes - L - $img->filter(type=>'autolevels'); +compare images - L -This will call the autolevels filter. Here is a list of the filters -that are always avaliable in Imager. This list can be obtained by -running the C script that comes with the module -source. +contrast - L, L - Filter Arguments - autolevels lsat(0.1) usat(0.1) skew(0) - bumpmap bump elevation(0) lightx lighty st(2) - bumpmap_complex bump channel(0) tx(0) ty(0) Lx(0.2) Ly(0.4) - Lz(-1) cd(1.0) cs(40.0) n(1.3) Ia(0 0 0) Il(255 255 255) - Is(255 255 255) - contrast intensity - conv coef - fountain xa ya xb yb ftype(linear) repeat(none) combine(none) - super_sample(none) ssample_param(4) segments(see below) - gaussian stddev - gradgen xo yo colors dist - hardinvert - mosaic size(20) - noise amount(3) subtype(0) - postlevels levels(10) - radnoise xo(100) yo(100) ascale(17.0) rscale(0.02) - turbnoise xo(0.0) yo(0.0) scale(10.0) - unsharpmask stddev(2.0) scale(1.0) - watermark wmark pixdiff(10) tx(0) ty(0) +convolution - L -The default values are in parenthesis. All parameters must have some -value but if a parameter has a default value it may be omitted when -calling the filter function. +cropping - L -The filters are: +C images - L -=over +dpi - L -=item autolevels +drawing boxes - L -scales the value of each channel so that the values in the image will -cover the whole possible range for the channel. I and I -truncate the range by the specified fraction at the top and bottom of -the range respectivly.. +drawing lines - L -=item bumpmap +drawing text - L, L -uses the channel I image I as a bumpmap on your -image, with the light at (I, I), with a shadow length -of I. +error message - L<"Basic Overview"> -=item bumpmap_complex +files, font - L -uses the channel I image I as a bumpmap on your image. -If Lz<0 the three L parameters are considered to be the direction of -the light. If Lz>0 the L parameters are considered to be the light -position. I is the ambient colour, I is the light colour, -I is the color of specular highlights. I is the diffuse -coefficient and I is the specular coefficient. I is the -shininess of the surface. +files, image - L -=item contrast +filling, types of fill - L -scales each channel by I. Values of I < 1.0 -will reduce the contrast. +filling, boxes - L -=item conv +filling, flood fill - L -performs 2 1-dimensional convolutions on the image using the values -from I. I should be have an odd length. +flood fill - L -=item fountain +fonts - L -renders a fountain fill, similar to the gradient tool in most paint -software. The default fill is a linear fill from opaque black to -opaque white. The points A(xa, ya) and B(xb, yb) control the way the -fill is performed, depending on the ftype parameter: +fonts, drawing with - L, L, +L -=over +fonts, metrics - L, L -=item linear +fonts, multiple master - L -the fill ramps from A through to B. +fountain fill - L, +L, L, +L -=item bilinear +GIF files - L -the fill ramps in both directions from A, where AB defines the length -of the gradient. +GIF files, animated - L -=item radial +gradient fill - L, +L, L, +L -A is the center of a circle, and B is a point on it's circumference. -The fill ramps from the center out to the circumference. +guassian blur - L -=item radial_square +hatch fills - L -A is the center of a square and B is the center of one of it's sides. -This can be used to rotate the square. The fill ramps out to the -edges of the square. +invert image - L -=item revolution +JPEG - L -A is the centre of a circle and B is a point on it's circumference. B -marks the 0 and 360 point on the circle, with the fill ramping -clockwise. +limiting image sizes - L -=item conical +lines, drawing - L -A is the center of a circle and B is a point on it's circumference. B -marks the 0 and point on the circle, with the fill ramping in both -directions to meet opposite. +matrix - L, +L, +L -=back +metadata, image - L -The I option controls how the fill is repeated for some -Is after it leaves the AB range: +mosaic - L -=over +noise, filter - L -=item none +noise, rendered - L, +L -no repeats, points outside of each range are treated as if they were -on the extreme end of that range. +paste - L, +L -=item sawtooth +pseudo-color image - L, +L -the fill simply repeats in the positive direction +posterize - L -=item triangle +png files - L, L -the fill repeats in reverse and then forward and so on, in the -positive direction +pnm - L -=item saw_both +rectangles, drawing - L -the fill repeats in both the positive and negative directions (only -meaningful for a linear fill). +resizing an image - L, +L -=item tri_both +saving an image - L -as for triangle, but in the negative direction too (only meaningful -for a linear fill). +scaling - L -=back +sharpen - L, L -By default the fill simply overwrites the whole image (unless you have -parts of the range 0 through 1 that aren't covered by a segment), if -any segments of your fill have any transparency, you can set the -I option to 'normal' to have the fill combined with the -existing pixels. See the description of I in L. +size, image - L, +L -If your fill has sharp edges, for example between steps if you use -repeat set to 'triangle', you may see some aliased or ragged edges. -You can enable super-sampling which will take extra samples within the -pixel in an attempt anti-alias the fill. +size, text - L -The possible values for the super_sample option are: +tags, image metadata - L -=over +text, drawing - L, L, +L -=item none +text, wrapping text in an area - L -no super-sampling is done +text, measuring - L, L -=item grid +tiles, color - L -a square grid of points are sampled. The number of points sampled is -the square of ceil(0.5 + sqrt(ssample_param)). +unsharp mask - L -=item random +watermark - L -a random set of points within the pixel are sampled. This looks -pretty bad for low ssample_param values. +writing an image to a file - L -=item circle +=head1 SUPPORT -the points on the radius of a circle within the pixel are sampled. -This seems to produce the best results, but is fairly slow (for now). +You can ask for help, report bugs or express your undying love for +Imager on the Imager-devel mailing list. -=back +To subscribe send a message with C in the body to: -You can control the level of sampling by setting the ssample_param -option. This is roughly the number of points sampled, but depends on -the type of sampling. + imager-devel+request@molar.is -The segments option is an arrayref of segments. You really should use -the Imager::Fountain class to build your fountain fill. Each segment -is an array ref containing: +or use the form at: =over -=item start - -a floating point number between 0 and 1, the start of the range of fill parameters covered by this segment. - -=item middle - -a floating point number between start and end which can be used to -push the color range towards one end of the segment. - -=item end - -a floating point number between 0 and 1, the end of the range of fill -parameters covered by this segment. This should be greater than -start. - -=item c0 - -=item c1 - -The colors at each end of the segment. These can be either -Imager::Color or Imager::Color::Float objects. - -=item segment type - -The type of segment, this controls the way the fill parameter varies -over the segment. 0 for linear, 1 for curved (unimplemented), 2 for -sine, 3 for sphere increasing, 4 for sphere decreasing. - -=item color type - -The way the color varies within the segment, 0 for simple RGB, 1 for -hue increasing and 2 for hue decreasing. +L =back -Don't forget to use Imager::Fountain instead of building your own. -Really. It even loads GIMP gradient files. - -=item gaussian - -performs a gaussian blur of the image, using I as the standard -deviation of the curve used to combine pixels, larger values give -bigger blurs. For a definition of Gaussian Blur, see: - - http://www.maths.abdn.ac.uk/~igc/tch/mx4002/notes/node99.html +where you can also find the mailing list archive. -=item gradgen - -renders a gradient, with the given I at the corresponding -points (x,y) in I and I. You can specify the way distance is -measured for color blendeing by setting I to 0 for Euclidean, 1 -for Euclidean squared, and 2 for Manhattan distance. - -=item hardinvert - -inverts the image, black to white, white to black. All channels are -inverted, including the alpha channel if any. - -=item mosaic - -produces averaged tiles of the given I. - -=item noise - -adds noise of the given I to the image. If I is -zero, the noise is even to each channel, otherwise noise is added to -each channel independently. - -=item radnoise - -renders radiant Perlin turbulent noise. The centre of the noise is at -(I, I), I controls the angular scale of the noise , -and I the radial scale, higher numbers give more detail. - -=item postlevels - -alters the image to have only I distinct level in each -channel. - -=item turbnoise - -renders Perlin turbulent noise. (I, I) controls the origin of -the noise, and I the scale of the noise, with lower numbers -giving more detail. - -=item unsharpmask - -performs an unsharp mask on the image. This is the result of -subtracting a gaussian blurred version of the image from the original. -I controls the stddev parameter of the gaussian blur. Each -output pixel is: in + I * (in - blurred). - -=item watermark - -applies I as a watermark on the image with strength I, -with an origin at (I, I) - -=back - -A demonstration of most of the filters can be found at: - - http://www.develop-help.com/imager/filters.html - -(This is a slow link.) - -=head2 Color transformations - -You can use the convert method to transform the color space of an -image using a matrix. For ease of use some presets are provided. - -The convert method can be used to: - -=over 4 - -=item * +If you're into IRC, you can typically find the developers in #Imager +on irc.perl.org. As with any IRC channel, the participants could be +occupied or asleep, so please be patient. -convert an RGB or RGBA image to grayscale. - -=item * - -convert a grayscale image to RGB. - -=item * - -extract a single channel from an image. - -=item * - -set a given channel to a particular value (or from another channel) - -=back - -The currently defined presets are: +You can report bugs by pointing your browser at: =over -=item gray - -=item grey - -converts an RGBA image into a grayscale image with alpha channel, or -an RGB image into a grayscale image without an alpha channel. - -This weights the RGB channels at 22.2%, 70.7% and 7.1% respectively. - -=item noalpha - -removes the alpha channel from a 2 or 4 channel image. An identity -for other images. - -=item red - -=item channel0 - -extracts the first channel of the image into a single channel image - -=item green - -=item channel1 - -extracts the second channel of the image into a single channel image - -=item blue - -=item channel2 - -extracts the third channel of the image into a single channel image - -=item alpha - -extracts the alpha channel of the image into a single channel image. - -If the image has 1 or 3 channels (assumed to be grayscale of RGB) then -the resulting image will be all white. - -=item rgb - -converts a grayscale image to RGB, preserving the alpha channel if any - -=item addalpha - -adds an alpha channel to a grayscale or RGB image. Preserves an -existing alpha channel for a 2 or 4 channel image. +L =back -For example, to convert an RGB image into a greyscale image: - - $new = $img->convert(preset=>'grey'); # or gray - -or to convert a grayscale image to an RGB image: - - $new = $img->convert(preset=>'rgb'); - -The presets aren't necessary simple constants in the code, some are -generated based on the number of channels in the input image. - -If you want to perform some other colour transformation, you can use -the 'matrix' parameter. - -For each output pixel the following matrix multiplication is done: - - channel[0] [ [ $c00, $c01, ... ] inchannel[0] - [ ... ] = ... x [ ... ] - channel[n-1] [ $cn0, ..., $cnn ] ] inchannel[max] - 1 - -So if you want to swap the red and green channels on a 3 channel image: - - $new = $img->convert(matrix=>[ [ 0, 1, 0 ], - [ 1, 0, 0 ], - [ 0, 0, 1 ] ]); - -or to convert a 3 channel image to greyscale using equal weightings: - - $new = $img->convert(matrix=>[ [ 0.333, 0.333, 0.334 ] ]) - -=head2 Color Mappings - -You can use the map method to map the values of each channel of an -image independently using a list of lookup tables. It's important to -realize that the modification is made inplace. The function simply -returns the input image again or undef on failure. - -Each channel is mapped independently through a lookup table with 256 -entries. The elements in the table should not be less than 0 and not -greater than 255. If they are out of the 0..255 range they are -clamped to the range. If a table does not contain 256 entries it is -silently ignored. - -Single channels can mapped by specifying their name and the mapping -table. The channel names are C, C, C, C. - - @map = map { int( $_/2 } 0..255; - $img->map( red=>\@map ); - -It is also possible to specify a single map that is applied to all -channels, alpha channel included. For example this applies a gamma -correction with a gamma of 1.4 to the input image. - - $gamma = 1.4; - @map = map { int( 0.5 + 255*($_/255)**$gamma ) } 0..255; - $img->map(all=> \@map); - -The C map is used as a default channel, if no other map is -specified for a channel then the C map is used instead. If we -had not wanted to apply gamma to the alpha channel we would have used: - - $img->map(all=> \@map, alpha=>[]); - -Since C<[]> contains fewer than 256 element the gamma channel is -unaffected. - -It is also possible to simply specify an array of maps that are -applied to the images in the rgba order. For example to apply -maps to the C and C channels one would use: - - $img->map(maps=>[\@redmap, [], \@bluemap]); +Please remember to include the versions of Imager, perl, supporting +libraries, and any relevant code. If you have specific images that +cause the problems, please include those too. +=head1 BUGS +Bugs are listed individually for relevant pod pages. -=head2 Transformations - -Another special image method is transform. It can be used to generate -warps and rotations and such features. It can be given the operations -in postfix notation or the module Affix::Infix2Postfix can be used. -Look in the test case t/t55trans.t for an example. - -transform() needs expressions (or opcodes) that determine the source -pixel for each target pixel. Source expressions are infix expressions -using any of the +, -, *, / or ** binary operators, the - unary -operator, ( and ) for grouping and the sin() and cos() functions. The -target pixel is input as the variables x and y. - -You specify the x and y expressions as xexpr and yexpr respectively. -You can also specify opcodes directly, but that's magic deep enough -that you can look at the source code. - -You can still use the transform() function, but the transform2() -function is just as fast and is more likely to be enhanced and -maintained. - -Later versions of Imager also support a transform2() class method -which allows you perform a more general set of operations, rather than -just specifying a spatial transformation as with the transform() -method, you can also perform colour transformations, image synthesis -and image combinations. - -transform2() takes an reference to an options hash, and a list of -images to operate one (this list may be empty): - - my %opts; - my @imgs; - ... - my $img = Imager::transform2(\%opts, @imgs) - or die "transform2 failed: $Imager::ERRSTR"; - -The options hash may define a transformation function, and optionally: - -=over 4 - -=item * - -width - the width of the image in pixels. If this isn't supplied the -width of the first input image is used. If there are no input images -an error occurs. - -=item * - -height - the height of the image in pixels. If this isn't supplied -the height of the first input image is used. If there are no input -images an error occurs. - -=item * - -constants - a reference to hash of constants to define for the -expression engine. Some extra constants are defined by Imager - -=back - -The tranformation function is specified using either the expr or -rpnexpr member of the options. - -=over 4 - -=item Infix expressions - -You can supply infix expressions to transform 2 with the expr keyword. - -$opts{expr} = 'return getp1(w-x, h-y)' - -The 'expression' supplied follows this general grammar: - - ( identifier '=' expr ';' )* 'return' expr - -This allows you to simplify your expressions using variables. - -A more complex example might be: - -$opts{expr} = 'pix = getp1(x,y); return if(value(pix)>0.8,pix*0.8,pix)' - -Currently to use infix expressions you must have the Parse::RecDescent -module installed (available from CPAN). There is also what might be a -significant delay the first time you run the infix expression parser -due to the compilation of the expression grammar. - -=item Postfix expressions - -You can supply postfix or reverse-polish notation expressions to -transform2() through the rpnexpr keyword. - -The parser for rpnexpr emulates a stack machine, so operators will -expect to see their parameters on top of the stack. A stack machine -isn't actually used during the image transformation itself. - -You can store the value at the top of the stack in a variable called -foo using !foo and retrieve that value again using @foo. The !foo -notation will pop the value from the stack. - -An example equivalent to the infix expression above: - - $opts{rpnexpr} = 'x y getp1 !pix @pix value 0.8 gt @pix 0.8 * @pix ifp' - -=back - -transform2() has a fairly rich range of operators. - -=over 4 - -=item +, *, -, /, %, ** - -multiplication, addition, subtraction, division, remainder and -exponentiation. Multiplication, addition and subtraction can be used -on colour values too - though you need to be careful - adding 2 white -values together and multiplying by 0.5 will give you grey, not white. - -Division by zero (or a small number) just results in a large number. -Modulo zero (or a small number) results in zero. - -=item sin(N), cos(N), atan2(y,x) - -Some basic trig functions. They work in radians, so you can't just -use the hue values. - -=item distance(x1, y1, x2, y2) - -Find the distance between two points. This is handy (along with -atan2()) for producing circular effects. - -=item sqrt(n) - -Find the square root. I haven't had much use for this since adding -the distance() function. - -=item abs(n) - -Find the absolute value. - -=item getp1(x,y), getp2(x,y), getp3(x, y) - -Get the pixel at position (x,y) from the first, second or third image -respectively. I may add a getpn() function at some point, but this -prevents static checking of the instructions against the number of -images actually passed in. - -=item value(c), hue(c), sat(c), hsv(h,s,v) - -Separates a colour value into it's value (brightness), hue (colour) -and saturation elements. Use hsv() to put them back together (after -suitable manipulation). - -=item red(c), green(c), blue(c), rgb(r,g,b) - -Separates a colour value into it's red, green and blue colours. Use -rgb(r,g,b) to put it back together. - -=item int(n) - -Convert a value to an integer. Uses a C int cast, so it may break on -large values. - -=item if(cond,ntrue,nfalse), if(cond,ctrue,cfalse) - -A simple (and inefficient) if function. - -=item <=,<,==,>=,>,!= - -Relational operators (typically used with if()). Since we're working -with floating point values the equalities are 'near equalities' - an -epsilon value is used. - -=item &&, ||, not(n) - -Basic logical operators. - -=back - -A few examples: - -=over 4 - -=item rpnexpr=>'x 25 % 15 * y 35 % 10 * getp1 !pat x y getp1 !pix @pix sat 0.7 gt @pat @pix ifp' - -tiles a smaller version of the input image over itself where the -colour has a saturation over 0.7. - -=item rpnexpr=>'x 25 % 15 * y 35 % 10 * getp1 !pat y 360 / !rat x y getp1 1 @rat - pmult @pat @rat pmult padd' - -tiles the input image over itself so that at the top of the image the -full-size image is at full strength and at the bottom the tiling is -most visible. - -=item rpnexpr=>'x y getp1 !pix @pix value 0.96 gt @pix sat 0.1 lt and 128 128 255 rgb @pix ifp' - -replace pixels that are white or almost white with a palish blue - -=item rpnexpr=>'x 35 % 10 * y 45 % 8 * getp1 !pat x y getp1 !pix @pix sat 0.2 lt @pix value 0.9 gt and @pix @pat @pix value 2 / 0.5 + pmult ifp' - -Tiles the input image overitself where the image isn't white or almost -white. - -=item rpnexpr=>'x y 160 180 distance !d y 180 - x 160 - atan2 !a @d 10 / @a + 3.1416 2 * % !a2 @a2 180 * 3.1416 / 1 @a2 sin 1 + 2 / hsv' - -Produces a spiral. - -=item rpnexpr=>'x y 160 180 distance !d y 180 - x 160 - atan2 !a @d 10 / @a + 3.1416 2 * % !a2 @a 180 * 3.1416 / 1 @a2 sin 1 + 2 / hsv' - -A spiral built on top of a colour wheel. - -=back - -For details on expression parsing see L. For details on -the virtual machine used to transform the images, see -L. - -=head2 Matrix Transformations - -Rather than having to write code in a little language, you can use a -matrix to perform transformations, using the matrix_transform() -method: - - my $im2 = $im->matrix_transform(matrix=>[ -1, 0, $im->getwidth-1, - 0, 1, 0, - 0, 0, 1 ]); - -By default the output image will be the same size as the input image, -but you can supply the xsize and ysize parameters to change the size. - -Rather than building matrices by hand you can use the Imager::Matrix2d -module to build the matrices. This class has methods to allow you to -scale, shear, rotate, translate and reflect, and you can combine these -with an overloaded multiplication operator. - -WARNING: the matrix you provide in the matrix operator transforms the -co-ordinates within the B image to the co-ordinates -within the I image. This can be confusing. - -Since Imager has 3 different fairly general ways of transforming an -image spatially, this method also has a yatf() alias. Yet Another -Transformation Function. - -=head2 Masked Images - -Masked images let you control which pixels are modified in an -underlying image. Where the first channel is completely black in the -mask image, writes to the underlying image are ignored. - -For example, given a base image called $img: - - my $mask = Imager->new(xsize=>$img->getwidth, ysize=>getheight, - channels=>1); - # ... draw something on the mask - my $maskedimg = $img->masked(mask=>$mask); - -You can specifiy the region of the underlying image that is masked -using the left, top, right and bottom options. - -If you just want a subset of the image, without masking, just specify -the region without specifying a mask. - -=head2 Plugins - -It is possible to add filters to the module without recompiling the -module itself. This is done by using DSOs (Dynamic shared object) -avaliable on most systems. This way you can maintain our own filters -and not have to get me to add it, or worse patch every new version of -the Module. Modules can be loaded AND UNLOADED at runtime. This -means that you can have a server/daemon thingy that can do something -like: - - load_plugin("dynfilt/dyntest.so") || die "unable to load plugin\n"; - %hsh=(a=>35,b=>200,type=>lin_stretch); - $img->filter(%hsh); - unload_plugin("dynfilt/dyntest.so") || die "unable to load plugin\n"; - $img->write(type=>'pnm',file=>'testout/t60.jpg') - || die "error in write()\n"; - -Someone decides that the filter is not working as it should - -dyntest.c modified and recompiled. - - load_plugin("dynfilt/dyntest.so") || die "unable to load plugin\n"; - $img->filter(%hsh); - -An example plugin comes with the module - Please send feedback to -addi@umich.edu if you test this. - -Note: This seems to test ok on the following systems: -Linux, Solaris, HPUX, OpenBSD, FreeBSD, TRU64/OSF1, AIX. -If you test this on other systems please let me know. - +=head1 AUTHOR -=head1 BUGS +Arnar M. Hrafnkelsson and Tony Cook (tony@imager.perl.org) among +others. See the README for a complete list. -box, arc, circle do not support antialiasing yet. arc, is only filled -as of yet. Some routines do not return $self where they should. This -affects code like this, C<$img-Ebox()-Earc()> where an object -is expected. +=head1 SEE ALSO -When saving Gif images the program does NOT try to shave of extra -colors if it is possible. If you specify 128 colors and there are -only 2 colors used - it will have a 128 colortable anyway. +L(1), L(3), L(3), +L(3), L(3), L(3), +L(3), L(3), +L(3), L(3), L(3), +L(3), L(3) -=head1 AUTHOR +L -Arnar M. Hrafnkelsson, addi@umich.edu, and recently lots of assistance -from Tony Cook. See the README for a complete list. +L(3), L(3) -=head1 SEE ALSO +Other perl imaging modules include: -perl(1), Imager::Color(3), Imager::Font(3), Imager::Matrix2d(3), -Affix::Infix2Postfix(3), Parse::RecDescent(3) -http://www.eecs.umich.edu/~addi/perl/Imager/ +L(3), L(3), L(3). =cut