loci.formats.in
Class LegacyQTReader

java.lang.Object
  extended by loci.formats.FormatHandler
      extended by loci.formats.FormatReader
          extended by loci.formats.in.LegacyQTReader
All Implemented Interfaces:
IFormatHandler, IFormatReader, StatusReporter

public class LegacyQTReader
extends FormatReader

LegacyQTReader is a file format reader for QuickTime movie files. To use it, QuickTime for Java must be installed. Much of this code was based on the QuickTime Movie Opener for ImageJ (available at http://rsb.info.nih.gov/ij/plugins/movie-opener.html).

Source code:
Trac, SVN


Field Summary
protected  Image image
          Image containing current frame.
protected  ReflectedUniverse r
          Reflection tool for QuickTime for Java calls.
protected  int[] times
          Time offset for each frame.
protected  LegacyQTTools tools
          Instance of LegacyQTTools to handle QuickTime for Java detection.
 
Fields inherited from class loci.formats.FormatReader
collectMetadata, core, filterMetadata, group, in, metadata, metadataStore, normalizeData, saveOriginalMetadata, series, THUMBNAIL_DIMENSION
 
Fields inherited from class loci.formats.FormatHandler
currentId, debug, debugLevel, format, statusListeners, suffixes
 
Fields inherited from interface loci.formats.IFormatReader
CAN_GROUP, CANNOT_GROUP, MUST_GROUP
 
Constructor Summary
LegacyQTReader()
          Constructs a new QT reader.
LegacyQTReader(Hashtable idMap)
          Constructs a new QT reader with the given id mappings.
 
Method Summary
 void close()
          Closes currently open file(s) and frees allocated memory.
 void close(boolean fileOnly)
          Closes the currently open file.
protected  void initFile(String id)
          Initializes the given file (parsing header information, etc.).
 boolean isThisType(byte[] block)
          Checks if the given block is a valid header for this file format.
 byte[] openBytes(int no, byte[] buf)
          Obtains the specified image from the current file into a pre-allocated byte array of (sizeX * sizeY * bytesPerPixel).
 BufferedImage openImage(int no)
          Obtains the specified image from the current file.
 
Methods inherited from class loci.formats.FormatReader
addMeta, checkBytes, fileGroupOption, get16BitLookupTable, get8BitLookupTable, getChannelDimLengths, getChannelDimLengths, getChannelDimTypes, getChannelDimTypes, getCoreMetadata, getCoreMetadata, getCurrentFile, getDimensionOrder, getDimensionOrder, getEffectiveSizeC, getEffectiveSizeC, getImageCount, getImageCount, getIndex, getIndex, getMeta, getMetadata, getMetadata, getMetadataStore, getMetadataStore, getMetadataStoreRoot, getMetadataStoreRoot, getMetadataValue, getMetadataValue, getPixelType, getPixelType, getRGBChannelCount, getRGBChannelCount, getSeries, getSeries, getSeriesCount, getSeriesCount, getSizeC, getSizeC, getSizeT, getSizeT, getSizeX, getSizeX, getSizeY, getSizeY, getSizeZ, getSizeZ, getThumbSizeX, getThumbSizeX, getThumbSizeY, getThumbSizeY, getUsedFiles, getUsedFiles, getZCTCoords, getZCTCoords, isFalseColor, isGroupFiles, isIndexed, isInterleaved, isInterleaved, isInterleaved, isInterleaved, isLittleEndian, isLittleEndian, isMetadataCollected, isMetadataComplete, isMetadataFiltered, isNormalized, isOrderCertain, isOrderCertain, isOriginalMetadataPopulated, isRGB, isRGB, isUsedFile, openBytes, openBytes, openBytes, openImage, openThumbBytes, openThumbBytes, openThumbImage, openThumbImage, setGroupFiles, setId, setMetadataCollected, setMetadataFiltered, setMetadataStore, setNormalized, setOriginalMetadataPopulated, setSeries, setSeries
 
Methods inherited from class loci.formats.FormatHandler
addStatusListener, debug, getFormat, getStatusListeners, getSuffixes, isThisType, isThisType, removeStatusListener, setDebug, setDebugLevel, setId, status, status, status, trace, trace
 
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, isThisType, setId
 
Methods inherited from interface loci.formats.StatusReporter
addStatusListener, getStatusListeners, removeStatusListener
 

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.


times

protected int[] times
Time offset for each frame.


image

protected Image image
Image containing current frame.

Constructor Detail

LegacyQTReader

public LegacyQTReader()
Constructs a new QT reader.


LegacyQTReader

public LegacyQTReader(Hashtable idMap)
Constructs a new QT reader with the given id mappings.

Method Detail

isThisType

public boolean isThisType(byte[] block)
Description copied from interface: IFormatReader
Checks if the given block is a valid header for this file format.


openBytes

public byte[] openBytes(int no,
                        byte[] buf)
                 throws FormatException,
                        IOException
Description copied from interface: IFormatReader
Obtains the specified image from the current file into a pre-allocated byte array of (sizeX * sizeY * bytesPerPixel).

Parameters:
no - the image index within the file.
buf - a pre-allocated buffer.
Returns:
the pre-allocated buffer buf for convenience.
Throws:
FormatException - if there was a problem parsing the metadata of the file.
IOException - if there was a problem reading the file.

openImage

public BufferedImage openImage(int no)
                        throws FormatException,
                               IOException
Description copied from interface: IFormatReader
Obtains the specified image from the current file.

Specified by:
openImage in interface IFormatReader
Overrides:
openImage in class FormatReader
Throws:
FormatException
IOException

close

public void close(boolean fileOnly)
           throws IOException
Description copied from interface: IFormatReader
Closes the currently open file. If the flag is set, this is all that happens; if unset, it is equivalent to calling IFormatHandler.close().

Specified by:
close in interface IFormatReader
Overrides:
close in class FormatReader
Throws:
IOException

close

public void close()
           throws IOException
Description copied from interface: IFormatHandler
Closes currently open file(s) and frees allocated memory.

Specified by:
close in interface IFormatHandler
Overrides:
close in class FormatReader
Throws:
IOException

initFile

protected void initFile(String id)
                 throws FormatException,
                        IOException
Description copied from class: FormatReader
Initializes the given file (parsing header information, etc.). Most subclasses should override this method to perform initialization operations such as parsing metadata.

Overrides:
initFile in class FormatReader
Throws:
FormatException
IOException