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 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453
|
/*
libheif example application "heif".
MIT License
Copyright (c) 2017 Dirk Farin <dirk.farin@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
#include <cassert>
#include <cerrno>
#include <cstring>
#include <getopt.h>
#include <fstream>
#include <iostream>
#include <iomanip>
#include <memory>
#include <algorithm>
#include <vector>
#include <string>
#include <sstream>
#include <filesystem>
#include <regex>
#include <optional>
#include <libheif/heif.h>
#include <libheif/heif_properties.h>
#include "libheif/heif_items.h"
#include "heifio/decoder_jpeg.h"
#include "heifio/decoder_png.h"
#include "heifio/decoder_tiff.h"
#include "heifio/decoder_y4m.h"
#include "benchmark.h"
#include "common.h"
#include "SAI_datafile.h"
#include "libheif/api_structs.h"
#include "libheif/heif_experimental.h"
#include "libheif/heif_sequences.h"
#include "libheif/heif_uncompressed.h"
// --- command line parameters
int master_alpha = 1;
int thumb_alpha = 1;
int list_encoders = 0;
int two_colr_boxes = 0;
int premultiplied_alpha = 0;
int run_benchmark = 0;
heif_metadata_compression metadata_compression_method = heif_metadata_compression_off;
int tiled_input_x_y = 0;
const char* encoderId = nullptr;
std::string chroma_downsampling;
int cut_tiles = 0;
int tiled_image_width = 0;
int tiled_image_height = 0;
std::string tiling_method = "grid";
heif_unci_compression unci_compression = heif_unci_compression_brotli;
int add_pyramid_group = 0;
uint16_t nclx_colour_primaries = 1;
uint16_t nclx_transfer_characteristic = 13;
uint16_t nclx_matrix_coefficients = 6;
int nclx_full_range = true;
std::optional<heif_content_light_level> clli;
struct pixel_aspect_ratio
{
uint32_t h,v;
};
std::optional<pixel_aspect_ratio> pasp;
// default to 30 fps
uint32_t sequence_timebase = 30;
uint32_t sequence_durations = 1;
uint32_t sequence_repetitions = 1;
std::string vmt_metadata_file;
bool binary_metadata_track = false;
std::string metadata_track_uri = "vmt:metadata";
int quality = 50;
bool lossless = false;
std::string output_filename;
int logging_level = 0;
bool option_show_parameters = false;
int thumbnail_bbox_size = 0;
int output_bit_depth = 10;
bool force_enc_av1f = false;
bool force_enc_avc = false;
bool force_enc_hevc = false;
bool force_enc_vvc = false;
bool force_enc_uncompressed = false;
bool force_enc_jpeg = false;
bool force_enc_jpeg2000 = false;
bool force_enc_htj2k = false;
bool use_tiling = false;
bool encode_sequence = false;
bool use_video_handler = false;
std::string option_mime_item_type;
std::string option_mime_item_file;
std::string option_mime_item_name;
enum heif_sequence_gop_structure sequence_gop_structure = heif_sequence_gop_structure_lowdelay;
int sequence_keyframe_distance_min = 0;
int sequence_keyframe_distance_max = 0;
int sequence_max_frames = 0; // 0 -> no maximum
std::string option_gimi_track_id;
std::string option_sai_data_file;
enum heif_output_nclx_color_profile_preset
{
heif_output_nclx_color_profile_preset_custom, // Default. Use the values provided by the user.
heif_output_nclx_color_profile_preset_automatic, // Choose the profile depending on the input.
heif_output_nclx_color_profile_preset_compatible, // Choose a profile that is decoded correctly by most systems.
heif_output_nclx_color_profile_preset_Rec_601, // SD / JPEG / MPEG
heif_output_nclx_color_profile_preset_Rec_709, // HDTV / (sRGB)
heif_output_nclx_color_profile_preset_Rec_2020 // UHDTV
};
heif_output_nclx_color_profile_preset output_color_profile_preset = heif_output_nclx_color_profile_preset_custom;
std::string property_pitm_description;
// for benchmarking
#if !defined(_MSC_VER)
#define HAVE_GETTIMEOFDAY 1 // TODO: should be set by CMake
#endif
#if HAVE_GETTIMEOFDAY
#include <sys/time.h>
timeval time_encoding_start;
timeval time_encoding_end;
#endif
const int OPTION_NCLX_MATRIX_COEFFICIENTS = 1000;
const int OPTION_NCLX_COLOUR_PRIMARIES = 1001;
const int OPTION_NCLX_TRANSFER_CHARACTERISTIC = 1002;
const int OPTION_NCLX_FULL_RANGE_FLAG = 1003;
const int OPTION_PLUGIN_DIRECTORY = 1004;
const int OPTION_PITM_DESCRIPTION = 1005;
const int OPTION_USE_JPEG_COMPRESSION = 1006;
const int OPTION_USE_JPEG2000_COMPRESSION = 1007;
const int OPTION_VERBOSE = 1008;
const int OPTION_USE_HTJ2K_COMPRESSION = 1009;
const int OPTION_USE_VVC_COMPRESSION = 1010;
const int OPTION_TILED_IMAGE_WIDTH = 1011;
const int OPTION_TILED_IMAGE_HEIGHT = 1012;
const int OPTION_TILING_METHOD = 1013;
const int OPTION_UNCI_COMPRESSION = 1014;
const int OPTION_CUT_TILES = 1015;
const int OPTION_SEQUENCES_TIMEBASE = 1016;
const int OPTION_SEQUENCES_DURATIONS = 1017;
const int OPTION_SEQUENCES_FPS = 1018;
const int OPTION_VMT_METADATA_FILE = 1019;
const int OPTION_SEQUENCES_REPETITIONS = 1020;
const int OPTION_COLOR_PROFILE_PRESET = 1021;
const int OPTION_SET_CLLI = 1022;
const int OPTION_SET_PASP = 1023;
const int OPTION_SEQUENCES_GOP_STRUCTURE = 1024;
const int OPTION_SEQUENCES_MIN_KEYFRAME_DISTANCE = 1025;
const int OPTION_SEQUENCES_MAX_KEYFRAME_DISTANCE = 1026;
const int OPTION_SEQUENCES_MAX_FRAMES = 1027;
const int OPTION_USE_AVC_COMPRESSION = 1028;
const int OPTION_BINARY_METADATA_TRACK = 1029;
const int OPTION_METADATA_TRACK_URI = 1030;
const int OPTION_ADD_MIME_ITEM = 1031;
const int OPTION_MIME_ITEM_FILE = 1032;
const int OPTION_MIME_ITEM_NAME = 1033;
const int OPTION_METADATA_COMPRESSION = 1034;
const int OPTION_SEQUENCES_GIMI_TRACK_ID = 1035;
const int OPTION_SEQUENCES_SAI_DATA_FILE = 1036;
const int OPTION_USE_HEVC_COMPRESSION = 1037;
static option long_options[] = {
{(char* const) "help", no_argument, 0, 'h'},
{(char* const) "version", no_argument, 0, 'v'},
{(char* const) "quality", required_argument, 0, 'q'},
{(char* const) "output", required_argument, 0, 'o'},
{(char* const) "lossless", no_argument, 0, 'L'},
{(char* const) "thumb", required_argument, 0, 't'},
{(char* const) "verbose", no_argument, 0, OPTION_VERBOSE},
{(char* const) "params", no_argument, 0, 'P'},
{(char* const) "no-alpha", no_argument, &master_alpha, 0},
{(char* const) "no-thumb-alpha", no_argument, &thumb_alpha, 0},
{(char* const) "list-encoders", no_argument, &list_encoders, 1},
{(char* const) "encoder", required_argument, 0, 'e'},
{(char* const) "bit-depth", required_argument, 0, 'b'},
{(char* const) "even-size", no_argument, 0, 'E'},
{(char* const) "avif", no_argument, 0, 'A'},
{(char* const) "hevc", no_argument, 0, OPTION_USE_HEVC_COMPRESSION},
{(char* const) "vvc", no_argument, 0, OPTION_USE_VVC_COMPRESSION},
{(char* const) "avc", no_argument, 0, OPTION_USE_AVC_COMPRESSION},
{(char* const) "jpeg", no_argument, 0, OPTION_USE_JPEG_COMPRESSION},
{(char* const) "jpeg2000", no_argument, 0, OPTION_USE_JPEG2000_COMPRESSION},
{(char* const) "htj2k", no_argument, 0, OPTION_USE_HTJ2K_COMPRESSION},
#if WITH_UNCOMPRESSED_CODEC
{(char* const) "uncompressed", no_argument, 0, 'U'},
{(char* const) "unci-compression-method", required_argument, nullptr, OPTION_UNCI_COMPRESSION},
#endif
{(char* const) "color-profile", required_argument, 0, OPTION_COLOR_PROFILE_PRESET},
{(char* const) "matrix_coefficients", required_argument, 0, OPTION_NCLX_MATRIX_COEFFICIENTS},
{(char* const) "colour_primaries", required_argument, 0, OPTION_NCLX_COLOUR_PRIMARIES},
{(char* const) "transfer_characteristic", required_argument, 0, OPTION_NCLX_TRANSFER_CHARACTERISTIC},
{(char* const) "full_range_flag", required_argument, 0, OPTION_NCLX_FULL_RANGE_FLAG},
{(char* const) "enable-two-colr-boxes", no_argument, &two_colr_boxes, 1},
{(char* const) "clli", required_argument, 0, OPTION_SET_CLLI},
{(char* const) "pasp", required_argument, 0, OPTION_SET_PASP},
{(char* const) "premultiplied-alpha", no_argument, &premultiplied_alpha, 1},
{(char* const) "plugin-directory", required_argument, 0, OPTION_PLUGIN_DIRECTORY},
{(char* const) "benchmark", no_argument, &run_benchmark, 1},
{(char* const) "enable-metadata-compression", required_argument, 0, OPTION_METADATA_COMPRESSION},
{(char* const) "pitm-description", required_argument, 0, OPTION_PITM_DESCRIPTION},
{(char* const) "chroma-downsampling", required_argument, 0, 'C'},
{(char* const) "cut-tiles", required_argument, nullptr, OPTION_CUT_TILES},
{(char* const) "tiled-input", no_argument, 0, 'T'},
{(char* const) "tiled-image-width", required_argument, nullptr, OPTION_TILED_IMAGE_WIDTH},
{(char* const) "tiled-image-height", required_argument, nullptr, OPTION_TILED_IMAGE_HEIGHT},
{(char* const) "tiled-input-x-y", no_argument, &tiled_input_x_y, 1},
{(char* const) "tiling-method", required_argument, nullptr, OPTION_TILING_METHOD},
{(char* const) "add-pyramid-group", no_argument, &add_pyramid_group, 1},
{(char* const) "sequence", no_argument, 0, 'S'},
{(char* const) "video", no_argument, 0, 'V'},
{(char* const) "timebase", required_argument, nullptr, OPTION_SEQUENCES_TIMEBASE},
{(char* const) "duration", required_argument, nullptr, OPTION_SEQUENCES_DURATIONS},
{(char* const) "fps", required_argument, nullptr, OPTION_SEQUENCES_FPS},
{(char* const) "repetitions", required_argument, nullptr, OPTION_SEQUENCES_REPETITIONS},
{(char* const) "max-frames", required_argument, nullptr, OPTION_SEQUENCES_MAX_FRAMES},
#if HEIF_ENABLE_EXPERIMENTAL_FEATURES
{(char* const) "vmt-metadata", required_argument, nullptr, OPTION_VMT_METADATA_FILE},
{(char* const) "binary-metadata-track", no_argument, nullptr, OPTION_BINARY_METADATA_TRACK},
{(char* const) "metadata-track-uri", required_argument, nullptr, OPTION_METADATA_TRACK_URI},
{(char* const) "add-mime-item", required_argument, nullptr, OPTION_ADD_MIME_ITEM},
{(char* const) "mime-item-file", required_argument, nullptr, OPTION_MIME_ITEM_FILE},
{(char* const) "mime-item-name", required_argument, nullptr, OPTION_MIME_ITEM_NAME},
#endif
{(char* const) "gop-structure", required_argument, nullptr, OPTION_SEQUENCES_GOP_STRUCTURE},
{(char* const) "min-keyframe-distance", required_argument, nullptr, OPTION_SEQUENCES_MIN_KEYFRAME_DISTANCE},
{(char* const) "max-keyframe-distance", required_argument, nullptr, OPTION_SEQUENCES_MAX_KEYFRAME_DISTANCE},
{(char* const) "set-gimi-track-id", required_argument, nullptr, OPTION_SEQUENCES_GIMI_TRACK_ID},
{(char* const) "sai-data-file", required_argument, nullptr, OPTION_SEQUENCES_SAI_DATA_FILE},
{0, 0, 0, 0}
};
void show_help(const char* argv0)
{
std::filesystem::path p(argv0);
std::string filename = p.filename().string();
std::stringstream sstr;
sstr << " " << filename << " libheif version: " << heif_get_version();
std::string title = sstr.str();
std::cerr << title << "\n"
<< std::string(title.length() + 1, '-') << "\n"
<< "Usage: " << filename << " [options] <input-image> ...\n"
<< "\n"
<< "When specifying multiple source images, they will all be saved into the same HEIF/AVIF file.\n"
<< "\n"
<< "Some encoders (x265, aom) let you pass-through any parameters by prefixing them with the encoder name.\n"
<< "For example, you may pass any x265 parameter by prefixing it with 'x265:'. For example, to set\n"
<< "the 'ctu' parameter, you will have to set 'x265:ctu' in libheif (e.g.: -p x265:ctu=64).\n"
<< "Note that when using the prefix, libheif cannot tell you which parameters and values are supported.\n"
<< "\n"
<< "Options:\n"
<< " -h, --help show help\n"
<< " -v, --version show version\n"
<< " -o, --output output filename (optional)\n"
<< " -q, --quality set output quality (0-100) for lossy compression\n"
<< " -L, --lossless generate lossless output (-q has no effect). Image will be encoded as RGB (matrix_coefficients=0).\n"
<< " -t, --thumb # generate thumbnail with maximum size # (default: off)\n"
<< " --no-alpha do not save alpha channel\n"
<< " --no-thumb-alpha do not save alpha channel in thumbnail image\n"
<< " --verbose enable logging output (more will increase logging level)\n"
<< " -b, --bit-depth # number of bits to use from an 16-bit PNG input, valid range: 9-16 (default: 10 bit)\n"
<< " --premultiplied-alpha input image has premultiplied alpha\n"
#if WITH_HEADER_COMPRESSION
<< " --enable-metadata-compression ALGO enable metadata item compression (experimental)\n"
<< " Choose algorithm from {off"; // TODO: add 'auto', but it currently equals 'off'
if (heif_metadata_compression_method_supported(heif_metadata_compression_deflate)) {
std::cerr << ",deflate,zlib";
}
if (heif_metadata_compression_method_supported(heif_metadata_compression_brotli)) {
std::cerr << ",brotli";
}
std::cerr << "}.\n"
#endif
<< " -C, --chroma-downsampling ALGO force chroma downsampling algorithm (nn = nearest-neighbor / average / sharp-yuv)\n"
<< " (sharp-yuv makes edges look sharper when using YUV420 with bilinear chroma upsampling)\n"
<< " --benchmark measure encoding time, PSNR, and output file size\n"
<< " --pitm-description TEXT set user description for primary image (experimental)\n"
#if HEIF_ENABLE_EXPERIMENTAL_FEATURES
<< " --add-mime-item TYPE add a mime item of the specified content type (experimental)\n"
<< " --mime-item-file FILE use the specified FILE as the data to put into the mime item (experimental)\n"
#endif
<< "\n"
<< "codecs:\n"
<< " -A, --avif encode as AVIF (not needed if output filename with .avif suffix is provided)\n"
<< " --hevc encode as HEVC (default)\n"
<< " --vvc encode as VVC (experimental)\n"
<< " --avc encode as AVC (experimental)\n"
<< " --jpeg encode as JPEG\n"
<< " --jpeg2000 encode as JPEG 2000 (experimental)\n"
<< " --htj2k encode as High Throughput JPEG 2000 (experimental)\n"
#if WITH_UNCOMPRESSED_CODEC
<< " -U, --uncompressed encode as uncompressed image (according to ISO 23001-17) (EXPERIMENTAL)\n"
<< " --unci-compression METHOD choose one of these methods: none, deflate, zlib, brotli.\n"
#endif
<< " --list-encoders list all available encoders for all compression formats\n"
<< " -e, --encoder ID select encoder to use (the IDs can be listed with --list-encoders)\n"
<< " --plugin-directory DIR load all codec plugins in the directory\n"
<< " -P, --params show all encoder parameters and exit, input file not required or used.\n"
<< " -p NAME=VALUE set encoder parameter\n"
<< "\n"
<< "color profile:\n"
<< " --color-profile NAME use a color profile preset for the output. Valid values are:\n"
<< " custom: (default) use the provided matrix_coefficients, colour_primaries, transfer_characteristic\n"
<< " auto: automatically guess suitable values from the input image characteristics\n"
<< " compatible: use a profile that is decoded correctly by most applications by avoiding incomplete implementations\n"
<< " 601: use Rec.601 (SD), close to JPEG\n"
<< " 709: use Rec.709 (HDTV), close to sRGB\n"
<< " 2020: use Rec.2020 (UHDTV), transfer curve will be selected based on bits per pixel\n"
<< " --matrix_coefficients nclx profile: color conversion matrix coefficients, default=6 (see h.273)\n"
<< " --colour_primaries nclx profile: color primaries (see h.273)\n"
<< " --transfer_characteristic nclx profile: transfer characteristics (see h.273)\n"
<< " --full_range_flag nclx profile: full range flag, default: 1\n"
<< " --enable-two-colr-boxes will write both an ICC and an nclx color profile if both are present\n"
<< " --clli MaxCLL,MaxPALL add 'content light level information' property to all encoded images\n"
<< " --pasp h,v set pixel aspect ratio property to all encoded images\n"
<< "\n"
<< "tiling:\n"
<< " --cut-tiles # cuts the input image into square tiles of the given width\n"
<< " -T, --tiled-input input is a set of tile images (only provide one filename with two tile position numbers).\n"
<< " For example, 'tile-01-05.jpg' would be a valid input filename.\n"
<< " You only have to provide the filename of one tile as input, heif-enc will scan the directory\n"
<< " for the other tiles and determine the range of tiles automatically.\n"
<< " --tiled-image-width # override image width of tiled image\n"
<< " --tiled-image-height # override image height of tiled image\n"
<< " --tiled-input-x-y usually, the first number in the input tile filename should be the y position.\n"
<< " With this option, this can be swapped so that the first number is x, the second number y.\n"
#if HEIF_ENABLE_EXPERIMENTAL_FEATURES || WITH_UNCOMPRESSED_CODEC
<< " --tiling-method METHOD choose one of these methods: grid"
#if HEIF_ENABLE_EXPERIMENTAL_FEATURES
", tili (experimental)"
#endif
#if WITH_UNCOMPRESSED_CODEC
", unci"
#endif
". The default is 'grid'.\n"
#endif
#if HEIF_ENABLE_EXPERIMENTAL_FEATURES
<< " --add-pyramid-group when several images are given, put them into a multi-resolution pyramid group. (experimental)\n"
#endif
<< "\n"
<< "sequences:\n"
<< " -S, --sequence encode input images as sequence (input filenames with a number will pull in all files with this pattern).\n"
<< " -V, --video encode as video instead of image sequence\n"
<< " --timebase # set clock ticks/second for sequence\n"
<< " --duration # set frame duration (default: 1)\n"
<< " --fps # set timebase and duration based on fps\n"
<< " --repetitions # set how often the sequence should be played back (default=1), special value: 'infinite'\n"
<< " --gop-structure GOP frame types to use in GOP (intra-only, low-delay, unrestricted)\n"
<< " --min-keyframe-distance # minimum distance of keyframes in sequence (0 = undefined)\n"
<< " --max-keyframe-distance # maximum distance of keyframes in sequence (0 = undefined)\n"
<< " --max-frames # limit sequence length to maximum number of frames\n"
#if HEIF_ENABLE_EXPERIMENTAL_FEATURES
<< " --vmt-metadata FILE encode metadata track from VMT file (experimental)\n"
<< " --binary-metadata-track parses VMT data as hex values that are written as raw binary (experimental)\n"
<< " --metadata-track-uri URI uses the URI identifier for the metadata track (experimental)\n"
<< " --set-gimi-track-id ID set the GIMI track ID for the visual track (experimental)\n"
<< " --sai-data-file FILE use the specified FILE as input data for the video frames SAI data\n"
#endif
;
}
void list_encoder_parameters(heif_encoder* encoder)
{
std::cerr << "Parameters for encoder `" << heif_encoder_get_name(encoder) << "`:\n";
const heif_encoder_parameter* const* params = heif_encoder_list_parameters(encoder);
for (int i = 0; params[i]; i++) {
const char* name = heif_encoder_parameter_get_name(params[i]);
switch (heif_encoder_parameter_get_type(params[i])) {
case heif_encoder_parameter_type_integer: {
heif_error error;
std::cerr << " " << name;
if (heif_encoder_has_default(encoder, name)) {
int value;
error = heif_encoder_get_parameter_integer(encoder, name, &value);
(void) error;
std::cerr << ", default=" << value;
}
int have_minimum, have_maximum, minimum, maximum, num_valid_values;
const int* valid_values = nullptr;
error = heif_encoder_parameter_integer_valid_values(encoder, name,
&have_minimum, &have_maximum,
&minimum, &maximum,
&num_valid_values,
&valid_values);
if (have_minimum || have_maximum) { // TODO: only one is set
std::cerr << ", [" << minimum << ";" << maximum << "]";
}
if (num_valid_values > 0) {
std::cerr << ", {";
for (int p = 0; p < num_valid_values; p++) {
if (p > 0) {
std::cerr << ", ";
}
std::cerr << valid_values[p];
}
std::cerr << "}";
}
std::cerr << "\n";
}
break;
case heif_encoder_parameter_type_boolean: {
heif_error error;
std::cerr << " " << name;
if (heif_encoder_has_default(encoder, name)) {
int value;
error = heif_encoder_get_parameter_boolean(encoder, name, &value);
(void) error;
std::cerr << ", default=" << (value ? "true" : "false");
}
std::cerr << "\n";
}
break;
case heif_encoder_parameter_type_string: {
heif_error error;
std::cerr << " " << name;
if (heif_encoder_has_default(encoder, name)) {
const int value_size = 50;
char value[value_size];
error = heif_encoder_get_parameter_string(encoder, name, value, value_size);
(void) error;
std::cerr << ", default=" << value;
}
const char* const* valid_options;
error = heif_encoder_parameter_string_valid_values(encoder, name, &valid_options);
if (valid_options) {
std::cerr << ", { ";
for (int k = 0; valid_options[k]; k++) {
if (k > 0) { std::cerr << ","; }
std::cerr << valid_options[k];
}
std::cerr << " }";
}
std::cerr << "\n";
}
break;
}
}
}
void set_params(heif_encoder* encoder, const std::vector<std::string>& params)
{
for (const std::string& p : params) {
auto pos = p.find_first_of('=');
if (pos == std::string::npos || pos == 0 || pos == p.size() - 1) {
std::cerr << "Encoder parameter must be in the format 'name=value'\n";
exit(5);
}
std::string name = p.substr(0, pos);
std::string value = p.substr(pos + 1);
struct heif_error error = heif_encoder_set_parameter(encoder, name.c_str(), value.c_str());
if (error.code) {
std::cerr << "Error: " << error.message << "\n";
exit(5);
}
}
}
static void show_list_of_encoders(const heif_encoder_descriptor* const* encoder_descriptors,
int count)
{
for (int i = 0; i < count; i++) {
std::cout << "- " << heif_encoder_descriptor_get_id_name(encoder_descriptors[i])
<< " = "
<< heif_encoder_descriptor_get_name(encoder_descriptors[i]);
if (i == 0) {
std::cout << " [default]";
}
std::cout << "\n";
}
}
static const char* get_compression_format_name(heif_compression_format format)
{
switch (format) {
case heif_compression_AV1:
return "AV1";
break;
case heif_compression_AVC:
return "AVC";
break;
case heif_compression_VVC:
return "VVC";
break;
case heif_compression_HEVC:
return "HEVC";
break;
case heif_compression_JPEG:
return "JPEG";
break;
case heif_compression_JPEG2000:
return "JPEG 2000";
break;
case heif_compression_HTJ2K:
return "HT-J2K";
break;
case heif_compression_uncompressed:
return "Uncompressed";
break;
default:
assert(false);
return "unknown";
}
}
static void show_list_of_all_encoders()
{
for (auto compression_format: {heif_compression_AVC, heif_compression_AV1, heif_compression_HEVC,
heif_compression_JPEG, heif_compression_JPEG2000, heif_compression_HTJ2K,
heif_compression_uncompressed, heif_compression_VVC
}) {
switch (compression_format) {
case heif_compression_AVC:
std::cout << "AVC";
break;
case heif_compression_AV1:
std::cout << "AVIF";
break;
case heif_compression_HEVC:
std::cout << "HEIC";
break;
case heif_compression_JPEG:
std::cout << "JPEG";
break;
case heif_compression_JPEG2000:
std::cout << "JPEG 2000";
break;
case heif_compression_HTJ2K:
std::cout << "JPEG 2000 (HT)";
break;
case heif_compression_uncompressed:
std::cout << "Uncompressed";
break;
case heif_compression_VVC:
std::cout << "VVIC";
break;
default:
assert(false);
}
std::cout << " encoders:\n";
#define MAX_ENCODERS 10
const heif_encoder_descriptor* encoder_descriptors[MAX_ENCODERS];
int count = heif_get_encoder_descriptors(compression_format,
nullptr,
encoder_descriptors, MAX_ENCODERS);
#undef MAX_ENCODERS
show_list_of_encoders(encoder_descriptors, count);
}
}
bool ends_with(const std::string& str, const std::string& end)
{
if (str.length() < end.length()) {
return false;
}
else {
return str.compare(str.length() - end.length(), end.length(), end) == 0;
}
}
heif_compression_format guess_compression_format_from_filename(const std::string& filename)
{
std::string filename_lowercase = filename;
std::transform(filename_lowercase.begin(), filename_lowercase.end(), filename_lowercase.begin(), ::tolower);
if (ends_with(filename_lowercase, ".avif")) {
return heif_compression_AV1;
}
else if (ends_with(filename_lowercase, ".vvic")) {
return heif_compression_VVC;
}
else if (ends_with(filename_lowercase, ".avci")) {
return heif_compression_AVC;
}
else if (ends_with(filename_lowercase, ".heic")) {
return heif_compression_HEVC;
}
else if (ends_with(filename_lowercase, ".hej2")) {
return heif_compression_JPEG2000;
}
else {
return heif_compression_undefined;
}
}
std::string suffix_for_compression_format(heif_compression_format format)
{
switch (format) {
case heif_compression_AV1: return "avif";
case heif_compression_VVC: return "vvic";
case heif_compression_AVC: return "avci";
case heif_compression_HEVC: return "heic";
case heif_compression_JPEG2000: return "hej2";
default: return "data";
}
}
InputImage load_image(const std::string& input_filename, int output_bit_depth)
{
InputImage input_image;
// get file type from file name
std::string suffix;
auto suffix_pos = input_filename.find_last_of('.');
if (suffix_pos != std::string::npos) {
suffix = input_filename.substr(suffix_pos + 1);
std::transform(suffix.begin(), suffix.end(), suffix.begin(), ::tolower);
}
enum
{
PNG, JPEG, Y4M, TIFF
} filetype = JPEG;
if (suffix == "png") {
filetype = PNG;
}
else if (suffix == "y4m") {
filetype = Y4M;
}
else if (suffix == "tif" || suffix == "tiff") {
filetype = TIFF;
}
if (filetype == PNG) {
heif_error err = loadPNG(input_filename.c_str(), output_bit_depth, &input_image);
if (err.code != heif_error_Ok) {
std::cerr << "Can not load TIFF input_image: " << err.message << '\n';
exit(1);
}
}
else if (filetype == Y4M) {
heif_error err = loadY4M(input_filename.c_str(), &input_image);
if (err.code != heif_error_Ok) {
std::cerr << "Can not load TIFF input_image: " << err.message << '\n';
exit(1);
}
}
else if (filetype == TIFF) {
heif_error err = loadTIFF(input_filename.c_str(), &input_image);
if (err.code != heif_error_Ok) {
std::cerr << "Can not load TIFF input_image: " << err.message << '\n';
exit(1);
}
}
else {
heif_error err = loadJPEG(input_filename.c_str(), &input_image);
if (err.code != heif_error_Ok) {
std::cerr << "Can not load JPEG input_image: " << err.message << '\n';
exit(1);
}
}
return input_image;
}
heif_error create_output_nclx_profile_and_configure_encoder(heif_encoder* encoder,
heif_color_profile_nclx** out_nclx,
std::shared_ptr<heif_image> input_image,
bool lossless,
heif_output_nclx_color_profile_preset profile_preset)
{
*out_nclx = heif_nclx_color_profile_alloc();
if (!*out_nclx) {
return {heif_error_Encoding_error, heif_suberror_Unspecified, "Cannot allocate NCLX color profile."};
}
heif_color_profile_nclx* nclx = *out_nclx; // abbreviation;
// set NCLX based on preset
switch (profile_preset) {
case heif_output_nclx_color_profile_preset_custom: {
heif_error error = heif_nclx_color_profile_set_matrix_coefficients(nclx, nclx_matrix_coefficients);
if (error.code) {
std::cerr << "Invalid matrix coefficients specified.\n";
exit(5);
}
error = heif_nclx_color_profile_set_transfer_characteristics(nclx, nclx_transfer_characteristic);
if (error.code) {
std::cerr << "Invalid transfer characteristics specified.\n";
exit(5);
}
error = heif_nclx_color_profile_set_color_primaries(nclx, nclx_colour_primaries);
if (error.code) {
std::cerr << "Invalid color primaries specified.\n";
exit(5);
}
nclx->full_range_flag = (uint8_t) nclx_full_range;
break;
}
case heif_output_nclx_color_profile_preset_automatic: {
heif_color_profile_nclx* input_nclx = nullptr;
// --- use input image color profile, if it exists
heif_error error = heif_image_get_nclx_color_profile(input_image.get(), &input_nclx);
if (error.code == heif_error_Color_profile_does_not_exist) {
// input image has not color profile, guess one
if (heif_image_get_colorspace(input_image.get()) == heif_colorspace_RGB) {
// sRGB
nclx->matrix_coefficients = heif_matrix_coefficients_ITU_R_BT_709_5; // will be overwritten below if lossless
nclx->color_primaries = heif_color_primaries_ITU_R_BT_709_5;
nclx->transfer_characteristics = heif_transfer_characteristic_IEC_61966_2_1;
}
else {
// BT.709
nclx->matrix_coefficients = heif_matrix_coefficients_ITU_R_BT_709_5; // will be overwritten below if lossless
nclx->color_primaries = heif_color_primaries_ITU_R_BT_709_5;
nclx->transfer_characteristics = heif_transfer_characteristic_ITU_R_BT_709_5;
}
}
else if (error.code) {
std::cerr << "Cannot get input NCLX color profile.\n";
return error;
}
else {
// no error, we have an input color profile that we can use for output too
nclx->matrix_coefficients = input_nclx->matrix_coefficients;
nclx->transfer_characteristics = input_nclx->transfer_characteristics;
nclx->color_primaries = input_nclx->color_primaries;
nclx->full_range_flag = input_nclx->full_range_flag;
heif_nclx_color_profile_free(input_nclx);
input_nclx = nullptr;
}
assert(!input_nclx);
break;
}
case heif_output_nclx_color_profile_preset_Rec_601:
nclx->matrix_coefficients = heif_matrix_coefficients_ITU_R_BT_601_6;
nclx->color_primaries = heif_color_primaries_ITU_R_BT_601_6;
nclx->transfer_characteristics = heif_transfer_characteristic_ITU_R_BT_601_6;
break;
case heif_output_nclx_color_profile_preset_compatible:
case heif_output_nclx_color_profile_preset_Rec_709:
nclx->matrix_coefficients = heif_matrix_coefficients_ITU_R_BT_709_5;
nclx->color_primaries = heif_color_primaries_ITU_R_BT_709_5;
nclx->transfer_characteristics = heif_transfer_characteristic_ITU_R_BT_709_5;
break;
case heif_output_nclx_color_profile_preset_Rec_2020:
nclx->matrix_coefficients = heif_matrix_coefficients_ITU_R_BT_2020_2_constant_luminance;
nclx->color_primaries = heif_color_primaries_ITU_R_BT_2020_2_and_2100_0;
if (heif_image_has_channel(input_image.get(), heif_channel_Y) &&
heif_image_get_bits_per_pixel(input_image.get(), heif_channel_Y) <= 10) {
nclx->transfer_characteristics = heif_transfer_characteristic_ITU_R_BT_2020_2_10bit;
}
else {
nclx->transfer_characteristics = heif_transfer_characteristic_ITU_R_BT_2020_2_12bit;
}
break;
}
// modify NCLX depending on input image
if (lossless) {
heif_encoder_set_lossless(encoder, true);
if (heif_image_get_colorspace(input_image.get()) == heif_colorspace_RGB) {
nclx->matrix_coefficients = heif_matrix_coefficients_RGB_GBR;
nclx->full_range_flag = true;
heif_error error = heif_encoder_set_parameter(encoder, "chroma", "444");
if (error.code) {
return error;
}
}
else {
heif_error error;
// TODO: this assumes that the encoder plugin has a 'chroma' parameter. Currently, they do, but there should be a better way to set this.
switch (heif_image_get_chroma_format(input_image.get())) {
case heif_chroma_420:
case heif_chroma_monochrome:
error = heif_encoder_set_parameter(encoder, "chroma", "420");
break;
case heif_chroma_422:
error = heif_encoder_set_parameter(encoder, "chroma", "422");
break;
case heif_chroma_444:
error = heif_encoder_set_parameter(encoder, "chroma", "444");
break;
default:
assert(false);
exit(5);
}
if (error.code) {
return error;
}
}
}
return {heif_error_Ok};
}
struct input_tiles_generator
{
virtual ~input_tiles_generator() = default;
virtual uint32_t nColumns() const = 0;
virtual uint32_t nRows() const = 0;
virtual uint32_t nTiles() const { return nColumns() * nRows(); }
virtual InputImage get_image(uint32_t tx, uint32_t ty, int output_bit_depth) = 0;
};
struct input_tiles_generator_separate_files : public input_tiles_generator
{
uint32_t first_start;
uint32_t first_end;
uint32_t first_digits;
uint32_t second_start;
uint32_t second_end;
uint32_t second_digits;
std::filesystem::path directory;
std::string prefix;
std::string separator;
std::string suffix;
bool first_is_x = false;
uint32_t nColumns() const override { return first_is_x ? (first_end - first_start + 1) : (second_end - second_start + 1); }
uint32_t nRows() const override { return first_is_x ? (second_end - second_start + 1) : (first_end - first_start + 1); }
uint32_t nTiles() const override { return (first_end - first_start + 1) * (second_end - second_start + 1); }
std::filesystem::path filename(uint32_t tx, uint32_t ty) const
{
std::stringstream sstr;
sstr << prefix << std::setw(first_digits) << std::setfill('0') << (first_is_x ? tx : ty) + first_start;
sstr << separator << std::setw(second_digits) << std::setfill('0') << (first_is_x ? ty : tx) + second_start;
sstr << suffix;
std::filesystem::path p = directory / sstr.str();
return p;
}
InputImage get_image(uint32_t tx, uint32_t ty, int output_bit_depth) override
{
std::string input_filename = filename(tx, ty).string();
InputImage image = load_image(input_filename, output_bit_depth);
return image;
}
};
std::shared_ptr<input_tiles_generator> determine_input_images_tiling(const std::string& filename, bool first_is_x)
{
std::regex pattern(R"((.*\D)?(\d+)(\D+?)(\d+)(\..+)$)");
std::smatch match;
auto generator = std::make_shared<input_tiles_generator_separate_files>();
if (std::regex_match(filename, match, pattern)) {
std::string prefix = match[1];
auto p = std::filesystem::absolute(std::filesystem::path(prefix));
generator->directory = p.parent_path();
generator->prefix = p.filename().string(); // TODO: we could also use u8string(), but it is not well supported in C++20
generator->separator = match[3];
generator->suffix = match[5];
generator->first_start = 9999;
generator->first_end = 0;
generator->first_digits = 9;
generator->second_start = 9999;
generator->second_end = 0;
generator->second_digits = 9;
}
else {
return nullptr;
}
std::string patternString = generator->prefix + "(\\d+)" + generator->separator + "(\\d+)" + generator->suffix + "$";
pattern = patternString;
for (const auto& dirEntry : std::filesystem::directory_iterator(generator->directory))
{
if (dirEntry.is_regular_file()) {
std::string s{dirEntry.path().filename().string()};
if (std::regex_match(s, match, pattern)) {
uint32_t first = std::stoi(match[1]);
uint32_t second = std::stoi(match[2]);
generator->first_digits = std::min(generator->first_digits, (uint32_t)match[1].length());
generator->second_digits = std::min(generator->second_digits, (uint32_t)match[2].length());
generator->first_start = std::min(generator->first_start, first);
generator->first_end = std::max(generator->first_end, first);
generator->second_start = std::min(generator->second_start, second);
generator->second_end = std::max(generator->second_end, second);
}
}
}
generator->first_is_x = first_is_x;
return generator;
}
class input_tiles_generator_cut_image : public input_tiles_generator
{
public:
input_tiles_generator_cut_image(const char* filename, int tile_size, int output_bit_depth)
{
mImage = load_image(filename, output_bit_depth);
mWidth = heif_image_get_primary_width(mImage.image.get());
mHeight = heif_image_get_primary_height(mImage.image.get());
mTileSize = tile_size;
}
uint32_t nColumns() const override { return (mWidth + mTileSize - 1)/mTileSize; }
uint32_t nRows() const override { return (mHeight + mTileSize - 1)/mTileSize; }
InputImage get_image(uint32_t tx, uint32_t ty, int output_bit_depth) override
{
heif_image* tileImage;
heif_error err = heif_image_extract_area(mImage.image.get(), tx * mTileSize, ty * mTileSize, mTileSize, mTileSize,
heif_get_global_security_limits(),
&tileImage);
if (err.code) {
std::cerr << "error extracting tile " << tx << ";" << ty << std::endl;
exit(1);
}
InputImage tile;
tile.image = std::shared_ptr<heif_image>(tileImage,
[](heif_image* img) { heif_image_release(img); });
return tile;
}
uint32_t get_image_width() const { return heif_image_get_primary_width(mImage.image.get()); }
uint32_t get_image_height() const { return heif_image_get_primary_height(mImage.image.get()); }
private:
InputImage mImage;
uint32_t mWidth, mHeight;
int mTileSize;
};
// TODO: we have to attach the input image Exif and XMP to the tiled image
heif_image_handle* encode_tiled(heif_context* ctx, heif_encoder* encoder, heif_encoding_options* options,
int output_bit_depth,
const std::shared_ptr<input_tiles_generator>& tile_generator,
const heif_image_tiling& tiling)
{
heif_image_handle* tiled_image = nullptr;
// --- create the main grid image
if (tiling_method == "grid") {
heif_error error = heif_context_add_grid_image(ctx, tiling.image_width, tiling.image_height,
tiling.num_columns, tiling.num_rows,
options,
&tiled_image);
if (error.code != 0) {
std::cerr << "Could not generate grid image: " << error.message << "\n";
return nullptr;
}
}
#if HEIF_ENABLE_EXPERIMENTAL_FEATURES
else if (tiling_method == "tili") {
heif_tiled_image_parameters tiled_params{};
tiled_params.version = 1;
tiled_params.image_width = tiling.image_width;
tiled_params.image_height = tiling.image_height;
tiled_params.tile_width = tiling.tile_width;
tiled_params.tile_height = tiling.tile_height;
tiled_params.offset_field_length = 32;
tiled_params.size_field_length = 24;
tiled_params.tiles_are_sequential = 1;
heif_error error = heif_context_add_tiled_image(ctx, &tiled_params, options, encoder, &tiled_image);
if (error.code != 0) {
std::cerr << "Could not generate tili image: " << error.message << "\n";
return nullptr;
}
}
#endif
#if WITH_UNCOMPRESSED_CODEC
else if (tiling_method == "unci") {
heif_unci_image_parameters params{};
params.version = 1;
params.image_width = tiling.image_width;
params.image_height = tiling.image_height;
params.tile_width = tiling.tile_width;
params.tile_height = tiling.tile_height;
params.compression = unci_compression;
InputImage prototype_image = tile_generator->get_image(0,0, output_bit_depth);
heif_error error = heif_context_add_empty_unci_image(ctx, ¶ms, options, prototype_image.image.get(), &tiled_image);
if (error.code != 0) {
std::cerr << "Could not generate unci image: " << error.message << "\n";
return nullptr;
}
}
#endif
else {
assert(false);
exit(10);
}
// --- add all the image tiles
std::cout << "encoding tiled image, tile size: " << tiling.tile_width << "x" << tiling.tile_height
<< " image size: " << tiling.image_width << "x" << tiling.image_height << "\n";
int tile_width = 0, tile_height = 0;
for (uint32_t ty = 0; ty < tile_generator->nRows(); ty++)
for (uint32_t tx = 0; tx < tile_generator->nColumns(); tx++) {
InputImage input_image = tile_generator->get_image(tx,ty, output_bit_depth);
if (tile_width == 0) {
tile_width = heif_image_get_primary_width(input_image.image.get());
tile_height = heif_image_get_primary_height(input_image.image.get());
if (tile_width <= 0 || tile_height <= 0) {
std::cerr << "Could not read input image size correctly\n";
return nullptr;
}
}
heif_error error;
error = heif_image_extend_to_size_fill_with_zero(input_image.image.get(), tile_width, tile_height);
if (error.code) {
std::cerr << error.message << "\n";
}
std::cout << "encoding tile " << ty+1 << " " << tx+1
<< " (of " << tile_generator->nRows() << "x" << tile_generator->nColumns() << ") \r";
std::cout.flush();
error = heif_context_add_image_tile(ctx, tiled_image, tx, ty,
input_image.image.get(),
encoder);
if (error.code != 0) {
std::cerr << "Could not encode HEIF/AVIF file: " << error.message << "\n";
return nullptr;
}
}
std::cout << "\n";
return tiled_image;
}
template <typename T>
std::vector<T> parse_comma_separated_numeric_arguments(std::string arg,
std::vector<T> max_val)
{
std::istringstream ss(arg);
std::string token;
std::vector<T> results;
for (size_t i = 0 ; i<max_val.size(); i++) {
if (!std::getline(ss, token, ',')) return {};
try {
size_t pos;
unsigned long val = std::stoul(token, &pos);
if (pos != token.size()) return {}; // extra non-numeric characters
if (val > max_val[i]) return {};
results.push_back(static_cast<T>(val));
} catch (...) {
return {};
}
}
// There should be no extra tokens
if (ss.rdbuf()->in_avail() != 0) return {};
return results;
}
bool prefix_compare(const char* a, const char* b)
{
auto minLen = std::min(strlen(a), strlen(b));
return strncmp(a,b,minLen) == 0;
}
bool set_metadata_compression_method(const std::string& arg)
{
if (arg == "auto") {
metadata_compression_method = heif_metadata_compression_auto;
return true;
}
else if (arg == "off") {
metadata_compression_method = heif_metadata_compression_off;
return true;
}
else if (arg == "brotli") {
metadata_compression_method = heif_metadata_compression_brotli;
return true;
}
else if (arg == "deflate") {
metadata_compression_method = heif_metadata_compression_deflate;
return true;
}
else if (arg == "zlib") {
metadata_compression_method = heif_metadata_compression_zlib;
return true;
}
else {
std::cerr << "Unknown metadata compression method '" << arg << "'. Choose between {auto,off,deflate,zlib,brotli}\n";
return false;
}
}
class LibHeifInitializer
{
public:
LibHeifInitializer() { heif_init(nullptr); }
~LibHeifInitializer() { heif_deinit(); }
};
int do_encode_images(heif_context*, heif_encoder*, heif_encoding_options* options, const std::vector<std::string>& args);
int do_encode_sequence(heif_context*, heif_encoder*, heif_encoding_options* options, std::vector<std::string> args);
int main(int argc, char** argv)
{
// This takes care of initializing libheif and also deinitializing it at the end to free all resources.
LibHeifInitializer initializer;
std::vector<std::string> raw_params;
while (true) {
int option_index = 0;
int c = getopt_long(argc, argv, "hq:Lo:vPp:t:b:Ae:C:TSV"
#if WITH_UNCOMPRESSED_CODEC
"U"
#endif
, long_options, &option_index);
if (c == -1)
break;
switch (c) {
case 'h':
show_help(argv[0]);
return 0;
case 'v':
heif_examples::show_version();
return 0;
case 'q':
quality = atoi(optarg);
break;
case 'L':
lossless = true;
break;
case 'o':
output_filename = optarg;
break;
case OPTION_VERBOSE:
logging_level++;
break;
case 'P':
option_show_parameters = true;
break;
case 'p':
raw_params.push_back(optarg);
break;
case 't':
thumbnail_bbox_size = atoi(optarg);
break;
case 'b':
output_bit_depth = atoi(optarg);
if (output_bit_depth < 9 || output_bit_depth > 16) {
std::cerr << "Bit depth for input HDR images must be 9-16 bits.\n";
return 5;
}
break;
case 'A':
force_enc_av1f = true;
break;
#if WITH_UNCOMPRESSED_CODEC
case 'U':
force_enc_uncompressed = true;
break;
#endif
case 'e':
encoderId = optarg;
break;
case OPTION_NCLX_MATRIX_COEFFICIENTS:
nclx_matrix_coefficients = (uint16_t) strtoul(optarg, nullptr, 0);
break;
case OPTION_NCLX_COLOUR_PRIMARIES:
nclx_colour_primaries = (uint16_t) strtoul(optarg, nullptr, 0);
break;
case OPTION_NCLX_TRANSFER_CHARACTERISTIC:
nclx_transfer_characteristic = (uint16_t) strtoul(optarg, nullptr, 0);
break;
case OPTION_NCLX_FULL_RANGE_FLAG:
nclx_full_range = atoi(optarg);
break;
case OPTION_PITM_DESCRIPTION:
property_pitm_description = optarg;
break;
case OPTION_USE_HEVC_COMPRESSION:
force_enc_hevc = true;
break;
case OPTION_USE_VVC_COMPRESSION:
force_enc_vvc = true;
break;
case OPTION_USE_AVC_COMPRESSION:
force_enc_avc = true;
break;
case OPTION_USE_JPEG_COMPRESSION:
force_enc_jpeg = true;
break;
case OPTION_USE_JPEG2000_COMPRESSION:
force_enc_jpeg2000 = true;
break;
case OPTION_USE_HTJ2K_COMPRESSION:
force_enc_htj2k = true;
break;
case OPTION_PLUGIN_DIRECTORY: {
int nPlugins;
heif_error error = heif_load_plugins(optarg, nullptr, &nPlugins, 0);
if (error.code) {
std::cerr << "Error loading libheif plugins: " << error.message << "\n";
return 1;
}
// Note: since we process the option within the loop, we can only consider the '-v' flags coming before the plugin loading option.
if (logging_level > 0) {
std::cout << nPlugins << " plugins loaded from directory " << optarg << "\n";
}
break;
}
case OPTION_TILED_IMAGE_WIDTH:
tiled_image_width = (int) strtol(optarg, nullptr, 0);
break;
case OPTION_TILED_IMAGE_HEIGHT:
tiled_image_height = (int) strtol(optarg, nullptr, 0);
break;
case OPTION_TILING_METHOD:
tiling_method = optarg;
if (tiling_method != "grid"
#if WITH_UNCOMPRESSED_CODEC
&& tiling_method != "unci"
#endif
#if HEIF_ENABLE_EXPERIMENTAL_FEATURES
&& tiling_method != "tili"
#endif
) {
std::cerr << "Invalid tiling method '" << tiling_method << "'\n";
exit(5);
}
break;
case OPTION_CUT_TILES:
cut_tiles = atoi(optarg);
break;
case OPTION_UNCI_COMPRESSION: {
std::string option(optarg);
if (option == "none") {
unci_compression = heif_unci_compression_off;
}
else if (option == "brotli") {
unci_compression = heif_unci_compression_brotli;
}
else if (option == "deflate") {
unci_compression = heif_unci_compression_deflate;
}
else if (option == "zlib") {
unci_compression = heif_unci_compression_zlib;
}
else {
std::cerr << "Invalid unci compression method '" << option << "'\n";
exit(5);
}
break;
}
case 'C':
chroma_downsampling = optarg;
if (chroma_downsampling != "nn" &&
chroma_downsampling != "nearest-neighbor" &&
chroma_downsampling != "average" &&
chroma_downsampling != "sharp-yuv") {
fprintf(stderr, "Undefined chroma downsampling algorithm.\n");
exit(5);
}
if (chroma_downsampling == "nn") { // abbreviation
chroma_downsampling = "nearest-neighbor";
}
#if !HAVE_LIBSHARPYUV
if (chroma_downsampling == "sharp-yuv") {
std::cerr << "Error: sharp-yuv chroma downsampling method has not been compiled into libheif.\n";
return 5;
}
#endif
break;
case 'T':
use_tiling = true;
break;
case 'S':
encode_sequence = true;
break;
case 'V':
use_video_handler = true;
break;
case OPTION_SEQUENCES_TIMEBASE:
sequence_timebase = atoi(optarg);
break;
case OPTION_SEQUENCES_DURATIONS:
sequence_durations = atoi(optarg);
break;
case OPTION_SEQUENCES_FPS:
if (strcmp(optarg,"29.97")==0) {
sequence_durations = 1001;
sequence_timebase = 30000;
}
else {
double fps = std::atof(optarg);
sequence_timebase = 90000;
sequence_durations = (uint32_t)(90000 / fps + 0.5);
}
break;
case OPTION_SEQUENCES_REPETITIONS:
if (strcmp(optarg, "infinite")==0) {
sequence_repetitions = heif_sequence_maximum_number_of_repetitions;
}
else {
sequence_repetitions = atoi(optarg);
if (sequence_repetitions == 0) {
std::cerr << "Sequence repetitions may not be 0.\n";
return 5;
}
}
break;
case OPTION_SEQUENCES_GOP_STRUCTURE:
if (prefix_compare(optarg, "intra-only")) {
sequence_gop_structure = heif_sequence_gop_structure_intra_only;
}
else if (prefix_compare(optarg, "low-delay") || prefix_compare(optarg, "p")) {
sequence_gop_structure = heif_sequence_gop_structure_lowdelay;
}
else if (prefix_compare(optarg, "unrestricted") || prefix_compare(optarg, "b")) {
sequence_gop_structure = heif_sequence_gop_structure_unrestricted;
}
else {
std::cerr << "Invalid GOP structure argument\n";
return 5;
}
break;
case OPTION_SEQUENCES_MIN_KEYFRAME_DISTANCE:
sequence_keyframe_distance_min = atoi(optarg);
if (sequence_keyframe_distance_min < 0) {
std::cerr << "Keyframe distance must be >= 0\n";
return 5;
}
break;
case OPTION_SEQUENCES_MAX_KEYFRAME_DISTANCE:
sequence_keyframe_distance_max = atoi(optarg);
if (sequence_keyframe_distance_max < 0) {
std::cerr << "Keyframe distance must be >= 0\n";
return 5;
}
break;
case OPTION_SEQUENCES_MAX_FRAMES:
sequence_max_frames = atoi(optarg);
if (sequence_max_frames <= 0) {
std::cerr << "Maximum number of frames must be >= 1\n";
return 5;
}
break;
case OPTION_COLOR_PROFILE_PRESET:
if (strcmp(optarg, "auto")==0) {
output_color_profile_preset = heif_output_nclx_color_profile_preset_automatic;
}
else if (strcmp(optarg, "custom")==0) {
output_color_profile_preset = heif_output_nclx_color_profile_preset_custom;
}
else if (strcmp(optarg, "compatible")==0) {
output_color_profile_preset = heif_output_nclx_color_profile_preset_compatible;
}
else if (strcmp(optarg, "601")==0) {
output_color_profile_preset = heif_output_nclx_color_profile_preset_Rec_601;
}
else if (strcmp(optarg, "709")==0) {
output_color_profile_preset = heif_output_nclx_color_profile_preset_Rec_709;
}
else if (strcmp(optarg, "2020")==0) {
output_color_profile_preset = heif_output_nclx_color_profile_preset_Rec_2020;
}
else {
std::cerr << "Invalid color-profile preset.\n";
return 5;
}
break;
case OPTION_VMT_METADATA_FILE:
vmt_metadata_file = optarg;
break;
case OPTION_BINARY_METADATA_TRACK:
binary_metadata_track = true;
break;
case OPTION_METADATA_TRACK_URI:
metadata_track_uri = optarg;
break;
case OPTION_SET_CLLI: {
auto clli_args = parse_comma_separated_numeric_arguments<uint16_t>(optarg,
{
std::numeric_limits<uint16_t>::max(),
std::numeric_limits<uint16_t>::max()
});
if (clli_args.empty()) {
std::cerr << "Invalid arguments for --clli option.\n";
}
else {
heif_content_light_level clliVal;
clliVal.max_content_light_level = clli_args[0];
clliVal.max_pic_average_light_level = clli_args[1];
clli = clliVal;
}
break;
}
case OPTION_SET_PASP: {
auto pasp_args = parse_comma_separated_numeric_arguments<uint32_t>(optarg,
{
std::numeric_limits<uint32_t>::max(),
std::numeric_limits<uint32_t>::max()
});
if (pasp_args.empty()) {
std::cerr << "Invalid arguments for --pasp option.\n";
}
else {
pixel_aspect_ratio aspect_ratio;
aspect_ratio.h = pasp_args[0];
aspect_ratio.v = pasp_args[1];
pasp = aspect_ratio;
}
break;
}
case OPTION_ADD_MIME_ITEM:
option_mime_item_type = optarg;
break;
case OPTION_MIME_ITEM_FILE:
option_mime_item_file = optarg;
break;
case OPTION_MIME_ITEM_NAME:
option_mime_item_name = optarg;
break;
case OPTION_METADATA_COMPRESSION: {
bool success = set_metadata_compression_method(optarg);
if (!success) {
exit(5);
}
break;
}
case OPTION_SEQUENCES_GIMI_TRACK_ID:
option_gimi_track_id = optarg;
break;
case OPTION_SEQUENCES_SAI_DATA_FILE:
option_sai_data_file = optarg;
break;
}
}
if (quality < 0 || quality > 100) {
std::cerr << "Invalid quality factor. Must be between 0 and 100.\n";
return 5;
}
if ((force_enc_av1f ? 1 : 0) + (force_enc_vvc ? 1 : 0) + (force_enc_uncompressed ? 1 : 0) + (force_enc_jpeg ? 1 : 0) +
(force_enc_jpeg2000 ? 1 : 0) + (force_enc_avc ? 1 : 0) + (force_enc_hevc ? 1 : 0) > 1) {
std::cerr << "Choose at most one output compression format.\n";
return 5;
}
if (encode_sequence && (use_tiling || cut_tiles)) {
std::cerr << "Image sequences cannot be used together with tiling.\n";
return 5;
}
if (sequence_timebase <= 0) {
std::cerr << "Sequence clock tick rate cannot be zero.\n";
return 5;
}
if (sequence_durations <= 0) {
std::cerr << "Sequence frame durations cannot be zero.\n";
return 5;
}
if (encode_sequence && !option_mime_item_file.empty()) {
std::cerr << "MIME item cannot be added to sequence-only files.\n";
return 5;
}
if (!option_sai_data_file.empty() && !encode_sequence) {
std::cerr << "Image SAI data can only be used with sequences.\n";
return 5;
}
if (logging_level > 0) {
logging_level += 2;
if (logging_level > 4) {
logging_level = 4;
}
}
// ==============================================================================
struct heif_encoder* encoder = nullptr;
if (list_encoders) {
show_list_of_all_encoders();
return 0;
}
// --- determine output compression format (from output filename or command line parameter)
heif_compression_format compressionFormat;
if (force_enc_av1f) {
compressionFormat = heif_compression_AV1;
}
else if (force_enc_vvc) {
compressionFormat = heif_compression_VVC;
}
else if (force_enc_avc) {
compressionFormat = heif_compression_AVC;
}
else if (force_enc_uncompressed) {
compressionFormat = heif_compression_uncompressed;
}
else if (force_enc_jpeg) {
compressionFormat = heif_compression_JPEG;
}
else if (force_enc_jpeg2000) {
compressionFormat = heif_compression_JPEG2000;
}
else if (force_enc_htj2k) {
compressionFormat = heif_compression_HTJ2K;
}
else if (force_enc_hevc) {
compressionFormat = heif_compression_HEVC;
}
else {
compressionFormat = guess_compression_format_from_filename(output_filename);
}
if (compressionFormat == heif_compression_undefined) {
compressionFormat = heif_compression_HEVC;
}
// --- select encoder
std::shared_ptr<heif_context> context(heif_context_alloc(),
[](heif_context* c) { heif_context_free(c); });
if (!context) {
std::cerr << "Could not create context object\n";
return 1;
}
#define MAX_ENCODERS 10
const heif_encoder_descriptor* encoder_descriptors[MAX_ENCODERS];
int count = heif_get_encoder_descriptors(compressionFormat,
nullptr,
encoder_descriptors, MAX_ENCODERS);
#undef MAX_ENCODERS
const heif_encoder_descriptor* active_encoder_descriptor = nullptr;
if (count > 0) {
int idx = 0;
if (encoderId != nullptr) {
for (int i = 0; i <= count; i++) {
if (i == count) {
std::cerr << "Unknown encoder ID. Choose one from the list below.\n";
show_list_of_encoders(encoder_descriptors, count);
return 5;
}
if (strcmp(encoderId, heif_encoder_descriptor_get_id_name(encoder_descriptors[i])) == 0) {
idx = i;
break;
}
}
}
heif_error error = heif_context_get_encoder(context.get(), encoder_descriptors[idx], &encoder);
if (error.code) {
std::cerr << error.message << "\n";
return 5;
}
active_encoder_descriptor = encoder_descriptors[idx];
}
else {
std::cerr << "No " << get_compression_format_name(compressionFormat) << " encoder available.\n";
return 5;
}
if (option_show_parameters) {
list_encoder_parameters(encoder);
heif_encoder_release(encoder);
return 0;
}
if (optind > argc - 1) {
show_help(argv[0]);
return 0;
}
if (lossless && !heif_encoder_descriptor_supports_lossless_compression(active_encoder_descriptor)) {
std::cerr << "Warning: the selected encoder does not support lossless encoding. Encoding in lossy mode.\n";
lossless = false;
}
// If we were given a list of filenames and no '-o' option, check whether the last filename is the desired output filename.
if (output_filename.empty() && argc>1) {
if (guess_compression_format_from_filename(argv[argc-1]) != heif_compression_undefined) {
output_filename = argv[argc-1];
argc--;
}
}
std::vector<std::string> args;
for (; optind < argc; optind++) {
args.emplace_back(argv[optind]);
}
// If we get a list of image filenames, but no '-o' option, assume that the last option
// denotes the output filename.
if (output_filename.empty() && args.size() > 1) {
output_filename = args.back();
args.pop_back();
}
if (!lossless) {
heif_encoder_set_lossy_quality(encoder, quality);
}
heif_encoder_set_logging_level(encoder, logging_level);
set_params(encoder, raw_params);
struct heif_encoding_options* options = heif_encoding_options_alloc();
options->save_two_colr_boxes_when_ICC_and_nclx_available = (uint8_t) two_colr_boxes;
if (chroma_downsampling == "average") {
options->color_conversion_options.preferred_chroma_downsampling_algorithm = heif_chroma_downsampling_average;
options->color_conversion_options.only_use_preferred_chroma_algorithm = true;
}
else if (chroma_downsampling == "sharp-yuv") {
options->color_conversion_options.preferred_chroma_downsampling_algorithm = heif_chroma_downsampling_sharp_yuv;
options->color_conversion_options.only_use_preferred_chroma_algorithm = true;
}
else if (chroma_downsampling == "nearest-neighbor") {
options->color_conversion_options.preferred_chroma_downsampling_algorithm = heif_chroma_downsampling_nearest_neighbor;
options->color_conversion_options.only_use_preferred_chroma_algorithm = true;
}
// --- if no output filename was given, synthesize one from the first input image filename
if (output_filename.empty()) {
const std::string& first_input_filename = args[0];
std::string filename_without_suffix;
std::string::size_type dot_position = first_input_filename.find_last_of('.');
if (dot_position != std::string::npos) {
filename_without_suffix = first_input_filename.substr(0, dot_position);
}
else {
filename_without_suffix = first_input_filename;
}
std::string suffix = suffix_for_compression_format(compressionFormat);
output_filename = filename_without_suffix + '.' + suffix;
}
int ret;
if (!encode_sequence) {
ret = do_encode_images(context.get(), encoder, options, args);
}
else {
ret = do_encode_sequence(context.get(), encoder, options, args);
}
if (ret != 0) {
heif_encoding_options_free(options);
heif_encoder_release(encoder);
return ret;
}
// --- write HEIF file
heif_error error = heif_context_write_to_file(context.get(), output_filename.c_str());
if (error.code) {
std::cerr << error.message << "\n";
return 5;
}
heif_encoding_options_free(options);
heif_encoder_release(encoder);
return 0;
}
int do_encode_images(heif_context* context, heif_encoder* encoder, heif_encoding_options* options, const std::vector<std::string>& args)
{
std::shared_ptr<heif_image> primary_image;
bool is_primary_image = true;
std::vector<heif_item_id> encoded_image_ids;
for (std::string input_filename : args) {
InputImage input_image = load_image(input_filename, output_bit_depth);
std::shared_ptr<heif_image> image = input_image.image;
heif_image_tiling tiling{};
std::shared_ptr<input_tiles_generator> tile_generator;
if (use_tiling) {
tile_generator = determine_input_images_tiling(input_filename, tiled_input_x_y);
if (tile_generator) {
tiling.version = 1;
tiling.num_columns = tile_generator->nColumns();
tiling.num_rows = tile_generator->nRows();
tiling.tile_width = heif_image_get_primary_width(image.get());
tiling.tile_height = heif_image_get_primary_height(image.get());
tiling.image_width = tiling.num_columns * tiling.tile_width;
tiling.image_height = tiling.num_rows * tiling.tile_height;
tiling.number_of_extra_dimensions = 0;
}
if (tiled_image_width) tiling.image_width = tiled_image_width;
if (tiled_image_height) tiling.image_height = tiled_image_height;
if (!tile_generator || tile_generator->nTiles()==1) {
std::cerr << "Cannot enumerate input tiles. Please use filenames with the two tile coordinates in the name.\n";
return 5;
}
}
else if (cut_tiles != 0) {
auto cutting_tile_generator = std::make_shared<input_tiles_generator_cut_image>(input_filename.c_str(),
cut_tiles, output_bit_depth);
tile_generator = cutting_tile_generator;
tiling.num_columns = tile_generator->nColumns();
tiling.num_rows = tile_generator->nRows();
tiling.tile_width = cut_tiles;
tiling.tile_height = cut_tiles;
tiling.image_width = cutting_tile_generator->get_image_width();
tiling.image_height = cutting_tile_generator->get_image_height();
tiling.number_of_extra_dimensions = 0;
}
if (!primary_image) {
primary_image = image;
}
#if HAVE_GETTIMEOFDAY
if (run_benchmark) {
gettimeofday(&time_encoding_start, nullptr);
}
#endif
heif_color_profile_nclx* nclx;
heif_error error = create_output_nclx_profile_and_configure_encoder(encoder, &nclx, primary_image,
lossless, output_color_profile_preset);
if (error.code) {
std::cerr << error.message << "\n";
return 5;
}
options->save_alpha_channel = (uint8_t) master_alpha;
options->output_nclx_profile = nclx;
options->image_orientation = input_image.orientation;
if (premultiplied_alpha) {
heif_image_set_premultiplied_alpha(image.get(), premultiplied_alpha);
}
heif_image_handle* handle;
if (use_tiling || cut_tiles > 0) {
handle = encode_tiled(context, encoder, options, output_bit_depth, tile_generator, tiling);
}
else {
error = heif_context_encode_image(context,
image.get(),
encoder,
options,
&handle);
if (error.code != 0) {
heif_nclx_color_profile_free(nclx);
std::cerr << "Could not encode HEIF/AVIF file: " << error.message << "\n";
return 1;
}
}
if (handle==nullptr) {
std::cerr << "Could not encode image\n";
return 1;
}
if (clli) {
heif_image_handle_set_content_light_level(handle, &*clli);
}
if (pasp) {
heif_image_handle_set_pixel_aspect_ratio(handle, pasp->h, pasp->v);
}
if (is_primary_image) {
heif_context_set_primary_image(context, handle);
}
encoded_image_ids.push_back(heif_image_handle_get_item_id(handle));
// write EXIF to HEIC
if (!input_image.exif.empty()) {
// Note: we do not modify the EXIF Orientation here because we want it to match the HEIF transforms.
// TODO: is this a good choice? Or should we set it to 1 (normal) so that other, faulty software will not transform it once more?
error = heif_context_add_exif_metadata(context, handle,
input_image.exif.data(), (int) input_image.exif.size());
if (error.code != 0) {
heif_nclx_color_profile_free(nclx);
std::cerr << "Could not write EXIF metadata: " << error.message << "\n";
return 1;
}
}
// write XMP to HEIC
if (!input_image.xmp.empty()) {
error = heif_context_add_XMP_metadata2(context, handle,
input_image.xmp.data(), (int) input_image.xmp.size(),
metadata_compression_method);
if (error.code != 0) {
heif_nclx_color_profile_free(nclx);
std::cerr << "Could not write XMP metadata: " << error.message << "\n";
return 1;
}
}
if (thumbnail_bbox_size > 0) {
// encode thumbnail
struct heif_image_handle* thumbnail_handle;
options->save_alpha_channel = master_alpha && thumb_alpha;
error = heif_context_encode_thumbnail(context,
image.get(),
handle,
encoder,
options,
thumbnail_bbox_size,
&thumbnail_handle);
if (error.code) {
heif_nclx_color_profile_free(nclx);
std::cerr << "Could not generate thumbnail: " << error.message << "\n";
return 5;
}
if (thumbnail_handle) {
heif_image_handle_release(thumbnail_handle);
}
}
#if HAVE_GETTIMEOFDAY
if (run_benchmark) {
gettimeofday(&time_encoding_end, nullptr);
}
#endif
heif_image_handle_release(handle);
heif_nclx_color_profile_free(nclx);
is_primary_image = false;
}
if (!property_pitm_description.empty()) {
heif_image_handle* primary_image_handle;
struct heif_error err = heif_context_get_primary_image_handle(context, &primary_image_handle);
if (err.code) {
std::cerr << "No primary image set, cannot set user description\n";
return 5;
}
heif_item_id pitm_id = heif_image_handle_get_item_id(primary_image_handle);
heif_property_user_description udes;
udes.lang = nullptr;
udes.name = nullptr;
udes.tags = nullptr;
udes.description = property_pitm_description.c_str();
err = heif_item_add_property_user_description(context, pitm_id, &udes, nullptr);
if (err.code) {
std::cerr << "Cannot set user description\n";
return 5;
}
heif_image_handle_release(primary_image_handle);
}
#if HEIF_ENABLE_EXPERIMENTAL_FEATURES
if (add_pyramid_group && encoded_image_ids.size() > 1) {
heif_error error = heif_context_add_pyramid_entity_group(context, encoded_image_ids.data(), encoded_image_ids.size(), nullptr);
if (error.code) {
std::cerr << "Cannot set multi-resolution pyramid: " << error.message << "\n";
return 5;
}
}
#endif
// --- add extra MIME item with user data
if (!option_mime_item_file.empty() || !option_mime_item_type.empty()) {
if (option_mime_item_file.empty() || option_mime_item_type.empty()) {
std::cerr << "Options --add-mime-item and --mime-item-file have to be used together\n";
return 5;
}
std::ifstream istr(option_mime_item_file.c_str(), std::ios::binary | std::ios::ate);
if (!istr) {
std::cerr << "Failed to open file for MIME item: '" << option_mime_item_file << "'\n";
return 5;
}
// Get size by seeking to the end (thanks to ios::ate)
std::streamsize size = istr.tellg();
if (size < 0) {
std::cerr << "Querying size of file '" << option_mime_item_file << "' failed.\n";
return 5;
}
std::vector<uint8_t> buffer(size);
// Seek back to beginning and read
istr.seekg(0, std::ios::beg);
istr.read(reinterpret_cast<char*>(buffer.data()), size);
heif_item_id itemId;
heif_context_add_mime_item(context, option_mime_item_type.c_str(),
metadata_compression_method,
buffer.data(), (int)buffer.size(),
&itemId);
if (!option_mime_item_name.empty()) {
heif_item_set_item_name(context, itemId, option_mime_item_name.c_str());
}
}
if (run_benchmark) {
double psnr = compute_psnr(primary_image.get(), output_filename);
std::cout << "PSNR: " << std::setprecision(2) << std::fixed << psnr << " ";
#if HAVE_GETTIMEOFDAY
double t = (double) (time_encoding_end.tv_sec - time_encoding_start.tv_sec) + (double) (time_encoding_end.tv_usec - time_encoding_start.tv_usec) / 1000000.0;
std::cout << "time: " << std::setprecision(1) << std::fixed << t << " ";
#endif
std::ifstream istr(output_filename.c_str());
istr.seekg(0, std::ios_base::end);
std::streamoff size = istr.tellg();
std::cout << "size: " << size << "\n";
}
return 0;
}
std::vector<std::string> deflate_input_filenames(const std::string& filename_example)
{
std::regex pattern(R"((.*\D)?(\d+)(\..+)$)");
std::smatch match;
if (!std::regex_match(filename_example, match, pattern)) {
return {filename_example};
}
std::string prefix = match[1];
auto p = std::filesystem::absolute(std::filesystem::path(prefix));
std::filesystem::path directory = p.parent_path();
std::string filename_prefix = p.filename().string(); // TODO: we could also use u8string(), but it is not well supported in C++20
std::string number = match[2];
std::string suffix = match[3];
std::string patternString = filename_prefix + "(\\d+)" + suffix + "$";
pattern = patternString;
uint32_t digits = std::numeric_limits<uint32_t>::max();
uint32_t start = std::numeric_limits<uint32_t>::max();
uint32_t end = 0;
for (const auto& dirEntry : std::filesystem::directory_iterator(directory))
{
if (dirEntry.is_regular_file()) {
std::string s{dirEntry.path().filename().string()};
if (std::regex_match(s, match, pattern)) {
digits = std::min(digits, (uint32_t)match[1].length());
uint32_t number = std::stoi(match[1]);
start = std::min(start, number);
end = std::max(end, number);
}
}
}
std::vector<std::string> files;
for (uint32_t i=start;i<=end;i++)
{
std::stringstream sstr;
sstr << prefix << std::setw(digits) << std::setfill('0') << i << suffix;
std::filesystem::path p = directory / sstr.str();
files.emplace_back(p.string());
}
return files;
}
std::optional<uint8_t> nibble_to_val(char c)
{
if (c>='0' && c<='9') {
return c - '0';
}
if (c>='a' && c<='f') {
return c - 'a' + 10;
}
if (c>='A' && c<='F') {
return c - 'A' + 10;
}
return std::nullopt;
}
// Convert hex data to raw binary. Ignore any non-hex characters.
static std::vector<uint8_t> hex_to_binary(const std::string& line)
{
std::vector<uint8_t> data;
uint8_t current_value = 0;
bool high_nibble = true;
for (auto c : line) {
auto v = nibble_to_val(c);
if (v) {
if (high_nibble) {
current_value = static_cast<uint8_t>(*v << 4);
high_nibble = false;
}
else {
current_value |= *v;
data.push_back(current_value);
high_nibble = true;
}
}
}
return data;
}
int encode_vmt_metadata_track(heif_context* context, heif_track* visual_track,
const std::string& track_uri, bool binary)
{
// --- add metadata track
heif_track* track = nullptr;
heif_track_options* track_options = heif_track_options_alloc();
heif_track_options_set_timescale(track_options, 1000);
heif_context_add_uri_metadata_sequence_track(context, track_uri.c_str(), track_options, &track);
heif_raw_sequence_sample* sample = heif_raw_sequence_sample_alloc();
std::ifstream istr(vmt_metadata_file.c_str());
std::regex pattern(R"((\d\d):(\d\d):(\d\d).(\d\d\d) -->$)");
static std::vector<uint8_t> prev_metadata;
static std::optional<uint32_t> prev_ts;
std::string line;
while (std::getline(istr, line))
{
std::smatch match;
if (!std::regex_match(line, match, pattern)) {
continue;
}
std::string hh = match[1];
std::string mm = match[2];
std::string ss = match[3];
std::string mil = match[4];
uint32_t ts = (std::stoi(hh) * 3600 * 1000 +
std::stoi(mm) * 60 * 1000 +
std::stoi(ss) * 1000 +
std::stoi(mil));
std::vector<uint8_t> concat;
if (binary) {
while (std::getline(istr, line)) {
if (line.empty()) {
break;
}
std::vector<uint8_t> binaryData = hex_to_binary(line);
concat.insert(concat.end(), binaryData.begin(), binaryData.end());
}
}
else {
while (std::getline(istr, line)) {
if (line.empty()) {
break;
}
concat.insert(concat.end(), line.data(), line.data() + line.length());
concat.push_back('\n');
}
concat.push_back(0);
}
if (prev_ts) {
heif_raw_sequence_sample_set_data(sample, (const uint8_t*)prev_metadata.data(), prev_metadata.size());
heif_raw_sequence_sample_set_duration(sample, ts - *prev_ts);
heif_track_add_raw_sequence_sample(track, sample);
}
prev_ts = ts;
prev_metadata = concat;
}
// --- flush last metadata packet
heif_raw_sequence_sample_set_data(sample, (const uint8_t*)prev_metadata.data(), prev_metadata.size());
heif_raw_sequence_sample_set_duration(sample, 1);
heif_track_add_raw_sequence_sample(track, sample);
// --- add track reference
heif_track_add_reference_to_track(track, heif_track_reference_type_description, visual_track);
// --- release all objects
heif_raw_sequence_sample_release(sample);
heif_track_options_release(track_options);
heif_track_release(track);
return 0;
}
int do_encode_sequence(heif_context* context, heif_encoder* encoder, heif_encoding_options* options, std::vector<std::string> args)
{
if (args.size() == 1) {
args = deflate_input_filenames(args[0]);
}
size_t currImage = 0;
size_t nImages = args.size();
if (sequence_max_frames && nImages > static_cast<size_t>(sequence_max_frames)) {
nImages = sequence_max_frames;
}
// --- optionally load SAI data to be used for the frames
SAI_datafile sai_data;
if (!option_sai_data_file.empty()) {
sai_data.load_sai_data_from_file(option_sai_data_file.c_str());
}
uint16_t image_width=0, image_height=0;
bool first_image = true;
heif_track* track = nullptr;
heif_sequence_encoding_options* encoding_options = nullptr;
for (std::string input_filename : args) {
currImage++;
if (currImage > nImages) {
break;
}
std::cout << "\rencoding sequence image " << currImage << "/" << nImages;
std::cout.flush();
InputImage input_image = load_image(input_filename, output_bit_depth);
std::shared_ptr<heif_image> image = input_image.image;
int w = heif_image_get_primary_width(image.get());
int h = heif_image_get_primary_height(image.get());
if (w > 0xFFFF || h > 0xFFFF) {
std::cerr << "maximum image size of 65535x65535 exceeded\n";
return 5;
}
if (first_image) {
heif_track_options* track_options = heif_track_options_alloc();
heif_track_options_set_timescale(track_options, sequence_timebase);
if (!option_gimi_track_id.empty()) {
heif_track_options_set_gimi_track_id(track_options, option_gimi_track_id.c_str());
}
if (sai_data.tai_clock_info) {
heif_track_options_enable_sample_tai_timestamps(track_options,
sai_data.tai_clock_info,
heif_sample_aux_info_presence_optional);
}
if (!sai_data.gimi_content_ids.empty()) {
heif_track_options_enable_sample_gimi_content_ids(track_options,
heif_sample_aux_info_presence_optional);
}
heif_context_set_sequence_timescale(context, sequence_timebase);
heif_context_set_number_of_sequence_repetitions(context, sequence_repetitions);
encoding_options = heif_sequence_encoding_options_alloc();
encoding_options->gop_structure = sequence_gop_structure;
encoding_options->keyframe_distance_min = sequence_keyframe_distance_min;
encoding_options->keyframe_distance_max = sequence_keyframe_distance_max;
encoding_options->save_alpha_channel = master_alpha;
image_width = static_cast<uint16_t>(w);
image_height = static_cast<uint16_t>(h);
heif_context_add_visual_sequence_track(context,
image_width, image_height,
use_video_handler ? heif_track_type_video : heif_track_type_image_sequence,
track_options,
encoding_options,
&track);
heif_track_options_release(track_options);
first_image = false;
}
if (image_width != static_cast<uint16_t>(w) ||
image_height != static_cast<uint16_t>(h)) {
std::cerr << "image '" << input_filename << "' has size " << w << "x" << h
<< " which is different from the first image size " << image_width << "x" << image_height << "\n";
return 5;
}
heif_color_profile_nclx* nclx;
heif_error error = create_output_nclx_profile_and_configure_encoder(encoder, &nclx, image, lossless, output_color_profile_preset);
if (error.code) {
std::cerr << error.message << "\n";
return 5;
}
//seq_options->save_alpha_channel = false; // TODO: sequences with alpha ?
encoding_options->output_nclx_profile = nclx;
//seq_options->image_orientation = heif_orientation_normal; // input_image.orientation; TODO: sequence rotation
heif_image_set_duration(image.get(), sequence_durations);
// --- set SAI data
if (currImage-1 < sai_data.gimi_content_ids.size()) {
if (!sai_data.gimi_content_ids[currImage-1].empty()) {
heif_image_set_gimi_sample_content_id(image.get(), sai_data.gimi_content_ids[currImage-1].c_str());
}
}
if (currImage-1 < sai_data.tai_timestamps.size()) {
if (sai_data.tai_timestamps[currImage-1]) {
heif_image_set_tai_timestamp(image.get(), sai_data.tai_timestamps[currImage-1]);
}
}
// --- encode image
error = heif_track_encode_sequence_image(track, image.get(), encoder, encoding_options);
if (error.code) {
heif_nclx_color_profile_free(nclx);
std::cerr << "Cannot encode sequence image: " << error.message << "\n";
return 5;
}
heif_nclx_color_profile_free(nclx);
}
std::cout << "\n";
heif_error error = heif_track_encode_end_of_sequence(track, encoder);
if (error.code) {
std::cerr << "Cannot end sequence: " << error.message << "\n";
return 5;
}
if (!vmt_metadata_file.empty()) {
int ret = encode_vmt_metadata_track(context, track, metadata_track_uri, binary_metadata_track);
if (ret) {
return ret;
}
}
heif_track_release(track);
heif_sequence_encoding_options_release(encoding_options);
// --- add first image as image item
if (!use_video_handler) {
do_encode_images(context, encoder, options, {args[0]});
}
return 0;
}
|