com.sun.media.imageioimpl.plugins.tiff

Class TIFFBaseJPEGCompressor

java.lang.Object

com.sun.media.imageio.plugins.tiff.TIFFCompressor

com.sun.media.imageioimpl.plugins.tiff.TIFFBaseJPEGCompressor

Direct Known Subclasses:

TIFFEXIFJPEGCompressor, TIFFJPEGCompressor

public abstract class TIFFBaseJPEGCompressor
extends TIFFCompressor

Base class for all possible forms of JPEG compression in TIFF.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	TIFFBaseJPEGCompressor.IIOByteArrayOutputStream A ByteArrayOutputStream which allows writing to an ImageOutputStream.

Field Summary

Fields

Modifier and Type	Field and Description
private TIFFBaseJPEGCompressor.IIOByteArrayOutputStream	baos
private static boolean	DEBUG
protected static String	IMAGE_METADATA_NAME
private IIOMetadata	JPEGImageMetadata
protected JPEGImageWriteParam	JPEGParam ImageWriteParam for JPEG writer.
protected IIOMetadata	JPEGStreamMetadata Stream metadata equivalent to a tables-only stream such as in the JPEGTables.
protected ImageWriter	JPEGWriter The JPEG writer.
private ImageWriteParam	param
protected static String	STREAM_METADATA_NAME
private boolean	usingCodecLib
protected boolean	writeAbbreviatedStream Whether to write abbreviated JPEG streams (default == false).

Fields inherited from class com.sun.media.imageio.plugins.tiff.TIFFCompressor

compressionTagValue, compressionType, isCompressionLossless, metadata, stream, writer

Constructor Summary

Constructors

Constructor and Description
TIFFBaseJPEGCompressor(String compressionType, int compressionTagValue, boolean isCompressionLossless, ImageWriteParam param)

Method Summary

Modifier and Type	Method and Description
int	encode(byte[] b, int off, int width, int height, int[] bitsPerSample, int scanlineStride) Encodes the supplied image data, writing to the currently set ImageOutputStream.
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.sun.media.imageio.plugins.tiff.TIFFCompressor

getCompressionTagValue, getCompressionType, getMetadata, getStream, getWriter, isCompressionLossless, setMetadata, setStream, setWriter

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEBUG

private static final boolean DEBUG

See Also:

Constant Field Values

STREAM_METADATA_NAME

protected static final String STREAM_METADATA_NAME

See Also:

Constant Field Values

IMAGE_METADATA_NAME

protected static final String IMAGE_METADATA_NAME

See Also:

Constant Field Values

param

private ImageWriteParam param

JPEGParam

protected JPEGImageWriteParam JPEGParam

ImageWriteParam for JPEG writer. May be initialized by initJPEGWriter(boolean, boolean).

JPEGWriter

protected ImageWriter JPEGWriter

The JPEG writer. May be initialized by initJPEGWriter(boolean, boolean).

writeAbbreviatedStream

protected boolean writeAbbreviatedStream

Whether to write abbreviated JPEG streams (default == false). A subclass which sets this to true should also initialized JPEGStreamMetadata.

JPEGStreamMetadata

protected IIOMetadata JPEGStreamMetadata

Stream metadata equivalent to a tables-only stream such as in the JPEGTables. Default value is null. This should be set by any subclass which sets writeAbbreviatedStream to true.

JPEGImageMetadata

private IIOMetadata JPEGImageMetadata

usingCodecLib

private boolean usingCodecLib

baos

private TIFFBaseJPEGCompressor.IIOByteArrayOutputStream baos

Constructor Detail

TIFFBaseJPEGCompressor

public TIFFBaseJPEGCompressor(String compressionType,
                              int compressionTagValue,
                              boolean isCompressionLossless,
                              ImageWriteParam param)

Method Detail

pruneNodes

private static void pruneNodes(Node tree,
                               boolean pruneTables)

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 unless pruneTables is true 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 - if tree is null or is not the root of a JPEG native image metadata tree.

getAllNodes

private static List getAllNodes(IIOMetadataNode root,
                                List nodes)

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

private IIOMetadata getImageMetadata(boolean pruneTables)
                              throws IIOException

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 set ImageOutputStream.

Specified by:

encode in class TIFFCompressor

Parameters:

b - an array of bytes containing the packed but uncompressed image data.

off - the starting offset of the data to be written in the array b.

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 of ints 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 this TIFFCompressor, or if any I/O error occurs during writing.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable