kc3-lang/libjpeg-turbo/java/doc/org/libjpegturbo/turbojpeg/TJDecompressor.html
-
Show log
Commit
-
Hash : 94c64ead
Author :
Date : 2024-06-17T20:27:57
Various doc tweaks - "bits per component" = "bits per sample" Describing the data precision of a JPEG image using "bits per component" is technically correct, but "bits per sample" is the terminology that the JPEG-1 spec uses. Also, "bits per component" is more commonly used to describe the precision of packed-pixel formats (as opposed to "bits per pixel") rather than planar formats, in which all components are grouped together. - Unmention legacy display technologies. Colormapped and monochrome displays aren't a thing anymore, and even when they were still a thing, it was possible to display full-color images to them. In 1991, when JPEG decompression time was measured in minutes per megapixel, it made sense to keep a decompressed copy of JPEG images on disk, in a format that could be displayed without further color conversion (since color conversion was slow and memory-intensive.) In 2024, JPEG decompression time is measured in milliseconds per megapixel, and color conversion is even faster. Thus, JPEG images can be decompressed, displayed, and color-converted (if necessary) "on the fly" at speeds too fast for human vision to perceive. (In fact, your TV performs much more complicated decompression algorithms at least 60 times per second.) - Document that color quantization (and associated features), GIF input/output, Targa input/output, and OS/2 BMP input/output are legacy features. Legacy status doesn't necessarily mean that the features are deprecated. Rather, it is meant to discourage users from using features that may be of little or no benefit on modern machines (such as low-quality modes that had significant performance advantages in the early 1990s but no longer do) and that are maintained on a break/fix basis only. - General wordsmithing, grammar/punctuation policing, and formatting tweaks - Clarify which data precisions each cjpeg input format and each djpeg output format supports. - cjpeg.1: Remove unnecessary and impolitic statement about the -targa switch. - Adjust or remove performance claims to reflect the fact that: * On modern machines, the djpeg "-fast" switch has a negligible effect on performance. * There is a measurable difference between the performance of Floyd- Steinberg dithering and no dithering, but it is not likely perceptible to most users. * There is a measurable difference between the performance of 1-pass and 2-pass color quantization, but it is not likely perceptible to most users. * There is a measurable difference between the performance of full-color and grayscale output when decompressing a full-color JPEG image, but it is not likely perceptible to most users. * IDCT scaling does not necessarily improve performance. (It generally does if the scaling factor is <= 1/2 and generally doesn't if the scaling factor is > 1/2, at least on my machine. The performance claim made in jpeg-6b was probably invalidated when we merged the additional scaling factors from jpeg-7.) - Clarify which djpeg switches/output formats cannot be used when decompressing lossless JPEG images. - Remove djpeg hints, since those involve quality vs. speed tradeoffs that are no longer relevant for modern machines. - Remove documentation regarding using color quantization with 16-bit data precision. (Color quantization requires lossy mode.) - Java: Fix typos in TJDecompressor.decompress12() and TJDecompressor.decompress16() documentation. - jpegtran.1: Fix truncated paragraph In a man page, a single quote at the start of a line is interpreted as a macro. Closes #775 - libjpeg.txt: * Mention J16SAMPLE data type (oversight.) * Remove statement about extending jdcolor.c. (libjpeg-turbo is not quite as DIY as libjpeg once was.) * Remove paragraph about tweaking the various typedefs in jmorecfg.h. It is no longer relevant for modern machines. * Remove caveat regarding systems with ints less than 16 bits wide. (ANSI/ISO C requires an int to be at least 16 bits wide, and libjpeg-turbo has never supported non-ANSI compilers.) - usage.txt: * Add copyright header. * Document cjpeg -icc, -memdst, -report, -strict, and -version switches. * Document djpeg -icc, -maxscans, -memsrc, -report, -skip, -crop, -strict, and -version switches. * Document jpegtran -icc, -maxscans, -report, -strict, and -version switches.
-
java/doc/org/libjpegturbo/turbojpeg/TJDecompressor.html
-
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
<!DOCTYPE HTML> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc --> <title>TJDecompressor</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style"> <script type="text/javascript" src="../../../script.js"></script> <script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script> <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> <!--[if IE]> <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> <![endif]--> <script type="text/javascript" src="../../../jquery/jquery-3.6.1.min.js"></script> <script type="text/javascript" src="../../../jquery/jquery-ui.min.js"></script> </head> <body> <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="TJDecompressor"; } } catch(err) { } //--> var data = {"i0":10,"i1":42,"i2":42,"i3":42,"i4":42,"i5":42,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":42,"i18":42,"i19":10,"i20":42,"i21":10,"i22":10,"i23":42,"i24":10,"i25":10,"i26":10,"i27":42,"i28":42,"i29":42,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; var activeTableTab = "activeTableTab"; var pathtoroot = "../../../"; var useModuleDirectories = true; loadScripts(document, 'script');</script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <header role="banner"> <nav role="navigation"> <div class="fixedNav"> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a id="navbar.top"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <a id="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../allclasses.html">All Classes</a></li> </ul> <ul class="navListSearch"> <li><label for="search">SEARCH:</label> <input type="text" id="search" value="search" disabled="disabled"> <input type="reset" id="reset" value="reset" disabled="disabled"> </li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a id="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> </div> <div class="navPadding"> </div> <script type="text/javascript"><!-- $('.navPadding').css('padding-top', $('.fixedNav').css("height")); //--> </script> </nav> </header> <!-- ======== START OF CLASS DATA ======== --> <main role="main"> <div class="header"> <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.libjpegturbo.turbojpeg</a></div> <h2 title="Class TJDecompressor" class="title">Class TJDecompressor</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.libjpegturbo.turbojpeg.TJDecompressor</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd><code>java.io.Closeable</code>, <code>java.lang.AutoCloseable</code></dd> </dl> <dl> <dt>Direct Known Subclasses:</dt> <dd><code><a href="TJTransformer.html" title="class in org.libjpegturbo.turbojpeg">TJTransformer</a></code></dd> </dl> <hr> <pre>public class <span class="typeNameLabel">TJDecompressor</span> extends java.lang.Object implements java.io.Closeable</pre> <div class="block">TurboJPEG decompressor</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <section> <ul class="blockList"> <li class="blockList"><a id="constructor.summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="memberSummary"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Constructor</th> <th class="colLast" scope="col">Description</th> </tr> <tr class="altColor"> <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">TJDecompressor</a></span>()</code></th> <td class="colLast"> <div class="block">Create a TurboJPEG decompresssor instance.</div> </td> </tr> <tr class="rowColor"> <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(byte%5B%5D)">TJDecompressor</a></span>​(byte[] jpegImage)</code></th> <td class="colLast"> <div class="block">Create a TurboJPEG decompressor instance and associate the JPEG source image or "abbreviated table specification" (AKA "tables-only") datastream stored in <code>jpegImage</code> with the newly created instance.</div> </td> </tr> <tr class="altColor"> <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(byte%5B%5D,int)">TJDecompressor</a></span>​(byte[] jpegImage, int imageSize)</code></th> <td class="colLast"> <div class="block">Create a TurboJPEG decompressor instance and associate the JPEG source image or "abbreviated table specification" (AKA "tables-only") datastream of length <code>imageSize</code> bytes stored in <code>jpegImage</code> with the newly created instance.</div> </td> </tr> <tr class="rowColor"> <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.libjpegturbo.turbojpeg.YUVImage)">TJDecompressor</a></span>​(<a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a> yuvImage)</code></th> <td class="colLast"> <div class="block">Create a TurboJPEG decompressor instance and associate the 8-bit-per-sample planar YUV source image stored in <code>yuvImage</code> with the newly created instance.</div> </td> </tr> </table> </li> </ul> </section> <!-- ========== METHOD SUMMARY =========== --> <section> <ul class="blockList"> <li class="blockList"><a id="method.summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="memberSummary"> <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colSecond" scope="col">Method</th> <th class="colLast" scope="col">Description</th> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th> <td class="colLast"> <div class="block">Free the native structures associated with this decompressor instance.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompress(byte%5B%5D,int,int,int,int,int,int,int)">decompress</a></span>​(byte[] dstBuf, int x, int y, int desiredWidth, int pitch, int desiredHeight, int pixelFormat, int flags)</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <a href="#set(int,int)"><code>set()</code></a>, <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, and <a href="#decompress8(byte%5B%5D,int,int,int,int)"><code>decompress8(byte[], int, int, int, int)</code></a> instead.</div> </div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompress(int%5B%5D,int,int,int,int,int,int,int)">decompress</a></span>​(int[] dstBuf, int x, int y, int desiredWidth, int stride, int desiredHeight, int pixelFormat, int flags)</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <a href="#set(int,int)"><code>set()</code></a>, <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, and <a href="#decompress8(int%5B%5D,int,int,int,int)"><code>decompress8(int[], int, int, int, int)</code></a> instead.</div> </div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>java.awt.image.BufferedImage</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompress(int,int,int,int)">decompress</a></span>​(int desiredWidth, int desiredHeight, int bufferedImageType, int flags)</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <a href="#set(int,int)"><code>set()</code></a>, <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, and <a href="#decompress8(int)"><code>decompress8(int)</code></a> instead.</div> </div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>byte[]</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompress(int,int,int,int,int)">decompress</a></span>​(int desiredWidth, int pitch, int desiredHeight, int pixelFormat, int flags)</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <a href="#set(int,int)"><code>set()</code></a>, <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, and <a href="#decompress8(int,int)"><code>decompress8(int, int)</code></a> instead.</div> </div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompress(java.awt.image.BufferedImage,int)">decompress</a></span>​(java.awt.image.BufferedImage dstImage, int flags)</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <a href="#set(int,int)"><code>set()</code></a>, <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, and <a href="#decompress8(java.awt.image.BufferedImage)"><code>decompress8(BufferedImage)</code></a> instead.</div> </div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>short[]</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompress12(int,int)">decompress12</a></span>​(int pitch, int pixelFormat)</code></th> <td class="colLast"> <div class="block">Decompress the 12-bit-per-sample JPEG source image associated with this decompressor instance and return a buffer containing a 12-bit-per-sample packed-pixel decompressed image.</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompress12(short%5B%5D,int,int,int,int)">decompress12</a></span>​(short[] dstBuf, int x, int y, int pitch, int pixelFormat)</code></th> <td class="colLast"> <div class="block">Decompress the 12-bit-per-sample JPEG source image associated with this decompressor instance and output a 12-bit-per-sample packed-pixel grayscale, RGB, or CMYK image to the given destination buffer.</div> </td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>short[]</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompress16(int,int)">decompress16</a></span>​(int pitch, int pixelFormat)</code></th> <td class="colLast"> <div class="block">Decompress the 16-bit-per-sample JPEG source image associated with this decompressor instance and return a buffer containing a 16-bit-per-sample packed-pixel decompressed image.</div> </td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompress16(short%5B%5D,int,int,int,int)">decompress16</a></span>​(short[] dstBuf, int x, int y, int pitch, int pixelFormat)</code></th> <td class="colLast"> <div class="block">Decompress the 16-bit-per-sample lossless JPEG source image associated with this decompressor instance and output a 16-bit-per-sample packed-pixel grayscale, RGB, or CMYK image to the given destination buffer.</div> </td> </tr> <tr id="i10" class="altColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompress8(byte%5B%5D,int,int,int,int)">decompress8</a></span>​(byte[] dstBuf, int x, int y, int pitch, int pixelFormat)</code></th> <td class="colLast"> <div class="block">Decompress the 8-bit-per-sample JPEG source image or decode the planar YUV source image associated with this decompressor instance and output an 8-bit-per-sample packed-pixel grayscale, RGB, or CMYK image to the given destination buffer.</div> </td> </tr> <tr id="i11" class="rowColor"> <td class="colFirst"><code>java.awt.image.BufferedImage</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompress8(int)">decompress8</a></span>​(int bufferedImageType)</code></th> <td class="colLast"> <div class="block">Decompress the 8-bit-per-sample JPEG source image or decode the planar YUV source image associated with this decompressor instance and return a <code>BufferedImage</code> instance containing the 8-bit-per-sample packed-pixel decompressed/decoded image.</div> </td> </tr> <tr id="i12" class="altColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompress8(int%5B%5D,int,int,int,int)">decompress8</a></span>​(int[] dstBuf, int x, int y, int stride, int pixelFormat)</code></th> <td class="colLast"> <div class="block">Decompress the 8-bit-per-sample JPEG source image or decode the planar YUV source image associated with this decompressor instance and output an 8-bit-per-sample packed-pixel grayscale, RGB, or CMYK image to the given destination buffer.</div> </td> </tr> <tr id="i13" class="rowColor"> <td class="colFirst"><code>byte[]</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompress8(int,int)">decompress8</a></span>​(int pitch, int pixelFormat)</code></th> <td class="colLast"> <div class="block">Decompress the 8-bit-per-sample JPEG source image or decode the planar YUV source image associated with this decompressor instance and return a buffer containing an 8-bit-per-sample packed-pixel decompressed image.</div> </td> </tr> <tr id="i14" class="altColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompress8(java.awt.image.BufferedImage)">decompress8</a></span>​(java.awt.image.BufferedImage dstImage)</code></th> <td class="colLast"> <div class="block">Decompress the 8-bit-per-sample JPEG source image or decode the planar YUV source image associated with this decompressor instance and output an 8-bit-per-sample packed-pixel decompressed/decoded image to the given <code>BufferedImage</code> instance.</div> </td> </tr> <tr id="i15" class="rowColor"> <td class="colFirst"><code><a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompressToYUV(int)">decompressToYUV</a></span>​(int align)</code></th> <td class="colLast"> <div class="block">Decompress the 8-bit-per-sample JPEG source image associated with this decompressor instance into an 8-bit-per-sample unified planar YUV image and return a <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>YUVImage</code></a> instance containing the decompressed image.</div> </td> </tr> <tr id="i16" class="altColor"> <td class="colFirst"><code><a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompressToYUV(int%5B%5D)">decompressToYUV</a></span>​(int[] strides)</code></th> <td class="colLast"> <div class="block">Decompress the 8-bit-per-sample JPEG source image associated with this decompressor instance into a set of 8-bit-per-sample Y, U (Cb), and V (Cr) image planes and return a <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>YUVImage</code></a> instance containing the decompressed image planes.</div> </td> </tr> <tr id="i17" class="rowColor"> <td class="colFirst"><code><a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompressToYUV(int,int%5B%5D,int,int)">decompressToYUV</a></span>​(int desiredWidth, int[] strides, int desiredHeight, int flags)</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <a href="#set(int,int)"><code>set()</code></a>, <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, and <a href="#decompressToYUV(int%5B%5D)"><code>decompressToYUV(int[])</code></a> instead.</div> </div> </td> </tr> <tr id="i18" class="altColor"> <td class="colFirst"><code><a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompressToYUV(int,int,int,int)">decompressToYUV</a></span>​(int desiredWidth, int align, int desiredHeight, int flags)</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <a href="#set(int,int)"><code>set()</code></a>, <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, and <a href="#decompressToYUV(int)"><code>decompressToYUV(int)</code></a> instead.</div> </div> </td> </tr> <tr id="i19" class="rowColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompressToYUV(org.libjpegturbo.turbojpeg.YUVImage)">decompressToYUV</a></span>​(<a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a> dstImage)</code></th> <td class="colLast"> <div class="block">Decompress the 8-bit-per-sample JPEG source image associated with this decompressor instance into an 8-bit-per-sample planar YUV image and store it in the given <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>YUVImage</code></a> instance.</div> </td> </tr> <tr id="i20" class="altColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompressToYUV(org.libjpegturbo.turbojpeg.YUVImage,int)">decompressToYUV</a></span>​(<a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a> dstImage, int flags)</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <a href="#set(int,int)"><code>set()</code></a>, <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, and <a href="#decompressToYUV(org.libjpegturbo.turbojpeg.YUVImage)"><code>decompressToYUV(YUVImage)</code></a> instead.</div> </div> </td> </tr> <tr id="i21" class="rowColor"> <td class="colFirst"><code>protected void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#finalize()">finalize</a></span>()</code></th> <td class="colLast"> </td> </tr> <tr id="i22" class="altColor"> <td class="colFirst"><code>int</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(int)">get</a></span>​(int param)</code></th> <td class="colLast"> <div class="block">Get the value of a decompression parameter.</div> </td> </tr> <tr id="i23" class="rowColor"> <td class="colFirst"><code>int</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getColorspace()">getColorspace</a></span>()</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <code><a href="#get(int)"><code>get</code></a>(<a href="TJ.html#PARAM_COLORSPACE"><code>TJ.PARAM_COLORSPACE</code></a>)</code> instead.</div> </div> </td> </tr> <tr id="i24" class="altColor"> <td class="colFirst"><code>int</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeight()">getHeight</a></span>()</code></th> <td class="colLast"> <div class="block">Returns the height of the source image (JPEG or YUV) associated with this decompressor instance.</div> </td> </tr> <tr id="i25" class="rowColor"> <td class="colFirst"><code>byte[]</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJPEGBuf()">getJPEGBuf</a></span>()</code></th> <td class="colLast"> <div class="block">Returns the JPEG buffer associated with this decompressor instance.</div> </td> </tr> <tr id="i26" class="altColor"> <td class="colFirst"><code>int</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJPEGSize()">getJPEGSize</a></span>()</code></th> <td class="colLast"> <div class="block">Returns the size of the JPEG image (in bytes) associated with this decompressor instance.</div> </td> </tr> <tr id="i27" class="rowColor"> <td class="colFirst"><code>int</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getScaledHeight(int,int)">getScaledHeight</a></span>​(int desiredWidth, int desiredHeight)</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a> and <a href="TJScalingFactor.html#getScaled(int)"><code>TJScalingFactor.getScaled()</code></a> instead.</div> </div> </td> </tr> <tr id="i28" class="altColor"> <td class="colFirst"><code>int</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getScaledWidth(int,int)">getScaledWidth</a></span>​(int desiredWidth, int desiredHeight)</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a> and <a href="TJScalingFactor.html#getScaled(int)"><code>TJScalingFactor.getScaled()</code></a> instead.</div> </div> </td> </tr> <tr id="i29" class="rowColor"> <td class="colFirst"><code>int</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSubsamp()">getSubsamp</a></span>()</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <code><a href="#get(int)"><code>get</code></a>(<a href="TJ.html#PARAM_SUBSAMP"><code>TJ.PARAM_SUBSAMP</code></a>)</code> instead.</div> </div> </td> </tr> <tr id="i30" class="altColor"> <td class="colFirst"><code>int</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWidth()">getWidth</a></span>()</code></th> <td class="colLast"> <div class="block">Returns the width of the source image (JPEG or YUV) associated with this decompressor instance.</div> </td> </tr> <tr id="i31" class="rowColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#set(int,int)">set</a></span>​(int param, int value)</code></th> <td class="colLast"> <div class="block">Set the value of a decompression parameter.</div> </td> </tr> <tr id="i32" class="altColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCroppingRegion(java.awt.Rectangle)">setCroppingRegion</a></span>​(java.awt.Rectangle croppingRegion)</code></th> <td class="colLast"> <div class="block">Set the cropping region for partially decompressing a lossy JPEG image into a packed-pixel image.</div> </td> </tr> <tr id="i33" class="rowColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)">setScalingFactor</a></span>​(<a href="TJScalingFactor.html" title="class in org.libjpegturbo.turbojpeg">TJScalingFactor</a> scalingFactor)</code></th> <td class="colLast"> <div class="block">Set the scaling factor for subsequent lossy decompression operations.</div> </td> </tr> <tr id="i34" class="altColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSourceImage(byte%5B%5D,int)">setSourceImage</a></span>​(byte[] jpegImage, int imageSize)</code></th> <td class="colLast"> <div class="block">Associate the JPEG image or "abbreviated table specification" (AKA "tables-only") datastream of length <code>imageSize</code> bytes stored in <code>jpegImage</code> with this decompressor instance.</div> </td> </tr> <tr id="i35" class="rowColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSourceImage(org.libjpegturbo.turbojpeg.YUVImage)">setSourceImage</a></span>​(<a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a> srcImage)</code></th> <td class="colLast"> <div class="block">Associate the specified planar YUV source image with this decompressor instance.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> <code>clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> </section> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <section> <ul class="blockList"> <li class="blockList"><a id="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a id="<init>()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>TJDecompressor</h4> <pre>public TJDecompressor() throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Create a TurboJPEG decompresssor instance.</div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="<init>(byte[])"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>TJDecompressor</h4> <pre>public TJDecompressor​(byte[] jpegImage) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Create a TurboJPEG decompressor instance and associate the JPEG source image or "abbreviated table specification" (AKA "tables-only") datastream stored in <code>jpegImage</code> with the newly created instance. Refer to <a href="#setSourceImage(byte%5B%5D,int)"><code>setSourceImage(byte[], int)</code></a> for more details.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>jpegImage</code> - buffer containing a JPEG source image or tables-only datastream. (The size of the JPEG image or datastream is assumed to be the length of the array.) This buffer is not modified.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="<init>(byte[],int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>TJDecompressor</h4> <pre>public TJDecompressor​(byte[] jpegImage, int imageSize) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Create a TurboJPEG decompressor instance and associate the JPEG source image or "abbreviated table specification" (AKA "tables-only") datastream of length <code>imageSize</code> bytes stored in <code>jpegImage</code> with the newly created instance. Refer to <a href="#setSourceImage(byte%5B%5D,int)"><code>setSourceImage(byte[], int)</code></a> for more details.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>jpegImage</code> - buffer containing a JPEG source image or tables-only datastream. This buffer is not modified.</dd> <dd><code>imageSize</code> - size of the JPEG source image or tables-only datastream (in bytes)</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="<init>(org.libjpegturbo.turbojpeg.YUVImage)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>TJDecompressor</h4> <pre>public TJDecompressor​(<a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a> yuvImage) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Create a TurboJPEG decompressor instance and associate the 8-bit-per-sample planar YUV source image stored in <code>yuvImage</code> with the newly created instance. Refer to <a href="#setSourceImage(org.libjpegturbo.turbojpeg.YUVImage)"><code>setSourceImage(YUVImage)</code></a> for more details.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>yuvImage</code> - <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>YUVImage</code></a> instance containing a planar YUV source image to be decoded. This image is not modified.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> </li> </ul> </section> <!-- ============ METHOD DETAIL ========== --> <section> <ul class="blockList"> <li class="blockList"><a id="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a id="setSourceImage(byte[],int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setSourceImage</h4> <pre class="methodSignature">public void setSourceImage​(byte[] jpegImage, int imageSize) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Associate the JPEG image or "abbreviated table specification" (AKA "tables-only") datastream of length <code>imageSize</code> bytes stored in <code>jpegImage</code> with this decompressor instance. If <code>jpegImage</code> contains a JPEG image, then this image will be used as the source image for subsequent decompression operations. Passing a tables-only datastream to this method primes the decompressor with quantization and Huffman tables that can be used when decompressing subsequent "abbreviated image" datastreams. This is useful, for instance, when decompressing video streams in which all frames share the same quantization and Huffman tables. If a JPEG image is passed to this method, then the <a href="TJ.html#PARAM_STOPONWARNING"><code>parameters</code></a> that describe the JPEG image will be set when the method returns.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>jpegImage</code> - buffer containing a JPEG source image or tables-only datastream. This buffer is not modified.</dd> <dd><code>imageSize</code> - size of the JPEG source image or tables-only datastream (in bytes)</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="setSourceImage(org.libjpegturbo.turbojpeg.YUVImage)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setSourceImage</h4> <pre class="methodSignature">public void setSourceImage​(<a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a> srcImage)</pre> <div class="block">Associate the specified planar YUV source image with this decompressor instance. Subsequent decompression operations will decode this image into a packed-pixel RGB or grayscale destination image. This method sets <a href="TJ.html#PARAM_SUBSAMP"><code>TJ.PARAM_SUBSAMP</code></a> to the chrominance subsampling level of the source image.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>srcImage</code> - <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>YUVImage</code></a> instance containing a planar YUV source image to be decoded. This image is not modified.</dd> </dl> </li> </ul> <a id="getWidth()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getWidth</h4> <pre class="methodSignature">public int getWidth()</pre> <div class="block">Returns the width of the source image (JPEG or YUV) associated with this decompressor instance.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the width of the source image (JPEG or YUV) associated with this decompressor instance.</dd> </dl> </li> </ul> <a id="getHeight()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getHeight</h4> <pre class="methodSignature">public int getHeight()</pre> <div class="block">Returns the height of the source image (JPEG or YUV) associated with this decompressor instance.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the height of the source image (JPEG or YUV) associated with this decompressor instance.</dd> </dl> </li> </ul> <a id="set(int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>set</h4> <pre class="methodSignature">public void set​(int param, int value)</pre> <div class="block">Set the value of a decompression parameter.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>param</code> - one of <a href="TJ.html#PARAM_STOPONWARNING"><code>TJ.PARAM_*</code></a></dd> <dd><code>value</code> - value of the decompression parameter (refer to <a href="TJ.html#PARAM_STOPONWARNING"><code>parameter documentation</code></a>)</dd> </dl> </li> </ul> <a id="get(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>get</h4> <pre class="methodSignature">public int get​(int param)</pre> <div class="block">Get the value of a decompression parameter.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>param</code> - one of <a href="TJ.html#PARAM_STOPONWARNING"><code>TJ.PARAM_*</code></a></dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>the value of the specified decompression parameter, or -1 if the value is unknown.</dd> </dl> </li> </ul> <a id="setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setScalingFactor</h4> <pre class="methodSignature">public void setScalingFactor​(<a href="TJScalingFactor.html" title="class in org.libjpegturbo.turbojpeg">TJScalingFactor</a> scalingFactor)</pre> <div class="block">Set the scaling factor for subsequent lossy decompression operations.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>scalingFactor</code> - <a href="TJScalingFactor.html" title="class in org.libjpegturbo.turbojpeg"><code>TJScalingFactor</code></a> instance that specifies a fractional scaling factor that the decompressor supports (see <a href="TJ.html#getScalingFactors()"><code>TJ.getScalingFactors()</code></a>), or <a href="TJ.html#UNSCALED"><code>TJ.UNSCALED</code></a> for no scaling. Decompression scaling is a function of the IDCT algorithm, so scaling factors are generally limited to multiples of 1/8. If the entire JPEG image will be decompressed, then the width and height of the scaled destination image can be determined by calling <code>scalingFactor.</code><a href="TJScalingFactor.html#getScaled(int)"><code>getScaled()</code></a> with the JPEG image width and height (see <a href="#getWidth()"><code>getWidth()</code></a> and <a href="#getHeight()"><code>getHeight()</code></a>.) When decompressing into a planar YUV image, an intermediate buffer copy will be performed if the width or height of the scaled destination image is not an even multiple of the MCU block size (see <a href="TJ.html#getMCUWidth(int)"><code>TJ.getMCUWidth()</code></a> and <a href="TJ.html#getMCUHeight(int)"><code>TJ.getMCUHeight()</code></a>.) Note that decompression scaling is not available (and the specified scaling factor is ignored) when decompressing lossless JPEG images (see <a href="TJ.html#PARAM_LOSSLESS"><code>TJ.PARAM_LOSSLESS</code></a>), since the IDCT algorithm is not used with those images. Note also that <a href="TJ.html#PARAM_FASTDCT"><code>TJ.PARAM_FASTDCT</code></a> is ignored when decompression scaling is enabled.</dd> </dl> </li> </ul> <a id="setCroppingRegion(java.awt.Rectangle)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setCroppingRegion</h4> <pre class="methodSignature">public void setCroppingRegion​(java.awt.Rectangle croppingRegion) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Set the cropping region for partially decompressing a lossy JPEG image into a packed-pixel image.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>croppingRegion</code> - <code>java.awt.Rectangle</code> instance that specifies a subregion of the JPEG image to decompress, or <a href="TJ.html#UNCROPPED"><code>TJ.UNCROPPED</code></a> for no cropping. The left boundary of the cropping region must be evenly divisible by the scaled MCU block width, which can be determined by calling <a href="TJScalingFactor.html#getScaled(int)"><code>TJScalingFactor.getScaled()</code></a> with the specified scaling factor (see <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>) and the MCU block width (see <a href="TJ.html#getMCUWidth(int)"><code>TJ.getMCUWidth()</code></a>) for the level of chrominance subsampling in the JPEG image (see <a href="TJ.html#PARAM_SUBSAMP"><code>TJ.PARAM_SUBSAMP</code></a>.) The cropping region should be specified relative to the scaled image dimensions. Unless <code>croppingRegion</code> is <a href="TJ.html#UNCROPPED"><code>TJ.UNCROPPED</code></a>, the JPEG header must be read (see <a href="#setSourceImage(byte%5B%5D,int)"><code>setSourceImage(byte[], int)</code></a> prior to calling this method.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="getSubsamp()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getSubsamp</h4> <pre class="methodSignature">@Deprecated public int getSubsamp()</pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <code><a href="#get(int)"><code>get</code></a>(<a href="TJ.html#PARAM_SUBSAMP"><code>TJ.PARAM_SUBSAMP</code></a>)</code> instead.</div> </div> </li> </ul> <a id="getColorspace()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getColorspace</h4> <pre class="methodSignature">@Deprecated public int getColorspace()</pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <code><a href="#get(int)"><code>get</code></a>(<a href="TJ.html#PARAM_COLORSPACE"><code>TJ.PARAM_COLORSPACE</code></a>)</code> instead.</div> </div> </li> </ul> <a id="getJPEGBuf()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getJPEGBuf</h4> <pre class="methodSignature">public byte[] getJPEGBuf()</pre> <div class="block">Returns the JPEG buffer associated with this decompressor instance.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the JPEG buffer associated with this decompressor instance.</dd> </dl> </li> </ul> <a id="getJPEGSize()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getJPEGSize</h4> <pre class="methodSignature">public int getJPEGSize()</pre> <div class="block">Returns the size of the JPEG image (in bytes) associated with this decompressor instance.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the size of the JPEG image (in bytes) associated with this decompressor instance.</dd> </dl> </li> </ul> <a id="getScaledWidth(int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getScaledWidth</h4> <pre class="methodSignature">@Deprecated public int getScaledWidth​(int desiredWidth, int desiredHeight)</pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a> and <a href="TJScalingFactor.html#getScaled(int)"><code>TJScalingFactor.getScaled()</code></a> instead.</div> </div> </li> </ul> <a id="getScaledHeight(int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getScaledHeight</h4> <pre class="methodSignature">@Deprecated public int getScaledHeight​(int desiredWidth, int desiredHeight)</pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a> and <a href="TJScalingFactor.html#getScaled(int)"><code>TJScalingFactor.getScaled()</code></a> instead.</div> </div> </li> </ul> <a id="decompress8(byte[],int,int,int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decompress8</h4> <pre class="methodSignature">public void decompress8​(byte[] dstBuf, int x, int y, int pitch, int pixelFormat) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Decompress the 8-bit-per-sample JPEG source image or decode the planar YUV source image associated with this decompressor instance and output an 8-bit-per-sample packed-pixel grayscale, RGB, or CMYK image to the given destination buffer. <p> NOTE: The destination image is fully recoverable if this method throws a non-fatal <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg"><code>TJException</code></a> (unless <a href="TJ.html#PARAM_STOPONWARNING"><code>TJ.PARAM_STOPONWARNING</code></a> is set.)</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>dstBuf</code> - buffer that will receive the packed-pixel decompressed/decoded image. This buffer should normally be <code>pitch * destinationHeight</code> bytes in size. However, the buffer may also be larger, in which case the <code>x</code>, <code>y</code>, and <code>pitch</code> parameters can be used to specify the region into which the source image should be decompressed/decoded. NOTE: If the source image is a lossy JPEG image, then <code>destinationHeight</code> is either the scaled JPEG height (see <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, <a href="TJScalingFactor.html#getScaled(int)"><code>TJScalingFactor.getScaled()</code></a>, and <a href="#getHeight()"><code>getHeight()</code></a>) or the height of the cropping region (see <a href="#setCroppingRegion(java.awt.Rectangle)"><code>setCroppingRegion()</code></a>.) If the source image is a YUV image or a lossless JPEG image, then <code>destinationHeight</code> is the height of the source image.</dd> <dd><code>x</code> - x offset (in pixels) of the region in the destination image into which the source image should be decompressed/decoded</dd> <dd><code>y</code> - y offset (in pixels) of the region in the destination image into which the source image should be decompressed/decoded</dd> <dd><code>pitch</code> - bytes per row in the destination image. Normally this should be set to <code>destinationWidth * <a href="TJ.html#getPixelSize(int)"><code>TJ.getPixelSize</code></a>(pixelFormat)</code>, if the destination image will be unpadded. (Setting this parameter to 0 is the equivalent of setting it to <code>destinationWidth * <a href="TJ.html#getPixelSize(int)"><code>TJ.getPixelSize</code></a>(pixelFormat)</code>.) However, you can also use this parameter to specify the row alignment/padding of the destination image, to skip rows, or to decompress/decode into a specific region of a larger image. NOTE: if the source image is a lossy JPEG image, then <code>destinationWidth</code> is either the scaled JPEG width (see <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, <a href="TJScalingFactor.html#getScaled(int)"><code>TJScalingFactor.getScaled()</code></a>, and <a href="#getWidth()"><code>getWidth()</code></a>) or the width of the cropping region (see <a href="#setCroppingRegion(java.awt.Rectangle)"><code>setCroppingRegion()</code></a>.) If the source image is a YUV image or a lossless JPEG image, then <code>destinationWidth</code> is the width of the source image.</dd> <dd><code>pixelFormat</code> - pixel format of the decompressed/decoded image (one of <a href="TJ.html#PF_RGB"><code>TJ.PF_*</code></a>)</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="decompress(byte[],int,int,int,int,int,int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decompress</h4> <pre class="methodSignature">@Deprecated public void decompress​(byte[] dstBuf, int x, int y, int desiredWidth, int pitch, int desiredHeight, int pixelFormat, int flags) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <a href="#set(int,int)"><code>set()</code></a>, <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, and <a href="#decompress8(byte%5B%5D,int,int,int,int)"><code>decompress8(byte[], int, int, int, int)</code></a> instead.</div> </div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="decompress8(int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decompress8</h4> <pre class="methodSignature">public byte[] decompress8​(int pitch, int pixelFormat) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Decompress the 8-bit-per-sample JPEG source image or decode the planar YUV source image associated with this decompressor instance and return a buffer containing an 8-bit-per-sample packed-pixel decompressed image.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>pitch</code> - see <a href="#decompress8(byte%5B%5D,int,int,int,int)"><code>decompress8(byte[], int, int, int, int)</code></a> for description</dd> <dd><code>pixelFormat</code> - pixel format of the decompressed image (one of <a href="TJ.html#PF_RGB"><code>TJ.PF_*</code></a>)</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a buffer containing an 8-bit-per-sample packed-pixel decompressed image.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="decompress(int,int,int,int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decompress</h4> <pre class="methodSignature">@Deprecated public byte[] decompress​(int desiredWidth, int pitch, int desiredHeight, int pixelFormat, int flags) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <a href="#set(int,int)"><code>set()</code></a>, <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, and <a href="#decompress8(int,int)"><code>decompress8(int, int)</code></a> instead.</div> </div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="decompress12(short[],int,int,int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decompress12</h4> <pre class="methodSignature">public void decompress12​(short[] dstBuf, int x, int y, int pitch, int pixelFormat) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Decompress the 12-bit-per-sample JPEG source image associated with this decompressor instance and output a 12-bit-per-sample packed-pixel grayscale, RGB, or CMYK image to the given destination buffer. <p> NOTE: The destination image is fully recoverable if this method throws a non-fatal <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg"><code>TJException</code></a> (unless <a href="TJ.html#PARAM_STOPONWARNING"><code>TJ.PARAM_STOPONWARNING</code></a> is set.)</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>dstBuf</code> - buffer that will receive the packed-pixel decompressed image. This buffer should normally be <code>pitch * destinationHeight</code> samples in size. However, the buffer may also be larger, in which case the <code>x</code>, <code>y</code>, and <code>pitch</code> parameters can be used to specify the region into which the source image should be decompressed. NOTE: If the source image is a lossy JPEG image, then <code>destinationHeight</code> is either the scaled JPEG height (see <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, <a href="TJScalingFactor.html#getScaled(int)"><code>TJScalingFactor.getScaled()</code></a>, and <a href="#getHeight()"><code>getHeight()</code></a>) or the height of the cropping region (see <a href="#setCroppingRegion(java.awt.Rectangle)"><code>setCroppingRegion()</code></a>.) If the source image is a lossless JPEG image, then <code>destinationHeight</code> is the height of the source image.</dd> <dd><code>x</code> - x offset (in pixels) of the region in the destination image into which the source image should be decompressed</dd> <dd><code>y</code> - y offset (in pixels) of the region in the destination image into which the source image should be decompressed</dd> <dd><code>pitch</code> - samples per row in the destination image. Normally this should be set to <code>destinationWidth * <a href="TJ.html#getPixelSize(int)"><code>TJ.getPixelSize</code></a>(pixelFormat)</code>, if the destination image will be unpadded. (Setting this parameter to 0 is the equivalent of setting it to <code>destinationWidth * <a href="TJ.html#getPixelSize(int)"><code>TJ.getPixelSize</code></a>(pixelFormat)</code>.) However, you can also use this parameter to specify the row alignment/padding of the destination image, to skip rows, or to decompress into a specific region of a larger image. NOTE: if the source image is a lossy JPEG image, then <code>destinationWidth</code> is either the scaled JPEG width (see <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, <a href="TJScalingFactor.html#getScaled(int)"><code>TJScalingFactor.getScaled()</code></a>, and <a href="#getWidth()"><code>getWidth()</code></a>) or the width of the cropping region (see <a href="#setCroppingRegion(java.awt.Rectangle)"><code>setCroppingRegion()</code></a>.) If the source image is a YUV image or a lossless JPEG image, then <code>destinationWidth</code> is the width of the source image.</dd> <dd><code>pixelFormat</code> - pixel format of the decompressed image (one of <a href="TJ.html#PF_RGB"><code>TJ.PF_*</code></a>)</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="decompress12(int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decompress12</h4> <pre class="methodSignature">public short[] decompress12​(int pitch, int pixelFormat) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Decompress the 12-bit-per-sample JPEG source image associated with this decompressor instance and return a buffer containing a 12-bit-per-sample packed-pixel decompressed image.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>pitch</code> - see <a href="#decompress12(short%5B%5D,int,int,int,int)"><code>decompress12(short[], int, int, int, int)</code></a> for description</dd> <dd><code>pixelFormat</code> - pixel format of the decompressed image (one of <a href="TJ.html#PF_RGB"><code>TJ.PF_*</code></a>)</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a buffer containing a 12-bit-per-sample packed-pixel decompressed image.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="decompress16(short[],int,int,int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decompress16</h4> <pre class="methodSignature">public void decompress16​(short[] dstBuf, int x, int y, int pitch, int pixelFormat) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Decompress the 16-bit-per-sample lossless JPEG source image associated with this decompressor instance and output a 16-bit-per-sample packed-pixel grayscale, RGB, or CMYK image to the given destination buffer. <p> NOTE: The destination image is fully recoverable if this method throws a non-fatal <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg"><code>TJException</code></a> (unless <a href="TJ.html#PARAM_STOPONWARNING"><code>TJ.PARAM_STOPONWARNING</code></a> is set.)</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>dstBuf</code> - buffer that will receive the packed-pixel decompressed image. This buffer should normally be <code>pitch * jpegHeight</code> samples in size. However, the buffer may also be larger, in which case the <code>x</code>, <code>y</code>, and <code>pitch</code> parameters can be used to specify the region into which the source image should be decompressed.</dd> <dd><code>x</code> - x offset (in pixels) of the region in the destination image into which the source image should be decompressed</dd> <dd><code>y</code> - y offset (in pixels) of the region in the destination image into which the source image should be decompressed</dd> <dd><code>pitch</code> - samples per row in the destination image. Normally this should be set to <code>jpegWidth * <a href="TJ.html#getPixelSize(int)"><code>TJ.getPixelSize</code></a>(pixelFormat)</code>, if the destination image will be unpadded. (Setting this parameter to 0 is the equivalent of setting it to <code>jpegWidth * <a href="TJ.html#getPixelSize(int)"><code>TJ.getPixelSize</code></a>(pixelFormat)</code>.) However, you can also use this parameter to specify the row alignment/padding of the destination image, to skip rows, or to decompress into a specific region of a larger image.</dd> <dd><code>pixelFormat</code> - pixel format of the decompressed image (one of <a href="TJ.html#PF_RGB"><code>TJ.PF_*</code></a>)</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="decompress16(int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decompress16</h4> <pre class="methodSignature">public short[] decompress16​(int pitch, int pixelFormat) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Decompress the 16-bit-per-sample JPEG source image associated with this decompressor instance and return a buffer containing a 16-bit-per-sample packed-pixel decompressed image.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>pitch</code> - see <a href="#decompress16(short%5B%5D,int,int,int,int)"><code>decompress16(short[], int, int, int, int)</code></a> for description</dd> <dd><code>pixelFormat</code> - pixel format of the decompressed image (one of <a href="TJ.html#PF_RGB"><code>TJ.PF_*</code></a>)</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a buffer containing a 16-bit-per-sample packed-pixel decompressed image.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="decompressToYUV(org.libjpegturbo.turbojpeg.YUVImage)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decompressToYUV</h4> <pre class="methodSignature">public void decompressToYUV​(<a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a> dstImage) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Decompress the 8-bit-per-sample JPEG source image associated with this decompressor instance into an 8-bit-per-sample planar YUV image and store it in the given <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>YUVImage</code></a> instance. This method performs JPEG decompression but leaves out the color conversion step, so a planar YUV image is generated instead of a packed-pixel image. This method cannot be used to decompress JPEG source images with the CMYK or YCCK colorspace. <p> NOTE: The planar YUV destination image is fully recoverable if this method throws a non-fatal <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg"><code>TJException</code></a> (unless <a href="TJ.html#PARAM_STOPONWARNING"><code>TJ.PARAM_STOPONWARNING</code></a> is set.)</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>dstImage</code> - <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>YUVImage</code></a> instance that will receive the planar YUV decompressed image. The level of subsampling specified in this <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>YUVImage</code></a> instance must match that of the JPEG image, and the width and height specified in the <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>YUVImage</code></a> instance must match the scaled JPEG width and height (see <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, <a href="TJScalingFactor.html#getScaled(int)"><code>TJScalingFactor.getScaled()</code></a>, <a href="#getWidth()"><code>getWidth()</code></a>, and <a href="#getHeight()"><code>getHeight()</code></a>.)</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="decompressToYUV(org.libjpegturbo.turbojpeg.YUVImage,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decompressToYUV</h4> <pre class="methodSignature">@Deprecated public void decompressToYUV​(<a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a> dstImage, int flags) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <a href="#set(int,int)"><code>set()</code></a>, <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, and <a href="#decompressToYUV(org.libjpegturbo.turbojpeg.YUVImage)"><code>decompressToYUV(YUVImage)</code></a> instead.</div> </div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="decompressToYUV(int[])"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decompressToYUV</h4> <pre class="methodSignature">public <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a> decompressToYUV​(int[] strides) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Decompress the 8-bit-per-sample JPEG source image associated with this decompressor instance into a set of 8-bit-per-sample Y, U (Cb), and V (Cr) image planes and return a <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>YUVImage</code></a> instance containing the decompressed image planes. This method performs JPEG decompression but leaves out the color conversion step, so a planar YUV image is generated instead of a packed-pixel image. This method cannot be used to decompress JPEG source images with the CMYK or YCCK colorspace.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>strides</code> - an array of integers, each specifying the number of bytes per row in the corresponding plane of the YUV image. Setting the stride for any plane to 0 is the same as setting it to the scaled plane width (see <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>YUVImage</code></a>.) If <code>strides</code> is null, then the strides for all planes will be set to their respective scaled plane widths. You can adjust the strides in order to add an arbitrary amount of row padding to each plane.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>YUVImage</code></a> instance containing the decompressed image planes</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="decompressToYUV(int,int[],int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decompressToYUV</h4> <pre class="methodSignature">@Deprecated public <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a> decompressToYUV​(int desiredWidth, int[] strides, int desiredHeight, int flags) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <a href="#set(int,int)"><code>set()</code></a>, <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, and <a href="#decompressToYUV(int%5B%5D)"><code>decompressToYUV(int[])</code></a> instead.</div> </div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="decompressToYUV(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decompressToYUV</h4> <pre class="methodSignature">public <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a> decompressToYUV​(int align) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Decompress the 8-bit-per-sample JPEG source image associated with this decompressor instance into an 8-bit-per-sample unified planar YUV image and return a <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>YUVImage</code></a> instance containing the decompressed image. This method performs JPEG decompression but leaves out the color conversion step, so a planar YUV image is generated instead of a packed-pixel image. This method cannot be used to decompress JPEG source images with the CMYK or YCCK colorspace.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>align</code> - row alignment (in bytes) of the YUV image (must be a power of 2.) Setting this parameter to n will cause each row in each plane of the YUV image to be padded to the nearest multiple of n bytes (1 = unpadded.)</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>YUVImage</code></a> instance containing the unified planar YUV decompressed image</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="decompressToYUV(int,int,int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decompressToYUV</h4> <pre class="methodSignature">@Deprecated public <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a> decompressToYUV​(int desiredWidth, int align, int desiredHeight, int flags) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <a href="#set(int,int)"><code>set()</code></a>, <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, and <a href="#decompressToYUV(int)"><code>decompressToYUV(int)</code></a> instead.</div> </div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="decompress8(int[],int,int,int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decompress8</h4> <pre class="methodSignature">public void decompress8​(int[] dstBuf, int x, int y, int stride, int pixelFormat) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Decompress the 8-bit-per-sample JPEG source image or decode the planar YUV source image associated with this decompressor instance and output an 8-bit-per-sample packed-pixel grayscale, RGB, or CMYK image to the given destination buffer. <p> NOTE: The destination image is fully recoverable if this method throws a non-fatal <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg"><code>TJException</code></a> (unless <a href="TJ.html#PARAM_STOPONWARNING"><code>TJ.PARAM_STOPONWARNING</code></a> is set.)</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>dstBuf</code> - buffer that will receive the packed-pixel decompressed/decoded image. This buffer should normally be <code>stride * destinationHeight</code> pixels in size. However, the buffer may also be larger, in which case the <code>x</code>, <code>y</code>, and <code>pitch</code> parameters can be used to specify the region into which the source image should be decompressed/decoded. NOTE: If the source image is a lossy JPEG image, then <code>destinationHeight</code> is either the scaled JPEG height (see <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, <a href="TJScalingFactor.html#getScaled(int)"><code>TJScalingFactor.getScaled()</code></a>, and <a href="#getHeight()"><code>getHeight()</code></a>) or the height of the cropping region (see <a href="#setCroppingRegion(java.awt.Rectangle)"><code>setCroppingRegion()</code></a>.) If the source image is a YUV image or a lossless JPEG image, then <code>destinationHeight</code> is the height of the source image.</dd> <dd><code>x</code> - x offset (in pixels) of the region in the destination image into which the source image should be decompressed/decoded</dd> <dd><code>y</code> - y offset (in pixels) of the region in the destination image into which the source image should be decompressed/decoded</dd> <dd><code>stride</code> - pixels per row in the destination image. Normally this should be set to <code>destinationWidth</code>. (Setting this parameter to 0 is the equivalent of setting it to <code>destinationWidth</code>.) However, you can also use this parameter to skip rows or to decompress/decode into a specific region of a larger image. NOTE: if the source image is a lossy JPEG image, then <code>destinationWidth</code> is either the scaled JPEG width (see <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, <a href="TJScalingFactor.html#getScaled(int)"><code>TJScalingFactor.getScaled()</code></a>, and <a href="#getWidth()"><code>getWidth()</code></a>) or the width of the cropping region (see <a href="#setCroppingRegion(java.awt.Rectangle)"><code>setCroppingRegion()</code></a>.) If the source image is a YUV image or a lossless JPEG image, then <code>destinationWidth</code> is the width of the source image.</dd> <dd><code>pixelFormat</code> - pixel format of the decompressed/decoded image (one of <a href="TJ.html#PF_RGB"><code>TJ.PF_*</code></a>)</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="decompress(int[],int,int,int,int,int,int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decompress</h4> <pre class="methodSignature">@Deprecated public void decompress​(int[] dstBuf, int x, int y, int desiredWidth, int stride, int desiredHeight, int pixelFormat, int flags) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <a href="#set(int,int)"><code>set()</code></a>, <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, and <a href="#decompress8(int%5B%5D,int,int,int,int)"><code>decompress8(int[], int, int, int, int)</code></a> instead.</div> </div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="decompress8(java.awt.image.BufferedImage)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decompress8</h4> <pre class="methodSignature">public void decompress8​(java.awt.image.BufferedImage dstImage) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Decompress the 8-bit-per-sample JPEG source image or decode the planar YUV source image associated with this decompressor instance and output an 8-bit-per-sample packed-pixel decompressed/decoded image to the given <code>BufferedImage</code> instance. <p> NOTE: The destination image is fully recoverable if this method throws a non-fatal <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg"><code>TJException</code></a> (unless <a href="TJ.html#PARAM_STOPONWARNING"><code>TJ.PARAM_STOPONWARNING</code></a> is set.)</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>dstImage</code> - a <code>BufferedImage</code> instance that will receive the packed-pixel decompressed/decoded image. If the source image is a lossy JPEG image, then the width and height of the <code>BufferedImage</code> instance must match the scaled JPEG width and height (see <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, <a href="TJScalingFactor.html#getScaled(int)"><code>TJScalingFactor.getScaled()</code></a>, <a href="#getWidth()"><code>getWidth()</code></a>, and <a href="#getHeight()"><code>getHeight()</code></a>) or the width and height of the cropping region (see <a href="#setCroppingRegion(java.awt.Rectangle)"><code>setCroppingRegion()</code></a>.) If the source image is a YUV image or a lossless JPEG image, then the width and height of the <code>BufferedImage</code> instance must match the width and height of the source image.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="decompress(java.awt.image.BufferedImage,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decompress</h4> <pre class="methodSignature">@Deprecated public void decompress​(java.awt.image.BufferedImage dstImage, int flags) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <a href="#set(int,int)"><code>set()</code></a>, <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, and <a href="#decompress8(java.awt.image.BufferedImage)"><code>decompress8(BufferedImage)</code></a> instead.</div> </div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="decompress8(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decompress8</h4> <pre class="methodSignature">public java.awt.image.BufferedImage decompress8​(int bufferedImageType) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Decompress the 8-bit-per-sample JPEG source image or decode the planar YUV source image associated with this decompressor instance and return a <code>BufferedImage</code> instance containing the 8-bit-per-sample packed-pixel decompressed/decoded image.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>bufferedImageType</code> - the image type of the <code>BufferedImage</code> instance that will be created (for instance, <code>BufferedImage.TYPE_INT_RGB</code>)</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a <code>BufferedImage</code> instance containing the 8-bit-per-sample packed-pixel decompressed/decoded image.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="decompress(int,int,int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decompress</h4> <pre class="methodSignature">@Deprecated public java.awt.image.BufferedImage decompress​(int desiredWidth, int desiredHeight, int bufferedImageType, int flags) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <a href="#set(int,int)"><code>set()</code></a>, <a href="#setScalingFactor(org.libjpegturbo.turbojpeg.TJScalingFactor)"><code>setScalingFactor()</code></a>, and <a href="#decompress8(int)"><code>decompress8(int)</code></a> instead.</div> </div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="close()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>close</h4> <pre class="methodSignature">public void close() throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Free the native structures associated with this decompressor instance.</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code>close</code> in interface <code>java.io.Closeable</code></dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd> </dl> </li> </ul> <a id="finalize()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>finalize</h4> <pre class="methodSignature">protected void finalize() throws java.lang.Throwable</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>finalize</code> in class <code>java.lang.Object</code></dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.Throwable</code></dd> </dl> </li> </ul> </li> </ul> </section> </li> </ul> </div> </div> </main> <!-- ========= END OF CLASS DATA ========= --> <footer role="contentinfo"> <nav role="navigation"> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a id="navbar.bottom"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a id="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../allclasses.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a id="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </nav> </footer> </body> </html>