Class TIFFT4Compressor

java.lang.Object

com.github.jaiimageio.plugins.tiff.TIFFCompressor

com.github.jaiimageio.impl.plugins.tiff.TIFFFaxCompressor

com.github.jaiimageio.impl.plugins.tiff.TIFFT4Compressor

public class TIFFT4Compressor
extends TIFFFaxCompressor

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	is1DMode
private boolean	isEOLAligned

Fields inherited from class TIFFFaxCompressor

bits, BLACK, byteTable, horz, horzMode, inverseFill, makeupCodes, makeupCodesBlack, makeupCodesWhite, ndex, pass, passMode, termCodes, termCodesBlack, termCodesWhite, vert, vertMode, WHITE

Fields inherited from class TIFFCompressor

compressionTagValue, compressionType, isCompressionLossless, metadata, stream, writer

Constructor Summary

Constructors

Constructor	Description
TIFFT4Compressor()

Method Summary

Modifier and Type	Method	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.
int	encodeT4(boolean is1DMode, boolean isEOLAligned, byte[] data, int lineStride, int colOffset, int width, int height, byte[] compData)	Encode a buffer of data using CCITT T.4 Compression also known as Group 3 facsimile compression.
void	setMetadata(IIOMetadata metadata)	Sets the value of the metadata field.

Methods inherited from class TIFFFaxCompressor

add1DBits, add2DBits, addEOFB, addEOL, encode1D, initBitBuf, nextState

Methods inherited from class TIFFCompressor

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

Methods inherited from class Object

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

Field Details

is1DMode

private boolean is1DMode

isEOLAligned

private boolean isEOLAligned

Constructor Details

TIFFT4Compressor

public TIFFT4Compressor()

Method Details

setMetadata

public void setMetadata(IIOMetadata metadata)

Sets the value of the metadata field.

The implementation in this class also sets local options from the T4_OPTIONS field if it exists, and if it doesn't, adds it with default values.

Overrides:

setMetadata in class TIFFFaxCompressor

Parameters:

metadata - the IIOMetadata object for the image being written.

See Also:

• TIFFCompressor.getMetadata()

encodeT4

public int encodeT4(boolean is1DMode,
 boolean isEOLAligned,
 byte[] data,
 int lineStride,
 int colOffset,
 int width,
 int height,
 byte[] compData)

Encode a buffer of data using CCITT T.4 Compression also known as Group 3 facsimile compression.

Parameters:

is1DMode - Whether to perform one-dimensional encoding.

isEOLAligned - Whether EOL bit sequences should be padded.

data - The row of data to compress.

lineStride - Byte step between the same sample in different rows.

colOffset - Bit offset within first data[rowOffset].

width - Number of bits in the row.

height - Number of rows in the buffer.

compData - The compressed data.

Returns:

The number of bytes saved in the compressed data array.

encode

public 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.