com.google.android.exoplayer2.mediacodec

Class MediaCodecRenderer

java.lang.Object

com.google.android.exoplayer2.BaseRenderer

com.google.android.exoplayer2.mediacodec.MediaCodecRenderer

All Implemented Interfaces:

PlayerMessage.Target, Renderer, RendererCapabilities

Direct Known Subclasses:

MediaCodecAudioRenderer, MediaCodecVideoRenderer

public abstract class MediaCodecRenderer
extends BaseRenderer

An abstract renderer that uses MediaCodec to decode samples for rendering.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaCodecRenderer.DecoderInitializationException Thrown when a failure occurs instantiating a decoder.
protected static interface	MediaCodecRenderer.KeepCodecResult The possible return values for canKeepCodec(MediaCodec, MediaCodecInfo, Format, Format).

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

Renderer.State

Field Summary

Fields

Modifier and Type	Field and Description
protected DecoderCounters	decoderCounters
protected static int	KEEP_CODEC_RESULT_NO The codec cannot be kept.
protected static int	KEEP_CODEC_RESULT_YES_WITH_RECONFIGURATION The codec can be kept, but must be reconfigured by prefixing the next input buffer with the new format's configuration data.
protected static int	KEEP_CODEC_RESULT_YES_WITHOUT_RECONFIGURATION The codec can be kept.

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
MediaCodecRenderer(int trackType, MediaCodecSelector mediaCodecSelector, DrmSessionManager<FrameworkMediaCrypto> drmSessionManager, boolean playClearSamplesWithoutKeys)

Method Summary

Modifier and Type	Method and Description
protected int	canKeepCodec(android.media.MediaCodec codec, MediaCodecInfo codecInfo, Format oldFormat, Format newFormat) Determines whether the existing MediaCodec can be kept for a new format, and if it can whether it requires reconfiguration.
protected abstract void	configureCodec(MediaCodecInfo codecInfo, android.media.MediaCodec codec, Format format, android.media.MediaCrypto crypto) Configures a newly created MediaCodec.
protected void	flushCodec()
protected android.media.MediaCodec	getCodec()
protected MediaCodecInfo	getCodecInfo()
protected MediaCodecInfo	getDecoderInfo(MediaCodecSelector mediaCodecSelector, Format format, boolean requiresSecureDecoder) Returns a MediaCodecInfo for a given format.
protected long	getDequeueOutputBufferTimeoutUs() Returns the maximum time to block whilst waiting for a decoded output buffer.
boolean	isEnded() Whether the renderer is ready for the ExoPlayer instance to transition to Player.STATE_ENDED.
boolean	isReady() Whether the renderer is able to immediately render media from the current position.
protected void	maybeInitCodec()
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	onProcessedOutputBuffer(long presentationTimeUs) Called when an output buffer is successfully processed.
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 abstract 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	releaseCodec()
void	render(long positionUs, long elapsedRealtimeUs) Incrementally renders the SampleStream.
protected void	renderToEndOfStream() Incrementally renders any remaining output.
protected boolean	shouldInitCodec(MediaCodecInfo codecInfo)
int	supportsFormat(Format format) Returns the extent to which the Renderer supports a given format.
protected abstract int	supportsFormat(MediaCodecSelector mediaCodecSelector, DrmSessionManager<FrameworkMediaCrypto> drmSessionManager, Format format) Returns the extent to which the renderer is capable of supporting a given format.
int	supportsMixedMimeTypeAdaptation() Returns the extent to which the Renderer supports adapting between supported formats that have different mime types.

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

disable, enable, getCapabilities, getConfiguration, getIndex, getMediaClock, getState, getStream, getStreamFormats, getTrackType, handleMessage, hasReadStreamToEnd, isCurrentStreamFinal, isSourceReady, maybeThrowStreamError, onStreamChanged, 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

Field Detail

KEEP_CODEC_RESULT_NO

protected static final int KEEP_CODEC_RESULT_NO

The codec cannot be kept.

See Also:

Constant Field Values

KEEP_CODEC_RESULT_YES_WITHOUT_RECONFIGURATION

protected static final int KEEP_CODEC_RESULT_YES_WITHOUT_RECONFIGURATION

The codec can be kept. No reconfiguration is required.

See Also:

Constant Field Values

KEEP_CODEC_RESULT_YES_WITH_RECONFIGURATION

protected static final int KEEP_CODEC_RESULT_YES_WITH_RECONFIGURATION

The codec can be kept, but must be reconfigured by prefixing the next input buffer with the new format's configuration data.

See Also:

Constant Field Values

decoderCounters

protected DecoderCounters decoderCounters

Constructor Detail

MediaCodecRenderer

public MediaCodecRenderer(int trackType,
                          MediaCodecSelector mediaCodecSelector,
                          @Nullable
                          DrmSessionManager<FrameworkMediaCrypto> drmSessionManager,
                          boolean playClearSamplesWithoutKeys)

Parameters:

trackType - The track type that the renderer handles. One of the C.TRACK_TYPE_* constants defined in C.

mediaCodecSelector - A decoder selector.

drmSessionManager - For use with encrypted media. May be null if support for encrypted media 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.

Method Detail

supportsMixedMimeTypeAdaptation

public final int supportsMixedMimeTypeAdaptation()

Description copied from interface: RendererCapabilities

Returns the extent to which the Renderer supports adapting between supported formats that have different mime types.

Specified by:

supportsMixedMimeTypeAdaptation in interface RendererCapabilities

Overrides:

supportsMixedMimeTypeAdaptation in class BaseRenderer

Returns:

The extent to which the renderer supports adapting between supported formats that have different mime types. One of RendererCapabilities.ADAPTIVE_SEAMLESS, RendererCapabilities.ADAPTIVE_NOT_SEAMLESS and RendererCapabilities.ADAPTIVE_NOT_SUPPORTED.

supportsFormat

public final int supportsFormat(Format format)
                         throws ExoPlaybackException

Description copied from interface: RendererCapabilities

Returns the extent to which the Renderer supports a given format. The returned value is the bitwise OR of three properties:

• The level of support for the format itself. One of RendererCapabilities.FORMAT_HANDLED, RendererCapabilities.FORMAT_EXCEEDS_CAPABILITIES, RendererCapabilities.FORMAT_UNSUPPORTED_DRM, RendererCapabilities.FORMAT_UNSUPPORTED_SUBTYPE and RendererCapabilities.FORMAT_UNSUPPORTED_TYPE.
• The level of support for adapting from the format to another format of the same mime type. One of RendererCapabilities.ADAPTIVE_SEAMLESS, RendererCapabilities.ADAPTIVE_NOT_SEAMLESS and RendererCapabilities.ADAPTIVE_NOT_SUPPORTED. Only set if the level of support for the format itself is RendererCapabilities.FORMAT_HANDLED or RendererCapabilities.FORMAT_EXCEEDS_CAPABILITIES.
• The level of support for tunneling. One of RendererCapabilities.TUNNELING_SUPPORTED and RendererCapabilities.TUNNELING_NOT_SUPPORTED. Only set if the level of support for the format itself is RendererCapabilities.FORMAT_HANDLED or RendererCapabilities.FORMAT_EXCEEDS_CAPABILITIES.

The individual properties can be retrieved by performing a bitwise AND with RendererCapabilities.FORMAT_SUPPORT_MASK, RendererCapabilities.ADAPTIVE_SUPPORT_MASK and RendererCapabilities.TUNNELING_SUPPORT_MASK respectively.

Parameters:

format - The format.

Returns:

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

Throws:

ExoPlaybackException - If an error occurs.

supportsFormat

protected abstract int supportsFormat(MediaCodecSelector mediaCodecSelector,
                                      DrmSessionManager<FrameworkMediaCrypto> drmSessionManager,
                                      Format format)
                               throws MediaCodecUtil.DecoderQueryException

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

Parameters:

mediaCodecSelector - The decoder selector.

drmSessionManager - The renderer's DrmSessionManager.

format - The format.

Returns:

The extent to which the renderer is capable of supporting the given format. See 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

Returns a MediaCodecInfo for a given format.

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.

configureCodec

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

Configures a newly created MediaCodec.

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.

maybeInitCodec

protected final void maybeInitCodec()
                             throws ExoPlaybackException

Throws:

ExoPlaybackException

shouldInitCodec

protected boolean shouldInitCodec(MediaCodecInfo codecInfo)

getCodec

protected final android.media.MediaCodec getCodec()

getCodecInfo

protected final MediaCodecInfo getCodecInfo()

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 BaseRenderer

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[], long) 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 BaseRenderer

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.

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 BaseRenderer

releaseCodec

protected void releaseCodec()

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 BaseRenderer

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 BaseRenderer

render

public void render(long positionUs,
                   long elapsedRealtimeUs)
            throws ExoPlaybackException

Description copied from interface: Renderer

Incrementally renders the SampleStream.

If the renderer is in the Renderer.STATE_ENABLED state then each call to this method will do work toward being ready to render the SampleStream when the renderer is started. It may also render the very start of the media, for example the first frame of a video stream. If the renderer is in the Renderer.STATE_STARTED state then calls to this method will render the SampleStream in sync with the specified media positions.

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

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

Parameters:

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

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

Throws:

ExoPlaybackException - If an error occurs.

flushCodec

protected void flushCodec()
                   throws ExoPlaybackException

Throws:

ExoPlaybackException

onCodecInitialized

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

Called when a MediaCodec has been created and configured.

The default implementation is a no-op.

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

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

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

Called when the output format of the MediaCodec changes.

The default implementation is a no-op.

Parameters:

codec - The MediaCodec instance.

outputFormat - The new output format.

Throws:

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

onQueueInputBuffer

protected void onQueueInputBuffer(DecoderInputBuffer buffer)

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

The default implementation is a no-op.

Parameters:

buffer - The buffer to be queued.

onProcessedOutputBuffer

protected void onProcessedOutputBuffer(long presentationTimeUs)

Called when an output buffer is successfully processed.

The default implementation is a no-op.

Parameters:

presentationTimeUs - The timestamp associated with the output buffer.

canKeepCodec

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

Determines whether the existing MediaCodec can be kept for a new format, and if it can whether it requires reconfiguration.

The default implementation returns KEEP_CODEC_RESULT_NO.

Parameters:

codec - The existing MediaCodec instance.

codecInfo - A MediaCodecInfo describing the decoder.

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

newFormat - The new format.

Returns:

Whether the instance can be kept, and if it can whether it requires reconfiguration.

isEnded

public boolean isEnded()

Description copied from interface: Renderer

Whether the renderer is ready for the ExoPlayer instance to transition to Player.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.

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.

Returns:

Whether the renderer is ready to render media.

getDequeueOutputBufferTimeoutUs

protected long getDequeueOutputBufferTimeoutUs()

Returns the maximum time to block whilst waiting for a decoded output buffer.

Returns:

The maximum time to block, in microseconds.

processOutputBuffer

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

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 onPositionReset(long, boolean) will always receive a new ByteBuffer to be processed.

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

Incrementally renders any remaining output.

The default implementation is a no-op.

Throws:

ExoPlaybackException - Thrown if an error occurs rendering remaining output.