kc3-lang/libjpeg-turbo/java/doc/org/libjpegturbo/turbojpeg/YUVImage.html
-
Show log
Commit
-
Hash : df9dbff8
Author :
Date : 2023-11-11T12:25:03
TurboJPEG: New param to limit virt array mem usage This corresponds to max_memory_to_use in the jpeg_memory_mgr struct in the libjpeg API, except that the TurboJPEG parameter is specified in megabytes. Because this is 2023 and computers with less than 1 MB of memory are not a thing (at least not within the scope of libjpeg-turbo support), it isn't useful to allow a limit less than 1 MB to be specified. Furthermore, because TurboJPEG parameters are signed integers, if we allowed the memory limit to be specified in bytes, then it would be impossible to specify a limit larger than 2 GB on 64-bit machines. Because max_memory_to_use is a long signed integer, effectively we can specify a limit of up to 2 petabytes on 64-bit machines if the TurboJPEG parameter is specified in megabytes. (2 PB should be enough for anybody, right?) This commit also bumps the TurboJPEG API version to 3.0.1. Since the TurboJPEG API version no longer tracks the libjpeg-turbo version, it makes sense to increment the API revision number when adding constants, to increment the minor version number when adding functions, and to increment the major version number for a complete overhaul. This commit also removes the vestigial TJ_NUMPARAM macro, which was never defined because it proved unnecessary. Partially implements #735
-
java/doc/org/libjpegturbo/turbojpeg/YUVImage.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
<!DOCTYPE HTML> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc --> <title>YUVImage</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="YUVImage"; } } catch(err) { } //--> var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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 YUVImage" class="title">Class YUVImage</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.libjpegturbo.turbojpeg.YUVImage</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <pre>public class <span class="typeNameLabel">YUVImage</span> extends java.lang.Object</pre> <div class="block">This class encapsulates a planar YUV image and the metadata associated with it. The TurboJPEG API allows both the JPEG compression and decompression pipelines to be split into stages: YUV encode, compress from YUV, decompress to YUV, and YUV decode. A <code>YUVImage</code> instance serves as the destination image for YUV encode and decompress-to-YUV operations and as the source image for compress-from-YUV and YUV decode operations. <p> Technically, the JPEG format uses the YCbCr colorspace (which is technically not a colorspace but a color transform), but per the convention of the digital video community, the TurboJPEG API uses "YUV" to refer to an image format consisting of Y, Cb, and Cr image planes. <p> Each plane is simply a 2D array of bytes, each byte representing the value of one of the components (Y, Cb, or Cr) at a particular location in the image. The width and height of each plane are determined by the image width, height, and level of chrominance subsampling. The luminance plane width is the image width padded to the nearest multiple of the horizontal subsampling factor (1 in the case of 4:4:4, grayscale, 4:4:0, or 4:4:1; 2 in the case of 4:2:2 or 4:2:0; 4 in the case of 4:1:1.) Similarly, the luminance plane height is the image height padded to the nearest multiple of the vertical subsampling factor (1 in the case of 4:4:4, 4:2:2, grayscale, or 4:1:1; 2 in the case of 4:2:0 or 4:4:0; 4 in the case of 4:4:1.) This is irrespective of any additional padding that may be specified as an argument to the various YUVImage methods. The chrominance plane width is equal to the luminance plane width divided by the horizontal subsampling factor, and the chrominance plane height is equal to the luminance plane height divided by the vertical subsampling factor. <p> For example, if the source image is 35 x 35 pixels and 4:2:2 subsampling is used, then the luminance plane would be 36 x 35 bytes, and each of the chrominance planes would be 18 x 35 bytes. If you specify a row alignment of 4 bytes on top of this, then the luminance plane would be 36 x 35 bytes, and each of the chrominance planes would be 20 x 35 bytes.</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(byte%5B%5D%5B%5D,int%5B%5D,int,int%5B%5D,int,int)">YUVImage</a></span>​(byte[][] planes, int[] offsets, int width, int[] strides, int height, int subsamp)</code></th> <td class="colLast"> <div class="block">Create a new <code>YUVImage</code> instance from a set of existing image planes.</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)">YUVImage</a></span>​(byte[] yuvImage, int width, int align, int height, int subsamp)</code></th> <td class="colLast"> <div class="block">Create a new <code>YUVImage</code> instance from an existing unified buffer.</div> </td> </tr> <tr class="altColor"> <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(int,int%5B%5D,int,int)">YUVImage</a></span>​(int width, int[] strides, int height, int subsamp)</code></th> <td class="colLast"> <div class="block">Create a new <code>YUVImage</code> instance backed by separate image planes, and allocate memory for the image planes.</div> </td> </tr> <tr class="rowColor"> <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(int,int,int,int)">YUVImage</a></span>​(int width, int align, int height, int subsamp)</code></th> <td class="colLast"> <div class="block">Create a new <code>YUVImage</code> instance backed by a unified buffer, and allocate memory for the buffer.</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></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>byte[]</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBuf()">getBuf</a></span>()</code></th> <td class="colLast"> <div class="block">Returns the YUV buffer (if this image is stored in a unified buffer rather than separate image planes.)</div> </td> </tr> <tr id="i1" class="rowColor"> <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 YUV image (or subregion.)</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>int[]</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOffsets()">getOffsets</a></span>()</code></th> <td class="colLast"> <div class="block">Returns the offsets (in bytes) of each plane within the planes of a larger YUV image.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>int</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPad()">getPad</a></span>()</code></th> <td class="colLast"> <div class="block">Returns the row alignment (in bytes) of the YUV buffer (if this image is stored in a unified buffer rather than separate image planes.)</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="#getPlanes()">getPlanes</a></span>()</code></th> <td class="colLast"> <div class="block">Returns the YUV image planes.</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>int</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSize()">getSize</a></span>()</code></th> <td class="colLast"> <div class="block">Returns the size (in bytes) of the YUV buffer (if this image is stored in a unified buffer rather than separate image planes.)</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>int[]</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStrides()">getStrides</a></span>()</code></th> <td class="colLast"> <div class="block">Returns the number of bytes per row of each plane in the YUV image.</div> </td> </tr> <tr id="i7" 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">Returns the level of chrominance subsampling used in the YUV image.</div> </td> </tr> <tr id="i8" 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 YUV image (or subregion.)</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="#setBuf(byte%5B%5D%5B%5D,int%5B%5D,int,int%5B%5D,int,int)">setBuf</a></span>​(byte[][] planes, int[] offsets, int width, int[] strides, int height, int subsamp)</code></th> <td class="colLast"> <div class="block">Assign a set of image planes to this <code>YUVImage</code> 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="#setBuf(byte%5B%5D,int,int,int,int)">setBuf</a></span>​(byte[] yuvImage, int width, int align, int height, int subsamp)</code></th> <td class="colLast"> <div class="block">Assign a unified buffer to this <code>YUVImage</code> 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, finalize, 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>(int,int[],int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>YUVImage</h4> <pre>public YUVImage​(int width, int[] strides, int height, int subsamp)</pre> <div class="block">Create a new <code>YUVImage</code> instance backed by separate image planes, and allocate memory for the image planes.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>width</code> - width (in pixels) of the YUV image</dd> <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 plane width (see <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>above</code></a>.) If <code>strides</code> is null, then the strides for all planes will be set to their respective plane widths. When using this constructor, the stride for each plane must be equal to or greater than the plane width.</dd> <dd><code>height</code> - height (in pixels) of the YUV image</dd> <dd><code>subsamp</code> - the level of chrominance subsampling to be used in the YUV image (one of <a href="TJ.html#SAMP_444"><code>TJ.SAMP_*</code></a>)</dd> </dl> </li> </ul> <a id="<init>(int,int,int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>YUVImage</h4> <pre>public YUVImage​(int width, int align, int height, int subsamp)</pre> <div class="block">Create a new <code>YUVImage</code> instance backed by a unified buffer, and allocate memory for the buffer.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>width</code> - width (in pixels) of the YUV image</dd> <dd><code>align</code> - row alignment (in bytes) of the YUV image (must be a power of 2.) Setting this parameter to n specifies that each row in each plane of the YUV image will be padded to the nearest multiple of n bytes (1 = unpadded.)</dd> <dd><code>height</code> - height (in pixels) of the YUV image</dd> <dd><code>subsamp</code> - the level of chrominance subsampling to be used in the YUV image (one of <a href="TJ.html#SAMP_444"><code>TJ.SAMP_*</code></a>)</dd> </dl> </li> </ul> <a id="<init>(byte[][],int[],int,int[],int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>YUVImage</h4> <pre>public YUVImage​(byte[][] planes, int[] offsets, int width, int[] strides, int height, int subsamp)</pre> <div class="block">Create a new <code>YUVImage</code> instance from a set of existing image planes.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>planes</code> - an array of buffers representing the Y, U (Cb), and V (Cr) image planes (or just the Y plane, if the image is grayscale.) These planes can be contiguous or non-contiguous in memory. Plane <code>i</code> should be at least <code>offsets[i] + <a href="TJ.html#planeSizeYUV(int,int,int,int,int)"><code>TJ.planeSizeYUV</code></a>(i, width, strides[i], height, subsamp)</code> bytes in size.</dd> <dd><code>offsets</code> - If this <code>YUVImage</code> instance represents a subregion of a larger image, then <code>offsets[i]</code> specifies the offset (in bytes) of the subregion within plane <code>i</code> of the larger image. Setting this to null is the same as setting the offsets for all planes to 0.</dd> <dd><code>width</code> - width (in pixels) of the new YUV image (or subregion)</dd> <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 plane width (see <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>above</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 or to specify that this <code>YUVImage</code> instance is a subregion of a larger image (in which case, <code>strides[i]</code> should be set to the plane width of plane <code>i</code> in the larger image.)</dd> <dd><code>height</code> - height (in pixels) of the new YUV image (or subregion)</dd> <dd><code>subsamp</code> - the level of chrominance subsampling used in the YUV image (one of <a href="TJ.html#SAMP_444"><code>TJ.SAMP_*</code></a>)</dd> </dl> </li> </ul> <a id="<init>(byte[],int,int,int,int)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>YUVImage</h4> <pre>public YUVImage​(byte[] yuvImage, int width, int align, int height, int subsamp)</pre> <div class="block">Create a new <code>YUVImage</code> instance from an existing unified buffer.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>yuvImage</code> - buffer that contains or will receive a unified planar YUV image. Use <a href="TJ.html#bufSizeYUV(int,int,int,int)"><code>TJ.bufSizeYUV()</code></a> to determine the minimum size for this buffer. The Y, U (Cb), and V (Cr) image planes are stored sequentially in the buffer. (See <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>above</code></a> for a description of the image format.)</dd> <dd><code>width</code> - width (in pixels) of the YUV image</dd> <dd><code>align</code> - row alignment (in bytes) of the YUV image (must be a power of 2.) Setting this parameter to n specifies that each row in each plane of the YUV image will be padded to the nearest multiple of n bytes (1 = unpadded.)</dd> <dd><code>height</code> - height (in pixels) of the YUV image</dd> <dd><code>subsamp</code> - the level of chrominance subsampling used in the YUV image (one of <a href="TJ.html#SAMP_444"><code>TJ.SAMP_*</code></a>)</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="setBuf(byte[][],int[],int,int[],int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setBuf</h4> <pre class="methodSignature">public void setBuf​(byte[][] planes, int[] offsets, int width, int[] strides, int height, int subsamp)</pre> <div class="block">Assign a set of image planes to this <code>YUVImage</code> instance.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>planes</code> - an array of buffers representing the Y, U (Cb), and V (Cr) image planes (or just the Y plane, if the image is grayscale.) These planes can be contiguous or non-contiguous in memory. Plane <code>i</code> should be at least <code>offsets[i] + <a href="TJ.html#planeSizeYUV(int,int,int,int,int)"><code>TJ.planeSizeYUV</code></a>(i, width, strides[i], height, subsamp)</code> bytes in size.</dd> <dd><code>offsets</code> - If this <code>YUVImage</code> instance represents a subregion of a larger image, then <code>offsets[i]</code> specifies the offset (in bytes) of the subregion within plane <code>i</code> of the larger image. Setting this to null is the same as setting the offsets for all planes to 0.</dd> <dd><code>width</code> - width (in pixels) of the YUV image (or subregion)</dd> <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 plane width (see <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>above</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 or to specify that this <code>YUVImage</code> instance is a subregion of a larger image (in which case, <code>strides[i]</code> should be set to the plane width of plane <code>i</code> in the larger image.)</dd> <dd><code>height</code> - height (in pixels) of the YUV image (or subregion)</dd> <dd><code>subsamp</code> - the level of chrominance subsampling used in the YUV image (one of <a href="TJ.html#SAMP_444"><code>TJ.SAMP_*</code></a>)</dd> </dl> </li> </ul> <a id="setBuf(byte[],int,int,int,int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setBuf</h4> <pre class="methodSignature">public void setBuf​(byte[] yuvImage, int width, int align, int height, int subsamp)</pre> <div class="block">Assign a unified buffer to this <code>YUVImage</code> instance.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>yuvImage</code> - buffer that contains or will receive a unified planar YUV image. Use <a href="TJ.html#bufSizeYUV(int,int,int,int)"><code>TJ.bufSizeYUV()</code></a> to determine the minimum size for this buffer. The Y, U (Cb), and V (Cr) image planes are stored sequentially in the buffer. (See <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>above</code></a> for a description of the image format.)</dd> <dd><code>width</code> - width (in pixels) of the YUV image</dd> <dd><code>align</code> - row alignment (in bytes) of the YUV image (must be a power of 2.) Setting this parameter to n specifies that each row in each plane of the YUV image will be padded to the nearest multiple of n bytes (1 = unpadded.)</dd> <dd><code>height</code> - height (in pixels) of the YUV image</dd> <dd><code>subsamp</code> - the level of chrominance subsampling used in the YUV image (one of <a href="TJ.html#SAMP_444"><code>TJ.SAMP_*</code></a>)</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 YUV image (or subregion.)</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the width of the YUV image (or subregion)</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 YUV image (or subregion.)</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the height of the YUV image (or subregion)</dd> </dl> </li> </ul> <a id="getPad()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPad</h4> <pre class="methodSignature">public int getPad()</pre> <div class="block">Returns the row alignment (in bytes) of the YUV buffer (if this image is stored in a unified buffer rather than separate image planes.)</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the row alignment of the YUV buffer</dd> </dl> </li> </ul> <a id="getStrides()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getStrides</h4> <pre class="methodSignature">public int[] getStrides()</pre> <div class="block">Returns the number of bytes per row of each plane in the YUV image.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the number of bytes per row of each plane in the YUV image</dd> </dl> </li> </ul> <a id="getOffsets()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getOffsets</h4> <pre class="methodSignature">public int[] getOffsets()</pre> <div class="block">Returns the offsets (in bytes) of each plane within the planes of a larger YUV image.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the offsets (in bytes) of each plane within the planes of a larger YUV image</dd> </dl> </li> </ul> <a id="getSubsamp()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getSubsamp</h4> <pre class="methodSignature">public int getSubsamp()</pre> <div class="block">Returns the level of chrominance subsampling used in the YUV image. See <a href="TJ.html#SAMP_444"><code>TJ.SAMP_*</code></a>.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the level of chrominance subsampling used in the YUV image</dd> </dl> </li> </ul> <a id="getPlanes()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPlanes</h4> <pre class="methodSignature">public byte[][] getPlanes()</pre> <div class="block">Returns the YUV image planes. If the image is stored in a unified buffer, then all image planes will point to that buffer.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the YUV image planes</dd> </dl> </li> </ul> <a id="getBuf()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getBuf</h4> <pre class="methodSignature">public byte[] getBuf()</pre> <div class="block">Returns the YUV buffer (if this image is stored in a unified buffer rather than separate image planes.)</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the YUV buffer</dd> </dl> </li> </ul> <a id="getSize()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getSize</h4> <pre class="methodSignature">public int getSize()</pre> <div class="block">Returns the size (in bytes) of the YUV buffer (if this image is stored in a unified buffer rather than separate image planes.)</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the size (in bytes) of the YUV buffer</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>