com.google.android.exoplayer2.video

Class CustomVideoCodecRenderer

java.lang.Object

com.google.android.exoplayer2.BaseRenderer

com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

com.google.android.exoplayer2.video.CustomVideoCodecRenderer

All Implemented Interfaces:

com.google.android.exoplayer2.PlayerMessage.Target, com.google.android.exoplayer2.Renderer, com.google.android.exoplayer2.RendererCapabilities

public class CustomVideoCodecRenderer
extends com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

Decodes and renders video using MediaCodec.

This renderer accepts the following messages sent via ExoPlayer#createMessage(Target) on the playback thread:

• Message with type C.MSG_SET_SURFACE to set the output surface. The message payload should be the target Surface, or null.
• Message with type C.MSG_SET_SCALING_MODE to set the video scaling mode. The message payload should be one of the integer scaling modes in C.VideoScalingMode. Note that the scaling mode only applies if the Surface targeted by this renderer is owned by a SurfaceView.

Nested Class Summary

Nested Classes

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

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

com.google.android.exoplayer2.mediacodec.MediaCodecRenderer.DecoderInitializationException

Nested classes/interfaces inherited from interface com.google.android.exoplayer2.Renderer

com.google.android.exoplayer2.Renderer.State

Field Summary

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

decoderCounters, KEEP_CODEC_RESULT_NO, KEEP_CODEC_RESULT_YES_WITH_RECONFIGURATION, KEEP_CODEC_RESULT_YES_WITHOUT_RECONFIGURATION

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_DRM, FORMAT_UNSUPPORTED_SUBTYPE, FORMAT_UNSUPPORTED_TYPE, TUNNELING_NOT_SUPPORTED, TUNNELING_SUPPORT_MASK, TUNNELING_SUPPORTED

Constructor Summary

Constructors

Constructor and Description
CustomVideoCodecRenderer(android.content.Context context, com.google.android.exoplayer2.mediacodec.MediaCodecSelector mediaCodecSelector)
CustomVideoCodecRenderer(android.content.Context context, com.google.android.exoplayer2.mediacodec.MediaCodecSelector mediaCodecSelector, long allowedJoiningTimeMs)
CustomVideoCodecRenderer(android.content.Context context, com.google.android.exoplayer2.mediacodec.MediaCodecSelector mediaCodecSelector, long allowedJoiningTimeMs, com.google.android.exoplayer2.drm.DrmSessionManager<com.google.android.exoplayer2.drm.FrameworkMediaCrypto> drmSessionManager, boolean playClearSamplesWithoutKeys, android.os.Handler eventHandler, com.google.android.exoplayer2.video.VideoRendererEventListener eventListener, int maxDroppedFramesToNotify)
CustomVideoCodecRenderer(android.content.Context context, com.google.android.exoplayer2.mediacodec.MediaCodecSelector mediaCodecSelector, long allowedJoiningTimeMs, android.os.Handler eventHandler, com.google.android.exoplayer2.video.VideoRendererEventListener eventListener, int maxDroppedFrameCountToNotify)

Method Summary

Modifier and Type	Method and Description
protected int	canKeepCodec(android.media.MediaCodec codec, com.google.android.exoplayer2.mediacodec.MediaCodecInfo codecInfo, com.google.android.exoplayer2.Format oldFormat, com.google.android.exoplayer2.Format newFormat)
protected void	configureCodec(com.google.android.exoplayer2.mediacodec.MediaCodecInfo codecInfo, android.media.MediaCodec codec, com.google.android.exoplayer2.Format format, android.media.MediaCrypto crypto)
protected void	dropOutputBuffer(android.media.MediaCodec codec, int index, long presentationTimeUs) Drops the output buffer with the specified index.
protected void	flushCodec()
protected CustomVideoCodecRenderer.CodecMaxValues	getCodecMaxValues(com.google.android.exoplayer2.mediacodec.MediaCodecInfo codecInfo, com.google.android.exoplayer2.Format format, com.google.android.exoplayer2.Format[] streamFormats) Returns CustomVideoCodecRenderer.CodecMaxValues suitable for configuring a codec for format in a way that will allow possible adaptation to other compatible formats in streamFormats.
protected android.media.MediaFormat	getMediaFormat(com.google.android.exoplayer2.Format format, CustomVideoCodecRenderer.CodecMaxValues codecMaxValues, boolean deviceNeedsAutoFrcWorkaround, int tunnelingAudioSessionId) Returns the framework MediaFormat that should be used to configure the decoder.
void	handleMessage(int messageType, java.lang.Object message)
boolean	isReady()
protected boolean	maybeDropBuffersToKeyframe(android.media.MediaCodec codec, int index, long presentationTimeUs, long positionUs) Drops frames from the current output buffer to the next keyframe at or before the playback position.
protected void	onCodecInitialized(java.lang.String name, long initializedTimestampMs, long initializationDurationMs)
protected void	onDisabled()
protected void	onEnabled(boolean joining)
protected void	onInputFormatChanged(com.google.android.exoplayer2.Format newFormat)
protected void	onOutputFormatChanged(android.media.MediaCodec codec, android.media.MediaFormat outputFormat)
protected void	onPositionReset(long positionUs, boolean joining)
protected void	onProcessedOutputBuffer(long presentationTimeUs) Called when an output buffer is successfully processed.
protected void	onQueueInputBuffer(com.google.android.exoplayer2.decoder.DecoderInputBuffer buffer) Called immediately before an input buffer is queued into the codec.
protected void	onStarted()
protected void	onStopped()
protected void	onStreamChanged(com.google.android.exoplayer2.Format[] formats, long offsetUs)
protected boolean	processOutputBuffer(long positionUs, long elapsedRealtimeUs, android.media.MediaCodec codec, java.nio.ByteBuffer buffer, int bufferIndex, int bufferFlags, long bufferPresentationTimeUs, boolean shouldSkip)
protected void	releaseCodec()
protected void	renderOutputBuffer(android.media.MediaCodec codec, int index, long presentationTimeUs) Renders the output buffer with the specified index.
protected void	renderOutputBufferV21(android.media.MediaCodec codec, int index, long presentationTimeUs, long releaseTimeNs) Renders the output buffer with the specified index.
protected boolean	shouldDropBuffersToKeyframe(long earlyUs, long elapsedRealtimeUs) Returns whether to drop all buffers from the buffer being processed to the keyframe at or after the current playback position, if possible.
protected boolean	shouldDropOutputBuffer(long earlyUs, long elapsedRealtimeUs) Returns whether the buffer being processed should be dropped.
protected boolean	shouldForceRenderOutputBuffer(long earlyUs, long elapsedSinceLastRenderUs) Returns whether to force rendering an output buffer.
protected boolean	shouldInitCodec(com.google.android.exoplayer2.mediacodec.MediaCodecInfo codecInfo)
protected void	skipOutputBuffer(android.media.MediaCodec codec, int index, long presentationTimeUs) Skips the output buffer with the specified index.
protected int	supportsFormat(com.google.android.exoplayer2.mediacodec.MediaCodecSelector mediaCodecSelector, com.google.android.exoplayer2.drm.DrmSessionManager<com.google.android.exoplayer2.drm.FrameworkMediaCrypto> drmSessionManager, com.google.android.exoplayer2.Format format)
protected void	updateDroppedBufferCounters(int droppedBufferCount) Updates decoder counters to reflect that droppedBufferCount additional buffers were dropped.

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

getCodec, getCodecInfo, getDecoderInfo, getDequeueOutputBufferTimeoutUs, isEnded, maybeInitCodec, render, renderToEndOfStream, supportsFormat, supportsMixedMimeTypeAdaptation

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomVideoCodecRenderer

public CustomVideoCodecRenderer(android.content.Context context,
                                com.google.android.exoplayer2.mediacodec.MediaCodecSelector mediaCodecSelector)

Parameters:

context - A context.

mediaCodecSelector - A decoder selector.

CustomVideoCodecRenderer

public CustomVideoCodecRenderer(android.content.Context context,
                                com.google.android.exoplayer2.mediacodec.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.

CustomVideoCodecRenderer

public CustomVideoCodecRenderer(android.content.Context context,
                                com.google.android.exoplayer2.mediacodec.MediaCodecSelector mediaCodecSelector,
                                long allowedJoiningTimeMs,
                                @Nullable
                                android.os.Handler eventHandler,
                                @Nullable
                                com.google.android.exoplayer2.video.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).

CustomVideoCodecRenderer

public CustomVideoCodecRenderer(android.content.Context context,
                                com.google.android.exoplayer2.mediacodec.MediaCodecSelector mediaCodecSelector,
                                long allowedJoiningTimeMs,
                                @Nullable
                                com.google.android.exoplayer2.drm.DrmSessionManager<com.google.android.exoplayer2.drm.FrameworkMediaCrypto> drmSessionManager,
                                boolean playClearSamplesWithoutKeys,
                                @Nullable
                                android.os.Handler eventHandler,
                                @Nullable
                                com.google.android.exoplayer2.video.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(com.google.android.exoplayer2.mediacodec.MediaCodecSelector mediaCodecSelector,
                             com.google.android.exoplayer2.drm.DrmSessionManager<com.google.android.exoplayer2.drm.FrameworkMediaCrypto> drmSessionManager,
                             com.google.android.exoplayer2.Format format)
                      throws com.google.android.exoplayer2.mediacodec.MediaCodecUtil.DecoderQueryException

Specified by:

supportsFormat in class com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

Throws:

com.google.android.exoplayer2.mediacodec.MediaCodecUtil.DecoderQueryException

onEnabled

protected void onEnabled(boolean joining)
                  throws com.google.android.exoplayer2.ExoPlaybackException

Overrides:

onEnabled in class com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

Throws:

com.google.android.exoplayer2.ExoPlaybackException

onStreamChanged

protected void onStreamChanged(com.google.android.exoplayer2.Format[] formats,
                               long offsetUs)
                        throws com.google.android.exoplayer2.ExoPlaybackException

Overrides:

onStreamChanged in class com.google.android.exoplayer2.BaseRenderer

Throws:

com.google.android.exoplayer2.ExoPlaybackException

onPositionReset

protected void onPositionReset(long positionUs,
                               boolean joining)
                        throws com.google.android.exoplayer2.ExoPlaybackException

Overrides:

onPositionReset in class com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

Throws:

com.google.android.exoplayer2.ExoPlaybackException

isReady

public boolean isReady()

Specified by:

isReady in interface com.google.android.exoplayer2.Renderer

Overrides:

isReady in class com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

onStarted

protected void onStarted()

Overrides:

onStarted in class com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

onStopped

protected void onStopped()

Overrides:

onStopped in class com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

onDisabled

protected void onDisabled()

Overrides:

onDisabled in class com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

handleMessage

public void handleMessage(int messageType,
                          java.lang.Object message)
                   throws com.google.android.exoplayer2.ExoPlaybackException

Specified by:

handleMessage in interface com.google.android.exoplayer2.PlayerMessage.Target

Overrides:

handleMessage in class com.google.android.exoplayer2.BaseRenderer

Throws:

com.google.android.exoplayer2.ExoPlaybackException

shouldInitCodec

protected boolean shouldInitCodec(com.google.android.exoplayer2.mediacodec.MediaCodecInfo codecInfo)

Overrides:

shouldInitCodec in class com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

configureCodec

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

Specified by:

configureCodec in class com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

Throws:

com.google.android.exoplayer2.mediacodec.MediaCodecUtil.DecoderQueryException

canKeepCodec

protected int canKeepCodec(android.media.MediaCodec codec,
                           com.google.android.exoplayer2.mediacodec.MediaCodecInfo codecInfo,
                           com.google.android.exoplayer2.Format oldFormat,
                           com.google.android.exoplayer2.Format newFormat)

Overrides:

canKeepCodec in class com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

releaseCodec

@CallSuper
protected void releaseCodec()

Overrides:

releaseCodec in class com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

flushCodec

@CallSuper
protected void flushCodec()
                              throws com.google.android.exoplayer2.ExoPlaybackException

Overrides:

flushCodec in class com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

Throws:

com.google.android.exoplayer2.ExoPlaybackException

onCodecInitialized

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

Overrides:

onCodecInitialized in class com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

onInputFormatChanged

protected void onInputFormatChanged(com.google.android.exoplayer2.Format newFormat)
                             throws com.google.android.exoplayer2.ExoPlaybackException

Overrides:

onInputFormatChanged in class com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

Throws:

com.google.android.exoplayer2.ExoPlaybackException

onQueueInputBuffer

@CallSuper
protected void onQueueInputBuffer(com.google.android.exoplayer2.decoder.DecoderInputBuffer buffer)

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

Overrides:

onQueueInputBuffer in class com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

Parameters:

buffer - The buffer to be queued.

onOutputFormatChanged

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

Overrides:

onOutputFormatChanged in class com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

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 com.google.android.exoplayer2.ExoPlaybackException

Specified by:

processOutputBuffer in class com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

Throws:

com.google.android.exoplayer2.ExoPlaybackException

onProcessedOutputBuffer

@CallSuper
protected void onProcessedOutputBuffer(long presentationTimeUs)

Called when an output buffer is successfully processed.

Overrides:

onProcessedOutputBuffer in class com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

Parameters:

presentationTimeUs - The timestamp associated with the output buffer.

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.

shouldDropBuffersToKeyframe

protected boolean shouldDropBuffersToKeyframe(long earlyUs,
                                              long elapsedRealtimeUs)

Returns whether to drop all buffers from the buffer being processed to the keyframe at or after the current playback position, if possible.

Parameters:

earlyUs - The time until the current 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.

shouldForceRenderOutputBuffer

protected boolean shouldForceRenderOutputBuffer(long earlyUs,
                                                long elapsedSinceLastRenderUs)

Returns whether to force rendering an output buffer.

Parameters:

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

elapsedSinceLastRenderUs - The elapsed time since the last output buffer was rendered, in microseconds.

Returns:

Returns whether to force rendering an output buffer.

skipOutputBuffer

protected void skipOutputBuffer(android.media.MediaCodec codec,
                                int index,
                                long presentationTimeUs)

Skips the output buffer with the specified index.

Parameters:

codec - The codec that owns the output buffer.

index - The index of the output buffer to skip.

presentationTimeUs - The presentation time of the output buffer, in microseconds.

dropOutputBuffer

protected void dropOutputBuffer(android.media.MediaCodec codec,
                                int index,
                                long presentationTimeUs)

Drops the output buffer with the specified index.

Parameters:

codec - The codec that owns the output buffer.

index - The index of the output buffer to drop.

presentationTimeUs - The presentation time of the output buffer, in microseconds.

maybeDropBuffersToKeyframe

protected boolean maybeDropBuffersToKeyframe(android.media.MediaCodec codec,
                                             int index,
                                             long presentationTimeUs,
                                             long positionUs)
                                      throws com.google.android.exoplayer2.ExoPlaybackException

Drops frames from the current output buffer to the next keyframe at or before the playback position. If no such keyframe exists, as the playback position is inside the same group of pictures as the buffer being processed, returns false. Returns true otherwise.

Parameters:

codec - The codec that owns the output buffer.

index - The index of the output buffer to drop.

presentationTimeUs - The presentation time of the output buffer, in microseconds.

positionUs - The current playback position, in microseconds.

Returns:

Whether any buffers were dropped.

Throws:

com.google.android.exoplayer2.ExoPlaybackException - If an error occurs flushing the codec.

updateDroppedBufferCounters

protected void updateDroppedBufferCounters(int droppedBufferCount)

Updates decoder counters to reflect that droppedBufferCount additional buffers were dropped.

Parameters:

droppedBufferCount - The number of additional dropped buffers.

renderOutputBuffer

protected void renderOutputBuffer(android.media.MediaCodec codec,
                                  int index,
                                  long presentationTimeUs)

Renders the output buffer with the specified index. This method is only called if the platform API version of the device is less than 21.

Parameters:

codec - The codec that owns the output buffer.

index - The index of the output buffer to drop.

presentationTimeUs - The presentation time of the output buffer, in microseconds.

renderOutputBufferV21

protected void renderOutputBufferV21(android.media.MediaCodec codec,
                                     int index,
                                     long presentationTimeUs,
                                     long releaseTimeNs)

Renders the output buffer with the specified index. This method is only called if the platform API version of the device is 21 or later.

Parameters:

codec - The codec that owns the output buffer.

index - The index of the output buffer to drop.

presentationTimeUs - The presentation time of the output buffer, in microseconds.

releaseTimeNs - The wallclock time at which the frame should be displayed, in nanoseconds.

getMediaFormat

protected android.media.MediaFormat getMediaFormat(com.google.android.exoplayer2.Format format,
                                                   CustomVideoCodecRenderer.CodecMaxValues codecMaxValues,
                                                   boolean deviceNeedsAutoFrcWorkaround,
                                                   int tunnelingAudioSessionId)

Returns the framework MediaFormat that should be used to configure the decoder.

Parameters:

format - The format of media.

codecMaxValues - Codec max values that should be used when configuring the decoder.

deviceNeedsAutoFrcWorkaround - Whether the device is known to enable frame-rate conversion logic that negatively impacts ExoPlayer.

tunnelingAudioSessionId - The audio session id to use for tunneling, or C.AUDIO_SESSION_ID_UNSET if tunneling should not be enabled.

Returns:

The framework MediaFormat that should be used to configure the decoder.

getCodecMaxValues

protected CustomVideoCodecRenderer.CodecMaxValues getCodecMaxValues(com.google.android.exoplayer2.mediacodec.MediaCodecInfo codecInfo,
                                                                    com.google.android.exoplayer2.Format format,
                                                                    com.google.android.exoplayer2.Format[] streamFormats)
                                                             throws com.google.android.exoplayer2.mediacodec.MediaCodecUtil.DecoderQueryException

Returns CustomVideoCodecRenderer.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 CustomVideoCodecRenderer.CodecMaxValues.

Throws:

com.google.android.exoplayer2.mediacodec.MediaCodecUtil.DecoderQueryException - If an error occurs querying codecInfo.