com.google.android.exoplayer2.audio

Class MediaCodecAudioRenderer

java.lang.Object

com.google.android.exoplayer2.BaseRenderer

com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

com.google.android.exoplayer2.audio.MediaCodecAudioRenderer

All Implemented Interfaces:

ExoPlayer.ExoPlayerComponent, Renderer, RendererCapabilities, MediaClock

public class MediaCodecAudioRenderer
extends MediaCodecRenderer
implements MediaClock

Decodes and renders audio using MediaCodec and AudioTrack.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

MediaCodecRenderer.DecoderInitializationException

Field Summary

Fields inherited from class com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

decoderCounters

Fields inherited from interface com.google.android.exoplayer2.Renderer

STATE_DISABLED, STATE_ENABLED, STATE_STARTED

Fields inherited from interface com.google.android.exoplayer2.RendererCapabilities

ADAPTIVE_NOT_SEAMLESS, ADAPTIVE_NOT_SUPPORTED, ADAPTIVE_SEAMLESS, ADAPTIVE_SUPPORT_MASK, FORMAT_EXCEEDS_CAPABILITIES, FORMAT_HANDLED, FORMAT_SUPPORT_MASK, FORMAT_UNSUPPORTED_SUBTYPE, FORMAT_UNSUPPORTED_TYPE, TUNNELING_NOT_SUPPORTED, TUNNELING_SUPPORT_MASK, TUNNELING_SUPPORTED

Constructor Summary

Constructors

Constructor and Description
MediaCodecAudioRenderer(MediaCodecSelector mediaCodecSelector)
MediaCodecAudioRenderer(MediaCodecSelector mediaCodecSelector, DrmSessionManager<FrameworkMediaCrypto> drmSessionManager, boolean playClearSamplesWithoutKeys)
MediaCodecAudioRenderer(MediaCodecSelector mediaCodecSelector, DrmSessionManager<FrameworkMediaCrypto> drmSessionManager, boolean playClearSamplesWithoutKeys, android.os.Handler eventHandler, AudioRendererEventListener eventListener)
MediaCodecAudioRenderer(MediaCodecSelector mediaCodecSelector, DrmSessionManager<FrameworkMediaCrypto> drmSessionManager, boolean playClearSamplesWithoutKeys, android.os.Handler eventHandler, AudioRendererEventListener eventListener, AudioCapabilities audioCapabilities, AudioProcessor... audioProcessors)
MediaCodecAudioRenderer(MediaCodecSelector mediaCodecSelector, android.os.Handler eventHandler, AudioRendererEventListener eventListener)

Method Summary

Modifier and Type	Method and Description
protected boolean	allowPassthrough(java.lang.String mimeType) Returns whether encoded audio passthrough should be used for playing back the input format.
protected void	configureCodec(MediaCodecInfo codecInfo, android.media.MediaCodec codec, Format format, android.media.MediaCrypto crypto) Configures a newly created MediaCodec.
protected MediaCodecInfo	getDecoderInfo(MediaCodecSelector mediaCodecSelector, Format format, boolean requiresSecureDecoder) Returns a MediaCodecInfo for a given format.
MediaClock	getMediaClock() If the renderer advances its own playback position then this method returns a corresponding MediaClock.
long	getPositionUs() Returns the current media position in microseconds.
void	handleMessage(int messageType, java.lang.Object message) Handles a message delivered to the component.
boolean	isEnded() Whether the renderer is ready for the ExoPlayer instance to transition to ExoPlayer.STATE_ENDED.
boolean	isReady() Whether the renderer is able to immediately render media from the current position.
protected void	onAudioSessionId(int audioSessionId) Called when the audio session id becomes known.
protected void	onAudioTrackPositionDiscontinuity()
protected void	onAudioTrackUnderrun(int bufferSize, long bufferSizeMs, long elapsedSinceLastFeedMs)
protected void	onCodecInitialized(java.lang.String name, long initializedTimestampMs, long initializationDurationMs) Called when a MediaCodec has been created and configured.
protected void	onDisabled() Called when the renderer is disabled.
protected void	onEnabled(boolean joining) Called when the renderer is enabled.
protected void	onInputFormatChanged(Format newFormat) Called when a new format is read from the upstream MediaPeriod.
protected void	onOutputFormatChanged(android.media.MediaCodec codec, android.media.MediaFormat outputFormat) Called when the output format of the MediaCodec changes.
protected void	onPositionReset(long positionUs, boolean joining) Called when the position is reset.
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, android.media.MediaCodec codec, java.nio.ByteBuffer buffer, int bufferIndex, int bufferFlags, long bufferPresentationTimeUs, boolean shouldSkip) Processes an output media buffer.
protected void	renderToEndOfStream() Incrementally renders any remaining output.
protected int	supportsFormat(MediaCodecSelector mediaCodecSelector, Format format) Returns the extent to which the renderer is capable of supporting a given format.

Methods inherited from class com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

canReconfigureCodec, flushCodec, getCodec, getDequeueOutputBufferTimeoutUs, maybeInitCodec, onProcessedOutputBuffer, onQueueInputBuffer, releaseCodec, render, shouldInitCodec, supportsFormat, supportsMixedMimeTypeAdaptation

Methods inherited from class com.google.android.exoplayer2.BaseRenderer

disable, enable, getCapabilities, getConfiguration, getIndex, getState, getStream, getTrackType, hasReadStreamToEnd, isCurrentStreamFinal, isSourceReady, maybeThrowStreamError, onStreamChanged, readSource, readSource, replaceStream, resetPosition, setCurrentStreamFinal, setIndex, skipToKeyframeBefore, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaCodecAudioRenderer

public MediaCodecAudioRenderer(MediaCodecSelector mediaCodecSelector)

Parameters:

mediaCodecSelector - A decoder selector.

MediaCodecAudioRenderer

public MediaCodecAudioRenderer(MediaCodecSelector mediaCodecSelector,
                               DrmSessionManager<FrameworkMediaCrypto> drmSessionManager,
                               boolean playClearSamplesWithoutKeys)

Parameters:

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.

MediaCodecAudioRenderer

public MediaCodecAudioRenderer(MediaCodecSelector mediaCodecSelector,
                               android.os.Handler eventHandler,
                               AudioRendererEventListener eventListener)

Parameters:

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.

MediaCodecAudioRenderer

public MediaCodecAudioRenderer(MediaCodecSelector mediaCodecSelector,
                               DrmSessionManager<FrameworkMediaCrypto> drmSessionManager,
                               boolean playClearSamplesWithoutKeys,
                               android.os.Handler eventHandler,
                               AudioRendererEventListener eventListener)

Parameters:

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.

MediaCodecAudioRenderer

public MediaCodecAudioRenderer(MediaCodecSelector mediaCodecSelector,
                               DrmSessionManager<FrameworkMediaCrypto> drmSessionManager,
                               boolean playClearSamplesWithoutKeys,
                               android.os.Handler eventHandler,
                               AudioRendererEventListener eventListener,
                               AudioCapabilities audioCapabilities,
                               AudioProcessor... audioProcessors)

Parameters:

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.

audioProcessors - Optional AudioProcessors that will process PCM audio before output.

Method Detail

supportsFormat

protected int supportsFormat(MediaCodecSelector mediaCodecSelector,
                             Format format)
                      throws MediaCodecUtil.DecoderQueryException

Description copied from class: MediaCodecRenderer

Returns the extent to which the renderer is capable of supporting a given format.

Specified by:

supportsFormat in class MediaCodecRenderer

Parameters:

mediaCodecSelector - The decoder selector.

format - The format.

Returns:

The extent to which the renderer is capable of supporting the given format. See MediaCodecRenderer.supportsFormat(Format) for more detail.

Throws:

MediaCodecUtil.DecoderQueryException - If there was an error querying decoders.

getDecoderInfo

protected MediaCodecInfo getDecoderInfo(MediaCodecSelector mediaCodecSelector,
                                        Format format,
                                        boolean requiresSecureDecoder)
                                 throws MediaCodecUtil.DecoderQueryException

Description copied from class: MediaCodecRenderer

Returns a MediaCodecInfo for a given format.

Overrides:

getDecoderInfo in class MediaCodecRenderer

Parameters:

mediaCodecSelector - The decoder selector.

format - The format for which a decoder is required.

requiresSecureDecoder - Whether a secure decoder is required.

Returns:

A MediaCodecInfo 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(java.lang.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:

Whether passthrough playback should be used.

configureCodec

protected void configureCodec(MediaCodecInfo codecInfo,
                              android.media.MediaCodec codec,
                              Format format,
                              android.media.MediaCrypto crypto)

Description copied from class: MediaCodecRenderer

Configures a newly created MediaCodec.

Specified by:

configureCodec in class MediaCodecRenderer

Parameters:

codecInfo - Information about the MediaCodec being configured.

codec - The MediaCodec to configure.

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

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

getMediaClock

public MediaClock getMediaClock()

Description copied from interface: Renderer

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.

Specified by:

getMediaClock in interface Renderer

Overrides:

getMediaClock in class BaseRenderer

Returns:

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

onCodecInitialized

protected void onCodecInitialized(java.lang.String name,
                                  long initializedTimestampMs,
                                  long initializationDurationMs)

Description copied from class: MediaCodecRenderer

Called when a MediaCodec has been created and configured.

The default implementation is a no-op.

Overrides:

onCodecInitialized in class MediaCodecRenderer

Parameters:

name - The name of the codec that was initialized.

initializedTimestampMs - SystemClock.elapsedRealtime() when initialization finished.

initializationDurationMs - The time taken to initialize the codec in milliseconds.

onInputFormatChanged

protected void onInputFormatChanged(Format newFormat)
                             throws ExoPlaybackException

Description copied from class: MediaCodecRenderer

Called when a new format is read from the upstream MediaPeriod.

Overrides:

onInputFormatChanged in class MediaCodecRenderer

Parameters:

newFormat - The new format.

Throws:

ExoPlaybackException - If an error occurs reinitializing the MediaCodec.

onOutputFormatChanged

protected void onOutputFormatChanged(android.media.MediaCodec codec,
                                     android.media.MediaFormat outputFormat)
                              throws ExoPlaybackException

Description copied from class: MediaCodecRenderer

Called when the output format of the MediaCodec changes.

The default implementation is a no-op.

Overrides:

onOutputFormatChanged in class MediaCodecRenderer

Parameters:

codec - The MediaCodec instance.

outputFormat - The new output format.

Throws:

ExoPlaybackException - Thrown if an error occurs handling the new output format.

onAudioSessionId

protected void onAudioSessionId(int audioSessionId)

Called when the audio session id becomes known. 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).

See Also:

AudioTrack.Listener.onAudioSessionId(int)

onAudioTrackPositionDiscontinuity

protected void onAudioTrackPositionDiscontinuity()

See Also:

AudioTrack.Listener.onPositionDiscontinuity()

onAudioTrackUnderrun

protected void onAudioTrackUnderrun(int bufferSize,
                                    long bufferSizeMs,
                                    long elapsedSinceLastFeedMs)

See Also:

AudioTrack.Listener.onUnderrun(int, long, long)

onEnabled

protected void onEnabled(boolean joining)
                  throws ExoPlaybackException

Description copied from class: BaseRenderer

Called when the renderer is enabled.

The default implementation is a no-op.

Overrides:

onEnabled in class MediaCodecRenderer

Parameters:

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

Throws:

ExoPlaybackException - If an error occurs.

onPositionReset

protected void onPositionReset(long positionUs,
                               boolean joining)
                        throws ExoPlaybackException

Description copied from class: BaseRenderer

Called when the position is reset. This occurs when the renderer is enabled after BaseRenderer.onStreamChanged(Format[]) has been called, and also when a position discontinuity is encountered.

After a position reset, the renderer's SampleStream is guaranteed to provide samples starting from a key frame.

The default implementation is a no-op.

Overrides:

onPositionReset in class MediaCodecRenderer

Parameters:

positionUs - The new playback position in microseconds.

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

Throws:

ExoPlaybackException - If an error occurs.

onStarted

protected void onStarted()

Description copied from class: BaseRenderer

Called when the renderer is started.

The default implementation is a no-op.

Overrides:

onStarted in class MediaCodecRenderer

onStopped

protected void onStopped()

Description copied from class: BaseRenderer

Called when the renderer is stopped.

The default implementation is a no-op.

Overrides:

onStopped in class MediaCodecRenderer

onDisabled

protected void onDisabled()

Description copied from class: BaseRenderer

Called when the renderer is disabled.

The default implementation is a no-op.

Overrides:

onDisabled in class MediaCodecRenderer

isEnded

public boolean isEnded()

Description copied from interface: Renderer

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 Renderers.

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

Specified by:

isEnded in interface Renderer

Overrides:

isEnded in class MediaCodecRenderer

Returns:

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

isReady

public boolean isReady()

Description copied from interface: Renderer

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

If the renderer is in the Renderer.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 Renderer.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: Renderer.STATE_ENABLED, Renderer.STATE_STARTED.

Specified by:

isReady in interface Renderer

Overrides:

isReady in class MediaCodecRenderer

Returns:

Whether the renderer is ready to render media.

getPositionUs

public long getPositionUs()

Description copied from interface: MediaClock

Returns the current media position in microseconds.

Specified by:

getPositionUs in interface MediaClock

processOutputBuffer

protected boolean processOutputBuffer(long positionUs,
                                      long elapsedRealtimeUs,
                                      android.media.MediaCodec codec,
                                      java.nio.ByteBuffer buffer,
                                      int bufferIndex,
                                      int bufferFlags,
                                      long bufferPresentationTimeUs,
                                      boolean shouldSkip)
                               throws ExoPlaybackException

Description copied from class: MediaCodecRenderer

Processes an output media buffer.

When a new ByteBuffer is passed to this method its position and limit delineate the data to be processed. The return value indicates whether the buffer was processed in full. If true is returned then the next call to this method will receive a new buffer to be processed. If false is returned then the same buffer will be passed to the next call. An implementation of this method is free to modify the buffer and can assume that the buffer will not be externally modified between successive calls. Hence an implementation can, for example, modify the buffer's position to keep track of how much of the data it has processed.

Note that the first call to this method following a call to MediaCodecRenderer.onPositionReset(long, boolean) will always receive a new ByteBuffer to be processed.

Specified by:

processOutputBuffer in class MediaCodecRenderer

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.

codec - The MediaCodec instance.

buffer - The output buffer to process.

bufferIndex - The index of the output buffer.

bufferFlags - The flags attached to the output buffer.

bufferPresentationTimeUs - The presentation time of the output buffer in microseconds.

shouldSkip - Whether the buffer should be skipped (i.e. not rendered).

Returns:

Whether the output buffer was fully processed (e.g. rendered or skipped).

Throws:

ExoPlaybackException - If an error occurs processing the output buffer.

renderToEndOfStream

protected void renderToEndOfStream()
                            throws ExoPlaybackException

Description copied from class: MediaCodecRenderer

Incrementally renders any remaining output.

The default implementation is a no-op.

Overrides:

renderToEndOfStream in class MediaCodecRenderer

Throws:

ExoPlaybackException - Thrown if an error occurs rendering remaining output.

handleMessage

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

Description copied from interface: ExoPlayer.ExoPlayerComponent

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

Specified by:

handleMessage in interface ExoPlayer.ExoPlayerComponent

Overrides:

handleMessage in class BaseRenderer

Parameters:

messageType - The message type.

message - The message.

Throws:

ExoPlaybackException - If an error occurred whilst handling the message.