MediaCodecAudioRenderer


@UnstableApi
public class MediaCodecAudioRenderer extends MediaCodecRenderer implements MediaClock


Decodes and renders audio using MediaCodec and an AudioSink.

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

Summary

Public constructors

MediaCodecAudioRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector
)
MediaCodecAudioRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    @Nullable Handler eventHandler,
    @Nullable AudioRendererEventListener eventListener
)
MediaCodecAudioRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    @Nullable Handler eventHandler,
    @Nullable AudioRendererEventListener eventListener,
    AudioSink audioSink
)
MediaCodecAudioRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable AudioRendererEventListener eventListener,
    AudioSink audioSink
)
MediaCodecAudioRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    @Nullable Handler eventHandler,
    @Nullable AudioRendererEventListener eventListener,
    AudioCapabilities audioCapabilities,
    AudioProcessor[] audioProcessors
)

This method is deprecated.

Use a constructor without AudioCapabilities.

MediaCodecAudioRenderer(
    Context context,
    MediaCodecAdapter.Factory codecAdapterFactory,
    MediaCodecSelector mediaCodecSelector,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable AudioRendererEventListener eventListener,
    AudioSink audioSink
)

Creates a new instance.

MediaCodecAudioRenderer(
    Context context,
    MediaCodecAdapter.Factory codecAdapterFactory,
    MediaCodecSelector mediaCodecSelector,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable AudioRendererEventListener eventListener,
    AudioSink audioSink,
    @Nullable LoudnessCodecController loudnessCodecController
)

Creates a new instance.

Public methods

@Nullable MediaClock

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

String

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

PlaybackParameters

Returns the active playback parameters.

long

Returns the current media position in microseconds.

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

Handles a message delivered to the target.

boolean

Returns whether there is a skipped silence since the last call to this method.

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

Attempts to set the playback parameters.

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.

int
getCodecMaxInputSize(
    MediaCodecInfo codecInfo,
    Format format,
    Format[] streamFormats
)

Returns a maximum input size suitable for configuring a codec for format in a way that will allow possible adaptation to other compatible formats in streamFormats.

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.

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

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

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,
    int codecMaxInputSize,
    float codecOperatingRate
)

Returns the framework MediaFormat that can be used to configure a MediaCodec for decoding the given Format for playback.

void

Handles supplemental data associated with an input buffer.

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

See onPositionDiscontinuity.

void
onPositionReset(long positionUs, boolean joining)

Called when the position is reset.

void

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

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.

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

Incrementally renders any remaining output.

boolean

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

int

Returns the Capabilities for the given Format.

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 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.

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.

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
MediaCodecDecoderException
createDecoderException(
    Throwable cause,
    @Nullable MediaCodecInfo codecInfo
)
void

Enables the renderer to invoke onProcessedStreamChange on the first stream.

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

final @Nullable MediaFormat
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.

long

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

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.

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
boolean

Initializes the processing pipeline, if needed by the implementation.

void
@CallSuper
onProcessedOutputBuffer(long presentationTimeUs)

Called when an output buffer is successfully processed.

void

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

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.

void
void
render(long positionUs, long elapsedRealtimeUs)

Incrementally renders the SampleStream.

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.

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.

boolean

Returns whether the input buffer should be discarded before decoding.

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.

final int

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

static boolean

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

final int

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

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.

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 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.

Public constructors

MediaCodecAudioRenderer

public MediaCodecAudioRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector
)
Parameters
Context context

A context.

MediaCodecSelector mediaCodecSelector

A decoder selector.

MediaCodecAudioRenderer

public MediaCodecAudioRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    @Nullable Handler eventHandler,
    @Nullable AudioRendererEventListener eventListener
)
Parameters
Context context

A context.

MediaCodecSelector mediaCodecSelector

A decoder selector.

@Nullable Handler eventHandler

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

@Nullable AudioRendererEventListener eventListener

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

MediaCodecAudioRenderer

public MediaCodecAudioRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    @Nullable Handler eventHandler,
    @Nullable AudioRendererEventListener eventListener,
    AudioSink audioSink
)
Parameters
Context context

A context.

MediaCodecSelector mediaCodecSelector

A decoder selector.

@Nullable Handler eventHandler

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

@Nullable AudioRendererEventListener eventListener

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

AudioSink audioSink

The sink to which audio will be output.

MediaCodecAudioRenderer

public MediaCodecAudioRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable AudioRendererEventListener eventListener,
    AudioSink audioSink
)
Parameters
Context context

A context.

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 slower/less efficient than the primary decoder.

@Nullable Handler eventHandler

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

@Nullable AudioRendererEventListener eventListener

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

AudioSink audioSink

The sink to which audio will be output.

MediaCodecAudioRenderer

public MediaCodecAudioRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    @Nullable Handler eventHandler,
    @Nullable AudioRendererEventListener eventListener,
    AudioCapabilities audioCapabilities,
    AudioProcessor[] audioProcessors
)

MediaCodecAudioRenderer

public MediaCodecAudioRenderer(
    Context context,
    MediaCodecAdapter.Factory codecAdapterFactory,
    MediaCodecSelector mediaCodecSelector,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable AudioRendererEventListener eventListener,
    AudioSink audioSink
)

Creates a new instance.

Parameters
Context context

A context.

MediaCodecAdapter.Factory codecAdapterFactory

The MediaCodecAdapter.Factory used to create 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 slower/less efficient than the primary decoder.

@Nullable Handler eventHandler

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

@Nullable AudioRendererEventListener eventListener

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

AudioSink audioSink

The sink to which audio will be output.

MediaCodecAudioRenderer

public MediaCodecAudioRenderer(
    Context context,
    MediaCodecAdapter.Factory codecAdapterFactory,
    MediaCodecSelector mediaCodecSelector,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable AudioRendererEventListener eventListener,
    AudioSink audioSink,
    @Nullable LoudnessCodecController loudnessCodecController
)

Creates a new instance.

Parameters
Context context

A context.

MediaCodecAdapter.Factory codecAdapterFactory

The MediaCodecAdapter.Factory used to create 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 slower/less efficient than the primary decoder.

@Nullable Handler eventHandler

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

@Nullable AudioRendererEventListener eventListener

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

AudioSink audioSink

The sink to which audio will be output.

@Nullable LoudnessCodecController loudnessCodecController

The LoudnessCodecController, or null to not control loudness.

Public methods

getMediaClock

public @Nullable MediaClock getMediaClock()

If the renderer advances its own playback position then this method returns a corresponding MediaClock. If provided, the player will use the returned MediaClock as its source of time during playback. A player may have at most one renderer that returns a from this method.

Returns
@Nullable MediaClock

The MediaClock tracking the playback position of the renderer, or null.

getName

public String getName()

Returns the name of this renderer, for logging and debugging purposes. Should typically be the renderer's (un-obfuscated) class name.

Returns
String

The name of this renderer.

getPlaybackParameters

public PlaybackParameters getPlaybackParameters()

Returns the active playback parameters.

getPositionUs

public long getPositionUs()

Returns the current media position in microseconds.

handleMessage

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

Handles a message delivered to the target.