DecoderVideoRenderer


@UnstableApi
public abstract class DecoderVideoRenderer extends BaseRenderer


Decodes and renders video using a Decoder.

This renderer accepts the following messages sent via createMessage on the playback thread:

Summary

Protected fields

DecoderCounters

Decoder event counters used for debugging purposes.

Protected constructors

DecoderVideoRenderer(
    long allowedJoiningTimeMs,
    @Nullable Handler eventHandler,
    @Nullable VideoRendererEventListener eventListener,
    int maxDroppedFramesToNotify
)

Public methods

void

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

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.

Protected methods

DecoderReuseEvaluation
canReuseDecoder(String decoderName, Format oldFormat, Format newFormat)

Evaluates whether the existing decoder can be reused for a new Format.

abstract Decoder<DecoderInputBufferVideoDecoderOutputBufferDecoderException>
createDecoder(Format format, @Nullable CryptoConfig cryptoConfig)

Creates a decoder for the given format.

void

Drops the specified output buffer and releases it.

void

Flushes the decoder.

boolean
maybeDropBuffersToKeyframe(long positionUs)

Drops frames from the current output buffer to the next keyframe at or before the playback position.

void

Called when the renderer is disabled.

void
onEnabled(boolean joining, boolean mayRenderStartOfStream)

Called when the renderer is enabled.

void

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

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 immediately before an input buffer is queued into the decoder.

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.

void

Releases the decoder.

void
renderOutputBuffer(
    VideoDecoderOutputBuffer outputBuffer,
    long presentationTimeUs,
    Format outputFormat
)

Renders the specified output buffer.

abstract void
renderOutputBufferToSurface(
    VideoDecoderOutputBuffer outputBuffer,
    Surface surface
)

Renders the specified output buffer to the passed surface.

abstract void

Sets output mode of the decoder.

final void

Sets the video output.

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.

boolean
shouldDropOutputBuffer(long earlyUs, long elapsedRealtimeUs)

Returns whether the buffer being processed should be dropped.

boolean
shouldForceRenderOutputBuffer(
    long earlyUs,
    long elapsedSinceLastRenderUs
)

Returns whether to force rendering an output buffer.

void

Skips the specified output buffer and releases it.

void
updateDroppedBufferCounters(
    int droppedInputBufferCount,
    int droppedDecoderBufferCount
)

Updates local counters and decoderCounters to reflect that buffers were dropped.

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 the renderer is reset.

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.

int

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

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.

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.

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.

void
setPlaybackSpeed(float currentPlaybackSpeed, float targetPlaybackSpeed)

Indicates the playback speed to this renderer.

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.

abstract int

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

Protected fields

decoderCounters

protected DecoderCounters decoderCounters

Decoder event counters used for debugging purposes.

Protected constructors

DecoderVideoRenderer

protected DecoderVideoRenderer(
    long allowedJoiningTimeMs,
    @Nullable Handler eventHandler,
    @Nullable VideoRendererEventListener eventListener,
    int maxDroppedFramesToNotify
)
Parameters
long allowedJoiningTimeMs

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

@Nullable Handler eventHandler

A handler to use when delivering events to eventListener. May be null if delivery of events is not required.

@Nullable VideoRendererEventListener eventListener

A listener of events. May be null if delivery of events is not required.

int maxDroppedFramesToNotify

The maximum number of frames that can be dropped between invocations of onDroppedFrames.

Public methods

enableMayRenderStartOfStream

public void enableMayRenderStartOfStream()

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

This is used to update the value of mayRenderStartOfStream passed to enable.

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.

Protected methods

canReuseDecoder

protected DecoderReuseEvaluation canReuseDecoder(String decoderName, Format oldFormat, Format newFormat)

Evaluates whether the existing decoder can be reused for a new Format.

The default implementation does not allow decoder reuse.

Parameters
String decoderName

The name of the decoder.

Format oldFormat

The previous format.

Format newFormat

The new format.

Returns
DecoderReuseEvaluation

The result of the evaluation.

createDecoder

protected abstract Decoder<DecoderInputBufferVideoDecoderOutputBufferDecoderExceptioncreateDecoder(Format format, @Nullable CryptoConfig cryptoConfig)

Creates a decoder for the given format.

Parameters
Format format

The format for which a decoder is required.

@Nullable CryptoConfig cryptoConfig

The CryptoConfig object required for decoding encrypted content. May be null and can be ignored if decoder does not handle encrypted content.

Throws
androidx.media3.decoder.DecoderException

If an error occurred creating a suitable decoder.

dropOutputBuffer

protected void dropOutputBuffer(VideoDecoderOutputBuffer outputBuffer)

Drops the specified output buffer and releases it.

Parameters
VideoDecoderOutputBuffer outputBuffer

The output buffer to drop.

flushDecoder

@CallSuper
protected void flushDecoder()

Flushes the decoder.

Throws
androidx.media3.exoplayer.ExoPlaybackException

If an error occurs reinitializing a decoder.

maybeDropBuffersToKeyframe

protected boolean maybeDropBuffersToKeyframe(long positionUs)

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
long positionUs

The current playback position, in microseconds.

Returns
boolean

Whether any buffers were dropped.

Throws
androidx.media3.exoplayer.ExoPlaybackException

If an error occurs flushing the decoder.

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 void onInputFormatChanged(FormatHolder formatHolder)

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

Parameters
FormatHolder formatHolder

A FormatHolder that holds the new Format.

Throws
androidx.media3.exoplayer.ExoPlaybackException

If an error occurs (re-)initializing the decoder.

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.

onQueueInputBuffer

protected void onQueueInputBuffer(DecoderInputBuffer buffer)

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

The default implementation is a no-op.

Parameters
DecoderInputBuffer buffer

The buffer that will be queued.

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.

releaseDecoder

@CallSuper
protected void releaseDecoder()

Releases the decoder.

renderOutputBuffer

protected void renderOutputBuffer(
    VideoDecoderOutputBuffer outputBuffer,
    long presentationTimeUs,
    Format outputFormat
)

Renders the specified output buffer.

The implementation of this method takes ownership of the output buffer and is responsible for calling release either immediately or in the future.

Parameters
VideoDecoderOutputBuffer outputBuffer

VideoDecoderOutputBuffer to render.

long presentationTimeUs

Presentation time in microseconds.

Format outputFormat

Output Format.

Throws
androidx.media3.decoder.DecoderException

If an error occurs when rendering the output buffer.

renderOutputBufferToSurface

protected abstract void renderOutputBufferToSurface(
    VideoDecoderOutputBuffer outputBuffer,
    Surface surface
)

Renders the specified output buffer to the passed surface.

The implementation of this method takes ownership of the output buffer and is responsible for calling release either immediately or in the future.

Parameters
VideoDecoderOutputBuffer outputBuffer

VideoDecoderOutputBuffer to render.

Surface surface

Output Surface.

Throws
androidx.media3.decoder.DecoderException

If an error occurs when rendering the output buffer.

setDecoderOutputMode

protected abstract void setDecoderOutputMode(@C.VideoOutputMode int outputMode)

Sets output mode of the decoder.

Parameters
@C.VideoOutputMode int outputMode

Output mode.

setOutput

protected final void setOutput(@Nullable Object output)

Sets the video output.

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
long earlyUs

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

long elapsedRealtimeUs

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

shouldDropOutputBuffer

protected boolean shouldDropOutputBuffer(long earlyUs, long elapsedRealtimeUs)

Returns whether the buffer being processed should be dropped.

Parameters
long earlyUs

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

long elapsedRealtimeUs

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
long earlyUs

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

long elapsedSinceLastRenderUs

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

Returns
boolean

Returns whether to force rendering an output buffer.

skipOutputBuffer

protected void skipOutputBuffer(VideoDecoderOutputBuffer outputBuffer)

Skips the specified output buffer and releases it.

Parameters
VideoDecoderOutputBuffer outputBuffer

The output buffer to skip.

updateDroppedBufferCounters

protected void updateDroppedBufferCounters(
    int droppedInputBufferCount,
    int droppedDecoderBufferCount
)

Updates local counters and decoderCounters to reflect that buffers were dropped.

Parameters
int droppedInputBufferCount

The number of buffers dropped from the source before being passed to the decoder.

int droppedDecoderBufferCount

The number of buffers dropped after being passed to the decoder.