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

Commit 407ea1ad authored by Mateusz Cicheński's avatar Mateusz Cicheński
Browse files

Add keep clear area avoidance algorithm for PiP 

The algorithm computes a new position for PiP based on the registered
keep clear areas within the system. If no occlusion happens the original
position is being returned. Otherwise, the bounds are moved in one of the
available directions so that none of the keep clear areas are occluded
while keeping PiP within the display bounds.

Test: atest PipKeepClearAlgorithmTest
Bug: 183746978
Change-Id: Ic2d11861329a46e2da0448f90283f67f6e7125d7
parent 83f04c01

libs/WindowManager/Shell/src/com/android/wm/shell/dagger/WMShellModule.java

+11 −2
Original line number Diff line number Diff line
@@ -63,6 +63,7 @@ import com.android.wm.shell.pip.PipTransitionState; 
import com.android.wm.shell.pip.PipUiEventLogger;

import com.android.wm.shell.pip.phone.PhonePipMenuController;

import com.android.wm.shell.pip.phone.PipController;

import com.android.wm.shell.pip.phone.PipKeepClearAlgorithm;

import com.android.wm.shell.pip.phone.PipMotionHelper;

import com.android.wm.shell.pip.phone.PipTouchHandler;

import com.android.wm.shell.recents.RecentTasksController;
@@ -188,7 +189,8 @@ public class WMShellModule { 
    @Provides

    static Optional<Pip> providePip(Context context, DisplayController displayController,

            PipAppOpsListener pipAppOpsListener, PipBoundsAlgorithm pipBoundsAlgorithm,

            PipBoundsState pipBoundsState, PipMediaController pipMediaController,

            PipKeepClearAlgorithm pipKeepClearAlgorithm, PipBoundsState pipBoundsState,

            PipMotionHelper pipMotionHelper, PipMediaController pipMediaController,

            PhonePipMenuController phonePipMenuController, PipTaskOrganizer pipTaskOrganizer,

            PipTouchHandler pipTouchHandler, PipTransitionController pipTransitionController,

            WindowManagerShellWrapper windowManagerShellWrapper,
@@ -197,7 +199,8 @@ public class WMShellModule { 
            Optional<OneHandedController> oneHandedController,

            @ShellMainThread ShellExecutor mainExecutor) {

        return Optional.ofNullable(PipController.create(context, displayController,

                pipAppOpsListener, pipBoundsAlgorithm, pipBoundsState,

                pipAppOpsListener, pipBoundsAlgorithm, pipKeepClearAlgorithm, pipBoundsState,

                pipMotionHelper,

                pipMediaController, phonePipMenuController, pipTaskOrganizer,

                pipTouchHandler, pipTransitionController, windowManagerShellWrapper,

                taskStackListener, pipParamsChangedForwarder, oneHandedController, mainExecutor));
@@ -215,6 +218,12 @@ public class WMShellModule { 
        return new PipSnapAlgorithm();

    }



    @WMSingleton

    @Provides

    static PipKeepClearAlgorithm providePipKeepClearAlgorithm() {

        return new PipKeepClearAlgorithm();

    }



    @WMSingleton

    @Provides

    static PipBoundsAlgorithm providesPipBoundsAlgorithm(Context context,

libs/WindowManager/Shell/src/com/android/wm/shell/pip/phone/PipController.java

+9 −2
Original line number Diff line number Diff line
@@ -110,7 +110,9 @@ public class PipController implements PipTransitionController.PipTransitionCallb 
    private PipAppOpsListener mAppOpsListener;

    private PipMediaController mMediaController;

    private PipBoundsAlgorithm mPipBoundsAlgorithm;

    private PipKeepClearAlgorithm mPipKeepClearAlgorithm;

    private PipBoundsState mPipBoundsState;

    private PipMotionHelper mPipMotionHelper;

    private PipTouchHandler mTouchHandler;

    private PipTransitionController mPipTransitionController;

    private TaskStackListenerImpl mTaskStackListener;
@@ -286,7 +288,8 @@ public class PipController implements PipTransitionController.PipTransitionCallb 
    @Nullable

    public static Pip create(Context context, DisplayController displayController,

            PipAppOpsListener pipAppOpsListener, PipBoundsAlgorithm pipBoundsAlgorithm,

            PipBoundsState pipBoundsState, PipMediaController pipMediaController,

            PipKeepClearAlgorithm pipKeepClearAlgorithm, PipBoundsState pipBoundsState,

            PipMotionHelper pipMotionHelper, PipMediaController pipMediaController,

            PhonePipMenuController phonePipMenuController, PipTaskOrganizer pipTaskOrganizer,

            PipTouchHandler pipTouchHandler, PipTransitionController pipTransitionController,

            WindowManagerShellWrapper windowManagerShellWrapper,
@@ -301,7 +304,7 @@ public class PipController implements PipTransitionController.PipTransitionCallb 
        }



        return new PipController(context, displayController, pipAppOpsListener, pipBoundsAlgorithm,

                pipBoundsState, pipMediaController,

                pipKeepClearAlgorithm, pipBoundsState, pipMotionHelper, pipMediaController,

                phonePipMenuController, pipTaskOrganizer, pipTouchHandler, pipTransitionController,

                windowManagerShellWrapper, taskStackListener, pipParamsChangedForwarder,

                oneHandedController, mainExecutor)
@@ -312,7 +315,9 @@ public class PipController implements PipTransitionController.PipTransitionCallb 
            DisplayController displayController,

            PipAppOpsListener pipAppOpsListener,

            PipBoundsAlgorithm pipBoundsAlgorithm,

            PipKeepClearAlgorithm pipKeepClearAlgorithm,

            @NonNull PipBoundsState pipBoundsState,

            PipMotionHelper pipMotionHelper,

            PipMediaController pipMediaController,

            PhonePipMenuController phonePipMenuController,

            PipTaskOrganizer pipTaskOrganizer,
@@ -335,7 +340,9 @@ public class PipController implements PipTransitionController.PipTransitionCallb 
        mWindowManagerShellWrapper = windowManagerShellWrapper;

        mDisplayController = displayController;

        mPipBoundsAlgorithm = pipBoundsAlgorithm;

        mPipKeepClearAlgorithm = pipKeepClearAlgorithm;

        mPipBoundsState = pipBoundsState;

        mPipMotionHelper = pipMotionHelper;

        mPipTaskOrganizer = pipTaskOrganizer;

        mMainExecutor = mainExecutor;

        mMediaController = pipMediaController;

libs/WindowManager/Shell/src/com/android/wm/shell/pip/phone/PipKeepClearAlgorithm.java

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

 * Copyright (C) 2022 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 com.android.wm.shell.pip.phone;



import android.graphics.Rect;

import android.util.ArraySet;



import com.android.wm.shell.pip.PipBoundsAlgorithm;

import com.android.wm.shell.pip.PipBoundsState;



import java.util.Set;



/**

 * Calculates the adjusted position that does not occlude keep clear areas.

 */

public class PipKeepClearAlgorithm {



    /**

     * Adjusts the current position of PiP to avoid occluding keep clear areas. If the user has

     * moved PiP manually, the unmodified current position will be returned instead.

     */

    public Rect adjust(PipBoundsState boundsState, PipBoundsAlgorithm boundsAlgorithm) {

        if (boundsState.hasUserResizedPip()) {

            return boundsState.getBounds();

        }

        return adjust(boundsAlgorithm.getEntryDestinationBounds(),

                boundsState.getRestrictedKeepClearAreas(),

                boundsState.getUnrestrictedKeepClearAreas(), boundsState.getDisplayBounds());

    }



    /** Returns a new {@code Rect} that does not occlude the provided keep clear areas. */

    public Rect adjust(Rect defaultBounds, Set<Rect> restrictedKeepClearAreas,

            Set<Rect> unrestrictedKeepClearAreas, Rect displayBounds) {

        if (restrictedKeepClearAreas.isEmpty()) {

            return defaultBounds;

        }

        Set<Rect> keepClearAreas = new ArraySet<>();

        if (!restrictedKeepClearAreas.isEmpty()) {

            keepClearAreas.addAll(restrictedKeepClearAreas);

        }

        Rect outBounds = new Rect(defaultBounds);

        for (Rect r : keepClearAreas) {

            if (Rect.intersects(r, outBounds)) {

                if (tryOffsetUp(outBounds, r, displayBounds)) continue;

                if (tryOffsetLeft(outBounds, r, displayBounds)) continue;

                if (tryOffsetDown(outBounds, r, displayBounds)) continue;

                if (tryOffsetRight(outBounds, r, displayBounds)) continue;

            }

        }

        return outBounds;

    }



    private boolean tryOffsetLeft(Rect rectToMove, Rect rectToAvoid, Rect displayBounds) {

        return tryOffset(rectToMove, rectToAvoid, displayBounds,

                rectToAvoid.left - rectToMove.right, 0);

    }



    private boolean tryOffsetRight(Rect rectToMove, Rect rectToAvoid, Rect displayBounds) {

        return tryOffset(rectToMove, rectToAvoid, displayBounds,

                rectToAvoid.right - rectToMove.left, 0);

    }



    private boolean tryOffsetUp(Rect rectToMove, Rect rectToAvoid, Rect displayBounds) {

        return tryOffset(rectToMove, rectToAvoid, displayBounds,

                0, rectToAvoid.top - rectToMove.bottom);

    }



    private boolean tryOffsetDown(Rect rectToMove, Rect rectToAvoid, Rect displayBounds) {

        return tryOffset(rectToMove, rectToAvoid, displayBounds,

                0, rectToAvoid.bottom - rectToMove.top);

    }



    private boolean tryOffset(Rect rectToMove, Rect rectToAvoid, Rect displayBounds,

            int dx, int dy) {

        Rect tmp = new Rect(rectToMove);

        tmp.offset(dx, dy);

        if (!Rect.intersects(rectToAvoid, tmp) && displayBounds.contains(tmp)) {

            rectToMove.offsetTo(tmp.left, tmp.top);

            return true;

        }

        return false;

    }

}

libs/WindowManager/Shell/tests/unittest/src/com/android/wm/shell/pip/phone/PipControllerTest.java

+5 −2
Original line number Diff line number Diff line
@@ -76,6 +76,7 @@ public class PipControllerTest extends ShellTestCase { 
    @Mock private PhonePipMenuController mMockPhonePipMenuController;

    @Mock private PipAppOpsListener mMockPipAppOpsListener;

    @Mock private PipBoundsAlgorithm mMockPipBoundsAlgorithm;

    @Mock private PipKeepClearAlgorithm mMockPipKeepClearAlgorithm;

    @Mock private PipSnapAlgorithm mMockPipSnapAlgorithm;

    @Mock private PipMediaController mMockPipMediaController;

    @Mock private PipTaskOrganizer mMockPipTaskOrganizer;
@@ -101,7 +102,8 @@ public class PipControllerTest extends ShellTestCase { 
        }).when(mMockExecutor).execute(any());

        mPipController = new PipController(mContext, mMockDisplayController,

                mMockPipAppOpsListener, mMockPipBoundsAlgorithm,

                mMockPipBoundsState, mMockPipMediaController,

                mMockPipKeepClearAlgorithm,

                mMockPipBoundsState, mMockPipMotionHelper, mMockPipMediaController,

                mMockPhonePipMenuController, mMockPipTaskOrganizer, mMockPipTouchHandler,

                mMockPipTransitionController, mMockWindowManagerShellWrapper,

                mMockTaskStackListener, mPipParamsChangedForwarder,
@@ -134,7 +136,8 @@ public class PipControllerTest extends ShellTestCase { 


        assertNull(PipController.create(spyContext, mMockDisplayController,

                mMockPipAppOpsListener, mMockPipBoundsAlgorithm,

                mMockPipBoundsState, mMockPipMediaController,

                mMockPipKeepClearAlgorithm,

                mMockPipBoundsState, mMockPipMotionHelper, mMockPipMediaController,

                mMockPhonePipMenuController, mMockPipTaskOrganizer, mMockPipTouchHandler,

                mMockPipTransitionController, mMockWindowManagerShellWrapper,

                mMockTaskStackListener, mPipParamsChangedForwarder,

libs/WindowManager/Shell/tests/unittest/src/com/android/wm/shell/pip/phone/PipKeepClearAlgorithmTest.java

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

 * Copyright (C) 2022 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 com.android.wm.shell.pip.phone;



import static org.junit.Assert.assertEquals;

import static org.junit.Assert.assertFalse;



import android.graphics.Rect;

import android.testing.AndroidTestingRunner;

import android.testing.TestableLooper;



import androidx.test.filters.SmallTest;



import com.android.wm.shell.ShellTestCase;



import org.junit.Before;

import org.junit.Test;

import org.junit.runner.RunWith;



import java.util.Set;



/**

 * Unit tests against {@link PipKeepClearAlgorithm}.

 */

@RunWith(AndroidTestingRunner.class)

@SmallTest

@TestableLooper.RunWithLooper(setAsMainLooper = true)

public class PipKeepClearAlgorithmTest extends ShellTestCase {



    private PipKeepClearAlgorithm mPipKeepClearAlgorithm;

    private static final Rect DISPLAY_BOUNDS = new Rect(0, 0, 1000, 1000);



    @Before

    public void setUp() throws Exception {

        mPipKeepClearAlgorithm = new PipKeepClearAlgorithm();

    }



    @Test

    public void adjust_withCollidingRestrictedKeepClearAreas_movesBounds() {

        final Rect inBounds = new Rect(0, 0, 100, 100);

        final Rect keepClearRect = new Rect(50, 50, 150, 150);



        final Rect outBounds = mPipKeepClearAlgorithm.adjust(inBounds, Set.of(keepClearRect),

                Set.of(), DISPLAY_BOUNDS);



        assertFalse(outBounds.contains(keepClearRect));

    }



    @Test

    public void adjust_withNonCollidingRestrictedKeepClearAreas_boundsDoNotChange() {

        final Rect inBounds = new Rect(0, 0, 100, 100);

        final Rect keepClearRect = new Rect(100, 100, 150, 150);



        final Rect outBounds = mPipKeepClearAlgorithm.adjust(inBounds, Set.of(keepClearRect),

                Set.of(), DISPLAY_BOUNDS);



        assertEquals(inBounds, outBounds);

    }



    @Test

    public void adjust_withCollidingUnrestrictedKeepClearAreas_boundsDoNotChange() {

        // TODO(b/183746978): update this test to accommodate for the updated algorithm

        final Rect inBounds = new Rect(0, 0, 100, 100);

        final Rect keepClearRect = new Rect(50, 50, 150, 150);



        final Rect outBounds = mPipKeepClearAlgorithm.adjust(inBounds, Set.of(),

                Set.of(keepClearRect), DISPLAY_BOUNDS);



        assertEquals(inBounds, outBounds);

    }



    @Test

    public void adjust_withNonCollidingUnrestrictedKeepClearAreas_boundsDoNotChange() {

        final Rect inBounds = new Rect(0, 0, 100, 100);

        final Rect keepClearRect = new Rect(100, 100, 150, 150);



        final Rect outBounds = mPipKeepClearAlgorithm.adjust(inBounds, Set.of(),

                Set.of(keepClearRect), DISPLAY_BOUNDS);



        assertEquals(inBounds, outBounds);

    }

}