PlayerMessage.Target, Renderer, RendererCapabilities, MediaClockpublic class MediaCodecAudioRenderer extends MediaCodecRenderer implements MediaClock
MediaCodec and an AudioSink.
This renderer accepts the following messages sent via ExoPlayer.createMessage(Target)
on the playback thread:
Renderer.MSG_SET_VOLUME to set the volume. The message payload should be
a Float with 0 being silence and 1 being unity gain.
Renderer.MSG_SET_AUDIO_ATTRIBUTES to set the audio attributes. The
message payload should be an AudioAttributes
instance that will configure the underlying audio track.
Renderer.MSG_SET_AUX_EFFECT_INFO to set the auxiliary effect. The message
payload should be an AuxEffectInfo instance that will configure the underlying
audio track.
Renderer.MSG_SET_SKIP_SILENCE_ENABLED to enable or disable skipping
silences. The message payload should be a Boolean.
Renderer.MSG_SET_AUDIO_SESSION_ID to set the audio session ID. The
message payload should be a session ID Integer that will be attached to the
underlying audio track.
MediaCodecRenderer.DecoderInitializationExceptionRenderer.State, Renderer.VideoScalingMode, Renderer.WakeupListenerRendererCapabilities.AdaptiveSupport, RendererCapabilities.Capabilities, RendererCapabilities.FormatSupport, RendererCapabilities.TunnelingSupportCODEC_OPERATING_RATE_UNSET, decoderCountersMSG_CUSTOM_BASE, MSG_SET_AUDIO_ATTRIBUTES, MSG_SET_AUDIO_SESSION_ID, MSG_SET_AUX_EFFECT_INFO, MSG_SET_CAMERA_MOTION_LISTENER, MSG_SET_SCALING_MODE, MSG_SET_SKIP_SILENCE_ENABLED, MSG_SET_SURFACE, MSG_SET_VIDEO_DECODER_OUTPUT_BUFFER_RENDERER, MSG_SET_VIDEO_FRAME_METADATA_LISTENER, MSG_SET_VOLUME, MSG_SET_WAKEUP_LISTENER, STATE_DISABLED, STATE_ENABLED, STATE_STARTED, VIDEO_SCALING_MODE_DEFAULT, VIDEO_SCALING_MODE_SCALE_TO_FIT, VIDEO_SCALING_MODE_SCALE_TO_FIT_WITH_CROPPINGADAPTIVE_NOT_SEAMLESS, ADAPTIVE_NOT_SUPPORTED, ADAPTIVE_SEAMLESS, ADAPTIVE_SUPPORT_MASK, FORMAT_EXCEEDS_CAPABILITIES, FORMAT_HANDLED, FORMAT_SUPPORT_MASK, FORMAT_UNSUPPORTED_DRM, FORMAT_UNSUPPORTED_SUBTYPE, FORMAT_UNSUPPORTED_TYPE, TUNNELING_NOT_SUPPORTED, TUNNELING_SUPPORT_MASK, TUNNELING_SUPPORTED| Constructor | Description |
|---|---|
MediaCodecAudioRenderer(Context context,
MediaCodecAdapter.Factory codecAdapterFactory,
MediaCodecSelector mediaCodecSelector,
boolean enableDecoderFallback,
Handler eventHandler,
AudioRendererEventListener eventListener,
AudioSink audioSink) |
Creates a new instance.
|
MediaCodecAudioRenderer(Context context,
MediaCodecSelector mediaCodecSelector) |
|
MediaCodecAudioRenderer(Context context,
MediaCodecSelector mediaCodecSelector,
boolean enableDecoderFallback,
Handler eventHandler,
AudioRendererEventListener eventListener,
AudioSink audioSink) |
|
MediaCodecAudioRenderer(Context context,
MediaCodecSelector mediaCodecSelector,
Handler eventHandler,
AudioRendererEventListener eventListener) |
|
MediaCodecAudioRenderer(Context context,
MediaCodecSelector mediaCodecSelector,
Handler eventHandler,
AudioRendererEventListener eventListener,
AudioCapabilities audioCapabilities,
AudioProcessor... audioProcessors) |
|
MediaCodecAudioRenderer(Context context,
MediaCodecSelector mediaCodecSelector,
Handler eventHandler,
AudioRendererEventListener eventListener,
AudioSink audioSink) |
| Modifier and Type | Method | Description |
|---|---|---|
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. |
protected void |
configureCodec(MediaCodecInfo codecInfo,
MediaCodecAdapter codec,
Format format,
MediaCrypto crypto,
float codecOperatingRate) |
Configures a newly created
MediaCodec. |
void |
experimentalSetEnableKeepAudioTrackOnSeek(boolean enableKeepAudioTrackOnSeek) |
Sets whether to enable the experimental feature that keeps and flushes the
AudioTrack when a seek occurs, as opposed to releasing and reinitialising. |
protected 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. |
protected float |
getCodecOperatingRateV23(float targetPlaybackSpeed,
Format format,
Format[] streamFormats) |
Returns the
MediaFormat.KEY_OPERATING_RATE value for a given playback speed, current
Format and set of possible stream formats. |
protected 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.
|
MediaClock |
getMediaClock() |
If the renderer advances its own playback position then this method returns a corresponding
MediaClock. |
protected 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. |
String |
getName() |
Returns the name of this renderer, for logging and debugging purposes.
|
PlaybackParameters |
getPlaybackParameters() |
Returns the active playback parameters.
|
long |
getPositionUs() |
Returns the current media position in microseconds.
|
void |
handleMessage(int messageType,
Object message) |
Handles a message delivered to the target.
|
boolean |
isEnded() |
Whether the renderer is ready for the
ExoPlayer instance to transition to Player.STATE_ENDED. |
boolean |
isReady() |
Whether the renderer is able to immediately render media from the current position.
|
protected void |
onCodecInitialized(String name,
long initializedTimestampMs,
long initializationDurationMs) |
Called when a
MediaCodec has been created and configured. |
protected void |
onCodecReleased(String name) |
Called when a
MediaCodec has been released. |
protected void |
onDisabled() |
Called when the renderer is disabled.
|
protected void |
onEnabled(boolean joining,
boolean mayRenderStartOfStream) |
Called when the renderer is enabled.
|
protected DecoderReuseEvaluation |
onInputFormatChanged(FormatHolder formatHolder) |
Called when a new
Format is read from the upstream MediaPeriod. |
protected void |
onOutputFormatChanged(Format format,
MediaFormat mediaFormat) |
Called when one of the output formats changes.
|
protected void |
onPositionDiscontinuity() |
|
protected void |
onPositionReset(long positionUs,
boolean joining) |
Called when the position is reset.
|
protected void |
onProcessedStreamChange() |
Called after the last output buffer before a stream change has been processed.
|
protected void |
onQueueInputBuffer(DecoderInputBuffer buffer) |
Called immediately before an input buffer is queued into the codec.
|
protected void |
onReset() |
Called when the renderer is reset.
|
protected void |
onStarted() |
Called when the renderer is started.
|
protected void |
onStopped() |
Called when the renderer is stopped.
|
protected boolean |
processOutputBuffer(long positionUs,
long elapsedRealtimeUs,
MediaCodecAdapter codec,
ByteBuffer buffer,
int bufferIndex,
int bufferFlags,
int sampleCount,
long bufferPresentationTimeUs,
boolean isDecodeOnlyBuffer,
boolean isLastBuffer,
Format format) |
Processes an output media buffer.
|
protected void |
renderToEndOfStream() |
Incrementally renders any remaining output.
|
void |
setPlaybackParameters(PlaybackParameters playbackParameters) |
Attempts to set the playback parameters.
|
protected boolean |
shouldUseBypass(Format format) |
Returns whether buffers in the input format can be processed without a codec.
|
protected int |
supportsFormat(MediaCodecSelector mediaCodecSelector,
Format format) |
Returns the
RendererCapabilities.Capabilities for the given Format. |
createRendererException, createRendererException, disable, enable, getCapabilities, getConfiguration, getFormatHolder, getIndex, getLastResetPositionUs, getReadingPositionUs, getState, getStream, getStreamFormats, getTrackType, hasReadStreamToEnd, isCurrentStreamFinal, isSourceReady, maybeThrowStreamError, readSource, replaceStream, reset, resetPosition, setCurrentStreamFinal, setIndex, skipSource, start, stopcreateDecoderException, experimentalSetAsynchronousBufferQueueingEnabled, experimentalSetForceAsyncQueueingSynchronizationWorkaround, experimentalSetSynchronizeCodecInteractionsWithQueueingEnabled, flushOrReinitializeCodec, flushOrReleaseCodec, getCodec, getCodecInfo, getCodecNeedsEosPropagation, getCodecOperatingRate, getCodecOutputMediaFormat, getOutputStreamOffsetUs, getPlaybackSpeed, handleInputBufferSupplementalData, legacyKeepAvailableCodecInfosWithoutCodec, maybeInitCodecOrBypass, onProcessedOutputBuffer, onStreamChanged, releaseCodec, render, resetCodecStateForFlush, resetCodecStateForRelease, setPendingOutputEndOfStream, setPendingPlaybackException, setPlaybackSpeed, setRenderTimeLimitMs, shouldInitCodec, supportsFormat, supportsFormatDrm, supportsMixedMimeTypeAdaptation, updateOutputFormatForTimeclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic MediaCodecAudioRenderer(Context context, MediaCodecSelector mediaCodecSelector)
context - A context.mediaCodecSelector - A decoder selector.public MediaCodecAudioRenderer(Context context, MediaCodecSelector mediaCodecSelector, @Nullable Handler eventHandler, @Nullable AudioRendererEventListener eventListener)
context - A context.mediaCodecSelector - A decoder selector.eventHandler - A handler to use when delivering events to eventListener. May be
null if delivery of events is not required.eventListener - A listener of events. May be null if delivery of events is not required.public MediaCodecAudioRenderer(Context context, MediaCodecSelector mediaCodecSelector, @Nullable Handler eventHandler, @Nullable AudioRendererEventListener eventListener, @Nullable AudioCapabilities audioCapabilities, AudioProcessor... audioProcessors)
context - A context.mediaCodecSelector - A decoder selector.eventHandler - A handler to use when delivering events to eventListener. May be
null if delivery of events is not required.eventListener - A listener of events. May be null if delivery of events is not required.audioCapabilities - The audio capabilities for playback on this device. May be null if the
default capabilities (no encoded audio passthrough support) should be assumed.audioProcessors - Optional AudioProcessors that will process PCM audio before
output.public MediaCodecAudioRenderer(Context context, MediaCodecSelector mediaCodecSelector, @Nullable Handler eventHandler, @Nullable AudioRendererEventListener eventListener, AudioSink audioSink)
context - A context.mediaCodecSelector - A decoder selector.eventHandler - A handler to use when delivering events to eventListener. May be
null if delivery of events is not required.eventListener - A listener of events. May be null if delivery of events is not required.audioSink - The sink to which audio will be output.public MediaCodecAudioRenderer(Context context, MediaCodecSelector mediaCodecSelector, boolean enableDecoderFallback, @Nullable Handler eventHandler, @Nullable AudioRendererEventListener eventListener, AudioSink audioSink)
context - A context.mediaCodecSelector - A decoder selector.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.eventHandler - A handler to use when delivering events to eventListener. May be
null if delivery of events is not required.eventListener - A listener of events. May be null if delivery of events is not required.audioSink - The sink to which audio will be output.public MediaCodecAudioRenderer(Context context, MediaCodecAdapter.Factory codecAdapterFactory, MediaCodecSelector mediaCodecSelector, boolean enableDecoderFallback, @Nullable Handler eventHandler, @Nullable AudioRendererEventListener eventListener, AudioSink audioSink)
context - A context.codecAdapterFactory - The MediaCodecAdapter.Factory used to create MediaCodecAdapter instances.mediaCodecSelector - A decoder selector.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.eventHandler - A handler to use when delivering events to eventListener. May be
null if delivery of events is not required.eventListener - A listener of events. May be null if delivery of events is not required.audioSink - The sink to which audio will be output.public String getName()
RenderergetName in interface RenderergetName in interface RendererCapabilitiespublic void experimentalSetEnableKeepAudioTrackOnSeek(boolean enableKeepAudioTrackOnSeek)
AudioTrack when a seek occurs, as opposed to releasing and reinitialising. Off
by default.
This method is experimental, and will be renamed or removed in a future release.
enableKeepAudioTrackOnSeek - Whether to keep the AudioTrack on seek.@Capabilities protected int supportsFormat(MediaCodecSelector mediaCodecSelector, Format format) throws MediaCodecUtil.DecoderQueryException
MediaCodecRendererRendererCapabilities.Capabilities for the given Format.supportsFormat in class MediaCodecRenderermediaCodecSelector - The decoder selector.format - The Format.RendererCapabilities.Capabilities for this Format.MediaCodecUtil.DecoderQueryException - If there was an error querying decoders.protected List<MediaCodecInfo> getDecoderInfos(MediaCodecSelector mediaCodecSelector, Format format, boolean requiresSecureDecoder) throws MediaCodecUtil.DecoderQueryException
MediaCodecRenderergetDecoderInfos in class MediaCodecRenderermediaCodecSelector - The decoder selector.format - The Format for which a decoder is required.requiresSecureDecoder - Whether a secure decoder is required.MediaCodecInfos corresponding to decoders. May be empty.MediaCodecUtil.DecoderQueryException - Thrown if there was an error querying decoders.protected boolean shouldUseBypass(Format format)
MediaCodecRendererThis method is only called if the content is not DRM protected, because if the content is DRM protected use of bypass is never possible.
shouldUseBypass in class MediaCodecRendererformat - The input Format.MediaCodec is supported.protected void configureCodec(MediaCodecInfo codecInfo, MediaCodecAdapter codec, Format format, @Nullable MediaCrypto crypto, float codecOperatingRate)
MediaCodecRendererMediaCodec.configureCodec in class MediaCodecRenderercodecInfo - Information about the MediaCodec being configured.codec - The MediaCodecAdapter to configure.format - The Format for which the codec is being configured.crypto - For drm protected playbacks, a MediaCrypto to use for decryption.codecOperatingRate - The codec operating rate, or MediaCodecRenderer.CODEC_OPERATING_RATE_UNSET if
no codec operating rate should be set.protected DecoderReuseEvaluation canReuseCodec(MediaCodecInfo codecInfo, Format oldFormat, Format newFormat)
MediaCodecRendererMediaCodec can be kept for a new Format, and if
it can whether it requires reconfiguration.
The default implementation does not allow decoder reuse.
canReuseCodec in class MediaCodecRenderercodecInfo - A MediaCodecInfo describing the decoder.oldFormat - The Format for which the existing instance is configured.newFormat - The new Format.@Nullable public MediaClock getMediaClock()
RendererMediaClock. 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 MediaClock from this method.getMediaClock in interface RenderergetMediaClock in class BaseRendererMediaClock tracking the playback position of the renderer, or null.protected float getCodecOperatingRateV23(float targetPlaybackSpeed,
Format format,
Format[] streamFormats)
MediaCodecRendererMediaFormat.KEY_OPERATING_RATE value for a given playback speed, current
Format and set of possible stream formats.
The default implementation returns MediaCodecRenderer.CODEC_OPERATING_RATE_UNSET.
getCodecOperatingRateV23 in class MediaCodecRenderertargetPlaybackSpeed - 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 - The Format for which the codec is being configured.streamFormats - The possible stream formats.MediaCodecRenderer.CODEC_OPERATING_RATE_UNSET if no codec operating
rate should be set.protected void onCodecInitialized(String name, long initializedTimestampMs, long initializationDurationMs)
MediaCodecRendererMediaCodec has been created and configured.
The default implementation is a no-op.
onCodecInitialized in class MediaCodecRenderername - The name of the codec that was initialized.initializedTimestampMs - SystemClock.elapsedRealtime() when initialization
finished.initializationDurationMs - The time taken to initialize the codec in milliseconds.protected void onCodecReleased(String name)
MediaCodecRendererMediaCodec has been released.
The default implementation is a no-op.
onCodecReleased in class MediaCodecRenderername - The name of the codec that was released.@Nullable protected DecoderReuseEvaluation onInputFormatChanged(FormatHolder formatHolder) throws ExoPlaybackException
MediaCodecRendererFormat is read from the upstream MediaPeriod.onInputFormatChanged in class MediaCodecRendererformatHolder - A FormatHolder that holds the new Format.null if the renderer did not have a decoder.ExoPlaybackException - If an error occurs re-initializing the MediaCodec.protected void onOutputFormatChanged(Format format, @Nullable MediaFormat mediaFormat) throws ExoPlaybackException
MediaCodecRendererThe default implementation is a no-op.
onOutputFormatChanged in class MediaCodecRendererformat - The input Format to which future output now corresponds. If the renderer
is in bypass mode, this is also the output format.mediaFormat - The codec output MediaFormat, or null if the renderer is in
bypass mode.ExoPlaybackException - Thrown if an error occurs configuring the output.@CallSuper protected void onPositionDiscontinuity()
protected void onEnabled(boolean joining,
boolean mayRenderStartOfStream)
throws ExoPlaybackException
BaseRendererThe default implementation is a no-op.
onEnabled in class MediaCodecRendererjoining - Whether this renderer is being enabled to join an ongoing playback.mayRenderStartOfStream - Whether this renderer is allowed to render the start of the
stream even if the state is not Renderer.STATE_STARTED yet.ExoPlaybackException - If an error occurs.protected void onPositionReset(long positionUs,
boolean joining)
throws ExoPlaybackException
BaseRendererBaseRenderer.onStreamChanged(Format[], long, long) 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.
onPositionReset in class MediaCodecRendererpositionUs - The new playback position in microseconds.joining - Whether this renderer is being enabled to join an ongoing playback.ExoPlaybackException - If an error occurs.protected void onStarted()
BaseRendererThe default implementation is a no-op.
onStarted in class MediaCodecRendererprotected void onStopped()
BaseRendererThe default implementation is a no-op.
onStopped in class MediaCodecRendererprotected void onDisabled()
BaseRendererThe default implementation is a no-op.
onDisabled in class MediaCodecRendererprotected void onReset()
BaseRendererThe default implementation is a no-op.
onReset in class MediaCodecRendererpublic boolean isEnded()
RendererExoPlayer instance to transition to Player.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: Renderer.STATE_ENABLED, Renderer.STATE_STARTED.
isEnded in interface RendererisEnded in class MediaCodecRendererpublic boolean isReady()
Renderer
If the renderer is in the Renderer.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 Renderer.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:
Renderer.STATE_ENABLED, Renderer.STATE_STARTED.
isReady in interface RendererisReady in class MediaCodecRendererpublic long getPositionUs()
MediaClockgetPositionUs in interface MediaClockpublic void setPlaybackParameters(PlaybackParameters playbackParameters)
MediaClocksetPlaybackParameters in interface MediaClockplaybackParameters - The playback parameters to attempt to set.public PlaybackParameters getPlaybackParameters()
MediaClockgetPlaybackParameters in interface MediaClockprotected void onQueueInputBuffer(DecoderInputBuffer buffer)
MediaCodecRendererThe default implementation is a no-op.
onQueueInputBuffer in class MediaCodecRendererbuffer - The buffer to be queued.protected void onProcessedStreamChange()
MediaCodecRendereronProcessedStreamChange in class MediaCodecRendererprotected 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)
throws ExoPlaybackException
MediaCodecRendererWhen 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 MediaCodecRenderer.onPositionReset(long,
boolean) will always receive a new ByteBuffer to be processed.
processOutputBuffer in class MediaCodecRendererpositionUs - The current media time in microseconds, measured at the start of the current
iteration of the rendering loop.elapsedRealtimeUs - SystemClock.elapsedRealtime() in microseconds, measured at the
start of the current iteration of the rendering loop.codec - The MediaCodecAdapter instance, or null in bypass mode were no codec is
used.buffer - The output buffer to process, or null if the buffer data is not made available to
the application layer (see MediaCodec.getOutputBuffer(int)). 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.bufferIndex - The index of the output buffer.bufferFlags - The flags attached to the output buffer.sampleCount - The number of samples extracted from the sample queue in the buffer. This
allows handling multiple samples as a batch for efficiency.bufferPresentationTimeUs - The presentation time of the output buffer in microseconds.isDecodeOnlyBuffer - Whether the buffer was marked with C.BUFFER_FLAG_DECODE_ONLY
by the source.isLastBuffer - Whether the buffer is the last sample of the current stream.format - The Format associated with the buffer.ExoPlaybackException - If an error occurs processing the output buffer.protected void renderToEndOfStream()
throws ExoPlaybackException
MediaCodecRendererThe default implementation is a no-op.
renderToEndOfStream in class MediaCodecRendererExoPlaybackException - Thrown if an error occurs rendering remaining output.public void handleMessage(int messageType,
@Nullable
Object message)
throws ExoPlaybackException
PlayerMessage.TargethandleMessage in interface PlayerMessage.TargethandleMessage in class BaseRenderermessageType - The message type.message - The message payload.ExoPlaybackException - If an error occurred whilst handling the message. Should only be
thrown by targets that handle messages on the playback thread.protected int getCodecMaxInputSize(MediaCodecInfo codecInfo, Format format, Format[] streamFormats)
format in a way that
will allow possible adaptation to other compatible formats in streamFormats.codecInfo - A MediaCodecInfo describing the decoder.format - The Format for which the codec is being configured.streamFormats - The possible stream formats.protected MediaFormat getMediaFormat(Format format, String codecMimeType, int codecMaxInputSize, float codecOperatingRate)
MediaFormat that can be used to configure a MediaCodec
for decoding the given Format for playback.format - The Format of the media.codecMimeType - The MIME type handled by the codec.codecMaxInputSize - The maximum input size supported by the codec.codecOperatingRate - The codec operating rate, or MediaCodecRenderer.CODEC_OPERATING_RATE_UNSET if
no codec operating rate should be set.MediaFormat.