The default value is {@code false}. * + * @deprecated Use {@link #setPcmEncodingRestrictionLifted} instead to allow any encoding, not + * just 32-bit float. * @param enableFloatOutput Whether to enable use of floating point audio output, if available. * @return This factory, for convenience. */ @CanIgnoreReturnValue + @Deprecated public final DefaultRenderersFactory setEnableAudioFloatOutput(boolean enableFloatOutput) { this.enableFloatOutput = enableFloatOutput; return this; } + /** + * Sets whether to enable outputting samples in any platform-supported format (such as 32-bit + * float, 32-bit integer, 24-bit integer, 16-bit integer or 8-bit integer) instead of restricting + * output to 16-bit integers. Where possible, the input sample format will be used, otherwise + * high-resolution formats will be output as 32-bit float. Parts of the default audio processing + * chain (for example, speed adjustment) will not be available when output formats other than + * 16-bit integer are in use. + * + *
The default value is {@code false}. + * + * @param pcmEncodingRestrictionLifted Whether to lift any restriction of output sample format. + * @return This factory, for convenience. + */ + @CanIgnoreReturnValue + public final DefaultRenderersFactory setPcmEncodingRestrictionLifted( + boolean pcmEncodingRestrictionLifted) { + this.pcmEncodingRestrictionLifted = pcmEncodingRestrictionLifted; + return this; + } + /** * Sets whether to enable setting playback speed using {@link * android.media.AudioTrack#setPlaybackParams(PlaybackParams)}, which is supported from API level @@ -377,7 +401,11 @@ public Renderer[] createRenderers( renderersList); @Nullable AudioSink audioSink = - buildAudioSink(context, enableFloatOutput, enableAudioTrackPlaybackParams); + buildAudioSink( + context, + pcmEncodingRestrictionLifted, + enableFloatOutput, + enableAudioTrackPlaybackParams); if (audioSink != null) { buildAudioRenderers( context, @@ -854,11 +882,17 @@ protected void buildMiscellaneousRenderers( */ @Nullable protected AudioSink buildAudioSink( - Context context, boolean enableFloatOutput, boolean enableAudioTrackPlaybackParams) { - return new DefaultAudioSink.Builder(context) - .setEnableFloatOutput(enableFloatOutput) - .setEnableAudioTrackPlaybackParams(enableAudioTrackPlaybackParams) - .build(); + Context context, + boolean pcmEncodingRestrictionLifted, + boolean enableFloatOutput, + boolean enableAudioTrackPlaybackParams) { + DefaultAudioSink.Builder builder = new DefaultAudioSink.Builder(context); + if (pcmEncodingRestrictionLifted || !enableFloatOutput) { + builder.setPcmEncodingRestrictionLifted(pcmEncodingRestrictionLifted); + } else { + builder.setEnableFloatOutput(true); + } + return builder.setEnableAudioTrackPlaybackParams(enableAudioTrackPlaybackParams).build(); } @Override diff --git a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/audio/DefaultAudioSink.java b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/audio/DefaultAudioSink.java index 4c47681318..3b2aff49ef 100644 --- a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/audio/DefaultAudioSink.java +++ b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/audio/DefaultAudioSink.java @@ -142,6 +142,21 @@ default int getAudioTrackChannelConfig(int channelCount) { /** The time it takes to ramp AudioTrack's volume up or down when pausing or starting to play. */ private static final int AUDIO_TRACK_VOLUME_RAMP_TIME_MS = 20; + /** + * @see Builder#setPcmEncodingRestrictionLifted(boolean) + */ + private static final int PCM_ENCODING_ANY = 0; + + /** + * @see Builder#setPcmEncodingRestrictionLifted(boolean) + */ + private static final int PCM_ENCODING_INT16_ONLY = 1; + + /** + * @see Builder#setEnableFloatOutput(boolean) + */ + private static final int PCM_ENCODING_INT16_FLOAT32_ONLY = 2; + /** * Thrown when the audio track has provided a spurious timestamp, if {@link * #failOnSpuriousAudioTimestamp} is set. @@ -167,10 +182,12 @@ public interface AudioProcessorChain extends androidx.media3.common.audio.AudioP /** * The default audio processor chain, which applies a (possibly empty) chain of user-defined audio * processors followed by {@link SilenceSkippingAudioProcessor} and {@link SonicAudioProcessor}. + * No audio processors will be applied for PCM encodings other than 16-bit integer. */ @SuppressWarnings("deprecation") public static class DefaultAudioProcessorChain implements AudioProcessorChain { + private boolean formatSupported = false; private final AudioProcessor[] audioProcessors; private final SilenceSkippingAudioProcessor silenceSkippingAudioProcessor; private final SonicAudioProcessor sonicAudioProcessor; @@ -207,12 +224,20 @@ public DefaultAudioProcessorChain( } @Override - public AudioProcessor[] getAudioProcessors() { + public AudioProcessor[] getAudioProcessors(Format inputFormat) { + if (inputFormat.pcmEncoding != C.ENCODING_PCM_16BIT) { + formatSupported = false; + return new AudioProcessor[0]; + } + formatSupported = true; return audioProcessors; } @Override public PlaybackParameters applyPlaybackParameters(PlaybackParameters playbackParameters) { + if (!formatSupported) { + return PlaybackParameters.DEFAULT; + } sonicAudioProcessor.setSpeed(playbackParameters.speed); sonicAudioProcessor.setPitch(playbackParameters.pitch); return playbackParameters; @@ -220,20 +245,23 @@ public PlaybackParameters applyPlaybackParameters(PlaybackParameters playbackPar @Override public boolean applySkipSilenceEnabled(boolean skipSilenceEnabled) { + if (!formatSupported) { + return false; + } silenceSkippingAudioProcessor.setEnabled(skipSilenceEnabled); return skipSilenceEnabled; } @Override public long getMediaDuration(long playoutDuration) { - return sonicAudioProcessor.isActive() + return formatSupported && sonicAudioProcessor.isActive() ? sonicAudioProcessor.getMediaDuration(playoutDuration) : playoutDuration; } @Override public long getSkippedOutputFrameCount() { - return silenceSkippingAudioProcessor.getSkippedFrames(); + return formatSupported ? silenceSkippingAudioProcessor.getSkippedFrames() : 0; } } @@ -297,7 +325,7 @@ public static final class Builder { @Nullable private final Context context; private AudioCapabilities audioCapabilities; @Nullable private androidx.media3.common.audio.AudioProcessorChain audioProcessorChain; - private boolean enableFloatOutput; + private int pcmEncodingRestrictionMode; private boolean enableAudioTrackPlaybackParams; private boolean buildCalled; @@ -316,6 +344,7 @@ public Builder() { audioCapabilities = DEFAULT_AUDIO_CAPABILITIES; audioTrackBufferSizeProvider = AudioTrackBufferSizeProvider.DEFAULT; audioTrackProvider = AudioTrackProvider.DEFAULT; + pcmEncodingRestrictionMode = PCM_ENCODING_INT16_ONLY; } /** @@ -328,6 +357,7 @@ public Builder(Context context) { audioCapabilities = DEFAULT_AUDIO_CAPABILITIES; audioTrackBufferSizeProvider = AudioTrackBufferSizeProvider.DEFAULT; audioTrackProvider = AudioTrackProvider.DEFAULT; + pcmEncodingRestrictionMode = PCM_ENCODING_INT16_ONLY; } /** @@ -375,14 +405,37 @@ public Builder setAudioProcessorChain( /** * Sets whether to enable 32-bit float output or integer output. Where possible, 32-bit float * output will be used if the input is 32-bit float, and also if the input is high resolution - * (24-bit or 32-bit) integer PCM. Audio processing (for example, speed adjustment) will not be - * available when float output is in use. + * (24-bit or 32-bit) integer PCM. Parts of the default audio processing chain (for example, + * speed adjustment) will not be available when output formats other than 16-bit integer are in + * use. * *
The default value is {@code false}. + * + * @deprecated Use {@link #setPcmEncodingRestrictionLifted} instead to allow any encoding, not + * just 32-bit float. */ + @Deprecated @CanIgnoreReturnValue public Builder setEnableFloatOutput(boolean enableFloatOutput) { - this.enableFloatOutput = enableFloatOutput; + this.pcmEncodingRestrictionMode = + enableFloatOutput ? PCM_ENCODING_INT16_FLOAT32_ONLY : PCM_ENCODING_INT16_ONLY; + return this; + } + + /** + * Sets whether to enable outputting samples in any platform-supported format (such as 32-bit + * float, 32-bit integer, 24-bit integer, 16-bit integer or 8-bit integer) instead of + * restricting output to 16-bit integers. Where possible, the input sample format will be used, + * otherwise high-resolution formats will be output as 32-bit float. Parts of the default audio + * processing chain (for example, speed adjustment) will not be available when output formats + * other than 16-bit integer are in use. + * + *
The default value is {@code false}.
+ */
+ @CanIgnoreReturnValue
+ public Builder setPcmEncodingRestrictionLifted(boolean pcmEncodingRestrictionLifted) {
+ this.pcmEncodingRestrictionMode =
+ pcmEncodingRestrictionLifted ? PCM_ENCODING_ANY : PCM_ENCODING_INT16_ONLY;
return this;
}
@@ -549,7 +602,7 @@ public DefaultAudioSink build() {
@Nullable private final Context context;
private final androidx.media3.common.audio.AudioProcessorChain audioProcessorChain;
- private final boolean enableFloatOutput;
+ private final int pcmEncodingRestrictionMode;
private final ChannelMappingAudioProcessor channelMappingAudioProcessor;
private final TrimmingAudioProcessor trimmingAudioProcessor;
private final ToInt16PcmAudioProcessor toInt16PcmAudioProcessor;
@@ -628,7 +681,7 @@ private DefaultAudioSink(Builder builder) {
audioAttributes = AudioAttributes.DEFAULT;
audioCapabilities = context != null ? null : builder.audioCapabilities;
audioProcessorChain = builder.audioProcessorChain;
- enableFloatOutput = builder.enableFloatOutput;
+ pcmEncodingRestrictionMode = builder.pcmEncodingRestrictionMode;
preferAudioTrackPlaybackParams = SDK_INT >= 23 && builder.enableAudioTrackPlaybackParams;
offloadMode = OFFLOAD_MODE_DISABLED;
audioTrackBufferSizeProvider = builder.audioTrackBufferSizeProvider;
@@ -690,13 +743,24 @@ public boolean supportsFormat(Format format) {
Log.w(TAG, "Invalid PCM encoding: " + format.pcmEncoding);
return SINK_FORMAT_UNSUPPORTED;
}
- if (format.pcmEncoding == C.ENCODING_PCM_16BIT
- || (enableFloatOutput && format.pcmEncoding == C.ENCODING_PCM_FLOAT)) {
- return SINK_FORMAT_SUPPORTED_DIRECTLY;
+ if (format.pcmEncoding != C.ENCODING_PCM_16BIT) {
+ if (pcmEncodingRestrictionMode == PCM_ENCODING_INT16_FLOAT32_ONLY
+ && format.pcmEncoding != C.ENCODING_PCM_FLOAT) {
+ // PCM_ENCODING_INT16_FLOAT32_ONLY is deprecated and kept for backwards compatibility.
+ return SINK_FORMAT_SUPPORTED_WITH_TRANSCODING;
+ }
+ if (pcmEncodingRestrictionMode == PCM_ENCODING_INT16_ONLY) {
+ // We will forcibly transcode to 16-bit PCM to allow the full audio processor chain to
+ // operate.
+ return SINK_FORMAT_SUPPORTED_WITH_TRANSCODING;
+ }
+ }
+ if (SDK_INT < Util.getApiLevelThatAudioFormatIntroducedAudioEncoding(format.pcmEncoding)) {
+ // We can resample all linear PCM encodings to 16-bit integer PCM, which AudioTrack is
+ // guaranteed to support.
+ return SINK_FORMAT_SUPPORTED_WITH_TRANSCODING;
}
- // We can resample all linear PCM encodings to 16-bit integer PCM, which AudioTrack is
- // guaranteed to support.
- return SINK_FORMAT_SUPPORTED_WITH_TRANSCODING;
+ return SINK_FORMAT_SUPPORTED_DIRECTLY;
}
if (audioCapabilities.isPassthroughPlaybackSupported(format, audioAttributes)) {
return SINK_FORMAT_SUPPORTED_DIRECTLY;
@@ -743,12 +807,32 @@ public void configure(Format inputFormat, int specifiedBufferSize, @Nullable int
ImmutableList.Builder