org.libtiff.jai.codec
Interface XTIFFTileCodec

All Known Implementing Classes:
XTIFFFaxTileCodec, XTIFFLZWTileCodec, XTIFFPackTileCodec, XTIFFTileCodecImpl, XTIFFUncompTileCodec

public interface XTIFFTileCodec

The XTIFFTileCodec is the common interface used by all registered implementations of TIFF data compression. Unlike other file formats, TIFF has no fixed set of data compressions schemes, but allows for new and user-defined compression types.

To use a new codec with the XTIFFDirectory you must do the following things:

See Also:
XTIFFTileCodecImpl

Method Summary
 XTIFFTileCodec create(XTIFFDecodeParam param)
          Create a codec for decoding
 XTIFFTileCodec create(XTIFFEncodeParam param)
          Create a codec for encoding data.
 java.awt.image.WritableRaster decode(java.awt.image.RenderedImage im, java.awt.Rectangle rect, byte[] input)
          Decode input byte data into a new WritableRaster, using information from underlying RenderedImage
 int encode(java.awt.image.RenderedImage im, java.awt.Rectangle rect, byte[] output)
          Encode some data from RenderedImage, and return the actual number of bytes stored in output buffer.
 int getCompressedTileSize(java.awt.image.RenderedImage im)
          Return the largest possible compressed buffer size for this image in bytes.
 int getCompression()
          Return the associated TIFF compression code
 void register()
          Register this codec with the XTIFFDirectory.
 

Method Detail

create

XTIFFTileCodec create(XTIFFEncodeParam param)
                      throws java.io.IOException
Create a codec for encoding data.

Parameters:
param - the encoding parameter. It is the responsibility of the codec to initialize itself from this parameter.
Throws:
java.io.IOException

create

XTIFFTileCodec create(XTIFFDecodeParam param)
                      throws java.io.IOException
Create a codec for decoding

Parameters:
param - the decoding parameter. It is the responsibility of the codec to initialize itself from this parameter.
Throws:
java.io.IOException

encode

int encode(java.awt.image.RenderedImage im,
           java.awt.Rectangle rect,
           byte[] output)
Encode some data from RenderedImage, and return the actual number of bytes stored in output buffer.


decode

java.awt.image.WritableRaster decode(java.awt.image.RenderedImage im,
                                     java.awt.Rectangle rect,
                                     byte[] input)
Decode input byte data into a new WritableRaster, using information from underlying RenderedImage


getCompression

int getCompression()
Return the associated TIFF compression code


getCompressedTileSize

int getCompressedTileSize(java.awt.image.RenderedImage im)
Return the largest possible compressed buffer size for this image in bytes. This is used by the XTIFFImage constructor to allocate a decoding buffer.


register

void register()
Register this codec with the XTIFFDirectory. The method may register itself with multiple TIFF compression codes, if it supports more than one.

See Also:
XTIFFDirectory