X-Git-Url: http://git.imager.perl.org/imager.git/blobdiff_plain/13fc481e12453c2a076b371d19548fe3abd73892..dc96e46cbbdfd9f0997dc12ddac6dfcf55412ff2:/Imager.pm diff --git a/Imager.pm b/Imager.pm index 407b5c3c..0f684aec 100644 --- a/Imager.pm +++ b/Imager.pm @@ -145,11 +145,17 @@ use Imager::Font; BEGIN { require Exporter; - require DynaLoader; - - $VERSION = '0.43'; - @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} = @@ -542,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; } @@ -552,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?? } @@ -573,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=>$self->getwidth(),top=>0,bottom=>$self->getheight(),@_); + + 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 @@ -685,6 +844,12 @@ 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); @@ -704,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}) @@ -1021,35 +1192,37 @@ 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; unless ($input{'type'}) { - $input{'type'} = i_test_format_probe($IO, -1); - } + $input{'type'} = i_test_format_probe($IO, -1); + } unless ($input{'type'}) { $self->_set_error('type parameter missing and not possible to guess from extension'); return undef; } + unless ($formats{$input{'type'}}) { + $self->_set_error("format '$input{'type'}' not supported"); + return; + } + # Setup data source 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->{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 + 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; } @@ -1060,7 +1233,8 @@ sub read { 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->{ERRSTR}='unable to read pnm image: '._error_as_msg(); + return undef; } $self->{DEBUG} && print "loading a pnm file\n"; return $self; @@ -1069,7 +1243,7 @@ sub read { 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'; + $self->{ERRSTR} = $self->_error_as_msg(); return undef; } $self->{DEBUG} && print "loading a png file\n"; @@ -1090,16 +1264,28 @@ sub read { $self->{ERRSTR} = "option 'colors' must be a scalar reference"; return undef; } - if ($input{colors}) { - my $colors; - ($self->{IMG}, $colors) =i_readgif_wiol( $IO ); - if ($colors) { - ${ $input{colors} } = [ map { NC(@$_) } @$colors ]; + if ($input{'gif_consolidate'}) { + if ($input{colors}) { + my $colors; + ($self->{IMG}, $colors) =i_readgif_wiol( $IO ); + if ($colors) { + ${ $input{colors} } = [ map { NC(@$_) } @$colors ]; + } + } + else { + $self->{IMG} =i_readgif_wiol( $IO ); } } else { - $self->{IMG} =i_readgif_wiol( $IO ); + 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})) ]; + } } + if ( !defined($self->{IMG}) ) { $self->{ERRSTR}=$self->_error_as_msg(); return undef; @@ -1141,7 +1327,7 @@ sub read { $params{storechannels}, $params{interleave}); if ( !defined($self->{IMG}) ) { - $self->{ERRSTR}='unable to read raw image'; + $self->{ERRSTR}=$self->_error_as_msg(); return undef; } $self->{DEBUG} && print "loading a raw file\n"; @@ -1277,12 +1463,12 @@ sub write { 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'; + $self->{ERRSTR} = $self->_error_as_msg(); return undef; } } else { if (!i_writetiff_wiol($self->{IMG}, $IO)) { - $self->{ERRSTR}='Could not write to buffer'; + $self->{ERRSTR} = $self->_error_as_msg(); return undef; } } @@ -1290,7 +1476,7 @@ sub write { $self->_set_opts(\%input, "pnm_", $self) or return undef; if ( ! i_writeppm_wiol($self->{IMG},$IO) ) { - $self->{ERRSTR}='unable to write pnm image'; + $self->{ERRSTR} = $self->_error_as_msg(); return undef; } $self->{DEBUG} && print "writing a pnm file\n"; @@ -1298,7 +1484,7 @@ sub write { $self->_set_opts(\%input, "raw_", $self) or return undef; if ( !i_writeraw_wiol($self->{IMG},$IO) ) { - $self->{ERRSTR}='unable to write raw image'; + $self->{ERRSTR} = $self->_error_as_msg(); return undef; } $self->{DEBUG} && print "writing a raw file\n"; @@ -1510,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}}; @@ -1523,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; @@ -1533,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 { @@ -1541,75 +1758,155 @@ sub scale { my $img = Imager->new(); my $tmp = Imager->new(); + 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->{ERRSTR}='empty input image'; return undef; } + 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 @@ -1769,8 +2066,14 @@ sub rubthrough { my $self=shift; 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, @@ -1779,8 +2082,9 @@ sub rubthrough { %opts); 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->{ERRSTR} = $self->_error_as_msg(); + $opts{src_minx}, $opts{src_miny}, + $opts{src_maxx}, $opts{src_maxy})) { + $self->_set_error($self->_error_as_msg()); return undef; } return $self; @@ -1801,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) { @@ -1828,9 +2139,16 @@ 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 ($opts{back}) { - $result->{IMG} = i_rotate_exact($self->{IMG}, $amount, $opts{back}); + 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); @@ -1853,6 +2171,12 @@ 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; @@ -1937,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; } @@ -1948,39 +2270,56 @@ 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); } } @@ -2251,6 +2590,111 @@ sub getpixel { $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) = @_; @@ -2267,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})) { @@ -2453,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 @@ -2476,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; } @@ -2487,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(@_); } @@ -2610,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__ @@ -2634,8 +3162,8 @@ Imager - Perl extension for Generating 24 bit Images my $format; my $img = Imager->new(); - # see Imager::Files for information on the open() method - $img->open(file=>$file) or die $img->errstr(); + # see Imager::Files for information on the read() method + $img->read(file=>$file) or die $img->errstr(); $file =~ s/\.[^.]*$//; @@ -2679,6 +3207,14 @@ Overview. =item * +L - a brief introduction to Imager. + +=item * + +L - how to do various things with Imager. + +=item * + 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 @@ -2735,6 +3271,22 @@ L - Helper class for affine transformations. L - Helper for making gradient profiles. +=item * + +L - using Imager's C API + +=item * + +L - API function reference + +=item * + +L - using Imager's C API from Inline::C + +=item * + +L - tools to get access to Imager's C API. + =back =head2 Basic Overview @@ -2743,7 +3295,7 @@ An Image object is created with C<$img = Imager-Enew()>. Examples: $img=Imager->new(); # create empty image - $img->open(file=>'lena.png',type=>'png') or # read image from file + $img->read(file=>'lena.png',type=>'png') or # read image from file die $img->errstr(); # give an explanation # if something failed @@ -2760,7 +3312,8 @@ C<$img-Eerrstr()>. 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. +with an image object. You can also call Cerrstr> to get this +value. The Cnew> method is described in detail in L. @@ -2769,19 +3322,23 @@ L. Where to find information on methods for Imager class objects. -addcolors() - L +addcolors() - L -addtag() - L - add image tags +addtag() - L - add image tags arc() - L -bits() - L - number of bits per sample for the +align_string() - L + +bits() - L - number of bits per sample for the image box() - L circle() - L +colorcount() - L + convert() - L - transform the color space @@ -2789,44 +3346,56 @@ copy() - L crop() - L - extract part of an image -deltag() - L - delete image tags +deltag() - L - delete image tags difference() - L +errstr() - L<"Basic Overview"> + filter() - L -findcolor() - L - search the image palette, if it +findcolor() - L - search the image palette, if it has one flip() - L flood_fill() - L -getchannels() - L +getchannels() - L -getcolorcount() - L +getcolorcount() - L -getcolors() - L - get colors from the image +getcolors() - L - get colors from the image palette, if it has one -getheight() - L +get_file_limits() - L + +getheight() - L + +getpixel() - L -getpixel() - L +getsamples() - L -getwidth() - L +getscanline() - L -img_set() - L +getwidth() - L + +img_set() - L line() - L map() - L - remap color channel values -masked() - L - make a masked image +masked() - L - make a masked image + +matrix_transform() - L + +maxcolors() - L -matrix_transform() - L +new() - L -new() - L +open() - L - an alias for read() paste() - L - draw an image onto an image @@ -2834,9 +3403,10 @@ polygon() - L polyline() - L -read() - L +read() - L - read a single image from an image file -read_multi() - L +read_multi() - L - read multiple images from an image +file rotate() - L @@ -2845,30 +3415,187 @@ image and use the alpha channel scale() - L -setcolors() - L - set palette colors in a paletted image +scaleX() - L -setpixel() - L +scaleY() - L -string() - L - draw text on an image +setcolors() - L - set palette colors in +a paletted image -tags() - L - fetch image tags +setpixel() - L -to_paletted() - L +setscanline() - L -to_rgb8() - L +settag() - L + +set_file_limits() - L + +string() - L - draw text on an image + +tags() - L - fetch image tags + +to_paletted() - L + +to_rgb8() - L transform() - L transform2() - L -type() - L - type of image (direct vs paletted) +type() - L - type of image (direct vs paletted) -virtual() - L - whether the image has it's own +virtual() - L - whether the image has it's own data -write() - L +write() - L - write an image to a file + +write_multi() - L - write multiple image to an image +file. + +=head1 CONCEPT INDEX + +animated GIF - L + +aspect ratio - L, +L, L + +blend - alpha blending one image onto another +L + +blur - L, L + +boxes, drawing - L + +changes between image - L + +color - L + +color names - L, L + +combine modes - L + +compare images - L + +contrast - L, L + +convolution - L + +cropping - L + +C images - L + +dpi - L + +drawing boxes - L + +drawing lines - L + +drawing text - L, L + +error message - L<"Basic Overview"> + +files, font - L + +files, image - L -write_multi() - L +filling, types of fill - L + +filling, boxes - L + +filling, flood fill - L + +flood fill - L + +fonts - L + +fonts, drawing with - L, L, +L + +fonts, metrics - L, L + +fonts, multiple master - L + +fountain fill - L, +L, L, +L + +GIF files - L + +GIF files, animated - L + +gradient fill - L, +L, L, +L + +guassian blur - L + +hatch fills - L + +invert image - L + +JPEG - L + +limiting image sizes - L + +lines, drawing - L + +matrix - L, +L, +L + +metadata, image - L + +mosaic - L + +noise, filter - L + +noise, rendered - L, +L + +paste - L, +L + +pseudo-color image - L, +L + +posterize - L + +png files - L, L + +pnm - L + +rectangles, drawing - L + +resizing an image - L, +L + +saving an image - L + +scaling - L + +sharpen - L, L + +size, image - L, +L + +size, text - L + +tags, image metadata - L + +text, drawing - L, L, +L + +text, wrapping text in an area - L + +text, measuring - L, L + +tiles, color - L + +unsharp mask - L + +watermark - L + +writing an image to a file - L =head1 SUPPORT @@ -2881,14 +3608,29 @@ To subscribe send a message with C in the body to: or use the form at: - http://www.molar.is/en/lists/imager-devel/ - (annonymous is temporarily off due to spam) +=over + +L + +=back where you can also find the mailing list archive. If you're into IRC, you can typically find the developers in #Imager -on irc.rhizomatic.net. As with any IRC channel, the participants -could be occupied or asleep, so please be patient. +on irc.perl.org. As with any IRC channel, the participants could be +occupied or asleep, so please be patient. + +You can report bugs by pointing your browser at: + +=over + +L + +=back + +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 @@ -2896,17 +3638,23 @@ Bugs are listed individually for relevant pod pages. =head1 AUTHOR -Arnar M. Hrafnkelsson (addi@imager.perl.org) and Tony Cook -(tony@imager.perl.org) See the README for a complete list. +Arnar M. Hrafnkelsson and Tony Cook (tony@imager.perl.org) among +others. See the README for a complete list. =head1 SEE ALSO -perl(1), Imager::ImageTypes(3), Imager::Files(3), Imager::Draw(3), -Imager::Color(3), Imager::Fill(3), Imager::Font(3), -Imager::Transformations(3), Imager::Engines(3), Imager::Filters(3), -Imager::Expr(3), Imager::Matrix2d(3), Imager::Fountain(3) +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) + +L + +L(3), L(3) + +Other perl imaging modules include: -Affix::Infix2Postfix(3), Parse::RecDescent(3) -http://imager.perl.org/~addi/perl/Imager/ +L(3), L(3), L(3). =cut