Run MediaSessionStub commands in order

Some commands are run asynchronously and subsequent commands need
to wait until the previous one finished. This can be supported
by returning a Future for each command and using the existing
command execution logic to wait for each Future to complete.

As some MediaSessionStub code is now executed delayed to when it
was originally created, we also need to check if the session is
not released before triggering any actions or sending result codes.

Issue: androidx/media#85
PiperOrigin-RevId: 462101136
(cherry picked from commit 7cb7636e)

RELEASENOTES.md

@@ -3,20 +3,40 @@
 ### Unreleased changes
 
 *   Core library:
+    *   Add `ExoPlayer.isTunnelingEnabled` to check if tunneling is enabled for
+        the currently selected tracks
+        ([#2518](https://github.com/google/ExoPlayer/issues/2518)).
+    *   Use `SingleThreadExecutor` for releasing `AudioTrack` instances to avoid
+        OutOfMemory errors when releasing multiple players at the same time
+        ([#10057](https://github.com/google/ExoPlayer/issues/10057)).
+*   Metadata:
+    *   `MetadataRenderer` can now be configured to render metadata as soon as
+        they are available. Create an instance with
+        `MetadataRenderer(MetadataOutput, Looper, MetadataDecoderFactory,
+        boolean)` to specify whether the renderer will output metadata early or
+        in sync with the player position.
+*   Session:
+    *   Ensure commands are always executed in the correct order even if some
+        require asynchronous resolution
+        ([#85](https://github.com/androidx/media/issues/85)).
+
+### 1.0.0-beta02 (2022-07-15)
+
+This release corresponds to the
+[ExoPlayer 2.18.1 release](https://github.com/google/ExoPlayer/releases/tag/r2.18.1).
+
+*   Core library:
     *   Ensure that changing the `ShuffleOrder` with `ExoPlayer.setShuffleOrder`
         results in a call to `Player.Listener#onTimelineChanged` with
         `reason=Player.TIMELINE_CHANGE_REASON_PLAYLIST_CHANGED`
         ([#9889](https://github.com/google/ExoPlayer/issues/9889)).
     *   For progressive media, only include selected tracks in buffered position
         ([#10361](https://github.com/google/ExoPlayer/issues/10361)).
-    *   Add `ExoPlayer.isTunnelingEnabled` to check if tunneling is enabled for
-        the currently selected tracks
-        ([#2518](https://github.com/google/ExoPlayer/issues/2518)).
     *   Allow custom logger for all ExoPlayer log output
         ([#9752](https://github.com/google/ExoPlayer/issues/9752)).
-    *   Use `SingleThreadExecutor` for releasing `AudioTrack` instances to avoid
-        OutOfMemory errors when releasing multiple players at the same time
-        ([#10057](https://github.com/google/ExoPlayer/issues/10057)).
+    *   Fix implementation of `setDataSourceFactory` in
+        `DefaultMediaSourceFactory`, which was non-functional in some cases
+        ([#116](https://github.com/androidx/media/issues/116)).
 *   Extractors:
     *   Add support for AVI
         ([#2092](https://github.com/google/ExoPlayer/issues/2092)).
@@ -24,12 +44,6 @@
         ([#10316](https://github.com/google/ExoPlayer/issues/10316)).
     *   Fix parsing of bitrates from `esds` boxes
         ([#10381](https://github.com/google/ExoPlayer/issues/10381)).
-*   Metadata:
-    *   `MetadataRenderer` can now be configured to render metadata as soon as
-        they are available. Create an instance with
-        `MetadataRenderer(MetadataOutput, Looper, MetadataDecoderFactory,
-        boolean)` to specify whether the renderer will output metadata early or
-        in sync with the player position.
 *   DASH:
     *   Parse ClearKey license URL from manifests
         ([#10246](https://github.com/google/ExoPlayer/issues/10246)).

libraries/session/src/main/java/androidx/media3/session/ConnectedControllersManager.java

@@ -24,7 +24,6 @@ import androidx.collection.ArrayMap;
 import androidx.media3.common.Player;
 import androidx.media3.session.MediaSession.ControllerInfo;
 import com.google.common.collect.ImmutableList;
-import com.google.common.util.concurrent.Futures;
 import com.google.common.util.concurrent.ListenableFuture;
 import com.google.common.util.concurrent.MoreExecutors;
 import java.util.ArrayDeque;
@@ -227,15 +226,11 @@ import org.checkerframework.checker.nullness.qual.NonNull;
     }
   }
 
-  public void addToCommandQueue(ControllerInfo controllerInfo, Runnable commandRunnable) {
+  public void addToCommandQueue(ControllerInfo controllerInfo, AsyncCommand asyncCommand) {
     synchronized (lock) {
       @Nullable ConnectedControllerRecord<T> info = controllerRecords.get(controllerInfo);
       if (info != null) {
-        info.commandQueue.add(
-            () -> {
-              commandRunnable.run();
-              return Futures.immediateVoidFuture();
-            });
+        info.commandQueue.add(asyncCommand);
       }
     }
   }

libraries/test_session_common/src/main/aidl/androidx/media3/test/session/common/IRemoteMediaController.aidl

@@ -81,6 +81,7 @@ interface IRemoteMediaController {
   void release(String controllerId);
   void stop(String controllerId);
   void setTrackSelectionParameters(String controllerId, in Bundle parameters);
+  void setMediaItemsPreparePlayAddItemsSeek(String controllerId, in List<Bundle> initialMediaItems, in List<Bundle> addedMediaItems, int seekIndex);
 
   // MediaBrowser methods
   Bundle getLibraryRoot(String controllerId, in Bundle libraryParams);

libraries/test_session_current/src/androidTest/java/androidx/media3/session/MediaSessionPlayerTest.java

@@ -19,19 +19,21 @@ import static androidx.media3.test.session.common.CommonConstants.SUPPORT_APP_PA
 import static androidx.media3.test.session.common.TestUtils.TIMEOUT_MS;
 import static com.google.common.truth.Truth.assertThat;
 
+import android.os.Handler;
+import android.os.HandlerThread;
 import androidx.media3.common.DeviceInfo;
 import androidx.media3.common.MediaItem;
 import androidx.media3.common.MediaMetadata;
 import androidx.media3.common.PlaybackParameters;
 import androidx.media3.common.Player;
 import androidx.media3.common.TrackSelectionParameters;
+import androidx.media3.common.util.Util;
 import androidx.media3.test.session.common.HandlerThreadTestRule;
 import androidx.media3.test.session.common.MainLooperTestRule;
 import androidx.media3.test.session.common.TestUtils;
 import androidx.test.core.app.ApplicationProvider;
 import androidx.test.ext.junit.runners.AndroidJUnit4;
 import androidx.test.filters.LargeTest;
-import com.google.common.util.concurrent.Futures;
 import com.google.common.util.concurrent.ListenableFuture;
 import java.util.List;
 import org.junit.After;
@@ -58,6 +60,7 @@ public class MediaSessionPlayerTest {
   private MediaSession session;
   private MockPlayer player;
   private RemoteMediaController controller;
+  private HandlerThread asyncHandlerThread;
 
   @Before
   public void setUp() throws Exception {
@@ -66,6 +69,9 @@ public class MediaSessionPlayerTest {
             .setApplicationLooper(threadTestRule.getHandler().getLooper())
             .setMediaItems(/* itemCount= */ 5)
             .build();
+    asyncHandlerThread = new HandlerThread("AsyncHandlerThread");
+    asyncHandlerThread.start();
+    Handler asyncHandler = new Handler(asyncHandlerThread.getLooper());
     session =
         new MediaSession.Builder(ApplicationProvider.getApplicationContext(), player)
             .setCallback(
@@ -84,7 +90,9 @@ public class MediaSessionPlayerTest {
                       MediaSession mediaSession,
                       MediaSession.ControllerInfo controller,
                       List<MediaItem> mediaItems) {
-                    return Futures.immediateFuture(mediaItems);
+                    // Send empty message and return mediaItems once done to simulate asynchronous
+                    // media item resolution.
+                    return Util.postOrRunWithCompletion(asyncHandler, () -> {}, mediaItems);
                   }
                 })
             .build();
@@ -97,6 +105,7 @@ public class MediaSessionPlayerTest {
   public void tearDown() throws Exception {
     controller.release();
     session.release();
+    asyncHandlerThread.quit();
   }
 
   @Test
@@ -544,6 +553,26 @@ public class MediaSessionPlayerTest {
     assertThat(player.trackSelectionParameters).isEqualTo(trackSelectionParameters);
   }
 
+  @Test
+  public void mixedAsyncAndSyncCommands_calledInCorrectOrder() throws Exception {
+    List<MediaItem> initialItems = MediaTestUtils.createMediaItems(/* size= */ 2);
+    List<MediaItem> addedItems = MediaTestUtils.createMediaItems(/* size= */ 3);
+
+    controller.setMediaItemsPreparePlayAddItemsSeek(initialItems, addedItems, /* seekIndex= */ 3);
+    player.awaitMethodCalled(MockPlayer.METHOD_PREPARE, TIMEOUT_MS);
+    boolean setMediaItemsCalledBeforePrepare =
+        player.hasMethodBeenCalled(MockPlayer.METHOD_SET_MEDIA_ITEMS);
+    player.awaitMethodCalled(MockPlayer.METHOD_SEEK_TO_WITH_MEDIA_ITEM_INDEX, TIMEOUT_MS);
+    boolean addMediaItemsCalledBeforeSeek =
+        player.hasMethodBeenCalled(MockPlayer.METHOD_ADD_MEDIA_ITEMS);
+
+    assertThat(setMediaItemsCalledBeforePrepare).isTrue();
+    assertThat(addMediaItemsCalledBeforeSeek).isTrue();
+    assertThat(player.hasMethodBeenCalled(MockPlayer.METHOD_PLAY)).isTrue();
+    assertThat(player.mediaItems).hasSize(5);
+    assertThat(player.seekMediaItemIndex).isEqualTo(3);
+  }
+
   private void changePlaybackTypeToRemote() throws Exception {
     threadTestRule
         .getHandler()

libraries/test_session_current/src/main/java/androidx/media3/session/MediaControllerProviderService.java

@@ -659,6 +659,26 @@ public class MediaControllerProviderService extends Service {
           });
     }
 
+    @Override
+    public void setMediaItemsPreparePlayAddItemsSeek(
+        String controllerId,
+        List<Bundle> initialMediaItems,
+        List<Bundle> addedMediaItems,
+        int seekIndex)
+        throws RemoteException {
+      runOnHandler(
+          () -> {
+            MediaController controller = mediaControllerMap.get(controllerId);
+            controller.setMediaItems(
+                BundleableUtil.fromBundleList(MediaItem.CREATOR, initialMediaItems));
+            controller.prepare();
+            controller.play();
+            controller.addMediaItems(
+                BundleableUtil.fromBundleList(MediaItem.CREATOR, addedMediaItems));
+            controller.seekTo(seekIndex, /* positionMs= */ 0);
+          });
+    }
+
     ////////////////////////////////////////////////////////////////////////////////
     // MediaBrowser methods
     ////////////////////////////////////////////////////////////////////////////////

libraries/test_session_current/src/main/java/androidx/media3/session/RemoteMediaController.java

@@ -292,6 +292,16 @@ public class RemoteMediaController {
     binder.setTrackSelectionParameters(controllerId, parameters.toBundle());
   }
 
+  public void setMediaItemsPreparePlayAddItemsSeek(
+      List<MediaItem> initialMediaItems, List<MediaItem> addedMediaItems, int seekIndex)
+      throws RemoteException {
+    binder.setMediaItemsPreparePlayAddItemsSeek(
+        controllerId,
+        BundleableUtil.toBundleList(initialMediaItems),
+        BundleableUtil.toBundleList(addedMediaItems),
+        seekIndex);
+  }
+
   ////////////////////////////////////////////////////////////////////////////////
   // Non-public methods
   ////////////////////////////////////////////////////////////////////////////////