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 long

Default duration to progress reported if the renderer does not need calls to render to progress, if it's in STATE_ENABLED and already ready or ended.

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 message that can be passed to a renderer to direct it to enable or disable scrubbing mode.

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 type of message that can be passed to a renderer to direct it to transfer relevant resources to another renderer.

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 @Nullable MediaSource.MediaPeriodId

The MediaSource.MediaPeriodId of the MediaPeriod producing the stream, or null if the renderer is disabled.

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 u