/usr/share/perl5/LaTeXML/Post/Graphics.pm is in latexml 0.7.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 | # /=====================================================================\ #
# | LaTeXML::Post::Graphics | #
# | Graphics postprocessing for LaTeXML | #
# |=====================================================================| #
# | Part of LaTeXML: | #
# | Public domain software, produced as part of work done by the | #
# | United States Government & not subject to copyright in the US. | #
# |---------------------------------------------------------------------| #
# | Bruce Miller <bruce.miller@nist.gov> #_# | #
# | http://dlmf.nist.gov/LaTeXML/ (o o) | #
# \=========================================================ooo==U==ooo=/ #
#======================================================================
# Adapted from graphics-support.perl of LaTeX2HTML (which I had rewritten)
#======================================================================
package LaTeXML::Post::Graphics;
use strict;
use LaTeXML::Util::Pathname;
use POSIX;
use Image::Magick;
use base qw(LaTeXML::Post);
#======================================================================
# Options:
# dpi : dots per inch for target medium.
# ignore_options : list of graphicx options to be ignored.
# warn_options : list of graphicx options to cause warning if used.
# trivial_scaling : If true, web images that only need scaling will be used as-is
# assuming the user agent scale the image.
# background : background color when filling or transparency.
# typeProperties : hash of types=>hash.
# The hash for each type can have the following
# destination_type : the type to convert the file to if different.
# transparent : if true, the background color will be made transparent.
# quality : the `quality' used for the image.
# ncolors : the image will be quantized to ncolors.
# prescale : If true, and there are leading (or only) scaling commands,
# compute the new image size and re-read the image into that size
# This is useful for getting the best antialiasing for postscript, eg.
# unit= (pixel|point) : What unit the image size is given in.
# autocrop : if the image should be cropped (trimmed) when loaded.
sub new {
my($class,%options)=@_;
my $self = $class->SUPER::new(%options);
$$self{dppt} = (($options{dpi} || 90)/72.0); # Dots per point.
$$self{ignoreOptions} = $options{ignoreOptions} || [];
$$self{trivial_scaling} = $options{trivial_scaling} || 1;
$$self{graphicsSourceTypes}= $options{graphicsSourceTypes}
|| [qw(png gif jpg jpeg
eps ps ai)];
$$self{typeProperties} = $options{typeProperties}
|| {
ai =>{destination_type=>'png',
transparent=>1,
prescale=>1, ncolors=>'400%', quality=>90, unit=>'point'},
pdf =>{destination_type=>'png',
transparent=>1,
prescale=>1, ncolors=>'400%', quality=>90, unit=>'point'},
ps =>{destination_type=>'png', transparent=>1,
prescale=>1, ncolors=>'400%', quality=>90, unit=>'point'},
eps =>{destination_type=>'png', transparent=>1,
prescale=>1, ncolors=>'400%', quality=>90, unit=>'point'},
jpg =>{destination_type=>'jpg',
ncolors=>'400%', unit=>'pixel'},
jpeg=>{destination_type=>'jpeg',
ncolors=>'400%', unit=>'pixel'},
gif =>{destination_type=>'gif', transparent=>1,
ncolors=>'400%', unit=>'pixel'},
png =>{destination_type=>'png', transparent=>1,
ncolors=>'400%', unit=>'pixel'}},
$$self{background} = $options{background} || "#FFFFFF";
$self; }
sub process {
my($self,$doc)=@_;
local $LaTeXML::Post::Graphics::SEARCHPATHS
= [map(pathname_canonical($_),$self->findGraphicsPaths($doc), $doc->getSearchPaths)];
$self->ProgressDetailed($doc,"Using graphicspaths: "
.join(', ',@$LaTeXML::Post::Graphics::SEARCHPATHS));
if(my @nodes = $self->selectGraphicsNodes($doc)){
$self->Progress($doc,scalar(@nodes)." graphics nodes to process");
foreach my $node (@nodes){
$self->processGraphic($doc,$node); }
$doc->closeCache; } # If opened.
$doc; }
#======================================================================
# Potentially customizable operations.
# find graphics file
# Need to deal with source directory, as well as graphicspath.
# Extract any graphicspath PI's from the document and return a reference
# to a list of search paths.
sub findGraphicsPaths {
my($self,$doc)=@_;
my @paths = ();
foreach my $pi ($doc->findnodes('.//processing-instruction("latexml")')){
if($pi->textContent =~ /^\s*graphicspath\s*=\s*([\"\'])(.*?)\1\s*$/){
my $value=$2;
while($value=~ s/^\s*\{(.*?)\}//){
push(@paths,$1); }}}
@paths; }
# Return a list of ZML nodes which have graphics that need processing.
sub selectGraphicsNodes {
my($self,$doc)=@_;
$doc->findnodes('//ltx:graphics'); }
sub getGraphicsSourceTypes {
my($self)=@_;
@{$$self{graphicsSourceTypes}}; }
# Return the pathname to an appropriate image.
sub findGraphicFile {
my($self,$doc,$node)=@_;
if(my $name = $node->getAttribute('graphic')){
pathname_find($name,paths=>$LaTeXML::Post::Graphics::SEARCHPATHS,
types=>[$self->getGraphicsSourceTypes]); }
else {
undef; }}
#======================================================================
# Return the Transform to be used for this node
# Default is based on parsing the graphicx options
sub getTransform {
my($self,$node)=@_;
my $options = $node->getAttribute('options');
($options ? $self->parseOptions($options) : []); }
# Get a hash of the image processing properties to be applied to this image.
sub getTypeProperties {
my($self,$source,$options)=@_;
my($dir,$name,$type)=pathname_split($source);
%{$$self{typeProperties}{$type}}; }
# Set the attributes of the graphics node to record the image file name,
# width and height.
sub setGraphicSrc {
my($self,$node,$src,$width,$height)=@_;
$node->setAttribute('imagesrc',$src);
$node->setAttribute('imagewidth',$width);
$node->setAttribute('imageheight',$height);
}
sub processGraphic {
my($self,$doc,$node)=@_;
my $source = $self->findGraphicFile($doc,$node);
if(!$source){
$self->Warn($doc,"Missing graphic for ".$node->toString."; skipping"); return; }
my $transform = $self->getTransform($node);
my($image,$width,$height)=$self->transformGraphic($doc,$node,$source,$transform);
$self->setGraphicSrc($node,$image,$width,$height) if $image;
}
#======================================================================
sub transformGraphic {
my($self,$doc,$node,$source,$transform)=@_;
my $sourcedir=$doc->getSourceDirectory;
($sourcedir) = $doc->getSearchPaths unless $sourcedir; # Fishing...
my ($reldir,$name,$srctype)
= pathname_split(pathname_relative($source,$sourcedir));
my $key = (ref $self).':'.join('|',"$reldir$name.$srctype", map(join(' ',@$_),@$transform));
$self->ProgressDetailed($doc,"Processing $source as key=$key");
my %properties = $self->getTypeProperties($source,$transform);
return warn "Don't know what to do with graphics file format $source" unless %properties;
my $type = $properties{destination_type} || $srctype;
my $reldest = $self->desiredResourcePathname($doc,$node,$source,$type);
if(my $prev = $doc->cacheLookup($key)){ # Image was processed on previous run?
$prev =~ /^(.*?)\|(\d+)\|(\d+)$/;
my ($cached,$width,$height)=($1,$2,$3);
if((!defined $reldest) || ($cached eq $reldest)){
my $dest = pathname_make(dir=>$doc->getDestinationDirectory,name=>$cached);
# if(-f $dest && (-M $source >= -M $dest)){
if(pathname_timestamp($source) < pathname_timestamp($dest)){
$self->ProgressDetailed($doc,">> Reuse $cached @ $width x $height");
return ($cached,$width,$height); }}}
$reldest = $self->generateResourcePathname($doc,$node,$source,$type) unless $reldest;
my $dest = $doc->checkDestination($reldest);
$self->ProgressDetailed($doc,"Destination $dest");
# Trivial scaling case: Use original image with different width & height.
my ($image,$width,$height);
if($$self{trivial_scaling} && ($type eq $srctype) && !grep(!($_->[0]=~/^scale/),@$transform)){
($width,$height)=$self->trivial_scaling($doc,$source,$transform);
return unless $width && $height;
pathname_copy($source, $dest) or warn("Couldn't copy $source to $dest: $!");
$self->ProgressDetailed($doc,">> Copied to $reldest for $width x $height"); }
else {
($image,$width,$height) =$self->complex_transform($doc,$source,$transform, %properties);
return unless $image && $width && $height;
$self->ProgressDetailed($doc,">> Writing to $dest ");
$self->ImageWrite($doc,$image,$dest) or return; }
$doc->cacheStore($key,"$reldest|$width|$height");
$self->ProgressDetailed($doc,">> done with $key");
($reldest,$width,$height); }
#======================================================================
# Compute the desired image size (width,height)
sub trivial_scaling {
my($self,$doc,$source,$transform)=@_;
my $image = $self->ImageRead($doc,$source) or return;
my($w,$h) = $self->ImageGet($doc,$image,'width','height');
return unless $w && $h;
foreach my $trans (@$transform){
my($op,$a1,$a2,$a3,$a4)=@$trans;
if($op eq 'scale'){ # $a1 => scale
($w,$h)=(ceil($w*$a1),ceil($h*$a1)); }
elsif($op eq 'scale-to'){ # $a1 => width, $a2 => height, $a3 => preserve aspect ratio.
if($a3){ # If keeping aspect ratio, ignore the most extreme request
if($a1/$w < $a2/$h) { $a2 = $h*$a1/$w; }
else { $a1 = $w*$a2/$h; }}
($w,$h)=(ceil($a1*$$self{dppt}),ceil($a2*$$self{dppt})); }}
return ($w,$h); }
# Transform the image, returning (image,width,height);
sub complex_transform {
my($self,$doc,$source,$transform, %properties)=@_;
my $image = $self->ImageRead($doc,$source,antialias=>1) or return;
$self->ImageOp($doc,$image,'Trim') or return if $properties{autocrop};
my $orig_ncolors = $self->ImageGet($doc,$image,'colors');
return unless $orig_ncolors;
my ($w,$h) = $self->ImageGet($doc,$image,'width','height');
return unless $w && $h;
my @transform = @$transform;
# If native unit is points, we at least need to scale by dots/point.
# [tho' other scalings may override this]
if(($properties{unit}||'pixel') eq 'point'){
push(@transform, ['scale',$$self{dppt}]); }
# For prescaling, compute the desired size and re-read the image into that size,
# with an appropriate density set. This will give much better anti-aliasing.
# Actually, we'll set the density & size up a further factor of $F, and then downscale.
if($properties{prescale}){
my($w0,$h0)=($w,$h);
while(@transform && ($transform[0]->[0] =~ /^scale/)){
my($op,$a1,$a2,$a3,$a4)=@{shift(@transform)};
if($op eq 'scale'){ # $a1 => scale
($w,$h)=(ceil($w*$a1),ceil($h*$a1)); }
elsif($op eq 'scale-to'){
# $a1 => width (pts), $a2 => height (pts), $a3 => preserve aspect ratio.
if($a3){ # If keeping aspect ratio, ignore the most extreme request
if($a1/$w < $a2/$h) { $a2 = $h*$a1/$w; }
else { $a1 = $w*$a2/$h; }}
($w,$h)=(ceil($a1*$$self{dppt}),ceil($a2*$$self{dppt})); }}
my $X = 4; # Expansion factor
my($dx,$dy)=(int($X * 72 * $w/$w0),int($X * 72 * $h/$h0));
$self->ProgressDetailed($doc,">> reloading to desired size $w x $h (density = $dx x $dy)");
$image = $self->ImageRead($doc,$source, antialias=>1, density=>$dx.'x'.$dy) or return;
$self->ImageOp($doc,$image,'Trim') or return if $properties{autocrop};
$self->ImageSet($doc,$image, colorspace=>'RGB') or return;
$self->ImageOp($doc,$image,'Scale',geometry=>int(100/$X)."%") or return; # Now downscale.
($w,$h) = $self->ImageGet($doc,$image,'width','height');
return unless $w && $h; }
my $notes='';
foreach my $trans (@transform){
my($op,$a1,$a2,$a3,$a4)=@$trans;
if($op eq 'scale'){ # $a1 => scale
($w,$h)=(ceil($w*$a1),ceil($h*$a1));
$notes .= " scale to $w x $h";
$self->ImageOp($doc,$image,'Scale',width=>$w,height=>$h) or return; }
elsif($op eq 'scale-to'){
# $a1 => width (pts), $a2 => height (pts), $a3 => preserve aspect ratio.
if($a3){ # If keeping aspect ratio, ignore the most extreme request
if($a1/$w < $a2/$h) { $a2 = $h*$a1/$w; }
else { $a1 = $w*$a2/$h; }}
($w,$h)=(ceil($a1*$$self{dppt}),ceil($a2*$$self{dppt}));
$notes .= " scale-to $w x $h";
$self->ImageOp($doc,$image,'Scale',width=>$w,height=>$h) or return; }
elsif($op eq 'rotate'){
$self->ImageOp($doc,$image,'Rotate',degrees=>-$a1,color=>$$self{background}) or return;
($w,$h) = $self->ImageGet($doc,$image,'width','height');
return unless $w && $h;
$notes .= " rotate $a1 to $w x $h"; }
# In the following two, note that TeX's coordinates are relative to lower left corner,
# but ImageMagick's coordinates are relative to upper left.
elsif(($op eq 'trim') || ($op eq 'clip')){
my($x0,$y0,$ww,$hh);
if($op eq 'trim'){ # Amount to trim: a1=left, a2=bottom, a3=right, a4=top
($x0,$y0,$ww,$hh)=( floor($a1*$$self{dppt}), floor($a4*$$self{dppt}),
ceil($w - ($a1 + $a3)*$$self{dppt}), ceil($h - ($a4 + $a2)*$$self{dppt}));
$notes .= " trim to $ww x $hh @ $x0,$y0"; }
else { # BBox: a1=left, a2=bottom, a3=right, a4=top
($x0,$y0,$ww,$hh)=( floor($a1*$$self{dppt}), floor($h - $a4*$$self{dppt}),
ceil(($a3 - $a1)*$$self{dppt}), ceil(($a4 - $a2)*$$self{dppt}));
$notes .= " clip to $ww x $hh @ $x0,$y0"; }
if(($x0 > 0) || ($y0 > 0) || ($x0+$ww < $w) || ($y0+$hh < $h)){
my $x0p=max($x0,0); $x0 = min($x0,0);
my $y0p=max($y0,0); $y0 = min($y0,0);
$self->ImageOp($doc,$image,'Crop',x=>$x0p, width =>min($ww,$w-$x0p),
y=>$y0p, height=>min($hh,$h-$y0p)) or return;
$w = min($ww+$x0, $w-$x0p);
$h = min($hh+$y0, $h-$y0p);
$notes .= " crop $w x $h @ $x0p,$y0p"; }
# No direct `padding' operation in ImageMagick
my $nimage = $self->ImageRead($doc,"xc:$$self{background}", size=>"$ww x $hh") or return;
$self->ImageOp($doc,$nimage,'Composite',image=>$image, compose=>'over', x=>-$x0, y=>-$y0) or return;
$image=$nimage;
($w,$h)=($ww,$hh);
}}
if(my $trans = $properties{transparent}){
$notes .= " transparent=$$self{background}";
$self->ImageOp($doc,$image,'Transparent',$$self{background}) or return; }
if(my $curr_ncolors = $self->ImageGet($doc,$image,'colors')){
if(my $req_ncolors = $properties{ncolors}){
$req_ncolors = int($orig_ncolors * $1/ 100) if $req_ncolors =~ /^([\d]*)\%$/;
if($req_ncolors < $curr_ncolors){
$notes .= " quantize $orig_ncolors => $req_ncolors";
$self->ImageOp($doc,$image,'Quantize',colors=>$req_ncolors) or return; }}}
if(my $quality = $properties{quality}){
$notes .= " quality=$quality";
$self->ImageSet($doc,$image, quality=>$properties{quality}) or return; }
$self->ProgressDetailed($doc,">> Transformed : $notes") if $notes;
($image,$w,$h); }
sub min { ($_[0] < $_[1] ? $_[0] : $_[1]); }
sub max { ($_[0] > $_[1] ? $_[0] : $_[1]); }
# Wrap up ImageMagick's methods to give more useful & consistent error handling.
# These all return non-zero on success!
# so, you generally want to do $self->ImageOp(...) or return;
# This reads a new image, setting the given properties BEFORE ingesting the image data.
sub ImageRead {
my($self,$doc,$source,@args)=@_;
my $image = Image::Magick->new();
$self->ImageOp($doc,$image,'Set',@args) or return;
$self->ImageOp($doc,$image,'Read',$source) or return;
$image; }
sub ImageWrite {
my($self,$doc,$image,$destination)=@_;
# In the perverse case that we've ended up with a sequence of images; flatten them.
if(@$image > 1){
my $fimage = $image->Flatten(); # Just in case we ended up with pieces!?!?!?
$image = $fimage if $fimage; }
$self->ImageOp($doc,$image,'Write',filename=>$destination) or return; }
sub ImageGet {
my($self,$doc,$image,@args)=@_;
my @values = $image->Get(@args);
@values; }
sub ImageSet {
my($self,$doc,$image,@args)=@_;
$self->ImageOp($doc,$image,'Set',@args); }
sub ImageOp {
my($self,$doc,$image,$operation,@args)=@_;
my $retval = $image->$operation(@args);
return 1 unless $retval;
$retval =~ /(\d+)/;
my $retcode = $1;
if($retcode < 400){ # Warning
$self->Warn($doc,"Image Warning: operation $operation (".join(', ',@args).") returned $retval");
1; }
else { # Error
$self->Warn($doc,"Image Error: $operation (".join(', ',@args).") returned $retval");
0; }}
#**********************************************************************
# Note that viewport is supposed to be relative to bounding box,
# and EITHER ONE can cause clipping, if clip=true.
# However, apparently the INTENT of bounding box is simply to
# supply one, if one can't be found, in order to determine the image size.
# In our case, we may end up getting a gif, jpeg, etc, whose origin is always 0,0,
# and whose size is clear; also postscript figures sizes will be determined
# by ghostview(?). Another use of setting a bounding box, when clip=false,
# is to make the image lay ontop of neighboring text. This isn't quite
# possible in HTML, other than possibly through some tricky CSS.
# Besides, I'd like to avoid reading the bb file, if I can.
# --- So, for all these reasons, we simply ignore bounding box here.
sub parseOptions {
my($self,$options)=@_;
local $_;
# --------------------------------------------------
# Parse options
my ($v,$clip,$trim,$width,$height,$scale,$aspect,$a,$rotfirst,$mag,@bb,@vp,)
=('', '', '', 0, 0, 0, '', 0, '', 1, 0);
my @unknown=();
foreach (split(',',$options||'')){
/^\s*(\w+)(=\s*(.*))?\s*$/; $_=$1; $v=$3||'';
my $op = $_;
if(grep($op eq $_, @{$$self{ignoreOptions}})){ } # Ignore this option
elsif(/^bb$/) { @bb = map(to_bp($_),split(' ',$v)); }
elsif(/^bb(ll|ur)(x|y)$/) { $bb[2*/ur/ + /y/] = to_bp($v); }
elsif(/^nat(width|height)$/){ $bb[2 + /width/] = to_bp($v); }
elsif(/^viewport$/) { @vp = map(to_bp($_),split(' ',$v)); $trim=0;}
elsif(/^trim$/) { @vp = map(to_bp($_),split(' ',$v)); $trim=1;}
elsif(/^clip$/) { $clip = !($v eq 'false'); }
elsif(/^keepaspectratio$/) { $aspect = !($v eq 'false'); }
elsif(/^width$/) { $width = to_bp($v); }
elsif(/^(total)?height$/) { $height = to_bp($v); }
elsif(/^scale$/) { $scale = $v; }
elsif(/^angle$/) { $a = $v; $rotfirst = !($width||$height||$scale); }
elsif(/^origin$/) { } # ??
# Non-standard option
elsif(/^magnification$/) { $mag = $v; }
else { push(@unknown,[$op,$v]); }}
# --------------------------------------------------
# Now, compile the options into a sequence of `transformations'.
# Note: the order of rotation & scaling is significant,
# but the order of various clipping options w.r.t rotation or scaling is not.
my @transform=();
# We ignore viewport & trim if clip isn't set, since in that case we shouldn't
# actually remove anything from the image (and there's no way to have the image
# overlap neighboring text, etc, in current HTML).
push(@transform, [($trim ? 'trim' : 'clip'), @vp]) if(@vp && $clip);
push(@transform,['rotate',$a]) if($rotfirst && $a); # Rotate before scaling?
if($width && $height){ push(@transform,['scale-to',$mag*$width,$mag*$height,$aspect]); }
elsif($width) { push(@transform,['scale-to',$mag*$width,999999,1]); }
elsif($height) { push(@transform,['scale-to',999999,$mag*$height,1]); }
elsif($scale) { push(@transform,['scale',$mag*$scale]); }
elsif($mag!=1) { push(@transform,['scale',$mag]); }
push(@transform,['rotate',$a]) if(!$rotfirst && $a); # Rotate after scaling?
# ----------------------
[@transform,@unknown]; }
our %BP_conversions=(pt=>72/72.27, pc=>12/72.27, in=>72, bp=>1,
cm=>72/2.54, mm=>72/25.4, dd=>(72/72.27)*(1238/1157),
cc=>12*(72/72.27)*(1238/1157),sp=>72/72.27/65536);
sub to_bp {
my($x)=@_;
$x =~ /^\s*([+-]?[\d\.]+)(\w*)\s*$/;
my($v,$u)=($1,$2);
$v*($u ? $BP_conversions{$u} : 1); }
#======================================================================
1;
|