Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 91ac9df2 authored by Massimo Carli's avatar Massimo Carli
Browse files

Encapsulate AppCompat TaskInfo data 

To better decouple letterbox logic from default core logic
we encapsulate TaskInfo property specific to app compat in
AppCompatTaskInfo.

Fix: 300802163
Test: atest WMShellUnitTests:ShellTaskOrganizerTests
Test: atest WMShellUnitTests:CompatUIControllerTest
Test: atest WMShellUnitTests:CompatUILayoutTest
Test: atest WMShellUnitTests:CompatUIWindowManagerTest
Test: atest WMShellUnitTests:LetterboxEduWindowManagerTest
Test: atest WMShellUnitTests:UserAspectRatioSettingsLayoutTest
Test: atest WMShellUnitTests:UserAspectRatioSettingsWindowManagerTest
Test: atest WmTests:ActivityRecordTests
Test: atest WmTests:WindowOrganizerTests
Test: atest WmTests:SizeCompatTests
Test: atest WmTests:TaskTests

Change-Id: I8beede6b98c2818898cd004d06e57abe2c99575f
parent 6aa441aa

core/java/android/app/AppCompatTaskInfo.java

0 → 100644
+302 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2023 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package android.app;



import android.annotation.IntDef;

import android.annotation.NonNull;

import android.annotation.Nullable;

import android.os.Parcel;

import android.os.Parcelable;



import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;



/**

 * Stores App Compat information about a particular Task.

 * @hide

 */

public class AppCompatTaskInfo implements Parcelable {



    /**

     * Camera compat control isn't shown because it's not requested by heuristics.

     */

    public static final int CAMERA_COMPAT_CONTROL_HIDDEN = 0;



    /**

     * Camera compat control is shown with the treatment suggested.

     */

    public static final int CAMERA_COMPAT_CONTROL_TREATMENT_SUGGESTED = 1;



    /**

     * Camera compat control is shown to allow reverting the applied treatment.

     */

    public static final int CAMERA_COMPAT_CONTROL_TREATMENT_APPLIED = 2;



    /**

     * Camera compat control is dismissed by user.

     */

    public static final int CAMERA_COMPAT_CONTROL_DISMISSED = 3;



    /**

     * Enum for the Camera app compat control states.

     */

    @Retention(RetentionPolicy.SOURCE)

    @IntDef(prefix = { "CAMERA_COMPAT_CONTROL_" }, value = {

            CAMERA_COMPAT_CONTROL_HIDDEN,

            CAMERA_COMPAT_CONTROL_TREATMENT_SUGGESTED,

            CAMERA_COMPAT_CONTROL_TREATMENT_APPLIED,

            CAMERA_COMPAT_CONTROL_DISMISSED,

    })

    public @interface CameraCompatControlState {};



    /**

     * State of the Camera app compat control which is used to correct stretched viewfinder

     * in apps that don't handle all possible configurations and changes between them correctly.

     */

    @CameraCompatControlState

    public int cameraCompatControlState = CAMERA_COMPAT_CONTROL_HIDDEN;



    /**

     * Whether the direct top activity is eligible for letterbox education.

     */

    public boolean topActivityEligibleForLetterboxEducation;



    /**

     * Whether the direct top activity is in size compat mode on foreground.

     */

    public boolean topActivityInSizeCompat;



    /**

     * Whether the double tap is enabled.

     */

    public boolean isLetterboxDoubleTapEnabled;



    /**

     * Whether the user aspect ratio settings button is enabled.

     */

    public boolean topActivityEligibleForUserAspectRatioButton;



    /**

     * Whether the user has forced the activity to be fullscreen through the user aspect ratio

     * settings.

     */

    public boolean isUserFullscreenOverrideEnabled;



    /**

     * Hint about the letterbox state of the top activity.

     */

    public boolean topActivityBoundsLetterboxed;



    /**

     * Whether the update comes from a letterbox double-tap action from the user or not.

     */

    public boolean isFromLetterboxDoubleTap;



    /**

     * If {@link isLetterboxDoubleTapEnabled} it contains the current letterbox vertical position or

     * {@link TaskInfo.PROPERTY_VALUE_UNSET} otherwise.

     */

    public int topActivityLetterboxVerticalPosition;



    /**

     * If {@link isLetterboxDoubleTapEnabled} it contains the current letterbox vertical position or

     * {@link TaskInfo.PROPERTY_VALUE_UNSET} otherwise.

     */

    public int topActivityLetterboxHorizontalPosition;



    /**

     * If {@link isLetterboxDoubleTapEnabled} it contains the current width of the letterboxed

     * activity or {@link TaskInfo.PROPERTY_VALUE_UNSET} otherwise.

     */

    public int topActivityLetterboxWidth;



    /**

     * If {@link isLetterboxDoubleTapEnabled} it contains the current height of the letterboxed

     * activity or {@link TaskInfo.PROPERTY_VALUE_UNSET} otherwise.

     */

    public int topActivityLetterboxHeight;



    private AppCompatTaskInfo() {

        // Do nothing

    }



    @NonNull

    static AppCompatTaskInfo create() {

        return new AppCompatTaskInfo();

    }



    private AppCompatTaskInfo(Parcel source) {

        readFromParcel(source);

    }



    @Override

    public int describeContents() {

        return 0;

    }



    public static final Creator<AppCompatTaskInfo> CREATOR =

            new Creator<>() {

                @Override

                public AppCompatTaskInfo createFromParcel(Parcel in) {

                    return new AppCompatTaskInfo(in);

                }



                @Override

                public AppCompatTaskInfo[] newArray(int size) {

                    return new AppCompatTaskInfo[size];

                }

            };



    /**

     * @return {@value true} if the task has camera compat controls.

     */

    public boolean hasCameraCompatControl() {

        return cameraCompatControlState != CAMERA_COMPAT_CONTROL_HIDDEN

                && cameraCompatControlState != CAMERA_COMPAT_CONTROL_DISMISSED;

    }



    /**

     * @return {@value true} if the task has some compat ui.

     */

    public boolean hasCompatUI() {

        return hasCameraCompatControl() || topActivityInSizeCompat

                || topActivityEligibleForLetterboxEducation

                || isLetterboxDoubleTapEnabled

                || topActivityEligibleForUserAspectRatioButton;

    }



    /**

     * @return {@value true} if top activity is pillarboxed.

     */

    public boolean isTopActivityPillarboxed() {

        return topActivityLetterboxWidth < topActivityLetterboxHeight;

    }



    /**

     * @return  {@code true} if the app compat parameters that are important for task organizers

     * are equal.

     */

    public boolean equalsForTaskOrganizer(@Nullable AppCompatTaskInfo that) {

        if (that == null) {

            return false;

        }

        return isFromLetterboxDoubleTap == that.isFromLetterboxDoubleTap

                && topActivityEligibleForUserAspectRatioButton

                    == that.topActivityEligibleForUserAspectRatioButton

                && topActivityLetterboxVerticalPosition == that.topActivityLetterboxVerticalPosition

                && topActivityLetterboxWidth == that.topActivityLetterboxWidth

                && topActivityLetterboxHeight == that.topActivityLetterboxHeight

                && topActivityLetterboxHorizontalPosition

                    == that.topActivityLetterboxHorizontalPosition

                && isUserFullscreenOverrideEnabled == that.isUserFullscreenOverrideEnabled;

    }



    /**

     * @return {@code true} if parameters that are important for size compat have changed.

     */

    public boolean equalsForCompatUi(@Nullable AppCompatTaskInfo that) {

        if (that == null) {

            return false;

        }

        return topActivityInSizeCompat == that.topActivityInSizeCompat

                && isFromLetterboxDoubleTap == that.isFromLetterboxDoubleTap

                && topActivityEligibleForUserAspectRatioButton

                    == that.topActivityEligibleForUserAspectRatioButton

                && topActivityEligibleForLetterboxEducation

                    == that.topActivityEligibleForLetterboxEducation

                && topActivityLetterboxVerticalPosition == that.topActivityLetterboxVerticalPosition

                && topActivityLetterboxHorizontalPosition

                    == that.topActivityLetterboxHorizontalPosition

                && topActivityLetterboxWidth == that.topActivityLetterboxWidth

                && topActivityLetterboxHeight == that.topActivityLetterboxHeight

                && cameraCompatControlState == that.cameraCompatControlState

                && isUserFullscreenOverrideEnabled == that.isUserFullscreenOverrideEnabled;

    }



    /**

     * Reads the TaskInfo from a parcel.

     */

    void readFromParcel(Parcel source) {

        topActivityInSizeCompat = source.readBoolean();

        topActivityEligibleForLetterboxEducation = source.readBoolean();

        cameraCompatControlState = source.readInt();

        isLetterboxDoubleTapEnabled = source.readBoolean();

        topActivityEligibleForUserAspectRatioButton = source.readBoolean();

        topActivityBoundsLetterboxed = source.readBoolean();

        isFromLetterboxDoubleTap = source.readBoolean();

        topActivityLetterboxVerticalPosition = source.readInt();

        topActivityLetterboxHorizontalPosition = source.readInt();

        topActivityLetterboxWidth = source.readInt();

        topActivityLetterboxHeight = source.readInt();

        isUserFullscreenOverrideEnabled = source.readBoolean();

    }



    /**

     * Writes the TaskInfo to a parcel.

     */

    @Override

    public void writeToParcel(Parcel dest, int flags) {

        dest.writeBoolean(topActivityInSizeCompat);

        dest.writeBoolean(topActivityEligibleForLetterboxEducation);

        dest.writeInt(cameraCompatControlState);

        dest.writeBoolean(isLetterboxDoubleTapEnabled);

        dest.writeBoolean(topActivityEligibleForUserAspectRatioButton);

        dest.writeBoolean(topActivityBoundsLetterboxed);

        dest.writeBoolean(isFromLetterboxDoubleTap);

        dest.writeInt(topActivityLetterboxVerticalPosition);

        dest.writeInt(topActivityLetterboxHorizontalPosition);

        dest.writeInt(topActivityLetterboxWidth);

        dest.writeInt(topActivityLetterboxHeight);

        dest.writeBoolean(isUserFullscreenOverrideEnabled);

    }



    @Override

    public String toString() {

        return "AppCompatTaskInfo { topActivityInSizeCompat=" + topActivityInSizeCompat

                + " topActivityEligibleForLetterboxEducation= "

                + topActivityEligibleForLetterboxEducation

                + " isLetterboxDoubleTapEnabled= " + isLetterboxDoubleTapEnabled

                + " topActivityEligibleForUserAspectRatioButton= "

                + topActivityEligibleForUserAspectRatioButton

                + " topActivityBoundsLetterboxed= " + topActivityBoundsLetterboxed

                + " isFromLetterboxDoubleTap= " + isFromLetterboxDoubleTap

                + " topActivityLetterboxVerticalPosition= " + topActivityLetterboxVerticalPosition

                + " topActivityLetterboxHorizontalPosition= "

                + topActivityLetterboxHorizontalPosition

                + " topActivityLetterboxWidth=" + topActivityLetterboxWidth

                + " topActivityLetterboxHeight=" + topActivityLetterboxHeight

                + " isUserFullscreenOverrideEnabled=" + isUserFullscreenOverrideEnabled

                + " cameraCompatControlState="

                + cameraCompatControlStateToString(cameraCompatControlState)

                + "}";

    }



    /** Human readable version of the camera control state. */

    @NonNull

    public static String cameraCompatControlStateToString(

            @CameraCompatControlState int cameraCompatControlState) {

        switch (cameraCompatControlState) {

            case CAMERA_COMPAT_CONTROL_HIDDEN: return "hidden";

            case CAMERA_COMPAT_CONTROL_TREATMENT_SUGGESTED: return "treatment-suggested";

            case CAMERA_COMPAT_CONTROL_TREATMENT_APPLIED: return "treatment-applied";

            case CAMERA_COMPAT_CONTROL_DISMISSED: return "dismissed";

            default:

                throw new AssertionError(

                        "Unexpected camera compat control state: " + cameraCompatControlState);

        }

    }

}

core/java/android/app/TaskInfo.java

+18 −215

File changed.

Preview size limit exceeded, changes collapsed.

core/java/android/window/TaskOrganizer.java

+1 −1
Original line number Diff line number Diff line
@@ -24,7 +24,7 @@ import android.annotation.RequiresPermission; 
import android.annotation.SuppressLint;

import android.annotation.TestApi;

import android.app.ActivityManager;

import android.app.TaskInfo.CameraCompatControlState;

import android.app.AppCompatTaskInfo.CameraCompatControlState;

import android.os.IBinder;

import android.os.RemoteException;

import android.view.SurfaceControl;

libs/WindowManager/Shell/src/com/android/wm/shell/ShellTaskOrganizer.java

+3 −2
Original line number Diff line number Diff line
@@ -29,6 +29,7 @@ import android.annotation.IntDef; 
import android.annotation.NonNull;

import android.annotation.Nullable;

import android.app.ActivityManager.RunningTaskInfo;

import android.app.AppCompatTaskInfo;

import android.app.TaskInfo;

import android.app.WindowConfiguration;

import android.content.LocusId;
@@ -700,7 +701,7 @@ public class ShellTaskOrganizer extends TaskOrganizer implements 


    @Override

    public void onCameraControlStateUpdated(

            int taskId, @TaskInfo.CameraCompatControlState int state) {

            int taskId, @AppCompatTaskInfo.CameraCompatControlState int state) {

        final TaskAppearedInfo info;

        synchronized (mLock) {

            info = mTasks.get(taskId);
@@ -754,7 +755,7 @@ public class ShellTaskOrganizer extends TaskOrganizer implements 
        // The task is vanished or doesn't support compat UI, notify to remove compat UI

        // on this Task if there is any.

        if (taskListener == null || !taskListener.supportCompatUI()

                || !taskInfo.hasCompatUI() || !taskInfo.isVisible) {

                || !taskInfo.appCompatTaskInfo.hasCompatUI() || !taskInfo.isVisible) {

            mCompatUI.onCompatInfoChanged(taskInfo, null /* taskListener */);

            return;

        }

libs/WindowManager/Shell/src/com/android/wm/shell/compatui/CompatUIController.java

+5 −4
Original line number Diff line number Diff line
@@ -20,8 +20,8 @@ import static android.app.WindowConfiguration.WINDOWING_MODE_FULLSCREEN; 


import android.annotation.NonNull;

import android.annotation.Nullable;

import android.app.AppCompatTaskInfo.CameraCompatControlState;

import android.app.TaskInfo;

import android.app.TaskInfo.CameraCompatControlState;

import android.content.ComponentName;

import android.content.Context;

import android.content.Intent;
@@ -239,7 +239,7 @@ public class CompatUIController implements OnDisplaysChangedListener, 
     */

    public void onCompatInfoChanged(@NonNull TaskInfo taskInfo,

            @Nullable ShellTaskOrganizer.TaskListener taskListener) {

        if (taskInfo != null && !taskInfo.topActivityInSizeCompat) {

        if (taskInfo != null && !taskInfo.appCompatTaskInfo.topActivityInSizeCompat) {

            mSetOfTaskIdsShowingRestartDialog.remove(taskInfo.taskId);

        }
@@ -267,7 +267,7 @@ public class CompatUIController implements OnDisplaysChangedListener, 
                }

                return;

            }

            if (!taskInfo.isFromLetterboxDoubleTap) {

            if (!taskInfo.appCompatTaskInfo.isFromLetterboxDoubleTap) {

                createOrUpdateUserAspectRatioSettingsLayout(taskInfo, taskListener);

            }

        }
@@ -348,7 +348,8 @@ public class CompatUIController implements OnDisplaysChangedListener, 
        // as they are still relevant. Else, if the activity is visible and focused (the one the

        // user can see and is using), the user aspect ratio button can potentially be displayed so

        // start tracking the buttons visibility for this task.

        if (mTopActivityTaskId != taskInfo.taskId && !taskInfo.isTopActivityTransparent

        if (mTopActivityTaskId != taskInfo.taskId

                && !taskInfo.isTopActivityTransparent

                && taskInfo.isVisible && taskInfo.isFocused) {

            mTopActivityTaskId = taskInfo.taskId;

            setHasShownUserAspectRatioSettingsButton(false);