/usr/share/perl5/Image/ExifTool/GIF.pm is in libimage-exiftool-perl 10.80-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 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 | #------------------------------------------------------------------------------
# File: GIF.pm
#
# Description: Read and write GIF meta information
#
# Revisions: 10/18/2005 - P. Harvey Separated from ExifTool.pm
# 05/23/2008 - P. Harvey Added ability to read/write XMP
# 10/28/2011 - P. Harvey Added ability to read/write ICC_Profile
#
# References: 1) http://www.w3.org/Graphics/GIF/spec-gif89a.txt
# 2) http://www.adobe.com/devnet/xmp/
# 3) http://graphcomp.com/info/specs/ani_gif.html
# 4) http://www.color.org/icc_specs2.html
# 5) http://www.midiox.com/mmgif.htm
#------------------------------------------------------------------------------
package Image::ExifTool::GIF;
use strict;
use vars qw($VERSION);
use Image::ExifTool qw(:DataAccess :Utils);
$VERSION = '1.14';
# road map of directory locations in GIF images
my %gifMap = (
XMP => 'GIF',
ICC_Profile => 'GIF',
);
%Image::ExifTool::GIF::Main = (
GROUPS => { 2 => 'Image' },
VARS => { NO_ID => 1 },
NOTES => q{
This table lists information extracted from GIF images. See
L<http://www.w3.org/Graphics/GIF/spec-gif89a.txt> for the official GIF89a
specification.
},
GIFVersion => { },
FrameCount => { Notes => 'number of animated images' },
Text => { Notes => 'text displayed in image' },
Comment => {
# for documentation only -- flag as writable for the docs, but
# it won't appear in the TagLookup because there is no WRITE_PROC
Writable => 1,
},
Duration => {
Notes => 'duration of a single animation iteration',
PrintConv => 'sprintf("%.2f s",$val)',
},
ScreenDescriptor => {
SubDirectory => { TagTable => 'Image::ExifTool::GIF::Screen' },
},
Extensions => { # (for documentation only)
SubDirectory => { TagTable => 'Image::ExifTool::GIF::Extensions' },
},
);
# GIF89a application extensions:
%Image::ExifTool::GIF::Extensions = (
GROUPS => { 2 => 'Image' },
NOTES => 'Tags extracted from GIF89a application extensions.',
'NETSCAPE/2.0' => { #3
Name => 'Animation',
SubDirectory => { TagTable => 'Image::ExifTool::GIF::Animation' },
},
'XMP Data/XMP' => { #2
Name => 'XMP',
IncludeLengthBytes => 1, # length bytes are included in the data
Writable => 1,
SubDirectory => { TagTable => 'Image::ExifTool::XMP::Main' },
},
'ICCRGBG1/012' => { #4
Name => 'ICC_Profile',
Writable => 1,
SubDirectory => { TagTable => 'Image::ExifTool::ICC_Profile::Main' },
},
'MIDICTRL/Jon' => { #5
Name => 'MIDIControl',
SubDirectory => { TagTable => 'Image::ExifTool::GIF::MIDIControl' },
},
'MIDISONG/Dm7' => { #5
Name => 'MIDISong',
Groups => { 2 => 'Audio' },
Binary => 1,
},
);
# GIF locical screen descriptor
%Image::ExifTool::GIF::Screen = (
PROCESS_PROC => \&Image::ExifTool::ProcessBinaryData,
GROUPS => { 2 => 'Image' },
NOTES => 'Information extracted from the GIF logical screen descriptor.',
0 => {
Name => 'ImageWidth',
Format => 'int16u',
},
2 => {
Name => 'ImageHeight',
Format => 'int16u',
},
4.1 => {
Name => 'HasColorMap',
Mask => 0x80,
PrintConv => { 0x00 => 'No', 0x80 => 'Yes' },
},
4.2 => {
Name => 'ColorResolutionDepth',
Mask => 0x70,
ValueConv => '($val >> 4) + 1',
},
4.3 => {
Name => 'BitsPerPixel',
Mask => 0x07,
ValueConv => '$val + 1',
},
5 => 'BackgroundColor',
);
# GIF Netscape 2.0 animation extension (ref 3)
%Image::ExifTool::GIF::Animation = (
PROCESS_PROC => \&Image::ExifTool::ProcessBinaryData,
GROUPS => { 2 => 'Image' },
NOTES => 'Information extracted from the "NETSCAPE2.0" animation extension.',
1 => {
Name => 'AnimationIterations',
Format => 'int16u',
PrintConv => '$val ? $val : "Infinite"',
},
);
# GIF MIDICTRL extension (ref 5)
%Image::ExifTool::GIF::MIDIControl = (
PROCESS_PROC => \&Image::ExifTool::ProcessBinaryData,
GROUPS => { 2 => 'Audio' },
NOTES => 'Information extracted from the MIDI control block extension.',
0 => 'MIDIControlVersion',
1 => 'SequenceNumber',
2 => 'MelodicPolyphony',
3 => 'PercussivePolyphony',
4 => {
Name => 'ChannelUsage',
Format => 'int16u',
PrintConv => 'sprintf("0x%.4x", $val)',
},
6 => {
Name => 'DelayTime',
Format => 'int16u',
ValueConv => '$val / 100',
PrintConv => '$val . " s"',
},
);
#------------------------------------------------------------------------------
# Process meta information in GIF image
# Inputs: 0) ExifTool object reference, 1) Directory information ref
# Returns: 1 on success, 0 if this wasn't a valid GIF file, or -1 if
# an output file was specified and a write error occurred
sub ProcessGIF($$)
{
my ($et, $dirInfo) = @_;
my $outfile = $$dirInfo{OutFile};
my $raf = $$dirInfo{RAF};
my $verbose = $et->Options('Verbose');
my $out = $et->Options('TextOut');
my ($a, $s, $ch, $length, $buff);
my ($err, $newComment, $setComment, $nvComment);
my ($addDirs, %doneDir);
my ($frameCount, $delayTime) = (0, 0);
# verify this is a valid GIF file
return 0 unless $raf->Read($buff, 6) == 6
and $buff =~ /^GIF(8[79]a)$/
and $raf->Read($s, 7) == 7;
my $ver = $1;
my $rtnVal = 0;
my $tagTablePtr = GetTagTable('Image::ExifTool::GIF::Main');
SetByteOrder('II');
if ($outfile) {
$et->InitWriteDirs(\%gifMap, 'XMP'); # make XMP the preferred group for GIF
$addDirs = $$et{ADD_DIRS};
# determine if we are editing the File:Comment tag
my $delGroup = $$et{DEL_GROUP};
$newComment = $et->GetNewValue('Comment', \$nvComment);
$setComment = 1 if $nvComment or $$delGroup{File};
# change to GIF 89a if adding comment, XMP or ICC_Profile
$buff = 'GIF89a' if $$addDirs{XMP} or $$addDirs{ICC_Profile} or defined $newComment;
Write($outfile, $buff, $s) or $err = 1;
} else {
$et->SetFileType(); # set file type
$et->HandleTag($tagTablePtr, 'GIFVersion', $ver);
$et->HandleTag($tagTablePtr, 'ScreenDescriptor', $s);
}
my $flags = Get8u(\$s, 4);
if ($flags & 0x80) { # does this image contain a color table?
# calculate color table size
$length = 3 * (2 << ($flags & 0x07));
$raf->Read($buff, $length) == $length or return 0; # skip color table
Write($outfile, $buff) or $err = 1 if $outfile;
}
#
# loop through GIF blocks
#
Block:
for (;;) {
last unless $raf->Read($ch, 1);
# write out any new metadata now if this isn't an extension block
if ($outfile and ord($ch) != 0x21) {
# write the comment first if necessary
if (defined $newComment and $$nvComment{IsCreating}) {
# write comment marker
Write($outfile, "\x21\xfe") or $err = 1;
$verbose and print $out " + Comment = $newComment\n";
my $len = length($newComment);
# write out the comment in 255-byte chunks, each
# chunk beginning with a length byte
my $n;
for ($n=0; $n<$len; $n+=255) {
my $size = $len - $n;
$size > 255 and $size = 255;
my $str = substr($newComment,$n,$size);
Write($outfile, pack('C',$size), $str) or $err = 1;
}
Write($outfile, "\0") or $err = 1; # empty chunk as terminator
undef $newComment;
undef $nvComment; # delete any other extraneous comments
++$$et{CHANGED}; # increment file changed flag
}
# add application extension containing XMP block if necessary
# (this will place XMP before the first non-extension block)
if (exists $$addDirs{XMP} and not defined $doneDir{XMP}) {
$doneDir{XMP} = 1;
# write new XMP data
my $xmpTable = GetTagTable('Image::ExifTool::XMP::Main');
my %dirInfo = ( Parent => 'GIF' );
$verbose and print $out "Creating XMP application extension block:\n";
$buff = $et->WriteDirectory(\%dirInfo, $xmpTable);
if (defined $buff and length $buff) {
my $lz = pack('C*',1,reverse(0..255),0);
Write($outfile, "\x21\xff\x0bXMP DataXMP", $buff, $lz) or $err = 1;
++$doneDir{XMP}; # set to 2 to indicate we added XMP
} else {
$verbose and print $out " -> no XMP to add\n";
}
}
# add application extension containing ICC_Profile if necessary
if (exists $$addDirs{ICC_Profile} and not defined $doneDir{ICC_Profile}) {
$doneDir{ICC_Profile} = 1;
# write new ICC_Profile
my $iccTable = GetTagTable('Image::ExifTool::ICC_Profile::Main');
my %dirInfo = ( Parent => 'GIF' );
$verbose and print $out "Creating ICC_Profile application extension block:\n";
$buff = $et->WriteDirectory(\%dirInfo, $iccTable);
if (defined $buff and length $buff) {
my $pos = 0;
Write($outfile, "\x21\xff\x0bICCRGBG1012") or $err = 1;
my $len = length $buff;
while ($pos < $len) {
my $n = $len - $pos;
$n = 255 if $n > 255;
Write($outfile, chr($n), substr($buff, $pos, $n)) or $err = 1;
$pos += $n;
}
Write($outfile, "\0") or $err = 1; # write null terminator
++$doneDir{ICC_Profile}; # set to 2 to indicate we added a new profile
} else {
$verbose and print $out " -> no ICC_Profile to add\n";
}
}
}
if (ord($ch) == 0x2c) {
++$frameCount;
Write($outfile, $ch) or $err = 1 if $outfile;
# image descriptor
last unless $raf->Read($buff, 8) == 8 and $raf->Read($ch, 1);
Write($outfile, $buff, $ch) or $err = 1 if $outfile;
if ($verbose) {
my ($left, $top, $w, $h) = unpack('v*', $buff);
print $out "Image: left=$left top=$top width=$w height=$h\n";
}
if (ord($ch) & 0x80) { # does color table exist?
$length = 3 * (2 << (ord($ch) & 0x07));
# skip the color table
last unless $raf->Read($buff, $length) == $length;
Write($outfile, $buff) or $err = 1 if $outfile;
}
# skip "LZW Minimum Code Size" byte
last unless $raf->Read($buff, 1);
Write($outfile,$buff) or $err = 1 if $outfile;
# skip image blocks
for (;;) {
last unless $raf->Read($ch, 1);
Write($outfile, $ch) or $err = 1 if $outfile;
last unless ord($ch);
last unless $raf->Read($buff, ord($ch));
Write($outfile,$buff) or $err = 1 if $outfile;
}
next; # continue with next field
}
# last if ord($ch) == 0x3b; # normal end of GIF marker
unless (ord($ch) == 0x21) {
if ($outfile) {
Write($outfile, $ch) or $err = 1;
# copy the rest of the file
while ($raf->Read($buff, 65536)) {
Write($outfile, $buff) or $err = 1;
}
}
$rtnVal = 1;
last;
}
# get extension block type/size
last unless $raf->Read($s, 2) == 2;
# get marker and block size
($a,$length) = unpack("C"x2, $s);
if ($a == 0xfe) { # comment extension
my $comment = '';
while ($length) {
last unless $raf->Read($buff, $length) == $length;
if ($verbose > 2 and not $outfile) {
HexDump(\$buff, undef, Out => $out);
}
# add buffer to comment string
$comment .= $buff;
last unless $raf->Read($ch, 1); # read next block header
$length = ord($ch); # get next block size
}
last if $length; # was a read error if length isn't zero
if ($outfile) {
my $isOverwriting;
if ($setComment) {
if ($nvComment) {
$isOverwriting = $et->IsOverwriting($nvComment,$comment);
# get new comment again (may have been shifted)
$newComment = $et->GetNewValue($nvComment) if defined $newComment;
} else {
# group delete, or deleting additional comments after writing one
$isOverwriting = 1;
}
}
if ($isOverwriting) {
++$$et{CHANGED}; # increment file changed flag
$et->VerboseValue('- Comment', $comment);
$comment = $newComment;
$et->VerboseValue('+ Comment', $comment) if defined $comment;
undef $nvComment; # just delete remaining comments
} else {
undef $setComment; # leave remaining comments alone
}
if (defined $comment) {
# write comment marker
Write($outfile, "\x21\xfe") or $err = 1;
my $len = length($comment);
# write out the comment in 255-byte chunks, each
# chunk beginning with a length byte
my $n;
for ($n=0; $n<$len; $n+=255) {
my $size = $len - $n;
$size > 255 and $size = 255;
my $str = substr($comment,$n,$size);
Write($outfile, pack('C',$size), $str) or $err = 1;
}
Write($outfile, "\0") or $err = 1; # empty chunk as terminator
}
undef $newComment; # don't write the new comment again
} else {
$rtnVal = 1;
$et->FoundTag('Comment', $comment) if $comment;
undef $comment;
# assume no more than one comment in FastScan mode
last if $et->Options('FastScan');
}
next;
} elsif ($a == 0xff and $length == 0x0b) { # application extension
last unless $raf->Read($buff, $length) == $length;
my $hdr = "$ch$s$buff";
# add "/" for readability
my $tag = substr($buff, 0, 8) . '/' . substr($buff, 8);
$tag =~ tr/\0-\x1f//d; # remove nulls and control characters
$verbose and print $out "Application Extension: $tag\n";
my $extTable = GetTagTable('Image::ExifTool::GIF::Extensions');
my $extInfo = $$extTable{$tag};
my ($subdir, $inclLen, $justCopy);
if ($extInfo) {
$subdir = $$extInfo{SubDirectory};
$inclLen = $$extInfo{IncludeLengthBytes};
# rewrite as-is unless this is a writable subdirectory
$justCopy = 1 if $outfile and (not $subdir or not $$extInfo{Writable});
} else {
$justCopy = 1 if $outfile;
}
Write($outfile, $hdr) or $err = 1 if $justCopy;
# read the extension data
my $dat = '';
for (;;) {
$raf->Read($ch, 1) or last Block; # read next block header
$length = ord($ch) or last; # get next block size
$raf->Read($buff, $length) == $length or last Block;
Write($outfile, $ch, $buff) or $err = 1 if $justCopy;
$dat .= $inclLen ? $ch . $buff : $buff;
}
Write($outfile, "\0") if $justCopy;
if ($subdir) {
my $dirLen = length $dat;
my $name = $$extInfo{Name};
if ($name eq 'XMP') {
# get length of XMP without landing zone data
# (note that LZ data may not be exactly the same as what we use)
$dirLen = pos($dat) if $dat =~ /<\?xpacket end=['"][wr]['"]\?>/g;
}
my %dirInfo = (
DataPt => \$dat,
DataLen => length $dat,
DirLen => $dirLen,
DirName => $name,
Parent => 'GIF',
);
my $subTable = GetTagTable($$subdir{TagTable});
if (not $outfile) {
$et->ProcessDirectory(\%dirInfo, $subTable);
} elsif ($$extInfo{Writable}) {
if ($doneDir{$name} and $doneDir{$name} > 1) {
$et->Warn("Duplicate $name block created");
}
$buff = $et->WriteDirectory(\%dirInfo, $subTable);
if (defined $buff) {
next unless length $buff; # delete this extension if length is zero
# check for null just to be safe
$et->Error("$name contained NULL character") if $buff =~ /\0/;
$dat = $buff;
# add landing zone (without terminator, which will be added later)
$dat .= pack('C*',1,reverse(0..255)) if $$extInfo{IncludeLengthBytes};
} # (else rewrite original data)
$doneDir{$name} = 1;
if ($$extInfo{IncludeLengthBytes}) {
# write data and landing zone
Write($outfile, $hdr, $dat) or $err = 1;
} else {
# write as sub-blocks
Write($outfile, $hdr) or $err = 1;
my $pos = 0;
my $len = length $dat;
while ($pos < $len) {
my $n = $len - $pos;
$n = 255 if $n > 255;
Write($outfile, chr($n), substr($dat, $pos, $n)) or $err = 1;
$pos += $n;
}
}
Write($outfile, "\0") or $err = 1; # write null terminator
}
} elsif (not $outfile) {
$et->HandleTag($extTable, $tag, $dat);
}
next;
} elsif ($a == 0xf9 and $length == 4) { # graphic control extension
last unless $raf->Read($buff, $length) == $length;
# sum the indivual delay times
my $delay = Get16u(\$buff, 1);
$delayTime += $delay;
$verbose and printf $out "Graphic Control: delay=%.2f\n", $delay / 100;
$raf->Seek(-$length, 1) or last;
} elsif ($a == 0x01 and $length == 12) { # plain text extension
last unless $raf->Read($buff, $length) == $length;
Write($outfile, $ch, $s, $buff) or $err = 1 if $outfile;
if ($verbose) {
my ($left, $top, $w, $h) = unpack('v4', $buff);
print $out "Text: left=$left top=$top width=$w height=$h\n";
}
my $text = '';
for (;;) {
last unless $raf->Read($ch, 1);
$length = ord($ch) or last;
last unless $raf->Read($buff, $length) == $length;
Write($outfile, $ch, $buff) or $err = 1 if $outfile; # write block
$text .= $buff;
}
Write($outfile, "\0") or $err = 1 if $outfile; # write terminator block
$et->HandleTag($tagTablePtr, 'Text', $text);
next;
}
Write($outfile, $ch, $s) or $err = 1 if $outfile;
# skip the block
while ($length) {
last unless $raf->Read($buff, $length) == $length;
Write($outfile, $buff) or $err = 1 if $outfile;
last unless $raf->Read($ch, 1); # read next block header
Write($outfile, $ch) or $err = 1 if $outfile;
$length = ord($ch); # get next block size
}
}
unless ($outfile) {
$et->HandleTag($tagTablePtr, 'FrameCount', $frameCount) if $frameCount > 1;
$et->HandleTag($tagTablePtr, 'Duration', $delayTime/100) if $delayTime;
}
# set return value to -1 if we only had a write error
$rtnVal = -1 if $rtnVal and $err;
return $rtnVal;
}
1; #end
__END__
=head1 NAME
Image::ExifTool::GIF - Read and write GIF meta information
=head1 SYNOPSIS
This module is loaded automatically by Image::ExifTool when required.
=head1 DESCRIPTION
This module contains definitions required by Image::ExifTool to read and
write GIF meta information.
=head1 AUTHOR
Copyright 2003-2018, Phil Harvey (phil at owl.phy.queensu.ca)
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
=head1 REFERENCES
=over 4
=item L<http://www.w3.org/Graphics/GIF/spec-gif89a.txt>
=item L<http://www.adobe.com/devnet/xmp/>
=item L<http://graphcomp.com/info/specs/ani_gif.html>
=item L<http://www.color.org/icc_specs2.html>
=item L<http://www.midiox.com/mmgif.htm>
=back
=head1 SEE ALSO
L<Image::ExifTool(3pm)|Image::ExifTool>
=cut
|