Add API to prefer docking big overlays
Bug: 216749913
Bug: 203647003
Test: atest PinnedStackTests#testPreferDockBigOverlaysWithExpandedPip
Change-Id: I6add690d54b8fb1061a1b5c9e5fe2f856f8019d0
diff --git a/core/api/current.txt b/core/api/current.txt
index 34497d1..685bfe5 100644
--- a/core/api/current.txt
+++ b/core/api/current.txt
@@ -4274,6 +4274,7 @@
method public void setLocusContext(@Nullable android.content.LocusId, @Nullable android.os.Bundle);
method public final void setMediaController(android.media.session.MediaController);
method public void setPictureInPictureParams(@NonNull android.app.PictureInPictureParams);
+ method public void setPreferDockBigOverlays(boolean);
method @Deprecated public final void setProgress(int);
method @Deprecated public final void setProgressBarIndeterminate(boolean);
method @Deprecated public final void setProgressBarIndeterminateVisibility(boolean);
diff --git a/core/api/test-current.txt b/core/api/test-current.txt
index 84b393a..3968a40 100644
--- a/core/api/test-current.txt
+++ b/core/api/test-current.txt
@@ -411,6 +411,7 @@
method @NonNull public android.content.res.Configuration getConfiguration();
method public int getParentTaskId();
method @Nullable public android.app.PictureInPictureParams getPictureInPictureParams();
+ method public boolean getPreferDockBigOverlays();
method @NonNull public android.window.WindowContainerToken getToken();
method public boolean hasParentTask();
}
diff --git a/core/java/android/app/Activity.java b/core/java/android/app/Activity.java
index 983dde3..7cb7ce5 100644
--- a/core/java/android/app/Activity.java
+++ b/core/java/android/app/Activity.java
@@ -2955,6 +2955,27 @@
return false;
}
+ /**
+ * Specifies a preference to dock big overlays like the expanded picture-in-picture on TV
+ * (see {@link PictureInPictureParams.Builder#setExpandedAspectRatio}). Docking puts the
+ * big overlay side-by-side next to this activity, so that both windows are fully visible to
+ * the user.
+ *
+ * <p> If unspecified, whether the overlay window will be docked or not, will be defined
+ * by the system.
+ *
+ * <p> If specified, the system will try to respect the preference, but it may be
+ * overridden by a user preference.
+ *
+ * @param preferDockBigOverlays indicates that the activity prefers big overlays to be
+ * docked next to it instead of overlaying its content
+ *
+ * @see PictureInPictureParams.Builder#setExpandedAspectRatio
+ */
+ public void setPreferDockBigOverlays(boolean preferDockBigOverlays) {
+ ActivityClient.getInstance().setPreferDockBigOverlays(mToken, preferDockBigOverlays);
+ }
+
void dispatchMovedToDisplay(int displayId, Configuration config) {
updateDisplay(displayId);
onMovedToDisplay(displayId, config);
diff --git a/core/java/android/app/ActivityClient.java b/core/java/android/app/ActivityClient.java
index 4715e0f..cf8480c 100644
--- a/core/java/android/app/ActivityClient.java
+++ b/core/java/android/app/ActivityClient.java
@@ -324,6 +324,14 @@
}
}
+ void setPreferDockBigOverlays(IBinder token, boolean preferDockBigOverlays) {
+ try {
+ getActivityClientController().setPreferDockBigOverlays(token, preferDockBigOverlays);
+ } catch (RemoteException e) {
+ e.rethrowFromSystemServer();
+ }
+ }
+
void toggleFreeformWindowingMode(IBinder token) {
try {
getActivityClientController().toggleFreeformWindowingMode(token);
diff --git a/core/java/android/app/IActivityClientController.aidl b/core/java/android/app/IActivityClientController.aidl
index f9439cb..caf1c41b7 100644
--- a/core/java/android/app/IActivityClientController.aidl
+++ b/core/java/android/app/IActivityClientController.aidl
@@ -88,6 +88,7 @@
boolean enterPictureInPictureMode(in IBinder token, in PictureInPictureParams params);
void setPictureInPictureParams(in IBinder token, in PictureInPictureParams params);
+ oneway void setPreferDockBigOverlays(in IBinder token, in boolean preferDockBigOverlays);
void toggleFreeformWindowingMode(in IBinder token);
oneway void startLockTaskModeByToken(in IBinder token);
diff --git a/core/java/android/app/TaskInfo.java b/core/java/android/app/TaskInfo.java
index 3d2c03d..eca4170 100644
--- a/core/java/android/app/TaskInfo.java
+++ b/core/java/android/app/TaskInfo.java
@@ -186,6 +186,11 @@
public PictureInPictureParams pictureInPictureParams;
/**
+ * @hide
+ */
+ public boolean preferDockBigOverlays;
+
+ /**
* The {@link Rect} copied from {@link DisplayCutout#getSafeInsets()} if the cutout is not of
* (LAYOUT_IN_DISPLAY_CUTOUT_MODE_SHORT_EDGES, LAYOUT_IN_DISPLAY_CUTOUT_MODE_ALWAYS),
* {@code null} otherwise.
@@ -379,6 +384,12 @@
}
/** @hide */
+ @TestApi
+ public boolean getPreferDockBigOverlays() {
+ return preferDockBigOverlays;
+ }
+
+ /** @hide */
@WindowConfiguration.WindowingMode
public int getWindowingMode() {
return configuration.windowConfiguration.getWindowingMode();
@@ -447,6 +458,7 @@
&& displayAreaFeatureId == that.displayAreaFeatureId
&& Objects.equals(positionInParent, that.positionInParent)
&& Objects.equals(pictureInPictureParams, that.pictureInPictureParams)
+ && Objects.equals(preferDockBigOverlays, that.preferDockBigOverlays)
&& Objects.equals(displayCutoutInsets, that.displayCutoutInsets)
&& getWindowingMode() == that.getWindowingMode()
&& Objects.equals(taskDescription, that.taskDescription)
@@ -503,6 +515,7 @@
token = WindowContainerToken.CREATOR.createFromParcel(source);
topActivityType = source.readInt();
pictureInPictureParams = source.readTypedObject(PictureInPictureParams.CREATOR);
+ preferDockBigOverlays = source.readBoolean();
displayCutoutInsets = source.readTypedObject(Rect.CREATOR);
topActivityInfo = source.readTypedObject(ActivityInfo.CREATOR);
isResizeable = source.readBoolean();
@@ -548,6 +561,7 @@
token.writeToParcel(dest, flags);
dest.writeInt(topActivityType);
dest.writeTypedObject(pictureInPictureParams, flags);
+ dest.writeBoolean(preferDockBigOverlays);
dest.writeTypedObject(displayCutoutInsets, flags);
dest.writeTypedObject(topActivityInfo, flags);
dest.writeBoolean(isResizeable);
@@ -587,6 +601,7 @@
+ " token=" + token
+ " topActivityType=" + topActivityType
+ " pictureInPictureParams=" + pictureInPictureParams
+ + " preferDockBigOverlays=" + preferDockBigOverlays
+ " displayCutoutSafeInsets=" + displayCutoutInsets
+ " topActivityInfo=" + topActivityInfo
+ " launchCookies=" + launchCookies
diff --git a/core/res/res/values-television/config.xml b/core/res/res/values-television/config.xml
index 009df4a..06fa891 100644
--- a/core/res/res/values-television/config.xml
+++ b/core/res/res/values-television/config.xml
@@ -45,6 +45,10 @@
<item name="config_pictureInPictureExpandedVerticalWidth"
format="dimension" type="dimen">110dp</item>
+ <!-- The behavior when an activity has not specified a preference to dock big overlays or not.
+ Docking puts the activity side-by-side next to the big overlay windows. -->
+ <bool name="config_dockBigOverlayWindows">true</bool>
+
<!-- Whether the device uses the default focus highlight when focus state isn't specified. -->
<bool name="config_useDefaultFocusHighlight">false</bool>
diff --git a/core/res/res/values/config.xml b/core/res/res/values/config.xml
index 5e6d05a..75ff52c 100644
--- a/core/res/res/values/config.xml
+++ b/core/res/res/values/config.xml
@@ -3730,6 +3730,10 @@
must be no less than 3 for back compatibility. -->
<integer name="config_pictureInPictureMaxNumberOfActions">3</integer>
+ <!-- The behavior when an activity has not specified a preference to dock big overlays or not.
+ Docking puts the activity side-by-side next to the big overlay windows. -->
+ <bool name="config_dockBigOverlayWindows">false</bool>
+
<!-- Controls the snap mode for the docked stack divider
0 - 3 snap targets: left/top has 16:9 ratio, 1:1, and right/bottom has 16:9 ratio
1 - 3 snap targets: fixed ratio, 1:1, (1 - fixed ratio)
diff --git a/core/res/res/values/symbols.xml b/core/res/res/values/symbols.xml
index 0190451..ef78fb3 100644
--- a/core/res/res/values/symbols.xml
+++ b/core/res/res/values/symbols.xml
@@ -417,6 +417,7 @@
<java-symbol type="integer" name="config_pictureInPictureMaxNumberOfActions" />
<java-symbol type="dimen" name="config_pictureInPictureExpandedHorizontalHeight" />
<java-symbol type="dimen" name="config_pictureInPictureExpandedVerticalWidth" />
+ <java-symbol type="bool" name="config_dockBigOverlayWindows" />
<java-symbol type="dimen" name="config_closeToSquareDisplayMaxAspectRatio" />
<java-symbol type="integer" name="config_burnInProtectionMinHorizontalOffset" />
<java-symbol type="integer" name="config_burnInProtectionMaxHorizontalOffset" />
diff --git a/services/core/java/com/android/server/wm/ActivityClientController.java b/services/core/java/com/android/server/wm/ActivityClientController.java
index 76e1c43..a4a200d 100644
--- a/services/core/java/com/android/server/wm/ActivityClientController.java
+++ b/services/core/java/com/android/server/wm/ActivityClientController.java
@@ -756,6 +756,19 @@
}
}
+ @Override
+ public void setPreferDockBigOverlays(IBinder token, boolean preferDockBigOverlays) {
+ final long origId = Binder.clearCallingIdentity();
+ try {
+ synchronized (mGlobalLock) {
+ final ActivityRecord r = ActivityRecord.forTokenLocked(token);
+ r.setPreferDockBigOverlays(preferDockBigOverlays);
+ }
+ } finally {
+ Binder.restoreCallingIdentity(origId);
+ }
+ }
+
/**
* Splash screen view is attached to activity.
*/
diff --git a/services/core/java/com/android/server/wm/ActivityRecord.java b/services/core/java/com/android/server/wm/ActivityRecord.java
index dc53cc6..4571e62 100644
--- a/services/core/java/com/android/server/wm/ActivityRecord.java
+++ b/services/core/java/com/android/server/wm/ActivityRecord.java
@@ -530,6 +530,7 @@
// activity can enter picture in picture while pausing (only when switching to another task)
PictureInPictureParams pictureInPictureArgs = new PictureInPictureParams.Builder().build();
// The PiP params used when deferring the entering of picture-in-picture.
+ boolean preferDockBigOverlays;
int launchCount; // count of launches since last state
long lastLaunchTime; // time of last launch of this activity
ComponentName requestedVrComponent; // the requested component for handling VR mode.
@@ -1956,6 +1957,8 @@
mLetterboxUiController = new LetterboxUiController(mWmService, this);
mCameraCompatControlEnabled = mWmService.mContext.getResources()
.getBoolean(R.bool.config_isCameraCompatControlForStretchedIssuesEnabled);
+ preferDockBigOverlays = mWmService.mContext.getResources()
+ .getBoolean(R.bool.config_dockBigOverlayWindows);
if (_createTime > 0) {
createTime = _createTime;
@@ -9430,6 +9433,11 @@
getTask().getRootTask().onPictureInPictureParamsChanged();
}
+ void setPreferDockBigOverlays(boolean preferDockBigOverlays) {
+ this.preferDockBigOverlays = preferDockBigOverlays;
+ getTask().getRootTask().onPreferDockBigOverlaysChanged();
+ }
+
@Override
boolean isSyncFinished() {
if (!super.isSyncFinished()) return false;
diff --git a/services/core/java/com/android/server/wm/Task.java b/services/core/java/com/android/server/wm/Task.java
index f7c5b26..58cf4bb 100644
--- a/services/core/java/com/android/server/wm/Task.java
+++ b/services/core/java/com/android/server/wm/Task.java
@@ -3397,6 +3397,7 @@
info.positionInParent = getRelativePosition();
info.pictureInPictureParams = getPictureInPictureParams(top);
+ info.preferDockBigOverlays = getPreferDockBigOverlays();
info.displayCutoutInsets = top != null ? top.getDisplayCutoutInsets() : null;
info.topActivityInfo = mReuseActivitiesReport.top != null
? mReuseActivitiesReport.top.info
@@ -3443,6 +3444,11 @@
? null : new PictureInPictureParams(topMostActivity.pictureInPictureArgs);
}
+ private boolean getPreferDockBigOverlays() {
+ final ActivityRecord topMostActivity = getTopMostActivity();
+ return topMostActivity != null && topMostActivity.preferDockBigOverlays;
+ }
+
Rect getDisplayCutoutInsets() {
if (mDisplayContent == null || getDisplayInfo().displayCutout == null) return null;
final WindowState w = getTopVisibleAppMainWindow();
@@ -4336,6 +4342,10 @@
}
}
+ void onPreferDockBigOverlaysChanged() {
+ dispatchTaskInfoChangedIfNeeded(true /* force */);
+ }
+
/** Called when the top activity in the Root Task enters or exits size compat mode. */
void onSizeCompatActivityChanged() {
// Trigger TaskInfoChanged to update the size compat restart button.