Expose AudioOffload track state.

yschimke · marcbaechinger · commit fe2b846552e1 · 2022-10-19T16:26:07.000Z
Adds a new event to AudioOffloadListener to get the offload state of the track, which indicates when software decoding is taking place.

PiperOrigin-RevId: 465264362
diff --git a/library/core/src/main/java/com/google/android/exoplayer2/ExoPlayer.java b/library/core/src/main/java/com/google/android/exoplayer2/ExoPlayer.java
@@ -423,6 +423,16 @@ default void onExperimentalOffloadSchedulingEnabledChanged(boolean offloadSchedu
      * <p>This method is experimental, and will be renamed or removed in a future release.
      */
     default void onExperimentalSleepingForOffloadChanged(boolean sleepingForOffload) {}
+
+    /**
+     * Called when the value of {@link AudioTrack#isOffloadedPlayback} changes.
+     *
+     * <p>This should not be generally required to be acted upon. But when offload is critical for
+     * efficiency, or audio features (gapless, playback speed), this will let the app know.
+     *
+     * <p>This method is experimental, and will be renamed or removed in a future release.
+     */
+    default void onExperimentalOffloadedPlayback(boolean offloadedPlayback) {}
   }
 
   /**
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
@@ -39,6 +39,7 @@
 import androidx.annotation.Nullable;
 import androidx.annotation.RequiresApi;
 import com.google.android.exoplayer2.C;
+import com.google.android.exoplayer2.ExoPlayer.AudioOffloadListener;
 import com.google.android.exoplayer2.Format;
 import com.google.android.exoplayer2.PlaybackParameters;
 import com.google.android.exoplayer2.analytics.PlayerId;
@@ -265,6 +266,7 @@ public static final class Builder {
     private boolean enableAudioTrackPlaybackParams;
     private int offloadMode;
     AudioTrackBufferSizeProvider audioTrackBufferSizeProvider;
+    @Nullable AudioOffloadListener audioOffloadListener;
 
     /** Creates a new builder. */
     public Builder() {
@@ -370,6 +372,19 @@ public Builder setAudioTrackBufferSizeProvider(
       return this;
     }
 
+    /**
+     * Sets an optional {@link AudioOffloadListener} to receive events relevant to offloaded
+     * playback.
+     *
+     * <p>The default value is null.
+     */
+    @CanIgnoreReturnValue
+    public Builder setExperimentalAudioOffloadListener(
+        @Nullable AudioOffloadListener audioOffloadListener) {
+      this.audioOffloadListener = audioOffloadListener;
+      return this;
+    }
+
     /** Builds the {@link DefaultAudioSink}. Must only be called once per Builder instance. */
     public DefaultAudioSink build() {
       if (audioProcessorChain == null) {
@@ -500,6 +515,7 @@ public DefaultAudioSink build() {
       initializationExceptionPendingExceptionHolder;
   private final PendingExceptionHolder<WriteException> writeExceptionPendingExceptionHolder;
   private final AudioTrackBufferSizeProvider audioTrackBufferSizeProvider;
+  @Nullable private final AudioOffloadListener audioOffloadListener;
 
   @Nullable private PlayerId playerId;
   @Nullable private Listener listener;
@@ -660,6 +676,7 @@ private DefaultAudioSink(Builder builder) {
         new PendingExceptionHolder<>(AUDIO_TRACK_RETRY_DURATION_MS);
     writeExceptionPendingExceptionHolder =
         new PendingExceptionHolder<>(AUDIO_TRACK_RETRY_DURATION_MS);
+    audioOffloadListener = builder.audioOffloadListener;
   }
 
   // AudioSink implementation.
@@ -1087,7 +1104,12 @@ private AudioTrack buildAudioTrackWithRetry() throws InitializationException {
 
   private AudioTrack buildAudioTrack(Configuration configuration) throws InitializationException {
     try {
-      return configuration.buildAudioTrack(tunneling, audioAttributes, audioSessionId);
+      AudioTrack audioTrack =
+          configuration.buildAudioTrack(tunneling, audioAttributes, audioSessionId);
+      if (audioOffloadListener != null) {
+        audioOffloadListener.onExperimentalOffloadedPlayback(isOffloadedPlayback(audioTrack));
+      }
+      return audioTrack;
     } catch (InitializationException e) {
       if (listener != null) {
         listener.onAudioSinkError(e);
