loci.formats.out

Class LegacyQTWriter

java.lang.Object

loci.formats.FormatHandler

loci.formats.FormatWriter

loci.formats.out.LegacyQTWriter

All Implemented Interfaces:

Closeable, AutoCloseable, IFormatHandler, IFormatWriter

public class LegacyQTWriter
extends FormatWriter

LegacyQTWriter is a file format writer for QuickTime movies. It uses the QuickTime for Java library, and allows the user to choose between a variety of common video codecs. Much of this code was based on the QuickTime Movie Writer for ImageJ (available at http://rsb.info.nih.gov/ij/plugins/movie-writer.html).

Source code:

Trac, Gitweb

Field Summary

Fields

Modifier and Type	Field and Description
protected int	codec The codec to use.
protected int	quality The quality to use.
protected ReflectedUniverse	r Reflection tool for QuickTime for Java calls.
protected LegacyQTTools	tools Instance of LegacyQTTools to handle QuickTime for Java detection.

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, suffixes

Constructor Summary

Constructors

Constructor and Description
LegacyQTWriter()

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()
Class<?>	getNativeDataType() Returns the native data type of image planes for this reader, as returned by IFormatReader.openPlane(int, int, int, int, int) or IFormatWriter.savePlane(int, java.lang.Object).
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	savePlane(int no, Object plane, int x, int y, int w, int h) Saves the given image plane to the current series in the current file.
void	setCodec(int codec) Sets the encoded movie's codec.
void	setQuality(int quality) Sets the quality of the encoded movie.

Methods inherited from class loci.formats.FormatWriter

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

Methods inherited from class loci.formats.FormatHandler

checkSuffix, checkSuffix, getFormat, getSuffixes, isThisType

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, getSuffixes, isThisType

Field Detail

tools

protected LegacyQTTools tools

Instance of LegacyQTTools to handle QuickTime for Java detection.

r

protected ReflectedUniverse r

Reflection tool for QuickTime for Java calls.

codec

protected int codec

The codec to use.

quality

protected int quality

The quality to use.

Constructor Detail

LegacyQTWriter

public LegacyQTWriter()

Method Detail

setCodec

public void setCodec(int codec)

Sets the encoded movie's codec.

Parameters:

codec - Codec value:

• QTWriter.CODEC_CINEPAK
• QTWriter.CODEC_ANIMATION
• QTWriter.CODEC_H_263
• QTWriter.CODEC_SORENSON
• QTWriter.CODEC_SORENSON_3
• QTWriter.CODEC_MPEG_4
• QTWriter.CODEC_RAW

setQuality

public void setQuality(int quality)

Sets the quality of the encoded movie.

Parameters:

quality - Quality value:

• QTWriter.QUALITY_LOW
• QTWriter.QUALITY_MEDIUM
• QTWriter.QUALITY_HIGH
• QTWriter.QUALITY_MAXIMUM

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)

savePlane

public void savePlane(int no,
             Object plane,
             int x,
             int y,
             int w,
             int h)
               throws FormatException,
                      IOException

Description copied from interface: IFormatWriter

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

Specified by:

savePlane in interface IFormatWriter

Overrides:

savePlane in class FormatWriter

Parameters:

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

plane - the image plane.

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.savePlane(int, Object, 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

getNativeDataType

public Class<?> getNativeDataType()

Description copied from interface: IFormatHandler

Returns the native data type of image planes for this reader, as returned by IFormatReader.openPlane(int, int, int, int, int) or IFormatWriter.savePlane(int, java.lang.Object). For most readers this type will be a byte array; however, some readers call external APIs that work with other types such as BufferedImage.

Specified by:

getNativeDataType in interface IFormatHandler

Overrides:

getNativeDataType in class FormatHandler

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