com.google.android.exoplayer.extractor

Class DefaultTrackOutput

java.lang.Object

com.google.android.exoplayer.extractor.DefaultTrackOutput

All Implemented Interfaces:

TrackOutput

public class DefaultTrackOutput
extends Object
implements TrackOutput

A TrackOutput that buffers extracted samples in a queue, and allows for consumption from that queue.

Constructor Summary

Constructors

Constructor and Description
DefaultTrackOutput(Allocator allocator)

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the queue, returning all allocations to the allocator.
boolean	configureSpliceTo(DefaultTrackOutput nextQueue) Attempts to configure a splice from this queue to the next.
void	discardUntil(long timeUs) Discards samples from the queue up to the specified time.
void	discardUpstreamSamples(int discardFromIndex) Discards samples from the write side of the queue.
void	format(MediaFormat format) Invoked when the MediaFormat of the track has been extracted from the stream.
MediaFormat	getFormat() The format most recently received by the output, or null if a format has yet to be received.
long	getLargestParsedTimestampUs() The largest timestamp of any sample received by the output, or Long.MIN_VALUE if a sample has yet to be received.
int	getReadIndex() Returns the current absolute read index.
boolean	getSample(SampleHolder holder) Removes the next sample from the head of the queue, writing it into the provided holder.
int	getWriteIndex() Returns the current absolute write index.
boolean	hasFormat() True if the output has received a format.
boolean	isEmpty() True if at least one sample can be read from the queue.
int	sampleData(DataSource dataSource, int length, boolean allowEndOfInput) Invoked to write sample data to the output.
int	sampleData(ExtractorInput input, int length, boolean allowEndOfInput) Invoked to write sample data to the output.
void	sampleData(ParsableByteArray buffer, int length) Invoked to write sample data to the output.
void	sampleMetadata(long timeUs, int flags, int size, int offset, byte[] encryptionKey) Invoked when metadata associated with a sample has been extracted from the stream.
boolean	skipToKeyframeBefore(long timeUs) Attempts to skip to the keyframe before the specified time, if it's present in the buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultTrackOutput

public DefaultTrackOutput(Allocator allocator)

Parameters:

allocator - An Allocator from which allocations for sample data can be obtained.

Method Detail

clear

public void clear()

Clears the queue, returning all allocations to the allocator.

getWriteIndex

public int getWriteIndex()

Returns the current absolute write index.

discardUpstreamSamples

public void discardUpstreamSamples(int discardFromIndex)

Discards samples from the write side of the queue.

Parameters:

discardFromIndex - The absolute index of the first sample to be discarded.

getReadIndex

public int getReadIndex()

Returns the current absolute read index.

hasFormat

public boolean hasFormat()

True if the output has received a format. False otherwise.

getFormat

public MediaFormat getFormat()

The format most recently received by the output, or null if a format has yet to be received.

getLargestParsedTimestampUs

public long getLargestParsedTimestampUs()

The largest timestamp of any sample received by the output, or Long.MIN_VALUE if a sample has yet to be received.

isEmpty

public boolean isEmpty()

True if at least one sample can be read from the queue. False otherwise.

getSample

public boolean getSample(SampleHolder holder)

Removes the next sample from the head of the queue, writing it into the provided holder.

The first sample returned is guaranteed to be a keyframe, since any non-keyframe samples queued prior to the first keyframe are discarded.

Parameters:

holder - A SampleHolder into which the sample should be read.

Returns:

True if a sample was read. False otherwise.

discardUntil

public void discardUntil(long timeUs)

Discards samples from the queue up to the specified time.

Parameters:

timeUs - The time up to which samples should be discarded, in microseconds.

skipToKeyframeBefore

public boolean skipToKeyframeBefore(long timeUs)

Attempts to skip to the keyframe before the specified time, if it's present in the buffer.

Parameters:

timeUs - The seek time.

Returns:

True if the skip was successful. False otherwise.

configureSpliceTo

public boolean configureSpliceTo(DefaultTrackOutput nextQueue)

Attempts to configure a splice from this queue to the next.

Parameters:

nextQueue - The queue being spliced to.

Returns:

Whether the splice was configured successfully.

sampleData

public int sampleData(DataSource dataSource,
                      int length,
                      boolean allowEndOfInput)
               throws IOException

Invoked to write sample data to the output.

Parameters:

dataSource - A DataSource from which to read the sample data.

length - The maximum length to read from the input.

allowEndOfInput - True if encountering the end of the input having read no data is allowed, and should result in C.RESULT_END_OF_INPUT being returned. False if it should be considered an error, causing an EOFException to be thrown.

Returns:

The number of bytes appended.

Throws:

IOException - If an error occurred reading from the input.

format

public void format(MediaFormat format)

Description copied from interface: TrackOutput

Invoked when the MediaFormat of the track has been extracted from the stream.

Specified by:

format in interface TrackOutput

Parameters:

format - The extracted MediaFormat.

sampleData

public int sampleData(ExtractorInput input,
                      int length,
                      boolean allowEndOfInput)
               throws IOException,
                      InterruptedException

Description copied from interface: TrackOutput

Invoked to write sample data to the output.

Specified by:

sampleData in interface TrackOutput

Parameters:

input - An ExtractorInput from which to read the sample data.

length - The maximum length to read from the input.

allowEndOfInput - True if encountering the end of the input having read no data is allowed, and should result in C.RESULT_END_OF_INPUT being returned. False if it should be considered an error, causing an EOFException to be thrown.

Returns:

The number of bytes appended.

Throws:

IOException - If an error occurred reading from the input.

InterruptedException - If the thread was interrupted.

sampleData

public void sampleData(ParsableByteArray buffer,
                       int length)

Description copied from interface: TrackOutput

Invoked to write sample data to the output.

Specified by:

sampleData in interface TrackOutput

Parameters:

buffer - A ParsableByteArray from which to read the sample data.

length - The number of bytes to read.

sampleMetadata

public void sampleMetadata(long timeUs,
                           int flags,
                           int size,
                           int offset,
                           byte[] encryptionKey)

Description copied from interface: TrackOutput

Invoked when metadata associated with a sample has been extracted from the stream.

The corresponding sample data will have already been passed to the output via calls to TrackOutput.sampleData(ExtractorInput, int, boolean) or TrackOutput.sampleData(ParsableByteArray, int).

Specified by:

sampleMetadata in interface TrackOutput

Parameters:

timeUs - The media timestamp associated with the sample, in microseconds.

flags - Flags associated with the sample. See SampleHolder.flags.

size - The size of the sample data, in bytes.

offset - The number of bytes that have been passed to TrackOutput.sampleData(ExtractorInput, int, boolean) or TrackOutput.sampleData(ParsableByteArray, int) since the last byte belonging to the sample whose metadata is being passed.

encryptionKey - The encryption key associated with the sample. May be null.