X-Git-Url: http://git.imager.perl.org/imager.git/blobdiff_plain/8f22b8d8b861725641f4a244c4a22ff7c1c1f3a5..b13bf7e831993470c920ccf8dac7acafe0b9fbc6:/Imager.pm?ds=sidebyside diff --git a/Imager.pm b/Imager.pm index fb279992..0c10d9ad 100644 --- a/Imager.pm +++ b/Imager.pm @@ -143,13 +143,28 @@ use Imager::Font; unload_plugin )]); +# registered file readers +my %readers; + +# registered file writers +my %writers; + +# modules we attempted to autoload +my %attempted_to_load; + BEGIN { require Exporter; - require DynaLoader; - - $VERSION = '0.43_02'; - @ISA = qw(Exporter DynaLoader); - bootstrap Imager $VERSION; + @ISA = qw(Exporter); + $VERSION = '0.53'; + eval { + require XSLoader; + XSLoader::load(Imager => $VERSION); + 1; + } or do { + require DynaLoader; + push @ISA, 'DynaLoader'; + bootstrap Imager $VERSION; + } } BEGIN { @@ -221,17 +236,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 +384,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} = @@ -383,8 +432,8 @@ BEGIN { #} sub init_log { - m_init_log($_[0],$_[1]); - log_entry("Imager $VERSION starting\n", 1); + i_init_log($_[0],$_[1]); + i_log_entry("Imager $VERSION starting\n", 1); } @@ -488,12 +537,7 @@ sub _color { $result = Imager::Color->new(%$arg); } elsif ($copy =~ /^ARRAY\(/) { - if (grep $_ > 1, @$arg) { - $result = Imager::Color->new(@$arg); - } - else { - $result = Imager::Color::Float->new(@$arg); - } + $result = Imager::Color->new(@$arg); } else { $Imager::ERRSTR = "Not a color"; @@ -508,6 +552,15 @@ sub _color { return $result; } +sub _valid_image { + my ($self) = @_; + + $self->{IMG} and return 1; + + $self->_set_error('empty input image'); + + return; +} # # Methods to be called on objects. @@ -542,9 +595,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 +610,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_maxy}) { + $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 > $b 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,8 +680,13 @@ sub paste { sub crop { my $self=shift; unless ($self->{IMG}) { $self->{ERRSTR}='empty input image'; return undef; } - + 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 %hsh=@_; my ($w, $h, $l, $r, $b, $t) = @@ -745,6 +857,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); @@ -764,6 +882,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 converted image at $caller[1] line $caller[2]\n"; + return; + } + if ($self->{IMG}) { $result = Imager->new; $result->{IMG} = i_img_to_rgb($self->{IMG}) @@ -777,17 +901,46 @@ sub addcolors { my $self = shift; my %opts = (colors=>[], @_); - @{$opts{colors}} or return undef; + unless ($self->{IMG}) { + $self->_set_error("empty input image"); + return; + } + + my @colors = @{$opts{colors}} + or return undef; + + for my $color (@colors) { + $color = _color($color); + unless ($color) { + $self->_set_error($Imager::ERRSTR); + return; + } + } - $self->{IMG} and i_addcolors($self->{IMG}, @{$opts{colors}}); + return i_addcolors($self->{IMG}, @colors); } sub setcolors { my $self = shift; my %opts = (start=>0, colors=>[], @_); - @{$opts{colors}} or return undef; - $self->{IMG} and i_setcolors($self->{IMG}, $opts{start}, @{$opts{colors}}); + unless ($self->{IMG}) { + $self->_set_error("empty input image"); + return; + } + + my @colors = @{$opts{colors}} + or return undef; + + for my $color (@colors) { + $color = _color($color); + unless ($color) { + $self->_set_error($Imager::ERRSTR); + return; + } + } + + return i_setcolors($self->{IMG}, $opts{start}, @colors); } sub getcolors { @@ -1081,35 +1234,43 @@ 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; } + _reader_autoload($input{type}); + + if ($readers{$input{type}} && $readers{$input{type}}{single}) { + return $readers{$input{type}}{single}->($self, $IO, %input); + } + + 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; } @@ -1120,7 +1281,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; @@ -1129,7 +1291,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"; @@ -1150,16 +1312,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; @@ -1201,7 +1375,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"; @@ -1210,6 +1384,106 @@ sub read { return $self; } +sub register_reader { + my ($class, %opts) = @_; + + defined $opts{type} + or die "register_reader called with no type parameter\n"; + + my $type = $opts{type}; + + defined $opts{single} || defined $opts{multiple} + or die "register_reader called with no single or multiple parameter\n"; + + $readers{$type} = { }; + if ($opts{single}) { + $readers{$type}{single} = $opts{single}; + } + if ($opts{multiple}) { + $readers{$type}{multiple} = $opts{multiple}; + } + + return 1; +} + +sub register_writer { + my ($class, %opts) = @_; + + defined $opts{type} + or die "register_writer called with no type parameter\n"; + + my $type = $opts{type}; + + defined $opts{single} || defined $opts{multiple} + or die "register_writer called with no single or multiple parameter\n"; + + $writers{$type} = { }; + if ($opts{single}) { + $writers{$type}{single} = $opts{single}; + } + if ($opts{multiple}) { + $writers{$type}{multiple} = $opts{multiple}; + } + + return 1; +} + +# probes for an Imager::File::whatever module +sub _reader_autoload { + my $type = shift; + + return if $formats{$type} || $readers{$type}; + + return unless $type =~ /^\w+$/; + + my $file = "Imager/File/\U$type\E.pm"; + + unless ($attempted_to_load{$file}) { + eval { + ++$attempted_to_load{$file}; + require $file; + }; + if ($@) { + # try to get a reader specific module + my $file = "Imager/File/\U$type\EReader.pm"; + unless ($attempted_to_load{$file}) { + eval { + ++$attempted_to_load{$file}; + require $file; + }; + } + } + } +} + +# probes for an Imager::File::whatever module +sub _writer_autoload { + my $type = shift; + + return if $formats{$type} || $readers{$type}; + + return unless $type =~ /^\w+$/; + + my $file = "Imager/File/\U$type\E.pm"; + + unless ($attempted_to_load{$file}) { + eval { + ++$attempted_to_load{$file}; + require $file; + }; + if ($@) { + # try to get a writer specific module + my $file = "Imager/File/\U$type\EWriter.pm"; + unless ($attempted_to_load{$file}) { + eval { + ++$attempted_to_load{$file}; + require $file; + }; + } + } + } +} + sub _fix_gif_positions { my ($opts, $opt, $msg, @imgs) = @_; @@ -1324,96 +1598,111 @@ sub write { return undef; } - if (!$formats{$input{'type'}}) { $self->{ERRSTR}='format not supported'; return undef; } - - my ($IO, $fh) = $self->_get_writer_io(\%input, $input{'type'}) - or return undef; + _writer_autoload($input{type}); - if ($input{'type'} eq 'tiff') { - $self->_set_opts(\%input, "tiff_", $self) - or return undef; - $self->_set_opts(\%input, "exif_", $self) + my ($IO, $fh); + if ($writers{$input{type}} && $writers{$input{type}}{single}) { + ($IO, $fh) = $self->_get_writer_io(\%input, $input{'type'}) or return undef; - 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' ) { - $self->_set_opts(\%input, "pnm_", $self) - or return undef; - 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' ) { - $self->_set_opts(\%input, "raw_", $self) - or return undef; - 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' ) { - $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) + $writers{$input{type}}{single}->($self, $IO, %input) 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 ( !i_writetga_wiol($self->{IMG}, $IO, $input{wierdpack}, $input{compress}, $input{idstring}) ) { - $self->{ERRSTR}=$self->_error_as_msg(); + } + else { + if (!$formats{$input{'type'}}) { + $self->{ERRSTR}='format not supported'; return undef; } - $self->{DEBUG} && print "writing a tga file\n"; - } elsif ( $input{'type'} eq 'gif' ) { - $self->_set_opts(\%input, "gif_", $self) + + ($IO, $fh) = $self->_get_writer_io(\%input, $input{'type'}) 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; + + if ($input{'type'} eq 'tiff') { + $self->_set_opts(\%input, "tiff_", $self) + or return undef; + $self->_set_opts(\%input, "exif_", $self) + or return undef; + + 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; + } + } else { + if (!i_writetiff_wiol($self->{IMG}, $IO)) { + $self->{ERRSTR} = $self->_error_as_msg(); + return undef; + } + } + } 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 ( !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; + } } } @@ -1431,10 +1720,12 @@ sub write { sub write_multi { my ($class, $opts, @images) = @_; - if (!$opts->{'type'} && $opts->{'file'}) { - $opts->{'type'} = $FORMATGUESS->($opts->{'file'}); + my $type = $opts->{type}; + + if (!$type && $opts->{'file'}) { + $type = $FORMATGUESS->($opts->{'file'}); } - unless ($opts->{'type'}) { + unless ($type) { $class->_set_error('type parameter missing and not possible to guess from extension'); return; } @@ -1446,60 +1737,104 @@ sub write_multi { $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}) { - # assume the caller wants the same delay for each frame - $opts->{gif_delays} = [ ($gif_delays) x @images ]; - } - my $res = i_writegif_wiol($IO, $opts, @work); - $res or $class->_set_error($class->_error_as_msg()); - 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') { - $res = i_writetiff_multi_wiol_faxable($IO, $opts->{fax_fine}, @work); + + _writer_autoload($type); + + my ($IO, $file); + if ($writers{$type} && $writers{$type}{multiple}) { + ($IO, $file) = $class->_get_writer_io($opts, $type) + or return undef; + + $writers{$type}{multiple}->($class, $IO, $opts, @images) + or return undef; + } + else { + if (!$formats{$type}) { + $class->_set_error("format $type not supported"); + return undef; + } + + ($IO, $file) = $class->_get_writer_io($opts, $type) + or return undef; + + if ($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}) { + # assume the caller wants the same delay for each frame + $opts->{gif_delays} = [ ($gif_delays) x @images ]; + } + unless (i_writegif_wiol($IO, $opts, @work)) { + $class->_set_error($class->_error_as_msg()); + return undef; + } + } + elsif ($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') { + $res = i_writetiff_multi_wiol_faxable($IO, $opts->{fax_fine}, @work); + } + else { + $res = i_writetiff_multi_wiol($IO, @work); + } + unless ($res) { + $class->_set_error($class->_error_as_msg()); + return undef; + } } else { - $res = i_writetiff_multi_wiol($IO, @work); + $ERRSTR = "Sorry, write_multi doesn't support $type yet"; + return 0; } - $res or $class->_set_error($class->_error_as_msg()); - return $res; } - else { - $ERRSTR = "Sorry, write_multi doesn't support $opts->{'type'} yet"; - return 0; + + if (exists $opts->{'data'}) { + my $data = io_slurp($IO); + if (!$data) { + Imager->_set_error('Could not slurp from buffer'); + return undef; + } + ${$opts->{data}} = $data; } + return 1; } # read multiple images from a file sub read_multi { my ($class, %opts) = @_; - if ($opts{file} && !exists $opts{'type'}) { + my ($IO, $file) = $class->_get_reader_io(\%opts, $opts{'type'}) + or return; + + my $type = $opts{'type'}; + unless ($type) { + $type = i_test_format_probe($IO, -1); + } + + if ($opts{file} && !$type) { # guess the type - my $type = $FORMATGUESS->($opts{file}); - $opts{'type'} = $type; + $type = $FORMATGUESS->($opts{file}); } - unless ($opts{'type'}) { + + unless ($type) { $ERRSTR = "No type parameter supplied and it couldn't be guessed"; return; } - my ($IO, $file) = $class->_get_reader_io(\%opts, $opts{'type'}) - or return; - if ($opts{'type'} eq 'gif') { + _reader_autoload($type); + + if ($readers{$type} && $readers{$type}{multiple}) { + return $readers{$type}{multiple}->($IO, %opts); + } + + if ($type eq 'gif') { my @imgs; @imgs = i_readgif_multi_wiol($IO); if (@imgs) { @@ -1512,7 +1847,7 @@ sub read_multi { return; } } - elsif ($opts{'type'} eq 'tiff') { + elsif ($type eq 'tiff') { my @imgs = i_readtiff_multi_wiol($IO, -1); if (@imgs) { return map { @@ -1525,7 +1860,7 @@ sub read_multi { } } - $ERRSTR = "Cannot read multiple images from $opts{'type'} files"; + $ERRSTR = "Cannot read multiple images from $type files"; return; } @@ -1570,9 +1905,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}}; @@ -1583,7 +1923,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; @@ -1593,13 +1940,33 @@ 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 { my $self=shift; - my %opts=(scalefactor=>0.5,'type'=>'max',qtype=>'normal',@_); + my %opts=('type'=>'max',qtype=>'normal',@_); my $img = Imager->new(); my $tmp = Imager->new(); + my ($x_scale, $y_scale); unless (defined wantarray) { my @caller = caller; @@ -1607,69 +1974,181 @@ sub scale { return; } - unless ($self->{IMG}) { $self->{ERRSTR}='empty input image'; return undef; } - - 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(); } + unless ($self->{IMG}) { + $self->_set_error('empty input image'); + return undef; + } + + if ($opts{'xscalefactor'} && $opts{'yscalefactor'}) { + $x_scale = $opts{'xscalefactor'}; + $y_scale = $opts{'yscalefactor'}; + } + elsif ($opts{'xscalefactor'}) { + $x_scale = $opts{'xscalefactor'}; + $y_scale = $opts{'scalefactor'} || $x_scale; + } + elsif ($opts{'yscalefactor'}) { + $y_scale = $opts{'yscalefactor'}; + $x_scale = $opts{'scalefactor'} || $y_scale; + } + else { + $x_scale = $y_scale = $opts{'scalefactor'} || 0.5; + } + + # 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') { + $x_scale = $y_scale = _min($xpix,$ypix); + } + elsif ($opts{'type'} eq 'max') { + $x_scale = $y_scale = _max($xpix,$ypix); + } + elsif ($opts{'type'} eq 'nonprop' || $opts{'type'} eq 'non-proportional') { + $x_scale = $xpix; + $y_scale = $ypix; + } + else { + $self->_set_error('invalid value for type parameter'); + return undef; + } + } elsif ($opts{xpixels}) { + $x_scale = $y_scale = $opts{xpixels} / $self->getwidth(); + } + elsif ($opts{ypixels}) { + $x_scale = $y_scale = $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 + my $scalefactor; + (undef, undef, $scalefactor) + = $opts{constrain}->constrain($self->getwidth, $self->getheight); + unless ($scalefactor) { + $self->_set_error('constrain method failed on constrain parameter'); + return undef; + } + $x_scale = $y_scale = $scalefactor; + } 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}, $x_scale, 0); + if ( !defined($tmp->{IMG}) ) { + $self->{ERRSTR} = 'unable to scale image'; + return undef; + } + $img->{IMG}=i_scaleaxis($tmp->{IMG}, $y_scale, 1); + if ( !defined($img->{IMG}) ) { + $self->{ERRSTR}='unable to scale image'; + return undef; + } + + return $img; + } + elsif ($opts{'qtype'} eq 'preview') { + $img->{IMG} = i_scale_nn($self->{IMG}, $x_scale, $y_scale); + 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 'mixing') { + my $new_width = int(0.5 + $self->getwidth * $x_scale); + my $new_height = int(0.5 + $self->getheight * $y_scale); + $new_width >= 1 or $new_width = 1; + $new_height >= 1 or $new_height = 1; + $img->{IMG} = i_scale_mixing($self->{IMG}, $new_width, $new_height); + unless ($img->{IMG}) { + $self->_set_error(Imager->_error_as_meg); + return; + } 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 @@ -1829,8 +2308,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, @@ -1839,8 +2324,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; @@ -1861,6 +2347,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) { @@ -1888,9 +2381,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); @@ -1913,6 +2413,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; @@ -1958,10 +2464,10 @@ sub box { my %opts=(color=>$dflcl,xmin=>0,ymin=>0,xmax=>$self->getwidth()-1,ymax=>$self->getheight()-1,@_); if (exists $opts{'box'}) { - $opts{'xmin'} = min($opts{'box'}->[0],$opts{'box'}->[2]); - $opts{'xmax'} = max($opts{'box'}->[0],$opts{'box'}->[2]); - $opts{'ymin'} = min($opts{'box'}->[1],$opts{'box'}->[3]); - $opts{'ymax'} = max($opts{'box'}->[1],$opts{'box'}->[3]); + $opts{'xmin'} = _min($opts{'box'}->[0],$opts{'box'}->[2]); + $opts{'xmax'} = _max($opts{'box'}->[0],$opts{'box'}->[2]); + $opts{'ymin'} = _min($opts{'box'}->[1],$opts{'box'}->[3]); + $opts{'ymax'} = _max($opts{'box'}->[1],$opts{'box'}->[3]); } if ($opts{filled}) { @@ -1997,50 +2503,65 @@ 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; } my $dflcl=i_color_new(255,255,255,255); my %opts=(color=>$dflcl, - 'r'=>min($self->getwidth(),$self->getheight())/3, + 'r'=>_min($self->getwidth(),$self->getheight())/3, '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); } } @@ -2205,26 +2726,69 @@ sub flood_fill { return undef; } - 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{border}) { + my $border = _color($opts{border}); + unless ($border) { + $self->_set_error($Imager::ERRSTR); + return; + } + if ($opts{fill}) { + unless (UNIVERSAL::isa($opts{fill}, 'Imager::Fill')) { + # assume it's a hash ref + require Imager::Fill; + unless ($opts{fill} = Imager::Fill->new(%{$opts{fill}})) { + $self->{ERRSTR} = $Imager::ERRSTR; + return; + } + } + $rc = i_flood_cfill_border($self->{IMG}, $opts{'x'}, $opts{'y'}, + $opts{fill}{fill}, $border); + } + else { + my $color = _color($opts{'color'}); + unless ($color) { + $self->{ERRSTR} = $Imager::ERRSTR; + return; } + $rc = i_flood_fill_border($self->{IMG}, $opts{'x'}, $opts{'y'}, + $color, $border); + } + if ($rc) { + return $self; + } + else { + $self->{ERRSTR} = $self->_error_as_msg(); + return; } - $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; + 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; + } + } + $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; + } + $rc = i_flood_fill($self->{IMG}, $opts{'x'}, $opts{'y'}, $color); + } + if ($rc) { + return $self; + } + else { + $self->{ERRSTR} = $self->_error_as_msg(); 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 { @@ -2311,6 +2875,131 @@ sub getpixel { $self; } +sub getscanline { + my $self = shift; + my %opts = ( type => '8bit', x=>0, @_); + + $self->_valid_image or return; + + 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'}); + } + elsif ($opts{type} eq 'index') { + unless (i_img_type($self->{IMG})) { + $self->_set_error("type => index only valid on paletted images"); + return; + } + return i_gpal($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, @_); + + $self->_valid_image or return; + + 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}); + } + } + elsif ($opts{type} eq 'index') { + if (ref $opts{pixels}) { + return i_ppal($self->{IMG}, $opts{x}, $opts{'y'}, @{$opts{pixels}}); + } + else { + return i_ppal_p($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) = @_; @@ -2327,6 +3016,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})) { @@ -2513,8 +3208,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 @@ -2536,7 +3240,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; } @@ -2547,13 +3251,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(@_); } @@ -2599,12 +3364,13 @@ sub def_guess_type { return 'rgb' if ($ext eq "rgb"); return 'gif' if ($ext eq "gif"); return 'raw' if ($ext eq "raw"); + return lc $ext; # best guess return (); } # get the minimum of a list -sub min { +sub _min { my $mx=shift; for(@_) { if ($_<$mx) { $mx=$_; }} return $mx; @@ -2612,7 +3378,7 @@ sub min { # get the maximum of a list -sub max { +sub _max { my $mx=shift; for(@_) { if ($_>$mx) { $mx=$_; }} return $mx; @@ -2620,7 +3386,7 @@ sub max { # string stuff for iptc headers -sub clean { +sub _clean { my($str)=$_[0]; $str = substr($str,3); $str =~ s/[\n\r]//g; @@ -2639,7 +3405,8 @@ sub parseiptc { my $str=$self->{IPTCRAW}; - #print $str; + defined $str + or return; @ar=split(/8BIM/,$str); @@ -2649,19 +3416,19 @@ sub parseiptc { @sar=split(/\034\002/); foreach $item (@sar) { if ($item =~ m/^x/) { - $caption=&clean($item); + $caption = _clean($item); $i++; } if ($item =~ m/^P/) { - $photogr=&clean($item); + $photogr = _clean($item); $i++; } if ($item =~ m/^i/) { - $headln=&clean($item); + $headln = _clean($item); $i++; } if ($item =~ m/^n/) { - $credit=&clean($item); + $credit = _clean($item); $i++; } } @@ -2670,7 +3437,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__ @@ -2694,8 +3469,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/\.[^.]*$//; @@ -2734,11 +3509,19 @@ render text and more. =item * -Imager - This document - Synopsis Example, Table of Contents and +Imager - This document - Synopsis, Example, Table of Contents and 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 @@ -2795,6 +3578,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 @@ -2803,7 +3602,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 @@ -2814,13 +3613,32 @@ or if you want to create an empty image: This example creates a completely black image of width 400 and height 300 and 4 channels. -When an operation fails which can be directly associated with an image -the error message is stored can be retrieved with -C<$img-Eerrstr()>. +=head1 ERROR HANDLING + +In general a method will return false when it fails, if it does use the errstr() method to find out why: + +=over + +=item errstr + +Returns the last error message in that context. + +If the last error you received was from calling an object method, such +as read, call errstr() as an object method to find out why: + + my $image = Imager->new; + $image->read(file => 'somefile.gif') + or die $image->errstr; -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. +If it was a class method then call errstr() as a class method: + + my @imgs = Imager->read_multi(file => 'somefile.gif') + or die Imager->errstr; + +Note that in some cases object methods are implemented in terms of +class methods so a failing object method may set both. + +=back The Cnew> method is described in detail in L. @@ -2829,19 +3647,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 +align_string() - L arc() - L -bits() - L - number of bits per sample for the +bits() - L - number of bits per sample for the image box() - L circle() - L +colorcount() - L + convert() - L - transform the color space @@ -2849,44 +3671,77 @@ copy() - L crop() - L - extract part of an image -deltag() - L - delete image tags +def_guess_type() - L + +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 + +getmask() - L + +getpixel() - L + +getsamples() - L -getpixel() - L +getscanline() - L -getwidth() - L +getwidth() - L -img_set() - L +img_set() - L + +init() - L line() - L +load_plugin() - L + map() - L - remap color channel values -masked() - L - make a masked image +masked() - L - make a masked image + +matrix_transform() - L + +maxcolors() - L + +NC() - L + +new() - L -matrix_transform() - L +newcolor() - L -new() - L +newcolour() - L + +newfont() - L + +NF() - L + +open() - L - an alias for read() + +parseiptc() - L - parse IPTC data from a JPEG +image paste() - L - draw an image onto an image @@ -2894,9 +3749,16 @@ polygon() - L polyline() - L -read() - L +read() - L - read a single image from an image file + +read_multi() - L - read multiple images from an image +file -read_multi() - L +register_filter() - L + +register_reader() - L + +register_writer() - L rotate() - L @@ -2905,35 +3767,196 @@ image and use the alpha channel scale() - L -setcolors() - L - set palette colors in a paletted image +scaleX() - L + +scaleY() - L + +setcolors() - L - set palette colors in +a paletted image + +set_file_limits() - L + +setmask() - L -setpixel() - L +setpixel() - L -string() - L - draw text on an image +setscanline() - L -tags() - L - fetch image tags +settag() - L -to_paletted() - L +string() - L - draw text on an image -to_rgb8() - L +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) + +unload_plugin() - L -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, +L + +drawing boxes - L + +drawing lines - L + +drawing text - L, L + +error message - L<"Basic Overview"> + +files, font - L + +files, image - L + +filling, types of fill - L + +filling, boxes - L + +filling, flood fill - L + +flood fill - L -write_multi() - 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 -You can ask for help, report bugs or express your undying love for -Imager on the Imager-devel mailing list. +The best place to get help with Imager is the mailing list. To subscribe send a message with C in the body to: @@ -2941,22 +3964,21 @@ 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 -where you can also find the mailing list archive. +=back -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. +where you can also find the mailing list archive. -You can report bugs either by sending email to: +You can report bugs by pointing your browser at: - bug-Imager@rt.cpan.org +=over -or by pointing your browser at: +L - https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Imager +=back Please remember to include the versions of Imager, perl, supporting libraries, and any relevant code. If you have specific images that @@ -2968,17 +3990,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/ +L(3), L(3), L(3). =cut