Split available command filtering and bundling

A few methods in PlayerInfo and related classes combine filtering
information with bundling in one method. This makes it impossible
to use just the filtering for example and it's also easier to reason
about than two dedicated methods. This change splits these methods
into two parts accordingly.

PiperOrigin-RevId: 572592458

Author: tonihei

libraries/common/src/main/java/androidx/media3/common/Player.java

@@ -350,15 +350,9 @@ public boolean equals(@Nullable Object o) {
         return false;
       }
       PositionInfo that = (PositionInfo) o;
-      return mediaItemIndex == that.mediaItemIndex
-          && periodIndex == that.periodIndex
-          && positionMs == that.positionMs
-          && contentPositionMs == that.contentPositionMs
-          && adGroupIndex == that.adGroupIndex
-          && adIndexInAdGroup == that.adIndexInAdGroup
+      return equalsForBundling(that)
           && Objects.equal(windowUid, that.windowUid)
-          && Objects.equal(periodUid, that.periodUid)
-          && Objects.equal(mediaItem, that.mediaItem);
+          && Objects.equal(periodUid, that.periodUid);
     }
 
     @Override
@@ -375,6 +369,21 @@ public int hashCode() {
           adIndexInAdGroup);
     }
 
+    /**
+     * Returns whether this position info and the other position info would result in the same
+     * {@link #toBundle() Bundle}.
+     */
+    @UnstableApi
+    public boolean equalsForBundling(PositionInfo other) {
+      return mediaItemIndex == other.mediaItemIndex
+          && periodIndex == other.periodIndex
+          && positionMs == other.positionMs
+          && contentPositionMs == other.contentPositionMs
+          && adGroupIndex == other.adGroupIndex
+          && adIndexInAdGroup == other.adIndexInAdGroup
+          && Objects.equal(mediaItem, other.mediaItem);
+    }
+
     // Bundleable implementation.
 
     private static final String FIELD_MEDIA_ITEM_INDEX = Util.intToStringMaxRadix(0);
@@ -386,39 +395,66 @@ public int hashCode() {
     private static final String FIELD_AD_INDEX_IN_AD_GROUP = Util.intToStringMaxRadix(6);
 
     /**
-     * {@inheritDoc}
+     * Returns a copy of this position info, filtered by the specified available commands.
      *
-     * <p>It omits the {@link #windowUid} and {@link #periodUid} fields. The {@link #windowUid} and
-     * {@link #periodUid} of an instance restored by {@link #CREATOR} will always be {@code null}.
+     * <p>The filtered fields are reset to their default values.
+     *
+     * <p>The return value may be the same object if nothing is filtered.
+     *
+     * @param canAccessCurrentMediaItem Whether {@link Player#COMMAND_GET_CURRENT_MEDIA_ITEM} is
+     *     available.
+     * @param canAccessTimeline Whether {@link Player#COMMAND_GET_TIMELINE} is available.
+     * @return The filtered position info.
      */
     @UnstableApi
-    @Override
-    public Bundle toBundle() {
-      return toBundle(/* canAccessCurrentMediaItem= */ true, /* canAccessTimeline= */ true);
+    public PositionInfo filterByAvailableCommands(
+        boolean canAccessCurrentMediaItem, boolean canAccessTimeline) {
+      if (canAccessCurrentMediaItem && canAccessTimeline) {
+        return this;
+      }
+      return new PositionInfo(
+          windowUid,
+          canAccessTimeline ? mediaItemIndex : 0,
+          canAccessCurrentMediaItem ? mediaItem : null,
+          periodUid,
+          canAccessTimeline ? periodIndex : 0,
+          canAccessCurrentMediaItem ? positionMs : 0,
+          canAccessCurrentMediaItem ? contentPositionMs : 0,
+          canAccessCurrentMediaItem ? adGroupIndex : C.INDEX_UNSET,
+          canAccessCurrentMediaItem ? adIndexInAdGroup : C.INDEX_UNSET);
     }
 
     /**
-     * Returns a {@link Bundle} representing the information stored in this object, filtered by
-     * available commands.
+     * {@inheritDoc}
      *
-     * @param canAccessCurrentMediaItem Whether the {@link Bundle} should contain information
-     *     accessbile with {@link #COMMAND_GET_CURRENT_MEDIA_ITEM}.
-     * @param canAccessTimeline Whether the {@link Bundle} should contain information accessbile
-     *     with {@link #COMMAND_GET_TIMELINE}.
+     * <p>It omits the {@link #windowUid} and {@link #periodUid} fields. The {@link #windowUid} and
+     * {@link #periodUid} of an instance restored by {@link #CREATOR} will always be {@code null}.
      */
     @UnstableApi
-    public Bundle toBundle(boolean canAccessCurrentMediaItem, boolean canAccessTimeline) {
+    @Override
+    public Bundle toBundle() {
       Bundle bundle = new Bundle();
-      bundle.putInt(FIELD_MEDIA_ITEM_INDEX, canAccessTimeline ? mediaItemIndex : 0);
-      if (mediaItem != null && canAccessCurrentMediaItem) {
+      if (mediaItemIndex != 0) {
+        bundle.putInt(FIELD_MEDIA_ITEM_INDEX, mediaItemIndex);
+      }
+      if (mediaItem != null) {
         bundle.putBundle(FIELD_MEDIA_ITEM, mediaItem.toBundle());
       }
-      bundle.putInt(FIELD_PERIOD_INDEX, canAccessTimeline ? periodIndex : 0);
-      bundle.putLong(FIELD_POSITION_MS, canAccessCurrentMediaItem ? positionMs : 0);
-      bundle.putLong(FIELD_CONTENT_POSITION_MS, canAccessCurrentMediaItem ? contentPositionMs : 0);
-      bundle.putInt(FIELD_AD_GROUP_INDEX, canAccessCurrentMediaItem ? adGroupIndex : C.INDEX_UNSET);
-      bundle.putInt(
-          FIELD_AD_INDEX_IN_AD_GROUP, canAccessCurrentMediaItem ? adIndexInAdGroup : C.INDEX_UNSET);
+      if (periodIndex != 0) {
+        bundle.putInt(FIELD_PERIOD_INDEX, periodIndex);
+      }
+      if (positionMs != 0) {
+        bundle.putLong(FIELD_POSITION_MS, positionMs);
+      }
+      if (contentPositionMs != 0) {
+        bundle.putLong(FIELD_CONTENT_POSITION_MS, contentPositionMs);
+      }
+      if (adGroupIndex != C.INDEX_UNSET) {
+        bundle.putInt(FIELD_AD_GROUP_INDEX, adGroupIndex);
+      }
+      if (adIndexInAdGroup != C.INDEX_UNSET) {
+        bundle.putInt(FIELD_AD_INDEX_IN_AD_GROUP, adIndexInAdGroup);
+      }
       return bundle;
     }
 

libraries/common/src/main/java/androidx/media3/common/Timeline.java

@@ -1443,36 +1443,29 @@ public final Bundle toBundle() {
   }
 
   /**
-   * Returns a {@link Bundle} containing just the specified {@link Window}.
+   * Returns a copy of this timeline containing just the single specified {@link Window}.
    *
-   * <p>The {@link #getWindow(int, Window)} windows} and {@link #getPeriod(int, Period) periods} of
-   * an instance restored by {@link #CREATOR} may have missing fields as described in {@link
-   * Window#toBundle()} and {@link Period#toBundle()}.
+   * <p>The method returns the same instance if there is only one window.
    *
-   * @param windowIndex The index of the {@link Window} to include in the {@link Bundle}.
+   * @param windowIndex The index of the {@link Window} to include in the copy.
+   * @return A {@link Timeline} with just the single specified {@link Window}.
    */
   @UnstableApi
-  public final Bundle toBundleWithOneWindowOnly(int windowIndex) {
+  public final Timeline copyWithSingleWindow(int windowIndex) {
+    if (getWindowCount() == 1) {
+      return this;
+    }
     Window window = getWindow(windowIndex, new Window(), /* defaultPositionProjectionUs= */ 0);
-
-    List<Bundle> periodBundles = new ArrayList<>();
-    Period period = new Period();
+    ImmutableList.Builder<Period> periods = ImmutableList.builder();
     for (int i = window.firstPeriodIndex; i <= window.lastPeriodIndex; i++) {
-      getPeriod(i, period, /* setIds= */ false);
+      Period period = getPeriod(i, new Period(), /* setIds= */ true);
       period.windowIndex = 0;
-      periodBundles.add(period.toBundle());
+      periods.add(period);
     }
-
     window.lastPeriodIndex = window.lastPeriodIndex - window.firstPeriodIndex;
     window.firstPeriodIndex = 0;
-    Bundle windowBundle = window.toBundle();
-
-    Bundle bundle = new Bundle();
-    BundleUtil.putBinder(
-        bundle, FIELD_WINDOWS, new BundleListRetriever(ImmutableList.of(windowBundle)));
-    BundleUtil.putBinder(bundle, FIELD_PERIODS, new BundleListRetriever(periodBundles));
-    bundle.putIntArray(FIELD_SHUFFLED_WINDOW_INDICES, new int[] {0});
-    return bundle;
+    return new RemotableTimeline(
+        ImmutableList.of(window), periods.build(), /* shuffledWindowIndices= */ new int[] {0});
   }
 
   /**

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

@@ -111,8 +111,10 @@ public Bundle toBundle() {
         MediaUtils.intersect(playerCommandsFromSession, playerCommandsFromPlayer);
     bundle.putBundle(
         FIELD_PLAYER_INFO,
-        playerInfo.toBundle(
-            intersectedCommands, /* excludeTimeline= */ false, /* excludeTracks= */ false));
+        playerInfo
+            .filterByAvailableCommands(
+                intersectedCommands, /* excludeTimeline= */ false, /* excludeTracks= */ false)
+            .toBundle());
     bundle.putInt(FIELD_SESSION_INTERFACE_VERSION, sessionInterfaceVersion);
     return bundle;
   }

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

@@ -1913,17 +1913,20 @@ public void onPlayerInfoChanged(
       boolean bundlingExclusionsTracks =
           excludeTracks || !availableCommands.contains(Player.COMMAND_GET_TRACKS);
       if (controllerInterfaceVersion >= 2) {
+        PlayerInfo filteredPlayerInfo =
+            playerInfo.filterByAvailableCommands(availableCommands, excludeTimeline, excludeTracks);
         iController.onPlayerInfoChangedWithExclusions(
             sequenceNumber,
-            playerInfo.toBundle(availableCommands, excludeTimeline, excludeTracks),
+            filteredPlayerInfo.toBundle(),
             new PlayerInfo.BundlingExclusions(bundlingExclusionsTimeline, bundlingExclusionsTracks)
                 .toBundle());
       } else {
+        PlayerInfo filteredPlayerInfo =
+            playerInfo.filterByAvailableCommands(
+                availableCommands, excludeTimeline, /* excludeTracks= */ true);
         //noinspection deprecation
         iController.onPlayerInfoChanged(
-            sequenceNumber,
-            playerInfo.toBundle(availableCommands, excludeTimeline, /* excludeTracks= */ true),
-            bundlingExclusionsTimeline);
+            sequenceNumber, filteredPlayerInfo.toBundle(), bundlingExclusionsTimeline);
       }
     }
 
@@ -1992,7 +1995,9 @@ public void onPeriodicSessionPositionInfoChanged(
         throws RemoteException {
       iController.onPeriodicSessionPositionInfoChanged(
           sequenceNumber,
-          sessionPositionInfo.toBundle(canAccessCurrentMediaItem, canAccessTimeline));
+          sessionPositionInfo
+              .filterByAvailableCommands(canAccessCurrentMediaItem, canAccessTimeline)
+              .toBundle());
     }
 
     @Override