public 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:
C.MSG_SET_VOLUME to set the volume. The message payload should be
a Float with 0 being silence and 1 being unity gain.
C.MSG_SET_AUDIO_ATTRIBUTES to set the audio attributes. The
message payload should be an AudioAttributes
instance that will configure the underlying audio track.
C.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.
MediaCodecRenderer.DecoderInitializationException, MediaCodecRenderer.KeepCodecResultRenderer.StateCODEC_OPERATING_RATE_UNSET, decoderCounters, KEEP_CODEC_RESULT_NO, KEEP_CODEC_RESULT_YES_WITH_RECONFIGURATION, KEEP_CODEC_RESULT_YES_WITHOUT_RECONFIGURATIONSTATE_DISABLED, STATE_ENABLED, STATE_STARTEDADAPTIVE_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 and Description |
|---|
MediaCodecAudioRenderer(android.content.Context context,
MediaCodecSelector mediaCodecSelector) |
MediaCodecAudioRenderer(android.content.Context context,
MediaCodecSelector mediaCodecSelector,
DrmSessionManager<FrameworkMediaCrypto> drmSessionManager,
boolean playClearSamplesWithoutKeys) |
MediaCodecAudioRenderer(android.content.Context context,
MediaCodecSelector mediaCodecSelector,
DrmSessionManager<FrameworkMediaCrypto> drmSessionManager,
boolean playClearSamplesWithoutKeys,
android.os.Handler eventHandler,
AudioRendererEventListener eventListener) |
MediaCodecAudioRenderer(android.content.Context context,
MediaCodecSelector mediaCodecSelector,
DrmSessionManager<FrameworkMediaCrypto> drmSessionManager,
boolean playClearSamplesWithoutKeys,
android.os.Handler eventHandler,
AudioRendererEventListener eventListener,
AudioCapabilities audioCapabilities,
AudioProcessor... audioProcessors) |
MediaCodecAudioRenderer(android.content.Context context,
MediaCodecSelector mediaCodecSelector,
DrmSessionManager<FrameworkMediaCrypto> drmSessionManager,
boolean playClearSamplesWithoutKeys,
android.os.Handler eventHandler,
AudioRendererEventListener eventListener,
AudioSink audioSink) |
MediaCodecAudioRenderer(android.content.Context context,
MediaCodecSelector mediaCodecSelector,
android.os.Handler eventHandler,
AudioRendererEventListener eventListener) |
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
allowPassthrough(int channelCount,
java.lang.String mimeType)
Returns whether encoded audio passthrough should be used for playing back the input format.
|
protected int |
canKeepCodec(android.media.MediaCodec codec,
MediaCodecInfo codecInfo,
Format oldFormat,
Format newFormat)
Determines whether the existing
MediaCodec can be kept for a new format, and if it can
whether it requires reconfiguration. |
protected void |
configureCodec(MediaCodecInfo codecInfo,
android.media.MediaCodec codec,
Format format,
android.media.MediaCrypto crypto,
float codecOperatingRate)
Configures a newly created
MediaCodec. |
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 |
getCodecOperatingRate(float operatingRate,
Format format,
Format[] streamFormats)
Returns the
MediaFormat.KEY_OPERATING_RATE value for a given renderer operating rate,
current format and set of possible stream formats. |
protected java.util.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 android.media.MediaFormat |
getMediaFormat(Format format,
java.lang.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. |
PlaybackParameters |
getPlaybackParameters()
Returns the active playback parameters.
|
long |
getPositionUs()
Returns the current media position in microseconds.
|
void |
handleMessage(int messageType,
java.lang.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 |
onAudioSessionId(int audioSessionId)
Called when the audio session id becomes known.
|
protected void |
onAudioTrackPositionDiscontinuity() |
protected void |
onAudioTrackUnderrun(int bufferSize,
long bufferSizeMs,
long elapsedSinceLastFeedMs) |
protected void |
onCodecInitialized(java.lang.String name,
long initializedTimestampMs,
long initializationDurationMs)
Called when a
MediaCodec has been created and configured. |
protected void |
onDisabled()
Called when the renderer is disabled.
|
protected void |
onEnabled(boolean joining)
Called when the renderer is enabled.
|
protected void |
onInputFormatChanged(Format newFormat)
Called when a new format is read from the upstream
MediaPeriod. |
protected void |
onOutputFormatChanged(android.media.MediaCodec codec,
android.media.MediaFormat outputFormat)
Called when the output format of the
MediaCodec changes. |
protected void |
onPositionReset(long positionUs,
boolean joining)
Called when the position is reset.
|
protected void |
onProcessedOutputBuffer(long presentationTimeUs)
Called when an output buffer is successfully processed.
|
protected void |
onQueueInputBuffer(DecoderInputBuffer buffer)
Called immediately before an input buffer is queued into the codec.
|
protected void |
onStarted()
Called when the renderer is started.
|
protected void |
onStopped()
Called when the renderer is stopped.
|
protected void |
onStreamChanged(Format[] formats,
long offsetUs)
Called when the renderer's stream has changed.
|
protected boolean |
processOutputBuffer(long positionUs,
long elapsedRealtimeUs,
android.media.MediaCodec codec,
java.nio.ByteBuffer buffer,
int bufferIndex,
int bufferFlags,
long bufferPresentationTimeUs,
boolean shouldSkip,
Format format)
Processes an output media buffer.
|
protected void |
renderToEndOfStream()
Incrementally renders any remaining output.
|
PlaybackParameters |
setPlaybackParameters(PlaybackParameters playbackParameters)
Attempts to set the playback parameters and returns the active playback parameters, which may
differ from those passed in.
|
protected int |
supportsFormat(MediaCodecSelector mediaCodecSelector,
DrmSessionManager<FrameworkMediaCrypto> drmSessionManager,
Format format)
Returns the extent to which the renderer is capable of supporting a given format.
|
flushCodec, getCodec, getCodecInfo, getCodecNeedsEosPropagation, getDequeueOutputBufferTimeoutUs, maybeInitCodec, releaseCodec, render, setOperatingRate, shouldInitCodec, supportsFormat, supportsMixedMimeTypeAdaptation, updateOutputFormatForTimedisable, enable, getCapabilities, getConfiguration, getIndex, getState, getStream, getStreamFormats, getTrackType, hasReadStreamToEnd, isCurrentStreamFinal, isSourceReady, maybeThrowStreamError, readSource, replaceStream, resetPosition, setCurrentStreamFinal, setIndex, skipSource, start, stop, supportsFormatDrmpublic MediaCodecAudioRenderer(android.content.Context context,
MediaCodecSelector mediaCodecSelector)
context - A context.mediaCodecSelector - A decoder selector.public MediaCodecAudioRenderer(android.content.Context context,
MediaCodecSelector mediaCodecSelector,
@Nullable
DrmSessionManager<FrameworkMediaCrypto> drmSessionManager,
boolean playClearSamplesWithoutKeys)
context - A context.mediaCodecSelector - A decoder selector.drmSessionManager - For use with encrypted content. May be null if support for encrypted
content is not required.playClearSamplesWithoutKeys - Encrypted media may contain clear (un-encrypted) regions.
For example a media file may start with a short clear region so as to allow playback to
begin in parallel with key acquisition. This parameter specifies whether the renderer is
permitted to play clear regions of encrypted media files before drmSessionManager
has obtained the keys necessary to decrypt encrypted regions of the media.public MediaCodecAudioRenderer(android.content.Context context,
MediaCodecSelector mediaCodecSelector,
@Nullable
android.os.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(android.content.Context context,
MediaCodecSelector mediaCodecSelector,
@Nullable
DrmSessionManager<FrameworkMediaCrypto> drmSessionManager,
boolean playClearSamplesWithoutKeys,
@Nullable
android.os.Handler eventHandler,
@Nullable
AudioRendererEventListener eventListener)
context - A context.mediaCodecSelector - A decoder selector.drmSessionManager - For use with encrypted content. May be null if support for encrypted
content is not required.playClearSamplesWithoutKeys - Encrypted media may contain clear (un-encrypted) regions.
For example a media file may start with a short clear region so as to allow playback to
begin in parallel with key acquisition. This parameter specifies whether the renderer is
permitted to play clear regions of encrypted media files before drmSessionManager
has obtained the keys necessary to decrypt encrypted regions of the media.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(android.content.Context context,
MediaCodecSelector mediaCodecSelector,
@Nullable
DrmSessionManager<FrameworkMediaCrypto> drmSessionManager,
boolean playClearSamplesWithoutKeys,
@Nullable
android.os.Handler eventHandler,
@Nullable
AudioRendererEventListener eventListener,
@Nullable
AudioCapabilities audioCapabilities,
AudioProcessor... audioProcessors)
context - A context.mediaCodecSelector - A decoder selector.drmSessionManager - For use with encrypted content. May be null if support for encrypted
content is not required.playClearSamplesWithoutKeys - Encrypted media may contain clear (un-encrypted) regions.
For example a media file may start with a short clear region so as to allow playback to
begin in parallel with key acquisition. This parameter specifies whether the renderer is
permitted to play clear regions of encrypted media files before drmSessionManager
has obtained the keys necessary to decrypt encrypted regions of the media.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(android.content.Context context,
MediaCodecSelector mediaCodecSelector,
@Nullable
DrmSessionManager<FrameworkMediaCrypto> drmSessionManager,
boolean playClearSamplesWithoutKeys,
@Nullable
android.os.Handler eventHandler,
@Nullable
AudioRendererEventListener eventListener,
AudioSink audioSink)
context - A context.mediaCodecSelector - A decoder selector.drmSessionManager - For use with encrypted content. May be null if support for encrypted
content is not required.playClearSamplesWithoutKeys - Encrypted media may contain clear (un-encrypted) regions.
For example a media file may start with a short clear region so as to allow playback to
begin in parallel with key acquisition. This parameter specifies whether the renderer is
permitted to play clear regions of encrypted media files before drmSessionManager
has obtained the keys necessary to decrypt encrypted regions of the media.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.protected int supportsFormat(MediaCodecSelector mediaCodecSelector, DrmSessionManager<FrameworkMediaCrypto> drmSessionManager, Format format) throws MediaCodecUtil.DecoderQueryException
MediaCodecRenderersupportsFormat in class MediaCodecRenderermediaCodecSelector - The decoder selector.drmSessionManager - The renderer's DrmSessionManager.format - The format.MediaCodecRenderer.supportsFormat(Format) for more detail.MediaCodecUtil.DecoderQueryException - If there was an error querying decoders.protected java.util.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 allowPassthrough(int channelCount,
java.lang.String mimeType)
AudioSink indicates that encoded audio output
is supported.channelCount - The number of channels in the input media, or Format.NO_VALUE if
not known.mimeType - The type of input media.protected void configureCodec(MediaCodecInfo codecInfo, android.media.MediaCodec codec, Format format, android.media.MediaCrypto crypto, float codecOperatingRate)
MediaCodecRendererMediaCodec.configureCodec in class MediaCodecRenderercodecInfo - Information about the MediaCodec being configured.codec - The MediaCodec 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.@MediaCodecRenderer.KeepCodecResult protected int canKeepCodec(android.media.MediaCodec codec, 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 returns MediaCodecRenderer.KEEP_CODEC_RESULT_NO.
canKeepCodec in class MediaCodecRenderercodec - The existing MediaCodec instance.codecInfo - A MediaCodecInfo describing the decoder.oldFormat - The format for which the existing instance is configured.newFormat - The new format.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 getCodecOperatingRate(float operatingRate,
Format format,
Format[] streamFormats)
MediaCodecRendererMediaFormat.KEY_OPERATING_RATE value for a given renderer operating rate,
current format and set of possible stream formats.
The default implementation returns MediaCodecRenderer.CODEC_OPERATING_RATE_UNSET.
getCodecOperatingRate in class MediaCodecRendereroperatingRate - The renderer operating rate.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(java.lang.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 onInputFormatChanged(Format newFormat) throws ExoPlaybackException
MediaCodecRendererMediaPeriod.onInputFormatChanged in class MediaCodecRenderernewFormat - The new format.ExoPlaybackException - If an error occurs reinitializing the MediaCodec.protected void onOutputFormatChanged(android.media.MediaCodec codec,
android.media.MediaFormat outputFormat)
throws ExoPlaybackException
MediaCodecRendererMediaCodec changes.
The default implementation is a no-op.
onOutputFormatChanged in class MediaCodecRenderercodec - The MediaCodec instance.outputFormat - The new output format.ExoPlaybackException - Thrown if an error occurs handling the new output format.protected void onAudioSessionId(int audioSessionId)
Virtualizer in
order to spatialize the audio channels. For this use case, any Virtualizer instances
should be released in onDisabled() (if not before).AudioSink.Listener.onAudioSessionId(int)protected void onAudioTrackPositionDiscontinuity()
protected void onAudioTrackUnderrun(int bufferSize,
long bufferSizeMs,
long elapsedSinceLastFeedMs)
protected void onEnabled(boolean joining)
throws ExoPlaybackException
BaseRendererThe default implementation is a no-op.
onEnabled in class MediaCodecRendererjoining - Whether this renderer is being enabled to join an ongoing playback.ExoPlaybackException - If an error occurs.protected void onStreamChanged(Format[] formats, long offsetUs) throws ExoPlaybackException
BaseRendererBaseRenderer.onEnabled(boolean) 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.
onStreamChanged in class BaseRendererformats - The enabled formats.offsetUs - The offset that will be added to the timestamps of buffers read via
BaseRenderer.readSource(FormatHolder, DecoderInputBuffer, boolean) so that decoder input
buffers have monotonically increasing timestamps.ExoPlaybackException - If an error occurs.protected void onPositionReset(long positionUs,
boolean joining)
throws ExoPlaybackException
BaseRendererBaseRenderer.onStreamChanged(Format[], 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 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 PlaybackParameters setPlaybackParameters(PlaybackParameters playbackParameters)
MediaClocksetPlaybackParameters in interface MediaClockplaybackParameters - The playback parameters.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.@CallSuper protected void onProcessedOutputBuffer(long presentationTimeUs)
MediaCodecRendererThe default implementation is a no-op.
onProcessedOutputBuffer in class MediaCodecRendererpresentationTimeUs - The timestamp associated with the output buffer.protected boolean processOutputBuffer(long positionUs,
long elapsedRealtimeUs,
android.media.MediaCodec codec,
java.nio.ByteBuffer buffer,
int bufferIndex,
int bufferFlags,
long bufferPresentationTimeUs,
boolean shouldSkip,
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 MediaCodec instance.buffer - The output buffer to process.bufferIndex - The index of the output buffer.bufferFlags - The flags attached to the output buffer.bufferPresentationTimeUs - The presentation time of the output buffer in microseconds.shouldSkip - Whether the buffer should be skipped (i.e. not rendered).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
java.lang.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 android.media.MediaFormat getMediaFormat(Format format, java.lang.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.