loci.formats.out

Class APNGWriter

java.lang.Object

loci.formats.FormatHandler

loci.formats.FormatWriter

loci.formats.out.APNGWriter

All Implemented Interfaces:

Closeable, AutoCloseable, IFormatHandler, IFormatWriter, IMetadataConfigurable

public class APNGWriter
extends FormatWriter

APNGWriter is the file format writer for PNG and APNG files.

Field Summary

Fields

Modifier and Type	Field and Description
private long	footerPointer
private boolean	littleEndian
private int	nextSequenceNumber
private int	numFrames
private long	numFramesPointer
private static byte[]	PNG_SIG

Fields inherited from class loci.formats.FormatWriter

cm, compression, compressionTypes, fps, initialized, interleaved, metadataRetrieve, options, out, sequential, series, validBits

Fields inherited from class loci.formats.FormatHandler

COMPRESSION_SUFFIXES, currentId, format, LOGGER, metadataOptions, suffixes

Constructor Summary

Constructors

Constructor and Description
APNGWriter()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDoStacks() Reports whether the writer can save multiple images to a single file.
void	close()
private int	crc(byte[] buf)
private int	crc(byte[] buf, int off, int len)
int[]	getPixelTypes(String codec) Gets the supported pixel types for the given codec.
void	saveBytes(int no, byte[] buf, int x, int y, int w, int h) Saves the given image tile to the current series in the current file.
void	setId(String id) Initializes a writer from the input file name.
private void	writeFCTL(int width, int height)
private void	writeFooter()
private void	writePixels(String chunk, byte[] stream, int x, int y, int width, int height)
private void	writePLTE()

Methods inherited from class loci.formats.FormatWriter

changeOutputFile, checkParams, getColorModel, getCompression, getCompressionTypes, getFramesPerSecond, getMetadataRetrieve, getPixelTypes, getPlaneCount, getPlaneCount, getSamplesPerPixel, getSamplesPerPixel, getSeries, isFullPlane, isInterleaved, isSupportedType, saveBytes, saveBytes, savePlane, savePlane, savePlane, seekToPlaneOffset, setCodecOptions, setColorModel, setCompression, setFramesPerSecond, setInterleaved, setMetadataRetrieve, setSeries, setValidBitsPerPixel, setWriteSequentially

Methods inherited from class loci.formats.FormatHandler

checkSuffix, checkSuffix, getFormat, getMetadataOptions, getNativeDataType, getSuffixes, getSupportedMetadataLevels, isThisType, setMetadataOptions

Methods inherited from class java.lang.Object

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

Methods inherited from interface loci.formats.IFormatHandler

getFormat, getNativeDataType, getSuffixes, isThisType

Methods inherited from interface loci.formats.IMetadataConfigurable

getMetadataOptions, getSupportedMetadataLevels, setMetadataOptions

Field Detail

PNG_SIG

private static final byte[] PNG_SIG

numFrames

private int numFrames

numFramesPointer

private long numFramesPointer

nextSequenceNumber

private int nextSequenceNumber

littleEndian

private boolean littleEndian

footerPointer

private long footerPointer

Constructor Detail

APNGWriter

public APNGWriter()

Method Detail

saveBytes

public void saveBytes(int no,
             byte[] buf,
             int x,
             int y,
             int w,
             int h)
               throws FormatException,
                      IOException

Description copied from interface: IFormatWriter

Saves the given image tile to the current series in the current file.

Parameters:

no - the image index within the current file, starting from 0.

buf - the byte array that represents the image tile.

x - the X coordinate of the upper-left corner of the image tile.

y - the Y coordinate of the upper-left corner of the image tile.

w - the width (in pixels) of the image tile.

h - the height (in pixels) of the image tile.

Throws:

FormatException - if one of the parameters is invalid.

IOException - if there was a problem writing to the file.

See Also:

IFormatWriter.saveBytes(int, byte[], int, int, int, int)

canDoStacks

public boolean canDoStacks()

Description copied from interface: IFormatWriter

Reports whether the writer can save multiple images to a single file.

Specified by:

canDoStacks in interface IFormatWriter

Overrides:

canDoStacks in class FormatWriter

getPixelTypes

public int[] getPixelTypes(String codec)

Description copied from interface: IFormatWriter

Gets the supported pixel types for the given codec.

Specified by:

getPixelTypes in interface IFormatWriter

Overrides:

getPixelTypes in class FormatWriter

setId

public void setId(String id)
           throws FormatException,
                  IOException

Description copied from class: FormatWriter

Initializes a writer from the input file name. Initializes a RandomAccessOutputStream for the output file and initializes the metadata for all the series using FormatWriter.setSeries(int).

Specified by:

setId in interface IFormatHandler

Overrides:

setId in class FormatWriter

Parameters:

id - a String specifying the path to the file

Throws:

FormatException

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FormatWriter

Throws:

IOException

crc

private int crc(byte[] buf)

crc

private int crc(byte[] buf,
      int off,
      int len)

writeFCTL

private void writeFCTL(int width,
             int height)
                throws IOException

Throws:

IOException

writePLTE

private void writePLTE()
                throws IOException

Throws:

IOException

writePixels

private void writePixels(String chunk,
               byte[] stream,
               int x,
               int y,
               int width,
               int height)
                  throws FormatException,
                         IOException

Throws:

FormatException

IOException

writeFooter

private void writeFooter()
                  throws IOException

Throws:

IOException