kc3-lang/libjpeg-turbo/java/doc/org/libjpegturbo/turbojpeg/TJCompressor.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/TJCompressor.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
<!DOCTYPE HTML> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc --> <title>TJCompressor</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="TJCompressor"; } } catch(err) { } //--> var data = {"i0":10,"i1":10,"i2":10,"i3":42,"i4":42,"i5":10,"i6":10,"i7":42,"i8":42,"i9":10,"i10":42,"i11":10,"i12":10,"i13":10,"i14":10,"i15":42,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":42}; 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 TJCompressor" class="title">Class TJCompressor</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.libjpegturbo.turbojpeg.TJCompressor</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> <hr> <pre>public class <span class="typeNameLabel">TJCompressor</span> extends java.lang.Object implements java.io.Closeable</pre> <div class="block">TurboJPEG compressor</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()">TJCompressor</a></span>()</code></th> <td class="colLast"> <div class="block">Create a TurboJPEG compressor instance.</div> </td> </tr> <tr class="rowColor"> <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(byte%5B%5D,int,int,int,int,int,int)">TJCompressor</a></span>​(byte[] srcImage, int x, int y, int width, int pitch, int height, int pixelFormat)</code></th> <td class="colLast"> <div class="block">Create a TurboJPEG compressor instance and associate the 8-bit-per-sample packed-pixel source image stored in <code>srcImage</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(java.awt.image.BufferedImage,int,int,int,int)">TJCompressor</a></span>​(java.awt.image.BufferedImage srcImage, int x, int y, int width, int height)</code></th> <td class="colLast"> <div class="block">Create a TurboJPEG compressor instance and associate the 8-bit-per-sample packed-pixel source image stored in <code>srcImage</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 compressor instance.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>byte[]</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compress()">compress</a></span>()</code></th> <td class="colLast"> <div class="block">Compress the packed-pixel or planar YUV source image associated with this compressor instance and return a buffer containing a JPEG image.</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="#compress(byte%5B%5D)">compress</a></span>​(byte[] dstBuf)</code></th> <td class="colLast"> <div class="block">Compress the packed-pixel or planar YUV source image associated with this compressor instance and output a JPEG image to the given destination buffer.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compress(byte%5B%5D,int)">compress</a></span>​(byte[] dstBuf, 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> and <a href="#compress(byte%5B%5D)"><code>compress(byte[])</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="#compress(int)">compress</a></span>​(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> and <a href="#compress()"><code>compress()</code></a> instead.</div> </div> </td> </tr> <tr id="i5" 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="#encodeYUV(int)">encodeYUV</a></span>​(int align)</code></th> <td class="colLast"> <div class="block">Encode the 8-bit-per-sample packed-pixel source image associated with this compressor 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 encoded image.</div> </td> </tr> <tr id="i6" 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="#encodeYUV(int%5B%5D)">encodeYUV</a></span>​(int[] strides)</code></th> <td class="colLast"> <div class="block">Encode the 8-bit-per-sample packed-pixel source image associated with this compressor instance into separate 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 encoded image planes.</div> </td> </tr> <tr id="i7" 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="#encodeYUV(int%5B%5D,int)">encodeYUV</a></span>​(int[] strides, 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> and <a href="#encodeYUV(int%5B%5D)"><code>encodeYUV(int[])</code></a> instead.</div> </div> </td> </tr> <tr id="i8" 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="#encodeYUV(int,int)">encodeYUV</a></span>​(int align, 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> and <a href="#encodeYUV(int)"><code>encodeYUV(int)</code></a> instead.</div> </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="#encodeYUV(org.libjpegturbo.turbojpeg.YUVImage)">encodeYUV</a></span>​(<a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a> dstImage)</code></th> <td class="colLast"> <div class="block">Encode the 8-bit-per-sample packed-pixel source image associated with this compressor 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="i10" class="altColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#encodeYUV(org.libjpegturbo.turbojpeg.YUVImage,int)">encodeYUV</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> and <a href="#encodeYUV(org.libjpegturbo.turbojpeg.YUVImage)"><code>encodeYUV(YUVImage)</code></a> instead.</div> </div> </td> </tr> <tr id="i11" 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="i12" 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 compression parameter.</div> </td> </tr> <tr id="i13" class="rowColor"> <td class="colFirst"><code>int</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCompressedSize()">getCompressedSize</a></span>()</code></th> <td class="colLast"> <div class="block">Returns the size of the image (in bytes) generated by the most recent compress operation.</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="#set(int,int)">set</a></span>​(int param, int value)</code></th> <td class="colLast"> <div class="block">Set the value of a compression parameter.</div> </td> </tr> <tr id="i15" class="rowColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setJPEGQuality(int)">setJPEGQuality</a></span>​(int quality)</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <code><a href="#set(int,int)"><code>set</code></a>(<a href="TJ.html#PARAM_QUALITY"><code>TJ.PARAM_QUALITY</code></a>, ...)</code> instead.</div> </div> </td> </tr> <tr id="i16" 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,int,int,int,int,int)">setSourceImage</a></span>​(byte[] srcImage, int x, int y, int width, int pitch, int height, int pixelFormat)</code></th> <td class="colLast"> <div class="block">Associate an 8-bit-per-sample packed-pixel RGB, grayscale, or CMYK source image with this compressor instance.</div> </td> </tr> <tr id="i17" class="rowColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSourceImage(java.awt.image.BufferedImage,int,int,int,int)">setSourceImage</a></span>​(java.awt.image.BufferedImage srcImage, int x, int y, int width, int height)</code></th> <td class="colLast"> <div class="block">Associate an 8-bit-per-sample packed-pixel RGB or grayscale source image with this compressor instance.</div> </td> </tr> <tr id="i18" class="altColor"> <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 an 8-bit-per-sample planar YUV source image with this compressor instance.</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="#setSourceImage12(short%5B%5D,int,int,int,int,int,int)">setSourceImage12</a></span>​(short[] srcImage, int x, int y, int width, int pitch, int height, int pixelFormat)</code></th> <td class="colLast"> <div class="block">Associate a 12-bit-per-sample packed-pixel RGB, grayscale, or CMYK source image with this compressor 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="#setSourceImage16(short%5B%5D,int,int,int,int,int,int)">setSourceImage16</a></span>​(short[] srcImage, int x, int y, int width, int pitch, int height, int pixelFormat)</code></th> <td class="colLast"> <div class="block">Associate a 16-bit-per-sample packed-pixel RGB, grayscale, or CMYK source image with this compressor instance.</div> </td> </tr> <tr id="i21" class="rowColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSubsamp(int)">setSubsamp</a></span>​(int subsamp)</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <code><a href="#set(int,int)"><code>set</code></a>(<a href="TJ.html#PARAM_SUBSAMP"><code>TJ.PARAM_SUBSAMP</code></a>, ...)</code> instead.</div> </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>TJCompressor</h4> <pre>public TJCompressor() throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Create a TurboJPEG compressor 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[],int,int,int,int,int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>TJCompressor</h4> <pre>public TJCompressor​(byte[] srcImage, int x, int y, int width, int pitch, int height, int pixelFormat) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Create a TurboJPEG compressor instance and associate the 8-bit-per-sample packed-pixel source image stored in <code>srcImage</code> with the newly created instance.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>srcImage</code> - see <a href="#setSourceImage(byte%5B%5D,int,int,int,int,int,int)"><code>setSourceImage(byte[], int, int, int, int, int, int)</code></a> for description</dd> <dd><code>x</code> - see <a href="#setSourceImage(byte%5B%5D,int,int,int,int,int,int)"><code>setSourceImage(byte[], int, int, int, int, int, int)</code></a> for description</dd> <dd><code>y</code> - see <a href="#setSourceImage(byte%5B%5D,int,int,int,int,int,int)"><code>setSourceImage(byte[], int, int, int, int, int, int)</code></a> for description</dd> <dd><code>width</code> - see <a href="#setSourceImage(byte%5B%5D,int,int,int,int,int,int)"><code>setSourceImage(byte[], int, int, int, int, int, int)</code></a> for description</dd> <dd><code>pitch</code> - see <a href="#setSourceImage(byte%5B%5D,int,int,int,int,int,int)"><code>setSourceImage(byte[], int, int, int, int, int, int)</code></a> for description</dd> <dd><code>height</code> - see <a href="#setSourceImage(byte%5B%5D,int,int,int,int,int,int)"><code>setSourceImage(byte[], int, int, int, int, int, int)</code></a> for description</dd> <dd><code>pixelFormat</code> - pixel format of the source 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="<init>(java.awt.image.BufferedImage,int,int,int,int)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>TJCompressor</h4> <pre>public TJCompressor​(java.awt.image.BufferedImage srcImage, int x, int y, int width, int height) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Create a TurboJPEG compressor instance and associate the 8-bit-per-sample packed-pixel source image stored in <code>srcImage</code> with the newly created instance.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>srcImage</code> - see <a href="#setSourceImage(java.awt.image.BufferedImage,int,int,int,int)"><code>setSourceImage(BufferedImage, int, int, int, int)</code></a> for description</dd> <dd><code>x</code> - see <a href="#setSourceImage(java.awt.image.BufferedImage,int,int,int,int)"><code>setSourceImage(BufferedImage, int, int, int, int)</code></a> for description</dd> <dd><code>y</code> - see <a href="#setSourceImage(java.awt.image.BufferedImage,int,int,int,int)"><code>setSourceImage(BufferedImage, int, int, int, int)</code></a> for description</dd> <dd><code>width</code> - see <a href="#setSourceImage(java.awt.image.BufferedImage,int,int,int,int)"><code>setSourceImage(BufferedImage, int, int, int, int)</code></a> for description</dd> <dd><code>height</code> - see <a href="#setSourceImage(java.awt.image.BufferedImage,int,int,int,int)"><code>setSourceImage(BufferedImage, int, int, int, int)</code></a> for description</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,int,int,int,int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setSourceImage</h4> <pre class="methodSignature">public void setSourceImage​(byte[] srcImage, int x, int y, int width, int pitch, int height, int pixelFormat) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Associate an 8-bit-per-sample packed-pixel RGB, grayscale, or CMYK source image with this compressor instance.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>srcImage</code> - buffer containing a packed-pixel RGB, grayscale, or CMYK source image to be compressed or encoded. This buffer is not modified.</dd> <dd><code>x</code> - x offset (in pixels) of the region in the source image from which the JPEG or YUV image should be compressed/encoded</dd> <dd><code>y</code> - y offset (in pixels) of the region in the source image from which the JPEG or YUV image should be compressed/encoded</dd> <dd><code>width</code> - width (in pixels) of the region in the source image from which the JPEG or YUV image should be compressed/encoded</dd> <dd><code>pitch</code> - bytes per row in the source image. Normally this should be <code>width * <a href="TJ.html#getPixelSize(int)"><code>TJ.getPixelSize</code></a>(pixelFormat)</code>, if the source image is unpadded. (Setting this parameter to 0 is the equivalent of setting it to <code>width * <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 source image, to skip rows, or to compress/encode a JPEG or YUV image from a specific region of a larger source image.</dd> <dd><code>height</code> - height (in pixels) of the region in the source image from which the JPEG or YUV image should be compressed/encoded</dd> <dd><code>pixelFormat</code> - pixel format of the source 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="setSourceImage12(short[],int,int,int,int,int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setSourceImage12</h4> <pre class="methodSignature">public void setSourceImage12​(short[] srcImage, int x, int y, int width, int pitch, int height, int pixelFormat) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Associate a 12-bit-per-sample packed-pixel RGB, grayscale, or CMYK source image with this compressor instance. Note that 12-bit-per-sample packed-pixel source images can only be compressed into 12-bit-per-sample JPEG images.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>srcImage</code> - buffer containing a packed-pixel RGB, grayscale, or CMYK source image to be compressed. This buffer is not modified.</dd> <dd><code>x</code> - x offset (in pixels) of the region in the source image from which the JPEG image should be compressed</dd> <dd><code>y</code> - y offset (in pixels) of the region in the source image from which the JPEG image should be compressed</dd> <dd><code>width</code> - width (in pixels) of the region in the source image from which the JPEG image should be compressed</dd> <dd><code>pitch</code> - samples per row in the source image. Normally this should be <code>width * <a href="TJ.html#getPixelSize(int)"><code>TJ.getPixelSize</code></a>(pixelFormat)</code>, if the source image is unpadded. (Setting this parameter to 0 is the equivalent of setting it to <code>width * <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 source image, to skip rows, or to compress a JPEG image from a specific region of a larger source image.</dd> <dd><code>height</code> - height (in pixels) of the region in the source image from which the JPEG image should be compressed</dd> <dd><code>pixelFormat</code> - pixel format of the source 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="setSourceImage16(short[],int,int,int,int,int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setSourceImage16</h4> <pre class="methodSignature">public void setSourceImage16​(short[] srcImage, int x, int y, int width, int pitch, int height, int pixelFormat) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Associate a 16-bit-per-sample packed-pixel RGB, grayscale, or CMYK source image with this compressor instance. Note that 16-bit-per-sample packed-pixel source images can only be compressed into 16-bit-per-sample lossless JPEG images.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>srcImage</code> - buffer containing a packed-pixel RGB, grayscale, or CMYK source image to be compressed. This buffer is not modified.</dd> <dd><code>x</code> - x offset (in pixels) of the region in the source image from which the JPEG image should be compressed</dd> <dd><code>y</code> - y offset (in pixels) of the region in the source image from which the JPEG image should be compressed</dd> <dd><code>width</code> - width (in pixels) of the region in the source image from which the JPEG image should be compressed</dd> <dd><code>pitch</code> - samples per row in the source image. Normally this should be <code>width * <a href="TJ.html#getPixelSize(int)"><code>TJ.getPixelSize</code></a>(pixelFormat)</code>, if the source image is unpadded. (Setting this parameter to 0 is the equivalent of setting it to <code>width * <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 source image, to skip rows, or to compress a JPEG image from a specific region of a larger source image.</dd> <dd><code>height</code> - height (in pixels) of the region in the source image from which the JPEG image should be compressed</dd> <dd><code>pixelFormat</code> - pixel format of the source 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="setSourceImage(java.awt.image.BufferedImage,int,int,int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setSourceImage</h4> <pre class="methodSignature">public void setSourceImage​(java.awt.image.BufferedImage srcImage, int x, int y, int width, int height) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Associate an 8-bit-per-sample packed-pixel RGB or grayscale source image with this compressor instance.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>srcImage</code> - a <code>BufferedImage</code> instance containing a packed-pixel RGB or grayscale source image to be compressed or encoded. This image is not modified.</dd> <dd><code>x</code> - x offset (in pixels) of the region in the source image from which the JPEG or YUV image should be compressed/encoded</dd> <dd><code>y</code> - y offset (in pixels) of the region in the source image from which the JPEG or YUV image should be compressed/encoded</dd> <dd><code>width</code> - width (in pixels) of the region in the source image from which the JPEG or YUV image should be compressed/encoded (0 = use the width of the source image)</dd> <dd><code>height</code> - height (in pixels) of the region in the source image from which the JPEG or YUV image should be compressed/encoded (0 = use the 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="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) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Associate an 8-bit-per-sample planar YUV source image with this compressor instance. 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> - planar YUV source image to be compressed. 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> <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 compression 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 compression 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 compression 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 compression parameter, or -1 if the value is unknown.</dd> </dl> </li> </ul> <a id="setSubsamp(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setSubsamp</h4> <pre class="methodSignature">@Deprecated public void setSubsamp​(int subsamp)</pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <code><a href="#set(int,int)"><code>set</code></a>(<a href="TJ.html#PARAM_SUBSAMP"><code>TJ.PARAM_SUBSAMP</code></a>, ...)</code> instead.</div> </div> </li> </ul> <a id="setJPEGQuality(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setJPEGQuality</h4> <pre class="methodSignature">@Deprecated public void setJPEGQuality​(int quality)</pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Use <code><a href="#set(int,int)"><code>set</code></a>(<a href="TJ.html#PARAM_QUALITY"><code>TJ.PARAM_QUALITY</code></a>, ...)</code> instead.</div> </div> </li> </ul> <a id="compress(byte[])"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>compress</h4> <pre class="methodSignature">public void compress​(byte[] dstBuf) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Compress the packed-pixel or planar YUV source image associated with this compressor instance and output a JPEG image to the given destination buffer.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>dstBuf</code> - buffer that will receive the JPEG image. Use <a href="TJ.html#bufSize(int,int,int)"><code>TJ.bufSize()</code></a> to determine the maximum size for this buffer based on the source image's width and height and the desired level of chrominance subsampling (see <a href="TJ.html#PARAM_SUBSAMP"><code>TJ.PARAM_SUBSAMP</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="compress(byte[],int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>compress</h4> <pre class="methodSignature">@Deprecated public void compress​(byte[] dstBuf, 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> and <a href="#compress(byte%5B%5D)"><code>compress(byte[])</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="compress()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>compress</h4> <pre class="methodSignature">public byte[] compress() throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Compress the packed-pixel or planar YUV source image associated with this compressor instance and return a buffer containing a JPEG image.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>a buffer containing a JPEG image. The length of this buffer will not be equal to the size of the JPEG image. Use <a href="#getCompressedSize()"><code>getCompressedSize()</code></a> to obtain the size of the JPEG 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="compress(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>compress</h4> <pre class="methodSignature">@Deprecated public byte[] compress​(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> and <a href="#compress()"><code>compress()</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="encodeYUV(org.libjpegturbo.turbojpeg.YUVImage)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>encodeYUV</h4> <pre class="methodSignature">public void encodeYUV​(<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">Encode the 8-bit-per-sample packed-pixel source image associated with this compressor 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 color conversion (which is accelerated in the libjpeg-turbo implementation) but does not execute any of the other steps in the JPEG compression process. Encoding CMYK source images into YUV images is not supported. This method sets <a href="TJ.html#PARAM_SUBSAMP"><code>TJ.PARAM_SUBSAMP</code></a> to the chrominance subsampling level of the destination image.</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 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="encodeYUV(org.libjpegturbo.turbojpeg.YUVImage,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>encodeYUV</h4> <pre class="methodSignature">@Deprecated public void encodeYUV​(<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> and <a href="#encodeYUV(org.libjpegturbo.turbojpeg.YUVImage)"><code>encodeYUV(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="encodeYUV(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>encodeYUV</h4> <pre class="methodSignature">public <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a> encodeYUV​(int align) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Encode the 8-bit-per-sample packed-pixel source image associated with this compressor 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 encoded image. This method performs color conversion (which is accelerated in the libjpeg-turbo implementation) but does not execute any of the other steps in the JPEG compression process. Encoding CMYK source images into YUV images is not supported.</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 encoded 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="encodeYUV(int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>encodeYUV</h4> <pre class="methodSignature">@Deprecated public <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a> encodeYUV​(int align, 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> and <a href="#encodeYUV(int)"><code>encodeYUV(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="encodeYUV(int[])"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>encodeYUV</h4> <pre class="methodSignature">public <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a> encodeYUV​(int[] strides) throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre> <div class="block">Encode the 8-bit-per-sample packed-pixel source image associated with this compressor instance into separate 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 encoded image planes. This method performs color conversion (which is accelerated in the libjpeg-turbo implementation) but does not execute any of the other steps in the JPEG compression process. Encoding CMYK source images into YUV images is not supported.</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 source image. Setting the stride for any plane to 0 is the same as setting it to the 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 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 encoded 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="encodeYUV(int[],int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>encodeYUV</h4> <pre class="methodSignature">@Deprecated public <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a> encodeYUV​(int[] strides, 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> and <a href="#encodeYUV(int%5B%5D)"><code>encodeYUV(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="getCompressedSize()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getCompressedSize</h4> <pre class="methodSignature">public int getCompressedSize()</pre> <div class="block">Returns the size of the image (in bytes) generated by the most recent compress operation.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the size of the image (in bytes) generated by the most recent compress operation.</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 compressor 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>