diff options
| author | dcommander <dcommander@632fc199-4ca6-4c93-a231-07263d6284db> | 2013-04-27 01:08:55 +0000 |
|---|---|---|
| committer | dcommander <dcommander@632fc199-4ca6-4c93-a231-07263d6284db> | 2013-04-27 01:08:55 +0000 |
| commit | 78fe405d7155374d6e4c3c83027b5d4ccc47dafe (patch) | |
| tree | 9bdaf0fefa8cb72b0863f2c4a24bd41f7b730771 /java/doc/org | |
| parent | 090f60a06197da0b07d02dde162fc1272e4aff83 (diff) | |
Java doc tweaks
git-svn-id: svn://svn.code.sf.net/p/libjpeg-turbo/code/trunk@967 632fc199-4ca6-4c93-a231-07263d6284db
Diffstat (limited to 'java/doc/org')
10 files changed, 110 insertions, 123 deletions
diff --git a/java/doc/org/libjpegturbo/turbojpeg/TJ.html b/java/doc/org/libjpegturbo/turbojpeg/TJ.html index 30b8265..2a11b78 100644 --- a/java/doc/org/libjpegturbo/turbojpeg/TJ.html +++ b/java/doc/org/libjpegturbo/turbojpeg/TJ.html @@ -2,12 +2,12 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_35) on Sun Sep 23 19:56:07 CDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_43) on Fri Apr 26 20:05:33 CDT 2013 --> <TITLE> TJ </TITLE> -<META NAME="date" CONTENT="2012-09-23"> +<META NAME="date" CONTENT="2013-04-26"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> @@ -146,8 +146,9 @@ TurboJPEG utility class (cannot be instantiated) <TD><CODE><B><A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html#FLAG_FASTUPSAMPLE">FLAG_FASTUPSAMPLE</A></B></CODE> <BR> - When decompressing, use the fastest chrominance upsampling algorithm - available in the underlying codec.</TD> + When decompressing an image that was compressed using chrominance + subsampling, use the fastest chrominance upsampling algorithm available in + the underlying codec.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> @@ -364,8 +365,7 @@ TurboJPEG utility class (cannot be instantiated) <BR> Returns the maximum size of the buffer (in bytes) required to hold a JPEG - image with the given width and height, and level of chrominance - subsampling.</TD> + image with the given width, height, and level of chrominance subsampling.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> @@ -420,7 +420,7 @@ TurboJPEG utility class (cannot be instantiated) <TD><CODE><B><A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html#getPixelSize(int)">getPixelSize</A></B>(int pixelFormat)</CODE> <BR> - Returns the pixel size (in bytes) of the given pixel format.</TD> + Returns the pixel size (in bytes) for the given pixel format.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> @@ -779,11 +779,11 @@ FLAG_FASTUPSAMPLE</H3> <PRE> public static final int <B>FLAG_FASTUPSAMPLE</B></PRE> <DL> -<DD>When decompressing, use the fastest chrominance upsampling algorithm - available in the underlying codec. The default is to use smooth - upsampling, which creates a smooth transition between neighboring - chrominance components in order to reduce upsampling artifacts in the - decompressed image. +<DD>When decompressing an image that was compressed using chrominance + subsampling, use the fastest chrominance upsampling algorithm available in + the underlying codec. The default is to use smooth upsampling, which + creates a smooth transition between neighboring chrominance components in + order to reduce upsampling artifacts in the decompressed image. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.FLAG_FASTUPSAMPLE">Constant Field Values</A></DL> @@ -896,11 +896,11 @@ getPixelSize</H3> public static int <B>getPixelSize</B>(int pixelFormat) throws java.lang.Exception</PRE> <DL> -<DD>Returns the pixel size (in bytes) of the given pixel format. +<DD>Returns the pixel size (in bytes) for the given pixel format. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>pixelFormat</CODE> - the pixel format (one of <code>PF_*</code>) -<DT><B>Returns:</B><DD>the pixel size (in bytes) of the given pixel format +<DT><B>Returns:</B><DD>the pixel size (in bytes) for the given pixel format <DT><B>Throws:</B> <DD><CODE>java.lang.Exception</CODE></DL> </DD> @@ -979,15 +979,13 @@ public static int <B>bufSize</B>(int width, throws java.lang.Exception</PRE> <DL> <DD>Returns the maximum size of the buffer (in bytes) required to hold a JPEG - image with the given width and height, and level of chrominance - subsampling. + image with the given width, height, and level of chrominance subsampling. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>width</CODE> - the width (in pixels) of the JPEG image<DD><CODE>height</CODE> - the height (in pixels) of the JPEG image<DD><CODE>jpegSubsamp</CODE> - the level of chrominance subsampling to be used when generating the JPEG image (one of <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html" title="class in org.libjpegturbo.turbojpeg"><CODE>TJ.SAMP_*</CODE></A>) <DT><B>Returns:</B><DD>the maximum size of the buffer (in bytes) required to hold a JPEG - image with the given width and height, and level of chrominance - subsampling + image with the given width, height, and level of chrominance subsampling <DT><B>Throws:</B> <DD><CODE>java.lang.Exception</CODE></DL> </DD> diff --git a/java/doc/org/libjpegturbo/turbojpeg/TJCompressor.html b/java/doc/org/libjpegturbo/turbojpeg/TJCompressor.html index d5d08ed..871d9bc 100644 --- a/java/doc/org/libjpegturbo/turbojpeg/TJCompressor.html +++ b/java/doc/org/libjpegturbo/turbojpeg/TJCompressor.html @@ -2,12 +2,12 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_35) on Sun Sep 23 19:56:07 CDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_43) on Fri Apr 26 20:05:34 CDT 2013 --> <TITLE> TJCompressor </TITLE> -<META NAME="date" CONTENT="2012-09-23"> +<META NAME="date" CONTENT="2013-04-26"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> @@ -280,7 +280,8 @@ TurboJPEG compressor int pixelFormat)</CODE> <BR> - Associate an uncompressed source image with this compressor instance.</TD> + <B>Deprecated.</B> <I>Use + <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> instead.</I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> @@ -358,7 +359,8 @@ public <B>TJCompressor</B>(byte[] srcImage, instance. <P> <DL> -<DT><B>Parameters:</B><DD><CODE>srcImage</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description<DD><CODE>width</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description<DD><CODE>pitch</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description<DD><CODE>height</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description<DD><CODE>pixelFormat</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description +<DT><B>Parameters:</B><DD><CODE>srcImage</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description<DD><CODE>width</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description<DD><CODE>pitch</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description<DD><CODE>height</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description<DD><CODE>pixelFormat</CODE> - pixel format of the source image (one of + <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html" title="class in org.libjpegturbo.turbojpeg"><CODE>TJ.PF_*</CODE></A>) <DT><B>Throws:</B> <DD><CODE>java.lang.Exception</CODE></DL> </DL> @@ -381,7 +383,8 @@ public <B>TJCompressor</B>(byte[] srcImage, instance. <P> <DL> -<DT><B>Parameters:</B><DD><CODE>srcImage</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description<DD><CODE>x</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description<DD><CODE>y</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description<DD><CODE>width</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description<DD><CODE>pitch</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description<DD><CODE>height</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description<DD><CODE>pixelFormat</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description +<DT><B>Parameters:</B><DD><CODE>srcImage</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description<DD><CODE>x</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description<DD><CODE>y</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description<DD><CODE>width</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description<DD><CODE>pitch</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description<DD><CODE>height</CODE> - see <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for description<DD><CODE>pixelFormat</CODE> - pixel format of the source image (one of + <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html" title="class in org.libjpegturbo.turbojpeg"><CODE>TJ.PF_*</CODE></A>) <DT><B>Throws:</B> <DD><CODE>java.lang.Exception</CODE></DL> </DL> @@ -441,19 +444,11 @@ public void <B>setSourceImage</B>(byte[] srcImage, int pixelFormat) throws java.lang.Exception</PRE> <DL> -<DD>Associate an uncompressed source image with this compressor instance. +<DD><B>Deprecated.</B> <I>Use + <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> instead.</I> <P> <DD><DL> -<DT><B>Parameters:</B><DD><CODE>srcImage</CODE> - see - <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for - description<DD><CODE>width</CODE> - see - <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for - description<DD><CODE>pitch</CODE> - see - <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for - description<DD><CODE>height</CODE> - see - <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#setSourceImage(byte[], int, int, int, int, int, int)"><CODE>setSourceImage(byte[], int, int, int, int, int, int)</CODE></A> for - description<DD><CODE>pixelFormat</CODE> - pixel format of the source image (one of - <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html" title="class in org.libjpegturbo.turbojpeg"><CODE>TJ.PF_*</CODE></A>) + <DT><B>Throws:</B> <DD><CODE>java.lang.Exception</CODE></DL> </DD> @@ -508,7 +503,7 @@ public void <B>compress</B>(byte[] dstBuf, <DD><DL> <DT><B>Parameters:</B><DD><CODE>dstBuf</CODE> - buffer that will receive the JPEG image. Use <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html#bufSize(int, int, int)"><CODE>TJ.bufSize(int, int, int)</CODE></A> to determine the maximum size for this buffer based on - the image width and height.<DD><CODE>flags</CODE> - the bitwise OR of one or more of <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html" title="class in org.libjpegturbo.turbojpeg"><CODE>TJ.FLAG_*</CODE></A> + the image width, height, and level of chrominance subsampling.<DD><CODE>flags</CODE> - the bitwise OR of one or more of <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html" title="class in org.libjpegturbo.turbojpeg"><CODE>TJ.FLAG_*</CODE></A> <DT><B>Throws:</B> <DD><CODE>java.lang.Exception</CODE></DL> </DD> @@ -549,7 +544,7 @@ public void <B>compress</B>(java.awt.image.BufferedImage srcImage, <DT><B>Parameters:</B><DD><CODE>srcImage</CODE> - a <code>BufferedImage</code> instance containing RGB or grayscale pixels to be compressed<DD><CODE>dstBuf</CODE> - buffer that will receive the JPEG image. Use <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html#bufSize(int, int, int)"><CODE>TJ.bufSize(int, int, int)</CODE></A> to determine the maximum size for this buffer based on - the image width and height.<DD><CODE>flags</CODE> - the bitwise OR of one or more of <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html" title="class in org.libjpegturbo.turbojpeg"><CODE>TJ.FLAG_*</CODE></A> + the image width, height, and level of chrominance subsampling.<DD><CODE>flags</CODE> - the bitwise OR of one or more of <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html" title="class in org.libjpegturbo.turbojpeg"><CODE>TJ.FLAG_*</CODE></A> <DT><B>Throws:</B> <DD><CODE>java.lang.Exception</CODE></DL> </DD> @@ -590,13 +585,13 @@ public void <B>encodeYUV</B>(byte[] dstBuf, TurboJPEG's underlying codec to produce a planar YUV image that is suitable for direct video display. Specifically, if the chrominance components are subsampled along the horizontal dimension, then the width - of the luminance plane is padded to 2 in the output image (same goes for - the height of the luminance plane, if the chrominance components are - subsampled along the vertical dimension.) Also, each line of each plane - in the output image is padded to 4 bytes. Although this will work with - any subsampling option, it is really only useful in combination with - <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html#SAMP_420"><CODE>TJ.SAMP_420</CODE></A>, which produces an image compatible with the I420 (AKA - "YUV420P") format. + of the luminance plane is padded to the nearest multiple of 2 in the + output image (same goes for the height of the luminance plane, if the + chrominance components are subsampled along the vertical dimension.) + Also, each line of each plane in the output image is padded to 4 bytes. + Although this will work with any subsampling option, it is really only + useful in combination with <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html#SAMP_420"><CODE>TJ.SAMP_420</CODE></A>, which produces an image + compatible with the I420 (AKA "YUV420P") format. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>dstBuf</CODE> - buffer that will receive the YUV planar image. Use diff --git a/java/doc/org/libjpegturbo/turbojpeg/TJCustomFilter.html b/java/doc/org/libjpegturbo/turbojpeg/TJCustomFilter.html index 09b8b22..c91978d 100644 --- a/java/doc/org/libjpegturbo/turbojpeg/TJCustomFilter.html +++ b/java/doc/org/libjpegturbo/turbojpeg/TJCustomFilter.html @@ -2,12 +2,12 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_35) on Sun Sep 23 19:56:07 CDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_43) on Fri Apr 26 20:05:34 CDT 2013 --> <TITLE> TJCustomFilter </TITLE> -<META NAME="date" CONTENT="2012-09-23"> +<META NAME="date" CONTENT="2013-04-26"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> @@ -167,10 +167,10 @@ void <B>customFilter</B>(java.nio.ShortBuffer coeffBuffer, into multiple DCT coefficient buffers and call the callback function once for each buffer.<DD><CODE>planeRegion</CODE> - rectangle containing the width and height of the component plane to which <code>coeffBuffer</code> belongs<DD><CODE>componentID</CODE> - ID number of the component plane to which - <code>coeffBuffer</code>belongs (Y, Cb, and Cr have, respectively, ID's of + <code>coeffBuffer</code> belongs (Y, U, and V have, respectively, ID's of 0, 1, and 2 in typical JPEG images.)<DD><CODE>transformID</CODE> - ID number of the transformed image to which <code>coeffBuffer</code> belongs. This is the same as the index of the - transform in the transforms array that was passed to <A HREF="../../../org/libjpegturbo/turbojpeg/TJTransformer.html#transform(byte[][], org.libjpegturbo.turbojpeg.TJTransform[], int)"><CODE>TJTransformer.transform()</CODE></A>.<DD><CODE>transform</CODE> - a <A HREF="../../../org/libjpegturbo/turbojpeg/TJTransform.html" title="class in org.libjpegturbo.turbojpeg"><CODE>TJTransform</CODE></A> instance that specifies the + transform in the <code>transforms</code> array that was passed to <A HREF="../../../org/libjpegturbo/turbojpeg/TJTransformer.html#transform(byte[][], org.libjpegturbo.turbojpeg.TJTransform[], int)"><CODE>TJTransformer.transform()</CODE></A>.<DD><CODE>transform</CODE> - a <A HREF="../../../org/libjpegturbo/turbojpeg/TJTransform.html" title="class in org.libjpegturbo.turbojpeg"><CODE>TJTransform</CODE></A> instance that specifies the parameters and/or cropping region for this transform <DT><B>Throws:</B> <DD><CODE>java.lang.Exception</CODE></DL> diff --git a/java/doc/org/libjpegturbo/turbojpeg/TJDecompressor.html b/java/doc/org/libjpegturbo/turbojpeg/TJDecompressor.html index 0e2fef5..d7c6495 100644 --- a/java/doc/org/libjpegturbo/turbojpeg/TJDecompressor.html +++ b/java/doc/org/libjpegturbo/turbojpeg/TJDecompressor.html @@ -2,12 +2,12 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_35) on Sun Sep 23 19:56:07 CDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_43) on Fri Apr 26 20:05:34 CDT 2013 --> <TITLE> TJDecompressor </TITLE> -<META NAME="date" CONTENT="2012-09-23"> +<META NAME="date" CONTENT="2013-04-26"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> @@ -237,8 +237,8 @@ TurboJPEG decompressor int flags)</CODE> <BR> - Decompress the JPEG source image associated with this decompressor - instance and output a decompressed image to the given destination buffer.</TD> + <B>Deprecated.</B> <I>Use + <A HREF="../../../org/libjpegturbo/turbojpeg/TJDecompressor.html#decompress(byte[], int, int, int, int, int, int, int)"><CODE>decompress(byte[], int, int, int, int, int, int, int)</CODE></A> instead.</I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> @@ -358,7 +358,7 @@ TurboJPEG decompressor int desiredHeight)</CODE> <BR> - Returns the height of the largest scaled down image that the TurboJPEG + Returns the height of the largest scaled-down image that the TurboJPEG decompressor can generate without exceeding the desired image width and height.</TD> </TR> @@ -369,7 +369,7 @@ TurboJPEG decompressor int desiredHeight)</CODE> <BR> - Returns the width of the largest scaled down image that the TurboJPEG + Returns the width of the largest scaled-down image that the TurboJPEG decompressor can generate without exceeding the desired image width and height.</TD> </TR> @@ -671,7 +671,7 @@ public int <B>getScaledWidth</B>(int desiredWidth, int desiredHeight) throws java.lang.Exception</PRE> <DL> -<DD>Returns the width of the largest scaled down image that the TurboJPEG +<DD>Returns the width of the largest scaled-down image that the TurboJPEG decompressor can generate without exceeding the desired image width and height. <P> @@ -683,7 +683,7 @@ public int <B>getScaledWidth</B>(int desiredWidth, Setting this to 0 is the same as setting it to the height of the JPEG image (in other words, the height will not be considered when determining the scaled image size.) -<DT><B>Returns:</B><DD>the width of the largest scaled down image that the TurboJPEG +<DT><B>Returns:</B><DD>the width of the largest scaled-down image that the TurboJPEG decompressor can generate without exceeding the desired image width and height <DT><B>Throws:</B> @@ -699,7 +699,7 @@ public int <B>getScaledHeight</B>(int desiredWidth, int desiredHeight) throws java.lang.Exception</PRE> <DL> -<DD>Returns the height of the largest scaled down image that the TurboJPEG +<DD>Returns the height of the largest scaled-down image that the TurboJPEG decompressor can generate without exceeding the desired image width and height. <P> @@ -711,7 +711,7 @@ public int <B>getScaledHeight</B>(int desiredWidth, Setting this to 0 is the same as setting it to the height of the JPEG image (in other words, the height will not be considered when determining the scaled image size.) -<DT><B>Returns:</B><DD>the height of the largest scaled down image that the TurboJPEG +<DT><B>Returns:</B><DD>the height of the largest scaled-down image that the TurboJPEG decompressor can generate without exceeding the desired image width and height <DT><B>Throws:</B> @@ -747,13 +747,13 @@ public void <B>decompress</B>(byte[] dstBuf, parameters can be used to specify the region into which the JPEG image should be decompressed.<DD><CODE>x</CODE> - x offset (in pixels) of the region into which the JPEG image should be decompressed, relative to the start of <code>dstBuf</code>.<DD><CODE>y</CODE> - y offset (in pixels) of the region into which the JPEG image - should be decompressed, relative to the start of <code>dstBuf</code>.<DD><CODE>desiredWidth</CODE> - desired width (in pixels) of the decompressed image. - If the desired image dimensions are smaller than the dimensions of the - JPEG image being decompressed, then TurboJPEG will use scaling in the JPEG - decompressor to generate the largest possible image that will fit within - the desired dimensions. Setting this to 0 is the same as setting it to - the width of the JPEG image (in other words, the width will not be - considered when determining the scaled image size.)<DD><CODE>pitch</CODE> - bytes per line of the destination image. Normally, this + should be decompressed, relative to the start of <code>dstBuf</code>.<DD><CODE>desiredWidth</CODE> - desired width (in pixels) of the decompressed image + (or image region.) If the desired image dimensions are different than the + dimensions of the JPEG image being decompressed, then TurboJPEG will use + scaling in the JPEG decompressor to generate the largest possible image + that will fit within the desired dimensions. Setting this to 0 is the + same as setting it to the width of the JPEG image (in other words, the + width will not be considered when determining the scaled image size.)<DD><CODE>pitch</CODE> - bytes per line of the destination image. Normally, this should be set to <code>scaledWidth * TJ.pixelSize(pixelFormat)</code> if the decompressed image is unpadded, but you can use this to, for instance, pad each line of the decompressed image to a 4-byte boundary or to @@ -762,13 +762,13 @@ public void <B>decompress</B>(byte[] dstBuf, scalingFactor.<A HREF="../../../org/libjpegturbo/turbojpeg/TJScalingFactor.html#getScaled(int)"><CODE>getScaled</CODE></A>(jpegWidth) </code> or by calling <A HREF="../../../org/libjpegturbo/turbojpeg/TJDecompressor.html#getScaledWidth(int, int)"><CODE>getScaledWidth(int, int)</CODE></A>. Setting this parameter to 0 is the equivalent of setting it to <code>scaledWidth * - TJ.pixelSize(pixelFormat)</code>.<DD><CODE>desiredHeight</CODE> - desired height (in pixels) of the decompressed image. - If the desired image dimensions are smaller than the dimensions of the - JPEG image being decompressed, then TurboJPEG will use scaling in the JPEG - decompressor to generate the largest possible image that will fit within - the desired dimensions. Setting this to 0 is the same as setting it to - the height of the JPEG image (in other words, the height will not be - considered when determining the scaled image size.)<DD><CODE>pixelFormat</CODE> - pixel format of the decompressed image (one of + TJ.pixelSize(pixelFormat)</code>.<DD><CODE>desiredHeight</CODE> - desired height (in pixels) of the decompressed image + (or image region.) If the desired image dimensions are different than the + dimensions of the JPEG image being decompressed, then TurboJPEG will use + scaling in the JPEG decompressor to generate the largest possible image + that will fit within the desired dimensions. Setting this to 0 is the + same as setting it to the height of the JPEG image (in other words, the + height will not be considered when determining the scaled image size.)<DD><CODE>pixelFormat</CODE> - pixel format of the decompressed image (one of <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html" title="class in org.libjpegturbo.turbojpeg"><CODE>TJ.PF_*</CODE></A>)<DD><CODE>flags</CODE> - the bitwise OR of one or more of <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html" title="class in org.libjpegturbo.turbojpeg"><CODE>TJ.FLAG_*</CODE></A> <DT><B>Throws:</B> <DD><CODE>java.lang.Exception</CODE></DL> @@ -787,20 +787,11 @@ public void <B>decompress</B>(byte[] dstBuf, int flags) throws java.lang.Exception</PRE> <DL> -<DD>Decompress the JPEG source image associated with this decompressor - instance and output a decompressed image to the given destination buffer. +<DD><B>Deprecated.</B> <I>Use + <A HREF="../../../org/libjpegturbo/turbojpeg/TJDecompressor.html#decompress(byte[], int, int, int, int, int, int, int)"><CODE>decompress(byte[], int, int, int, int, int, int, int)</CODE></A> instead.</I> <P> <DD><DL> -<DT><B>Parameters:</B><DD><CODE>dstBuf</CODE> - see - <A HREF="../../../org/libjpegturbo/turbojpeg/TJDecompressor.html#decompress(byte[], int, int, int, int, int, int, int)"><CODE>decompress(byte[], int, int, int, int, int, int, int)</CODE></A> - for description<DD><CODE>desiredWidth</CODE> - see - <A HREF="../../../org/libjpegturbo/turbojpeg/TJDecompressor.html#decompress(byte[], int, int, int, int, int, int, int)"><CODE>decompress(byte[], int, int, int, int, int, int, int)</CODE></A> - for description<DD><CODE>pitch</CODE> - see - <A HREF="../../../org/libjpegturbo/turbojpeg/TJDecompressor.html#decompress(byte[], int, int, int, int, int, int, int)"><CODE>decompress(byte[], int, int, int, int, int, int, int)</CODE></A> - for description<DD><CODE>desiredHeight</CODE> - see - <A HREF="../../../org/libjpegturbo/turbojpeg/TJDecompressor.html#decompress(byte[], int, int, int, int, int, int, int)"><CODE>decompress(byte[], int, int, int, int, int, int, int)</CODE></A> - for description<DD><CODE>pixelFormat</CODE> - pixel format of the decompressed image (one of - <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html" title="class in org.libjpegturbo.turbojpeg"><CODE>TJ.PF_*</CODE></A>)<DD><CODE>flags</CODE> - the bitwise OR of one or more of <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html" title="class in org.libjpegturbo.turbojpeg"><CODE>TJ.FLAG_*</CODE></A> + <DT><B>Throws:</B> <DD><CODE>java.lang.Exception</CODE></DL> </DD> @@ -847,11 +838,11 @@ public void <B>decompressToYUV</B>(byte[] dstBuf, instance and output a YUV planar image to the given destination buffer. This method performs JPEG decompression but leaves out the color conversion step, so a planar YUV image is generated instead of an RGB - image. The padding of the planes in this image is the same as the images - generated by <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#encodeYUV(byte[], int)"><CODE>TJCompressor.encodeYUV(byte[], int)</CODE></A>. Note that, if - the width or height of the image is not an even multiple of the MCU block - size (see <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html#getMCUWidth(int)"><CODE>TJ.getMCUWidth(int)</CODE></A> and <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html#getMCUHeight(int)"><CODE>TJ.getMCUHeight(int)</CODE></A>), then an - intermediate buffer copy will be performed within TurboJPEG. + image. The padding of the planes in this image is the same as in the + images generated by <A HREF="../../../org/libjpegturbo/turbojpeg/TJCompressor.html#encodeYUV(byte[], int)"><CODE>TJCompressor.encodeYUV(byte[], int)</CODE></A>. Note + that, if the width or height of the image is not an even multiple of the + MCU block size (see <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html#getMCUWidth(int)"><CODE>TJ.getMCUWidth(int)</CODE></A> and <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html#getMCUHeight(int)"><CODE>TJ.getMCUHeight(int)</CODE></A>), + then an intermediate buffer copy will be performed within TurboJPEG. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>dstBuf</CODE> - buffer that will receive the YUV planar image. Use @@ -908,25 +899,25 @@ public void <B>decompress</B>(int[] dstBuf, parameters can be used to specify the region into which the JPEG image should be decompressed.<DD><CODE>x</CODE> - x offset (in pixels) of the region into which the JPEG image should be decompressed, relative to the start of <code>dstBuf</code>.<DD><CODE>y</CODE> - y offset (in pixels) of the region into which the JPEG image - should be decompressed, relative to the start of <code>dstBuf</code>.<DD><CODE>desiredWidth</CODE> - desired width (in pixels) of the decompressed image. - If the desired image dimensions are smaller than the dimensions of the - JPEG image being decompressed, then TurboJPEG will use scaling in the JPEG - decompressor to generate the largest possible image that will fit within - the desired dimensions. Setting this to 0 is the same as setting it to - the width of the JPEG image (in other words, the width will not be - considered when determining the scaled image size.)<DD><CODE>stride</CODE> - pixels per line of the destination image. Normally, this + should be decompressed, relative to the start of <code>dstBuf</code>.<DD><CODE>desiredWidth</CODE> - desired width (in pixels) of the decompressed image + (or image region.) If the desired image dimensions are different than the + dimensions of the JPEG image being decompressed, then TurboJPEG will use + scaling in the JPEG decompressor to generate the largest possible image + that will fit within the desired dimensions. Setting this to 0 is the + same as setting it to the width of the JPEG image (in other words, the + width will not be considered when determining the scaled image size.)<DD><CODE>stride</CODE> - pixels per line of the destination image. Normally, this should be set to <code>scaledWidth</code>, but you can use this to, for instance, decompress the JPEG image into a region of a larger image. NOTE: <code>scaledWidth</code> can be determined by calling <code> scalingFactor.<A HREF="../../../org/libjpegturbo/turbojpeg/TJScalingFactor.html#getScaled(int)"><CODE>getScaled</CODE></A>(jpegWidth) </code> or by calling <A HREF="../../../org/libjpegturbo/turbojpeg/TJDecompressor.html#getScaledWidth(int, int)"><CODE>getScaledWidth(int, int)</CODE></A>. Setting this parameter to - 0 is the equivalent of setting it to <code>scaledWidth</code>.<DD><CODE>desiredHeight</CODE> - desired height (in pixels) of the decompressed image. - If the desired image dimensions are smaller than the dimensions of the - JPEG image being decompressed, then TurboJPEG will use scaling in the JPEG - decompressor to generate the largest possible image that will fit within - the desired dimensions. Setting this to 0 is the same as setting it to - the height of the JPEG image (in other words, the height will not be - considered when determining the scaled image size.)<DD><CODE>pixelFormat</CODE> - pixel format of the decompressed image (one of + 0 is the equivalent of setting it to <code>scaledWidth</code>.<DD><CODE>desiredHeight</CODE> - desired height (in pixels) of the decompressed image + (or image region.) If the desired image dimensions are different than the + dimensions of the JPEG image being decompressed, then TurboJPEG will use + scaling in the JPEG decompressor to generate the largest possible image + that will fit within the desired dimensions. Setting this to 0 is the + same as setting it to the height of the JPEG image (in other words, the + height will not be considered when determining the scaled image size.)<DD><CODE>pixelFormat</CODE> - pixel format of the decompressed image (one of <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html" title="class in org.libjpegturbo.turbojpeg"><CODE>TJ.PF_*</CODE></A>)<DD><CODE>flags</CODE> - the bitwise OR of one or more of <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html" title="class in org.libjpegturbo.turbojpeg"><CODE>TJ.FLAG_*</CODE></A> <DT><B>Throws:</B> <DD><CODE>java.lang.Exception</CODE></DL> diff --git a/java/doc/org/libjpegturbo/turbojpeg/TJScalingFactor.html b/java/doc/org/libjpegturbo/turbojpeg/TJScalingFactor.html index 418da03..9262c49 100644 --- a/java/doc/org/libjpegturbo/turbojpeg/TJScalingFactor.html +++ b/java/doc/org/libjpegturbo/turbojpeg/TJScalingFactor.html @@ -2,12 +2,12 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_35) on Sun Sep 23 19:56:07 CDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_43) on Fri Apr 26 20:05:34 CDT 2013 --> <TITLE> TJScalingFactor </TITLE> -<META NAME="date" CONTENT="2012-09-23"> +<META NAME="date" CONTENT="2013-04-26"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> diff --git a/java/doc/org/libjpegturbo/turbojpeg/TJTransform.html b/java/doc/org/libjpegturbo/turbojpeg/TJTransform.html index 820c515..5a31980 100644 --- a/java/doc/org/libjpegturbo/turbojpeg/TJTransform.html +++ b/java/doc/org/libjpegturbo/turbojpeg/TJTransform.html @@ -2,12 +2,12 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_35) on Sun Sep 23 19:56:07 CDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_43) on Fri Apr 26 20:05:34 CDT 2013 --> <TITLE> TJTransform </TITLE> -<META NAME="date" CONTENT="2012-09-23"> +<META NAME="date" CONTENT="2013-04-26"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> @@ -676,8 +676,10 @@ public <B>TJTransform</B>(int x, <DT><B>Parameters:</B><DD><CODE>x</CODE> - the left boundary of the cropping region. This must be evenly divisible by the MCU block width (see <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html#getMCUWidth(int)"><CODE>TJ.getMCUWidth(int)</CODE></A>)<DD><CODE>y</CODE> - the upper boundary of the cropping region. This must be evenly divisible by the MCU block height (see <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html#getMCUHeight(int)"><CODE>TJ.getMCUHeight(int)</CODE></A>)<DD><CODE>w</CODE> - the width of the cropping region. Setting this to 0 is the - equivalent of setting it to the width of the source JPEG image - x.<DD><CODE>h</CODE> - the height of the cropping region. Setting this to 0 is the - equivalent of setting it to the height of the source JPEG image - y.<DD><CODE>op</CODE> - one of the transform operations (<code>OP_*</code>)<DD><CODE>options</CODE> - the bitwise OR of one or more of the transform options + equivalent of setting it to (width of the source JPEG image - + <code>x</code>).<DD><CODE>h</CODE> - the height of the cropping region. Setting this to 0 is the + equivalent of setting it to (height of the source JPEG image - + <code>y</code>).<DD><CODE>op</CODE> - one of the transform operations (<code>OP_*</code>)<DD><CODE>options</CODE> - the bitwise OR of one or more of the transform options (<code>OPT_*</code>)<DD><CODE>cf</CODE> - an instance of an object that implements the <A HREF="../../../org/libjpegturbo/turbojpeg/TJCustomFilter.html" title="interface in org.libjpegturbo.turbojpeg"><CODE>TJCustomFilter</CODE></A> interface, or null if no custom filter is needed <DT><B>Throws:</B> <DD><CODE>java.lang.Exception</CODE></DL> diff --git a/java/doc/org/libjpegturbo/turbojpeg/TJTransformer.html b/java/doc/org/libjpegturbo/turbojpeg/TJTransformer.html index 154e8d1..dfef713 100644 --- a/java/doc/org/libjpegturbo/turbojpeg/TJTransformer.html +++ b/java/doc/org/libjpegturbo/turbojpeg/TJTransformer.html @@ -2,12 +2,12 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_35) on Sun Sep 23 19:56:07 CDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_43) on Fri Apr 26 20:05:34 CDT 2013 --> <TITLE> TJTransformer </TITLE> -<META NAME="date" CONTENT="2012-09-23"> +<META NAME="date" CONTENT="2013-04-26"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> @@ -303,18 +303,19 @@ public void <B>transform</B>(byte[][] dstBufs, JPEG image structure to another without altering the values of the coefficients. While this is typically faster than decompressing the image, transforming it, and re-compressing it, lossless transforms are not - free. Each lossless transform requires reading and Huffman decoding all - of the coefficients in the source image, regardless of the size of the - destination image. Thus, this method provides a means of generating - multiple transformed images from the same source or of applying multiple - transformations simultaneously, in order to eliminate the need to read the - source coefficients multiple times. + free. Each lossless transform requires reading and performing Huffman + decoding on all of the coefficients in the source image, regardless of the + size of the destination image. Thus, this method provides a means of + generating multiple transformed images from the same source or of applying + multiple transformations simultaneously, in order to eliminate the need to + read the source coefficients multiple times. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>dstBufs</CODE> - an array of image buffers. <code>dstbufs[i]</code> will receive a JPEG image that has been transformed using the parameters in <code>transforms[i]</code>. Use <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html#bufSize(int, int, int)"><CODE>TJ.bufSize(int, int, int)</CODE></A> to determine the - maximum size for each buffer based on the cropped width and height.<DD><CODE>transforms</CODE> - an array of <A HREF="../../../org/libjpegturbo/turbojpeg/TJTransform.html" title="class in org.libjpegturbo.turbojpeg"><CODE>TJTransform</CODE></A> instances, each of + maximum size for each buffer based on the transformed or cropped width and + height.<DD><CODE>transforms</CODE> - an array of <A HREF="../../../org/libjpegturbo/turbojpeg/TJTransform.html" title="class in org.libjpegturbo.turbojpeg"><CODE>TJTransform</CODE></A> instances, each of which specifies the transform parameters and/or cropping region for the corresponding transformed output image<DD><CODE>flags</CODE> - the bitwise OR of one or more of <A HREF="../../../org/libjpegturbo/turbojpeg/TJ.html" title="class in org.libjpegturbo.turbojpeg"><CODE>TJ.FLAG_*</CODE></A> <DT><B>Throws:</B> diff --git a/java/doc/org/libjpegturbo/turbojpeg/package-frame.html b/java/doc/org/libjpegturbo/turbojpeg/package-frame.html index 83c3c7e..7286078 100644 --- a/java/doc/org/libjpegturbo/turbojpeg/package-frame.html +++ b/java/doc/org/libjpegturbo/turbojpeg/package-frame.html @@ -2,12 +2,12 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_35) on Sun Sep 23 19:56:07 CDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_43) on Fri Apr 26 20:05:34 CDT 2013 --> <TITLE> org.libjpegturbo.turbojpeg </TITLE> -<META NAME="date" CONTENT="2012-09-23"> +<META NAME="date" CONTENT="2013-04-26"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> diff --git a/java/doc/org/libjpegturbo/turbojpeg/package-summary.html b/java/doc/org/libjpegturbo/turbojpeg/package-summary.html index 1cd4b40..bafbf52 100644 --- a/java/doc/org/libjpegturbo/turbojpeg/package-summary.html +++ b/java/doc/org/libjpegturbo/turbojpeg/package-summary.html @@ -2,12 +2,12 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_35) on Sun Sep 23 19:56:07 CDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_43) on Fri Apr 26 20:05:34 CDT 2013 --> <TITLE> org.libjpegturbo.turbojpeg </TITLE> -<META NAME="date" CONTENT="2012-09-23"> +<META NAME="date" CONTENT="2013-04-26"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> diff --git a/java/doc/org/libjpegturbo/turbojpeg/package-tree.html b/java/doc/org/libjpegturbo/turbojpeg/package-tree.html index fcdb173..40eb910 100644 --- a/java/doc/org/libjpegturbo/turbojpeg/package-tree.html +++ b/java/doc/org/libjpegturbo/turbojpeg/package-tree.html @@ -2,12 +2,12 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_35) on Sun Sep 23 19:56:07 CDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_43) on Fri Apr 26 20:05:34 CDT 2013 --> <TITLE> org.libjpegturbo.turbojpeg Class Hierarchy </TITLE> -<META NAME="date" CONTENT="2012-09-23"> +<META NAME="date" CONTENT="2013-04-26"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> |