unload_plugin
)]);
+# registered file readers
+my %readers;
+
+# registered file writers
+my %writers;
+
+# modules we attempted to autoload
+my %attempted_to_load;
+
BEGIN {
require Exporter;
@ISA = qw(Exporter);
- $VERSION = '0.47';
+ $VERSION = '0.55';
eval {
require XSLoader;
XSLoader::load(Imager => $VERSION);
}
};
- $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 => { },
i_fountain($hsh{image}, $hsh{xa}, $hsh{ya}, $hsh{xb}, $hsh{yb},
$hsh{ftype}, $hsh{repeat}, $hsh{combine}, $hsh{super_sample},
- $hsh{ssample_param}, \@segments);
+ $hsh{ssample_param}, \@segments)
+ or die Imager->_error_as_msg() . "\n";
},
};
$filters{unsharpmask} =
#}
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);
}
$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";
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.
else {
$src_right = $r;
}
- if (defined $input{src_maxx}) {
+ if (defined $input{src_maxy}) {
$src_bottom = $input{src_maxy};
}
elsif (defined $input{height}) {
}
$src_right > $r and $src_right = $r;
- $src_bottom > $r and $src_bottom = $b;
+ $src_bottom > $b and $src_bottom = $b;
if ($src_right <= $src_left
|| $src_bottom < $src_top) {
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";
+ warn "to_rgb8() called in void context - to_rgb8() returns the converted image at $caller[1] line $caller[2]\n";
return;
}
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;
- $self->{IMG} and i_addcolors($self->{IMG}, @{$opts{colors}});
+ for my $color (@colors) {
+ $color = _color($color);
+ unless ($color) {
+ $self->_set_error($Imager::ERRSTR);
+ return;
+ }
+ }
+
+ 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 {
sub _get_reader_io {
my ($self, $input) = @_;
- if ($input->{io}) {
- return $input->{io}, undef;
- }
+ if ($input->{io}) {
+ return $input->{io}, undef;
+ }
elsif ($input->{fd}) {
return io_new_fd($input->{fd});
}
sub _get_writer_io {
my ($self, $input, $type) = @_;
- if ($input->{fd}) {
+ if ($input->{io}) {
+ return $input->{io};
+ }
+ elsif ($input->{fd}) {
return io_new_fd($input->{fd});
}
elsif ($input->{fh}) {
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;
return $self;
}
+ my $allow_incomplete = $input{allow_incomplete};
+ defined $allow_incomplete or $allow_incomplete = 0;
+
if ( $input{'type'} eq 'tiff' ) {
my $page = $input{'page'};
defined $page or $page = 0;
- # Fixme, check if that length parameter is ever needed
- $self->{IMG}=i_readtiff_wiol( $IO, -1, $page );
+ $self->{IMG}=i_readtiff_wiol( $IO, $allow_incomplete, $page );
if ( !defined($self->{IMG}) ) {
$self->{ERRSTR}=$self->_error_as_msg(); return undef;
}
}
if ( $input{'type'} eq 'pnm' ) {
- $self->{IMG}=i_readpnm_wiol( $IO, -1 ); # Fixme, check if that length parameter is ever needed
+ $self->{IMG}=i_readpnm_wiol( $IO, $allow_incomplete );
if ( !defined($self->{IMG}) ) {
$self->{ERRSTR}='unable to read pnm image: '._error_as_msg();
return undef;
}
if ( $input{'type'} eq 'bmp' ) {
- $self->{IMG}=i_readbmp_wiol( $IO );
+ $self->{IMG}=i_readbmp_wiol( $IO, $allow_incomplete );
if ( !defined($self->{IMG}) ) {
$self->{ERRSTR}=$self->_error_as_msg();
return undef;
$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";
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) = @_;
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} = $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}='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)
- 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)
+ $writers{$input{type}}{single}->($self, $IO, %input)
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;
+ }
}
}
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;
}
$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);
+ if (@images == 1) {
+ unless ($images[0]->write(%$opts, io => $IO, type => $type)) {
+ return 1;
+ }
+ }
+ else {
+ $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) {
return;
}
}
- elsif ($opts{'type'} eq 'tiff') {
+ elsif ($type eq 'tiff') {
my @imgs = i_readtiff_multi_wiol($IO, -1);
if (@imgs) {
return map {
return;
}
}
+ else {
+ my $img = Imager->new;
+ if ($img->read(%opts, io => $IO, type => $type)) {
+ return ( $img );
+ }
+ }
- $ERRSTR = "Cannot read multiple images from $opts{'type'} files";
+ $ERRSTR = "Cannot read multiple images from $type files";
return;
}
}
}
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}};
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;
return;
}
- unless ($self->{IMG}) { $self->{ERRSTR}='empty input image'; return undef; }
+ 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') { $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') {
+ $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;
}
- 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}, $x_scale, $y_scale);
+ if ( !defined($img->{IMG}) ) {
+ $self->{ERRSTR}='unable to scale image';
+ return undef;
+ }
return $img;
}
- $self->{ERRSTR}='scale: invalid value for qtype'; 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;
+ }
+ 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 (defined wantarray) {
my @caller = caller;
return;
}
- unless ($self->{IMG}) { $self->{ERRSTR}='empty input image'; return undef; }
+ 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;
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
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,
%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;
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);
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}) {
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, @_);
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 {
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'}) {
if ($opts{type} eq '8bit') {
return i_glin($self->{IMG}, $opts{x}, $opts{x}+$opts{width},
- $opts{y});
+ $opts{'y'});
}
elsif ($opts{type} eq 'float') {
return i_glinf($self->{IMG}, $opts{x}, $opts{x}+$opts{width},
- $opts{y});
+ $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'");
my $self = shift;
my %opts = ( x=>0, @_);
+ $self->_valid_image or return;
+
unless (defined $opts{'y'}) {
$self->_set_error("missing y parameter");
return;
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;
unless ($self->{IMG}) { $self->{ERRSTR}='empty input image'; return undef; }
my %input=('x'=>0, 'y'=>0, @_);
- $input{string}||=$input{text};
+ defined($input{string}) or $input{string} = $input{text};
unless(defined $input{string}) {
$self->{ERRSTR}="missing required parameter 'string'";
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;
# get the maximum of a list
-sub max {
+sub _max {
my $mx=shift;
for(@_) { if ($_>$mx) { $mx=$_; }}
return $mx;
# string stuff for iptc headers
-sub clean {
+sub _clean {
my($str)=$_[0];
$str = substr($str,3);
$str =~ s/[\n\r]//g;
my $str=$self->{IPTCRAW};
- #print $str;
+ defined $str
+ or return;
@ar=split(/8BIM/,$str);
@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++;
}
}
=item *
-Imager - This document - Synopsis Example, Table of Contents and
+Imager - This document - Synopsis, Example, Table of Contents and
Overview.
=item *
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-E<gt>errstr()>.
+=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. You can also call C<Imager->errstr> to get this
-value.
+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 C<Imager-E<gt>new> method is described in detail in
L<Imager::ImageTypes>.
addtag() - L<Imager::ImageTypes/addtag> - add image tags
-arc() - L<Imager::Draw/arc>
-
align_string() - L<Imager::Draw/align_string>
+arc() - L<Imager::Draw/arc>
+
bits() - L<Imager::ImageTypes/bits> - number of bits per sample for the
image
crop() - L<Imager::Transformations/crop> - extract part of an image
+def_guess_type() - L<Imager::Files/def_guess_type>
+
deltag() - L<Imager::ImageTypes/deltag> - delete image tags
difference() - L<Imager::Filters/"Image Difference">
getheight() - L<Imager::ImageTypes/getwidth>
+getmask() - L<Imager::ImageTypes/getmask>
+
getpixel() - L<Imager::Draw/getpixel>
getsamples() - L<Imager::Draw/getsamples>
img_set() - L<Imager::ImageTypes/img_set>
+init() - L<Imager::ImageTypes/init>
+
line() - L<Imager::Draw/line>
+load_plugin() - L<Imager::Filters/load_plugin>
+
map() - L<Imager::Transformations/"Color Mappings"> - remap color
channel values
masked() - L<Imager::ImageTypes/masked> - make a masked image
-matrix_transform() - L<Imager::Engines/"Matrix Transformations">
+matrix_transform() - L<Imager::Engines/matrix_transform>
maxcolors() - L<Imager::ImageTypes/maxcolors>
+NC() - L<Imager::Handy/NC>
+
new() - L<Imager::ImageTypes/new>
+newcolor() - L<Imager::Handy/newcolor>
+
+newcolour() - L<Imager::Handy/newcolour>
+
+newfont() - L<Imager::Handy/newfont>
+
+NF() - L<Imager::Handy/NF>
+
open() - L<Imager::Files> - an alias for read()
+parseiptc() - L<Imager::Files/parseiptc> - parse IPTC data from a JPEG
+image
+
paste() - L<Imager::Transformations/paste> - draw an image onto an image
polygon() - L<Imager::Draw/polygon>
read_multi() - L<Imager::Files> - read multiple images from an image
file
+register_filter() - L<Imager::Filters/register_filter>
+
+register_reader() - L<Imager::Filters/register_reader>
+
+register_writer() - L<Imager::Filters/register_writer>
+
rotate() - L<Imager::Transformations/rotate>
rubthrough() - L<Imager::Transformations/rubthrough> - draw an image onto an
scale() - L<Imager::Transformations/scale>
-setscanline() - L<Imager::Draw/setscanline>
-
scaleX() - L<Imager::Transformations/scaleX>
scaleY() - L<Imager::Transformations/scaleY>
setcolors() - L<Imager::ImageTypes/setcolors> - set palette colors in
a paletted image
+set_file_limits() - L<Imager::Files/"Limiting the sizes of images you read">
+
+setmask() - L<Imager::ImageTypes/setmask>
+
setpixel() - L<Imager::Draw/setpixel>
-set_file_limits() - L<Imager::Files/"Limiting the sizes of images you read">
+setscanline() - L<Imager::Draw/setscanline>
+
+settag() - L<Imager::ImageTypes/settag>
string() - L<Imager::Draw/string> - draw text on an image
type() - L<Imager::ImageTypes/type> - type of image (direct vs paletted)
+unload_plugin() - L<Imager::Filters/unload_plugin>
+
virtual() - L<Imager::ImageTypes/virtual> - whether the image has it's own
data
C<diff> images - L<Imager::Filter/"Image Difference">
-dpi - L<Imager::ImageTypes/i_xres>
+dpi - L<Imager::ImageTypes/i_xres>,
+L<Imager::Cookbook/"Image spatial resolution">
drawing boxes - L<Imager::Draw/box>
drawing lines - L<Imager::Draw/line>
-drawing text - L<Imager::Font/string>, L<Imager::Font/align>
+drawing text - L<Imager::Draw/string>, L<Imager::Draw/align_string>
error message - L<"Basic Overview">
fonts - L<Imager::Font>
-fonts, drawing with - L<Imager::Font/string>, L<Imager::Font/align>,
-L<Imager::Font::Wrap>
+fonts, drawing with - L<Imager::Draw/string>,
+L<Imager::Draw/align_string>, L<Imager::Font::Wrap>
fonts, metrics - L<Imager::Font/bounding_box>, L<Imager::Font::BBox>
=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<subscribe> in the body to:
where you can also find the mailing list archive.
-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.
-
You can report bugs by pointing your browser at:
=over
projects / imager.git / blobdiff