com.google.android.exoplayer

Class SampleSourceTrackRenderer

java.lang.Object

com.google.android.exoplayer.TrackRenderer

com.google.android.exoplayer.SampleSourceTrackRenderer

All Implemented Interfaces:

ExoPlayer.ExoPlayerComponent

Direct Known Subclasses:

Eia608TrackRenderer, MediaCodecTrackRenderer, MetadataTrackRenderer, TextTrackRenderer

public abstract class SampleSourceTrackRenderer
extends TrackRenderer

Base class for TrackRenderer implementations that render samples obtained from a SampleSource.

Field Summary

Fields inherited from class com.google.android.exoplayer.TrackRenderer

END_OF_TRACK_US, MATCH_LONGEST_US, STATE_ENABLED, STATE_PREPARED, STATE_RELEASED, STATE_STARTED, STATE_UNPREPARED, UNKNOWN_TIME_US

Constructor Summary

Constructors

Constructor and Description
SampleSourceTrackRenderer(SampleSource... sources)

Method Summary

Modifier and Type	Method and Description
protected boolean	doPrepare(long positionUs) Invoked to make progress when the renderer is in the TrackRenderer.STATE_UNPREPARED state.
protected void	doSomeWork(long positionUs, long elapsedRealtimeUs) Invoked to make progress when the renderer is in the TrackRenderer.STATE_ENABLED or TrackRenderer.STATE_STARTED states.
protected abstract void	doSomeWork(long positionUs, long elapsedRealtimeUs, boolean sourceIsReady) Called by doSomeWork(long, long).
protected long	getBufferedPositionUs() Returns an estimate of the absolute position in microseconds up to which data is buffered.
protected long	getDurationUs() Returns the duration of the media being rendered.
protected MediaFormat	getFormat(int track) Returns the format of the specified track.
protected int	getTrackCount() Returns the number of tracks exposed by the renderer.
protected abstract boolean	handlesTrack(MediaFormat mediaFormat) Returns whether this renderer is capable of handling the provided track.
protected void	maybeThrowError() Throws an error that's preventing the renderer from making progress or buffering more data at this point in time.
protected void	onDisabled() Called when the renderer is disabled.
protected abstract void	onDiscontinuity(long positionUs) Invoked when a discontinuity is encountered.
protected void	onEnabled(int track, long positionUs, boolean joining) Called when the renderer is enabled.
protected void	onReleased() Called when the renderer is released.
protected int	readSource(long positionUs, MediaFormatHolder formatHolder, SampleHolder sampleHolder) Reads from the enabled upstream source.
protected void	seekTo(long positionUs) Seeks to a specified time in the track.
protected long	shiftInputPosition(long positionUs) Shifts positions passed to onEnabled(int, long, boolean), seekTo(long) and doSomeWork(long, long).

Methods inherited from class com.google.android.exoplayer.TrackRenderer

getMediaClock, getState, handleMessage, isEnded, isReady, onStarted, onStopped

Methods inherited from class java.lang.Object

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

Constructor Detail

SampleSourceTrackRenderer

public SampleSourceTrackRenderer(SampleSource... sources)

Parameters:

sources - One or more upstream sources from which the renderer can obtain samples.

Method Detail

doPrepare

protected final boolean doPrepare(long positionUs)
                           throws ExoPlaybackException

Description copied from class: TrackRenderer

Invoked to make progress when the renderer is in the TrackRenderer.STATE_UNPREPARED state. This method will be called repeatedly until true is returned.

This method should return quickly, and should not block if the renderer is currently unable to make any useful progress.

Specified by:

doPrepare in class TrackRenderer

Parameters:

positionUs - The player's current playback position.

Returns:

True if the renderer is now prepared. False otherwise.

Throws:

ExoPlaybackException - If an error occurs.

onEnabled

protected void onEnabled(int track,
                         long positionUs,
                         boolean joining)
                  throws ExoPlaybackException

Description copied from class: TrackRenderer

Called when the renderer is enabled.

The default implementation is a no-op.

Overrides:

onEnabled in class TrackRenderer

Parameters:

track - The track for which the renderer is being enabled.

positionUs - The player's current position.

joining - Whether this renderer is being enabled to join an ongoing playback.

Throws:

ExoPlaybackException - If an error occurs.

seekTo

protected void seekTo(long positionUs)
               throws ExoPlaybackException

Description copied from class: TrackRenderer

Seeks to a specified time in the track.

This method may be called when the renderer is in the following states: TrackRenderer.STATE_ENABLED

Specified by:

seekTo in class TrackRenderer

Parameters:

positionUs - The desired playback position in microseconds.

Throws:

ExoPlaybackException - If an error occurs.

doSomeWork

protected final void doSomeWork(long positionUs,
                                long elapsedRealtimeUs)
                         throws ExoPlaybackException

Description copied from class: TrackRenderer

Invoked to make progress when the renderer is in the TrackRenderer.STATE_ENABLED or TrackRenderer.STATE_STARTED states.

If the renderer's state is TrackRenderer.STATE_STARTED, then repeated calls to this method should cause the media track to be rendered. If the state is TrackRenderer.STATE_ENABLED, then repeated calls should make progress towards getting the renderer into a position where it is ready to render the track.

This method should return quickly, and should not block if the renderer is currently unable to make any useful progress.

This method may be called when the renderer is in the following states: TrackRenderer.STATE_ENABLED, TrackRenderer.STATE_STARTED

Specified by:

doSomeWork in class TrackRenderer

Parameters:

positionUs - The current media time in microseconds, measured at the start of the current iteration of the rendering loop.

elapsedRealtimeUs - SystemClock.elapsedRealtime() in microseconds, measured at the start of the current iteration of the rendering loop.

Throws:

ExoPlaybackException - If an error occurs.

getBufferedPositionUs

protected long getBufferedPositionUs()

Description copied from class: TrackRenderer

Returns an estimate of the absolute position in microseconds up to which data is buffered.

This method may be called when the renderer is in the following states: TrackRenderer.STATE_ENABLED, TrackRenderer.STATE_STARTED

Specified by:

getBufferedPositionUs in class TrackRenderer

Returns:

An estimate of the absolute position in microseconds up to which data is buffered, or TrackRenderer.END_OF_TRACK_US if the track is fully buffered, or TrackRenderer.UNKNOWN_TIME_US if no estimate is available.

getDurationUs

protected long getDurationUs()

Description copied from class: TrackRenderer

Returns the duration of the media being rendered.

This method may be called when the renderer is in the following states: TrackRenderer.STATE_PREPARED, TrackRenderer.STATE_ENABLED, TrackRenderer.STATE_STARTED

Specified by:

getDurationUs in class TrackRenderer

Returns:

The duration of the track in microseconds, or TrackRenderer.MATCH_LONGEST_US if the track's duration should match that of the longest track whose duration is known, or or TrackRenderer.UNKNOWN_TIME_US if the duration is not known.

maybeThrowError

protected void maybeThrowError()
                        throws ExoPlaybackException

Description copied from class: TrackRenderer

Throws an error that's preventing the renderer from making progress or buffering more data at this point in time.

Specified by:

maybeThrowError in class TrackRenderer

Throws:

ExoPlaybackException - An error that's preventing the renderer from making progress or buffering more data.

onDisabled

protected void onDisabled()
                   throws ExoPlaybackException

Description copied from class: TrackRenderer

Called when the renderer is disabled.

The default implementation is a no-op.

Overrides:

onDisabled in class TrackRenderer

Throws:

ExoPlaybackException - If an error occurs.

onReleased

protected void onReleased()
                   throws ExoPlaybackException

Description copied from class: TrackRenderer

Called when the renderer is released.

The default implementation is a no-op.

Overrides:

onReleased in class TrackRenderer

Throws:

ExoPlaybackException - If an error occurs.

getTrackCount

protected final int getTrackCount()

Description copied from class: TrackRenderer

Returns the number of tracks exposed by the renderer.

This method may be called when the renderer is in the following states: TrackRenderer.STATE_PREPARED, TrackRenderer.STATE_ENABLED, TrackRenderer.STATE_STARTED

Specified by:

getTrackCount in class TrackRenderer

Returns:

The number of tracks.

getFormat

protected final MediaFormat getFormat(int track)

Description copied from class: TrackRenderer

Returns the format of the specified track.

This method may be called when the renderer is in the following states: TrackRenderer.STATE_PREPARED, TrackRenderer.STATE_ENABLED, TrackRenderer.STATE_STARTED

Specified by:

getFormat in class TrackRenderer

Parameters:

track - The track index.

Returns:

The format of the specified track.

shiftInputPosition

protected long shiftInputPosition(long positionUs)

Shifts positions passed to onEnabled(int, long, boolean), seekTo(long) and doSomeWork(long, long).

The default implementation does not modify the position. Except in very specific cases, subclasses should not override this method.

Parameters:

positionUs - The position in microseconds.

Returns:

The adjusted position in microseconds.

readSource

protected final int readSource(long positionUs,
                               MediaFormatHolder formatHolder,
                               SampleHolder sampleHolder)

Reads from the enabled upstream source.

Parameters:

positionUs - The current playback position.

formatHolder - A MediaFormatHolder object to populate in the case of a new format.

sampleHolder - A SampleHolder object to populate in the case of a new sample. If the caller requires the sample data then it must ensure that SampleHolder.data references a valid output buffer.

Returns:

The result, which can be SampleSource.SAMPLE_READ, SampleSource.FORMAT_READ, SampleSource.NOTHING_READ or SampleSource.END_OF_STREAM.

handlesTrack

protected abstract boolean handlesTrack(MediaFormat mediaFormat)
                                 throws MediaCodecUtil.DecoderQueryException

Returns whether this renderer is capable of handling the provided track.

Parameters:

mediaFormat - The format of the track.

Returns:

True if the renderer can handle the track, false otherwise.

Throws:

MediaCodecUtil.DecoderQueryException - Thrown if there was an error querying decoders.

onDiscontinuity

protected abstract void onDiscontinuity(long positionUs)
                                 throws ExoPlaybackException

Invoked when a discontinuity is encountered. Also invoked when the renderer is enabled, for convenience.

Parameters:

positionUs - The playback position after the discontinuity, or the position at which the renderer is being enabled.

Throws:

ExoPlaybackException - If an error occurs handling the discontinuity.

doSomeWork

protected abstract void doSomeWork(long positionUs,
                                   long elapsedRealtimeUs,
                                   boolean sourceIsReady)
                            throws ExoPlaybackException

Called by doSomeWork(long, long).

Parameters:

positionUs - The current media time in microseconds, measured at the start of the current iteration of the rendering loop.

elapsedRealtimeUs - SystemClock.elapsedRealtime() in microseconds, measured at the start of the current iteration of the rendering loop.

sourceIsReady - The result of the most recent call to SampleSource.SampleSourceReader.continueBuffering(int, long).

Throws:

ExoPlaybackException - If an error occurs.

ExoPlaybackException