Add a builder to `DefaultAudioSink`

`DefaultAudioSink` already has 3 telescoping
constructors and an other one would be have been
needed to add a buffer size tuning option.

PiperOrigin-RevId: 414703366

RELEASENOTES.md

@@ -25,6 +25,9 @@
         targeting Android 12, and will crash with an `IllegalArgumentException`
         when creating `PendingIntent`s
         ([#9528](https://github.com/google/ExoPlayer/issues/9528)).
+*   Audio:
+    *   Add a `Builder` to `DefaultAudioSink` and deprecate the existing
+        constructors.
 *   Extractors:
     *   Fix inconsistency with spec in H.265 SPS nal units parsing
         ((#9719)[https://github.com/google/ExoPlayer/issues/9719]).

extensions/ffmpeg/src/main/java/com/google/android/exoplayer2/ext/ffmpeg/FfmpegAudioRenderer.java

@@ -64,7 +64,7 @@ public final class FfmpegAudioRenderer extends DecoderAudioRenderer<FfmpegAudioD
     this(
         eventHandler,
         eventListener,
-        new DefaultAudioSink(/* audioCapabilities= */ null, audioProcessors));
+        new DefaultAudioSink.Builder().setAudioProcessors(audioProcessors).build());
   }
 
   /**

extensions/flac/src/androidTest/java/com/google/android/exoplayer2/ext/flac/FlacPlaybackTest.java

@@ -29,7 +29,6 @@ import com.google.android.exoplayer2.PlaybackException;
 import com.google.android.exoplayer2.Player;
 import com.google.android.exoplayer2.Renderer;
 import com.google.android.exoplayer2.RenderersFactory;
-import com.google.android.exoplayer2.audio.AudioProcessor;
 import com.google.android.exoplayer2.audio.AudioSink;
 import com.google.android.exoplayer2.audio.DefaultAudioSink;
 import com.google.android.exoplayer2.extractor.mkv.MatroskaExtractor;
@@ -67,9 +66,7 @@ public class FlacPlaybackTest {
   }
 
   private static void playAndAssertAudioSinkInput(String fileName) throws Exception {
-    CapturingAudioSink audioSink =
-        new CapturingAudioSink(
-            new DefaultAudioSink(/* audioCapabilities= */ null, new AudioProcessor[0]));
+    CapturingAudioSink audioSink = new CapturingAudioSink(new DefaultAudioSink.Builder().build());
 
     TestPlaybackRunnable testPlaybackRunnable =
         new TestPlaybackRunnable(

library/core/build.gradle

@@ -47,6 +47,7 @@ dependencies {
     compileOnly 'org.checkerframework:checker-qual:' + checkerframeworkVersion
     compileOnly 'org.checkerframework:checker-compat-qual:' + checkerframeworkCompatVersion
     compileOnly 'org.jetbrains.kotlin:kotlin-annotations-jvm:' + kotlinAnnotationsVersion
+    compileOnly 'com.google.errorprone:error_prone_annotations:' + errorProneVersion
     androidTestImplementation 'androidx.test:runner:' + androidxTestRunnerVersion
     androidTestImplementation 'com.linkedin.dexmaker:dexmaker:' + dexmakerVersion
     androidTestImplementation 'com.linkedin.dexmaker:dexmaker-mockito:' + dexmakerVersion

library/core/src/main/java/com/google/android/exoplayer2/DefaultRenderersFactory.java

@@ -26,7 +26,6 @@ import com.google.android.exoplayer2.audio.AudioCapabilities;
 import com.google.android.exoplayer2.audio.AudioRendererEventListener;
 import com.google.android.exoplayer2.audio.AudioSink;
 import com.google.android.exoplayer2.audio.DefaultAudioSink;
-import com.google.android.exoplayer2.audio.DefaultAudioSink.DefaultAudioProcessorChain;
 import com.google.android.exoplayer2.audio.MediaCodecAudioRenderer;
 import com.google.android.exoplayer2.mediacodec.DefaultMediaCodecAdapterFactory;
 import com.google.android.exoplayer2.mediacodec.MediaCodecAdapter;
@@ -666,14 +665,15 @@ public class DefaultRenderersFactory implements RenderersFactory {
       boolean enableFloatOutput,
       boolean enableAudioTrackPlaybackParams,
       boolean enableOffload) {
-    return new DefaultAudioSink(
-        AudioCapabilities.getCapabilities(context),
-        new DefaultAudioProcessorChain(),
-        enableFloatOutput,
-        enableAudioTrackPlaybackParams,
-        enableOffload
-            ? DefaultAudioSink.OFFLOAD_MODE_ENABLED_GAPLESS_REQUIRED
-            : DefaultAudioSink.OFFLOAD_MODE_DISABLED);
+    return new DefaultAudioSink.Builder()
+        .setAudioCapabilities(AudioCapabilities.getCapabilities(context))
+        .setEnableFloatOutput(enableFloatOutput)
+        .setEnableAudioTrackPlaybackParams(enableAudioTrackPlaybackParams)
+        .setOffloadMode(
+            enableOffload
+                ? DefaultAudioSink.OFFLOAD_MODE_ENABLED_GAPLESS_REQUIRED
+                : DefaultAudioSink.OFFLOAD_MODE_DISABLED)
+        .build();
   }
 
   /**

library/core/src/main/java/com/google/android/exoplayer2/ExoPlayer.java

@@ -33,7 +33,6 @@ import androidx.annotation.VisibleForTesting;
 import com.google.android.exoplayer2.analytics.AnalyticsCollector;
 import com.google.android.exoplayer2.analytics.AnalyticsListener;
 import com.google.android.exoplayer2.audio.AudioAttributes;
-import com.google.android.exoplayer2.audio.AudioCapabilities;
 import com.google.android.exoplayer2.audio.AudioSink;
 import com.google.android.exoplayer2.audio.AuxEffectInfo;
 import com.google.android.exoplayer2.audio.DefaultAudioSink;
@@ -1492,8 +1491,7 @@ public interface ExoPlayer extends Player {
    * <ul>
    *   <li>Audio offload rendering is enabled in {@link
    *       DefaultRenderersFactory#setEnableAudioOffload} or the equivalent option passed to {@link
-   *       DefaultAudioSink#DefaultAudioSink(AudioCapabilities,
-   *       DefaultAudioSink.AudioProcessorChain, boolean, boolean, int)}.
+   *       DefaultAudioSink.Builder#setOffloadMode}.
    *   <li>An audio track is playing in a format that the device supports offloading (for example,
    *       MP3 or AAC).
    *   <li>The {@link AudioSink} is playing with an offload {@link AudioTrack}.

library/core/src/main/java/com/google/android/exoplayer2/audio/DecoderAudioRenderer.java

@@ -54,6 +54,7 @@ import com.google.android.exoplayer2.util.MediaClock;
 import com.google.android.exoplayer2.util.MimeTypes;
 import com.google.android.exoplayer2.util.TraceUtil;
 import com.google.android.exoplayer2.util.Util;
+import com.google.common.base.MoreObjects;
 import java.lang.annotation.Documented;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
@@ -171,7 +172,15 @@ public abstract class DecoderAudioRenderer<
       @Nullable AudioRendererEventListener eventListener,
       @Nullable AudioCapabilities audioCapabilities,
       AudioProcessor... audioProcessors) {
-    this(eventHandler, eventListener, new DefaultAudioSink(audioCapabilities, audioProcessors));
+    this(
+        eventHandler,
+        eventListener,
+        new DefaultAudioSink.Builder()
+            .setAudioCapabilities(
+                MoreObjects.firstNonNull(
+                    audioCapabilities, AudioCapabilities.DEFAULT_AUDIO_CAPABILITIES))
+            .setAudioProcessors(audioProcessors)
+            .build());
   }
 
   /**

library/core/src/main/java/com/google/android/exoplayer2/audio/MediaCodecAudioRenderer.java

@@ -155,7 +155,10 @@ public class MediaCodecAudioRenderer extends MediaCodecRenderer implements Media
         mediaCodecSelector,
         eventHandler,
         eventListener,
-        new DefaultAudioSink(audioCapabilities, audioProcessors));
+        new DefaultAudioSink.Builder()
+            .setAudioCapabilities(audioCapabilities)
+            .setAudioProcessors(audioProcessors)
+            .build());
   }
 
   /**

library/core/src/test/java/com/google/android/exoplayer2/audio/DefaultAudioSinkTest.java

@@ -15,6 +15,7 @@
  */
 package com.google.android.exoplayer2.audio;
 
+import static com.google.android.exoplayer2.audio.AudioCapabilities.DEFAULT_AUDIO_CAPABILITIES;
 import static com.google.android.exoplayer2.audio.AudioSink.CURRENT_POSITION_NOT_SET;
 import static com.google.android.exoplayer2.audio.AudioSink.SINK_FORMAT_SUPPORTED_DIRECTLY;
 import static com.google.android.exoplayer2.audio.AudioSink.SINK_FORMAT_SUPPORTED_WITH_TRANSCODING;
@@ -24,6 +25,7 @@ import androidx.test.ext.junit.runners.AndroidJUnit4;
 import com.google.android.exoplayer2.C;
 import com.google.android.exoplayer2.Format;
 import com.google.android.exoplayer2.PlaybackParameters;
+import com.google.android.exoplayer2.audio.DefaultAudioSink.DefaultAudioProcessorChain;
 import com.google.android.exoplayer2.util.MimeTypes;
 import java.nio.ByteBuffer;
 import java.nio.ByteOrder;
@@ -37,7 +39,6 @@ import org.robolectric.annotation.Config;
 /** Unit tests for {@link DefaultAudioSink}. */
 @RunWith(AndroidJUnit4.class)
 public final class DefaultAudioSinkTest {
-
   private static final int CHANNEL_COUNT_MONO = 1;
   private static final int CHANNEL_COUNT_STEREO = 2;
   private static final int BYTES_PER_FRAME_16_BIT = 2;
@@ -59,19 +60,20 @@ public final class DefaultAudioSinkTest {
     arrayAudioBufferSink = new ArrayAudioBufferSink();
     TeeAudioProcessor teeAudioProcessor = new TeeAudioProcessor(arrayAudioBufferSink);
     defaultAudioSink =
-        new DefaultAudioSink(
-            AudioCapabilities.DEFAULT_AUDIO_CAPABILITIES,
-            new DefaultAudioSink.DefaultAudioProcessorChain(teeAudioProcessor),
-            /* enableFloatOutput= */ false,
-            /* enableAudioTrackPlaybackParams= */ false,
-            DefaultAudioSink.OFFLOAD_MODE_DISABLED);
+        new DefaultAudioSink.Builder()
+            .setAudioCapabilities(DEFAULT_AUDIO_CAPABILITIES)
+            .setAudioProcessorChain(new DefaultAudioProcessorChain(teeAudioProcessor))
+            .setOffloadMode(DefaultAudioSink.OFFLOAD_MODE_DISABLED)
+            .build();
   }
 
   @Test
   public void handlesSpecializedAudioProcessorArray() {
     defaultAudioSink =
-        new DefaultAudioSink(
-            AudioCapabilities.DEFAULT_AUDIO_CAPABILITIES, new TeeAudioProcessor[0]);
+        new DefaultAudioSink.Builder()
+            .setAudioCapabilities(DEFAULT_AUDIO_CAPABILITIES)
+            .setAudioProcessors(new TeeAudioProcessor[0])
+            .build();
   }
 
   @Test
@@ -203,10 +205,7 @@ public final class DefaultAudioSinkTest {
   @Test
   public void floatPcmNeedsTranscodingIfFloatOutputDisabled() {
     defaultAudioSink =
-        new DefaultAudioSink(
-            AudioCapabilities.DEFAULT_AUDIO_CAPABILITIES,
-            new AudioProcessor[0],
-            /* enableFloatOutput= */ false);
+        new DefaultAudioSink.Builder().setAudioCapabilities(DEFAULT_AUDIO_CAPABILITIES).build();
     Format floatFormat =
         STEREO_44_1_FORMAT
             .buildUpon()
@@ -221,10 +220,10 @@ public final class DefaultAudioSinkTest {
   @Test
   public void floatPcmNeedsTranscodingIfFloatOutputEnabledBeforeApi21() {
     defaultAudioSink =
-        new DefaultAudioSink(
-            AudioCapabilities.DEFAULT_AUDIO_CAPABILITIES,
-            new AudioProcessor[0],
-            /* enableFloatOutput= */ true);
+        new DefaultAudioSink.Builder()
+            .setAudioCapabilities(DEFAULT_AUDIO_CAPABILITIES)
+            .setEnableFloatOutput(true)
+            .build();
     Format floatFormat =
         STEREO_44_1_FORMAT
             .buildUpon()
@@ -239,10 +238,10 @@ public final class DefaultAudioSinkTest {
   @Test
   public void floatOutputSupportedIfFloatOutputEnabledFromApi21() {
     defaultAudioSink =
-        new DefaultAudioSink(
-            AudioCapabilities.DEFAULT_AUDIO_CAPABILITIES,
-            new AudioProcessor[0],
-            /* enableFloatOutput= */ true);
+        new DefaultAudioSink.Builder()
+            .setAudioCapabilities(DEFAULT_AUDIO_CAPABILITIES)
+            .setEnableFloatOutput(true)
+            .build();
     Format floatFormat =
         STEREO_44_1_FORMAT
             .buildUpon()
@@ -267,8 +266,9 @@ public final class DefaultAudioSinkTest {
   @Test
   public void audioSinkWithAacAudioCapabilitiesWithoutOffload_doesNotSupportAac() {
     DefaultAudioSink defaultAudioSink =
-        new DefaultAudioSink(
-            new AudioCapabilities(new int[] {C.ENCODING_AAC_LC}, 2), new AudioProcessor[0]);
+        new DefaultAudioSink.Builder()
+            .setAudioCapabilities(new AudioCapabilities(new int[] {C.ENCODING_AAC_LC}, 2))
+            .build();
     Format aacLcFormat =
         STEREO_44_1_FORMAT
             .buildUpon()

testutils/src/main/java/com/google/android/exoplayer2/testutil/CapturingRenderersFactory.java

@@ -31,7 +31,6 @@ import com.google.android.exoplayer2.DefaultRenderersFactory;
 import com.google.android.exoplayer2.Renderer;
 import com.google.android.exoplayer2.RenderersFactory;
 import com.google.android.exoplayer2.audio.AudioCapabilities;
-import com.google.android.exoplayer2.audio.AudioProcessor;
 import com.google.android.exoplayer2.audio.AudioRendererEventListener;
 import com.google.android.exoplayer2.audio.DefaultAudioSink;
 import com.google.android.exoplayer2.audio.MediaCodecAudioRenderer;
@@ -94,7 +93,9 @@ public class CapturingRenderersFactory implements RenderersFactory, Dumper.Dumpa
           /* enableDecoderFallback= */ false,
           eventHandler,
           audioRendererEventListener,
-          new DefaultAudioSink(AudioCapabilities.getCapabilities(context), new AudioProcessor[0])),
+          new DefaultAudioSink.Builder()
+              .setAudioCapabilities(AudioCapabilities.getCapabilities(context))
+              .build()),
       new TextRenderer(textRendererOutput, eventHandler.getLooper()),
       new MetadataRenderer(metadataRendererOutput, eventHandler.getLooper())
     };