/ 
lsn-data-hub-05.00289
River stage zero No dependents
/ WWW::Misc::Image

NAME

WWW::Misc::Image -

SYNOPSIS

EXPORTS

Nothing exported by default

Exported upon request

props_to_resize_str, resize_str_to_props, image_convert, image_dims, image_size

DEPENDENCIES

This module requires these other modules and libraries:

Parse::Template::Standard
Try::Tiny
Error::Logical
Error::Programatic
Perl::Module
Perl::Options
Data::Hub::Util
Image::Size
Data::Hub

DESCRIPTION

PUBLIC INTERFACE

image_convert

Create a file which satisfies the specified geometry

options: See "image_dims"

-out_dir    => $abs_path      # default is same dir as $path
-grayscale  => 1              # convert to grayscale
-watermark  => <Hash>         # watermark image
-maxdpi     => 1              # keep original image path/size
-resize    => WxH/wxh         # Resize to max W by H and min w by h

resize_str_to_props

Translate a resize string into a hash

A resize string like this:

800x600/480x320

Becomes

max_x => 800
max_y => 600
min_x => 480
min_y => 320

Resize strings may omit dimensions, in which case they will default to zero

800                   max_x => 800
800x600               max_x => 800, max_y => 600
800x600/480           max_x => 800, max_y => 600, min_x => 480
800/480               max_x => 800, min_x => 480

A shorthand of a single number ending with a caret (^) indicates all the dimensions are the same, and we a producing a zoomed (as opposed to a letter-box image).

100^                  same as 100x100/100x100

This example will not abort:

use WWW::Misc::Image qw(resize_str_to_props);

This example:

my $props = resize_str_to_props('800');
join(';', map { $_ . '=' . $$props{$_} } sort keys %$props);

will return:

max_x=800;max_y=0;min_x=0;min_y=0

This example:

my $props = resize_str_to_props('800x600');
join(';', map { $_ . '=' . $$props{$_} } sort keys %$props);

will return:

max_x=800;max_y=600;min_x=0;min_y=0

This example:

my $props = resize_str_to_props('800x600/480');
join(';', map { $_ . '=' . $$props{$_} } sort keys %$props);

will return:

max_x=800;max_y=600;min_x=480;min_y=0

This example:

my $props = resize_str_to_props('800/480');
join(';', map { $_ . '=' . $$props{$_} } sort keys %$props);

will return:

max_x=800;max_y=0;min_x=480;min_y=0

This example:

my $props = resize_str_to_props('100/z');
join(';', map { $_ . '=' . $$props{$_} } sort keys %$props);

will return:

flags=z;max_x=100;max_y=0;min_x=0;min_y=0

props_to_resize_str

Create a resize-string from hash properties.

This is the inverse of resize_str_to_props.

This example will not abort:

use WWW::Misc::Image qw(props_to_resize_str);

This example:

props_to_resize_str({max_x => 800});

will return:

800

This example:

props_to_resize_str({max_x => 800, max_y => 600});

will return:

800x600

This example:

props_to_resize_str({max_x => 800, min_x => 480});

will return:

800/480

This example:

props_to_resize_str({max_x => 100, max_y => 100,min_x => 100, min_y => 100});

will return:

100x100/100x100

This example:

props_to_resize_str({max_x => 100, flags => 'z'});

will return:

100/z

image_dims

Get image dimensions

options:

-resize=WxH/wxh   Resize to max W by H and min w by h
--or--
-max_x=n          Maximum width
-max_y=n          Maximum height
-min_x=n          Minimum width
-min_y=n          Minimum height
  
my ($w,$h) = image_dims( "/images/laura.jpg", -max_x => 50, -max_y => 50 );
my ($w,$h) = image_dims( "/images/laura.jpg", -resize => '50x50' );

Zoomed image:

my ($w,$h,$z) = image_dims( "/images/laura.jpg", -resize => '50^' );

This example will not abort:

use WWW::Misc::Image qw(image_dims);

This example will return false:

image_dims("/foo");

AUTHORS

Ryan Gies <ryangies@cpan.org>

COPYRIGHT

Copyright (C) 2014-2016 by Ryan Gies. All rights reserved.
Copyright (C) 2006-2013 by Livesite Networks, LLC. All rights reserved.
Copyright (C) 2000-2005 by Ryan Gies. All rights reserved.
Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, 
this list of conditions and the following disclaimer.
* The origin of this software must not be misrepresented; you must not 
claim that you wrote the original software. If you use this software in a 
product, an acknowledgment in the product documentation would be 
appreciated but is not required.
* Altered source versions must be plainly marked as such, and must not be 
misrepresented as being the original software.
* The name of the author may not be used to endorse or promote products 
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED 
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 
EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
OF SUCH DAMAGE.
To the best of our knowledge, no patented algorithms have been used. However, we
do not have the resources to carry out a patent search, and therefore cannot 
give any guarantee of the above statement.