com.google.android.exoplayer

Class MediaCodecAudioTrackRenderer

java.lang.Object

com.google.android.exoplayer.TrackRenderer

com.google.android.exoplayer.SampleSourceTrackRenderer

com.google.android.exoplayer.MediaCodecTrackRenderer

com.google.android.exoplayer.MediaCodecAudioTrackRenderer

All Implemented Interfaces:

ExoPlayer.ExoPlayerComponent, MediaClock

public class MediaCodecAudioTrackRenderer
extends MediaCodecTrackRenderer
implements MediaClock

Decodes and renders audio using MediaCodec and AudioTrack.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MediaCodecAudioTrackRenderer.EventListener Interface definition for a callback to be notified of MediaCodecAudioTrackRenderer events.

Nested classes/interfaces inherited from class com.google.android.exoplayer.MediaCodecTrackRenderer

MediaCodecTrackRenderer.DecoderInitializationException

Field Summary

Fields

Modifier and Type	Field and Description
static int	MSG_SET_PLAYBACK_PARAMS A type of a message that can be passed to an instance of this class via ExoPlayer.sendMessage(com.google.android.exoplayer.ExoPlayer.ExoPlayerComponent, int, java.lang.Object) or ExoPlayer.blockingSendMessage(com.google.android.exoplayer.ExoPlayer.ExoPlayerComponent, int, java.lang.Object).
static int	MSG_SET_STREAM_TYPE A type of a message that can be passed to an instance of this class via ExoPlayer.sendMessage(com.google.android.exoplayer.ExoPlayer.ExoPlayerComponent, int, java.lang.Object) or ExoPlayer.blockingSendMessage(com.google.android.exoplayer.ExoPlayer.ExoPlayerComponent, int, java.lang.Object).
static int	MSG_SET_VOLUME A type of a message that can be passed to an instance of this class via ExoPlayer.sendMessage(com.google.android.exoplayer.ExoPlayer.ExoPlayerComponent, int, java.lang.Object) or ExoPlayer.blockingSendMessage(com.google.android.exoplayer.ExoPlayer.ExoPlayerComponent, int, java.lang.Object).

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

codecCounters, eventHandler, SOURCE_STATE_NOT_READY, SOURCE_STATE_READY, SOURCE_STATE_READY_READ_MAY_FAIL

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
MediaCodecAudioTrackRenderer(SampleSource[] sources, MediaCodecSelector mediaCodecSelector, DrmSessionManager drmSessionManager, boolean playClearSamplesWithoutKeys, Handler eventHandler, MediaCodecAudioTrackRenderer.EventListener eventListener, AudioCapabilities audioCapabilities, int streamType)
MediaCodecAudioTrackRenderer(SampleSource source, MediaCodecSelector mediaCodecSelector)
MediaCodecAudioTrackRenderer(SampleSource source, MediaCodecSelector mediaCodecSelector, DrmSessionManager drmSessionManager, boolean playClearSamplesWithoutKeys)
MediaCodecAudioTrackRenderer(SampleSource source, MediaCodecSelector mediaCodecSelector, DrmSessionManager drmSessionManager, boolean playClearSamplesWithoutKeys, Handler eventHandler, MediaCodecAudioTrackRenderer.EventListener eventListener)
MediaCodecAudioTrackRenderer(SampleSource source, MediaCodecSelector mediaCodecSelector, DrmSessionManager drmSessionManager, boolean playClearSamplesWithoutKeys, Handler eventHandler, MediaCodecAudioTrackRenderer.EventListener eventListener, AudioCapabilities audioCapabilities, int streamType)
MediaCodecAudioTrackRenderer(SampleSource source, MediaCodecSelector mediaCodecSelector, Handler eventHandler, MediaCodecAudioTrackRenderer.EventListener eventListener)

Method Summary

Modifier and Type	Method and Description
protected boolean	allowPassthrough(String mimeType) Returns whether encoded audio passthrough should be used for playing back the input format.
protected void	configureCodec(MediaCodec codec, boolean codecIsAdaptive, MediaFormat format, MediaCrypto crypto) Configures a newly created MediaCodec.
protected DecoderInfo	getDecoderInfo(MediaCodecSelector mediaCodecSelector, String mimeType, boolean requiresSecureDecoder) Returns a DecoderInfo for a given format.
protected MediaClock	getMediaClock() If the renderer advances its own playback position then this method returns a corresponding MediaClock.
long	getPositionUs()
protected void	handleAudioTrackDiscontinuity()
void	handleMessage(int messageType, Object message) Handles a message delivered to the component.
protected boolean	handlesTrack(MediaCodecSelector mediaCodecSelector, MediaFormat mediaFormat) Returns whether this renderer is capable of handling the provided track.
protected boolean	isEnded() Whether the renderer is ready for the ExoPlayer instance to transition to ExoPlayer.STATE_ENDED.
protected boolean	isReady() Whether the renderer is able to immediately render media from the current position.
protected void	onAudioSessionId(int audioSessionId) Invoked when the audio session id becomes known.
protected void	onDisabled() Called when the renderer is disabled.
protected void	onDiscontinuity(long positionUs) Invoked when a discontinuity is encountered.
protected void	onInputFormatChanged(MediaFormatHolder holder) Invoked when a new format is read from the upstream SampleSource.
protected void	onOutputFormatChanged(MediaCodec codec, MediaFormat outputFormat) Invoked when the output format of the MediaCodec changes.
protected void	onOutputStreamEnded() Invoked when the output stream ends, meaning that the last output buffer has been processed and the MediaCodec.BUFFER_FLAG_END_OF_STREAM flag has been propagated through the decoder.
protected void	onStarted() Called when the renderer is started.
protected void	onStopped() Called when the renderer is stopped.
protected boolean	processOutputBuffer(long positionUs, long elapsedRealtimeUs, MediaCodec codec, ByteBuffer buffer, MediaCodec.BufferInfo bufferInfo, int bufferIndex, boolean shouldSkip) Processes the provided output buffer.

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

canReconfigureCodec, codecInitialized, doSomeWork, flushCodec, getDequeueOutputBufferTimeoutUs, getSourceState, handlesTrack, haveFormat, maybeInitCodec, onProcessedOutputBuffer, onQueuedInputBuffer, releaseCodec, shouldInitCodec

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

doPrepare, doSomeWork, getBufferedPositionUs, getDurationUs, getFormat, getTrackCount, maybeThrowError, onEnabled, onReleased, readSource, seekTo, shiftInputPosition

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

getState

Methods inherited from class java.lang.Object

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

Field Detail

MSG_SET_VOLUME

public static final int MSG_SET_VOLUME

A type of a message that can be passed to an instance of this class via ExoPlayer.sendMessage(com.google.android.exoplayer.ExoPlayer.ExoPlayerComponent, int, java.lang.Object) or ExoPlayer.blockingSendMessage(com.google.android.exoplayer.ExoPlayer.ExoPlayerComponent, int, java.lang.Object). The message object should be a Float with 0 being silence and 1 being unity gain.

See Also:

Constant Field Values

MSG_SET_PLAYBACK_PARAMS

public static final int MSG_SET_PLAYBACK_PARAMS

A type of a message that can be passed to an instance of this class via ExoPlayer.sendMessage(com.google.android.exoplayer.ExoPlayer.ExoPlayerComponent, int, java.lang.Object) or ExoPlayer.blockingSendMessage(com.google.android.exoplayer.ExoPlayer.ExoPlayerComponent, int, java.lang.Object). The message object should be a PlaybackParams, which will be used to configure the underlying AudioTrack. The message object should not be modified by the caller after it has been passed

See Also:

Constant Field Values

MSG_SET_STREAM_TYPE

public static final int MSG_SET_STREAM_TYPE

A type of a message that can be passed to an instance of this class via ExoPlayer.sendMessage(com.google.android.exoplayer.ExoPlayer.ExoPlayerComponent, int, java.lang.Object) or ExoPlayer.blockingSendMessage(com.google.android.exoplayer.ExoPlayer.ExoPlayerComponent, int, java.lang.Object). The message object should be an integer stream type accepted by AudioTrack's constructor (see AudioTrack.AudioTrack(int, int, int, int, int, int)).

Note that when the stream type changes, the AudioTrack must be reinitialized, which can introduce a brief gap in audio output. Note also that tracks in the same audio session must share the same routing, so a new audio session id will be generated.

See Also:

Constant Field Values

Constructor Detail

MediaCodecAudioTrackRenderer

public MediaCodecAudioTrackRenderer(SampleSource source,
                                    MediaCodecSelector mediaCodecSelector)

Parameters:

source - The upstream source from which the renderer obtains samples.

mediaCodecSelector - A decoder selector.

MediaCodecAudioTrackRenderer

public MediaCodecAudioTrackRenderer(SampleSource source,
                                    MediaCodecSelector mediaCodecSelector,
                                    DrmSessionManager drmSessionManager,
                                    boolean playClearSamplesWithoutKeys)

Parameters:

source - The upstream source from which the renderer obtains samples.

mediaCodecSelector - A decoder selector.

drmSessionManager - For use with encrypted content. May be null if support for encrypted content is not required.

playClearSamplesWithoutKeys - Encrypted media may contain clear (un-encrypted) regions. For example a media file may start with a short clear region so as to allow playback to begin in parallel with key acquisition. This parameter specifies whether the renderer is permitted to play clear regions of encrypted media files before drmSessionManager has obtained the keys necessary to decrypt encrypted regions of the media.

MediaCodecAudioTrackRenderer

public MediaCodecAudioTrackRenderer(SampleSource source,
                                    MediaCodecSelector mediaCodecSelector,
                                    Handler eventHandler,
                                    MediaCodecAudioTrackRenderer.EventListener eventListener)

Parameters:

source - The upstream source from which the renderer obtains samples.

mediaCodecSelector - A decoder selector.

eventHandler - A handler to use when delivering events to eventListener. May be null if delivery of events is not required.

eventListener - A listener of events. May be null if delivery of events is not required.

MediaCodecAudioTrackRenderer

public MediaCodecAudioTrackRenderer(SampleSource source,
                                    MediaCodecSelector mediaCodecSelector,
                                    DrmSessionManager drmSessionManager,
                                    boolean playClearSamplesWithoutKeys,
                                    Handler eventHandler,
                                    MediaCodecAudioTrackRenderer.EventListener eventListener)

Parameters:

source - The upstream source from which the renderer obtains samples.

mediaCodecSelector - A decoder selector.

drmSessionManager - For use with encrypted content. May be null if support for encrypted content is not required.

playClearSamplesWithoutKeys - Encrypted media may contain clear (un-encrypted) regions. For example a media file may start with a short clear region so as to allow playback to begin in parallel with key acquisition. This parameter specifies whether the renderer is permitted to play clear regions of encrypted media files before drmSessionManager has obtained the keys necessary to decrypt encrypted regions of the media.

eventHandler - A handler to use when delivering events to eventListener. May be null if delivery of events is not required.

eventListener - A listener of events. May be null if delivery of events is not required.

MediaCodecAudioTrackRenderer

public MediaCodecAudioTrackRenderer(SampleSource source,
                                    MediaCodecSelector mediaCodecSelector,
                                    DrmSessionManager drmSessionManager,
                                    boolean playClearSamplesWithoutKeys,
                                    Handler eventHandler,
                                    MediaCodecAudioTrackRenderer.EventListener eventListener,
                                    AudioCapabilities audioCapabilities,
                                    int streamType)

Parameters:

source - The upstream source from which the renderer obtains samples.

mediaCodecSelector - A decoder selector.

drmSessionManager - For use with encrypted content. May be null if support for encrypted content is not required.

playClearSamplesWithoutKeys - Encrypted media may contain clear (un-encrypted) regions. For example a media file may start with a short clear region so as to allow playback to begin in parallel with key acquisition. This parameter specifies whether the renderer is permitted to play clear regions of encrypted media files before drmSessionManager has obtained the keys necessary to decrypt encrypted regions of the media.

eventHandler - A handler to use when delivering events to eventListener. May be null if delivery of events is not required.

eventListener - A listener of events. May be null if delivery of events is not required.

audioCapabilities - The audio capabilities for playback on this device. May be null if the default capabilities (no encoded audio passthrough support) should be assumed.

streamType - The type of audio stream for the AudioTrack.

MediaCodecAudioTrackRenderer

public MediaCodecAudioTrackRenderer(SampleSource[] sources,
                                    MediaCodecSelector mediaCodecSelector,
                                    DrmSessionManager drmSessionManager,
                                    boolean playClearSamplesWithoutKeys,
                                    Handler eventHandler,
                                    MediaCodecAudioTrackRenderer.EventListener eventListener,
                                    AudioCapabilities audioCapabilities,
                                    int streamType)

Parameters:

sources - The upstream sources from which the renderer obtains samples.

mediaCodecSelector - A decoder selector.

drmSessionManager - For use with encrypted content. May be null if support for encrypted content is not required.

playClearSamplesWithoutKeys - Encrypted media may contain clear (un-encrypted) regions. For example a media file may start with a short clear region so as to allow playback to begin in parallel with key acquisition. This parameter specifies whether the renderer is permitted to play clear regions of encrypted media files before drmSessionManager has obtained the keys necessary to decrypt encrypted regions of the media.

eventHandler - A handler to use when delivering events to eventListener. May be null if delivery of events is not required.

eventListener - A listener of events. May be null if delivery of events is not required.

audioCapabilities - The audio capabilities for playback on this device. May be null if the default capabilities (no encoded audio passthrough support) should be assumed.

streamType - The type of audio stream for the AudioTrack.

Method Detail

handlesTrack

protected boolean handlesTrack(MediaCodecSelector mediaCodecSelector,
                               MediaFormat mediaFormat)
                        throws MediaCodecUtil.DecoderQueryException

Description copied from class: MediaCodecTrackRenderer

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

Specified by:

handlesTrack in class MediaCodecTrackRenderer

Parameters:

mediaCodecSelector - The decoder selector.

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.

getDecoderInfo

protected DecoderInfo getDecoderInfo(MediaCodecSelector mediaCodecSelector,
                                     String mimeType,
                                     boolean requiresSecureDecoder)
                              throws MediaCodecUtil.DecoderQueryException

Description copied from class: MediaCodecTrackRenderer

Returns a DecoderInfo for a given format.

Overrides:

getDecoderInfo in class MediaCodecTrackRenderer

Parameters:

mediaCodecSelector - The decoder selector.

mimeType - The mime type for which a decoder is required.

requiresSecureDecoder - Whether a secure decoder is required.

Returns:

A DecoderInfo describing the decoder to instantiate, or null if no suitable decoder exists.

Throws:

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

allowPassthrough

protected boolean allowPassthrough(String mimeType)

Returns whether encoded audio passthrough should be used for playing back the input format. This implementation returns true if the AudioTrack's audio capabilities indicate that passthrough is supported.

Parameters:

mimeType - The type of input media.

Returns:

True if passthrough playback should be used. False otherwise.

configureCodec

protected void configureCodec(MediaCodec codec,
                              boolean codecIsAdaptive,
                              MediaFormat format,
                              MediaCrypto crypto)

Description copied from class: MediaCodecTrackRenderer

Configures a newly created MediaCodec.

Specified by:

configureCodec in class MediaCodecTrackRenderer

Parameters:

codec - The MediaCodec to configure.

codecIsAdaptive - Whether the codec is adaptive.

format - The format for which the codec is being configured.

crypto - For drm protected playbacks, a MediaCrypto to use for decryption.

getMediaClock

protected MediaClock getMediaClock()

Description copied from class: TrackRenderer

If the renderer advances its own playback position then this method returns a corresponding MediaClock. If provided, the player will use the returned MediaClock as its source of time during playback. A player may have at most one renderer that returns a MediaClock from this method.

Overrides:

getMediaClock in class TrackRenderer

Returns:

The MediaClock tracking the playback position of the renderer, or null.

onInputFormatChanged

protected void onInputFormatChanged(MediaFormatHolder holder)
                             throws ExoPlaybackException

Description copied from class: MediaCodecTrackRenderer

Invoked when a new format is read from the upstream SampleSource.

Overrides:

onInputFormatChanged in class MediaCodecTrackRenderer

Parameters:

holder - Holds the new format.

Throws:

ExoPlaybackException - If an error occurs reinitializing the MediaCodec.

onOutputFormatChanged

protected void onOutputFormatChanged(MediaCodec codec,
                                     MediaFormat outputFormat)

Description copied from class: MediaCodecTrackRenderer

Invoked when the output format of the MediaCodec changes.

The default implementation is a no-op.

Overrides:

onOutputFormatChanged in class MediaCodecTrackRenderer

Parameters:

codec - The MediaCodec instance.

outputFormat - The new output format.

onAudioSessionId

protected void onAudioSessionId(int audioSessionId)

Invoked when the audio session id becomes known. Once the id is known it will not change (and hence this method will not be invoked again) unless the renderer is disabled and then subsequently re-enabled.

The default implementation is a no-op. One reason for overriding this method would be to instantiate and enable a Virtualizer in order to spatialize the audio channels. For this use case, any Virtualizer instances should be released in onDisabled() (if not before).

Parameters:

audioSessionId - The audio session id.

onStarted

protected void onStarted()

Description copied from class: TrackRenderer

Called when the renderer is started.

The default implementation is a no-op.

Overrides:

onStarted in class MediaCodecTrackRenderer

onStopped

protected void onStopped()

Description copied from class: TrackRenderer

Called when the renderer is stopped.

The default implementation is a no-op.

Overrides:

onStopped in class MediaCodecTrackRenderer

isEnded

protected boolean isEnded()

Description copied from class: TrackRenderer

Whether the renderer is ready for the ExoPlayer instance to transition to ExoPlayer.STATE_ENDED. The player will make this transition as soon as true is returned by all of its TrackRenderers.

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

Overrides:

isEnded in class MediaCodecTrackRenderer

Returns:

Whether the renderer is ready for the player to transition to the ended state.

isReady

protected boolean isReady()

Description copied from class: TrackRenderer

Whether the renderer is able to immediately render media from the current position.

If the renderer is in the TrackRenderer.STATE_STARTED state then returning true indicates that the renderer has everything that it needs to continue playback. Returning false indicates that the player should pause until the renderer is ready.

If the renderer is in the TrackRenderer.STATE_ENABLED state then returning true indicates that the renderer is ready for playback to be started. Returning false indicates that it is not.

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

Overrides:

isReady in class MediaCodecTrackRenderer

Returns:

True if the renderer is ready to render media. False otherwise.

getPositionUs

public long getPositionUs()

Specified by:

getPositionUs in interface MediaClock

Returns:

The current media position in microseconds.

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 MediaCodecTrackRenderer

Throws:

ExoPlaybackException - If an error occurs.

onDiscontinuity

protected void onDiscontinuity(long positionUs)
                        throws ExoPlaybackException

Description copied from class: SampleSourceTrackRenderer

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

Overrides:

onDiscontinuity in class MediaCodecTrackRenderer

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.

processOutputBuffer

protected boolean processOutputBuffer(long positionUs,
                                      long elapsedRealtimeUs,
                                      MediaCodec codec,
                                      ByteBuffer buffer,
                                      MediaCodec.BufferInfo bufferInfo,
                                      int bufferIndex,
                                      boolean shouldSkip)
                               throws ExoPlaybackException

Description copied from class: MediaCodecTrackRenderer

Processes the provided output buffer.

Specified by:

processOutputBuffer in class MediaCodecTrackRenderer

Returns:

True if the output buffer was processed (e.g. rendered or discarded) and hence is no longer required. False otherwise.

Throws:

ExoPlaybackException - If an error occurs processing the output buffer.

onOutputStreamEnded

protected void onOutputStreamEnded()

Description copied from class: MediaCodecTrackRenderer

Invoked when the output stream ends, meaning that the last output buffer has been processed and the MediaCodec.BUFFER_FLAG_END_OF_STREAM flag has been propagated through the decoder.

The default implementation is a no-op.

Overrides:

onOutputStreamEnded in class MediaCodecTrackRenderer

handleAudioTrackDiscontinuity

protected void handleAudioTrackDiscontinuity()

handleMessage

public void handleMessage(int messageType,
                          Object message)
                   throws ExoPlaybackException

Description copied from interface: ExoPlayer.ExoPlayerComponent

Handles a message delivered to the component. Invoked on the playback thread.

Specified by:

handleMessage in interface ExoPlayer.ExoPlayerComponent

Overrides:

handleMessage in class TrackRenderer

Parameters:

messageType - An integer identifying the type of message.

message - The message object.

Throws:

ExoPlaybackException - If an error occurred whilst handling the message.