Class TIFFImageWriter

java.lang.Object

javax.imageio.ImageWriter

com.github.jaiimageio.impl.plugins.tiff.TIFFImageWriter

All Implemented Interfaces:

ImageTranscoder

public class TIFFImageWriter
extends ImageWriter

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	bitDepth
(package private) char[]	bitsPerSample
(package private) ByteOrder	byteOrder
(package private) TIFFColorConverter	colorConverter
(package private) int	compression
static final int[]	compressionNumbers	Compression tag values for known compression types.
static final String[]	compressionTypes	Known TIFF compression types.
(package private) TIFFCompressor	compressor
private static final boolean	DEBUG
static final int	DEFAULT_BYTES_PER_STRIP
(package private) static final String	EXIF_JPEG_COMPRESSION_TYPE
(package private) long	headerPosition
(package private) RenderedImage	image
(package private) TIFFImageMetadata	imageMetadata
(package private) ImageTypeSpecifier	imageType
private boolean	inReplacePixelsNest
(package private) boolean	isBilevel
static final boolean[]	isCompressionLossless	Lossless flag for known compression types.
(package private) boolean	isImageSimple
private boolean	isInsertingEmpty
(package private) boolean	isInverted
(package private) boolean	isRescaling
(package private) boolean	isTiled
private boolean	isWritingEmpty
(package private) boolean	isWritingSequence
(package private) int	nativePhotometricInterpretation
(package private) long	nextIFDPointerPos
(package private) long	nextSpace
(package private) int	numBands
(package private) ImageWriteParam	param
(package private) int	periodX
(package private) int	periodY
(package private) int	photometricInterpretation
(package private) int	pixelsDone
(package private) int	predictor
private TIFFImageReader	reader
private long[]	replacePixelsByteCounts
private long	replacePixelsByteCountsPosition
private int	replacePixelsIndex
private Object	replacePixelsLock
private TIFFImageMetadata	replacePixelsMetadata
private long	replacePixelsOffsetsPosition
private Rectangle	replacePixelsRegion
private long[]	replacePixelsTileOffsets
(package private) int	sampleFormat
(package private) int[]	sampleSize
(package private) byte[][]	scale
(package private) byte[]	scale0
(package private) byte[][]	scaleh
(package private) byte[][]	scalel
(package private) int	scalingBitDepth
(package private) int[]	sourceBands
(package private) int	sourceHeight
(package private) int	sourceWidth
(package private) int	sourceXOffset
(package private) int	sourceYOffset
(package private) ImageOutputStream	stream
(package private) TIFFStreamMetadata	streamMetadata
static final String[]	TIFFCompressionTypes	Supported TIFF compression types.
(package private) int	tileLength
(package private) int	tilesAcross
(package private) int	tilesDown
(package private) int	tileWidth
(package private) int	totalPixels

Fields inherited from class ImageWriter

availableLocales, locale, originatingProvider, output, progressListeners, warningListeners, warningLocales

Constructor Summary

Constructors

Constructor	Description
TIFFImageWriter(ImageWriterSpi originatingProvider)

Method Summary

Modifier and Type	Method	Description
boolean	canInsertEmpty(int imageIndex)
boolean	canInsertImage(int imageIndex)
boolean	canReplacePixels(int imageIndex)
boolean	canWriteEmpty()
boolean	canWriteSequence()
private void	checkParamsEmpty(ImageTypeSpecifier imageType, int width, int height, List thumbnails)
IIOMetadata	convertImageMetadata(IIOMetadata inData, ImageTypeSpecifier imageType, ImageWriteParam param)
private TIFFImageMetadata	convertNativeImageMetadata(IIOMetadata inData)	Converts a native com_sun_media_imageio_plugins_tiff_image_1.0 tree to a TIFFImageMetadata object.
private TIFFImageMetadata	convertStandardImageMetadata(IIOMetadata inData)	Converts a standard javax_imageio_1.0 tree to a TIFFImageMetadata object.
IIOMetadata	convertStreamMetadata(IIOMetadata inData, ImageWriteParam param)
void	dispose()
void	endInsertEmpty()
void	endReplacePixels()
void	endWriteEmpty()
void	endWriteSequence()
private boolean	equals(int[] s0, int[] s1)
IIOMetadata	getDefaultImageMetadata(ImageTypeSpecifier imageType, ImageWriteParam param)
IIOMetadata	getDefaultStreamMetadata(ImageWriteParam param)
ImageWriteParam	getDefaultWriteParam()
private void	initializeScaleTables(int[] sampleSize)
private void	insert(int imageIndex, IIOImage image, ImageWriteParam param, boolean writeData)
private boolean	isEncodingEmpty()
private void	locateIFD(int imageIndex, long[] ifdpos, long[] ifd)
void	prepareInsertEmpty(int imageIndex, ImageTypeSpecifier imageType, int width, int height, IIOMetadata imageMetadata, List thumbnails, ImageWriteParam param)
void	prepareReplacePixels(int imageIndex, Rectangle region)
void	prepareWriteEmpty(IIOMetadata streamMetadata, ImageTypeSpecifier imageType, int width, int height, IIOMetadata imageMetadata, List thumbnails, ImageWriteParam param)
void	prepareWriteSequence(IIOMetadata streamMetadata)
private TIFFIFD	readIFD(int imageIndex)
void	replacePixels(Raster raster, ImageWriteParam param)
void	replacePixels(RenderedImage image, ImageWriteParam param)
void	reset()
void	setOutput(Object output)
(package private) void	setupMetadata(ColorModel cm, SampleModel sm, int destWidth, int destHeight)	Sets up the output metadata adding, removing, and overriding fields as needed.
private Raster	subsample(Raster raster, int[] sourceBands, int subOriginX, int subOriginY, int subPeriodX, int subPeriodY, int dstOffsetX, int dstOffsetY, Rectangle target)
void	write(IIOMetadata sm, IIOImage iioimage, ImageWriteParam p)
private void	write(IIOMetadata sm, IIOImage iioimage, ImageWriteParam p, boolean writeHeader, boolean writeData)
private void	writeHeader()
void	writeInsert(int imageIndex, IIOImage image, ImageWriteParam param)
private int	writeTile(Rectangle tileRect, TIFFCompressor compressor)
void	writeToSequence(IIOImage image, ImageWriteParam param)
static int	XToTileX(int x, int tileGridXOffset, int tileWidth)	Converts a pixel's X coordinate into a horizontal tile index relative to a given tile grid layout specified by its X offset and tile width.
static int	YToTileY(int y, int tileGridYOffset, int tileHeight)	Converts a pixel's Y coordinate into a vertical tile index relative to a given tile grid layout specified by its Y offset and tile height.

Methods inherited from class ImageWriter

abort, abortRequested, addIIOWriteProgressListener, addIIOWriteWarningListener, canRemoveImage, canReplaceImageMetadata, canReplaceStreamMetadata, canWriteRasters, clearAbortRequest, getAvailableLocales, getLocale, getNumThumbnailsSupported, getOriginatingProvider, getOutput, getPreferredThumbnailSizes, processImageComplete, processImageProgress, processImageStarted, processThumbnailComplete, processThumbnailProgress, processThumbnailStarted, processWarningOccurred, processWarningOccurred, processWriteAborted, removeAllIIOWriteProgressListeners, removeAllIIOWriteWarningListeners, removeIIOWriteProgressListener, removeIIOWriteWarningListener, removeImage, replaceImageMetadata, replaceStreamMetadata, setLocale, write, write

Methods inherited from class Object

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

Field Details

DEBUG

private static final boolean DEBUG

See Also:

• Constant Field Values

EXIF_JPEG_COMPRESSION_TYPE

static final String EXIF_JPEG_COMPRESSION_TYPE

See Also:

• Constant Field Values

DEFAULT_BYTES_PER_STRIP

public static final int DEFAULT_BYTES_PER_STRIP

See Also:

• Constant Field Values

TIFFCompressionTypes

public static final String[] TIFFCompressionTypes

Supported TIFF compression types.

compressionTypes

public static final String[] compressionTypes

Known TIFF compression types.

isCompressionLossless

public static final boolean[] isCompressionLossless

Lossless flag for known compression types.

compressionNumbers

public static final int[] compressionNumbers

Compression tag values for known compression types.

stream

ImageOutputStream stream

headerPosition

long headerPosition

image

RenderedImage image

imageType

ImageTypeSpecifier imageType

byteOrder

ByteOrder byteOrder

param

ImageWriteParam param

compressor

TIFFCompressor compressor

colorConverter

TIFFColorConverter colorConverter

streamMetadata

TIFFStreamMetadata streamMetadata

imageMetadata

TIFFImageMetadata imageMetadata

sourceXOffset

int sourceXOffset

sourceYOffset

int sourceYOffset

sourceWidth

int sourceWidth

sourceHeight

int sourceHeight

sourceBands

int[] sourceBands

periodX

int periodX

periodY

int periodY

bitDepth

int bitDepth

numBands

int numBands

tileWidth

int tileWidth

tileLength

int tileLength

tilesAcross

int tilesAcross

tilesDown

int tilesDown

sampleSize

int[] sampleSize

scalingBitDepth

int scalingBitDepth

isRescaling

boolean isRescaling

isBilevel

boolean isBilevel

isImageSimple

boolean isImageSimple

isInverted

boolean isInverted

isTiled

boolean isTiled

nativePhotometricInterpretation

int nativePhotometricInterpretation

photometricInterpretation

int photometricInterpretation

bitsPerSample

char[] bitsPerSample

sampleFormat

int sampleFormat

scale

byte[][] scale

scale0

byte[] scale0

scaleh

byte[][] scaleh

scalel

byte[][] scalel

compression

int compression

predictor

int predictor

totalPixels

int totalPixels

pixelsDone

int pixelsDone

nextIFDPointerPos

long nextIFDPointerPos

nextSpace

long nextSpace

isWritingSequence

boolean isWritingSequence

isInsertingEmpty

private boolean isInsertingEmpty

isWritingEmpty

private boolean isWritingEmpty

replacePixelsLock

private Object replacePixelsLock

replacePixelsIndex

private int replacePixelsIndex

replacePixelsMetadata

private TIFFImageMetadata replacePixelsMetadata

replacePixelsTileOffsets

private long[] replacePixelsTileOffsets

replacePixelsByteCounts

private long[] replacePixelsByteCounts

replacePixelsOffsetsPosition

private long replacePixelsOffsetsPosition

replacePixelsByteCountsPosition

private long replacePixelsByteCountsPosition

replacePixelsRegion

private Rectangle replacePixelsRegion

inReplacePixelsNest

private boolean inReplacePixelsNest

reader

private TIFFImageReader reader

Constructor Details

TIFFImageWriter

public TIFFImageWriter(ImageWriterSpi originatingProvider)

Method Details

XToTileX

public static int XToTileX(int x,
 int tileGridXOffset,
 int tileWidth)

Converts a pixel's X coordinate into a horizontal tile index relative to a given tile grid layout specified by its X offset and tile width.

If tileWidth invalid input: '<' 0, the results of this method are undefined. If tileWidth == 0, an ArithmeticException will be thrown.

Throws:

ArithmeticException - If tileWidth == 0.

YToTileY

public static int YToTileY(int y,
 int tileGridYOffset,
 int tileHeight)

Converts a pixel's Y coordinate into a vertical tile index relative to a given tile grid layout specified by its Y offset and tile height.

If tileHeight invalid input: '<' 0, the results of this method are undefined. If tileHeight == 0, an ArithmeticException will be thrown.

Throws:

ArithmeticException - If tileHeight == 0.

getDefaultWriteParam

public ImageWriteParam getDefaultWriteParam()

Overrides:

getDefaultWriteParam in class ImageWriter

setOutput

public void setOutput(Object output)

Overrides:

setOutput in class ImageWriter

getDefaultStreamMetadata

public IIOMetadata getDefaultStreamMetadata(ImageWriteParam param)

Specified by:

getDefaultStreamMetadata in class ImageWriter

getDefaultImageMetadata

public IIOMetadata getDefaultImageMetadata(ImageTypeSpecifier imageType,
 ImageWriteParam param)

Specified by:

getDefaultImageMetadata in class ImageWriter

convertStreamMetadata

public IIOMetadata convertStreamMetadata(IIOMetadata inData,
 ImageWriteParam param)

Specified by:

convertStreamMetadata in interface ImageTranscoder

Specified by:

convertStreamMetadata in class ImageWriter

convertImageMetadata

public IIOMetadata convertImageMetadata(IIOMetadata inData,
 ImageTypeSpecifier imageType,
 ImageWriteParam param)

Specified by:

convertImageMetadata in interface ImageTranscoder

Specified by:

convertImageMetadata in class ImageWriter

convertStandardImageMetadata

private TIFFImageMetadata convertStandardImageMetadata(IIOMetadata inData)
                                                throws IIOInvalidTreeException

Converts a standard javax_imageio_1.0 tree to a TIFFImageMetadata object.

Parameters:

inData - The metadata object.

Returns:

a TIFFImageMetadata or null if the standard tree derived from the input object is null.

Throws:

IllegalArgumentException - if inData is null or does not support the standard metadata format.

IIOInvalidTreeException - if inData generates an invalid standard metadata tree.

convertNativeImageMetadata

private TIFFImageMetadata convertNativeImageMetadata(IIOMetadata inData)
                                              throws IIOInvalidTreeException

Converts a native com_sun_media_imageio_plugins_tiff_image_1.0 tree to a TIFFImageMetadata object.

Parameters:

inData - The metadata object.

Returns:

a TIFFImageMetadata or null if the native tree derived from the input object is null.

Throws:

IllegalArgumentException - if inData is null or does not support the native metadata format.

IIOInvalidTreeException - if inData generates an invalid native metadata tree.

setupMetadata

void setupMetadata(ColorModel cm,
 SampleModel sm,
 int destWidth,
 int destHeight)
            throws IIOException

Sets up the output metadata adding, removing, and overriding fields as needed. The destination image dimensions are provided as parameters because these might differ from those of the source due to subsampling.

Parameters:

cm - The ColorModel of the image being written.

sm - The SampleModel of the image being written.

destWidth - The width of the written image after subsampling.

destHeight - The height of the written image after subsampling.

Throws:

IIOException

writeTile

private int writeTile(Rectangle tileRect,
 TIFFCompressor compressor)
               throws IOException

Parameters:

tileRect - The area to be written which might be outside the image.

Throws:

IOException

equals

private boolean equals(int[] s0,
 int[] s1)

initializeScaleTables

private void initializeScaleTables(int[] sampleSize)

write

public void write(IIOMetadata sm,
 IIOImage iioimage,
 ImageWriteParam p)
           throws IOException

Specified by:

write in class ImageWriter

Throws:

IOException

writeHeader

private void writeHeader()
                  throws IOException

Throws:

IOException

write

private void write(IIOMetadata sm,
 IIOImage iioimage,
 ImageWriteParam p,
 boolean writeHeader,
 boolean writeData)
            throws IOException

Throws:

IOException

canWriteSequence

public boolean canWriteSequence()

Overrides:

canWriteSequence in class ImageWriter

prepareWriteSequence

public void prepareWriteSequence(IIOMetadata streamMetadata)
                          throws IOException

Overrides:

prepareWriteSequence in class ImageWriter

Throws:

IOException

writeToSequence

public void writeToSequence(IIOImage image,
 ImageWriteParam param)
                     throws IOException

Overrides:

writeToSequence in class ImageWriter

Throws:

IOException

endWriteSequence

public void endWriteSequence()
                      throws IOException

Overrides:

endWriteSequence in class ImageWriter

Throws:

IOException

canInsertImage

public boolean canInsertImage(int imageIndex)
                       throws IOException

Overrides:

canInsertImage in class ImageWriter

Throws:

IOException

locateIFD

private void locateIFD(int imageIndex,
 long[] ifdpos,
 long[] ifd)
                throws IOException

Throws:

IOException

writeInsert

public void writeInsert(int imageIndex,
 IIOImage image,
 ImageWriteParam param)
                 throws IOException

Overrides:

writeInsert in class ImageWriter

Throws:

IOException

insert

private void insert(int imageIndex,
 IIOImage image,
 ImageWriteParam param,
 boolean writeData)
             throws IOException

Throws:

IOException

isEncodingEmpty

private boolean isEncodingEmpty()

canInsertEmpty

public boolean canInsertEmpty(int imageIndex)
                       throws IOException

Overrides:

canInsertEmpty in class ImageWriter

Throws:

IOException

canWriteEmpty

public boolean canWriteEmpty()
                      throws IOException

Overrides:

canWriteEmpty in class ImageWriter

Throws:

IOException

checkParamsEmpty

private void checkParamsEmpty(ImageTypeSpecifier imageType,
 int width,
 int height,
 List thumbnails)

prepareInsertEmpty

public void prepareInsertEmpty(int imageIndex,
 ImageTypeSpecifier imageType,
 int width,
 int height,
 IIOMetadata imageMetadata,
 List thumbnails,
 ImageWriteParam param)
                        throws IOException

Overrides:

prepareInsertEmpty in class ImageWriter

Throws:

IOException

prepareWriteEmpty

public void prepareWriteEmpty(IIOMetadata streamMetadata,
 ImageTypeSpecifier imageType,
 int width,
 int height,
 IIOMetadata imageMetadata,
 List thumbnails,
 ImageWriteParam param)
                       throws IOException

Overrides:

prepareWriteEmpty in class ImageWriter

Throws:

IOException

endInsertEmpty

public void endInsertEmpty()
                    throws IOException

Overrides:

endInsertEmpty in class ImageWriter

Throws:

IOException

endWriteEmpty

public void endWriteEmpty()
                   throws IOException

Overrides:

endWriteEmpty in class ImageWriter

Throws:

IOException

readIFD

private TIFFIFD readIFD(int imageIndex)
                 throws IOException

Throws:

IOException

canReplacePixels

public boolean canReplacePixels(int imageIndex)
                         throws IOException

Overrides:

canReplacePixels in class ImageWriter

Throws:

IOException

prepareReplacePixels

public void prepareReplacePixels(int imageIndex,
 Rectangle region)
                          throws IOException

Overrides:

prepareReplacePixels in class ImageWriter

Throws:

IOException

subsample

private Raster subsample(Raster raster,
 int[] sourceBands,
 int subOriginX,
 int subOriginY,
 int subPeriodX,
 int subPeriodY,
 int dstOffsetX,
 int dstOffsetY,
 Rectangle target)

replacePixels

public void replacePixels(RenderedImage image,
 ImageWriteParam param)
                   throws IOException

Overrides:

replacePixels in class ImageWriter

Throws:

IOException

replacePixels

public void replacePixels(Raster raster,
 ImageWriteParam param)
                   throws IOException

Overrides:

replacePixels in class ImageWriter

Throws:

IOException

endReplacePixels

public void endReplacePixels()
                      throws IOException

Overrides:

endReplacePixels in class ImageWriter

Throws:

IOException

reset

public void reset()

Overrides:

reset in class ImageWriter

dispose

public void dispose()

Overrides:

dispose in class ImageWriter