org.monte.media.avi

Class AVIReader

java.lang.Object

org.monte.media.avi.AbstractAVIStream

org.monte.media.avi.AVIInputStream

org.monte.media.avi.AVIReader

All Implemented Interfaces:

MovieReader

public class AVIReader
extends AVIInputStream
implements MovieReader

Provides high-level support for decoding and reading audio and video samples from an AVI 1.0 file.

Version:

1.0 2011-08-24 Created.

Author:

Werner Randelshofer

Nested Class Summary

Nested classes/interfaces inherited from class org.monte.media.avi.AbstractAVIStream

AbstractAVIStream.AudioTrack, AbstractAVIStream.AVIMediaType, AbstractAVIStream.Chunk, AbstractAVIStream.CompositeChunk, AbstractAVIStream.DataChunk, AbstractAVIStream.FixedSizeDataChunk, AbstractAVIStream.MainHeader, AbstractAVIStream.MidiTrack, AbstractAVIStream.Sample, AbstractAVIStream.TextTrack, AbstractAVIStream.Track, AbstractAVIStream.VideoTrack

Field Summary

Fields

Modifier and Type	Field and Description
static Format	AVI

Fields inherited from class org.monte.media.avi.AVIInputStream

idx1, in, mainHeader

Fields inherited from class org.monte.media.avi.AbstractAVIStream

AVI_ID, AVIH_FLAG_COPYRIGHTED, AVIH_FLAG_HAS_INDEX, AVIH_FLAG_IS_INTERLEAVED, AVIH_FLAG_MUST_USE_INDEX, AVIH_FLAG_TRUST_CK_TYPE, AVIH_FLAG_WAS_CAPTURE_FILE, AVIH_ID, AVIX_ID, CHUNK_SUBTYPE_MASK, DB_ID, DC_ID, HDRL_ID, IDX1_ID, LIST_ID, MOVI_ID, out, PC_ID, REC_ID, RIFF_ID, STRD_ID, streamOffset, STRF_ID, STRH_FLAG_DISABLED, STRH_FLAG_VIDEO_PALETTE_CHANGES, STRH_ID, STRL_ID, STRN_ID, tracks, WB_ID

Constructor Summary

Constructors

Constructor and Description
AVIReader(File file)
AVIReader(ImageInputStream in)

Method Summary

Methods

Modifier and Type	Method and Description
int	findTrack(int fromTrack, Format format) Finds a track with the specified format.
Rational	getDuration() Returns the total duration of the movie .
Rational	getDuration(int track) Returns the duration of the specified track.
Format	getFileFormat() Returns the file format.
Format	getFormat(int track) Returns the media format of the specified track.
Rational	getReadTime(int track) Returns the current time of the track.
long	getTimeScale(int track) Returns the time scale of the specified track.
int	nextTrack() Returns the index of the next track in playback sequence.
void	read(int track, Buffer buffer) Reads a chunk of media data from the specified track.
BufferedImage	read(int track, BufferedImage img) Reads an image.
Rational	sampleToTime(int track, long sampleIndex) Returns the time for the specified sample number.
void	setMovieReadTime(Rational newValue) Sets the read time of all tracks to the closest sync sample before or at the specified time.
long	timeToSample(int track, Rational time) Returns the sample number for the specified time.

Methods inherited from class org.monte.media.avi.AVIInputStream

close, ensureRealized, getChunkCount, getExtraHeader, getExtraHeaderFourCCs, getHeaderFlags, getMicroSecPerFrame, getName, getStartTime, getTrackCount, getVideoDimension, readAllMetadata

Methods inherited from class org.monte.media.avi.AbstractAVIStream

getRelativeStreamPosition, intToType, isFlagSet, seekRelative, typeToInt

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.monte.media.MovieReader

close, getChunkCount, getTrackCount

Field Detail

AVI

public static final Format AVI

Constructor Detail

AVIReader

public AVIReader(ImageInputStream in)
          throws IOException

Throws:

IOException

AVIReader

public AVIReader(File file)
          throws IOException

Throws:

IOException

Method Detail

getFileFormat

public Format getFileFormat()
                     throws IOException

Description copied from interface: MovieReader

Returns the file format.

Specified by:

getFileFormat in interface MovieReader

Throws:

IOException

getFormat

public Format getFormat(int track)
                 throws IOException

Description copied from interface: MovieReader

Returns the media format of the specified track.

Specified by:

getFormat in interface MovieReader

Parameters:

track - Track number.

Returns:

The media format of the track.

Throws:

IOException

read

public void read(int track,
        Buffer buffer)
          throws IOException

Reads a chunk of media data from the specified track.

If the track is a video track with palette change "..PC" chunks, then the body of the palette change chunk can be found in the buffer.header.

Specified by:

read in interface MovieReader

Parameters:

track - The track number.

buffer - The buffer for the media data.

Throws:

IOException

read

public BufferedImage read(int track,
                 BufferedImage img)
                   throws IOException

Reads an image.

Parameters:

track - The track number

img - An image that can be reused if it fits the media format of the track. Pass null to create a new image on each read.

Returns:

An image or null if the end of the media has been reached.

Throws:

IOException

getReadTime

public Rational getReadTime(int track)
                     throws IOException

Description copied from interface: MovieReader

Returns the current time of the track.

Specified by:

getReadTime in interface MovieReader

Throws:

IOException

nextTrack

public int nextTrack()
              throws IOException

Description copied from interface: MovieReader

Returns the index of the next track in playback sequence.

Specified by:

nextTrack in interface MovieReader

Returns:

Index of next track or -1 if end of media reached.

Throws:

IOException

getDuration

public Rational getDuration()

Description copied from interface: MovieReader

Returns the total duration of the movie .

Specified by:

getDuration in interface MovieReader

getDuration

public Rational getDuration(int track)

Description copied from interface: MovieReader

Returns the duration of the specified track.

Specified by:

getDuration in interface MovieReader

getTimeScale

public long getTimeScale(int track)

Description copied from class: AVIInputStream

Returns the time scale of the specified track.

Overrides:

getTimeScale in class AVIInputStream

timeToSample

public long timeToSample(int track,
                Rational time)

Description copied from interface: MovieReader

Returns the sample number for the specified time.

Specified by:

timeToSample in interface MovieReader

sampleToTime

public Rational sampleToTime(int track,
                    long sampleIndex)
                      throws IOException

Description copied from interface: MovieReader

Returns the time for the specified sample number.

Specified by:

sampleToTime in interface MovieReader

Throws:

IOException

setMovieReadTime

public void setMovieReadTime(Rational newValue)
                      throws IOException

Description copied from interface: MovieReader

Sets the read time of all tracks to the closest sync sample before or at the specified time.

Specified by:

setMovieReadTime in interface MovieReader

Parameters:

newValue - Time in seconds.

Throws:

IOException

findTrack

public int findTrack(int fromTrack,
            Format format)
              throws IOException

Description copied from interface: MovieReader

Finds a track with the specified format.

Specified by:

findTrack in interface MovieReader

Parameters:

fromTrack - the start track number.

format - A format specification.

Returns:

The track number >= fromTrack or -1 if no track has been found.

Throws:

IOException