Class TIFFBaseJPEGCompressor
java.lang.Object
com.github.jaiimageio.plugins.tiff.TIFFCompressor
com.github.jaiimageio.impl.plugins.tiff.TIFFBaseJPEGCompressor
- Direct Known Subclasses:
TIFFEXIFJPEGCompressor
,TIFFJPEGCompressor
Base class for all possible forms of JPEG compression in TIFF.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
AByteArrayOutputStream
which allows writing to anImageOutputStream
. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final boolean
protected static final String
private IIOMetadata
protected JPEGImageWriteParam
ImageWriteParam for JPEG writer.protected IIOMetadata
Stream metadata equivalent to a tables-only stream such as in theJPEGTables
.protected ImageWriter
The JPEG writer.private ImageWriteParam
protected static final String
private boolean
protected boolean
Whether to write abbreviated JPEG streams (default == false).Fields inherited from class com.github.jaiimageio.plugins.tiff.TIFFCompressor
compressionTagValue, compressionType, isCompressionLossless, metadata, stream, writer
-
Constructor Summary
ConstructorsConstructorDescriptionTIFFBaseJPEGCompressor
(String compressionType, int compressionTagValue, boolean isCompressionLossless, ImageWriteParam param) -
Method Summary
Modifier and TypeMethodDescriptionfinal int
encode
(byte[] b, int off, int width, int height, int[] bitsPerSample, int scanlineStride) Encodes the supplied image data, writing to the currently setImageOutputStream
.protected void
finalize()
private static List
getAllNodes
(IIOMetadataNode root, List nodes) private IIOMetadata
getImageMetadata
(boolean pruneTables) Retrieves image metadata with non-core nodes removed.protected void
initJPEGWriter
(boolean supportsStreamMetadata, boolean supportsImageMetadata) Initializes the JPEGWriter and JPEGParam instance variables.private static void
pruneNodes
(Node tree, boolean pruneTables) Removes nonessential nodes from a JPEG native image metadata tree.Methods inherited from class com.github.jaiimageio.plugins.tiff.TIFFCompressor
dispose, getCompressionTagValue, getCompressionType, getMetadata, getStream, getWriter, isCompressionLossless, setMetadata, setStream, setWriter
-
Field Details
-
DEBUG
private static final boolean DEBUG- See Also:
-
STREAM_METADATA_NAME
- See Also:
-
IMAGE_METADATA_NAME
- See Also:
-
param
-
JPEGParam
ImageWriteParam for JPEG writer. May be initialized byinitJPEGWriter(boolean, boolean)
. -
JPEGWriter
The JPEG writer. May be initialized byinitJPEGWriter(boolean, boolean)
. -
writeAbbreviatedStream
protected boolean writeAbbreviatedStreamWhether to write abbreviated JPEG streams (default == false). A subclass which sets this totrue
should also initializedJPEGStreamMetadata
. -
JPEGStreamMetadata
Stream metadata equivalent to a tables-only stream such as in theJPEGTables
. Default value isnull
. This should be set by any subclass which setswriteAbbreviatedStream
totrue
. -
JPEGImageMetadata
-
usingCodecLib
private boolean usingCodecLib -
baos
-
-
Constructor Details
-
TIFFBaseJPEGCompressor
public TIFFBaseJPEGCompressor(String compressionType, int compressionTagValue, boolean isCompressionLossless, ImageWriteParam param)
-
-
Method Details
-
pruneNodes
Removes nonessential nodes from a JPEG native image metadata tree. All nodes derived from JPEG marker segments other than DHT, DQT, SOF, SOS segments are removed unlesspruneTables
istrue
in which case the nodes derived from the DHT and DQT marker segments are also removed.- Parameters:
tree
- A javax_imageio_jpeg_image_1.0 tree.pruneTables
- Whether to prune Huffman and quantization tables.- Throws:
IllegalArgumentException
- iftree
isnull
or is not the root of a JPEG native image metadata tree.
-
getAllNodes
-
initJPEGWriter
protected void initJPEGWriter(boolean supportsStreamMetadata, boolean supportsImageMetadata) Initializes the JPEGWriter and JPEGParam instance variables. This method must be called before encode() is invoked.- Parameters:
supportsStreamMetadata
- Whether the JPEG writer must support JPEG native stream metadata, i.e., be capable of writing abbreviated streams.supportsImageMetadata
- Whether the JPEG writer must support JPEG native image metadata.
-
getImageMetadata
Retrieves image metadata with non-core nodes removed.- Throws:
IIOException
-
encode
public final int encode(byte[] b, int off, int width, int height, int[] bitsPerSample, int scanlineStride) throws IOException Description copied from class:TIFFCompressor
Encodes the supplied image data, writing to the currently setImageOutputStream
.- Specified by:
encode
in classTIFFCompressor
- Parameters:
b
- an array ofbyte
s containing the packed but uncompressed image data.off
- the starting offset of the data to be written in the arrayb
.width
- the width of the rectangle of pixels to be written.height
- the height of the rectangle of pixels to be written.bitsPerSample
- an array ofint
s indicting the number of bits used to represent each image sample within a pixel.scanlineStride
- the number of bytes separating each row of the input data.- Returns:
- the number of bytes written.
- Throws:
IOException
- if the supplied data cannot be encoded by thisTIFFCompressor
, or if any I/O error occurs during writing.
-
finalize
-