Align PlaybackStateCompat states with logic in MediaSessionConnector

Creating the PlaybackStateCompat from a media3 Player state is done
already by the MediaSessionConnector (and used widely). The media3
session module should set the same states under the same circumstances
to ensure compatiblity and consistency.

PlaybackStateCompat changes made in media3 session:
 - Use STATE_STOPPED when player is ended instead of STATE_PAUSED
 - Use STATE_PLAYING when playback is suppressed temporarily.
 - Set the playback speed to 0 if the player is not playing.
 - Add extras for mediaId and user-set playback speed.

Part of the problem was that Player.isPlaying() was used to check
the state. Unfortunately, MockPlayer.isPlaying() is implemented in
a way that makes it hard to test these changes, because the value
is set independently of playbackState, playWhenReady and suppression
reason. To be able to write consistent, logical tests, this change
also removes the independent setting of isPlaying in MockPlayer to
align it better with a real player. This requires to update some
other tests to use alternative methods.

PiperOrigin-RevId: 487500859
(cherry picked from commit c5e071e)

Author: tonihei

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

@@ -32,7 +32,7 @@
 public final class MediaConstants {
 
   /**
-   * The legacy error code for expired authentication.
+   * {@link Bundle} key used for the error code for expired authentication.
    *
    * Use this error code to indicate an expired authentication when {@linkplain
    * LibraryResult#ofError(int, LibraryParams) creating a library result} for an unsuccessful
@@ -43,7 +43,23 @@ public final class MediaConstants {
   public static final int ERROR_CODE_AUTHENTICATION_EXPIRED_COMPAT = 3;
 
   /**
-   * The extras key for the localized error resolution string.
+   * {@link Bundle} key used for the value of {@code Player.getPlaybackParameters().speed}.
+   *
+   * Use this key in the extras bundle of the legacy {@link PlaybackStateCompat}.
+   */
+  @UnstableApi public static final String EXTRAS_KEY_PLAYBACK_SPEED_COMPAT = "EXO_SPEED";
+
+  /**
+   * {@link Bundle} key used for the media id of the media being played.
+   *
+   * Use this key in the extras bundle of the legacy {@link PlaybackStateCompat}.
+   */
+  @UnstableApi
+  public static final String EXTRAS_KEY_MEDIA_ID_COMPAT =
+      androidx.media.utils.MediaConstants.PLAYBACK_STATE_EXTRAS_KEY_MEDIA_ID;
+
+  /**
+   * {@link Bundle} key used for a localized error resolution string.
    *
    * Use this key to populate the extras bundle of the {@link LibraryParams} when {@linkplain
    * LibraryResult#ofError(int, LibraryParams) creating a library result} for an unsuccessful
@@ -53,7 +69,7 @@ public final class MediaConstants {
       androidx.media.utils.MediaConstants.PLAYBACK_STATE_EXTRAS_KEY_ERROR_RESOLUTION_ACTION_LABEL;
 
   /**
-   * The extras key for the error resolution intent.
+   * {@link Bundle} key used for an error resolution intent.
    *
    * Use this key to populate the extras bundle of the {@link LibraryParams} when {@linkplain
    * LibraryResult#ofError(int, LibraryParams) creating a library result} for an unsuccessful

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

@@ -728,20 +728,17 @@ public static RatingCompat convertToRatingCompat(@Nullable Rating rating) {
   public static int convertToPlaybackStateCompatState(
       @Nullable PlaybackException playerError,
       @Player.State int playbackState,
-      boolean playWhenReady,
-      boolean isPlaying) {
+      boolean playWhenReady) {
     if (playerError != null) {
       return PlaybackStateCompat.STATE_ERROR;
     }
-    if (isPlaying) {
-      return PlaybackStateCompat.STATE_PLAYING;
-    }
     switch (playbackState) {
       case Player.STATE_IDLE:
         return PlaybackStateCompat.STATE_NONE;
       case Player.STATE_READY:
+        return playWhenReady ? PlaybackStateCompat.STATE_PLAYING : PlaybackStateCompat.STATE_PAUSED;
       case Player.STATE_ENDED:
-        return PlaybackStateCompat.STATE_PAUSED;
+        return PlaybackStateCompat.STATE_STOPPED;
       case Player.STATE_BUFFERING:
         return playWhenReady
             ? PlaybackStateCompat.STATE_BUFFERING

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

@@ -18,6 +18,8 @@
 import static androidx.media3.common.util.Assertions.checkNotNull;
 import static androidx.media3.common.util.Assertions.checkState;
 import static androidx.media3.common.util.Util.postOrRun;
+import static androidx.media3.session.MediaConstants.EXTRAS_KEY_MEDIA_ID_COMPAT;
+import static androidx.media3.session.MediaConstants.EXTRAS_KEY_PLAYBACK_SPEED_COMPAT;
 
 import android.media.AudioManager;
 import android.os.Bundle;
@@ -768,7 +770,7 @@ public PlaybackStateCompat createPlaybackStateCompat() {
     @Nullable PlaybackException playerError = getPlayerError();
     int state =
         MediaUtils.convertToPlaybackStateCompatState(
-            playerError, getPlaybackState(), getPlayWhenReady(), isPlaying());
+            playerError, getPlaybackState(), getPlayWhenReady());
     long allActions =
         PlaybackStateCompat.ACTION_STOP
             | PlaybackStateCompat.ACTION_PAUSE
@@ -798,16 +800,22 @@ public PlaybackStateCompat createPlaybackStateCompat() {
       allActions |= PlaybackStateCompat.ACTION_SKIP_TO_NEXT;
     }
     long queueItemId = MediaUtils.convertToQueueItemId(getCurrentMediaItemIndex());
+    float playbackSpeed = getPlaybackParameters().speed;
+    float sessionPlaybackSpeed = isPlaying() ? playbackSpeed : 0f;
+    Bundle extras = new Bundle();
+    extras.putFloat(EXTRAS_KEY_PLAYBACK_SPEED_COMPAT, playbackSpeed);
+    @Nullable MediaItem currentMediaItem = getCurrentMediaItem();
+    if (currentMediaItem != null && !MediaItem.DEFAULT_MEDIA_ID.equals(currentMediaItem.mediaId)) {
+      extras.putString(EXTRAS_KEY_MEDIA_ID_COMPAT, currentMediaItem.mediaId);
+    }
     PlaybackStateCompat.Builder builder =
         new PlaybackStateCompat.Builder()
             .setState(
-                state,
-                getCurrentPosition(),
-                getPlaybackParameters().speed,
-                SystemClock.elapsedRealtime())
+                state, getCurrentPosition(), sessionPlaybackSpeed, SystemClock.elapsedRealtime())
             .setActions(allActions)
             .setActiveQueueItemId(queueItemId)
-            .setBufferedPosition(getBufferedPosition());
+            .setBufferedPosition(getBufferedPosition())
+            .setExtras(extras);
 
     for (int i = 0; i < customLayout.size(); i++) {
       CommandButton commandButton = customLayout.get(i);

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

@@ -55,7 +55,6 @@ interface IRemoteMediaSession {
   void notifyPlayerError(String sessionId, in Bundle playerErrorBundle);
   void notifyPlayWhenReadyChanged(String sessionId, boolean playWhenReady, int reason);
   void notifyPlaybackStateChanged(String sessionId, int state);
-  void notifyIsPlayingChanged(String sessionId, boolean isPlaying);
   void notifyIsLoadingChanged(String sessionId, boolean isLoading);
   void notifyPositionDiscontinuity(String sessionId,
       in Bundle oldPositionBundle, in Bundle newPositionBundle, int reason);

libraries/test_session_common/src/main/java/androidx/media3/test/session/common/CommonConstants.java

@@ -90,7 +90,6 @@ public class CommonConstants {
   public static final String KEY_PLAY_WHEN_READY = "playWhenReady";
   public static final String KEY_PLAYBACK_SUPPRESSION_REASON = "playbackSuppressionReason";
   public static final String KEY_PLAYBACK_STATE = "playbackState";
-  public static final String KEY_IS_PLAYING = "isPlaying";
   public static final String KEY_IS_LOADING = "isLoading";
   public static final String KEY_REPEAT_MODE = "repeatMode";
   public static final String KEY_SHUFFLE_MODE_ENABLED = "shuffleModeEnabled";

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

@@ -338,7 +338,6 @@ public void onError(String parentId) {
           }
         });
     assertThat(errorLatch.await(TIMEOUT_MS, MILLISECONDS)).isTrue();
-    assertThat(lastReportedPlaybackStateCompat).isNotNull();
     assertThat(lastReportedPlaybackStateCompat.getState())
         .isEqualTo(PlaybackStateCompat.STATE_ERROR);
     assertThat(
@@ -361,7 +360,11 @@ public void onChildrenLoaded(String parentId, List children) {
     // Any successful calls remove the error state,
     assertThat(lastReportedPlaybackStateCompat.getState())
         .isNotEqualTo(PlaybackStateCompat.STATE_ERROR);
-    assertThat(lastReportedPlaybackStateCompat.getExtras()).isNull();
+    assertThat(
+            lastReportedPlaybackStateCompat
+                .getExtras()
+                .getString(MediaConstants.EXTRAS_KEY_ERROR_RESOLUTION_ACTION_LABEL_COMPAT))
+        .isNull();
   }
 
   @Test