a53f87973eaf6064719c43ca158d85afca26eba6
[platform/upstream/libjpeg-turbo.git] / java / doc / org / libjpegturbo / turbojpeg / TJCompressor.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!-- NewPage -->
3 <html lang="en">
4 <head>
5 <title>TJCompressor</title>
6 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
7 </head>
8 <body>
9 <script type="text/javascript"><!--
10     try {
11         if (location.href.indexOf('is-external=true') == -1) {
12             parent.document.title="TJCompressor";
13         }
14     }
15     catch(err) {
16     }
17 //-->
18 </script>
19 <noscript>
20 <div>JavaScript is disabled on your browser.</div>
21 </noscript>
22 <!-- ========= START OF TOP NAVBAR ======= -->
23 <div class="topNav"><a name="navbar_top">
24 <!--   -->
25 </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
26 <!--   -->
27 </a>
28 <ul class="navList" title="Navigation">
29 <li><a href="../../../org/libjpegturbo/turbojpeg/package-summary.html">Package</a></li>
30 <li class="navBarCell1Rev">Class</li>
31 <li><a href="package-tree.html">Tree</a></li>
32 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
33 <li><a href="../../../index-all.html">Index</a></li>
34 <li><a href="../../../help-doc.html">Help</a></li>
35 </ul>
36 </div>
37 <div class="subNav">
38 <ul class="navList">
39 <li><a href="../../../org/libjpegturbo/turbojpeg/TJ.html" title="class in org.libjpegturbo.turbojpeg"><span class="strong">Prev Class</span></a></li>
40 <li><a href="../../../org/libjpegturbo/turbojpeg/TJCustomFilter.html" title="interface in org.libjpegturbo.turbojpeg"><span class="strong">Next Class</span></a></li>
41 </ul>
42 <ul class="navList">
43 <li><a href="../../../index.html?org/libjpegturbo/turbojpeg/TJCompressor.html" target="_top">Frames</a></li>
44 <li><a href="TJCompressor.html" target="_top">No Frames</a></li>
45 </ul>
46 <ul class="navList" id="allclasses_navbar_top">
47 <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
48 </ul>
49 <div>
50 <script type="text/javascript"><!--
51   allClassesLink = document.getElementById("allclasses_navbar_top");
52   if(window==top) {
53     allClassesLink.style.display = "block";
54   }
55   else {
56     allClassesLink.style.display = "none";
57   }
58   //-->
59 </script>
60 </div>
61 <div>
62 <ul class="subNavList">
63 <li>Summary:&nbsp;</li>
64 <li>Nested&nbsp;|&nbsp;</li>
65 <li>Field&nbsp;|&nbsp;</li>
66 <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
67 <li><a href="#method_summary">Method</a></li>
68 </ul>
69 <ul class="subNavList">
70 <li>Detail:&nbsp;</li>
71 <li>Field&nbsp;|&nbsp;</li>
72 <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
73 <li><a href="#method_detail">Method</a></li>
74 </ul>
75 </div>
76 <a name="skip-navbar_top">
77 <!--   -->
78 </a></div>
79 <!-- ========= END OF TOP NAVBAR ========= -->
80 <!-- ======== START OF CLASS DATA ======== -->
81 <div class="header">
82 <div class="subTitle">org.libjpegturbo.turbojpeg</div>
83 <h2 title="Class TJCompressor" class="title">Class TJCompressor</h2>
84 </div>
85 <div class="contentContainer">
86 <ul class="inheritance">
87 <li>java.lang.Object</li>
88 <li>
89 <ul class="inheritance">
90 <li>org.libjpegturbo.turbojpeg.TJCompressor</li>
91 </ul>
92 </li>
93 </ul>
94 <div class="description">
95 <ul class="blockList">
96 <li class="blockList">
97 <dl>
98 <dt>All Implemented Interfaces:</dt>
99 <dd>java.io.Closeable, java.lang.AutoCloseable</dd>
100 </dl>
101 <hr>
102 <br>
103 <pre>public class <span class="strong">TJCompressor</span>
104 extends java.lang.Object
105 implements java.io.Closeable</pre>
106 <div class="block">TurboJPEG compressor</div>
107 </li>
108 </ul>
109 </div>
110 <div class="summary">
111 <ul class="blockList">
112 <li class="blockList">
113 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
114 <ul class="blockList">
115 <li class="blockList"><a name="constructor_summary">
116 <!--   -->
117 </a>
118 <h3>Constructor Summary</h3>
119 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
120 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
121 <tr>
122 <th class="colOne" scope="col">Constructor and Description</th>
123 </tr>
124 <tr class="altColor">
125 <td class="colOne"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#TJCompressor()">TJCompressor</a></strong>()</code>
126 <div class="block">Create a TurboJPEG compressor instance.</div>
127 </td>
128 </tr>
129 <tr class="rowColor">
130 <td class="colOne"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#TJCompressor(java.awt.image.BufferedImage,%20int,%20int,%20int,%20int)">TJCompressor</a></strong>(java.awt.image.BufferedImage&nbsp;srcImage,
131             int&nbsp;x,
132             int&nbsp;y,
133             int&nbsp;width,
134             int&nbsp;height)</code>
135 <div class="block">Create a TurboJPEG compressor instance and associate the uncompressed
136  source image stored in <code>srcImage</code> with the newly created
137  instance.</div>
138 </td>
139 </tr>
140 <tr class="altColor">
141 <td class="colOne"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#TJCompressor(byte[],%20int,%20int,%20int,%20int)">TJCompressor</a></strong>(byte[]&nbsp;srcImage,
142             int&nbsp;width,
143             int&nbsp;pitch,
144             int&nbsp;height,
145             int&nbsp;pixelFormat)</code>
146 <div class="block"><strong>Deprecated.</strong>&nbsp;
147 <div class="block"><i>Use
148  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#TJCompressor(byte[],%20int,%20int,%20int,%20int,%20int,%20int)"><code>TJCompressor(byte[], int, int, int, int, int, int)</code></a> instead.</i></div>
149 </div>
150 </td>
151 </tr>
152 <tr class="rowColor">
153 <td class="colOne"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#TJCompressor(byte[],%20int,%20int,%20int,%20int,%20int,%20int)">TJCompressor</a></strong>(byte[]&nbsp;srcImage,
154             int&nbsp;x,
155             int&nbsp;y,
156             int&nbsp;width,
157             int&nbsp;pitch,
158             int&nbsp;height,
159             int&nbsp;pixelFormat)</code>
160 <div class="block">Create a TurboJPEG compressor instance and associate the uncompressed
161  source image stored in <code>srcImage</code> with the newly created
162  instance.</div>
163 </td>
164 </tr>
165 </table>
166 </li>
167 </ul>
168 <!-- ========== METHOD SUMMARY =========== -->
169 <ul class="blockList">
170 <li class="blockList"><a name="method_summary">
171 <!--   -->
172 </a>
173 <h3>Method Summary</h3>
174 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
175 <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
176 <tr>
177 <th class="colFirst" scope="col">Modifier and Type</th>
178 <th class="colLast" scope="col">Method and Description</th>
179 </tr>
180 <tr class="altColor">
181 <td class="colFirst"><code>void</code></td>
182 <td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#close()">close</a></strong>()</code>
183 <div class="block">Free the native structures associated with this compressor instance.</div>
184 </td>
185 </tr>
186 <tr class="rowColor">
187 <td class="colFirst"><code>void</code></td>
188 <td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#compress(java.awt.image.BufferedImage,%20byte[],%20int)">compress</a></strong>(java.awt.image.BufferedImage&nbsp;srcImage,
189         byte[]&nbsp;dstBuf,
190         int&nbsp;flags)</code>
191 <div class="block"><strong>Deprecated.</strong>&nbsp;
192 <div class="block"><i>Use
193  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(java.awt.image.BufferedImage,%20int,%20int,%20int,%20int)"><code>setSourceImage(BufferedImage, int, int, int, int)</code></a> and
194  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#compress(byte[],%20int)"><code>compress(byte[], int)</code></a> instead.</i></div>
195 </div>
196 </td>
197 </tr>
198 <tr class="altColor">
199 <td class="colFirst"><code>byte[]</code></td>
200 <td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#compress(java.awt.image.BufferedImage,%20int)">compress</a></strong>(java.awt.image.BufferedImage&nbsp;srcImage,
201         int&nbsp;flags)</code>
202 <div class="block"><strong>Deprecated.</strong>&nbsp;
203 <div class="block"><i>Use
204  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(java.awt.image.BufferedImage,%20int,%20int,%20int,%20int)"><code>setSourceImage(BufferedImage, int, int, int, int)</code></a> and
205  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#compress(int)"><code>compress(int)</code></a> instead.</i></div>
206 </div>
207 </td>
208 </tr>
209 <tr class="rowColor">
210 <td class="colFirst"><code>void</code></td>
211 <td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#compress(byte[],%20int)">compress</a></strong>(byte[]&nbsp;dstBuf,
212         int&nbsp;flags)</code>
213 <div class="block">Compress the uncompressed source image associated with this compressor
214  instance and output a JPEG image to the given destination buffer.</div>
215 </td>
216 </tr>
217 <tr class="altColor">
218 <td class="colFirst"><code>byte[]</code></td>
219 <td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#compress(int)">compress</a></strong>(int&nbsp;flags)</code>
220 <div class="block">Compress the uncompressed source image associated with this compressor
221  instance and return a buffer containing a JPEG image.</div>
222 </td>
223 </tr>
224 <tr class="rowColor">
225 <td class="colFirst"><code>void</code></td>
226 <td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#encodeYUV(java.awt.image.BufferedImage,%20byte[],%20int)">encodeYUV</a></strong>(java.awt.image.BufferedImage&nbsp;srcImage,
227          byte[]&nbsp;dstBuf,
228          int&nbsp;flags)</code>
229 <div class="block"><strong>Deprecated.</strong>&nbsp;
230 <div class="block"><i>Use
231  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(java.awt.image.BufferedImage,%20int,%20int,%20int,%20int)"><code>setSourceImage(BufferedImage, int, int, int, int)</code></a> and
232  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#encodeYUV(byte[],%20int)"><code>encodeYUV(byte[], int)</code></a> instead.</i></div>
233 </div>
234 </td>
235 </tr>
236 <tr class="altColor">
237 <td class="colFirst"><code>byte[]</code></td>
238 <td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#encodeYUV(java.awt.image.BufferedImage,%20int)">encodeYUV</a></strong>(java.awt.image.BufferedImage&nbsp;srcImage,
239          int&nbsp;flags)</code>
240 <div class="block"><strong>Deprecated.</strong>&nbsp;
241 <div class="block"><i>Use
242  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(java.awt.image.BufferedImage,%20int,%20int,%20int,%20int)"><code>setSourceImage(BufferedImage, int, int, int, int)</code></a> and
243  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#encodeYUV(int,%20int)"><code>encodeYUV(int, int)</code></a> instead.</i></div>
244 </div>
245 </td>
246 </tr>
247 <tr class="rowColor">
248 <td class="colFirst"><code>void</code></td>
249 <td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#encodeYUV(byte[],%20int)">encodeYUV</a></strong>(byte[]&nbsp;dstBuf,
250          int&nbsp;flags)</code>
251 <div class="block"><strong>Deprecated.</strong>&nbsp;
252 <div class="block"><i>Use <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#encodeYUV(org.libjpegturbo.turbojpeg.YUVImage,%20int)"><code>encodeYUV(YUVImage, int)</code></a> instead.</i></div>
253 </div>
254 </td>
255 </tr>
256 <tr class="altColor">
257 <td class="colFirst"><code>byte[]</code></td>
258 <td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#encodeYUV(int)">encodeYUV</a></strong>(int&nbsp;flags)</code>
259 <div class="block"><strong>Deprecated.</strong>&nbsp;
260 <div class="block"><i>Use <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#encodeYUV(int,%20int)"><code>encodeYUV(int, int)</code></a> instead.</i></div>
261 </div>
262 </td>
263 </tr>
264 <tr class="rowColor">
265 <td class="colFirst"><code><a href="../../../org/libjpegturbo/turbojpeg/YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a></code></td>
266 <td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#encodeYUV(int[],%20int)">encodeYUV</a></strong>(int[]&nbsp;strides,
267          int&nbsp;flags)</code>
268 <div class="block">Encode the uncompressed source image associated with this compressor
269  instance into separate Y, U (Cb), and V (Cr) image planes and return a
270  <code>YUVImage</code> instance containing the encoded image planes.</div>
271 </td>
272 </tr>
273 <tr class="altColor">
274 <td class="colFirst"><code><a href="../../../org/libjpegturbo/turbojpeg/YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a></code></td>
275 <td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#encodeYUV(int,%20int)">encodeYUV</a></strong>(int&nbsp;pad,
276          int&nbsp;flags)</code>
277 <div class="block">Encode the uncompressed source image associated with this compressor
278  instance into a unified YUV planar image buffer and return a
279  <code>YUVImage</code> instance containing the encoded image.</div>
280 </td>
281 </tr>
282 <tr class="rowColor">
283 <td class="colFirst"><code>void</code></td>
284 <td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#encodeYUV(org.libjpegturbo.turbojpeg.YUVImage,%20int)">encodeYUV</a></strong>(<a href="../../../org/libjpegturbo/turbojpeg/YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a>&nbsp;dstImage,
285          int&nbsp;flags)</code>
286 <div class="block">Encode the uncompressed source image associated with this compressor
287  instance into a YUV planar image and store it in the given
288  <code>YUVImage</code> instance.</div>
289 </td>
290 </tr>
291 <tr class="altColor">
292 <td class="colFirst"><code>protected void</code></td>
293 <td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#finalize()">finalize</a></strong>()</code>&nbsp;</td>
294 </tr>
295 <tr class="rowColor">
296 <td class="colFirst"><code>int</code></td>
297 <td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#getCompressedSize()">getCompressedSize</a></strong>()</code>
298 <div class="block">Returns the size of the image (in bytes) generated by the most recent
299  compress operation.</div>
300 </td>
301 </tr>
302 <tr class="altColor">
303 <td class="colFirst"><code>void</code></td>
304 <td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setJPEGQuality(int)">setJPEGQuality</a></strong>(int&nbsp;quality)</code>
305 <div class="block">Set the JPEG image quality level for subsequent compress operations.</div>
306 </td>
307 </tr>
308 <tr class="rowColor">
309 <td class="colFirst"><code>void</code></td>
310 <td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(java.awt.image.BufferedImage,%20int,%20int,%20int,%20int)">setSourceImage</a></strong>(java.awt.image.BufferedImage&nbsp;srcImage,
311               int&nbsp;x,
312               int&nbsp;y,
313               int&nbsp;width,
314               int&nbsp;height)</code>
315 <div class="block">Associate an uncompressed RGB or grayscale source image with this
316  compressor instance.</div>
317 </td>
318 </tr>
319 <tr class="altColor">
320 <td class="colFirst"><code>void</code></td>
321 <td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[],%20int,%20int,%20int,%20int)">setSourceImage</a></strong>(byte[]&nbsp;srcImage,
322               int&nbsp;width,
323               int&nbsp;pitch,
324               int&nbsp;height,
325               int&nbsp;pixelFormat)</code>
326 <div class="block"><strong>Deprecated.</strong>&nbsp;
327 <div class="block"><i>Use
328  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[],%20int,%20int,%20int,%20int,%20int,%20int)"><code>setSourceImage(byte[], int, int, int, int, int, int)</code></a> instead.</i></div>
329 </div>
330 </td>
331 </tr>
332 <tr class="rowColor">
333 <td class="colFirst"><code>void</code></td>
334 <td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[],%20int,%20int,%20int,%20int,%20int,%20int)">setSourceImage</a></strong>(byte[]&nbsp;srcImage,
335               int&nbsp;x,
336               int&nbsp;y,
337               int&nbsp;width,
338               int&nbsp;pitch,
339               int&nbsp;height,
340               int&nbsp;pixelFormat)</code>
341 <div class="block">Associate an uncompressed RGB, grayscale, or CMYK source image with this
342  compressor instance.</div>
343 </td>
344 </tr>
345 <tr class="altColor">
346 <td class="colFirst"><code>void</code></td>
347 <td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(org.libjpegturbo.turbojpeg.YUVImage)">setSourceImage</a></strong>(<a href="../../../org/libjpegturbo/turbojpeg/YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a>&nbsp;srcImage)</code>
348 <div class="block">Associate an uncompressed YUV planar source image with this compressor
349  instance.</div>
350 </td>
351 </tr>
352 <tr class="rowColor">
353 <td class="colFirst"><code>void</code></td>
354 <td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSubsamp(int)">setSubsamp</a></strong>(int&nbsp;newSubsamp)</code>
355 <div class="block">Set the level of chrominance subsampling for subsequent compress/encode
356  operations.</div>
357 </td>
358 </tr>
359 </table>
360 <ul class="blockList">
361 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
362 <!--   -->
363 </a>
364 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
365 <code>clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
366 </ul>
367 </li>
368 </ul>
369 </li>
370 </ul>
371 </div>
372 <div class="details">
373 <ul class="blockList">
374 <li class="blockList">
375 <!-- ========= CONSTRUCTOR DETAIL ======== -->
376 <ul class="blockList">
377 <li class="blockList"><a name="constructor_detail">
378 <!--   -->
379 </a>
380 <h3>Constructor Detail</h3>
381 <a name="TJCompressor()">
382 <!--   -->
383 </a>
384 <ul class="blockList">
385 <li class="blockList">
386 <h4>TJCompressor</h4>
387 <pre>public&nbsp;TJCompressor()
388              throws <a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre>
389 <div class="block">Create a TurboJPEG compressor instance.</div>
390 <dl><dt><span class="strong">Throws:</span></dt>
391 <dd><code><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd></dl>
392 </li>
393 </ul>
394 <a name="TJCompressor(byte[], int, int, int, int, int, int)">
395 <!--   -->
396 </a>
397 <ul class="blockList">
398 <li class="blockList">
399 <h4>TJCompressor</h4>
400 <pre>public&nbsp;TJCompressor(byte[]&nbsp;srcImage,
401             int&nbsp;x,
402             int&nbsp;y,
403             int&nbsp;width,
404             int&nbsp;pitch,
405             int&nbsp;height,
406             int&nbsp;pixelFormat)
407              throws <a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre>
408 <div class="block">Create a TurboJPEG compressor instance and associate the uncompressed
409  source image stored in <code>srcImage</code> with the newly created
410  instance.</div>
411 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>srcImage</code> - see <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[],%20int,%20int,%20int,%20int,%20int,%20int)"><code>setSourceImage(byte[], int, int, int, int, int, int)</code></a> for description</dd><dd><code>x</code> - see <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[],%20int,%20int,%20int,%20int,%20int,%20int)"><code>setSourceImage(byte[], int, int, int, int, int, int)</code></a> for description</dd><dd><code>y</code> - see <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[],%20int,%20int,%20int,%20int,%20int,%20int)"><code>setSourceImage(byte[], int, int, int, int, int, int)</code></a> for description</dd><dd><code>width</code> - see <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[],%20int,%20int,%20int,%20int,%20int,%20int)"><code>setSourceImage(byte[], int, int, int, int, int, int)</code></a> for description</dd><dd><code>pitch</code> - see <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[],%20int,%20int,%20int,%20int,%20int,%20int)"><code>setSourceImage(byte[], int, int, int, int, int, int)</code></a> for description</dd><dd><code>height</code> - see <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[],%20int,%20int,%20int,%20int,%20int,%20int)"><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
412  <a href="../../../org/libjpegturbo/turbojpeg/TJ.html#PF_RGB"><code>TJ.PF_*</code></a>)</dd>
413 <dt><span class="strong">Throws:</span></dt>
414 <dd><code><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd></dl>
415 </li>
416 </ul>
417 <a name="TJCompressor(byte[], int, int, int, int)">
418 <!--   -->
419 </a>
420 <ul class="blockList">
421 <li class="blockList">
422 <h4>TJCompressor</h4>
423 <pre>@Deprecated
424 public&nbsp;TJCompressor(byte[]&nbsp;srcImage,
425                        int&nbsp;width,
426                        int&nbsp;pitch,
427                        int&nbsp;height,
428                        int&nbsp;pixelFormat)
429              throws <a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre>
430 <div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>Use
431  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#TJCompressor(byte[],%20int,%20int,%20int,%20int,%20int,%20int)"><code>TJCompressor(byte[], int, int, int, int, int, int)</code></a> instead.</i></div>
432 <dl><dt><span class="strong">Throws:</span></dt>
433 <dd><code><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd></dl>
434 </li>
435 </ul>
436 <a name="TJCompressor(java.awt.image.BufferedImage, int, int, int, int)">
437 <!--   -->
438 </a>
439 <ul class="blockListLast">
440 <li class="blockList">
441 <h4>TJCompressor</h4>
442 <pre>public&nbsp;TJCompressor(java.awt.image.BufferedImage&nbsp;srcImage,
443             int&nbsp;x,
444             int&nbsp;y,
445             int&nbsp;width,
446             int&nbsp;height)
447              throws <a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre>
448 <div class="block">Create a TurboJPEG compressor instance and associate the uncompressed
449  source image stored in <code>srcImage</code> with the newly created
450  instance.</div>
451 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>srcImage</code> - see
452  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(java.awt.image.BufferedImage,%20int,%20int,%20int,%20int)"><code>setSourceImage(BufferedImage, int, int, int, int)</code></a> for description</dd><dd><code>x</code> - see
453  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(java.awt.image.BufferedImage,%20int,%20int,%20int,%20int)"><code>setSourceImage(BufferedImage, int, int, int, int)</code></a> for description</dd><dd><code>y</code> - see
454  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(java.awt.image.BufferedImage,%20int,%20int,%20int,%20int)"><code>setSourceImage(BufferedImage, int, int, int, int)</code></a> for description</dd><dd><code>width</code> - see
455  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(java.awt.image.BufferedImage,%20int,%20int,%20int,%20int)"><code>setSourceImage(BufferedImage, int, int, int, int)</code></a> for description</dd><dd><code>height</code> - see
456  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(java.awt.image.BufferedImage,%20int,%20int,%20int,%20int)"><code>setSourceImage(BufferedImage, int, int, int, int)</code></a> for description</dd>
457 <dt><span class="strong">Throws:</span></dt>
458 <dd><code><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd></dl>
459 </li>
460 </ul>
461 </li>
462 </ul>
463 <!-- ============ METHOD DETAIL ========== -->
464 <ul class="blockList">
465 <li class="blockList"><a name="method_detail">
466 <!--   -->
467 </a>
468 <h3>Method Detail</h3>
469 <a name="setSourceImage(byte[], int, int, int, int, int, int)">
470 <!--   -->
471 </a>
472 <ul class="blockList">
473 <li class="blockList">
474 <h4>setSourceImage</h4>
475 <pre>public&nbsp;void&nbsp;setSourceImage(byte[]&nbsp;srcImage,
476                   int&nbsp;x,
477                   int&nbsp;y,
478                   int&nbsp;width,
479                   int&nbsp;pitch,
480                   int&nbsp;height,
481                   int&nbsp;pixelFormat)
482                     throws <a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre>
483 <div class="block">Associate an uncompressed RGB, grayscale, or CMYK source image with this
484  compressor instance.</div>
485 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>srcImage</code> - image buffer containing RGB, grayscale, or CMYK pixels to
486  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
487  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
488  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
489  which the JPEG or YUV image should be compressed/encoded</dd><dd><code>pitch</code> - bytes per line of the source image.  Normally, this should be
490  <code>width * TJ.pixelSize(pixelFormat)</code> if the source image is
491  unpadded, but you can use this parameter to, for instance, specify that
492  the scanlines in the source image are padded to a 4-byte boundary or to
493  compress/encode a JPEG or YUV image from a region of a larger source
494  image.  You can also be clever and use this parameter to skip lines, etc.
495  Setting this parameter to 0 is the equivalent of setting it to
496  <code>width * TJ.pixelSize(pixelFormat)</code>.</dd><dd><code>height</code> - height (in pixels) of the region in the source image from
497  which the JPEG or YUV image should be compressed/encoded</dd><dd><code>pixelFormat</code> - pixel format of the source image (one of
498  <a href="../../../org/libjpegturbo/turbojpeg/TJ.html#PF_RGB"><code>TJ.PF_*</code></a>)</dd>
499 <dt><span class="strong">Throws:</span></dt>
500 <dd><code><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd></dl>
501 </li>
502 </ul>
503 <a name="setSourceImage(byte[], int, int, int, int)">
504 <!--   -->
505 </a>
506 <ul class="blockList">
507 <li class="blockList">
508 <h4>setSourceImage</h4>
509 <pre>@Deprecated
510 public&nbsp;void&nbsp;setSourceImage(byte[]&nbsp;srcImage,
511                              int&nbsp;width,
512                              int&nbsp;pitch,
513                              int&nbsp;height,
514                              int&nbsp;pixelFormat)
515                     throws <a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre>
516 <div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>Use
517  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[],%20int,%20int,%20int,%20int,%20int,%20int)"><code>setSourceImage(byte[], int, int, int, int, int, int)</code></a> instead.</i></div>
518 <dl><dt><span class="strong">Throws:</span></dt>
519 <dd><code><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd></dl>
520 </li>
521 </ul>
522 <a name="setSourceImage(java.awt.image.BufferedImage, int, int, int, int)">
523 <!--   -->
524 </a>
525 <ul class="blockList">
526 <li class="blockList">
527 <h4>setSourceImage</h4>
528 <pre>public&nbsp;void&nbsp;setSourceImage(java.awt.image.BufferedImage&nbsp;srcImage,
529                   int&nbsp;x,
530                   int&nbsp;y,
531                   int&nbsp;width,
532                   int&nbsp;height)
533                     throws <a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre>
534 <div class="block">Associate an uncompressed RGB or grayscale source image with this
535  compressor instance.</div>
536 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>srcImage</code> - a <code>BufferedImage</code> instance containing RGB or
537  grayscale pixels 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
538  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
539  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
540  which the JPEG or YUV image should be compressed/encoded (0 = use the
541  width of the source image)</dd><dd><code>height</code> - height (in pixels) of the region in the source image from
542  which the JPEG or YUV image should be compressed/encoded (0 = use the
543  height of the source image)</dd>
544 <dt><span class="strong">Throws:</span></dt>
545 <dd><code><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd></dl>
546 </li>
547 </ul>
548 <a name="setSourceImage(org.libjpegturbo.turbojpeg.YUVImage)">
549 <!--   -->
550 </a>
551 <ul class="blockList">
552 <li class="blockList">
553 <h4>setSourceImage</h4>
554 <pre>public&nbsp;void&nbsp;setSourceImage(<a href="../../../org/libjpegturbo/turbojpeg/YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a>&nbsp;srcImage)
555                     throws <a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre>
556 <div class="block">Associate an uncompressed YUV planar source image with this compressor
557  instance.</div>
558 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>srcImage</code> - YUV planar image to be compressed.  This image is not
559  modified.</dd>
560 <dt><span class="strong">Throws:</span></dt>
561 <dd><code><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd></dl>
562 </li>
563 </ul>
564 <a name="setSubsamp(int)">
565 <!--   -->
566 </a>
567 <ul class="blockList">
568 <li class="blockList">
569 <h4>setSubsamp</h4>
570 <pre>public&nbsp;void&nbsp;setSubsamp(int&nbsp;newSubsamp)</pre>
571 <div class="block">Set the level of chrominance subsampling for subsequent compress/encode
572  operations.  When pixels are converted from RGB to YCbCr (see
573  <a href="../../../org/libjpegturbo/turbojpeg/TJ.html#CS_YCbCr"><code>TJ.CS_YCbCr</code></a>) or from CMYK to YCCK (see <a href="../../../org/libjpegturbo/turbojpeg/TJ.html#CS_YCCK"><code>TJ.CS_YCCK</code></a>) as part
574  of the JPEG compression process, some of the Cb and Cr (chrominance)
575  components can be discarded or averaged together to produce a smaller
576  image with little perceptible loss of image clarity (the human eye is more
577  sensitive to small changes in brightness than to small changes in color.)
578  This is called "chrominance subsampling".
579  <p>
580  NOTE: This method has no effect when compressing a JPEG image from a YUV
581  planar source.  In that case, the level of chrominance subsampling in
582  the JPEG image is determined by the source.  Furthermore, this method has
583  no effect when encoding to a pre-allocated <a href="../../../org/libjpegturbo/turbojpeg/YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>YUVImage</code></a> instance.  In
584  that case, the level of chrominance subsampling is determined by the
585  destination.</div>
586 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>newSubsamp</code> - the level of chrominance subsampling to use in
587  subsequent compress/encode oeprations (one of
588  <a href="../../../org/libjpegturbo/turbojpeg/TJ.html#SAMP_444"><code>TJ.SAMP_*</code></a>)</dd></dl>
589 </li>
590 </ul>
591 <a name="setJPEGQuality(int)">
592 <!--   -->
593 </a>
594 <ul class="blockList">
595 <li class="blockList">
596 <h4>setJPEGQuality</h4>
597 <pre>public&nbsp;void&nbsp;setJPEGQuality(int&nbsp;quality)</pre>
598 <div class="block">Set the JPEG image quality level for subsequent compress operations.</div>
599 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>quality</code> - the new JPEG image quality level (1 to 100, 1 = worst,
600  100 = best)</dd></dl>
601 </li>
602 </ul>
603 <a name="compress(byte[], int)">
604 <!--   -->
605 </a>
606 <ul class="blockList">
607 <li class="blockList">
608 <h4>compress</h4>
609 <pre>public&nbsp;void&nbsp;compress(byte[]&nbsp;dstBuf,
610             int&nbsp;flags)
611               throws <a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre>
612 <div class="block">Compress the uncompressed source image associated with this compressor
613  instance and output a JPEG image to the given destination buffer.</div>
614 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>dstBuf</code> - buffer that will receive the JPEG image.  Use
615  <a href="../../../org/libjpegturbo/turbojpeg/TJ.html#bufSize(int,%20int,%20int)"><code>TJ.bufSize(int, int, int)</code></a> to determine the maximum size for this buffer based on
616  the source image's width and height and the desired level of chrominance
617  subsampling.</dd><dd><code>flags</code> - the bitwise OR of one or more of
618  <a href="../../../org/libjpegturbo/turbojpeg/TJ.html#FLAG_BOTTOMUP"><code>TJ.FLAG_*</code></a></dd>
619 <dt><span class="strong">Throws:</span></dt>
620 <dd><code><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd></dl>
621 </li>
622 </ul>
623 <a name="compress(int)">
624 <!--   -->
625 </a>
626 <ul class="blockList">
627 <li class="blockList">
628 <h4>compress</h4>
629 <pre>public&nbsp;byte[]&nbsp;compress(int&nbsp;flags)
630                 throws <a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre>
631 <div class="block">Compress the uncompressed source image associated with this compressor
632  instance and return a buffer containing a JPEG image.</div>
633 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>flags</code> - the bitwise OR of one or more of
634  <a href="../../../org/libjpegturbo/turbojpeg/TJ.html#FLAG_BOTTOMUP"><code>TJ.FLAG_*</code></a></dd>
635 <dt><span class="strong">Returns:</span></dt><dd>a buffer containing a JPEG image.  The length of this buffer will
636  not be equal to the size of the JPEG image.  Use <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#getCompressedSize()"><code>getCompressedSize()</code></a> to obtain the size of the JPEG image.</dd>
637 <dt><span class="strong">Throws:</span></dt>
638 <dd><code><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd></dl>
639 </li>
640 </ul>
641 <a name="compress(java.awt.image.BufferedImage, byte[], int)">
642 <!--   -->
643 </a>
644 <ul class="blockList">
645 <li class="blockList">
646 <h4>compress</h4>
647 <pre>@Deprecated
648 public&nbsp;void&nbsp;compress(java.awt.image.BufferedImage&nbsp;srcImage,
649                        byte[]&nbsp;dstBuf,
650                        int&nbsp;flags)
651               throws <a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre>
652 <div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>Use
653  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(java.awt.image.BufferedImage,%20int,%20int,%20int,%20int)"><code>setSourceImage(BufferedImage, int, int, int, int)</code></a> and
654  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#compress(byte[],%20int)"><code>compress(byte[], int)</code></a> instead.</i></div>
655 <dl><dt><span class="strong">Throws:</span></dt>
656 <dd><code><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd></dl>
657 </li>
658 </ul>
659 <a name="compress(java.awt.image.BufferedImage, int)">
660 <!--   -->
661 </a>
662 <ul class="blockList">
663 <li class="blockList">
664 <h4>compress</h4>
665 <pre>@Deprecated
666 public&nbsp;byte[]&nbsp;compress(java.awt.image.BufferedImage&nbsp;srcImage,
667                          int&nbsp;flags)
668                 throws <a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre>
669 <div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>Use
670  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(java.awt.image.BufferedImage,%20int,%20int,%20int,%20int)"><code>setSourceImage(BufferedImage, int, int, int, int)</code></a> and
671  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#compress(int)"><code>compress(int)</code></a> instead.</i></div>
672 <dl><dt><span class="strong">Throws:</span></dt>
673 <dd><code><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd></dl>
674 </li>
675 </ul>
676 <a name="encodeYUV(org.libjpegturbo.turbojpeg.YUVImage, int)">
677 <!--   -->
678 </a>
679 <ul class="blockList">
680 <li class="blockList">
681 <h4>encodeYUV</h4>
682 <pre>public&nbsp;void&nbsp;encodeYUV(<a href="../../../org/libjpegturbo/turbojpeg/YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a>&nbsp;dstImage,
683              int&nbsp;flags)
684                throws <a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre>
685 <div class="block">Encode the uncompressed source image associated with this compressor
686  instance into a YUV planar image and store it in the given
687  <code>YUVImage</code> instance.   This method uses the accelerated color
688  conversion routines in TurboJPEG's underlying codec but does not execute
689  any of the other steps in the JPEG compression process.  Encoding
690  CMYK source images to YUV is not supported.</div>
691 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>dstImage</code> - <a href="../../../org/libjpegturbo/turbojpeg/YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>YUVImage</code></a> instance that will receive the YUV planar
692  image</dd><dd><code>flags</code> - the bitwise OR of one or more of
693  <a href="../../../org/libjpegturbo/turbojpeg/TJ.html#FLAG_BOTTOMUP"><code>TJ.FLAG_*</code></a></dd>
694 <dt><span class="strong">Throws:</span></dt>
695 <dd><code><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd></dl>
696 </li>
697 </ul>
698 <a name="encodeYUV(byte[], int)">
699 <!--   -->
700 </a>
701 <ul class="blockList">
702 <li class="blockList">
703 <h4>encodeYUV</h4>
704 <pre>@Deprecated
705 public&nbsp;void&nbsp;encodeYUV(byte[]&nbsp;dstBuf,
706                         int&nbsp;flags)
707                throws <a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre>
708 <div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>Use <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#encodeYUV(org.libjpegturbo.turbojpeg.YUVImage,%20int)"><code>encodeYUV(YUVImage, int)</code></a> instead.</i></div>
709 <dl><dt><span class="strong">Throws:</span></dt>
710 <dd><code><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd></dl>
711 </li>
712 </ul>
713 <a name="encodeYUV(int, int)">
714 <!--   -->
715 </a>
716 <ul class="blockList">
717 <li class="blockList">
718 <h4>encodeYUV</h4>
719 <pre>public&nbsp;<a href="../../../org/libjpegturbo/turbojpeg/YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a>&nbsp;encodeYUV(int&nbsp;pad,
720                  int&nbsp;flags)
721                    throws <a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre>
722 <div class="block">Encode the uncompressed source image associated with this compressor
723  instance into a unified YUV planar image buffer and return a
724  <code>YUVImage</code> instance containing the encoded image.  This method
725  uses the accelerated color conversion routines in TurboJPEG's underlying
726  codec but does not execute any of the other steps in the JPEG compression
727  process.  Encoding CMYK source images to YUV is not supported.</div>
728 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pad</code> - the width of each line in each plane of the YUV image will be
729  padded to the nearest multiple of this number of bytes (must be a power of
730  2.)</dd><dd><code>flags</code> - the bitwise OR of one or more of
731  <a href="../../../org/libjpegturbo/turbojpeg/TJ.html#FLAG_BOTTOMUP"><code>TJ.FLAG_*</code></a></dd>
732 <dt><span class="strong">Returns:</span></dt><dd>a YUV planar image.</dd>
733 <dt><span class="strong">Throws:</span></dt>
734 <dd><code><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd></dl>
735 </li>
736 </ul>
737 <a name="encodeYUV(int[], int)">
738 <!--   -->
739 </a>
740 <ul class="blockList">
741 <li class="blockList">
742 <h4>encodeYUV</h4>
743 <pre>public&nbsp;<a href="../../../org/libjpegturbo/turbojpeg/YUVImage.html" title="class in org.libjpegturbo.turbojpeg">YUVImage</a>&nbsp;encodeYUV(int[]&nbsp;strides,
744                  int&nbsp;flags)
745                    throws <a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre>
746 <div class="block">Encode the uncompressed source image associated with this compressor
747  instance into separate Y, U (Cb), and V (Cr) image planes and return a
748  <code>YUVImage</code> instance containing the encoded image planes.  This
749  method uses the accelerated color conversion routines in TurboJPEG's
750  underlying codec but does not execute any of the other steps in the JPEG
751  compression process.  Encoding CMYK source images to YUV is not supported.</div>
752 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>strides</code> - an array of integers, each specifying the number of bytes
753  per line in the corresponding plane of the output image.  Setting the
754  stride for any plane to 0 is the same as setting it to the component width
755  of the plane.  If <code>strides</code> is null, then the strides for all
756  planes will be set to their respective component widths.  You can adjust
757  the strides in order to add an arbitrary amount of line padding to each
758  plane.</dd><dd><code>flags</code> - the bitwise OR of one or more of
759  <a href="../../../org/libjpegturbo/turbojpeg/TJ.html#FLAG_BOTTOMUP"><code>TJ.FLAG_*</code></a></dd>
760 <dt><span class="strong">Returns:</span></dt><dd>a YUV planar image.</dd>
761 <dt><span class="strong">Throws:</span></dt>
762 <dd><code><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd></dl>
763 </li>
764 </ul>
765 <a name="encodeYUV(int)">
766 <!--   -->
767 </a>
768 <ul class="blockList">
769 <li class="blockList">
770 <h4>encodeYUV</h4>
771 <pre>@Deprecated
772 public&nbsp;byte[]&nbsp;encodeYUV(int&nbsp;flags)
773                  throws <a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre>
774 <div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>Use <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#encodeYUV(int,%20int)"><code>encodeYUV(int, int)</code></a> instead.</i></div>
775 <dl><dt><span class="strong">Throws:</span></dt>
776 <dd><code><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd></dl>
777 </li>
778 </ul>
779 <a name="encodeYUV(java.awt.image.BufferedImage, byte[], int)">
780 <!--   -->
781 </a>
782 <ul class="blockList">
783 <li class="blockList">
784 <h4>encodeYUV</h4>
785 <pre>@Deprecated
786 public&nbsp;void&nbsp;encodeYUV(java.awt.image.BufferedImage&nbsp;srcImage,
787                         byte[]&nbsp;dstBuf,
788                         int&nbsp;flags)
789                throws <a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre>
790 <div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>Use
791  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(java.awt.image.BufferedImage,%20int,%20int,%20int,%20int)"><code>setSourceImage(BufferedImage, int, int, int, int)</code></a> and
792  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#encodeYUV(byte[],%20int)"><code>encodeYUV(byte[], int)</code></a> instead.</i></div>
793 <dl><dt><span class="strong">Throws:</span></dt>
794 <dd><code><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd></dl>
795 </li>
796 </ul>
797 <a name="encodeYUV(java.awt.image.BufferedImage, int)">
798 <!--   -->
799 </a>
800 <ul class="blockList">
801 <li class="blockList">
802 <h4>encodeYUV</h4>
803 <pre>@Deprecated
804 public&nbsp;byte[]&nbsp;encodeYUV(java.awt.image.BufferedImage&nbsp;srcImage,
805                           int&nbsp;flags)
806                  throws <a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre>
807 <div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>Use
808  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(java.awt.image.BufferedImage,%20int,%20int,%20int,%20int)"><code>setSourceImage(BufferedImage, int, int, int, int)</code></a> and
809  <a href="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#encodeYUV(int,%20int)"><code>encodeYUV(int, int)</code></a> instead.</i></div>
810 <dl><dt><span class="strong">Throws:</span></dt>
811 <dd><code><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd></dl>
812 </li>
813 </ul>
814 <a name="getCompressedSize()">
815 <!--   -->
816 </a>
817 <ul class="blockList">
818 <li class="blockList">
819 <h4>getCompressedSize</h4>
820 <pre>public&nbsp;int&nbsp;getCompressedSize()</pre>
821 <div class="block">Returns the size of the image (in bytes) generated by the most recent
822  compress operation.</div>
823 <dl><dt><span class="strong">Returns:</span></dt><dd>the size of the image (in bytes) generated by the most recent
824  compress operation.</dd></dl>
825 </li>
826 </ul>
827 <a name="close()">
828 <!--   -->
829 </a>
830 <ul class="blockList">
831 <li class="blockList">
832 <h4>close</h4>
833 <pre>public&nbsp;void&nbsp;close()
834            throws <a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre>
835 <div class="block">Free the native structures associated with this compressor instance.</div>
836 <dl>
837 <dt><strong>Specified by:</strong></dt>
838 <dd><code>close</code>&nbsp;in interface&nbsp;<code>java.io.Closeable</code></dd>
839 <dt><strong>Specified by:</strong></dt>
840 <dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
841 <dt><span class="strong">Throws:</span></dt>
842 <dd><code><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></code></dd></dl>
843 </li>
844 </ul>
845 <a name="finalize()">
846 <!--   -->
847 </a>
848 <ul class="blockListLast">
849 <li class="blockList">
850 <h4>finalize</h4>
851 <pre>protected&nbsp;void&nbsp;finalize()
852                  throws java.lang.Throwable</pre>
853 <dl>
854 <dt><strong>Overrides:</strong></dt>
855 <dd><code>finalize</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
856 <dt><span class="strong">Throws:</span></dt>
857 <dd><code>java.lang.Throwable</code></dd></dl>
858 </li>
859 </ul>
860 </li>
861 </ul>
862 </li>
863 </ul>
864 </div>
865 </div>
866 <!-- ========= END OF CLASS DATA ========= -->
867 <!-- ======= START OF BOTTOM NAVBAR ====== -->
868 <div class="bottomNav"><a name="navbar_bottom">
869 <!--   -->
870 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
871 <!--   -->
872 </a>
873 <ul class="navList" title="Navigation">
874 <li><a href="../../../org/libjpegturbo/turbojpeg/package-summary.html">Package</a></li>
875 <li class="navBarCell1Rev">Class</li>
876 <li><a href="package-tree.html">Tree</a></li>
877 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
878 <li><a href="../../../index-all.html">Index</a></li>
879 <li><a href="../../../help-doc.html">Help</a></li>
880 </ul>
881 </div>
882 <div class="subNav">
883 <ul class="navList">
884 <li><a href="../../../org/libjpegturbo/turbojpeg/TJ.html" title="class in org.libjpegturbo.turbojpeg"><span class="strong">Prev Class</span></a></li>
885 <li><a href="../../../org/libjpegturbo/turbojpeg/TJCustomFilter.html" title="interface in org.libjpegturbo.turbojpeg"><span class="strong">Next Class</span></a></li>
886 </ul>
887 <ul class="navList">
888 <li><a href="../../../index.html?org/libjpegturbo/turbojpeg/TJCompressor.html" target="_top">Frames</a></li>
889 <li><a href="TJCompressor.html" target="_top">No Frames</a></li>
890 </ul>
891 <ul class="navList" id="allclasses_navbar_bottom">
892 <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
893 </ul>
894 <div>
895 <script type="text/javascript"><!--
896   allClassesLink = document.getElementById("allclasses_navbar_bottom");
897   if(window==top) {
898     allClassesLink.style.display = "block";
899   }
900   else {
901     allClassesLink.style.display = "none";
902   }
903   //-->
904 </script>
905 </div>
906 <div>
907 <ul class="subNavList">
908 <li>Summary:&nbsp;</li>
909 <li>Nested&nbsp;|&nbsp;</li>
910 <li>Field&nbsp;|&nbsp;</li>
911 <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
912 <li><a href="#method_summary">Method</a></li>
913 </ul>
914 <ul class="subNavList">
915 <li>Detail:&nbsp;</li>
916 <li>Field&nbsp;|&nbsp;</li>
917 <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
918 <li><a href="#method_detail">Method</a></li>
919 </ul>
920 </div>
921 <a name="skip-navbar_bottom">
922 <!--   -->
923 </a></div>
924 <!-- ======== END OF BOTTOM NAVBAR ======= -->
925 </body>
926 </html>