com.google.android.exoplayer2.video

Class MediaCodecVideoRenderer

java.lang.Object

com.google.android.exoplayer2.BaseRenderer

com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

com.google.android.exoplayer2.video.MediaCodecVideoRenderer

All Implemented Interfaces:

ExoPlayer.ExoPlayerComponent, Renderer, RendererCapabilities

public class MediaCodecVideoRenderer
extends MediaCodecRenderer

Decodes and renders video using MediaCodec.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	MediaCodecVideoRenderer.CodecMaxValues

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
MediaCodecVideoRenderer(android.content.Context context, MediaCodecSelector mediaCodecSelector)
MediaCodecVideoRenderer(android.content.Context context, MediaCodecSelector mediaCodecSelector, long allowedJoiningTimeMs)
MediaCodecVideoRenderer(android.content.Context context, MediaCodecSelector mediaCodecSelector, long allowedJoiningTimeMs, DrmSessionManager<FrameworkMediaCrypto> drmSessionManager, boolean playClearSamplesWithoutKeys, android.os.Handler eventHandler, VideoRendererEventListener eventListener, int maxDroppedFramesToNotify)
MediaCodecVideoRenderer(android.content.Context context, MediaCodecSelector mediaCodecSelector, long allowedJoiningTimeMs, android.os.Handler eventHandler, VideoRendererEventListener eventListener, int maxDroppedFrameCountToNotify)

Method Summary

Modifier and Type	Method and Description
protected boolean	canReconfigureCodec(android.media.MediaCodec codec, boolean codecIsAdaptive, Format oldFormat, Format newFormat) Determines whether the existing MediaCodec should be reconfigured for a new format by sending codec specific initialization data at the start of the next input buffer.
protected void	configureCodec(MediaCodecInfo codecInfo, android.media.MediaCodec codec, Format format, android.media.MediaCrypto crypto) Configures a newly created MediaCodec.
protected MediaCodecVideoRenderer.CodecMaxValues	getCodecMaxValues(MediaCodecInfo codecInfo, Format format, Format[] streamFormats) Returns MediaCodecVideoRenderer.CodecMaxValues suitable for configuring a codec for format in a way that will allow possible adaptation to other compatible formats in streamFormats.
void	handleMessage(int messageType, java.lang.Object message) Handles a message delivered to the component.
boolean	isReady() Whether the renderer is able to immediately render media from the current position.
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	onQueueInputBuffer(DecoderInputBuffer buffer) Called immediately before an input buffer is queued into the codec.
protected void	onStarted() Called when the renderer is started.
protected void	onStopped() Called when the renderer is stopped.
protected void	onStreamChanged(Format[] formats) Called when the renderer's stream has changed.
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 boolean	shouldDropOutputBuffer(long earlyUs, long elapsedRealtimeUs) Returns whether the buffer being processed should be dropped.
protected boolean	shouldInitCodec()
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

flushCodec, getCodec, getDecoderInfo, getDequeueOutputBufferTimeoutUs, isEnded, maybeInitCodec, onProcessedOutputBuffer, releaseCodec, render, renderToEndOfStream, supportsFormat, supportsMixedMimeTypeAdaptation

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaCodecVideoRenderer

public MediaCodecVideoRenderer(android.content.Context context,
                               MediaCodecSelector mediaCodecSelector)

Parameters:

context - A context.

mediaCodecSelector - A decoder selector.

MediaCodecVideoRenderer

public MediaCodecVideoRenderer(android.content.Context context,
                               MediaCodecSelector mediaCodecSelector,
                               long allowedJoiningTimeMs)

Parameters:

context - A context.

mediaCodecSelector - A decoder selector.

allowedJoiningTimeMs - The maximum duration in milliseconds for which this video renderer can attempt to seamlessly join an ongoing playback.

MediaCodecVideoRenderer

public MediaCodecVideoRenderer(android.content.Context context,
                               MediaCodecSelector mediaCodecSelector,
                               long allowedJoiningTimeMs,
                               android.os.Handler eventHandler,
                               VideoRendererEventListener eventListener,
                               int maxDroppedFrameCountToNotify)

Parameters:

context - A context.

mediaCodecSelector - A decoder selector.

allowedJoiningTimeMs - The maximum duration in milliseconds for which this video renderer can attempt to seamlessly join an ongoing playback.

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.

maxDroppedFrameCountToNotify - The maximum number of frames that can be dropped between invocations of VideoRendererEventListener.onDroppedFrames(int, long).

MediaCodecVideoRenderer

public MediaCodecVideoRenderer(android.content.Context context,
                               MediaCodecSelector mediaCodecSelector,
                               long allowedJoiningTimeMs,
                               DrmSessionManager<FrameworkMediaCrypto> drmSessionManager,
                               boolean playClearSamplesWithoutKeys,
                               android.os.Handler eventHandler,
                               VideoRendererEventListener eventListener,
                               int maxDroppedFramesToNotify)

Parameters:

context - A context.

mediaCodecSelector - A decoder selector.

allowedJoiningTimeMs - The maximum duration in milliseconds for which this video renderer can attempt to seamlessly join an ongoing playback.

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.

maxDroppedFramesToNotify - The maximum number of frames that can be dropped between invocations of VideoRendererEventListener.onDroppedFrames(int, long).

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.

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.

onStreamChanged

protected void onStreamChanged(Format[] formats)
                        throws ExoPlaybackException

Description copied from class: BaseRenderer

Called when the renderer's stream has changed. This occurs when the renderer is enabled after BaseRenderer.onEnabled(boolean) has been called, and also when the stream has been replaced whilst the renderer is enabled or started.

The default implementation is a no-op.

Overrides:

onStreamChanged in class BaseRenderer

Parameters:

formats - The enabled formats.

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.

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.

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

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.

shouldInitCodec

protected boolean shouldInitCodec()

Overrides:

shouldInitCodec in class MediaCodecRenderer

configureCodec

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

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.

Throws:

MediaCodecUtil.DecoderQueryException - If an error occurs querying codecInfo.

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.

onQueueInputBuffer

protected void onQueueInputBuffer(DecoderInputBuffer buffer)

Description copied from class: MediaCodecRenderer

Called immediately before an input buffer is queued into the codec.

The default implementation is a no-op.

Overrides:

onQueueInputBuffer in class MediaCodecRenderer

Parameters:

buffer - The buffer to be queued.

onOutputFormatChanged

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

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.

canReconfigureCodec

protected boolean canReconfigureCodec(android.media.MediaCodec codec,
                                      boolean codecIsAdaptive,
                                      Format oldFormat,
                                      Format newFormat)

Description copied from class: MediaCodecRenderer

Determines whether the existing MediaCodec should be reconfigured for a new format by sending codec specific initialization data at the start of the next input buffer. If true is returned then the MediaCodec instance will be reconfigured in this way. If false is returned then the instance will be released, and a new instance will be created for the new format.

The default implementation returns false.

Overrides:

canReconfigureCodec in class MediaCodecRenderer

Parameters:

codec - The existing MediaCodec instance.

codecIsAdaptive - Whether the codec is adaptive.

oldFormat - The format for which the existing instance is configured.

newFormat - The new format.

Returns:

Whether the existing instance can be reconfigured.

processOutputBuffer

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

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

shouldDropOutputBuffer

protected boolean shouldDropOutputBuffer(long earlyUs,
                                         long elapsedRealtimeUs)

Returns whether the buffer being processed should be dropped.

Parameters:

earlyUs - The time until the buffer should be presented in microseconds. A negative value indicates that the buffer is late.

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

getCodecMaxValues

protected MediaCodecVideoRenderer.CodecMaxValues getCodecMaxValues(MediaCodecInfo codecInfo,
                                                                   Format format,
                                                                   Format[] streamFormats)
                                                            throws MediaCodecUtil.DecoderQueryException

Returns MediaCodecVideoRenderer.CodecMaxValues suitable for configuring a codec for format in a way that will allow possible adaptation to other compatible formats in streamFormats.

Parameters:

codecInfo - Information about the MediaCodec being configured.

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

streamFormats - The possible stream formats.

Returns:

Suitable MediaCodecVideoRenderer.CodecMaxValues.

Throws:

MediaCodecUtil.DecoderQueryException - If an error occurs querying codecInfo.