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 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904
|
// =================================================================================================
// ADOBE SYSTEMS INCORPORATED
// Copyright 2006 Adobe Systems Incorporated
// All Rights Reserved
//
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance with the terms
// of the Adobe license agreement accompanying it.
// =================================================================================================
#include "TIFF_Support.hpp"
// =================================================================================================
/// \file TIFF_FileWriter.cpp
/// \brief TIFF_FileWriter is used for memory-based read-write access and all file-based access.
///
/// \c TIFF_FileWriter is used for memory-based read-write access and all file-based access. The
/// main internal data structure is the InternalTagMap, a std::map that uses the tag number as the
/// key and InternalTagInfo as the value. There are 5 of these maps, one for each of the recognized
/// IFDs. The maps contain an entry for each tag in the IFD, whether we capture the data or not. The
/// dataPtr and dataLen fields in the InternalTagInfo are zero if the tag is not captured.
// =================================================================================================
// =================================================================================================
// TIFF_FileWriter::TIFF_FileWriter
// ================================
//
// Set big endian Get/Put routines so that routines are in place for creating TIFF without a parse.
// Parsing will reset them to the proper endianness for the stream. Big endian is a good default
// since JPEG and PSD files are big endian overall.
TIFF_FileWriter::TIFF_FileWriter() : changed(false), legacyDeleted(false), memParsed(false),
fileParsed(false), ownedStream(false), memStream(0), tiffLength(0)
{
XMP_Uns8 bogusTIFF [kEmptyTIFFLength];
bogusTIFF[0] = 0x4D;
bogusTIFF[1] = 0x4D;
bogusTIFF[2] = 0x00;
bogusTIFF[3] = 0x2A;
bogusTIFF[4] = bogusTIFF[5] = bogusTIFF[6] = bogusTIFF[7] = 0x00;
(void) this->CheckTIFFHeader ( bogusTIFF, sizeof ( bogusTIFF ) );
} // TIFF_FileWriter::TIFF_FileWriter
// =================================================================================================
// TIFF_FileWriter::~TIFF_FileWriter
// =================================
TIFF_FileWriter::~TIFF_FileWriter()
{
XMP_Assert ( ! (this->memParsed && this->fileParsed) );
if ( this->ownedStream ) {
XMP_Assert ( this->memStream != 0 );
free ( this->memStream );
}
} // TIFF_FileWriter::~TIFF_FileWriter
// =================================================================================================
// TIFF_FileWriter::DeleteExistingInfo
// ===================================
void TIFF_FileWriter::DeleteExistingInfo()
{
XMP_Assert ( ! (this->memParsed && this->fileParsed) );
if ( this->ownedStream ) free ( this->memStream ); // ! Current TIFF might be memory-parsed.
this->memStream = 0;
this->tiffLength = 0;
for ( int ifd = 0; ifd < kTIFF_KnownIFDCount; ++ifd ) this->containedIFDs[ifd].clear();
this->changed = false;
this->legacyDeleted = false;
this->memParsed = false;
this->fileParsed = false;
this->ownedStream = false;
} // TIFF_FileWriter::DeleteExistingInfo
// =================================================================================================
// TIFF_FileWriter::PickIFD
// ========================
XMP_Uns8 TIFF_FileWriter::PickIFD ( XMP_Uns8 ifd, XMP_Uns16 id )
{
if ( ifd > kTIFF_LastRealIFD ) {
if ( ifd != kTIFF_KnownIFD ) XMP_Throw ( "Invalid IFD number", kXMPErr_BadParam );
XMP_Throw ( "kTIFF_KnownIFD not yet implemented", kXMPErr_Unimplemented );
// *** Likely to stay unimplemented until there is a client need.
}
return ifd;
} // TIFF_FileWriter::PickIFD
// =================================================================================================
// TIFF_FileWriter::FindTagInIFD
// =============================
const TIFF_FileWriter::InternalTagInfo* TIFF_FileWriter::FindTagInIFD ( XMP_Uns8 ifd, XMP_Uns16 id ) const
{
ifd = PickIFD ( ifd, id );
const InternalTagMap& currIFD = this->containedIFDs[ifd].tagMap;
InternalTagMap::const_iterator tagPos = currIFD.find ( id );
if ( tagPos == currIFD.end() ) return 0;
return &tagPos->second;
} // TIFF_FileWriter::FindTagInIFD
// =================================================================================================
// TIFF_FileWriter::GetIFD
// =======================
bool TIFF_FileWriter::GetIFD ( XMP_Uns8 ifd, TagInfoMap* ifdMap ) const
{
if ( ifd > kTIFF_LastRealIFD ) XMP_Throw ( "Invalid IFD number", kXMPErr_BadParam );
const InternalTagMap& currIFD = this->containedIFDs[ifd].tagMap;
InternalTagMap::const_iterator tagPos = currIFD.begin();
InternalTagMap::const_iterator tagEnd = currIFD.end();
if ( ifdMap != 0 ) ifdMap->clear();
if ( tagPos == tagEnd ) return false; // Empty IFD.
if ( ifdMap != 0 ) {
for ( ; tagPos != tagEnd; ++tagPos ) {
const InternalTagInfo& intInfo = tagPos->second;
TagInfo extInfo ( intInfo.id, intInfo.type, intInfo.count, intInfo.dataPtr, intInfo.dataLen );
(*ifdMap)[intInfo.id] = extInfo;
}
}
return true;
} // TIFF_FileWriter::GetIFD
// =================================================================================================
// TIFF_FileWriter::GetValueOffset
// ===============================
XMP_Uns32 TIFF_FileWriter::GetValueOffset ( XMP_Uns8 ifd, XMP_Uns16 id ) const
{
const InternalTagInfo* thisTag = this->FindTagInIFD ( ifd, id );
if ( (thisTag == 0) || (thisTag->origDataLen == 0) ) return 0;
return thisTag->origDataOffset;
} // TIFF_FileWriter::GetValueOffset
// =================================================================================================
// TIFF_FileWriter::GetTag
// =======================
bool TIFF_FileWriter::GetTag ( XMP_Uns8 ifd, XMP_Uns16 id, TagInfo* info ) const
{
const InternalTagInfo* thisTag = this->FindTagInIFD ( ifd, id );
if ( thisTag == 0 ) return false;
if ( info != 0 ) {
info->id = thisTag->id;
info->type = thisTag->type;
info->count = thisTag->dataLen / (XMP_Uns32)kTIFF_TypeSizes[thisTag->type];
info->dataLen = thisTag->dataLen;
info->dataPtr = (const void*)(thisTag->dataPtr);
}
return true;
} // TIFF_FileWriter::GetTag
// =================================================================================================
// TIFF_FileWriter::SetTag
// =======================
void TIFF_FileWriter::SetTag ( XMP_Uns8 ifd, XMP_Uns16 id, XMP_Uns16 type, XMP_Uns32 count, const void* clientPtr )
{
if ( (type < kTIFF_ByteType) || (type > kTIFF_LastType) ) XMP_Throw ( "Invalid TIFF tag type", kXMPErr_BadParam );
size_t typeSize = kTIFF_TypeSizes[type];
size_t fullSize = count * typeSize;
ifd = PickIFD ( ifd, id );
InternalTagMap& currIFD = this->containedIFDs[ifd].tagMap;
InternalTagInfo* tagPtr = 0;
InternalTagMap::iterator tagPos = currIFD.find ( id );
if ( tagPos == currIFD.end() ) {
// The tag does not yet exist, add it.
InternalTagMap::value_type mapValue ( id, InternalTagInfo ( id, type, count, this->fileParsed ) );
tagPos = currIFD.insert ( tagPos, mapValue );
tagPtr = &tagPos->second;
} else {
tagPtr = &tagPos->second;
// The tag already exists, make sure the value is actually changing.
if ( (type == tagPtr->type) && (count == tagPtr->count) &&
(memcmp ( clientPtr, tagPtr->dataPtr, tagPtr->dataLen ) == 0) ) {
return; // ! The value is unchanged, exit.
}
tagPtr->FreeData(); // Release any existing data allocation.
tagPtr->type = type; // These might be changing also.
tagPtr->count = count;
}
tagPtr->changed = true;
tagPtr->dataLen = (XMP_Uns32)fullSize;
if ( fullSize <= 4 ) {
// The data is less than 4 bytes, store it in the smallValue field using native endianness.
tagPtr->dataPtr = (XMP_Uns8*) &tagPtr->smallValue;
} else {
// The data is more than 4 bytes, make a copy.
tagPtr->dataPtr = (XMP_Uns8*) malloc ( fullSize );
if ( tagPtr->dataPtr == 0 ) XMP_Throw ( "Out of memory", kXMPErr_NoMemory );
}
memcpy ( tagPtr->dataPtr, clientPtr, fullSize ); // AUDIT: Safe, space guaranteed to be fullSize.
if ( ! this->nativeEndian ) {
if ( typeSize == 2 ) {
XMP_Uns16* flipPtr = (XMP_Uns16*) tagPtr->dataPtr;
for ( XMP_Uns32 i = 0; i < count; ++i ) Flip2 ( flipPtr[i] );
} else if ( typeSize == 4 ) {
XMP_Uns32* flipPtr = (XMP_Uns32*) tagPtr->dataPtr;
for ( XMP_Uns32 i = 0; i < count; ++i ) Flip4 ( flipPtr[i] );
} else if ( typeSize == 8 ) {
XMP_Uns64* flipPtr = (XMP_Uns64*) tagPtr->dataPtr;
for ( XMP_Uns32 i = 0; i < count; ++i ) Flip8 ( flipPtr[i] );
}
}
this->containedIFDs[ifd].changed = true;
this->changed = true;
} // TIFF_FileWriter::SetTag
// =================================================================================================
// TIFF_FileWriter::DeleteTag
// ==========================
void TIFF_FileWriter::DeleteTag ( XMP_Uns8 ifd, XMP_Uns16 id )
{
ifd = PickIFD ( ifd, id );
InternalTagMap& currIFD = this->containedIFDs[ifd].tagMap;
InternalTagMap::iterator tagPos = currIFD.find ( id );
if ( tagPos == currIFD.end() ) return; // ! Don't set the changed flags if the tag didn't exist.
currIFD.erase ( tagPos );
this->containedIFDs[ifd].changed = true;
this->changed = true;
if ( (ifd != kTIFF_PrimaryIFD) || (id != kTIFF_XMP) ) this->legacyDeleted = true;
} // TIFF_FileWriter::DeleteTag
// =================================================================================================
// TIFF_FileWriter::GetTag_Integer
// ===============================
bool TIFF_FileWriter::GetTag_Integer ( XMP_Uns8 ifd, XMP_Uns16 id, XMP_Uns32* data ) const
{
const InternalTagInfo* thisTag = this->FindTagInIFD ( ifd, id );
if ( thisTag == 0 ) return false;
if ( thisTag->count != 1 ) return false;
static XMP_Uns32 voidValue;
if ( data == 0 ) data = &voidValue;
if ( thisTag->type == kTIFF_ShortType ) {
*data = this->GetUns16 ( thisTag->dataPtr );
} else if ( thisTag->type == kTIFF_LongType ) {
*data = this->GetUns32 ( thisTag->dataPtr );
} else {
return false;
}
return true;
} // TIFF_FileWriter::GetTag_Integer
// =================================================================================================
// TIFF_FileWriter::GetTag_Byte
// ============================
bool TIFF_FileWriter::GetTag_Byte ( XMP_Uns8 ifd, XMP_Uns16 id, XMP_Uns8* data ) const
{
const InternalTagInfo* thisTag = this->FindTagInIFD ( ifd, id );
if ( thisTag == 0 ) return false;
if ( (thisTag->type != kTIFF_ByteType) || (thisTag->dataLen != 1) ) return false;
if ( data != 0 ) *data = *thisTag->dataPtr;
return true;
} // TIFF_FileWriter::GetTag_Byte
// =================================================================================================
// TIFF_FileWriter::GetTag_SByte
// =============================
bool TIFF_FileWriter::GetTag_SByte ( XMP_Uns8 ifd, XMP_Uns16 id, XMP_Int8* data ) const
{
const InternalTagInfo* thisTag = this->FindTagInIFD ( ifd, id );
if ( thisTag == 0 ) return false;
if ( (thisTag->type != kTIFF_SByteType) || (thisTag->dataLen != 1) ) return false;
if ( data != 0 ) *data = *thisTag->dataPtr;
return true;
} // TIFF_FileWriter::GetTag_SByte
// =================================================================================================
// TIFF_FileWriter::GetTag_Short
// =============================
bool TIFF_FileWriter::GetTag_Short ( XMP_Uns8 ifd, XMP_Uns16 id, XMP_Uns16* data ) const
{
const InternalTagInfo* thisTag = this->FindTagInIFD ( ifd, id );
if ( thisTag == 0 ) return false;
if ( (thisTag->type != kTIFF_ShortType) || (thisTag->dataLen != 2) ) return false;
if ( data != 0 ) *data = this->GetUns16 ( thisTag->dataPtr );
return true;
} // TIFF_FileWriter::GetTag_Short
// =================================================================================================
// TIFF_FileWriter::GetTag_SShort
// ==============================
bool TIFF_FileWriter::GetTag_SShort ( XMP_Uns8 ifd, XMP_Uns16 id, XMP_Int16* data ) const
{
const InternalTagInfo* thisTag = this->FindTagInIFD ( ifd, id );
if ( thisTag == 0 ) return false;
if ( (thisTag->type != kTIFF_SShortType) || (thisTag->dataLen != 2) ) return false;
if ( data != 0 ) *data = (XMP_Int16) this->GetUns16 ( thisTag->dataPtr );
return true;
} // TIFF_FileWriter::GetTag_SShort
// =================================================================================================
// TIFF_FileWriter::GetTag_Long
// ============================
bool TIFF_FileWriter::GetTag_Long ( XMP_Uns8 ifd, XMP_Uns16 id, XMP_Uns32* data ) const
{
const InternalTagInfo* thisTag = this->FindTagInIFD ( ifd, id );
if ( thisTag == 0 ) return false;
if ( (thisTag->type != kTIFF_LongType) || (thisTag->dataLen != 4) ) return false;
if ( data != 0 ) *data = this->GetUns32 ( thisTag->dataPtr );
return true;
} // TIFF_FileWriter::GetTag_Long
// =================================================================================================
// TIFF_FileWriter::GetTag_SLong
// =============================
bool TIFF_FileWriter::GetTag_SLong ( XMP_Uns8 ifd, XMP_Uns16 id, XMP_Int32* data ) const
{
const InternalTagInfo* thisTag = this->FindTagInIFD ( ifd, id );
if ( thisTag == 0 ) return false;
if ( (thisTag->type != kTIFF_SLongType) || (thisTag->dataLen != 4) ) return false;
if ( data != 0 ) *data = (XMP_Int32) this->GetUns32 ( thisTag->dataPtr );
return true;
} // TIFF_FileWriter::GetTag_SLong
// =================================================================================================
// TIFF_FileWriter::GetTag_Rational
// ================================
bool TIFF_FileWriter::GetTag_Rational ( XMP_Uns8 ifd, XMP_Uns16 id, Rational* data ) const
{
const InternalTagInfo* thisTag = this->FindTagInIFD ( ifd, id );
if ( (thisTag == 0) || (thisTag->dataPtr == 0) ) return false;
if ( (thisTag->type != kTIFF_RationalType) || (thisTag->dataLen != 8) ) return false;
if ( data != 0 ) {
XMP_Uns32* dataPtr = (XMP_Uns32*)thisTag->dataPtr;
data->num = this->GetUns32 ( dataPtr );
data->denom = this->GetUns32 ( dataPtr+1 );
}
return true;
} // TIFF_FileWriter::GetTag_Rational
// =================================================================================================
// TIFF_FileWriter::GetTag_SRational
// =================================
bool TIFF_FileWriter::GetTag_SRational ( XMP_Uns8 ifd, XMP_Uns16 id, SRational* data ) const
{
const InternalTagInfo* thisTag = this->FindTagInIFD ( ifd, id );
if ( (thisTag == 0) || (thisTag->dataPtr == 0) ) return false;
if ( (thisTag->type != kTIFF_SRationalType) || (thisTag->dataLen != 8) ) return false;
if ( data != 0 ) {
XMP_Uns32* dataPtr = (XMP_Uns32*)thisTag->dataPtr;
data->num = (XMP_Int32) this->GetUns32 ( dataPtr );
data->denom = (XMP_Int32) this->GetUns32 ( dataPtr+1 );
}
return true;
} // TIFF_FileWriter::GetTag_SRational
// =================================================================================================
// TIFF_FileWriter::GetTag_Float
// =============================
bool TIFF_FileWriter::GetTag_Float ( XMP_Uns8 ifd, XMP_Uns16 id, float* data ) const
{
const InternalTagInfo* thisTag = this->FindTagInIFD ( ifd, id );
if ( thisTag == 0 ) return false;
if ( (thisTag->type != kTIFF_FloatType) || (thisTag->dataLen != 4) ) return false;
if ( data != 0 ) *data = this->GetFloat ( thisTag->dataPtr );
return true;
} // TIFF_FileWriter::GetTag_Float
// =================================================================================================
// TIFF_FileWriter::GetTag_Double
// ==============================
bool TIFF_FileWriter::GetTag_Double ( XMP_Uns8 ifd, XMP_Uns16 id, double* data ) const
{
const InternalTagInfo* thisTag = this->FindTagInIFD ( ifd, id );
if ( (thisTag == 0) || (thisTag->dataPtr == 0) ) return false;
if ( (thisTag->type != kTIFF_DoubleType) || (thisTag->dataLen != 8) ) return false;
if ( data != 0 ) *data = this->GetDouble ( thisTag->dataPtr );
return true;
} // TIFF_FileWriter::GetTag_Double
// =================================================================================================
// TIFF_FileWriter::GetTag_ASCII
// =============================
bool TIFF_FileWriter::GetTag_ASCII ( XMP_Uns8 ifd, XMP_Uns16 id, XMP_StringPtr* dataPtr, XMP_StringLen* dataLen ) const
{
const InternalTagInfo* thisTag = this->FindTagInIFD ( ifd, id );
if ( thisTag == 0 ) return false;
if ( (thisTag->dataLen > 4) && (thisTag->dataPtr == 0) ) return false;
if ( thisTag->type != kTIFF_ASCIIType ) return false;
if ( dataPtr != 0 ) *dataPtr = (XMP_StringPtr)thisTag->dataPtr;
if ( dataLen != 0 ) *dataLen = thisTag->dataLen;
return true;
} // TIFF_FileWriter::GetTag_ASCII
// =================================================================================================
// TIFF_FileWriter::GetTag_EncodedString
// =====================================
bool TIFF_FileWriter::GetTag_EncodedString ( XMP_Uns8 ifd, XMP_Uns16 id, std::string* utf8Str ) const
{
const InternalTagInfo* thisTag = this->FindTagInIFD ( ifd, id );
if ( thisTag == 0 ) return false;
if ( thisTag->type != kTIFF_UndefinedType ) return false;
if ( utf8Str == 0 ) return true; // Return true if the converted string is not wanted.
bool ok = this->DecodeString ( thisTag->dataPtr, thisTag->dataLen, utf8Str );
return ok;
} // TIFF_FileWriter::GetTag_EncodedString
// =================================================================================================
// TIFF_FileWriter::SetTag_EncodedString
// =====================================
void TIFF_FileWriter::SetTag_EncodedString ( XMP_Uns8 ifd, XMP_Uns16 id, const std::string& utf8Str, XMP_Uns8 encoding )
{
std::string encodedStr;
this->EncodeString ( utf8Str, encoding, &encodedStr );
this->SetTag ( ifd, id, kTIFF_UndefinedType, (XMP_Uns32)encodedStr.size(), encodedStr.c_str() );
} // TIFF_FileWriter::SetTag_EncodedString
// =================================================================================================
// TIFF_FileWriter::IsLegacyChanged
// ================================
bool TIFF_FileWriter::IsLegacyChanged()
{
if ( ! this->changed ) return false;
if ( this->legacyDeleted ) return true;
for ( int ifd = 0; ifd < kTIFF_KnownIFDCount; ++ifd ) {
InternalIFDInfo & thisIFD = this->containedIFDs[ifd];
if ( ! thisIFD.changed ) continue;
InternalTagMap::iterator tagPos;
InternalTagMap::iterator tagEnd = thisIFD.tagMap.end();
for ( tagPos = thisIFD.tagMap.begin(); tagPos != tagEnd; ++tagPos ) {
InternalTagInfo & thisTag = tagPos->second;
if ( thisTag.changed && (thisTag.id != kTIFF_XMP) ) return true;
}
}
return false; // Can get here if the XMP tag is the only one changed.
} // TIFF_FileWriter::IsLegacyChanged
// =================================================================================================
// TIFF_FileWriter::ParseMemoryStream
// ==================================
void TIFF_FileWriter::ParseMemoryStream ( const void* data, XMP_Uns32 length, bool copyData /* = true */ )
{
this->DeleteExistingInfo();
this->memParsed = true;
if ( length == 0 ) return;
// Allocate space for the full in-memory stream and copy it.
if ( ! copyData ) {
XMP_Assert ( ! this->ownedStream );
this->memStream = (XMP_Uns8*) data;
} else {
if ( length > 100*1024*1024 ) XMP_Throw ( "Outrageous length for memory-based TIFF", kXMPErr_BadTIFF );
this->memStream = (XMP_Uns8*) malloc(length);
this->ownedStream = true;
if ( this->memStream == 0 ) XMP_Throw ( "Out of memory", kXMPErr_NoMemory );
memcpy ( this->memStream, data, length ); // AUDIT: Safe, malloc'ed length bytes above.
this->ownedStream = true;
}
this->tiffLength = length;
// Find and process the primary, Exif, GPS, and Interoperability IFDs.
XMP_Uns32 primaryIFDOffset = this->CheckTIFFHeader ( this->memStream, length );
if ( primaryIFDOffset != 0 ) (void) this->ProcessMemoryIFD ( primaryIFDOffset, kTIFF_PrimaryIFD );
const InternalTagInfo* exifIFDTag = this->FindTagInIFD ( kTIFF_PrimaryIFD, kTIFF_ExifIFDPointer );
if ( (exifIFDTag != 0) && (exifIFDTag->type == kTIFF_LongType) && (exifIFDTag->dataLen == 4) ) {
XMP_Uns32 exifOffset = this->GetUns32 ( exifIFDTag->dataPtr );
(void) this->ProcessMemoryIFD ( exifOffset, kTIFF_ExifIFD );
}
const InternalTagInfo* gpsIFDTag = this->FindTagInIFD ( kTIFF_PrimaryIFD, kTIFF_GPSInfoIFDPointer );
if ( (gpsIFDTag != 0) && (gpsIFDTag->type == kTIFF_LongType) && (gpsIFDTag->dataLen == 4) ) {
XMP_Uns32 gpsOffset = this->GetUns32 ( gpsIFDTag->dataPtr );
(void) this->ProcessMemoryIFD ( gpsOffset, kTIFF_GPSInfoIFD );
}
const InternalTagInfo* interopIFDTag = this->FindTagInIFD ( kTIFF_ExifIFD, kTIFF_InteroperabilityIFDPointer );
if ( (interopIFDTag != 0) && (interopIFDTag->type == kTIFF_LongType) && (interopIFDTag->dataLen == 4) ) {
XMP_Uns32 interopOffset = this->GetUns32 ( interopIFDTag->dataPtr );
(void) this->ProcessMemoryIFD ( interopOffset, kTIFF_InteropIFD );
}
#if 0
{
printf ( "\nExiting TIFF_FileWriter::ParseMemoryStream\n" );
for ( int ifd = 0; ifd < kTIFF_KnownIFDCount; ++ifd ) {
InternalIFDInfo & thisIFD = this->containedIFDs[ifd];
printf ( "\n IFD %d, count %d, mapped %d, offset %d (0x%X), next IFD %d (0x%X)\n",
ifd, thisIFD.origCount, thisIFD.tagMap.size(),
thisIFD.origDataOffset, thisIFD.origDataOffset, thisIFD.origNextIFD, thisIFD.origNextIFD );
InternalTagMap::iterator tagPos;
InternalTagMap::iterator tagEnd = thisIFD.tagMap.end();
for ( tagPos = thisIFD.tagMap.begin(); tagPos != tagEnd; ++tagPos ) {
InternalTagInfo & thisTag = tagPos->second;
printf ( " Tag %d, smallValue 0x%X, origDataLen %d, origDataOffset %d (0x%X)\n",
thisTag.id, thisTag.smallValue, thisTag.origDataLen, thisTag.origDataOffset, thisTag.origDataOffset );
}
}
printf ( "\n" );
}
#endif
} // TIFF_FileWriter::ParseMemoryStream
// =================================================================================================
// TIFF_FileWriter::ProcessMemoryIFD
// =================================
XMP_Uns32 TIFF_FileWriter::ProcessMemoryIFD ( XMP_Uns32 ifdOffset, XMP_Uns8 ifd )
{
InternalIFDInfo& ifdInfo ( this->containedIFDs[ifd] );
if ( (ifdOffset < 8) || (ifdOffset > (this->tiffLength - kEmptyIFDLength)) ) {
XMP_Throw ( "Bad IFD offset", kXMPErr_BadTIFF );
}
XMP_Uns8* ifdPtr = this->memStream + ifdOffset;
XMP_Uns16 tagCount = this->GetUns16 ( ifdPtr );
RawIFDEntry* ifdEntries = (RawIFDEntry*)(ifdPtr+2);
if ( tagCount >= 0x8000 ) XMP_Throw ( "Outrageous IFD count", kXMPErr_BadTIFF );
if ( (ifdOffset + 2 + tagCount*12 + 4) > this->tiffLength ) XMP_Throw ( "Out of bounds IFD", kXMPErr_BadTIFF );
ifdInfo.origIFDOffset = ifdOffset;
ifdInfo.origCount = tagCount;
for ( size_t i = 0; i < tagCount; ++i ) {
RawIFDEntry* rawTag = &ifdEntries[i];
XMP_Uns16 tagType = this->GetUns16 ( &rawTag->type );
if ( (tagType < kTIFF_ByteType) || (tagType > kTIFF_LastType) ) continue; // Bad type, skip this tag.
XMP_Uns16 tagID = this->GetUns16 ( &rawTag->id );
XMP_Uns32 tagCount = this->GetUns32 ( &rawTag->count );
InternalTagMap::value_type mapValue ( tagID, InternalTagInfo ( tagID, tagType, tagCount, kIsMemoryBased ) );
InternalTagMap::iterator newPos = ifdInfo.tagMap.insert ( ifdInfo.tagMap.end(), mapValue );
InternalTagInfo& mapTag = newPos->second;
mapTag.dataLen = mapTag.origDataLen = mapTag.count * (XMP_Uns32)kTIFF_TypeSizes[mapTag.type];
mapTag.smallValue = rawTag->dataOrOffset; // Keep the value or offset in stream byte ordering.
if ( mapTag.dataLen <= 4 ) {
mapTag.origDataOffset = ifdOffset + 2 + (12 * (XMP_Uns32)i) + 8; // Compute the data offset.
} else {
mapTag.origDataOffset = this->GetUns32 ( &rawTag->dataOrOffset ); // Extract the data offset.
// printf ( "FW_ProcessMemoryIFD tag %d large value @ %.8X\n", mapTag.id, mapTag.dataPtr );
}
mapTag.dataPtr = this->memStream + mapTag.origDataOffset;
}
ifdPtr += (2 + tagCount*12);
ifdInfo.origNextIFD = this->GetUns32 ( ifdPtr );
return ifdInfo.origNextIFD;
} // TIFF_FileWriter::ProcessMemoryIFD
// =================================================================================================
// TIFF_FileWriter::ParseFileStream
// ================================
//
// The buffered I/O model is worth the logic complexity - as opposed to a simple seek/read for each
// part of the TIFF stream. The vast majority of real-world TIFFs have the primary IFD, Exif IFD,
// and all of their interesting tag values within the first 64K of the file. Well, at least before
// we get around to our edit-by-append approach.
void TIFF_FileWriter::ParseFileStream ( LFA_FileRef fileRef )
{
bool ok;
IOBuffer ioBuf;
this->DeleteExistingInfo();
this->fileParsed = true;
this->tiffLength = (XMP_Uns32) LFA_Measure ( fileRef );
if ( this->tiffLength == 0 ) return;
// Find and process the primary, Exif, GPS, and Interoperability IFDs.
ioBuf.filePos = LFA_Seek ( fileRef, 0, SEEK_SET );
ok = CheckFileSpace ( fileRef, &ioBuf, 8 );
if ( ! ok ) XMP_Throw ( "TIFF too small", kXMPErr_BadTIFF );
XMP_Uns32 primaryIFDOffset = this->CheckTIFFHeader ( ioBuf.ptr, this->tiffLength );
if ( primaryIFDOffset != 0 ) (void) this->ProcessFileIFD ( kTIFF_PrimaryIFD, primaryIFDOffset, fileRef, &ioBuf );
const InternalTagInfo* exifIFDTag = this->FindTagInIFD ( kTIFF_PrimaryIFD, kTIFF_ExifIFDPointer );
if ( (exifIFDTag != 0) && (exifIFDTag->type == kTIFF_LongType) && (exifIFDTag->count == 1) ) {
XMP_Uns32 exifOffset = this->GetUns32 ( exifIFDTag->dataPtr );
(void) this->ProcessFileIFD ( kTIFF_ExifIFD, exifOffset, fileRef, &ioBuf );
}
const InternalTagInfo* gpsIFDTag = this->FindTagInIFD ( kTIFF_PrimaryIFD, kTIFF_GPSInfoIFDPointer );
if ( (gpsIFDTag != 0) && (gpsIFDTag->type == kTIFF_LongType) && (gpsIFDTag->count == 1) ) {
XMP_Uns32 gpsOffset = this->GetUns32 ( gpsIFDTag->dataPtr );
(void) this->ProcessFileIFD ( kTIFF_GPSInfoIFD, gpsOffset, fileRef, &ioBuf );
}
const InternalTagInfo* interopIFDTag = this->FindTagInIFD ( kTIFF_ExifIFD, kTIFF_InteroperabilityIFDPointer );
if ( (interopIFDTag != 0) && (interopIFDTag->type == kTIFF_LongType) && (interopIFDTag->dataLen == 4) ) {
XMP_Uns32 interopOffset = this->GetUns32 ( interopIFDTag->dataPtr );
(void) this->ProcessFileIFD ( kTIFF_InteropIFD, interopOffset, fileRef, &ioBuf );
}
#if 0
{
printf ( "\nExiting TIFF_FileWriter::ParseFileStream\n" );
for ( int ifd = 0; ifd < kTIFF_KnownIFDCount; ++ifd ) {
InternalIFDInfo & thisIFD = this->containedIFDs[ifd];
printf ( "\n IFD %d, count %d, mapped %d, offset %d (0x%X), next IFD %d (0x%X)\n",
ifd, thisIFD.origCount, thisIFD.tagMap.size(),
thisIFD.origDataOffset, thisIFD.origDataOffset, thisIFD.origNextIFD, thisIFD.origNextIFD );
InternalTagMap::iterator tagPos;
InternalTagMap::iterator tagEnd = thisIFD.tagMap.end();
for ( tagPos = thisIFD.tagMap.begin(); tagPos != tagEnd; ++tagPos ) {
InternalTagInfo & thisTag = tagPos->second;
printf ( " Tag %d, smallValue 0x%X, origDataLen %d, origDataOffset %d (0x%X)\n",
thisTag.id, thisTag.smallValue, thisTag.origDataLen, thisTag.origDataOffset, thisTag.origDataOffset );
}
}
printf ( "\n" );
}
#endif
} // TIFF_FileWriter::ParseFileStream
// =================================================================================================
// TIFF_FileWriter::ProcessFileIFD
// ===============================
XMP_Uns32 TIFF_FileWriter::ProcessFileIFD ( XMP_Uns8 ifd, XMP_Uns32 ifdOffset, LFA_FileRef fileRef, IOBuffer* ioBuf )
{
InternalIFDInfo& ifdInfo ( this->containedIFDs[ifd] );
MoveToOffset ( fileRef, ifdOffset, ioBuf ); // Move to the start of the IFD.
bool ok = CheckFileSpace ( fileRef, ioBuf, 2 );
if ( ! ok ) XMP_Throw ( "IFD count missing", kXMPErr_BadTIFF );
XMP_Uns16 tagCount = this->GetUns16 ( ioBuf->ptr );
if ( tagCount >= 0x8000 ) XMP_Throw ( "Outrageous IFD count", kXMPErr_BadTIFF );
if ( (ifdOffset + 2 + tagCount*12 + 4) > this->tiffLength ) XMP_Throw ( "Out of bounds IFD", kXMPErr_BadTIFF );
ifdInfo.origIFDOffset = ifdOffset;
ifdInfo.origCount = tagCount;
// ---------------------------------------------------------------------------------------------
// First create all of the IFD map entries, capturing short values, and get the next IFD offset.
// We're using a std::map for storage, it automatically eliminates duplicates and provides
// sorted output. Plus the "map[key] = value" assignment conveniently keeps the last encountered
// value, following Photoshop's behavior.
ioBuf->ptr += 2; // Move to the first IFD entry.
for ( XMP_Uns16 i = 0; i < tagCount; ++i, ioBuf->ptr += 12 ) {
if ( ! CheckFileSpace ( fileRef, ioBuf, 12 ) ) XMP_Throw ( "EOF within IFD", kXMPErr_BadTIFF );
RawIFDEntry* rawTag = (RawIFDEntry*)ioBuf->ptr;
XMP_Uns16 tagType = this->GetUns16 ( &rawTag->type );
if ( (tagType < kTIFF_ByteType) || (tagType > kTIFF_LastType) ) continue; // Bad type, skip this tag.
XMP_Uns16 tagID = this->GetUns16 ( &rawTag->id );
XMP_Uns32 tagCount = this->GetUns32 ( &rawTag->count );
InternalTagMap::value_type mapValue ( tagID, InternalTagInfo ( tagID, tagType, tagCount, kIsFileBased ) );
InternalTagMap::iterator newPos = ifdInfo.tagMap.insert ( ifdInfo.tagMap.end(), mapValue );
InternalTagInfo& mapTag = newPos->second;
mapTag.dataLen = mapTag.origDataLen = mapTag.count * (XMP_Uns32)kTIFF_TypeSizes[mapTag.type];
mapTag.smallValue = rawTag->dataOrOffset; // Keep the value or offset in stream byte ordering.
if ( mapTag.dataLen <= 4 ) {
mapTag.dataPtr = (XMP_Uns8*) &mapTag.smallValue;
mapTag.origDataOffset = ifdOffset + 2 + (12 * i) + 8; // Compute the data offset.
} else {
mapTag.origDataOffset = this->GetUns32 ( &rawTag->dataOrOffset ); // Extract the data offset.
}
}
if ( ! CheckFileSpace ( fileRef, ioBuf, 4 ) ) XMP_Throw ( "EOF at next IFD offset", kXMPErr_BadTIFF );
ifdInfo.origNextIFD = this->GetUns32 ( ioBuf->ptr );
// ---------------------------------------------------------------------------------------------
// Go back over the tag map and extract the data for large recognized tags. This is done in 2
// passes, in order to lessen the typical amount of I/O. On the first pass make sure we have at
// least 32K of data following the IFD in the buffer, and extract all of the values in that
// portion. This should cover an original file, or the appended values with an appended IFD.
if ( (ioBuf->limit - ioBuf->ptr) < 32*1024 ) RefillBuffer ( fileRef, ioBuf );
InternalTagMap::iterator tagPos = ifdInfo.tagMap.begin();
InternalTagMap::iterator tagEnd = ifdInfo.tagMap.end();
const XMP_Uns16* knownTagPtr = sKnownTags[ifd]; // Points into the ordered recognized tag list.
XMP_Uns32 bufBegin = (XMP_Uns32)ioBuf->filePos; // TIFF stream bounds for the current buffer.
XMP_Uns32 bufEnd = bufBegin + (XMP_Uns32)ioBuf->len;
for ( ; tagPos != tagEnd; ++tagPos ) {
InternalTagInfo* currTag = &tagPos->second;
if ( currTag->dataLen <= 4 ) continue; // Short values are already in the smallValue field.
while ( *knownTagPtr < currTag->id ) ++knownTagPtr;
if ( *knownTagPtr != currTag->id ) continue; // Skip unrecognized tags.
if ( currTag->dataLen > 1024*1024 ) XMP_Throw ( "Outrageous data length", kXMPErr_BadTIFF );
if ( (bufBegin <= currTag->origDataOffset) && ((currTag->origDataOffset + currTag->dataLen) <= bufEnd) ) {
// This value is already fully within the current I/O buffer, copy it.
MoveToOffset ( fileRef, currTag->origDataOffset, ioBuf );
currTag->dataPtr = (XMP_Uns8*) malloc ( currTag->dataLen );
if ( currTag->dataPtr == 0 ) XMP_Throw ( "No data block", kXMPErr_NoMemory );
memcpy ( currTag->dataPtr, ioBuf->ptr, currTag->dataLen ); // AUDIT: Safe, malloc'ed currTag->dataLen bytes above.
currTag->changed = true; // Memory leaks otherwise
}
}
// ---------------------------------------------------------------------------------------------
// Now the second large value pass. This will reposition the I/O buffer as necessary. Hopefully
// just once, to pick up the span of data not covered in the first pass.
tagPos = ifdInfo.tagMap.begin(); // Reset both map/array positions.
knownTagPtr = sKnownTags[ifd];
for ( ; tagPos != tagEnd; ++tagPos ) {
InternalTagInfo* currTag = &tagPos->second;
if ( (currTag->dataLen <= 4) || (currTag->dataPtr != 0) ) continue; // Done this tag?
while ( *knownTagPtr < currTag->id ) ++knownTagPtr;
if ( *knownTagPtr != currTag->id ) continue; // Skip unrecognized tags.
if ( currTag->dataLen > 1024*1024 ) XMP_Throw ( "Outrageous data length", kXMPErr_BadTIFF );
currTag->dataPtr = (XMP_Uns8*) malloc ( currTag->dataLen );
if ( currTag->dataPtr == 0 ) XMP_Throw ( "No data block", kXMPErr_NoMemory );
//HUB-merge currTag->changed = true; // Memory leaks otherwise
if ( currTag->dataLen > kIOBufferSize ) {
// This value is bigger than the I/O buffer, read it directly and restore the file position.
LFA_Seek ( fileRef, currTag->origDataOffset, SEEK_SET );
LFA_Read ( fileRef, currTag->dataPtr, currTag->dataLen, kLFA_RequireAll );
LFA_Seek ( fileRef, (ioBuf->filePos + ioBuf->len), SEEK_SET );
} else {
// This value can fit in the I/O buffer, so use that.
MoveToOffset ( fileRef, currTag->origDataOffset, ioBuf );
ok = CheckFileSpace ( fileRef, ioBuf, currTag->dataLen );
if ( ! ok ) XMP_Throw ( "EOF in data block", kXMPErr_BadTIFF );
memcpy ( currTag->dataPtr, ioBuf->ptr, currTag->dataLen ); // AUDIT: Safe, malloc'ed currTag->dataLen bytes above.
}
}
// Done, return the next IFD offset.
return ifdInfo.origNextIFD;
} // TIFF_FileWriter::ProcessFileIFD
// =================================================================================================
// TIFF_FileWriter::IntegrateFromPShop6
// ====================================
//
// See comments for ProcessPShop6IFD.
void TIFF_FileWriter::IntegrateFromPShop6 ( const void * buriedPtr, size_t buriedLen )
{
TIFF_MemoryReader buriedExif;
buriedExif.ParseMemoryStream ( buriedPtr, (XMP_Uns32) buriedLen );
this->ProcessPShop6IFD ( buriedExif, kTIFF_PrimaryIFD );
this->ProcessPShop6IFD ( buriedExif, kTIFF_ExifIFD );
this->ProcessPShop6IFD ( buriedExif, kTIFF_GPSInfoIFD );
} // TIFF_FileWriter::IntegrateFromPShop6
// =================================================================================================
// TIFF_FileWriter::CopyTagToMasterIFD
// ===================================
//
// Create a new master IFD entry from a buried Photoshop 6 IFD entry. Don't try to get clever with
// large values, just create a new copy. This preserves a clean separation between the memory-based
// and file-based TIFF processing.
void* TIFF_FileWriter::CopyTagToMasterIFD ( const TagInfo & ps6Tag, InternalIFDInfo * masterIFD )
{
InternalTagMap::value_type mapValue ( ps6Tag.id, InternalTagInfo ( ps6Tag.id, ps6Tag.type, ps6Tag.count, this->fileParsed ) );
InternalTagMap::iterator newPos = masterIFD->tagMap.insert ( masterIFD->tagMap.end(), mapValue );
InternalTagInfo& newTag = newPos->second;
newTag.dataLen = ps6Tag.dataLen;
if ( newTag.dataLen <= 4 ) {
newTag.dataPtr = (XMP_Uns8*) &newTag.smallValue;
newTag.smallValue = *((XMP_Uns32*)ps6Tag.dataPtr);
} else {
newTag.dataPtr = (XMP_Uns8*) malloc ( newTag.dataLen );
if ( newTag.dataPtr == 0 ) XMP_Throw ( "Out of memory", kXMPErr_NoMemory );
memcpy ( newTag.dataPtr, ps6Tag.dataPtr, newTag.dataLen ); // AUDIT: Safe, malloc'ed dataLen bytes above.
}
newTag.changed = true; // ! See comments with ProcessPShop6IFD.
XMP_Assert ( (newTag.origDataLen == 0) && (newTag.origDataOffset == 0) );
masterIFD->changed = true;
return newPos->second.dataPtr; // ! Return the address within the map entry for small values.
} // TIFF_FileWriter::CopyTagToMasterIFD
// =================================================================================================
// FlipCFATable
// ============
//
// The CFA pattern table is trivial, a pair of short counts followed by n*m bytes.
static bool FlipCFATable ( void* voidPtr, XMP_Uns32 tagLen, GetUns16_Proc GetUns16 )
{
if ( tagLen < 4 ) return false;
XMP_Uns16* u16Ptr = (XMP_Uns16*)voidPtr;
Flip2 ( &u16Ptr[0] ); // Flip the counts to match the master TIFF.
Flip2 ( &u16Ptr[1] );
XMP_Uns16 columns = GetUns16 ( &u16Ptr[0] ); // Fetch using the master TIFF's routine.
XMP_Uns16 rows = GetUns16 ( &u16Ptr[1] );
if ( tagLen != (XMP_Uns32)(4 + columns*rows) ) return false;
return true;
} // FlipCFATable
// =================================================================================================
// FlipDSDTable
// ============
//
// The device settings description table is trivial, a pair of short counts followed by UTF-16
// strings. So the whole value should be flipped as a sequence of 16 bit items.
// ! The Exif 2.2 description is a bit garbled. It might be wrong. It would be nice to have a real example.
static bool FlipDSDTable ( void* voidPtr, XMP_Uns32 tagLen, GetUns16_Proc GetUns16 )
{
if ( tagLen < 4 ) return false;
XMP_Uns16* u16Ptr = (XMP_Uns16*)voidPtr;
for ( size_t i = tagLen/2; i > 0; --i, ++u16Ptr ) Flip2 ( u16Ptr );
return true;
} // FlipDSDTable
// =================================================================================================
// FlipOECFSFRTable
// ================
//
// The OECF and SFR tables have the same layout:
// 2 short counts, columns and rows
// c ASCII strings, null terminated, column names
// c*r rationals
static bool FlipOECFSFRTable ( void* voidPtr, XMP_Uns32 tagLen, GetUns16_Proc GetUns16 )
{
XMP_Uns16* u16Ptr = (XMP_Uns16*)voidPtr;
Flip2 ( &u16Ptr[0] ); // Flip the data to match the master TIFF.
Flip2 ( &u16Ptr[1] );
XMP_Uns16 columns = GetUns16 ( &u16Ptr[0] ); // Fetch using the master TIFF's routine.
XMP_Uns16 rows = GetUns16 ( &u16Ptr[1] );
XMP_Uns32 minLen = 4 + columns + (8 * columns * rows); // Minimum legit tag size.
if ( tagLen < minLen ) return false;
// Compute the start of the rationals from the end of value. No need to walk through the names.
XMP_Uns32* u32Ptr = (XMP_Uns32*) ((XMP_Uns8*)voidPtr + tagLen - (8 * columns * rows));
for ( size_t i = 2*columns*rows; i > 0; --i, ++u32Ptr ) Flip4 ( u32Ptr );
return true;
} // FlipOECFSFRTable
// =================================================================================================
// TIFF_FileWriter::ProcessPShop6IFD
// =================================
//
// Photoshop 6 wrote wacky TIFF files that have much of the Exif metadata buried inside of image
// resource 1058, which is itself within tag 34377 in the 0th IFD. This routine moves the buried
// tags up to the parent file. Existing tags are not replaced.
//
// While it is tempting to try to directly use the TIFF_MemoryReader's tweaked IFD info, making that
// visible would compromise implementation separation. Better to pay the modest runtime cost of
// using the official GetIFD method, letting it build the map.
//
// The tags that get moved are marked as being changed, as is the IFD they are moved into, but the
// overall TIFF_FileWriter object is not. We don't want this integration on its own to force a file
// update, but a file update should include these changes.
// ! Be careful to not move tags that are the nasty Exif explicit offsets, e.g. the Exif or GPS IFD
// ! "pointers". These are tags with a LONG type and count of 1, whose value is an offset into the
// ! buried TIFF stream. We can't reliably plant that offset into the outer IFD structure.
// ! To make things even more fun, the buried Exif might not have the same endianness as the outer!
void TIFF_FileWriter::ProcessPShop6IFD ( const TIFF_MemoryReader& buriedExif, XMP_Uns8 ifd )
{
bool ok, found;
TagInfoMap ps6IFD;
found = buriedExif.GetIFD ( ifd, &ps6IFD );
if ( ! found ) return;
bool needsFlipping = (this->bigEndian != buriedExif.IsBigEndian());
InternalIFDInfo* masterIFD = &this->containedIFDs[ifd];
TagInfoMap::const_iterator ps6Pos = ps6IFD.begin();
TagInfoMap::const_iterator ps6End = ps6IFD.end();
for ( ; ps6Pos != ps6End; ++ps6Pos ) {
// Copy buried tags to the master IFD if they don't already exist there.
const TagInfo& ps6Tag = ps6Pos->second;
if ( this->FindTagInIFD ( ifd, ps6Tag.id ) != 0 ) continue; // Keep existing master tags.
if ( needsFlipping && (ps6Tag.id == 37500) ) continue; // Don't copy an unflipped MakerNote.
if ( (ps6Tag.id == kTIFF_ExifIFDPointer) || // Skip the tags that are explicit offsets.
(ps6Tag.id == kTIFF_GPSInfoIFDPointer) ||
(ps6Tag.id == kTIFF_JPEGInterchangeFormat) ||
(ps6Tag.id == kTIFF_InteroperabilityIFDPointer) ) continue;
void* voidPtr = this->CopyTagToMasterIFD ( ps6Tag, masterIFD );
if ( needsFlipping ) {
switch ( ps6Tag.type ) {
case kTIFF_ByteType:
case kTIFF_SByteType:
case kTIFF_ASCIIType:
// Nothing more to do.
break;
case kTIFF_ShortType:
case kTIFF_SShortType:
{
XMP_Uns16* u16Ptr = (XMP_Uns16*)voidPtr;
for ( size_t i = ps6Tag.count; i > 0; --i, ++u16Ptr ) Flip2 ( u16Ptr );
}
break;
case kTIFF_LongType:
case kTIFF_SLongType:
case kTIFF_FloatType:
{
XMP_Uns32* u32Ptr = (XMP_Uns32*)voidPtr;
for ( size_t i = ps6Tag.count; i > 0; --i, ++u32Ptr ) Flip4 ( u32Ptr );
}
break;
case kTIFF_RationalType:
case kTIFF_SRationalType:
{
XMP_Uns32* ratPtr = (XMP_Uns32*)voidPtr;
for ( size_t i = (2 * ps6Tag.count); i > 0; --i, ++ratPtr ) Flip4 ( ratPtr );
}
break;
case kTIFF_DoubleType:
{
XMP_Uns64* u64Ptr = (XMP_Uns64*)voidPtr;
for ( size_t i = ps6Tag.count; i > 0; --i, ++u64Ptr ) Flip8 ( u64Ptr );
}
break;
case kTIFF_UndefinedType:
// Fix up the few kinds of special tables that Exif 2.2 defines.
ok = true; // Keep everything that isn't a special table.
if ( ps6Tag.id == kTIFF_CFAPattern ) {
ok = FlipCFATable ( voidPtr, ps6Tag.dataLen, this->GetUns16 );
} else if ( ps6Tag.id == kTIFF_DeviceSettingDescription ) {
ok = FlipDSDTable ( voidPtr, ps6Tag.dataLen, this->GetUns16 );
} else if ( (ps6Tag.id == kTIFF_OECF) || (ps6Tag.id == kTIFF_SpatialFrequencyResponse) ) {
ok = FlipOECFSFRTable ( voidPtr, ps6Tag.dataLen, this->GetUns16 );
}
if ( ! ok ) this->DeleteTag ( ifd, ps6Tag.id );
break;
default:
// ? XMP_Throw ( "Unexpected tag type", kXMPErr_InternalFailure );
this->DeleteTag ( ifd, ps6Tag.id );
break;
}
}
}
} // TIFF_FileWriter::ProcessPShop6IFD
// =================================================================================================
// TIFF_FileWriter::PreflightIFDLinkage
// ====================================
//
// Preflight special cases for the linkage between IFDs. Three of the IFDs are found through an
// explicit tag, the Exif, GPS, and Interop IFDs. The presence or absence of those IFDs affects the
// presence or absence of the linkage tag, which can affect the IFD containing the linkage tag. The
// thumbnail IFD is chained from the primary IFD, so if the thumbnail IFD is present we make sure
// that the primary IFD isn't empty.
void TIFF_FileWriter::PreflightIFDLinkage()
{
// Do the tag-linked IFDs bottom up, Interop then GPS then Exif.
if ( this->containedIFDs[kTIFF_InteropIFD].tagMap.empty() ) {
this->DeleteTag ( kTIFF_ExifIFD, kTIFF_InteroperabilityIFDPointer );
} else if ( ! this->GetTag ( kTIFF_ExifIFD, kTIFF_InteroperabilityIFDPointer, 0 ) ) {
this->SetTag_Long ( kTIFF_ExifIFD, kTIFF_InteroperabilityIFDPointer, 0xABADABAD );
}
if ( this->containedIFDs[kTIFF_GPSInfoIFD].tagMap.empty() ) {
this->DeleteTag ( kTIFF_PrimaryIFD, kTIFF_GPSInfoIFDPointer );
} else if ( ! this->GetTag ( kTIFF_PrimaryIFD, kTIFF_GPSInfoIFDPointer, 0 ) ) {
this->SetTag_Long ( kTIFF_PrimaryIFD, kTIFF_GPSInfoIFDPointer, 0xABADABAD );
}
if ( this->containedIFDs[kTIFF_ExifIFD].tagMap.empty() ) {
this->DeleteTag ( kTIFF_PrimaryIFD, kTIFF_ExifIFDPointer );
} else if ( ! this->GetTag ( kTIFF_PrimaryIFD, kTIFF_ExifIFDPointer, 0 ) ) {
this->SetTag_Long ( kTIFF_PrimaryIFD, kTIFF_ExifIFDPointer, 0xABADABAD );
}
// Make sure that the primary IFD is not empty if the thumbnail IFD is not empty.
if ( this->containedIFDs[kTIFF_PrimaryIFD].tagMap.empty() &&
(! this->containedIFDs[kTIFF_TNailIFD].tagMap.empty()) ) {
this->SetTag_Short ( kTIFF_PrimaryIFD, kTIFF_ResolutionUnit, 2 ); // Set Resolution unit to inches.
}
} // TIFF_FileWriter::PreflightIFDLinkage
// =================================================================================================
// TIFF_FileWriter::DetermineVisibleLength
// =======================================
XMP_Uns32 TIFF_FileWriter::DetermineVisibleLength()
{
XMP_Uns32 visibleLength = 8; // Start with the TIFF header size.
for ( int ifd = 0; ifd < kTIFF_KnownIFDCount; ++ifd ) {
InternalIFDInfo& ifdInfo ( this->containedIFDs[ifd] );
size_t tagCount = ifdInfo.tagMap.size();
if ( tagCount == 0 ) continue;
visibleLength += (XMP_Uns32)( 6 + (12 * tagCount) );
InternalTagMap::iterator tagPos = ifdInfo.tagMap.begin();
InternalTagMap::iterator tagEnd = ifdInfo.tagMap.end();
for ( ; tagPos != tagEnd; ++tagPos ) {
InternalTagInfo & currTag ( tagPos->second );
if ( currTag.dataLen > 4 ) visibleLength += ((currTag.dataLen + 1) & 0xFFFFFFFE); // ! Round to even lengths.
}
}
return visibleLength;
} // TIFF_FileWriter::DetermineVisibleLength
// =================================================================================================
// TIFF_FileWriter::DetermineAppendInfo
// ====================================
#ifndef Trace_DetermineAppendInfo
#define Trace_DetermineAppendInfo 0
#endif
XMP_Uns32 TIFF_FileWriter::DetermineAppendInfo ( XMP_Uns32 appendedOrigin,
bool appendedIFDs[kTIFF_KnownIFDCount],
XMP_Uns32 newIFDOffsets[kTIFF_KnownIFDCount],
bool appendAll /* = false */ )
{
XMP_Uns32 appendedLength = 0;
XMP_Assert ( (appendedOrigin & 1) == 0 ); // Make sure it is even.
#if Trace_DetermineAppendInfo
{
printf ( "\nEntering TIFF_FileWriter::DetermineAppendInfo%s\n", (appendAll ? ", append all" : "") );
for ( int ifd = 0; ifd < kTIFF_KnownIFDCount; ++ifd ) {
InternalIFDInfo & thisIFD = this->containedIFDs[ifd];
printf ( "\n IFD %d, origCount %d, map.size %d, origIFDOffset %d (0x%X), origNextIFD %d (0x%X)",
ifd, thisIFD.origCount, thisIFD.tagMap.size(),
thisIFD.origIFDOffset, thisIFD.origIFDOffset, thisIFD.origNextIFD, thisIFD.origNextIFD );
if ( thisIFD.changed ) printf ( ", changed" );
if ( thisIFD.origCount < thisIFD.tagMap.size() ) printf ( ", should get appended" );
printf ( "\n" );
InternalTagMap::iterator tagPos;
InternalTagMap::iterator tagEnd = thisIFD.tagMap.end();
for ( tagPos = thisIFD.tagMap.begin(); tagPos != tagEnd; ++tagPos ) {
InternalTagInfo & thisTag = tagPos->second;
printf ( " Tag %d, smallValue 0x%X, origDataLen %d, origDataOffset %d (0x%X)",
thisTag.id, thisTag.smallValue, thisTag.origDataLen, thisTag.origDataOffset, thisTag.origDataOffset );
if ( thisTag.changed ) printf ( ", changed" );
if ( (thisTag.dataLen > thisTag.origDataLen) && (thisTag.dataLen > 4) ) printf ( ", should get appended" );
printf ( "\n" );
}
}
printf ( "\n" );
}
#endif
// Determine which of the IFDs will be appended. If the Exif, GPS, or Interoperability IFDs are
// appended, set dummy values for their offsets in the "owning" IFD. This must be done first
// since this might cause the owning IFD to grow.
if ( ! appendAll ) {
for ( int i = 0; i < kTIFF_KnownIFDCount ;++i ) appendedIFDs[i] = false;
} else {
for ( int i = 0; i < kTIFF_KnownIFDCount ;++i ) appendedIFDs[i] = (this->containedIFDs[i].tagMap.size() > 0);
}
appendedIFDs[kTIFF_InteropIFD] |= (this->containedIFDs[kTIFF_InteropIFD].origCount <
this->containedIFDs[kTIFF_InteropIFD].tagMap.size());
if ( appendedIFDs[kTIFF_InteropIFD] ) {
this->SetTag_Long ( kTIFF_ExifIFD, kTIFF_InteroperabilityIFDPointer, 0xABADABAD );
}
appendedIFDs[kTIFF_GPSInfoIFD] |= (this->containedIFDs[kTIFF_GPSInfoIFD].origCount <
this->containedIFDs[kTIFF_GPSInfoIFD].tagMap.size());
if ( appendedIFDs[kTIFF_GPSInfoIFD] ) {
this->SetTag_Long ( kTIFF_PrimaryIFD, kTIFF_GPSInfoIFDPointer, 0xABADABAD );
}
appendedIFDs[kTIFF_ExifIFD] |= (this->containedIFDs[kTIFF_ExifIFD].origCount <
this->containedIFDs[kTIFF_ExifIFD].tagMap.size());
if ( appendedIFDs[kTIFF_ExifIFD] ) {
this->SetTag_Long ( kTIFF_PrimaryIFD, kTIFF_ExifIFDPointer, 0xABADABAD );
}
appendedIFDs[kTIFF_PrimaryIFD] |= (this->containedIFDs[kTIFF_PrimaryIFD].origCount <
this->containedIFDs[kTIFF_PrimaryIFD].tagMap.size());
// The appended data (if any) will be a sequence of an IFD followed by its large values.
// Determine the new offsets for the appended IFDs and tag values, and the total amount of
// appended stuff.
for ( int ifd = 0; ifd < kTIFF_KnownIFDCount ;++ifd ) {
InternalIFDInfo& ifdInfo ( this->containedIFDs[ifd] );
size_t tagCount = ifdInfo.tagMap.size();
if ( ! (appendAll | ifdInfo.changed) ) continue;
if ( tagCount == 0 ) continue;
newIFDOffsets[ifd] = ifdInfo.origIFDOffset;
if ( appendedIFDs[ifd] ) {
newIFDOffsets[ifd] = appendedOrigin + appendedLength;
appendedLength += (XMP_Uns32)( 6 + (12 * tagCount) );
}
InternalTagMap::iterator tagPos = ifdInfo.tagMap.begin();
InternalTagMap::iterator tagEnd = ifdInfo.tagMap.end();
for ( ; tagPos != tagEnd; ++tagPos ) {
InternalTagInfo & currTag ( tagPos->second );
if ( (! (appendAll | currTag.changed)) || (currTag.dataLen <= 4) ) continue;
if ( (currTag.dataLen <= currTag.origDataLen) && (! appendAll) ) {
this->PutUns32 ( currTag.origDataOffset, &currTag.smallValue ); // Reuse the old space.
} else {
this->PutUns32 ( (appendedOrigin + appendedLength), &currTag.smallValue ); // Set the appended offset.
appendedLength += ((currTag.dataLen + 1) & 0xFFFFFFFEUL); // Round to an even size.
}
}
}
// If the Exif, GPS, or Interoperability IFDs get appended, update the tag values for their new offsets.
if ( appendedIFDs[kTIFF_ExifIFD] ) {
this->SetTag_Long ( kTIFF_PrimaryIFD, kTIFF_ExifIFDPointer, newIFDOffsets[kTIFF_ExifIFD] );
}
if ( appendedIFDs[kTIFF_GPSInfoIFD] ) {
this->SetTag_Long ( kTIFF_PrimaryIFD, kTIFF_GPSInfoIFDPointer, newIFDOffsets[kTIFF_GPSInfoIFD] );
}
if ( appendedIFDs[kTIFF_InteropIFD] ) {
this->SetTag_Long ( kTIFF_ExifIFD, kTIFF_InteroperabilityIFDPointer, newIFDOffsets[kTIFF_InteropIFD] );
}
#if Trace_DetermineAppendInfo
{
printf ( "Exiting TIFF_FileWriter::DetermineAppendInfo\n" );
for ( int ifd = 0; ifd < kTIFF_KnownIFDCount; ++ifd ) {
InternalIFDInfo & thisIFD = this->containedIFDs[ifd];
printf ( "\n IFD %d, origCount %d, map.size %d, origIFDOffset %d (0x%X), origNextIFD %d (0x%X)",
ifd, thisIFD.origCount, thisIFD.tagMap.size(),
thisIFD.origIFDOffset, thisIFD.origIFDOffset, thisIFD.origNextIFD, thisIFD.origNextIFD );
if ( thisIFD.changed ) printf ( ", changed" );
if ( appendedIFDs[ifd] ) printf ( ", will be appended at %d (0x%X)", newIFDOffsets[ifd], newIFDOffsets[ifd] );
printf ( "\n" );
InternalTagMap::iterator tagPos;
InternalTagMap::iterator tagEnd = thisIFD.tagMap.end();
for ( tagPos = thisIFD.tagMap.begin(); tagPos != tagEnd; ++tagPos ) {
InternalTagInfo & thisTag = tagPos->second;
printf ( " Tag %d, smallValue 0x%X, origDataLen %d, origDataOffset %d (0x%X)",
thisTag.id, thisTag.smallValue, thisTag.origDataLen, thisTag.origDataOffset, thisTag.origDataOffset );
if ( thisTag.changed ) printf ( ", changed" );
if ( (thisTag.dataLen > thisTag.origDataLen) && (thisTag.dataLen > 4) ) {
XMP_Uns32 newOffset = this->GetUns32 ( &thisTag.smallValue );
printf ( ", will be appended at %d (0x%X)", newOffset, newOffset );
}
printf ( "\n" );
}
}
printf ( "\n" );
}
#endif
return appendedLength;
} // TIFF_FileWriter::DetermineAppendInfo
// =================================================================================================
// TIFF_FileWriter::UpdateMemByAppend
// ==================================
//
// Normally we update TIFF in a conservative "by-append" manner. Changes are written in-place where
// they fit, anything requiring growth is appended to the end and the old space is abandoned. The
// end for memory-based TIFF is the end of the data block, the end for file-based TIFF is the end of
// the file. This update-by-append model has the advantage of not perturbing any hidden offsets, a
// common feature of proprietary MakerNotes.
//
// When doing the update-by-append we're only going to be modifying things that have changed. This
// means IFDs with changed, added, or deleted tags, and large values for changed or added tags. The
// IFDs and tag values are updated in-place if they fit, leaving holes in the stream if the new
// value is smaller than the old.
// ** Someday we might want to use the FreeOffsets and FreeByteCounts tags to track free space.
// ** Probably not a huge win in practice though, and the TIFF spec says they are not recommended
// ** for general interchange use.
void TIFF_FileWriter::UpdateMemByAppend ( XMP_Uns8** newStream_out, XMP_Uns32* newLength_out,
bool appendAll /* = false */, XMP_Uns32 extraSpace /* = 0 */ )
{
bool appendedIFDs[kTIFF_KnownIFDCount];
XMP_Uns32 newIFDOffsets[kTIFF_KnownIFDCount];
XMP_Uns32 appendedOrigin = ((this->tiffLength + 1) & 0xFFFFFFFEUL); // Start at an even offset.
XMP_Uns32 appendedLength = DetermineAppendInfo ( appendedOrigin, appendedIFDs, newIFDOffsets, appendAll );
// Allocate the new block of memory for the full stream. Copy the original stream. Write the
// modified IFDs and values. Finally rebuild the internal IFD info and tag map.
XMP_Uns32 newLength = appendedOrigin + appendedLength;
XMP_Uns8* newStream = (XMP_Uns8*) malloc ( newLength + extraSpace );
if ( newStream == 0 ) XMP_Throw ( "Out of memory", kXMPErr_NoMemory );
memcpy ( newStream, this->memStream, this->tiffLength ); // AUDIT: Safe, malloc'ed newLength bytes above.
if ( this->tiffLength < appendedOrigin ) {
XMP_Assert ( appendedOrigin == (this->tiffLength + 1) );
newStream[this->tiffLength] = 0; // Clear the pad byte.
}
try { // We might get exceptions from the next part and must delete newStream on the way out.
// Write the modified IFDs and values. Rewrite the full IFD from scratch to make sure the
// tags are now unique and sorted. Copy large changed values to their appropriate location.
XMP_Uns32 appendedOffset = appendedOrigin;
for ( int ifd = 0; ifd < kTIFF_KnownIFDCount; ++ifd ) {
InternalIFDInfo& ifdInfo ( this->containedIFDs[ifd] );
size_t tagCount = ifdInfo.tagMap.size();
if ( ! (appendAll | ifdInfo.changed) ) continue;
if ( tagCount == 0 ) continue;
XMP_Uns8* ifdPtr = newStream + newIFDOffsets[ifd];
if ( appendedIFDs[ifd] ) {
XMP_Assert ( newIFDOffsets[ifd] == appendedOffset );
appendedOffset += (XMP_Uns32)( 6 + (12 * tagCount) );
}
this->PutUns16 ( (XMP_Uns16)tagCount, ifdPtr );
ifdPtr += 2;
InternalTagMap::iterator tagPos = ifdInfo.tagMap.begin();
InternalTagMap::iterator tagEnd = ifdInfo.tagMap.end();
for ( ; tagPos != tagEnd; ++tagPos ) {
InternalTagInfo & currTag ( tagPos->second );
this->PutUns16 ( currTag.id, ifdPtr );
ifdPtr += 2;
this->PutUns16 ( currTag.type, ifdPtr );
ifdPtr += 2;
this->PutUns32 ( currTag.count, ifdPtr );
ifdPtr += 4;
*((XMP_Uns32*)ifdPtr) = currTag.smallValue;
if ( (appendAll | currTag.changed) && (currTag.dataLen > 4) ) {
XMP_Uns32 valueOffset = this->GetUns32 ( &currTag.smallValue );
if ( (currTag.dataLen <= currTag.origDataLen) && (! appendAll) ) {
XMP_Assert ( valueOffset == currTag.origDataOffset );
} else {
XMP_Assert ( valueOffset == appendedOffset );
appendedOffset += ((currTag.dataLen + 1) & 0xFFFFFFFEUL);
}
if ( currTag.dataLen > (newLength - valueOffset) ) XMP_Throw ( "Buffer overrun", kXMPErr_InternalFailure );
memcpy ( (newStream + valueOffset), currTag.dataPtr, currTag.dataLen ); // AUDIT: Protected by the above check.
if ( (currTag.dataLen & 1) != 0 ) newStream[valueOffset+currTag.dataLen] = 0;
}
ifdPtr += 4;
}
this->PutUns32 ( ifdInfo.origNextIFD, ifdPtr );
ifdPtr += 4;
}
XMP_Assert ( appendedOffset == newLength );
// Back fill the offsets for the primary and thumnbail IFDs, if they are now appended.
if ( appendedIFDs[kTIFF_PrimaryIFD] ) {
this->PutUns32 ( newIFDOffsets[kTIFF_PrimaryIFD], (newStream + 4) );
}
} catch ( ... ) {
free ( newStream );
throw;
}
*newStream_out = newStream;
*newLength_out = newLength;
} // TIFF_FileWriter::UpdateMemByAppend
// =================================================================================================
// TIFF_FileWriter::UpdateMemByRewrite
// ===================================
//
// Normally we update TIFF in a conservative "by-append" manner. Changes are written in-place where
// they fit, anything requiring growth is appended to the end and the old space is abandoned. The
// end for memory-based TIFF is the end of the data block, the end for file-based TIFF is the end of
// the file. This update-by-append model has the advantage of not perturbing any hidden offsets, a
// common feature of proprietary MakerNotes.
//
// The condenseStream parameter can be used to rewrite the full stream instead of appending. This
// will discard any MakerNote tag and risks breaking offsets that are hidden. This can be necessary
// though to try to make the TIFF fit in a JPEG file.
//
// We don't do most of the actual rewrite here. We set things up so that UpdateMemByAppend can be
// called to append onto a bare TIFF header. Additional hidden offsets are then handled here.
//
// These tags are recognized as being hidden offsets when composing a condensed stream:
// 273 - StripOffsets, lengths in tag 279
// 288 - FreeOffsets, lengths in tag 289
// 324 - TileOffsets, lengths in tag 325
// 330 - SubIFDs, lengths within the IFDs (Plus subIFD values and possible chaining!)
// 513 - JPEGInterchangeFormat, length in tag 514
// 519 - JPEGQTables, each table is 64 bytes
// 520 - JPEGDCTables, lengths ???
// 521 - JPEGACTables, lengths ???
// Some of these will handled and kept, some will be thrown out, some will cause the rewrite to fail.
//
// The hidden offsets for the Exif, GPS, and Interoperability IFDs (tags 34665, 34853, and 40965)
// are handled by the code in DetermineAppendInfo, which is called from UpdateMemByAppend, which is
// called from here.
// ! So far, a memory-based TIFF rewrite would only be done for the Exif portion of a JPEG file.
// ! In which case we're probably OK to handle JPEGInterchangeFormat (used for compressed thumbnails)
// ! and complain about any of the other hidden offset tags.
// tag count type
// 273 n short or long
// 279 n short or long
// 288 n long
// 289 n long
// 324 n long
// 325 n short or long
// 330 n long
// 513 1 long
// 514 1 long
// 519 n long
// 520 n long
// 521 n long
static XMP_Uns16 kNoGoTags[] =
{
kTIFF_StripOffsets, // 273 *** Should be handled?
kTIFF_StripByteCounts, // 279 *** Should be handled?
kTIFF_FreeOffsets, // 288 *** Should be handled?
kTIFF_FreeByteCounts, // 289 *** Should be handled?
kTIFF_TileOffsets, // 324 *** Should be handled?
kTIFF_TileByteCounts, // 325 *** Should be handled?
kTIFF_SubIFDs, // 330 *** Should be handled?
kTIFF_JPEGQTables, // 519
kTIFF_JPEGDCTables, // 520
kTIFF_JPEGACTables, // 521
0xFFFF // Must be last as a sentinel.
};
static XMP_Uns16 kBanishedTags[] =
{
kTIFF_MakerNote, // *** Should someday support MakerNoteSafety.
0xFFFF // Must be last as a sentinel.
};
struct SimpleHiddenContentInfo {
XMP_Uns8 ifd;
XMP_Uns16 offsetTag, lengthTag;
};
struct SimpleHiddenContentLocations {
XMP_Uns32 length, oldOffset, newOffset;
SimpleHiddenContentLocations() : length(0), oldOffset(0), newOffset(0) {};
};
enum { kSimpleHiddenContentCount = 1 };
static const SimpleHiddenContentInfo kSimpleHiddenContentInfo [kSimpleHiddenContentCount] =
{
{ kTIFF_TNailIFD, kTIFF_JPEGInterchangeFormat, kTIFF_JPEGInterchangeFormatLength }
};
// -------------------------------------------------------------------------------------------------
void TIFF_FileWriter::UpdateMemByRewrite ( XMP_Uns8** newStream_out, XMP_Uns32* newLength_out )
{
const InternalTagInfo* tagInfo;
// Check for tags that we don't tolerate because they have data we can't (or refuse to) find.
for ( XMP_Uns8 ifd = 0; ifd < kTIFF_KnownIFDCount; ++ifd ) {
for ( int i = 0; kNoGoTags[i] != 0xFFFF; ++i ) {
tagInfo = this->FindTagInIFD ( ifd, kNoGoTags[i] );
if ( tagInfo != 0 ) XMP_Throw ( "Tag not tolerated for TIFF rewrite", kXMPErr_Unimplemented );
}
}
// Delete unwanted tags.
for ( XMP_Uns8 ifd = 0; ifd < kTIFF_KnownIFDCount; ++ifd ) {
for ( int i = 0; kBanishedTags[i] != 0xFFFF; ++i ) {
this->DeleteTag ( ifd, kBanishedTags[i] );
}
}
// Determine the offsets and additional size for the hidden offset content. Set the offset tags
// to the new offset.
XMP_Uns32 hiddenContentLength = 0;
XMP_Uns32 hiddenContentOrigin = this->DetermineVisibleLength();
SimpleHiddenContentLocations hiddenLocations [kSimpleHiddenContentCount];
for ( int i = 0; i < kSimpleHiddenContentCount; ++i ) {
const SimpleHiddenContentInfo & hiddenInfo ( kSimpleHiddenContentInfo[i] );
bool haveLength = this->GetTag_Integer ( hiddenInfo.ifd, hiddenInfo.lengthTag, &hiddenLocations[i].length );
bool haveOffset = this->GetTag_Integer ( hiddenInfo.ifd, hiddenInfo.offsetTag, &hiddenLocations[i].oldOffset );
if ( haveLength != haveOffset ) XMP_Throw ( "Unpaired simple hidden content tag", kXMPErr_BadTIFF );
if ( (! haveLength) || (hiddenLocations[i].length == 0) ) continue;
hiddenLocations[i].newOffset = hiddenContentOrigin + hiddenContentLength;
this->SetTag_Long ( hiddenInfo.ifd, hiddenInfo.offsetTag, hiddenLocations[i].newOffset );
hiddenContentLength += ((hiddenLocations[i].length + 1) & 0xFFFFFFFE); // ! Round up for even offsets.
}
// Save any old memory stream for the content behind hidden offsets. Setup a bare TIFF header.
XMP_Uns8* oldStream = this->memStream;
XMP_Uns8 bareTIFF [8];
if ( this->bigEndian ) {
bareTIFF[0] = 0x4D; bareTIFF[1] = 0x4D; bareTIFF[2] = 0x00; bareTIFF[3] = 0x2A;
} else {
bareTIFF[0] = 0x49; bareTIFF[1] = 0x49; bareTIFF[2] = 0x2A; bareTIFF[3] = 0x00;
}
*((XMP_Uns32*)&bareTIFF[4]) = 0;
this->memStream = &bareTIFF[0];
this->tiffLength = sizeof ( bareTIFF );
this->ownedStream = false;
// Call UpdateMemByAppend to write the new stream, telling it to append everything.
this->UpdateMemByAppend ( newStream_out, newLength_out, true, hiddenContentLength );
// Copy the hidden content and update the output stream length;
XMP_Assert ( *newLength_out == hiddenContentOrigin );
*newLength_out += hiddenContentLength;
for ( int i = 0; i < kSimpleHiddenContentCount; ++i ) {
if ( hiddenLocations[i].length == 0 ) continue;
XMP_Uns8* srcPtr = oldStream + hiddenLocations[i].oldOffset;
XMP_Uns8* destPtr = *newStream_out + hiddenLocations[i].newOffset;
memcpy ( destPtr, srcPtr, hiddenLocations[i].length ); // AUDIT: Safe copy, not user data, computed length.
}
} // TIFF_FileWriter::UpdateMemByRewrite
// =================================================================================================
// TIFF_FileWriter::UpdateMemoryStream
// ===================================
//
// Normally we update TIFF in a conservative "by-append" manner. Changes are written in-place where
// they fit, anything requiring growth is appended to the end and the old space is abandoned. The
// end for memory-based TIFF is the end of the data block, the end for file-based TIFF is the end of
// the file. This update-by-append model has the advantage of not perturbing any hidden offsets, a
// common feature of proprietary MakerNotes.
//
// The condenseStream parameter can be used to rewrite the full stream instead of appending. This
// will discard any MakerNote tags and risks breaking offsets that are hidden. This can be necessary
// though to try to make the TIFF fit in a JPEG file.
XMP_Uns32 TIFF_FileWriter::UpdateMemoryStream ( void** dataPtr, bool condenseStream /* = false */ )
{
if ( this->fileParsed ) XMP_Throw ( "Not memory based", kXMPErr_EnforceFailure );
if ( ! this->changed ) {
if ( dataPtr != 0 ) *dataPtr = this->memStream;
return this->tiffLength;
}
this->PreflightIFDLinkage();
bool nowEmpty = true;
for ( size_t i = 0; i < kTIFF_KnownIFDCount; ++i ) {
if ( ! this->containedIFDs[i].tagMap.empty() ) {
nowEmpty = false;
break;
}
}
XMP_Uns8* newStream = 0;
XMP_Uns32 newLength = 0;
if ( nowEmpty ) {
this->DeleteExistingInfo(); // Prepare for an empty reparse.
} else {
if ( this->tiffLength == 0 ) { // ! An empty parse does set this->memParsed.
condenseStream = true; // Makes "conjured" TIFF take the full rewrite path.
}
if ( condenseStream ) this->changed = true; // A prior regular call would have cleared this->changed.
if ( condenseStream ) {
this->UpdateMemByRewrite ( &newStream, &newLength );
} else {
this->UpdateMemByAppend ( &newStream, &newLength );
}
}
// Parse the revised stream. This is the cleanest way to rebuild the tag map.
this->ParseMemoryStream ( newStream, newLength, kDoNotCopyData );
XMP_Assert ( this->tiffLength == newLength );
this->ownedStream = (newLength > 0); // ! We really do own the new stream, if not empty.
if ( dataPtr != 0 ) *dataPtr = this->memStream;
return newLength;
} // TIFF_FileWriter::UpdateMemoryStream
// =================================================================================================
// TIFF_FileWriter::UpdateFileStream
// =================================
//
// Updating a file stream is done in the same general manner as updating a memory stream, the intro
// comments for UpdateMemoryStream largely apply. The file update happens in 3 phases:
// 1. Determine which IFDs will be appended, and the new offsets for the appended IFDs and tags.
// 2. Do the in-place update for the IFDs and tag values that fit.
// 3. Append the IFDs and tag values that grow.
//
// The file being updated must match the file that was previously parsed. Offsets and lengths saved
// when parsing are used to decide if something can be updated in-place or must be appended.
// *** The general linked structure of TIFF makes it very difficult to process the file in a single
// *** sequential pass. This implementation uses a simple seek/write model for the in-place updates.
// *** In the future we might want to consider creating a map of what gets updated, allowing use of
// *** a possibly more efficient buffered model.
// ** Someday we might want to use the FreeOffsets and FreeByteCounts tags to track free space.
// ** Probably not a huge win in practice though, and the TIFF spec says they are not recommended
// ** for general interchange use.
#ifndef Trace_UpdateFileStream
#define Trace_UpdateFileStream 0
#endif
void TIFF_FileWriter::UpdateFileStream ( LFA_FileRef fileRef )
{
if ( this->memParsed ) XMP_Throw ( "Not file based", kXMPErr_EnforceFailure );
if ( ! this->changed ) return;
XMP_Int64 origDataLength = LFA_Measure ( fileRef );
if ( (origDataLength >> 32) != 0 ) XMP_Throw ( "TIFF files can't exceed 4GB", kXMPErr_BadTIFF );
bool appendedIFDs[kTIFF_KnownIFDCount];
XMP_Uns32 newIFDOffsets[kTIFF_KnownIFDCount];
#if Trace_UpdateFileStream
printf ( "\nStarting update of TIFF file stream\n" );
#endif
XMP_Uns32 appendedOrigin = (XMP_Uns32)origDataLength;
if ( (appendedOrigin & 1) != 0 ) {
++appendedOrigin; // Start at an even offset.
LFA_Seek ( fileRef, 0, SEEK_END );
LFA_Write ( fileRef, "\0", 1 );
}
this->PreflightIFDLinkage();
XMP_Uns32 appendedLength = DetermineAppendInfo ( appendedOrigin, appendedIFDs, newIFDOffsets );
if ( appendedLength > (0xFFFFFFFFUL - appendedOrigin) ) XMP_Throw ( "TIFF files can't exceed 4GB", kXMPErr_BadTIFF );
// Do the in-place update for the IFDs and tag values that fit. This part does separate seeks
// and writes for the IFDs and values. Things to be updated can be anywhere in the file.
// *** This might benefit from a map of the in-place updates. This would allow use of a possibly
// *** more efficient sequential I/O model. Could even incorporate the safe update file copying.
for ( int ifd = 0; ifd < kTIFF_KnownIFDCount; ++ifd ) {
InternalIFDInfo & thisIFD = this->containedIFDs[ifd];
if ( ! thisIFD.changed ) continue;
// In order to get a little bit of locality, write the IFD first then the changed tags that
// have large values and fit in-place.
if ( ! appendedIFDs[ifd] ) {
#if Trace_UpdateFileStream
printf ( " Updating IFD %d in-place at offset %d (0x%X)\n", ifd, thisIFD.origIFDOffset, thisIFD.origIFDOffset );
#endif
LFA_Seek ( fileRef, thisIFD.origIFDOffset, SEEK_SET );
this->WriteFileIFD ( fileRef, thisIFD );
}
InternalTagMap::iterator tagPos;
InternalTagMap::iterator tagEnd = thisIFD.tagMap.end();
for ( tagPos = thisIFD.tagMap.begin(); tagPos != tagEnd; ++tagPos ) {
InternalTagInfo & thisTag = tagPos->second;
if ( (! thisTag.changed) || (thisTag.dataLen <= 4) || (thisTag.dataLen > thisTag.origDataLen) ) continue;
#if Trace_UpdateFileStream
printf ( " Updating tag %d in IFD %d in-place at offset %d (0x%X)\n", thisTag.id, ifd, thisTag.origDataOffset, thisTag.origDataOffset );
#endif
LFA_Seek ( fileRef, thisTag.origDataOffset, SEEK_SET );
LFA_Write ( fileRef, thisTag.dataPtr, thisTag.dataLen );
}
}
// Append the IFDs and tag values that grow.
XMP_Int64 fileEnd = LFA_Seek ( fileRef, 0, SEEK_END );
XMP_Assert ( fileEnd == appendedOrigin );
for ( int ifd = 0; ifd < kTIFF_KnownIFDCount; ++ifd ) {
InternalIFDInfo & thisIFD = this->containedIFDs[ifd];
if ( ! thisIFD.changed ) continue;
if ( appendedIFDs[ifd] ) {
#if Trace_UpdateFileStream
printf ( " Updating IFD %d by append at offset %d (0x%X)\n", ifd, newIFDOffsets[ifd], newIFDOffsets[ifd] );
#endif
XMP_Assert ( newIFDOffsets[ifd] == LFA_Measure(fileRef) );
this->WriteFileIFD ( fileRef, thisIFD );
}
InternalTagMap::iterator tagPos;
InternalTagMap::iterator tagEnd = thisIFD.tagMap.end();
for ( tagPos = thisIFD.tagMap.begin(); tagPos != tagEnd; ++tagPos ) {
InternalTagInfo & thisTag = tagPos->second;
if ( (! thisTag.changed) || (thisTag.dataLen <= 4) || (thisTag.dataLen <= thisTag.origDataLen) ) continue;
#if Trace_UpdateFileStream
XMP_Uns32 newOffset = this->GetUns32(&thisTag.origDataOffset);
printf ( " Updating tag %d in IFD %d by append at offset %d (0x%X)\n", thisTag.id, ifd, newOffset, newOffset );
#endif
XMP_Assert ( this->GetUns32(&thisTag.smallValue) == LFA_Measure(fileRef) );
LFA_Write ( fileRef, thisTag.dataPtr, thisTag.dataLen );
if ( (thisTag.dataLen & 1) != 0 ) LFA_Write ( fileRef, "\0", 1 );
}
}
// Back-fill the offset for the primary IFD, if it is now appended.
XMP_Uns32 newOffset;
if ( appendedIFDs[kTIFF_PrimaryIFD] ) {
this->PutUns32 ( newIFDOffsets[kTIFF_PrimaryIFD], &newOffset );
#if TraceUpdateFileStream
printf ( " Back-filling offset of primary IFD, pointing to %d (0x%X)\n", newOffset, newOffset );
#endif
LFA_Seek ( fileRef, 4, SEEK_SET );
LFA_Write ( fileRef, &newOffset, 4 );
}
// Reset the changed flags and original length/offset values. This simulates a reparse of the
// updated file.
for ( int ifd = 0; ifd < kTIFF_KnownIFDCount; ++ifd ) {
InternalIFDInfo & thisIFD = this->containedIFDs[ifd];
if ( ! thisIFD.changed ) continue;
thisIFD.changed = false;
thisIFD.origCount = (XMP_Uns16)( thisIFD.tagMap.size() );
thisIFD.origIFDOffset = newIFDOffsets[ifd];
InternalTagMap::iterator tagPos;
InternalTagMap::iterator tagEnd = thisIFD.tagMap.end();
for ( tagPos = thisIFD.tagMap.begin(); tagPos != tagEnd; ++tagPos ) {
InternalTagInfo & thisTag = tagPos->second;
if ( ! thisTag.changed ) continue;
thisTag.changed = false;
thisTag.origDataLen = thisTag.dataLen;
if ( thisTag.origDataLen > 4 ) thisTag.origDataOffset = this->GetUns32 ( &thisTag.smallValue );
}
}
this->tiffLength = (XMP_Uns32) LFA_Measure ( fileRef );
LFA_Seek ( fileRef, 0, SEEK_END ); // Can't hurt.
#if Trace_UpdateFileStream
printf ( "\nFinished update of TIFF file stream\n" );
#endif
} // TIFF_FileWriter::UpdateFileStream
// =================================================================================================
// TIFF_FileWriter::WriteFileIFD
// =============================
void TIFF_FileWriter::WriteFileIFD ( LFA_FileRef fileRef, InternalIFDInfo & thisIFD )
{
XMP_Uns16 tagCount;
this->PutUns16 ( (XMP_Uns16)thisIFD.tagMap.size(), &tagCount );
LFA_Write ( fileRef, &tagCount, 2 );
InternalTagMap::iterator tagPos;
InternalTagMap::iterator tagEnd = thisIFD.tagMap.end();
for ( tagPos = thisIFD.tagMap.begin(); tagPos != tagEnd; ++tagPos ) {
InternalTagInfo & thisTag = tagPos->second;
RawIFDEntry ifdEntry;
this->PutUns16 ( thisTag.id, &ifdEntry.id );
this->PutUns16 ( thisTag.type, &ifdEntry.type );
this->PutUns32 ( thisTag.count, &ifdEntry.count );
ifdEntry.dataOrOffset = thisTag.smallValue; // ! Already in stream endianness.
LFA_Write ( fileRef, &ifdEntry, sizeof(ifdEntry) );
XMP_Assert ( sizeof(ifdEntry) == 12 );
}
XMP_Uns32 nextIFD;
this->PutUns32 ( thisIFD.origNextIFD, &nextIFD );
LFA_Write ( fileRef, &nextIFD, 4 );
} // TIFF_FileWriter::WriteFileIFD
|