MediaCodecVideoRenderer

@UnstableApi
public class MediaCodecVideoRenderer extends MediaCodecRenderer implements VideoFrameReleaseControl.FrameTimingEvaluator

java.lang.Object
   ↳ androidx.media3.exoplayer.BaseRenderer
     ↳ androidx.media3.exoplayer.mediacodec.MediaCodecRenderer
       ↳ androidx.media3.exoplayer.video.MediaCodecVideoRenderer

Decodes and renders video using MediaCodec.

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

Summary

Nested types

A builder to create MediaCodecVideoRenderer instances.

Public constructors
MediaCodecVideoRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector
)

This method is deprecated.

Use Builder instead.
MediaCodecVideoRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    long allowedJoiningTimeMs
)

This method is deprecated.

Use Builder instead.
MediaCodecVideoRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    long allowedJoiningTimeMs,
    @Nullable Handler eventHandler,
    @Nullable VideoRendererEventListener eventListener,
    int maxDroppedFramesToNotify
)

This method is deprecated.

Use Builder instead.
MediaCodecVideoRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    long allowedJoiningTimeMs,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable VideoRendererEventListener eventListener,
    int maxDroppedFramesToNotify
)

This method is deprecated.

Use Builder instead.
MediaCodecVideoRenderer(
    Context context,
    MediaCodecAdapter.Factory codecAdapterFactory,
    MediaCodecSelector mediaCodecSelector,
    long allowedJoiningTimeMs,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable VideoRendererEventListener eventListener,
    int maxDroppedFramesToNotify
)

This method is deprecated.

Use Builder instead.
MediaCodecVideoRenderer(
    Context context,
    MediaCodecAdapter.Factory codecAdapterFactory,
    MediaCodecSelector mediaCodecSelector,
    long allowedJoiningTimeMs,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable VideoRendererEventListener eventListener,
    int maxDroppedFramesToNotify,
    float assumedMinimumCodecOperatingRate
)

This method is deprecated.

Use Builder instead.
MediaCodecVideoRenderer(
    Context context,
    MediaCodecAdapter.Factory codecAdapterFactory,
    MediaCodecSelector mediaCodecSelector,
    long allowedJoiningTimeMs,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable VideoRendererEventListener eventListener,
    int maxDroppedFramesToNotify,
    float assumedMinimumCodecOperatingRate,
    @Nullable VideoSinkProvider videoSinkProvider
)

This method is deprecated.

Use Builder instead.
MediaCodecVideoRenderer(
    Context context,
    MediaCodecAdapter.Factory codecAdapterFactory,
    MediaCodecSelector mediaCodecSelector,
    long allowedJoiningTimeMs,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable VideoRendererEventListener eventListener,
    int maxDroppedFramesToNotify,
    float assumedMinimumCodecOperatingRate,
    @Nullable VideoSink videoSink
)

This method is deprecated.

Use Builder instead.

Protected constructors

Public methods
void

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

Returns a maximum input size for a given codec and format.
String

Returns the name of this renderer, for logging and debugging purposes.
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
@CallSuper
render(long positionUs, long elapsedRealtimeUs)

Incrementally renders the SampleStream.
void
setPlaybackSpeed(float currentPlaybackSpeed, float targetPlaybackSpeed)

Indicates the playback speed to this renderer.
void

Sets the video effects to apply.
boolean
shouldDropFrame(
    long earlyUs,
    long elapsedRealtimeUs,
    boolean isLastFrame
)

Returns whether the frame should be dropped.
boolean
shouldForceReleaseFrame(long earlyUs, long elapsedSinceLastReleaseUs)

Whether a frame should be forced for release.
boolean
shouldIgnoreFrame(
    long earlyUs,
    long positionUs,
    long elapsedRealtimeUs,
    boolean isLastFrame,
    boolean treatDroppedBuffersAsSkipped
)

Returns whether this frame should be ignored.
static int
@RendererCapabilities.Capabilities
supportsFormat(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    Format format
)

Returns the Capabilities of MediaCodecVideoRenderer for a given Format.

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.
void
changeVideoSinkInputStream(
    VideoSink videoSink,
    @VideoSink.InputType int inputType,
    Format format
)

Called when ready to <>change the input stream.
boolean

Returns whether the codec is known to implement setOutputSurface incorrectly.
MediaCodecDecoderException
createDecoderException(
    Throwable cause,
    @Nullable MediaCodecInfo codecInfo
)
void
void
dropOutputBuffer(
    MediaCodecAdapter codec,
    int index,
    long presentationTimeUs
)

Drops the output buffer with the specified index.
long

Returns the timestamp that is added to the buffer presentation time (the player decoding position) to get the frame presentation time, in microseconds.
int

Returns the flags that should be set on queueInputBuffer or queueSecureInputBuffer for this buffer.
MediaCodecVideoRenderer.CodecMaxValues
getCodecMaxValues(
    MediaCodecInfo codecInfo,
    Format format,
    Format[] streamFormats
)

Returns CodecMaxValues suitable for configuring a codec for format in a way that will allow possible adaptation to other compatible formats in streamFormats.
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
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.
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.
static int
getMaxInputSize(MediaCodecInfo codecInfo, Format format)

Returns a maximum input buffer size for a given MediaCodec and Format.
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.
MediaFormat
getMediaFormat(
    Format format,
    String codecMimeType,
    MediaCodecVideoRenderer.CodecMaxValues codecMaxValues,
    float codecOperatingRate,
    boolean deviceNeedsNoPostProcessWorkaround,
    int tunnelingAudioSessionId
)

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

Returns the output surface.
void

Handles supplemental data associated with an input buffer.
boolean
maybeDropBuffersToKeyframe(
    long positionUs,
    boolean treatDroppedBuffersAsSkipped
)

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

Initializes the processing pipeline, if needed by the implementation.
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.
void

Called when the renderer is initialized.
@Nullable DecoderReuseEvaluation

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

Called when one of the output formats 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
onProcessedTunneledBuffer(long presentationTimeUs)

Called when a buffer was processed in tunneling mode.
void

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

Called when the renderer is released.
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.
void

Called when a WakeupListener is set.
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
renderOutputBuffer(
    MediaCodecAdapter codec,
    int index,
    long presentationTimeUs
)

This method is deprecated.

Override renderOutputBufferV21 instead.
void
renderOutputBufferV21(
    MediaCodecAdapter codec,
    int index,
    long presentationTimeUs,
    long releaseTimeNs
)

Renders the output buffer with the specified index.
void

Incrementally renders any remaining output.
void

Resets the renderer internal state after a codec flush.
void
@RequiresApi(value = 23)
setOutputSurfaceV23(MediaCodecAdapter codec, Surface surface)
boolean

Returns whether the input buffer should be discarded before decoding.
boolean
shouldDropBuffersToKeyframe(
    long earlyUs,
    long elapsedRealtimeUs,
    boolean isLastBuffer
)

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,
    boolean isLastBuffer
)

Returns whether the buffer being processed should be dropped.
boolean
shouldForceRenderOutputBuffer(
    long earlyUs,
    long elapsedSinceLastRenderUs
)

Returns whether to force rendering an output buffer.
boolean
boolean

Returns whether to skip buffers that have an identical release time as the previous released buffer.
boolean
boolean
void
skipOutputBuffer(
    MediaCodecAdapter codec,
    int index,
    long presentationTimeUs
)

Skips the output buffer with the specified index.
int

Returns the Capabilities for the given Format.
void
updateDroppedBufferCounters(
    int droppedInputBufferCount,
    int droppedDecoderBufferCount
)

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

Updates local counters and DecoderCounters with a new video frame processing offset.

Inherited Constants
From androidx.media3.exoplayer.mediacodec.MediaCodecRenderer
static final float

Indicates no codec operating rate should be set.
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 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 fields
From androidx.media3.exoplayer.BaseRenderer
@MonotonicNonNull Clock
@Nullable RendererConfiguration
final FormatHolder
int
long
@MonotonicNonNull PlayerId
long
int
@Nullable SampleStream
@Nullable Format[]
long
Timeline
final int
From androidx.media3.exoplayer.mediacodec.MediaCodecRenderer
@Nullable MediaCodecAdapter
@Nullable MediaCodecInfo
float
@Nullable MediaFormat
DecoderCounters
long
@MonotonicNonNull Renderer.WakeupListener

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.
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.mediacodec.MediaCodecRenderer
void

Enables the renderer to invoke onProcessedStreamChange on the first stream.
final boolean

Flushes the codec.
boolean

Flushes the codec.
final @Nullable MediaCodecAdapter
final @Nullable MediaCodecInfo