/usr/share/perl5/Image/ExifTool/PNG.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 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 | #------------------------------------------------------------------------------
# File: PNG.pm
#
# Description: Read and write PNG meta information
#
# Revisions: 06/10/2005 - P. Harvey Created
# 06/23/2005 - P. Harvey Added MNG and JNG support
# 09/16/2005 - P. Harvey Added write support
#
# References: 1) http://www.libpng.org/pub/png/spec/1.2/
# 2) http://www.faqs.org/docs/png/
# 3) http://www.libpng.org/pub/mng/
# 4) http://www.libpng.org/pub/png/spec/register/
# 5) ftp://ftp.simplesystems.org/pub/png/documents/pngext-1.4.0-pdg.html
#
# Notes: Writing meta information in PNG images is a pain in the butt
# for a number of reasons: One biggie is that you have to
# decompress then decode the ASCII/hex profile information before
# you can edit it, then you have to ASCII/hex-encode, recompress
# and calculate a CRC before you can write it out again. gaaaak.
#------------------------------------------------------------------------------
package Image::ExifTool::PNG;
use strict;
use vars qw($VERSION $AUTOLOAD %stdCase);
use Image::ExifTool qw(:DataAccess :Utils);
$VERSION = '1.45';
sub ProcessPNG_tEXt($$$);
sub ProcessPNG_iTXt($$$);
sub ProcessPNG_eXIf($$$);
sub ProcessPNG_Compressed($$$);
sub CalculateCRC($;$$$);
sub HexEncode($);
sub AddChunks($$;@);
sub Add_iCCP($$);
sub DoneDir($$$;$);
sub GetLangInfo($$);
sub BuildTextChunk($$$$$);
sub ConvertPNGDate($$);
sub InversePNGDate($$);
# translate lower-case to actual case used for eXIf/zXIf chunks
%stdCase = ( 'zxif' => 'zxIf', exif => 'eXIf' );
my $noCompressLib;
# look up for file type, header chunk and end chunk, based on file signature
my %pngLookup = (
"\x89PNG\r\n\x1a\n" => ['PNG', 'IHDR', 'IEND' ],
"\x8aMNG\r\n\x1a\n" => ['MNG', 'MHDR', 'MEND' ],
"\x8bJNG\r\n\x1a\n" => ['JNG', 'JHDR', 'IEND' ],
);
# map for directories in PNG images
my %pngMap = (
IFD1 => 'IFD0',
EXIF => 'IFD0', # to write EXIF as a block
ExifIFD => 'IFD0',
GPS => 'IFD0',
SubIFD => 'IFD0',
GlobParamIFD => 'IFD0',
PrintIM => 'IFD0',
InteropIFD => 'ExifIFD',
MakerNotes => 'ExifIFD',
IFD0 => 'PNG',
XMP => 'PNG',
ICC_Profile => 'PNG',
Photoshop => 'PNG',
'PNG-pHYs' => 'PNG',
IPTC => 'Photoshop',
MakerNotes => 'ExifIFD',
);
# color type of current image
$Image::ExifTool::PNG::colorType = -1;
# PNG chunks
%Image::ExifTool::PNG::Main = (
WRITE_PROC => \&Image::ExifTool::DummyWriteProc,
GROUPS => { 2 => 'Image' },
PREFERRED => 1, # always add these tags when writing
NOTES => q{
Tags extracted from PNG images. See
L<http://www.libpng.org/pub/png/spec/1.2/> for the official PNG 1.2
specification.
According to the specification, a PNG file should end at the IEND chunk,
however ExifTool will preserve any data found after this when writing unless
it is specifically deleted with C<-Trailer:All=>. When reading, a minor
warning is issued if this trailer exists, and ExifTool will attempt to parse
this data as additional PNG chunks.
},
bKGD => {
Name => 'BackgroundColor',
ValueConv => 'join(" ",unpack(length($val) < 2 ? "C" : "n*", $val))',
},
cHRM => {
Name => 'PrimaryChromaticities',
SubDirectory => { TagTable => 'Image::ExifTool::PNG::PrimaryChromaticities' },
},
dSIG => {
Name => 'DigitalSignature',
Binary => 1,
},
fRAc => {
Name => 'FractalParameters',
Binary => 1,
},
gAMA => {
Name => 'Gamma',
Notes => q{
ExifTool reports the gamma for decoding the image, which is consistent with
the EXIF convention, but is the inverse of the stored encoding gamma
},
ValueConv => 'my $a=unpack("N",$val);$a ? int(1e9/$a+0.5)/1e4 : $val',
},
gIFg => {
Name => 'GIFGraphicControlExtension',
Binary => 1,
},
gIFt => {
Name => 'GIFPlainTextExtension',
Binary => 1,
},
gIFx => {
Name => 'GIFApplicationExtension',
Binary => 1,
},
hIST => {
Name => 'PaletteHistogram',
Binary => 1,
},
iCCP => {
Name => 'ICC_Profile',
Notes => 'this is where ExifTool will write a new ICC_Profile',
SubDirectory => {
TagTable => 'Image::ExifTool::ICC_Profile::Main',
ProcessProc => \&ProcessPNG_Compressed,
},
},
'iCCP-name' => {
Name => 'ProfileName',
Notes => 'not a real tag ID, this tag represents the iCCP profile name',
},
# IDAT
# IEND
IHDR => {
Name => 'ImageHeader',
SubDirectory => { TagTable => 'Image::ExifTool::PNG::ImageHeader' },
},
iTXt => {
Name => 'InternationalText',
SubDirectory => {
TagTable => 'Image::ExifTool::PNG::TextualData',
ProcessProc => \&ProcessPNG_iTXt,
},
},
oFFs => {
Name => 'ImageOffset',
ValueConv => q{
my @a = unpack("NNC",$val);
$a[2] = ($a[2] ? "microns" : "pixels");
return "$a[0], $a[1] ($a[2])";
},
},
pCAL => {
Name => 'PixelCalibration',
Binary => 1,
},
pHYs => {
Name => 'PhysicalPixel',
SubDirectory => {
TagTable => 'Image::ExifTool::PNG::PhysicalPixel',
DirName => 'PNG-pHYs', # (needed for writing)
},
},
PLTE => {
Name => 'Palette',
ValueConv => 'length($val) <= 3 ? join(" ",unpack("C*",$val)) : \$val',
},
sBIT => {
Name => 'SignificantBits',
ValueConv => 'join(" ",unpack("C*",$val))',
},
sCAL => { # png 1.4.0
Name => 'SubjectScale',
SubDirectory => { TagTable => 'Image::ExifTool::PNG::SubjectScale' },
},
sPLT => {
Name => 'SuggestedPalette',
Binary => 1,
PrintConv => 'split("\0",$$val,1)', # extract palette name
},
sRGB => {
Name => 'SRGBRendering',
ValueConv => 'unpack("C",$val)',
PrintConv => {
0 => 'Perceptual',
1 => 'Relative Colorimetric',
2 => 'Saturation',
3 => 'Absolute Colorimetric',
},
},
sTER => { # png 1.4.0
Name => 'StereoImage',
SubDirectory => { TagTable => 'Image::ExifTool::PNG::StereoImage' },
},
tEXt => {
Name => 'TextualData',
SubDirectory => { TagTable => 'Image::ExifTool::PNG::TextualData' },
},
tIME => {
Name => 'ModifyDate',
Groups => { 2 => 'Time' },
Writable => 1,
Shift => 'Time',
ValueConv => 'sprintf("%.4d:%.2d:%.2d %.2d:%.2d:%.2d", unpack("nC5", $val))',
ValueConvInv => q{
my @a = ($val=~/^(\d+):(\d+):(\d+)\s+(\d+):(\d+):(\d+)/);
@a == 6 or warn('Invalid date'), return undef;
return pack('nC5', @a);
},
PrintConv => '$self->ConvertDateTime($val)',
PrintConvInv => '$self->InverseDateTime($val)',
},
tRNS => {
Name => 'Transparency',
ValueConv => q{
return \$val if length($val) > 6;
join(" ",unpack($Image::ExifTool::PNG::colorType == 3 ? "C*" : "n*", $val));
},
},
tXMP => {
Name => 'XMP',
Notes => 'obsolete location specified by a September 2001 XMP draft',
NonStandard => 1,
SubDirectory => { TagTable => 'Image::ExifTool::XMP::Main' },
},
vpAg => { # private imagemagick chunk
Name => 'VirtualPage',
SubDirectory => { TagTable => 'Image::ExifTool::PNG::VirtualPage' },
},
zTXt => {
Name => 'CompressedText',
SubDirectory => {
TagTable => 'Image::ExifTool::PNG::TextualData',
ProcessProc => \&ProcessPNG_Compressed,
},
},
# animated PNG (ref https://wiki.mozilla.org/APNG_Specification)
acTL => {
Name => 'AnimationControl',
SubDirectory => {
TagTable => 'Image::ExifTool::PNG::AnimationControl',
},
},
# eXIf
$stdCase{exif} => {
Name => $stdCase{exif},
Notes => 'this is where ExifTool will create new EXIF',
SubDirectory => {
TagTable => 'Image::ExifTool::Exif::Main',
DirName => 'EXIF', # (to write as a block)
ProcessProc => \&ProcessPNG_eXIf,
},
},
# zXIf
$stdCase{zxif} => {
Name => $stdCase{zxif},
Notes => 'a once-proposed chunk for compressed EXIF',
SubDirectory => {
TagTable => 'Image::ExifTool::Exif::Main',
DirName => 'EXIF', # (to write as a block)
ProcessProc => \&ProcessPNG_eXIf,
},
},
# fcTL - animation frame control for each frame
# fdAT - animation data for each frame
);
# PNG IHDR chunk
%Image::ExifTool::PNG::ImageHeader = (
PROCESS_PROC => \&Image::ExifTool::ProcessBinaryData,
GROUPS => { 2 => 'Image' },
0 => {
Name => 'ImageWidth',
Format => 'int32u',
},
4 => {
Name => 'ImageHeight',
Format => 'int32u',
},
8 => 'BitDepth',
9 => {
Name => 'ColorType',
RawConv => '$Image::ExifTool::PNG::colorType = $val',
PrintConv => {
0 => 'Grayscale',
2 => 'RGB',
3 => 'Palette',
4 => 'Grayscale with Alpha',
6 => 'RGB with Alpha',
},
},
10 => {
Name => 'Compression',
PrintConv => { 0 => 'Deflate/Inflate' },
},
11 => {
Name => 'Filter',
PrintConv => { 0 => 'Adaptive' },
},
12 => {
Name => 'Interlace',
PrintConv => { 0 => 'Noninterlaced', 1 => 'Adam7 Interlace' },
},
);
# PNG cHRM chunk
%Image::ExifTool::PNG::PrimaryChromaticities = (
PROCESS_PROC => \&Image::ExifTool::ProcessBinaryData,
GROUPS => { 2 => 'Image' },
FORMAT => 'int32u',
0 => { Name => 'WhitePointX', ValueConv => '$val / 100000' },
1 => { Name => 'WhitePointY', ValueConv => '$val / 100000' },
2 => { Name => 'RedX', ValueConv => '$val / 100000' },
3 => { Name => 'RedY', ValueConv => '$val / 100000' },
4 => { Name => 'GreenX', ValueConv => '$val / 100000' },
5 => { Name => 'GreenY', ValueConv => '$val / 100000' },
6 => { Name => 'BlueX', ValueConv => '$val / 100000' },
7 => { Name => 'BlueY', ValueConv => '$val / 100000' },
);
# PNG pHYs chunk
%Image::ExifTool::PNG::PhysicalPixel = (
PROCESS_PROC => \&Image::ExifTool::ProcessBinaryData,
WRITE_PROC => \&Image::ExifTool::WriteBinaryData,
WRITABLE => 1,
GROUPS => { 1 => 'PNG-pHYs', 2 => 'Image' },
WRITE_GROUP => 'PNG-pHYs',
NOTES => q{
These tags are found in the PNG pHYs chunk and belong to the PNG-pHYs family
1 group. They are all created together with default values if necessary
when any of these tags is written, and may only be deleted as a group.
},
0 => {
Name => 'PixelsPerUnitX',
Format => 'int32u',
},
4 => {
Name => 'PixelsPerUnitY',
Format => 'int32u',
},
8 => {
Name => 'PixelUnits',
PrintConv => { 0 => 'Unknown', 1 => 'meters' },
},
);
# PNG sCAL chunk
%Image::ExifTool::PNG::SubjectScale = (
PROCESS_PROC => \&Image::ExifTool::ProcessBinaryData,
GROUPS => { 2 => 'Image' },
0 => {
Name => 'SubjectUnits',
PrintConv => { 1 => 'meters', 2 => 'radians' },
},
1 => {
Name => 'SubjectPixelWidth',
Format => 'var_string',
},
2 => {
Name => 'SubjectPixelHeight',
Format => 'var_string',
},
);
# PNG vpAg chunk
%Image::ExifTool::PNG::VirtualPage = (
PROCESS_PROC => \&Image::ExifTool::ProcessBinaryData,
GROUPS => { 2 => 'Image' },
FORMAT => 'int32u',
0 => 'VirtualImageWidth',
1 => 'VirtualImageHeight',
2 => {
Name => 'VirtualPageUnits',
Format => 'int8u',
# what is the conversion for this?
},
);
# PNG sTER chunk
%Image::ExifTool::PNG::StereoImage = (
PROCESS_PROC => \&Image::ExifTool::ProcessBinaryData,
GROUPS => { 2 => 'Image' },
0 => {
Name => 'StereoMode',
PrintConv => {
0 => 'Cross-fuse Layout',
1 => 'Diverging-fuse Layout',
},
},
);
my %unreg = ( Notes => 'unregistered' );
# Tags for PNG tEXt zTXt and iTXt chunks
# (NOTE: ValueConv is set dynamically, so don't set it here!)
%Image::ExifTool::PNG::TextualData = (
PROCESS_PROC => \&ProcessPNG_tEXt,
WRITE_PROC => \&Image::ExifTool::DummyWriteProc,
WRITABLE => 'string',
PREFERRED => 1, # always add these tags when writing
GROUPS => { 2 => 'Image' },
LANG_INFO => \&GetLangInfo,
NOTES => q{
The PNG TextualData format allows arbitrary tag names to be used. The tags
listed below are the only ones that can be written (unless new user-defined
tags are added via the configuration file), however ExifTool will extract
any other TextualData tags that are found. All TextualData tags (including
tags not listed below) are removed when deleting all PNG tags.
These tags may be stored as tEXt, zTXt or iTXt chunks in the PNG image. By
default ExifTool writes new string-value tags as as uncompressed tEXt, or
compressed zTXt if the Compress (-z) option is used and Compress::Zlib is
available. Alternate language tags and values containing special characters
(unless the Latin character set is used) are written as iTXt, and compressed
if the Compress option is used and Compress::Zlib is available. Raw profile
information is always created as compressed zTXt if Compress::Zlib is
available, or tEXt otherwise. Standard XMP is written as uncompressed iTXt.
Alternate languages are accessed by suffixing the tag name with a '-',
followed by an RFC 3066 language code (eg. "PNG:Comment-fr", or
"Title-en-US"). See L<http://www.ietf.org/rfc/rfc3066.txt> for the RFC 3066
specification.
Some of the tags below are not registered as part of the PNG specification,
but are included here because they are generated by other software such as
ImageMagick.
},
Title => { },
Author => { Groups => { 2 => 'Author' } },
Description => { },
Copyright => { Groups => { 2 => 'Author' } },
'Creation Time' => {
Name => 'CreationTime',
Groups => { 2 => 'Time' },
Shift => 'Time',
Notes => 'stored in RFC-1123 format and converted to/from EXIF format by ExifTool',
ValueConv => \&ConvertPNGDate,
ValueConvInv => \&InversePNGDate,
PrintConv => '$self->ConvertDateTime($val)',
PrintConvInv => '$self->InverseDateTime($val,undef,1)',
},
Software => { },
Disclaimer => { },
# change name to differentiate from ExifTool Warning
Warning => { Name => 'PNGWarning', },
Source => { },
Comment => { },
Collection => { }, # (PNG extensions, 2004)
#
# The following tags are not part of the original PNG specification,
# but are written by ImageMagick and other software
#
Artist => { %unreg, Groups => { 2 => 'Author' } },
Document => { %unreg },
Label => { %unreg },
Make => { %unreg, Groups => { 2 => 'Camera' } },
Model => { %unreg, Groups => { 2 => 'Camera' } },
'create-date'=> {
Name => 'CreateDate',
Groups => { 2 => 'Time' },
Shift => 'Time',
%unreg,
ValueConv => 'require Image::ExifTool::XMP; Image::ExifTool::XMP::ConvertXMPDate($val)',
ValueConvInv => 'require Image::ExifTool::XMP; Image::ExifTool::XMP::FormatXMPDate($val)',
PrintConv => '$self->ConvertDateTime($val)',
PrintConvInv => '$self->InverseDateTime($val,undef,1)',
},
'modify-date'=> {
Name => 'ModDate', # (to distinguish from tIME chunk "ModifyDate")
Groups => { 2 => 'Time' },
Shift => 'Time',
%unreg,
ValueConv => 'require Image::ExifTool::XMP; Image::ExifTool::XMP::ConvertXMPDate($val)',
ValueConvInv => 'require Image::ExifTool::XMP; Image::ExifTool::XMP::FormatXMPDate($val)',
PrintConv => '$self->ConvertDateTime($val)',
PrintConvInv => '$self->InverseDateTime($val,undef,1)',
},
TimeStamp => { %unreg, Groups => { 2 => 'Time' }, Shift => 'Time' },
URL => { %unreg },
'XML:com.adobe.xmp' => {
Name => 'XMP',
Notes => q{
unregistered, but this is the location according to the June 2002 or later
XMP specification, and is where ExifTool will add a new XMP chunk if the
image didn't already contain XMP
},
SubDirectory => {
TagTable => 'Image::ExifTool::XMP::Main',
},
},
'Raw profile type APP1' => [
{
# EXIF table must come first because we key on this in ProcessProfile()
# (No condition because this is just for BuildTagLookup)
Name => 'APP1_Profile',
%unreg,
NonStandard => 1,
SubDirectory => {
TagTable => 'Image::ExifTool::Exif::Main',
ProcessProc => \&ProcessProfile,
},
},
{
Name => 'APP1_Profile',
NonStandard => 1,
SubDirectory => {
TagTable => 'Image::ExifTool::XMP::Main',
ProcessProc => \&ProcessProfile,
},
},
],
'Raw profile type exif' => {
Name => 'EXIF_Profile',
%unreg,
NonStandard => 1,
SubDirectory => {
TagTable => 'Image::ExifTool::Exif::Main',
ProcessProc => \&ProcessProfile,
},
},
'Raw profile type icc' => {
Name => 'ICC_Profile',
%unreg,
SubDirectory => {
TagTable => 'Image::ExifTool::ICC_Profile::Main',
ProcessProc => \&ProcessProfile,
},
},
'Raw profile type icm' => {
Name => 'ICC_Profile',
%unreg,
SubDirectory => {
TagTable => 'Image::ExifTool::ICC_Profile::Main',
ProcessProc => \&ProcessProfile,
},
},
'Raw profile type iptc' => {
Name => 'IPTC_Profile',
Notes => q{
unregistered. May be either IPTC IIM or Photoshop IRB format. This is
where ExifTool will add new IPTC, inside a Photoshop IRB container
},
SubDirectory => {
TagTable => 'Image::ExifTool::Photoshop::Main',
ProcessProc => \&ProcessProfile,
},
},
'Raw profile type xmp' => {
Name => 'XMP_Profile',
%unreg,
NonStandard => 1,
SubDirectory => {
TagTable => 'Image::ExifTool::XMP::Main',
ProcessProc => \&ProcessProfile,
},
},
'Raw profile type 8bim' => {
Name => 'Photoshop_Profile',
%unreg,
SubDirectory => {
TagTable => 'Image::ExifTool::Photoshop::Main',
ProcessProc => \&ProcessProfile,
},
},
);
# Animation control
%Image::ExifTool::PNG::AnimationControl = (
PROCESS_PROC => \&Image::ExifTool::ProcessBinaryData,
GROUPS => { 2 => 'Image' },
FORMAT => 'int32u',
NOTES => q{
Tags found in the Animation Conrol chunk. See
L<https://wiki.mozilla.org/APNG_Specification> for details.
},
0 => {
Name => 'AnimationFrames',
RawConv => '$self->OverrideFileType("APNG", undef, "PNG"); $val',
},
1 => {
Name => 'AnimationPlays',
PrintConv => '$val || "inf"',
},
);
#------------------------------------------------------------------------------
# AutoLoad our writer routines when necessary
#
sub AUTOLOAD
{
return Image::ExifTool::DoAutoLoad($AUTOLOAD, @_);
}
#------------------------------------------------------------------------------
# Get standard case for language code (this routine copied from XMP.pm)
# Inputs: 0) Language code
# Returns: Language code in standard case
sub StandardLangCase($)
{
my $lang = shift;
# make 2nd subtag uppercase only if it is 2 letters
return lc($1) . uc($2) . lc($3) if $lang =~ /^([a-z]{2,3}|[xi])(-[a-z]{2})\b(.*)/i;
return lc($lang);
}
#------------------------------------------------------------------------------
# Convert date from PNG to EXIF format
# Inputs: 0) Date/time in PNG format, 1) ExifTool ref
# Returns: EXIF formatted date/time string
my %monthNum = (
Jan=>1, Feb=>2, Mar=>3, Apr=>4, May=>5, Jun=>6,
Jul=>7, Aug=>8, Sep=>9, Oct=>10,Nov=>11,Dec=>12
);
my %tzConv = (
UT => '+00:00', GMT => '+00:00', UTC => '+00:00', # (UTC not in spec -- PH addition)
EST => '-05:00', EDT => '-04:00',
CST => '-06:00', CDT => '-05:00',
MST => '-07:00', MDT => '-06:00',
PST => '-08:00', PDT => '-07:00',
A => '-01:00', N => '+01:00',
B => '-02:00', O => '+02:00',
C => '-03:00', P => '+03:00',
D => '-04:00', Q => '+04:00',
E => '-05:00', R => '+05:00',
F => '-06:00', S => '+06:00',
G => '-07:00', T => '+07:00',
H => '-08:00', U => '+08:00',
I => '-09:00', V => '+09:00',
K => '-10:00', W => '+10:00',
L => '-11:00', X => '+11:00',
M => '-12:00', Y => '+12:00',
Z => '+00:00',
);
sub ConvertPNGDate($$)
{
my $val = shift;
# standard format is like "Mon, 1 Jan 2018 12:10:22 EST"
if ($val =~ /(\d+)\s*(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s*(\d+)\s+(\d+):(\d{2})(:\d{2})?\s*(\S*)/i) {
my ($day,$mon,$yr,$hr,$min,$sec,$tz) = ($1,$2,$3,$4,$5,$6,$7);
$yr += $yr > 70 ? 1900 : 2000 if $yr < 100; # boost year to 4 digits if necessary
$mon = $monthNum{ucfirst lc $mon} or return $val;
if (not $tz) {
$tz = '';
} elsif ($tzConv{$tz}) {
$tz = $tzConv{$tz};
} elsif ($tz =~ /^([-+]\d+):?(\d{2})/) {
$tz = $1 . ':' . $2;
} else {
return $val; # (non-standard date)
}
$val = sprintf("%.4d:%.2d:%.2d %.2d:%.2d%s%s",$yr,$mon,$day,$hr,$min,$sec||':00',$tz);
}
return $val;
}
#------------------------------------------------------------------------------
# Convert EXIF date/time to PNG format
# Inputs: 0) Date/time in EXIF format, 1) ExifTool ref
# Returns: PNG formatted date/time string
sub InversePNGDate($$)
{
my ($val, $et) = @_;
my $err;
if ($val =~ /^(\d{4}):(\d{2}):(\d{2}) (\d{2})(:\d{2})(:\d{2})?(?:\.\d*)?\s*(\S*)/) {
my ($yr,$mon,$day,$hr,$min,$sec,$tz) = ($1,$2,$3,$4,$5,$6,$7);
$sec or $sec = '';
my %monName = map { $monthNum{$_} => $_ } keys %monthNum;
$mon = $monName{$mon + 0} or $err = 1;
$tz =~ /^(Z|[-+]\d{2}:?\d{2})/ or $err = 1 if length $tz;
$tz =~ tr/://d;
$val = "$day $mon $yr $hr$min$sec $tz" unless $err;
}
if ($err and $et->Options('StrictDate')) {
warn "Invalid date/time (use YYYY:mm:dd HH:MM:SS[.ss][+/-HH:MM|Z])\n";
undef $val;
}
return $val;
}
#------------------------------------------------------------------------------
# Get localized version of tagInfo hash
# Inputs: 0) tagInfo hash ref, 1) language code (eg. "x-default")
# Returns: new tagInfo hash ref, or undef if invalid
sub GetLangInfo($$)
{
my ($tagInfo, $lang) = @_;
$lang =~ tr/_/-/; # RFC 3066 specifies '-' as a separator
# no alternate languages for XMP or raw profile directories
return undef if $$tagInfo{SubDirectory};
# language code must normalized for use in tag ID
return Image::ExifTool::GetLangInfo($tagInfo, StandardLangCase($lang));
}
#------------------------------------------------------------------------------
# Found a PNG tag -- extract info from subdirectory or decompress data if necessary
# Inputs: 0) ExifTool object reference, 1) Pointer to tag table,
# 2) Tag ID, 3) Tag value, 4) [optional] compressed data flag:
# 0=not compressed, 1=unknown compression, 2-N=compression with type N-2
# 5) optional output buffer ref, 6) character encoding (tEXt/zTXt/iTXt only)
# 6) optional language code
# Returns: 1 on success
sub FoundPNG($$$$;$$$$)
{
my ($et, $tagTablePtr, $tag, $val, $compressed, $outBuff, $enc, $lang) = @_;
return 0 unless defined $val;
my $verbose = $et->Options('Verbose');
my $id = $tag; # generate tag ID which include language code
if ($lang) {
# case of language code must be normalized since they are case insensitive
$lang = StandardLangCase($lang);
$id .= '-' . $lang;
}
my $tagInfo = $et->GetTagInfo($tagTablePtr, $id) ||
# (some software forgets to capitalize first letter)
$et->GetTagInfo($tagTablePtr, ucfirst($id));
# create alternate language tag if necessary
if (not $tagInfo and $lang) {
$tagInfo = $et->GetTagInfo($tagTablePtr, $tag) ||
$et->GetTagInfo($tagTablePtr, ucfirst($tag));
$tagInfo = GetLangInfo($tagInfo, $lang) if $tagInfo;
}
#
# uncompress data if necessary
#
my ($wasCompressed, $deflateErr);
if ($compressed and $compressed > 1) {
if ($compressed == 2) { # Inflate/Deflate compression
if (eval { require Compress::Zlib }) {
my ($v2, $stat);
my $inflate = Compress::Zlib::inflateInit();
$inflate and ($v2, $stat) = $inflate->inflate($val);
if ($inflate and $stat == Compress::Zlib::Z_STREAM_END()) {
$val = $v2;
$compressed = 0;
$wasCompressed = 1;
} else {
$deflateErr = "Error inflating $tag";
}
} elsif (not $noCompressLib) {
$deflateErr = "Install Compress::Zlib to read compressed information";
} else {
$deflateErr = ''; # flag deflate error but no warning
}
} else {
$compressed -= 2;
$deflateErr = "Unknown compression method $compressed for $tag";
}
if ($compressed and $verbose and $tagInfo and $$tagInfo{SubDirectory}) {
$et->VerboseDir("Unable to decompress $$tagInfo{Name}", 0, length($val));
}
# issue warning if relevant
if ($deflateErr and not $outBuff) {
$et->Warn($deflateErr);
$noCompressLib = 1 if $deflateErr =~ /^Install/;
}
}
# translate character encoding if necessary (tEXt/zTXt/iTXt string values only)
if ($enc and not $compressed and not ($tagInfo and $$tagInfo{SubDirectory})) {
$val = $et->Decode($val, $enc);
}
#
# extract information from subdirectory if available
#
if ($tagInfo) {
my $tagName = $$tagInfo{Name};
my $processed;
if ($$tagInfo{SubDirectory}) {
my $subdir = $$tagInfo{SubDirectory};
my $dirName = $$subdir{DirName} || $tagName;
if (not $compressed) {
my $len = length $val;
if ($verbose and $$et{INDENT} ne ' ') {
if ($wasCompressed and $verbose > 2) {
my $name = $tagName;
$wasCompressed and $name = "Decompressed $name";
$et->VerboseDir($name, 0, $len);
$et->VerboseDump(\$val);
}
# don't indent next directory (since it is really the same data)
$$et{INDENT} =~ s/..$//;
}
my $processProc = $$subdir{ProcessProc};
# nothing more to do if writing and subdirectory is not writable
my $subTable = GetTagTable($$subdir{TagTable});
return 1 if $outBuff and not $$subTable{WRITE_PROC};
my $dirName = $$subdir{DirName} || $tagName;
my %subdirInfo = (
DataPt => \$val,
DirStart => 0,
DataLen => $len,
DirLen => $len,
DirName => $dirName,
TagInfo => $tagInfo,
ReadOnly => 1, # (used only by WriteXMP)
OutBuff => $outBuff,
);
# no need to re-decompress if already done
undef $processProc if $wasCompressed and $processProc and $processProc eq \&ProcessPNG_Compressed;
# rewrite this directory if necessary (but always process TextualData normally)
if ($outBuff and not $processProc and $subTable ne \%Image::ExifTool::PNG::TextualData) {
return 1 unless $$et{EDIT_DIRS}{$dirName};
$$outBuff = $et->WriteDirectory(\%subdirInfo, $subTable);
if ($tagName eq 'XMP' and $$outBuff) {
if ($$et{FoundIDAT} and $$et{DEL_GROUP}{XMP}) {
$et->VPrint(0,' Deleting XMP');
$$outBuff = '';
} else {
# make sure the XMP is marked as read-only
Image::ExifTool::XMP::ValidateXMP($outBuff,'r');
}
}
DoneDir($et, $dirName, $outBuff, $$tagInfo{NonStandard});
} else {
# issue warning for standard XMP after IDAT (PNGEarlyXMP option)
if ($tagName eq 'XMP' and not $$tagInfo{NonStandard} and
$$et{FoundIDAT} and $$et{FoundIDAT} == 2)
{
$et->Warn('XMP found after PNG IDAT');
$$et{FoundIDAT} = 1;
}
$processed = $et->ProcessDirectory(\%subdirInfo, $subTable, $processProc);
}
$compressed = 1; # pretend this is compressed since it is binary data
} elsif ($outBuff) {
if ($$et{DEL_GROUP}{$dirName} or ($dirName eq 'EXIF' and $$et{DEL_GROUP}{IFD0})) {
$$outBuff = '';
++$$et{CHANGED};
$et->VPrint(0, " Deleting $tag chunk");
} else {
if ($$et{EDIT_DIRS}{$dirName} or ($dirName eq 'EXIF' and $$et{EDIT_DIRS}{IFD0})) {
$et->Warn("Can't write $dirName. Requires Compress::Zlib");
}
# pretend we did this directory so we don't try to recreate it
DoneDir($et, $dirName, $outBuff, $$tagInfo{NonStandard});
}
}
}
if ($outBuff) {
my $writable = $$tagInfo{Writable};
my $isOverwriting;
if ($writable or ($$tagTablePtr{WRITABLE} and
not defined $writable and not $$tagInfo{SubDirectory}))
{
# write new value for this tag if necessary
my $newVal;
if ($$et{DEL_GROUP}{PNG} or $$et{PNGDoneTag}{$tag} or
$$et{PNGDoneTag}{ucfirst $tag})
{
# remove this tag now, but keep in ADD_PNG list to add back later
$isOverwriting = 1;
} else {
# remove this from the list of PNG tags to add
delete $$et{ADD_PNG}{$id};
# (also handle case of tEXt tags written with lowercase first letter)
delete $$et{ADD_PNG}{ucfirst($id)};
my $nvHash = $et->GetNewValueHash($tagInfo);
$isOverwriting = $et->IsOverwriting($nvHash);
if (defined $deflateErr) {
$newVal = $et->GetNewValue($nvHash);
# can only write tag now if always overwriting
if ($isOverwriting > 0) {
$val = '<deflate error>';
} elsif ($isOverwriting) {
$isOverwriting = 0; # can't overwrite
$et->Warn($deflateErr) if $deflateErr;
}
} else {
if ($isOverwriting < 0) {
$isOverwriting = $et->IsOverwriting($nvHash, $val);
}
# (must get new value after IsOverwriting() in case it was shifted)
$newVal = $et->GetNewValue($nvHash);
}
}
if ($isOverwriting) {
$$outBuff = (defined $newVal) ? $newVal : '';
++$$et{CHANGED};
$et->VerboseValue("- PNG:$tagName", $val);
$et->VerboseValue("+ PNG:$tagName", $newVal) if defined $newVal;
}
}
if (defined $$outBuff and length $$outBuff) {
if ($enc) { # must be tEXt/zTXt/iTXt if $enc is set
$$outBuff = BuildTextChunk($et, $tag, $tagInfo, $$outBuff, $lang);
} elsif ($wasCompressed) {
# re-compress the output data
my $len = length $$outBuff;
my $deflate = Compress::Zlib::deflateInit();
if ($deflate) {
$$outBuff = $deflate->deflate($$outBuff);
$$outBuff .= $deflate->flush() if defined $$outBuff;
} else {
undef $$outBuff;
}
if (not $$outBuff) {
$et->Warn("PNG:$tagName not written (compress error)");
} elsif (lc $tag eq 'zxif') {
$$outBuff = "\0" . pack('N',$len) . $$outBuff; # add zXIf header
}
}
}
return 1;
}
return 1 if $processed;
} elsif ($outBuff) {
if ($$et{DEL_GROUP}{PNG} and $tagTablePtr eq \%Image::ExifTool::PNG::TextualData) {
# delete all TextualData tags if deleting the PNG group
$$outBuff = '';
++$$et{CHANGED};
$et->VerboseValue("- PNG:$tag", $val);
}
return 1;
} else {
my $name;
($name = $tag) =~ s/\s+(.)/\u$1/g; # remove white space from tag name
$tagInfo = { Name => $name };
$$tagInfo{LangCode} = $lang if $lang;
# make unknown profiles binary data type
$$tagInfo{Binary} = 1 if $tag =~ /^Raw profile type /;
$verbose and $et->VPrint(0, " | [adding $tag]\n");
AddTagToTable($tagTablePtr, $tag, $tagInfo);
}
#
# store this tag information
#
if ($verbose) {
# temporarily remove subdirectory so it isn't printed in verbose information
# since we aren't decoding it anyway;
my $subdir = $$tagInfo{SubDirectory};
delete $$tagInfo{SubDirectory};
$et->VerboseInfo($tag, $tagInfo,
Table => $tagTablePtr,
DataPt => \$val,
);
$$tagInfo{SubDirectory} = $subdir if $subdir;
}
# set the RawConv dynamically depending on whether this is binary or not
my $delRawConv;
if ($compressed and not defined $$tagInfo{ValueConv}) {
$$tagInfo{RawConv} = '\$val';
$delRawConv = 1;
}
$et->FoundTag($tagInfo, $val);
delete $$tagInfo{RawConv} if $delRawConv;
return 1;
}
#------------------------------------------------------------------------------
# Process encoded PNG profile information
# Inputs: 0) ExifTool object reference, 1) DirInfo reference, 2) Pointer to tag table
# Returns: 1 on success
sub ProcessProfile($$$)
{
my ($et, $dirInfo, $tagTablePtr) = @_;
my $dataPt = $$dirInfo{DataPt};
my $tagInfo = $$dirInfo{TagInfo};
my $outBuff = $$dirInfo{OutBuff};
my $tagName = $$tagInfo{Name};
# ImageMagick 5.3.6 writes profiles with the following headers:
# "\nICC Profile\n", "\nIPTC profile\n", "\n\xaa\x01{generic prof\n"
# and "\ngeneric profile\n"
return 0 unless $$dataPt =~ /^\n(.*?)\n\s*(\d+)\n(.*)/s;
my ($profileType, $len) = ($1, $2);
# data is encoded in hex, so change back to binary
my $buff = pack('H*', join('',split(' ',$3)));
my $actualLen = length $buff;
if ($len ne $actualLen) {
$et->Warn("$tagName is wrong size (should be $len bytes but is $actualLen)");
$len = $actualLen;
}
my $verbose = $et->Options('Verbose');
if ($verbose) {
if ($verbose > 2) {
$et->VerboseDir("Decoded $tagName", 0, $len);
$et->VerboseDump(\$buff);
}
# don't indent next directory (since it is really the same data)
$$et{INDENT} =~ s/..$//;
}
my %dirInfo = (
Parent => 'PNG',
DataPt => \$buff,
DataLen => $len,
DirStart => 0,
DirLen => $len,
Base => 0,
OutFile => $outBuff,
);
$$et{PROCESSED} = { }; # reset processed directory offsets
my $processed = 0;
my $oldChanged = $$et{CHANGED};
my $exifTable = GetTagTable('Image::ExifTool::Exif::Main');
my $editDirs = $$et{EDIT_DIRS};
if ($tagTablePtr ne $exifTable) {
# this is unfortunate, but the "IPTC" profile may be stored as either
# IPTC IIM or a Photoshop IRB resource, so we must test for this
if ($tagName eq 'IPTC_Profile' and $buff =~ /^\x1c/) {
$tagTablePtr = GetTagTable('Image::ExifTool::IPTC::Main');
}
# process non-EXIF and non-APP1 profile as-is
if ($outBuff) {
# no need to rewrite this if not editing tags in this directory
my $dir = $tagName;
$dir =~ s/_Profile// unless $dir =~ /^ICC/;
return 1 unless $$editDirs{$dir};
$$outBuff = $et->WriteDirectory(\%dirInfo, $tagTablePtr);
DoneDir($et, $dir, $outBuff, $$tagInfo{NonStandard});
} else {
$processed = $et->ProcessDirectory(\%dirInfo, $tagTablePtr);
}
} elsif ($buff =~ /^$Image::ExifTool::exifAPP1hdr/) {
# APP1 EXIF information
return 1 if $outBuff and not $$editDirs{IFD0};
my $hdrLen = length($Image::ExifTool::exifAPP1hdr);
$dirInfo{DirStart} += $hdrLen;
$dirInfo{DirLen} -= $hdrLen;
if ($outBuff) {
# delete non-standard EXIF if recreating from scratch
if ($$et{DEL_GROUP}{EXIF} or $$et{DEL_GROUP}{IFD0}) {
$$outBuff = '';
$et->VPrint(0, ' Deleting non-standard APP1 EXIF information');
return 1;
}
$$outBuff = $et->WriteDirectory(\%dirInfo, $tagTablePtr,
\&Image::ExifTool::WriteTIFF);
$$outBuff = $Image::ExifTool::exifAPP1hdr . $$outBuff if $$outBuff;
DoneDir($et, 'IFD0', $outBuff);
} else {
$processed = $et->ProcessTIFF(\%dirInfo);
}
} elsif ($buff =~ /^$Image::ExifTool::xmpAPP1hdr/) {
# APP1 XMP information
my $hdrLen = length($Image::ExifTool::xmpAPP1hdr);
my $tagTablePtr = GetTagTable('Image::ExifTool::XMP::Main');
$dirInfo{DirStart} += $hdrLen;
$dirInfo{DirLen} -= $hdrLen;
if ($outBuff) {
return 1 unless $$editDirs{XMP};
$$outBuff = $et->WriteDirectory(\%dirInfo, $tagTablePtr);
$$outBuff and $$outBuff = $Image::ExifTool::xmpAPP1hdr . $$outBuff;
DoneDir($et, 'XMP', $outBuff, 1);
} else {
$processed = $et->ProcessDirectory(\%dirInfo, $tagTablePtr);
}
} elsif ($buff =~ /^(MM\0\x2a|II\x2a\0)/) {
# TIFF information
return 1 if $outBuff and not $$editDirs{IFD0};
if ($outBuff) {
# delete non-standard EXIF if recreating from scratch
if ($$et{DEL_GROUP}{EXIF} or $$et{DEL_GROUP}{IFD0}) {
$$outBuff = '';
$et->VPrint(0, ' Deleting non-standard EXIF/TIFF information');
return 1;
}
$$outBuff = $et->WriteDirectory(\%dirInfo, $tagTablePtr,
\&Image::ExifTool::WriteTIFF);
DoneDir($et, 'IFD0', $outBuff);
} else {
$processed = $et->ProcessTIFF(\%dirInfo);
}
} else {
my $profName = $profileType;
$profName =~ tr/\x00-\x1f\x7f-\xff/./;
$et->Warn("Unknown raw profile '${profName}'");
}
if ($outBuff and defined $$outBuff and length $$outBuff) {
if ($$et{CHANGED} != $oldChanged) {
my $hdr = sprintf("\n%s\n%8d\n", $profileType, length($$outBuff));
# hex encode the data
$$outBuff = $hdr . HexEncode($outBuff);
} else {
undef $$outBuff;
}
}
return $processed;
}
#------------------------------------------------------------------------------
# Process PNG compressed zTXt or iCCP chunk
# Inputs: 0) ExifTool object reference, 1) DirInfo reference, 2) Pointer to tag table
# Returns: 1 on success
# Notes: writes new chunk data to ${$$dirInfo{OutBuff}} if writing tag
sub ProcessPNG_Compressed($$$)
{
my ($et, $dirInfo, $tagTablePtr) = @_;
my ($tag, $val) = split /\0/, ${$$dirInfo{DataPt}}, 2;
return 0 unless defined $val;
# set compressed to 2 + compression method to decompress the data
my $compressed = 2 + unpack('C', $val);
my $hdr = $tag . "\0" . substr($val, 0, 1);
$val = substr($val, 1); # remove compression method byte
my $success;
my $outBuff = $$dirInfo{OutBuff};
my $tagInfo = $$dirInfo{TagInfo};
# use the PNG chunk tag instead of the embedded tag name for iCCP chunks
if ($tagInfo and $$tagInfo{Name} eq 'ICC_Profile') {
$et->VerboseDir('iCCP');
$tagTablePtr = \%Image::ExifTool::PNG::Main;
if (length($tag) and not $outBuff) {
FoundPNG($et, $tagTablePtr, 'iCCP-name', $tag);
}
$success = FoundPNG($et, $tagTablePtr, 'iCCP', $val, $compressed, $outBuff);
$$outBuff = $hdr . $$outBuff if $outBuff and $$outBuff;
} else {
$success = FoundPNG($et, $tagTablePtr, $tag, $val, $compressed, $outBuff, 'Latin');
}
return $success;
}
#------------------------------------------------------------------------------
# Process PNG tEXt chunk
# Inputs: 0) ExifTool object reference, 1) DirInfo reference, 2) Pointer to tag table
# Returns: 1 on success
# Notes: writes new chunk data to ${$$dirInfo{OutBuff}} if writing tag
sub ProcessPNG_tEXt($$$)
{
my ($et, $dirInfo, $tagTablePtr) = @_;
my ($tag, $val) = split /\0/, ${$$dirInfo{DataPt}}, 2;
my $outBuff = $$dirInfo{OutBuff};
return FoundPNG($et, $tagTablePtr, $tag, $val, undef, $outBuff, 'Latin');
}
#------------------------------------------------------------------------------
# Process PNG iTXt chunk
# Inputs: 0) ExifTool object reference, 1) DirInfo reference, 2) Pointer to tag table
# Returns: 1 on success
# Notes: writes new chunk data to ${$$dirInfo{OutBuff}} if writing tag
sub ProcessPNG_iTXt($$$)
{
my ($et, $dirInfo, $tagTablePtr) = @_;
my ($tag, $dat) = split /\0/, ${$$dirInfo{DataPt}}, 2;
return 0 unless defined $dat and length($dat) >= 4;
my ($compressed, $meth) = unpack('CC', $dat);
my ($lang, $trans, $val) = split /\0/, substr($dat, 2), 3;
# set compressed flag so we will decompress it in FoundPNG()
$compressed and $compressed = 2 + $meth;
my $outBuff = $$dirInfo{OutBuff};
return FoundPNG($et, $tagTablePtr, $tag, $val, $compressed, $outBuff, 'UTF8', $lang);
}
#------------------------------------------------------------------------------
# Process PNG eXIf/zXIf chunk
# Inputs: 0) ExifTool object reference, 1) DirInfo reference, 2) Pointer to tag table
# Returns: 1 on success
# Notes: writes new chunk data to ${$$dirInfo{OutBuff}} if writing tag
sub ProcessPNG_eXIf($$$)
{
my ($et, $dirInfo, $tagTablePtr) = @_;
my $outBuff = $$dirInfo{OutBuff};
my $dataPt = $$dirInfo{DataPt};
my $tagInfo = $$dirInfo{TagInfo};
my $tag = $$tagInfo{TagID};
my $del = $outBuff && ($$et{DEL_GROUP}{EXIF} or $$et{DEL_GROUP}{IFD0});
my $type;
if ($$dataPt =~ /^Exif\0\0/) {
$et->Warn('Improper "Exif00" header in EXIF chunk');
$$dataPt = substr($$dataPt, 6);
$$dirInfo{DataLen} = length $$dataPt;
$$dirInfo{DirLen} -= 6 if $$dirInfo{DirLen};
}
if ($$dataPt =~ /^(\0|II|MM)/) {
$type = $1;
} elsif ($del) {
$et->VPrint(0, " Deleting invalid $tag chunk");
$$outBuff = '';
++$$et{CHANGED};
return 1;
} else {
$et->Warn("Invalid $tag chunk");
return 0;
}
if ($type eq "\0") { # is this compressed EXIF?
my $buf = substr($$dataPt, 5);
# go around again to uncompress the data
$tagTablePtr = GetTagTable('Image::ExifTool::PNG::Main');
return FoundPNG($et, $tagTablePtr, $$tagInfo{TagID}, \$buf, 2, $outBuff);
} elsif (not $outBuff) {
return $et->ProcessTIFF($dirInfo);
# (zxIf was not adopted)
#} elsif ($del and ($et->Options('Compress') xor lc($tag) eq 'zxif')) {
} elsif ($del and lc($tag) eq 'zxif') {
$et->VPrint(0, " Deleting $tag chunk");
$$outBuff = '';
++$$et{CHANGED};
} elsif ($$et{EDIT_DIRS}{IFD0}) {
$$outBuff = $et->WriteDirectory($dirInfo, $tagTablePtr,
\&Image::ExifTool::WriteTIFF);
DoneDir($et, 'IFD0', $outBuff, $$tagInfo{NonStandard});
}
return 1;
}
#------------------------------------------------------------------------------
# Extract meta information from a PNG image
# Inputs: 0) ExifTool object reference, 1) dirInfo reference
# Returns: 1 on success, 0 if this wasn't a valid PNG image, or -1 on write error
sub ProcessPNG($$)
{
my ($et, $dirInfo) = @_;
my $outfile = $$dirInfo{OutFile};
my $raf = $$dirInfo{RAF};
my $datChunk = '';
my $datCount = 0;
my $datBytes = 0;
my ($sig, $err);
# check to be sure this is a valid PNG/MNG/JNG image
return 0 unless $raf->Read($sig,8) == 8 and $pngLookup{$sig};
my $earlyXMP = $et->Options('PNGEarlyXMP');
if ($outfile) {
delete $$et{TextChunkType};
Write($outfile, $sig) or $err = 1 if $outfile;
# can only add tags in Main and TextualData tables
$$et{ADD_PNG} = $et->GetNewTagInfoHash(
\%Image::ExifTool::PNG::Main,
\%Image::ExifTool::PNG::TextualData);
# NOTE: PNGDoneTag and PNGDoneDir are used to keep track of metadata added
# before the PNG IEND chunk is encountered. Currently this is implemented
# only for XMP (written before IDAT with the PNGEarlyXMP option), but
# may be implemented in the future for other types - PH
$$et{PNGDoneTag} = { };
$$et{PNGDoneDir} = { };
# initialize with same directories, with PNG tags taking priority
$et->InitWriteDirs(\%pngMap,'PNG');
# write XMP before IDAT if we would delete it later anyway
$earlyXMP = 1 if $$et{DEL_GROUP}{XMP};
}
my ($fileType, $hdrChunk, $endChunk) = @{$pngLookup{$sig}};
$et->SetFileType($fileType); # set the FileType tag
SetByteOrder('MM'); # PNG files are big-endian
my $tagTablePtr = GetTagTable('Image::ExifTool::PNG::Main');
my $mngTablePtr;
if ($fileType ne 'PNG') {
$mngTablePtr = GetTagTable('Image::ExifTool::MNG::Main');
}
my $verbose = $et->Options('Verbose');
my $out = $et->Options('TextOut');
my ($hbuf, $dbuf, $cbuf, $wasHdr, $wasEnd);
# process the PNG/MNG/JNG chunks
undef $noCompressLib;
for (;;) {
my $n = $raf->Read($hbuf,8);
if ($wasEnd) {
last unless $n; # stop now if normal end of PNG
$et->WarnOnce("Trailer data after $fileType $endChunk chunk", 1);
last if $n < 8;
$$et{SET_GROUP1} = 'Trailer';
} elsif ($n != 8) {
$et->Warn("Truncated $fileType image") unless $wasEnd;
last;
}
my ($len, $chunk) = unpack('Na4',$hbuf);
if ($len > 0x7fffffff) {
$et->Warn("Invalid $fileType chunk size") unless $wasEnd;
last;
}
if ($verbose) {
# don't dump image data chunks in verbose mode (only give count instead)
if ($datCount and $chunk ne $datChunk) {
my $s = $datCount > 1 ? 's' : '';
print $out "$fileType $datChunk ($datCount chunk$s, total $datBytes bytes)\n";
$datCount = $datBytes = 0;
$datChunk = '';
}
if ($chunk =~ /^(IDAT|JDAT|JDAA)$/) {
$datChunk = $chunk;
$datCount++;
$datBytes += $len;
}
}
if ($outfile) {
if ($chunk eq $endChunk) {
# add any new chunks immediately before the IEND/MEND chunk
AddChunks($et, $outfile) or $err = 1;
} elsif ($chunk eq 'PLTE' or $chunk eq 'IDAT') {
if ($chunk eq 'IDAT') {
# add XMP before IDAT if specified
AddChunks($et, $outfile, 'XMP') or $err = 1 if $earlyXMP;
# pHYs comes before IDAT
AddChunks($et, $outfile, 'PNG-pHYs') or $err = 1;
}
# iCCP chunk must come before PLTE and IDAT
# (ignore errors -- will add later as text profile if this fails)
Add_iCCP($et, $outfile);
}
}
if ($chunk eq $endChunk) {
# read CRC
unless ($raf->Read($cbuf,4) == 4) {
$et->Warn("Truncated $fileType $endChunk chunk") unless $wasEnd;
last;
}
$verbose and print $out "$fileType $chunk (end of image)\n";
$wasEnd = 1;
if ($outfile) {
# write the IEND/MEND chunk with CRC
Write($outfile, $hbuf, $cbuf) or $err = 1;
if ($$et{DEL_GROUP}{Trailer}) {
if ($raf->Read($hbuf, 1)) {
$verbose and printf $out " Deleting PNG trailer\n";
++$$et{CHANGED};
}
} else {
# copy over any existing trailer data
my $tot = 0;
for (;;) {
$n = $raf->Read($hbuf, 65536) or last;
$tot += $n;
Write($outfile, $hbuf) or $err = 1;
}
$tot and $verbose and printf $out " Copying PNG trailer ($tot bytes)\n";
}
last;
}
next;
}
# set FoundIDAT flag: 1=after IDAT, 2=after IDAT and warn about late XMP
$$et{FoundIDAT} = $earlyXMP ? 2 : 1 if $chunk eq 'IDAT';
# read chunk data and CRC
unless ($raf->Read($dbuf,$len)==$len and $raf->Read($cbuf, 4)==4) {
$et->Warn("Corrupted $fileType image") unless $wasEnd;
last;
}
unless ($wasHdr) {
if ($chunk eq $hdrChunk) {
$wasHdr = 1;
} elsif ($hdrChunk eq 'IHDR' and $chunk eq 'CgBI') {
$et->Warn('Non-standard PNG image (Apple iPhone format)');
} else {
$et->Warn("$fileType image did not start with $hdrChunk");
last;
}
}
if ($verbose) {
# check CRC when in verbose mode (since we don't care about speed)
my $crc = CalculateCRC(\$hbuf, undef, 4);
$crc = CalculateCRC(\$dbuf, $crc);
$crc == unpack('N',$cbuf) or $et->Warn("Bad CRC for $chunk chunk") unless $wasEnd;
if ($datChunk) {
Write($outfile, $hbuf, $dbuf, $cbuf) or $err = 1 if $outfile;
next;
}
print $out "$fileType $chunk ($len bytes):\n";
$et->VerboseDump(\$dbuf, Addr => $raf->Tell() - $len - 4) if $verbose > 2;
}
# translate case of chunk name if necessary
if (not $$tagTablePtr{$chunk}) {
my $stdChunk = $stdCase{lc $chunk};
if ($stdChunk) {
if ($outfile and ($$et{EDIT_DIRS}{IFD0} or $stdChunk !~ /^[ez]xif$/i)) {
$et->Warn("Changed $chunk chunk to $stdChunk", 1);
++$$et{CHANGED};
} else {
$et->Warn("$chunk chunk should be $stdChunk", 1);
}
$chunk = $stdCase{lc $chunk};
}
}
# only extract information from chunks in our tables
my ($theBuff, $outBuff);
$outBuff = \$theBuff if $outfile;
if ($$tagTablePtr{$chunk}) {
FoundPNG($et, $tagTablePtr, $chunk, $dbuf, undef, $outBuff);
} elsif ($mngTablePtr and $$mngTablePtr{$chunk}) {
FoundPNG($et, $mngTablePtr, $chunk, $dbuf, undef, $outBuff);
}
if ($outfile) {
if (defined $theBuff) {
next unless length $theBuff; # empty if we deleted the information
# change chunk type if necessary
if ($$et{TextChunkType}) {
$chunk = $$et{TextChunkType};
delete $$et{TextChunkType};
}
$hbuf = pack('Na4', length($theBuff), $chunk);
$dbuf = $theBuff;
my $crc = CalculateCRC(\$hbuf, undef, 4);
$crc = CalculateCRC(\$dbuf, $crc);
$cbuf = pack('N', $crc);
}
Write($outfile, $hbuf, $dbuf, $cbuf) or $err = 1;
}
}
delete $$et{SET_GROUP1};
return -1 if $outfile and ($err or not $wasEnd);
return 1; # this was a valid PNG/MNG/JNG image
}
1; # end
__END__
=head1 NAME
Image::ExifTool::PNG - Read and write PNG meta information
=head1 SYNOPSIS
This module is used by Image::ExifTool
=head1 DESCRIPTION
This module contains routines required by Image::ExifTool to read and
write PNG (Portable Network Graphics), MNG (Multi-image Network Graphics)
and JNG (JPEG Network Graphics) images.
=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.libpng.org/pub/png/spec/1.2/>
=item L<http://www.faqs.org/docs/png/>
=item L<http://www.libpng.org/pub/mng/>
=item L<http://www.libpng.org/pub/png/spec/register/>
=back
=head1 SEE ALSO
L<Image::ExifTool::TagNames/PNG Tags>,
L<Image::ExifTool::TagNames/MNG Tags>,
L<Image::ExifTool(3pm)|Image::ExifTool>
=cut
|