From 02ed809a181702e663dfef81f104eb1d419f073b Mon Sep 17 00:00:00 2001
From: olly <olly@google.com>
Date: Mon, 17 Aug 2020 12:44:16 +0100
Subject: [PATCH] Tweak offload disable Javadoc

PiperOrigin-RevId: 326998407
---
 .../exoplayer2/audio/DefaultAudioSink.java    | 35 +++++++++----------
 1 file changed, 17 insertions(+), 18 deletions(-)

diff --git a/library/core/src/main/java/com/google/android/exoplayer2/audio/DefaultAudioSink.java b/library/core/src/main/java/com/google/android/exoplayer2/audio/DefaultAudioSink.java
index 28f22dcf72..2da648b303 100644
--- a/library/core/src/main/java/com/google/android/exoplayer2/audio/DefaultAudioSink.java
+++ b/library/core/src/main/java/com/google/android/exoplayer2/audio/DefaultAudioSink.java
@@ -327,15 +327,7 @@ public final class DefaultAudioSink implements AudioSink {
   private AuxEffectInfo auxEffectInfo;
   private boolean tunneling;
   private long lastFeedElapsedRealtimeMs;
-  /**
-   * Do not retrying offload if it just failed.
-   *
-   * <p>{@link AudioManager#isOffloadedPlaybackSupported(AudioFormat,
-   * android.media.AudioAttributes)} does not guaranty that offload is available (eg: using {@link
-   * android.media.AudioPlaybackCaptureConfiguration}) will disable offload. As a result only try
-   * once per track/seek to play in offload mode.
-   */
-  private boolean disableOffloadAfterFailureUntilNextConfiguration;
+  private boolean offloadDisabledUntilNextConfiguration;
 
   /**
    * Creates a new default audio sink.
@@ -466,7 +458,7 @@ public final class DefaultAudioSink implements AudioSink {
       return SINK_FORMAT_SUPPORTED_WITH_TRANSCODING;
     }
     if (enableOffload
-        && !disableOffloadAfterFailureUntilNextConfiguration
+        && !offloadDisabledUntilNextConfiguration
         && isOffloadedPlaybackSupported(format, audioAttributes)) {
       return SINK_FORMAT_SUPPORTED_DIRECTLY;
     }
@@ -575,8 +567,7 @@ public final class DefaultAudioSink implements AudioSink {
           "Invalid output channel config (mode=" + outputMode + ") for: " + inputFormat);
     }
 
-    disableOffloadAfterFailureUntilNextConfiguration = false;
-
+    offloadDisabledUntilNextConfiguration = false;
     Configuration pendingConfiguration =
         new Configuration(
             inputFormat,
@@ -836,9 +827,7 @@ public final class DefaultAudioSink implements AudioSink {
       return Assertions.checkNotNull(configuration)
           .buildAudioTrack(tunneling, audioAttributes, audioSessionId);
     } catch (InitializationException e) {
-      if (configuration.outputModeIsOffload()) {
-        disableOffloadAfterFailureUntilNextConfiguration = true;
-      }
+      maybeDisableOffload();
       throw e;
     }
   }
@@ -929,8 +918,8 @@ public final class DefaultAudioSink implements AudioSink {
 
     if (bytesWritten < 0) {
       boolean isRecoverable = isAudioTrackDeadObject(bytesWritten);
-      if (isRecoverable && configuration.outputModeIsOffload()) {
-        disableOffloadAfterFailureUntilNextConfiguration = true;
+      if (isRecoverable) {
+        maybeDisableOffload();
       }
       throw new WriteException(bytesWritten);
     }
@@ -966,6 +955,16 @@ public final class DefaultAudioSink implements AudioSink {
     }
   }
 
+  private void maybeDisableOffload() {
+    if (!configuration.outputModeIsOffload()) {
+      return;
+    }
+    // Offload was requested, but may not be available. There are cases when this can occur even if
+    // AudioManager.isOffloadedPlaybackSupported returned true. For example, due to use of an
+    // AudioPlaybackCaptureConfiguration. Disable offload until the sink is next configured.
+    offloadDisabledUntilNextConfiguration = true;
+  }
+
   private static boolean isAudioTrackDeadObject(int status) {
     return Util.SDK_INT >= 24 && status == AudioTrack.ERROR_DEAD_OBJECT;
   }
@@ -1200,7 +1199,7 @@ public final class DefaultAudioSink implements AudioSink {
     }
     audioSessionId = C.AUDIO_SESSION_ID_UNSET;
     playing = false;
-    disableOffloadAfterFailureUntilNextConfiguration = false;
+    offloadDisabledUntilNextConfiguration = false;
   }
 
   // Internal methods.