MediaCodecRenderer


@UnstableApi
public abstract class MediaCodecRenderer extends BaseRenderer

Known direct subclasses
MediaCodecAudioRenderer

Decodes and renders audio using MediaCodec and an AudioSink.

MediaCodecVideoRenderer

Decodes and renders video using MediaCodec.


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

Summary

Nested types

Thrown when a failure occurs instantiating a decoder.

Constants

static final float

Indicates no codec operating rate should be set.

Public constructors

MediaCodecRenderer(
    @C.TrackType int trackType,
    MediaCodecAdapter.Factory codecAdapterFactory,
    MediaCodecSelector mediaCodecSelector,
    boolean enableDecoderFallback,
    float assumedMinimumCodecOperatingRate
)

Public methods

void

Enables the renderer to invoke onProcessedStreamChange on the first stream.

final long
getDurationToProgressUs(long positionUs, long elapsedRealtimeUs)

Returns minimum amount of playback clock time that must pass in order for the render call to make progress.

void
handleMessage(
    @Renderer.MessageType int messageType,
    @Nullable Object message
)

Handles a message delivered to the target.

boolean

Whether the renderer is ready for the ExoPlayer instance to transition to STATE_ENDED.

boolean

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

void
render(long positionUs, long elapsedRealtimeUs)

Incrementally renders the SampleStream.

void
setPlaybackSpeed(float currentPlaybackSpeed, float targetPlaybackSpeed)

Indicates the playback speed to this renderer.

void
setRenderTimeLimitMs(long renderTimeLimitMs)

Sets a limit on the time a single render call can spend draining and filling the decoder.

final int

Returns the extent to which the Renderer supports a given format.

final int

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

Protected methods

DecoderReuseEvaluation
canReuseCodec(
    MediaCodecInfo codecInfo,
    Format oldFormat,
    Format newFormat
)

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

MediaCodecDecoderException
createDecoderException(
    Throwable cause,
    @Nullable MediaCodecInfo codecInfo
)
final boolean

Flushes the codec.

boolean

Flushes the codec.

final @Nullable MediaCodecAdapter
int

Returns the flags that should be set on queueInputBuffer or queueSecureInputBuffer for this buffer.

final @Nullable MediaCodecInfo
boolean

Returns whether the codec needs the renderer to propagate the end-of-stream signal directly, rather than by using an end-of-stream buffer queued to the codec.

float

Returns the operating rate used by the current codec

float
getCodecOperatingRateV23(
    float targetPlaybackSpeed,
    Format format,
    Format[] streamFormats
)

Returns the KEY_OPERATING_RATE value for a given playback speed, current Format and set of possible stream formats.

final @Nullable MediaFormat
abstract List<MediaCodecInfo>
getDecoderInfos(
    MediaCodecSelector mediaCodecSelector,
    Format format,
    boolean requiresSecureDecoder
)

Returns a list of decoders that can decode media in the specified format, in priority order.

long
getDurationToProgressUs(
    boolean isOnBufferAvailableListenerRegistered,
    long positionUs,
    long elapsedRealtimeUs
)

Returns minimum time playback must advance in order for the render call to make progress.

long

Returns the presentation time of the last buffer in the stream.

abstract MediaCodecAdapter.Configuration
getMediaCodecConfiguration(
    MediaCodecInfo codecInfo,
    Format format,
    @Nullable MediaCrypto crypto,
    float codecOperatingRate
)

Returns the MediaCodecAdapter.Configuration that will be used to create and configure a MediaCodec to decode the given Format for a playback.

final long

Returns the offset that should be subtracted from bufferPresentationTimeUs in processOutputBuffer to get the playback position with respect to the media.

final long

Returns the start position of the current output stream in microseconds.

float

Returns the current playback speed, as set by setPlaybackSpeed.

final @Nullable Renderer.WakeupListener

Returns listener used to signal that render should be called.

void

Handles supplemental data associated with an input buffer.

final boolean

Returns whether bypass is enabled by the renderer.

final boolean

Returns whether buffers in the input format can be processed without a codec.

final void
void
onCodecError(Exception codecError)

Called when a codec error has occurred.

void
onCodecInitialized(
    String name,
    MediaCodecAdapter.Configuration configuration,
    long initializedTimestampMs,
    long initializationDurationMs
)

Called when a MediaCodec has been created and configured.

void

Called when a MediaCodec has been released.

void

Called when the renderer is disabled.

void
onEnabled(boolean joining, boolean mayRenderStartOfStream)

Called when the renderer is enabled.

@Nullable DecoderReuseEvaluation

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

void

Called when one of the output formats changes.

void
onOutputStreamOffsetUsChanged(long outputStreamOffsetUs)

Called after the output stream offset changes.

void
onPositionReset(long positionUs, boolean joining)

Called when the position is reset.

void
@CallSuper
onProcessedOutputBuffer(long presentationTimeUs)

Called when an output buffer is successfully processed.

void

Called after the last output buffer before a stream change has been processed.

void

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

void

Called when ready to initialize the MediaCodecAdapter.

void

Called when the renderer is reset.

void

Called when the renderer is started.

void

Called when the renderer is stopped.

void
onStreamChanged(
    Format[] formats,
    long startPositionUs,
    long offsetUs,
    MediaSource.MediaPeriodId mediaPeriodId
)

Called when the renderer's stream has changed.

abstract boolean
processOutputBuffer(
    long positionUs,
    long elapsedRealtimeUs,
    @Nullable MediaCodecAdapter codec,
    @Nullable ByteBuffer buffer,
    int bufferIndex,
    int bufferFlags,
    int sampleCount,
    long bufferPresentationTimeUs,
    boolean isDecodeOnlyBuffer,
    boolean isLastBuffer,
    Format format
)

Processes an output media buffer.

void
void

Incrementally renders any remaining output.

void

Resets the renderer internal state after a codec flush.

void

Resets the renderer internal state after a codec release.

final void

Notifies the renderer that output end of stream is pending and should be handled on the next render.

final void

Sets an exception to be re-thrown by render.

boolean
boolean

Returns whether the renderer needs to re-initialize the codec, possibly as a result of a change in device capabilities.

boolean

Returns whether the input buffer should be skipped before the decoder.

boolean

Returns whether buffers in the input format can be processed without a codec.

abstract int

Returns the Capabilities for the given Format.

static boolean

Returns whether this renderer supports the given Format's DRM scheme.

final boolean

Updates the codec operating rate, or triggers codec release and re-initialization if a previously set operating rate needs to be cleared.

final void
updateOutputFormatForTime(long presentationTimeUs)

Updates the output formats for the specified output buffer timestamp, calling onOutputFormatChanged if a change has occurred.

Inherited Constants

From androidx.media3.exoplayer.Renderer
static final long

Default minimum duration that the playback clock must advance before render can make progress.

static final int

Applications or extensions may define custom MSG_* constants that can be passed to renderers.

static final int

A type of a message that can be passed to an audio renderer via createMessage.

static final int

The type of a message that can be passed to audio and video renderers via createMessage.

static final int

A type of a message that can be passed to an audio renderer via createMessage.

static final int

The type of a message that can be passed to a camera motion renderer via createMessage.

static final int

The type of a message that can be passed to a video renderer via createMessage.

static final int

The type of message that can be passed to an image renderer to set a desired image output.

static final int

The type of a message that can be passed to audio renderers via createMessage.

static final int

The type of message that can be passed to a renderer to set its priority.

static final int

The type of a message that can be passed to a MediaCodec-based video renderer via createMessage.

static final int

The type of a message that can be passed to an audio renderer via createMessage.

static final int

The type of a message that can be passed to a video renderer.

static final int

The type of a message that can be passed to a video renderer via createMessage.

static final int

The type of a message that can be passed to a video renderer via createMessage.

static final int

The type of a message that can be passed to a video renderer to set the desired output resolution.

static final int

A type of a message that can be passed to an audio renderer via createMessage.

static final int

The type of a message that can be passed to a Renderer via createMessage, to inform the renderer that it can schedule waking up another component.

static final int

The renderer is disabled.

static final int

The renderer is enabled but not started.

static final int

The renderer is started.

From androidx.media3.exoplayer.RendererCapabilities
static final int

The Renderer can adapt between formats, but may suffer a brief discontinuity (~50-100ms) when adaptation occurs.

static final int

The Renderer does not support adaptation between formats.

static final int

The Renderer can seamlessly adapt between formats.

static final int

A mask to apply to Capabilities to obtain the AdaptiveSupport only.

static final int

The renderer supports audio offload and gapless transitions with this format.

static final int

Audio offload is not supported with this format.

static final int

The renderer supports audio offload and speed changes with this format.

static final int

The renderer supports audio offload with this format.

static final int

A mask to apply to Capabilities to obtain AudioOffloadSupport only.

static final int

The format exceeds the primary decoder's capabilities but is supported by fallback decoder

static final int

The format's MIME type is unsupported and the renderer may use a decoder for a fallback MIME type.

static final int

A mask to apply to Capabilities to obtain DecoderSupport only.

static final int

The renderer is able to use the primary decoder for the format's MIME type.

static final int

A mask to apply to Capabilities to obtain the C.FormatSupport only.

static final int

The renderer is not able to use hardware acceleration.

static final int

The renderer is able to use hardware acceleration.

static final int

A mask to apply to Capabilities to obtain HardwareAccelerationSupport only.

static final int

The Renderer does not support tunneled output.

static final int

The Renderer supports tunneled output.

static final int

A mask to apply to Capabilities to obtain TunnelingSupport only.

Inherited methods

From androidx.media3.exoplayer.BaseRenderer
final void

Clears the Listener.

final ExoPlaybackException
createRendererException(
    Throwable cause,
    @Nullable Format format,
    @PlaybackException.ErrorCode int errorCode
)

Creates an ExoPlaybackException of type TYPE_RENDERER for this renderer.

final ExoPlaybackException
createRendererException(
    Throwable cause,
    @Nullable Format format,
    boolean isRecoverable,
    @PlaybackException.ErrorCode int errorCode
)

Creates an ExoPlaybackException of type TYPE_RENDERER for this renderer.

final void

Disable the renderer, transitioning it to the STATE_DISABLED state.

final void
enable(
    RendererConfiguration configuration,
    Format[] formats,
    SampleStream stream,
    long positionUs,
    boolean joining,
    boolean mayRenderStartOfStream,
    long startPositionUs,
    long offsetUs,
    MediaSource.MediaPeriodId mediaPeriodId
)

Enables the renderer to consume from the specified SampleStream.

final RendererCapabilities

Returns the capabilities of the renderer.

final Clock

Returns the Clock.

final RendererConfiguration

Returns the configuration set when the renderer was most recently enabled.

final FormatHolder

Returns a clear FormatHolder.

final int

Returns the index of the renderer within the player.

final long

Returns the position passed to the most recent call to enable or resetPosition.

@Nullable MediaClock

If the renderer advances its own playback position then this method returns a corresponding MediaClock.

final PlayerId

Returns the PlayerId of the player using this renderer.

final long

Returns the renderer time up to which the renderer has read samples, in microseconds, or TIME_END_OF_SOURCE if the renderer has read the current SampleStream to the end.

final int

Returns the current state of the renderer.

final @Nullable SampleStream

Returns the SampleStream being consumed, or null if the renderer is disabled.

final Format[]

Returns the formats of the currently enabled stream.

final long

Returns the offset added to timestamps of buffers read from the SampleStream.

final Timeline

Returns the current Timeline containing the rendered stream.

final int

Returns the track type that the renderer handles.

final boolean

Returns whether the renderer has read the current SampleStream to the end.

final void
init(int index, PlayerId playerId, Clock clock)

Initializes the renderer for playback with a player.

final boolean

Returns whether the current SampleStream will be the final one supplied before the renderer is next disabled or reset.

final boolean

Returns whether the upstream source is ready.

final void

Throws an error that's preventing the renderer from reading from its SampleStream.

void

Called when the renderer is initialized.

void

Called when the renderer is released.

final void

Called when the renderer capabilities are changed.

void

Called when a new timeline is set.

final int
@SampleStream.ReadDataResult
readSource(
    FormatHolder formatHolder,
    DecoderInputBuffer buffer,
    @SampleStream.ReadFlags int readFlags
)

Reads from the enabled upstream source.

final void

Releases the renderer.

final void
replaceStream(
    Format[] formats,
    SampleStream stream,
    long startPositionUs,
    long offsetUs,
    MediaSource.MediaPeriodId mediaPeriodId
)

Replaces the SampleStream from which samples will be consumed.

final void

Forces the renderer to give up any resources (e.g. media decoders) that it may be holding.

final void
resetPosition(long positionUs)

Signals to the renderer that a position discontinuity has occurred.

final void

Signals to the renderer that the current SampleStream will be the final one supplied before it is next disabled or reset.

final void

Sets the Listener.

final void

Sets the timeline that is currently being played.

int
skipSource(long positionUs)

Attempts to skip to the keyframe before the specified position, or to the end of the stream if positionUs is beyond it.

final void

Starts the renderer, meaning that calls to render will cause media to be rendered.

final void

Stops the renderer, transitioning it to the STATE_ENABLED state.

From androidx.media3.exoplayer.Renderer
abstract void
enable(
    RendererConfiguration configuration,
    Format[] formats,
    SampleStream stream,
    long positionUs,
    boolean joining,
    boolean mayRenderStartOfStream,
    long startPositionUs,
    long offsetUs,
    MediaSource.MediaPeriodId mediaPeriodId
)

Enables the renderer to consume from the specified SampleStream.

void

Enables this renderer to render the start of the stream even if the state is not STATE_STARTED yet.

abstract String

Returns the name of this renderer, for logging and debugging purposes.

abstract void
replaceStream(
    Format[] formats,
    SampleStream stream,
    long startPositionUs,
    long offsetUs,
    MediaSource.MediaPeriodId mediaPeriodId
)

Replaces the SampleStream from which samples will be consumed.

From androidx.media3.exoplayer.RendererCapabilities
static int

Returns Capabilities for the given C.FormatSupport.

static int
@RendererCapabilities.Capabilities
create(
    @C.FormatSupport int formatSupport,
    @RendererCapabilities.AdaptiveSupport int adaptiveSupport,
    @RendererCapabilities.TunnelingSupport int tunnelingSupport
)

Returns Capabilities combining the given C.FormatSupport, and TunnelingSupport.

static int
@RendererCapabilities.Capabilities
create(
    @C.FormatSupport int formatSupport,
    @RendererCapabilities.AdaptiveSupport int adaptiveSupport,
    @RendererCapabilities.TunnelingSupport int tunnelingSupport,
    @RendererCapabilities.AudioOffloadSupport int audioOffloadSupport
)

Returns Capabilities combining the given C.FormatSupport, , TunnelingSupport, and AudioOffloadSupport.

static int
@RendererCapabilities.Capabilities
create(
    @C.FormatSupport int formatSupport,
    @RendererCapabilities.AdaptiveSupport int adaptiveSupport,
    @RendererCapabilities.TunnelingSupport int tunnelingSupport,
    @RendererCapabilities.HardwareAccelerationSupport int hardwareAccelerationSupport,
    @RendererCapabilities.DecoderSupport int decoderSupport
)

Returns Capabilities combining the given C.FormatSupport, , TunnelingSupport, HardwareAccelerationSupport, and .

static int
@RendererCapabilities.Capabilities
create(
    @C.FormatSupport int formatSupport,
    @RendererCapabilities.AdaptiveSupport int adaptiveSupport,
    @RendererCapabilities.TunnelingSupport int tunnelingSupport,
    @RendererCapabilities.HardwareAccelerationSupport int hardwareAccelerationSupport,
    @RendererCapabilities.DecoderSupport int decoderSupport,
    @RendererCapabilities.AudioOffloadSupport int audioOffloadSupport
)

Returns Capabilities combining the given C.FormatSupport, , TunnelingSupport, HardwareAccelerationSupport, and AudioOffloadSupport.

static int

Returns the AdaptiveSupport from the combined Capabilities.

static int

Returns the AudioOffloadSupport from the combined Capabilities.

static int

Returns the DecoderSupport from the combined Capabilities.

static int

Returns the C.FormatSupport from the combined Capabilities.

static int

Returns the HardwareAccelerationSupport from the combined Capabilities.

static int

Returns the TunnelingSupport from the combined Capabilities.

static boolean
isFormatSupported(
    @RendererCapabilities.Capabilities int supportFlags,
    boolean allowExceedsCapabilities
)

Returns whether the C.FormatSupport from the combined Capabilities indicates the format is supported.

void

Sets the Listener.

Constants

CODEC_OPERATING_RATE_UNSET

protected static final float CODEC_OPERATING_RATE_UNSET = -1.0f

Indicates no codec operating rate should be set.

Protected fields

codec

protected @Nullable MediaCodecAdapter codec

codecInfo

protected @Nullable MediaCodecInfo codecInfo

codecNeedsEosPropagation

protected boolean codecNeedsEosPropagation

codecOperatingRate

protected float codecOperatingRate

codecOutputMediaFormat

protected @Nullable MediaFormat codecOutputMediaFormat

decoderCounters

protected DecoderCounters decoderCounters

lastBufferInStreamPresentationTimeUs

protected long lastBufferInStreamPresentationTimeUs

wakeupListener

protected @Nullable Renderer.WakeupListener wakeupListener

Public constructors

MediaCodecRenderer

public MediaCodecRenderer(
    @C.TrackType int trackType,
    MediaCodecAdapter.Factory codecAdapterFactory,
    MediaCodecSelector mediaCodecSelector,
    boolean enableDecoderFallback,
    float assumedMinimumCodecOperatingRate
)
Parameters
@C.TrackType int trackType

The track type that the renderer handles.

MediaCodecAdapter.Factory codecAdapterFactory

A factory for MediaCodecAdapter instances.

MediaCodecSelector mediaCodecSelector

A decoder selector.

boolean enableDecoderFallback

Whether to enable fallback to lower-priority decoders if decoder initialization fails. This may result in using a decoder that is less efficient or slower than the primary decoder.

float assumedMinimumCodecOperatingRate

A codec operating rate that all codecs instantiated by this renderer are assumed to meet implicitly (i.e. without the operating rate being set explicitly using KEY_OPERATING_RATE).

Public methods

experimentalEnableProcessedStreamChangedAtStart

public void experimentalEnableProcessedStreamChangedAtStart()

Enables the renderer to invoke onProcessedStreamChange on the first stream.

When not enabled, onProcessedStreamChange is invoked from the second stream onwards.

getDurationToProgressUs

public final long getDurationToProgressUs(long positionUs, long elapsedRealtimeUs)

Returns minimum amount of playback clock time that must pass in order for the render call to make progress.

The default return time is DEFAULT_DURATION_TO_PROGRESS_US.

Parameters
long positionUs

The current render position in microseconds, measured at the start of the current iteration of the rendering loop.

long elapsedRealtimeUs

elapsedRealtime in microseconds, measured at the start of the current iteration of the rendering loop.

Returns
long

Minimum amount of playback clock time that must pass before renderer is able to make progress.

handleMessage

public void handleMessage(
    @Renderer.MessageType int messageType,
    @Nullable Object message
)

Handles a message delivered to the target.

Parameters
@Renderer.MessageType int messageType

The message type.

@Nullable Object message

The message payload.

Throws
androidx.media3.exoplayer.ExoPlaybackException

If an error occurred whilst handling the message. Should only be thrown by targets that handle messages on the playback thread.

isEnded

public boolean isEnded()

Whether the renderer is ready for the ExoPlayer instance to transition to 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: STATE_ENABLED, STATE_STARTED.

Returns
boolean

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

isReady

public boolean isReady()

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

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

Returns
boolean

Whether the renderer is ready to render media.

render

public void render(long positionUs, long elapsedRealtimeUs)

Incrementally renders the SampleStream.

If the renderer is in the STATE_ENABLED state then each call to this method will do work toward being ready to render the SampleStream when the renderer is started. If the renderer is in the STATE_STARTED state then calls to this method will render the SampleStream in sync with the specified media positions.

The renderer may also render the very start of the media at the current position (e.g. the first frame of a video stream) while still in the STATE_ENABLED state, unless it's the initial start of the media after calling enable with mayRenderStartOfStream set to false.

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: STATE_ENABLED, STATE_STARTED.

Parameters
long positionUs

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

long elapsedRealtimeUs

elapsedRealtime in microseconds, measured at the start of the current iteration of the rendering loop.

setPlaybackSpeed

public void setPlaybackSpeed(float currentPlaybackSpeed, float targetPlaybackSpeed)

Indicates the playback speed to this renderer.

The default implementation is a no-op.

Parameters
float currentPlaybackSpeed

The factor by which playback is currently sped up.

float targetPlaybackSpeed

The target factor by which playback should be sped up. This may be different from currentPlaybackSpeed, for example, if the speed is temporarily adjusted for live playback.

Throws
androidx.media3.exoplayer.ExoPlaybackException

If an error occurs handling the playback speed.

setRenderTimeLimitMs

public void setRenderTimeLimitMs(long renderTimeLimitMs)

Sets a limit on the time a single render call can spend draining and filling the decoder.

This method should be called right after creating an instance of this class.

Parameters
long renderTimeLimitMs

The render time limit in milliseconds, or TIME_UNSET for no limit.

supportsFormat

@RendererCapabilities.Capabilities
public final int supportsFormat(Format format)

Returns the extent to which the Renderer supports a given format.

Parameters
Format format

The format.

Returns
int

The Capabilities for this format.

supportsMixedMimeTypeAdaptation

@RendererCapabilities.AdaptiveSupport
public final int supportsMixedMimeTypeAdaptation()

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

Returns
int

The AdaptiveSupport for adapting between supported formats that have different MIME types.

Protected methods

canReuseCodec

protected DecoderReuseEvaluation canReuseCodec(
    MediaCodecInfo codecInfo,
    Format oldFormat,
    Format newFormat
)

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

The default implementation does not allow decoder reuse.

Parameters
MediaCodecInfo codecInfo

A MediaCodecInfo describing the decoder.

Format oldFormat

The Format for which the existing instance is configured.

Format newFormat

The new Format.

Returns
DecoderReuseEvaluation

The result of the evaluation.

createDecoderException

protected MediaCodecDecoderException createDecoderException(
    Throwable cause,
    @Nullable MediaCodecInfo codecInfo
)

flushOrReinitializeCodec

protected final boolean flushOrReinitializeCodec()

Flushes the codec. If flushing is not possible, the codec will be released and re-instantiated. This method is a no-op if the codec is null.

The implementation of this method calls flushOrReleaseCodec, and maybeInitCodecOrBypass if the codec needs to be re-instantiated.

Returns
boolean

Whether the codec was released and reinitialized, rather than being flushed.

Throws
androidx.media3.exoplayer.ExoPlaybackException

If an error occurs re-instantiating the codec.

flushOrReleaseCodec

protected boolean flushOrReleaseCodec()

Flushes the codec. If flushing is not possible, the codec will be released. This method is a no-op if the codec is null.

Returns
boolean

Whether the codec was released.

getCodec

protected final @Nullable MediaCodecAdapter getCodec()

getCodecBufferFlags

protected int getCodecBufferFlags(DecoderInputBuffer buffer)

Returns the flags that should be set on queueInputBuffer or queueSecureInputBuffer for this buffer.

Parameters
DecoderInputBuffer buffer

The input buffer.

Returns
int

The flags to set on queueInputBuffer or queueSecureInputBuffer.

getCodecInfo

protected final @Nullable MediaCodecInfo getCodecInfo()

getCodecNeedsEosPropagation

protected boolean getCodecNeedsEosPropagation()

Returns whether the codec needs the renderer to propagate the end-of-stream signal directly, rather than by using an end-of-stream buffer queued to the codec.

getCodecOperatingRate

protected float getCodecOperatingRate()

Returns the operating rate used by the current codec

getCodecOperatingRateV23

protected float getCodecOperatingRateV23(
    float targetPlaybackSpeed,
    Format format,
    Format[] streamFormats
)

Returns the KEY_OPERATING_RATE value for a given playback speed, current Format and set of possible stream formats.

The default implementation returns CODEC_OPERATING_RATE_UNSET.

Parameters
float targetPlaybackSpeed

The target factor by which playback should be sped up. This may be different from the current playback speed, for example, if the speed is temporarily adjusted for live playback.

Format format

The Format for which the codec is being configured.

Format[] streamFormats

The possible stream formats.

Returns
float

The codec operating rate, or CODEC_OPERATING_RATE_UNSET if no codec operating rate should be set.

getCodecOutputMediaFormat

protected final @Nullable MediaFormat getCodecOutputMediaFormat()

getDecoderInfos

protected abstract List<MediaCodecInfogetDecoderInfos(
    MediaCodecSelector mediaCodecSelector,
    Format format,
    boolean requiresSecureDecoder
)

Returns a list of decoders that can decode media in the specified format, in priority order.

Parameters
MediaCodecSelector mediaCodecSelector

The decoder selector.

Format format

The Format for which a decoder is required.

boolean requiresSecureDecoder

Whether a secure decoder is required.

Returns
List<MediaCodecInfo>

A list of MediaCodecInfos corresponding to decoders. May be empty.

Throws
androidx.media3.exoplayer.mediacodec.MediaCodecUtil.DecoderQueryException

Thrown if there was an error querying decoders.

getDurationToProgressUs

protected long getDurationToProgressUs(
    boolean isOnBufferAvailableListenerRegistered,
    long positionUs,
    long elapsedRealtimeUs
)

Returns minimum time playback must advance in order for the render call to make progress.

If the Renderer has a registered , then the Renderer will be notified when decoder input and output buffers become available. These callbacks may affect the calculated minimum time playback must advance before a render call can make progress.

Parameters
boolean isOnBufferAvailableListenerRegistered

Whether the Renderer is using a with successfully registered OnBufferAvailableListener.

long positionUs

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

long elapsedRealtimeUs

elapsedRealtime in microseconds, measured at the start of the current iteration of the rendering loop.

Returns
long

minimum time playback must advance before renderer is able to make progress.

getLastBufferInStreamPresentationTimeUs

protected long getLastBufferInStreamPresentationTimeUs()

Returns the presentation time of the last buffer in the stream.

If the last buffer has not yet been read off the sample queue then the return value will be TIME_UNSET.

Returns
long

The presentation time of the last buffer in the stream.

getMediaCodecConfiguration

protected abstract MediaCodecAdapter.Configuration getMediaCodecConfiguration(
    MediaCodecInfo codecInfo,
    Format format,
    @Nullable MediaCrypto crypto,
    float codecOperatingRate
)

Returns the MediaCodecAdapter.Configuration that will be used to create and configure a MediaCodec to decode the given Format for a playback.

Parameters
MediaCodecInfo codecInfo

Information about the MediaCodec being configured.

Format format

The Format for which the codec is being configured.

@Nullable MediaCrypto crypto

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

float codecOperatingRate

The codec operating rate, or CODEC_OPERATING_RATE_UNSET if no codec operating rate should be set.

Returns
MediaCodecAdapter.Configuration

The parameters needed to call configure.

getOutputStreamOffsetUs

protected final long getOutputStreamOffsetUs()

Returns the offset that should be subtracted from bufferPresentationTimeUs in processOutputBuffer to get the playback position with respect to the media.

getOutputStreamStartPositionUs

protected final long getOutputStreamStartPositionUs()

Returns the start position of the current output stream in microseconds.

getPlaybackSpeed

protected float getPlaybackSpeed()

Returns the current playback speed, as set by setPlaybackSpeed.

getWakeupListener

protected final @Nullable Renderer.WakeupListener getWakeupListener()

Returns listener used to signal that render should be called.

handleInputBufferSupplementalData

protected void handleInputBufferSupplementalData(DecoderInputBuffer buffer)

Handles supplemental data associated with an input buffer.

The default implementation is a no-op.

Parameters
DecoderInputBuffer buffer

The input buffer that is about to be queued.

Throws
androidx.media3.exoplayer.ExoPlaybackException

Thrown if an error occurs handling supplemental data.

isBypassEnabled

protected final boolean isBypassEnabled()

Returns whether bypass is enabled by the renderer.

isBypassPossible

protected final boolean isBypassPossible(Format format)

Returns whether buffers in the input format can be processed without a codec.

This method returns the possibility of bypass mode with checking both the renderer capabilities and DRM protection.

Parameters
Format format

The input Format.

Returns
boolean

Whether playback bypassing MediaCodec is possible.

maybeInitCodecOrBypass

protected final void maybeInitCodecOrBypass()

onCodecError

protected void onCodecError(Exception codecError)

Called when a codec error has occurred.

The default implementation is a no-op.

Parameters
Exception codecError

The error.

onCodecInitialized

protected void onCodecInitialized(
    String name,
    MediaCodecAdapter.Configuration configuration,
    long initializedTimestampMs,
    long initializationDurationMs
)

Called when a MediaCodec has been created and configured.

The default implementation is a no-op.

Parameters
String name

The name of the codec that was initialized.

MediaCodecAdapter.Configuration configuration

The MediaCodecAdapter.Configuration used to configure the codec.

long initializedTimestampMs

elapsedRealtime when initialization finished.

long initializationDurationMs

The time taken to initialize the codec in milliseconds.

onCodecReleased

protected void onCodecReleased(String name)

Called when a MediaCodec has been released.

The default implementation is a no-op.

Parameters
String name

The name of the codec that was released.

onDisabled

protected void onDisabled()

Called when the renderer is disabled.

The default implementation is a no-op.

onEnabled

protected void onEnabled(boolean joining, boolean mayRenderStartOfStream)

Called when the renderer is enabled.

The default implementation is a no-op.

Parameters
boolean joining

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

boolean mayRenderStartOfStream

Whether this renderer is allowed to render the start of the stream even if the state is not STATE_STARTED yet.

onInputFormatChanged

@CallSuper
protected @Nullable DecoderReuseEvaluation onInputFormatChanged(FormatHolder formatHolder)

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

Parameters
FormatHolder formatHolder

A FormatHolder that holds the new Format.

Returns
@Nullable DecoderReuseEvaluation

The result of the evaluation to determine whether the existing decoder instance can be reused for the new format, or null if the renderer did not have a decoder.

Throws
androidx.media3.exoplayer.ExoPlaybackException

If an error occurs re-initializing the MediaCodec.

onOutputFormatChanged

protected void onOutputFormatChanged(Format format, @Nullable MediaFormat mediaFormat)

Called when one of the output formats changes.

The default implementation is a no-op.

Parameters
Format format

The input Format to which future output now corresponds. If the renderer is in bypass mode, this is also the output format.

@Nullable MediaFormat mediaFormat

The codec output MediaFormat, or null if the renderer is in bypass mode.

Throws
androidx.media3.exoplayer.ExoPlaybackException

Thrown if an error occurs configuring the output.

onOutputStreamOffsetUsChanged

protected void onOutputStreamOffsetUsChanged(long outputStreamOffsetUs)

Called after the output stream offset changes.

The default implementation is a no-op.

Parameters
long outputStreamOffsetUs

The output stream offset in microseconds.

onPositionReset

protected void onPositionReset(long positionUs, boolean joining)

Called when the position is reset. This occurs when the renderer is enabled after onStreamChanged 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.

Parameters
long positionUs

The new playback position in microseconds.

boolean joining

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

onProcessedOutputBuffer

@CallSuper
protected void onProcessedOutputBuffer(long presentationTimeUs)

Called when an output buffer is successfully processed.

Parameters
long presentationTimeUs

The timestamp associated with the output buffer.

onProcessedStreamChange

protected void onProcessedStreamChange()

Called after the last output buffer before a stream change has been processed.

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
DecoderInputBuffer buffer

The buffer to be queued.

Throws
androidx.media3.exoplayer.ExoPlaybackException

Thrown if an error occurs handling the input buffer.

onReadyToInitializeCodec

protected void onReadyToInitializeCodec(Format format)

Called when ready to initialize the MediaCodecAdapter.

This method is called just before the renderer obtains the configuration for the MediaCodecAdapter and creates the adapter via the passed in MediaCodecAdapter.Factory.

The default implementation is a no-op.

Parameters
Format format

The Format for which the codec is being configured.

Throws
androidx.media3.exoplayer.ExoPlaybackException

If an error occurs preparing for initializing the codec.

onReset

protected void onReset()

Called when the renderer is reset.

The default implementation is a no-op.

onStarted

protected void onStarted()

Called when the renderer is started.

The default implementation is a no-op.

onStopped

protected void onStopped()

Called when the renderer is stopped.

The default implementation is a no-op.

onStreamChanged

protected void onStreamChanged(
    Format[] formats,
    long startPositionUs,
    long offsetUs,
    MediaSource.MediaPeriodId mediaPeriodId
)

Called when the renderer's stream has changed. This occurs when the renderer is enabled after onEnabled 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.

Parameters
Format[] formats

The enabled formats.

long startPositionUs

The start position of the new stream in renderer time (microseconds).

long offsetUs

The offset that will be added to the timestamps of buffers read via readSource so that decoder input buffers have monotonically increasing timestamps.

MediaSource.MediaPeriodId mediaPeriodId

The MediaSource.MediaPeriodId of the MediaPeriod that produces the stream.

processOutputBuffer

protected abstract boolean processOutputBuffer(
    long positionUs,
    long elapsedRealtimeUs,
    @Nullable MediaCodecAdapter codec,
    @Nullable ByteBuffer buffer,
    int bufferIndex,
    int bufferFlags,
    int sampleCount,
    long bufferPresentationTimeUs,
    boolean isDecodeOnlyBuffer,
    boolean isLastBuffer,
    Format format
)

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 will always receive a new ByteBuffer to be processed.

Parameters
long positionUs

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

long elapsedRealtimeUs

elapsedRealtime in microseconds, measured at the start of the current iteration of the rendering loop.

@Nullable MediaCodecAdapter codec

The MediaCodecAdapter instance, or null in bypass mode were no codec is used.

@Nullable ByteBuffer buffer

The output buffer to process, or null if the buffer data is not made available to the application layer (see getOutputBuffer). This buffer can only be null for video data. Note that the buffer data can still be rendered in this case by using the bufferIndex.

int bufferIndex

The index of the output buffer.

int bufferFlags

The flags attached to the output buffer.

int sampleCount

The number of samples extracted from the sample queue in the buffer. This allows handling multiple samples as a batch for efficiency.

long bufferPresentationTimeUs

The presentation time of the output buffer in microseconds.

boolean isDecodeOnlyBuffer

Whether the buffer timestamp is less than the intended playback start position.

boolean isLastBuffer

Whether the buffer is known to contain the last sample of the current stream. This flag is set on a best effort basis, and any logic relying on it should degrade gracefully to handle cases where it's not set.

Format format

The Format associated with the buffer.

Returns
boolean

Whether the output buffer was fully processed (for example, rendered or skipped).

Throws
androidx.media3.exoplayer.ExoPlaybackException

If an error occurs processing the output buffer.

releaseCodec

protected void releaseCodec()

renderToEndOfStream

protected void renderToEndOfStream()

Incrementally renders any remaining output.

The default implementation is a no-op.

Throws
androidx.media3.exoplayer.ExoPlaybackException

Thrown if an error occurs rendering remaining output.

resetCodecStateForFlush

@CallSuper
protected void resetCodecStateForFlush()

Resets the renderer internal state after a codec flush.

resetCodecStateForRelease

@CallSuper
protected void resetCodecStateForRelease()

Resets the renderer internal state after a codec release.

Note that this only needs to reset state variables that are changed in addition to those already changed in resetCodecStateForFlush.

setPendingOutputEndOfStream

protected final void setPendingOutputEndOfStream()

Notifies the renderer that output end of stream is pending and should be handled on the next render.

setPendingPlaybackException

protected final void setPendingPlaybackException(ExoPlaybackException exception)

Sets an exception to be re-thrown by render.

Parameters
ExoPlaybackException exception

The exception.

shouldInitCodec

protected boolean shouldInitCodec(MediaCodecInfo codecInfo)

shouldReinitCodec

protected boolean shouldReinitCodec()

Returns whether the renderer needs to re-initialize the codec, possibly as a result of a change in device capabilities.

shouldSkipDecoderInputBuffer

protected boolean shouldSkipDecoderInputBuffer(DecoderInputBuffer buffer)

Returns whether the input buffer should be skipped before the decoder.

This can be used to skip decoding of buffers that are not depended on during seeking. See BUFFER_FLAG_NOT_DEPENDED_ON.

Parameters
DecoderInputBuffer buffer

The input buffer.

shouldUseBypass

protected boolean shouldUseBypass(Format format)

Returns whether buffers in the input format can be processed without a codec.

This method is only called if the content is not DRM protected, because if the content is DRM protected use of bypass is never possible.

Parameters
Format format

The input Format.

Returns
boolean

Whether playback bypassing MediaCodec is supported.

supportsFormat

@RendererCapabilities.Capabilities
protected abstract int supportsFormat(MediaCodecSelector mediaCodecSelector, Format format)

Returns the Capabilities for the given Format.

Parameters
MediaCodecSelector mediaCodecSelector

The decoder selector.

Format format

The Format.

Returns
int

The Capabilities for this Format.

Throws
androidx.media3.exoplayer.mediacodec.MediaCodecUtil.DecoderQueryException

If there was an error querying decoders.

supportsFormatDrm

protected static boolean supportsFormatDrm(Format format)

Returns whether this renderer supports the given Format's DRM scheme.

updateCodecOperatingRate

protected final boolean updateCodecOperatingRate()

Updates the codec operating rate, or triggers codec release and re-initialization if a previously set operating rate needs to be cleared.

Returns
boolean

False if codec release and re-initialization was triggered. True in all other cases.

Throws
androidx.media3.exoplayer.ExoPlaybackException

If an error occurs releasing or initializing a codec.

updateOutputFormatForTime

protected final void updateOutputFormatForTime(long presentationTimeUs)

Updates the output formats for the specified output buffer timestamp, calling onOutputFormatChanged if a change has occurred.

Subclasses should only call this method if operating in a mode where buffers are not dequeued from the decoder, for example when using video tunneling).

Throws
androidx.media3.exoplayer.ExoPlaybackException

Thrown if an error occurs as a result of the output format change.