srcImage with the newly-created
* instance.
*
* @param srcImage see {@link #setSourceImage} for description
*
* @param x see {@link #setSourceImage} for description
*
* @param y see {@link #setSourceImage} for description
*
* @param width see {@link #setSourceImage} for description
*
* @param pitch see {@link #setSourceImage} for description
*
* @param height see {@link #setSourceImage} for description
*
* @param pixelFormat pixel format of the source image (one of
* {@link TJ TJ.PF_*})
*/
public TJCompressor(byte[] srcImage, int x, int y, int width, int pitch,
int height, int pixelFormat) throws Exception {
setSourceImage(srcImage, x, y, width, pitch, height, pixelFormat);
}
/**
* Create a TurboJPEG compressor instance and associate the uncompressed
* source image stored in srcImage with the newly-created
* instance.
*
* @param srcImage see
* {@link #setSourceImage(BufferedImage, int, int, int, int)} for description
*
* @param x see
* {@link #setSourceImage(BufferedImage, int, int, int, int)} for description
*
* @param y see
* {@link #setSourceImage(BufferedImage, int, int, int, int)} for description
*
* @param width see
* {@link #setSourceImage(BufferedImage, int, int, int, int)} for description
*
* @param height see
* {@link #setSourceImage(BufferedImage, int, int, int, int)} for description
*/
public TJCompressor(BufferedImage srcImage, int x, int y, int width,
int height) throws Exception {
setSourceImage(srcImage, x, y, width, height);
}
/**
* Associate an uncompressed source image with this compressor instance.
*
* @param srcImage image buffer containing RGB, grayscale, or CMYK pixels to
* be compressed
*
* @param x x offset (in pixels) of the region from which the JPEG image
* should be compressed, relative to the start of srcImage.
*
* @param y y offset (in pixels) of the region from which the JPEG image
* should be compressed, relative to the start of srcImage.
*
* @param width width (in pixels) of the region in the source image from
* which the JPEG image should be compressed.
*
* @param pitch bytes per line of the source image. Normally, this should be
* width * TJ.pixelSize(pixelFormat) if the source image is
* unpadded, but you can use this parameter to, for instance, specify that
* the scanlines in the source image are padded to a 4-byte boundary or to
* compress a JPEG image from a region of a larger source image. You can
* also be clever and use this parameter to skip lines, etc. Setting this
* parameter to 0 is the equivalent of setting it to width *
* TJ.pixelSize(pixelFormat).
*
* @param height height (in pixels) of the region in the source image from
* which the JPEG image should be compressed.
*
* @param pixelFormat pixel format of the source image (one of
* {@link TJ TJ.PF_*})
*/
public void setSourceImage(byte[] srcImage, int x, int y, int width,
int pitch, int height, int pixelFormat)
throws Exception {
if (handle == 0) init();
if (srcImage == null || x < 0 || y < 0 || width < 1 || height < 1 ||
pitch < 0 || pixelFormat < 0 || pixelFormat >= TJ.NUMPF)
throw new Exception("Invalid argument in setSourceImage()");
srcBuf = srcImage;
srcWidth = width;
if (pitch == 0)
srcPitch = width * TJ.getPixelSize(pixelFormat);
else
srcPitch = pitch;
srcHeight = height;
srcPixelFormat = pixelFormat;
srcX = x;
srcY = y;
srcBufInt = null;
srcIsYUV = false;
}
/**
* @deprecated Use
* {@link #setSourceImage(byte[], int, int, int, int, int, int)} instead.
*/
@Deprecated
public void setSourceImage(byte[] srcImage, int width, int pitch,
int height, int pixelFormat) throws Exception {
setSourceImage(srcImage, 0, 0, width, pitch, height, pixelFormat);
srcX = srcY = -1;
}
/**
* Associate an uncompressed source image with this compressor instance.
*
* @param srcImage a BufferedImage instance containing RGB or
* grayscale pixels to be compressed
*
* @param x x offset (in pixels) of the region in the source image from which
* the JPEG image should be compressed
*
* @param y y offset (in pixels) of the region in the source image from which
* the JPEG image should be compressed
*
* @param width width (in pixels) of the region in the source image from
* which the JPEG image should be compressed (0 = compress the whole image)
*
* @param height height (in pixels) of the region in the source image from
* which the JPEG image should be compressed (0 = compress the whole image)
*/
public void setSourceImage(BufferedImage srcImage, int x, int y, int width,
int height) throws Exception {
if (handle == 0) init();
if (srcImage == null || x < 0 || y < 0 || width < 0 || height < 0)
throw new Exception("Invalid argument in setSourceImage()");
srcX = x;
srcY = y;
srcWidth = (width == 0) ? srcImage.getWidth(): width;
srcHeight = (height == 0) ? srcImage.getHeight() : height;
if (x + width > srcImage.getWidth() || y + height > srcImage.getHeight())
throw new Exception("Compression region exceeds the bounds of the source image");
int pixelFormat;
boolean intPixels = false;
if (byteOrder == null)
byteOrder = ByteOrder.nativeOrder();
switch(srcImage.getType()) {
case BufferedImage.TYPE_3BYTE_BGR:
pixelFormat = TJ.PF_BGR; break;
case BufferedImage.TYPE_4BYTE_ABGR:
case BufferedImage.TYPE_4BYTE_ABGR_PRE:
pixelFormat = TJ.PF_XBGR; break;
case BufferedImage.TYPE_BYTE_GRAY:
pixelFormat = TJ.PF_GRAY; break;
case BufferedImage.TYPE_INT_BGR:
if (byteOrder == ByteOrder.BIG_ENDIAN)
pixelFormat = TJ.PF_XBGR;
else
pixelFormat = TJ.PF_RGBX;
intPixels = true; break;
case BufferedImage.TYPE_INT_RGB:
case BufferedImage.TYPE_INT_ARGB:
case BufferedImage.TYPE_INT_ARGB_PRE:
if (byteOrder == ByteOrder.BIG_ENDIAN)
pixelFormat = TJ.PF_XRGB;
else
pixelFormat = TJ.PF_BGRX;
intPixels = true; break;
default:
throw new Exception("Unsupported BufferedImage format");
}
srcPixelFormat = pixelFormat;
WritableRaster wr = srcImage.getRaster();
if (intPixels) {
SinglePixelPackedSampleModel sm =
(SinglePixelPackedSampleModel)srcImage.getSampleModel();
srcStride = sm.getScanlineStride();
DataBufferInt db = (DataBufferInt)wr.getDataBuffer();
srcBufInt = db.getData();
srcBuf = null;
} else {
ComponentSampleModel sm =
(ComponentSampleModel)srcImage.getSampleModel();
int pixelSize = sm.getPixelStride();
if (pixelSize != TJ.getPixelSize(pixelFormat))
throw new Exception("Inconsistency between pixel format and pixel size in BufferedImage");
srcPitch = sm.getScanlineStride();
DataBufferByte db = (DataBufferByte)wr.getDataBuffer();
srcBuf = db.getData();
srcBufInt = null;
}
}
/**
* Associate an uncompressed YUV planar source image with this compressor
* instance.
*
* @param srcImage image buffer containing a YUV planar image to be
* compressed. The Y, U (Cb), and V (Cr) image planes should be stored
* sequentially in the buffer, and the size of each plane is determined by
* the specified width, height, and padding, as well as the level of
* chrominance subsampling (specified using {@link #setSubsamp}.) If the
* chrominance components are subsampled along the horizontal dimension, then
* the width of the luminance plane should be padded to the nearest multiple
* of 2 (same goes for the height of the luminance plane, if the chrominance
* components are subsampled along the vertical dimension.) This is
* irrespective of any additional padding specified in the pad
* parameter.
*
* @param width width (in pixels) of the source image
*
* @param pad the line padding used in the source image. For instance, if
* each line in each plane of the YUV image is padded to the nearest multiple
* of 4 bytes, then pad should be set to 4.
*
* @param height height (in pixels) of the source image
*/
public void setSourceImageYUV(byte[] srcImage, int width, int pad,
int height) throws Exception {
if (handle == 0) init();
if (srcImage == null || width < 1 || pad < 1 || height < 1)
throw new Exception("Invalid argument in setSourceImageYUV()");
srcBuf = srcImage;
srcWidth = width;
srcYUVPad = pad;
srcHeight = height;
srcIsYUV = true;
}
/**
* Set the level of chrominance subsampling for subsequent compress/encode
* operations. When pixels are converted from RGB to YCbCr (see
* {@link TJ#CS_YCbCr}) or from CMYK to YCCK (see {@link TJ#CS_YCCK}) as part
* of the JPEG compression process, some of the Cb and Cr (chrominance)
* components can be discarded or averaged together to produce a smaller
* image with little perceptible loss of image clarity (the human eye is more
* sensitive to small changes in brightness than to small changes in color.)
* This is called "chrominance subsampling".
* * NOTE: When compressing a YUV planar image into a JPEG image, this method * also specifies the level of chrominance subsampling used in the source * image. * * @param newSubsamp the new level of chrominance subsampling (one of * {@link TJ TJ.SAMP_*}) */ public void setSubsamp(int newSubsamp) throws Exception { if (newSubsamp < 0 || newSubsamp >= TJ.NUMSAMP) throw new Exception("Invalid argument in setSubsamp()"); subsamp = newSubsamp; } /** * Set the JPEG image quality level for subsequent compress operations. * * @param quality the new JPEG image quality level (1 to 100, 1 = worst, * 100 = best) */ public void setJPEGQuality(int quality) throws Exception { if (quality < 1 || quality > 100) throw new Exception("Invalid argument in setJPEGQuality()"); jpegQuality = quality; } /** * Compress the uncompressed source image associated with this compressor * instance and output a JPEG image to the given destination buffer. * * @param dstBuf buffer that will receive the JPEG image. Use * {@link TJ#bufSize} to determine the maximum size for this buffer based on * the image width, height, and level of chrominance subsampling. * * @param flags the bitwise OR of one or more of {@link TJ TJ.FLAG_*} */ public void compress(byte[] dstBuf, int flags) throws Exception { if (dstBuf == null || flags < 0) throw new Exception("Invalid argument in compress()"); if (srcBuf == null && (srcBufInt == null || srcIsYUV)) throw new Exception(NO_ASSOC_ERROR); if (jpegQuality < 0) throw new Exception("JPEG Quality not set"); if (subsamp < 0) throw new Exception("Subsampling level not set"); if (srcIsYUV) compressedSize = compressFromYUV(srcBuf, srcWidth, srcYUVPad, srcHeight, subsamp, dstBuf, jpegQuality, flags); else if (srcBuf != null) { if (srcX >= 0 && srcY >= 0) compressedSize = compress(srcBuf, srcX, srcY, srcWidth, srcPitch, srcHeight, srcPixelFormat, dstBuf, subsamp, jpegQuality, flags); else compressedSize = compress(srcBuf, srcWidth, srcPitch, srcHeight, srcPixelFormat, dstBuf, subsamp, jpegQuality, flags); } else if (srcBufInt != null) { if (srcX >= 0 && srcY >= 0) compressedSize = compress(srcBufInt, srcX, srcY, srcWidth, srcStride, srcHeight, srcPixelFormat, dstBuf, subsamp, jpegQuality, flags); else compressedSize = compress(srcBufInt, srcWidth, srcStride, srcHeight, srcPixelFormat, dstBuf, subsamp, jpegQuality, flags); } } /** * Compress the uncompressed source image associated with this compressor * instance and return a buffer containing a JPEG image. * * @param flags the bitwise OR of one or more of {@link TJ TJ.FLAG_*} * * @return a buffer containing a JPEG image. The length of this buffer will * not be equal to the size of the JPEG image. Use {@link * #getCompressedSize} to obtain the size of the JPEG image. */ public byte[] compress(int flags) throws Exception { if (srcWidth < 1 || srcHeight < 1) throw new Exception(NO_ASSOC_ERROR); byte[] buf = new byte[TJ.bufSize(srcWidth, srcHeight, subsamp)]; compress(buf, flags); return buf; } /** * @deprecated Use * {@link #setSourceImage(BufferedImage, int, int, int, int)} and * {@link #compress(byte[], int)} instead. */ @Deprecated public void compress(BufferedImage srcImage, byte[] dstBuf, int flags) throws Exception { setSourceImage(srcImage, 0, 0, 0, 0); compress(dstBuf, flags); } /** * @deprecated Use * {@link #setSourceImage(BufferedImage, int, int, int, int)} and * {@link #compress(int)} instead. */ @Deprecated public byte[] compress(BufferedImage srcImage, int flags) throws Exception { setSourceImage(srcImage, 0, 0, 0, 0); return compress(flags); } /** * Set the plane padding for subsequent YUV encode operations. * * @param pad the width of each line in each plane of the YUV image will be * padded to the nearest multiple of this number of bytes (must be a * power of 2.) The default padding is 4 bytes, which generates * images suitable for direct video display. */ public void setYUVPad(int pad) throws Exception { if(pad < 1 || ((pad & (pad - 1)) != 0)) throw new Exception("Invalid argument in setYUVPad()"); yuvPad = pad; } /** * Encode the uncompressed source image associated with this compressor * instance and output a YUV planar image to the given destination buffer. * This method uses the accelerated color conversion routines in TurboJPEG's * underlying codec but does not execute any of the other steps in the JPEG * compression process. The Y, U (Cb), and V (Cr) image planes are stored * sequentially into the destination buffer, and the size of each plane is * determined by the width and height of the source image, as well as the * specified padding and level of chrominance subsampling. If the * chrominance components are subsampled along the horizontal dimension, then * the width 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.) *
* NOTE: Technically, the JPEG format uses the YCbCr colorspace, but per the * convention of the digital video community, the TurboJPEG API uses "YUV" to * refer to an image format consisting of Y, Cb, and Cr image planes. * * @param dstBuf buffer that will receive the YUV planar image. Use * {@link TJ#bufSizeYUV} to determine the appropriate size for this buffer * based on the image width, height, and level of chrominance subsampling. * * @param flags the bitwise OR of one or more of {@link TJ TJ.FLAG_*} */ public void encodeYUV(byte[] dstBuf, int flags) throws Exception { if (dstBuf == null || flags < 0) throw new Exception("Invalid argument in compress()"); if (srcBuf == null && srcBufInt == null) throw new Exception(NO_ASSOC_ERROR); if (srcIsYUV) throw new Exception("Source image is not correct type"); if (subsamp < 0) throw new Exception("Subsampling level not set"); if (srcBufInt != null) { encodeYUV(srcBufInt, srcWidth, srcStride, srcHeight, srcPixelFormat, dstBuf, yuvPad, subsamp, flags); } else { encodeYUV(srcBuf, srcWidth, srcPitch, srcHeight, srcPixelFormat, dstBuf, yuvPad, subsamp, flags); } compressedSize = TJ.bufSizeYUV(srcWidth, yuvPad, srcHeight, subsamp); } /** * Encode the uncompressed source image associated with this compressor * instance and return a buffer containing a YUV planar image. See * {@link #encodeYUV(byte[], int)} for more detail. * * @param flags the bitwise OR of one or more of {@link TJ TJ.FLAG_*} * * @return a buffer containing a YUV planar image */ public byte[] encodeYUV(int flags) throws Exception { if (srcWidth < 1 || srcHeight < 1) throw new Exception(NO_ASSOC_ERROR); if (subsamp < 0) throw new Exception("Subsampling level not set"); byte[] buf = new byte[TJ.bufSizeYUV(srcWidth, yuvPad, srcHeight, subsamp)]; encodeYUV(buf, flags); return buf; } /** * @deprecated Use * {@link #setSourceImage(BufferedImage, int, int, int, int)} and * {@link #encodeYUV(byte[], int)} instead. */ @Deprecated public void encodeYUV(BufferedImage srcImage, byte[] dstBuf, int flags) throws Exception { setSourceImage(srcImage, 0, 0, 0, 0); encodeYUV(dstBuf, flags); } /** * @deprecated Use * {@link #setSourceImage(BufferedImage, int, int, int, int)} and * {@link #encodeYUV(int)} instead. */ @Deprecated public byte[] encodeYUV(BufferedImage srcImage, int flags) throws Exception { setSourceImage(srcImage, 0, 0, 0, 0); return encodeYUV(flags); } /** * Returns the size of the image (in bytes) generated by the most recent * compress/encode operation. * * @return the size of the image (in bytes) generated by the most recent * compress/encode operation */ public int getCompressedSize() { return compressedSize; } /** * Free the native structures associated with this compressor instance. */ public void close() throws Exception { destroy(); } protected void finalize() throws Throwable { try { close(); } catch(Exception e) { } finally { super.finalize(); } }; private native void init() throws Exception; private native void destroy() throws Exception; // JPEG size in bytes is returned private native int compress(byte[] srcBuf, int width, int pitch, int height, int pixelFormat, byte[] dstBuf, int jpegSubsamp, int jpegQual, int flags) throws Exception; // deprecated private native int compress(byte[] srcBuf, int x, int y, int width, int pitch, int height, int pixelFormat, byte[] dstBuf, int jpegSubsamp, int jpegQual, int flags) throws Exception; private native int compress(int[] srcBuf, int width, int stride, int height, int pixelFormat, byte[] dstBuf, int jpegSubsamp, int jpegQual, int flags) throws Exception; // deprecated private native int compress(int[] srcBuf, int x, int y, int width, int stride, int height, int pixelFormat, byte[] dstBuf, int jpegSubsamp, int jpegQual, int flags) throws Exception; private native int compressFromYUV(byte[] srcBuf, int width, int pad, int height, int subsamp, byte[] dstBuf, int jpegQual, int flags) throws Exception; private native void encodeYUV(byte[] srcBuf, int width, int pitch, int height, int pixelFormat, byte[] dstBuf, int subsamp, int flags) throws Exception; // deprecated private native void encodeYUV(byte[] srcBuf, int width, int pitch, int height, int pixelFormat, byte[] dstBuf, int pad, int subsamp, int flags) throws Exception; private native void encodeYUV(int[] srcBuf, int width, int stride, int height, int pixelFormat, byte[] dstBuf, int subsamp, int flags) throws Exception; // deprecated private native void encodeYUV(int[] srcBuf, int width, int pitch, int height, int pixelFormat, byte[] dstBuf, int pad, int subsamp, int flags) throws Exception; static { TJLoader.load(); } private long handle = 0; private byte[] srcBuf = null; private int[] srcBufInt = null; private int srcWidth = 0; private int srcHeight = 0; private int srcX = -1; private int srcY = -1; private int srcPitch = 0; private int srcStride = 0; private int srcPixelFormat = -1; private int srcYUVPad = -1; private boolean srcIsYUV; private int subsamp = -1; private int jpegQuality = -1; private int compressedSize = 0; private int yuvPad = 4; private ByteOrder byteOrder = null; };