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

Commit c9be3f36 authored by Hongwei Wang's avatar Hongwei Wang
Browse files

Add separated Pip1 and Pip2 dagger module 

- Moved all legacy PiP related to its own Pip1Module and
  Pip1SharedModule (shared with TvPipModule)
- Added a placeholder Pip2Module
- Hold all PiP related dependencies to dagger.pip package
- Abstract the experiment flag based selection of class to dedicated
  PipModule and expose that only to WMShellModule

Changed also constructors to not register for wm/ shell callbacks by
default. This is to prevent implementations from both legacy and pip2
listening for same events, which can cause undefined behavior.

TODO

- Move shared classes between the legacy and new PiP implementation to a
  separated package
- Refactor PipTransitionController as an interface can be shared in
  between legacy and new implementations, this should be the only
  external dependency for PiP

Bug: 291996784
Test: m -j SystemUIGoogle
Change-Id: I0d15ce2aa77e0452d12a6e8e1fd9568261ec11e0
parent aeb77b50

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

+1 −0
Original line number Diff line number Diff line
@@ -31,6 +31,7 @@ import com.android.wm.shell.common.SyncTransactionQueue; 
import com.android.wm.shell.common.SystemWindows;

import com.android.wm.shell.common.TransactionPool;

import com.android.wm.shell.common.annotations.ShellMainThread;

import com.android.wm.shell.dagger.pip.TvPipModule;

import com.android.wm.shell.draganddrop.DragAndDropController;

import com.android.wm.shell.recents.RecentTasksController;

import com.android.wm.shell.splitscreen.SplitScreenController;

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

+2 −43
Original line number Diff line number Diff line
@@ -20,7 +20,6 @@ import static com.android.wm.shell.onehanded.OneHandedController.SUPPORT_ONE_HAN 


import android.app.ActivityTaskManager;

import android.content.Context;

import android.content.pm.PackageManager;

import android.os.Handler;

import android.os.SystemProperties;

import android.view.IWindowManager;
@@ -45,7 +44,6 @@ import com.android.wm.shell.common.DisplayImeController; 
import com.android.wm.shell.common.DisplayInsetsController;

import com.android.wm.shell.common.DisplayLayout;

import com.android.wm.shell.common.DockStateReader;

import com.android.wm.shell.common.FloatingContentCoordinator;

import com.android.wm.shell.common.LaunchAdjacentController;

import com.android.wm.shell.common.ShellExecutor;

import com.android.wm.shell.common.SyncTransactionQueue;
@@ -76,10 +74,6 @@ import com.android.wm.shell.keyguard.KeyguardTransitions; 
import com.android.wm.shell.onehanded.OneHanded;

import com.android.wm.shell.onehanded.OneHandedController;

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

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

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

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

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

import com.android.wm.shell.recents.RecentTasks;

import com.android.wm.shell.recents.RecentTasksController;

import com.android.wm.shell.recents.RecentsTransitionHandler;
@@ -103,13 +97,13 @@ import com.android.wm.shell.unfold.UnfoldAnimationController; 
import com.android.wm.shell.unfold.UnfoldTransitionHandler;

import com.android.wm.shell.windowdecor.WindowDecorViewModel;



import java.util.Optional;



import dagger.BindsOptionalOf;

import dagger.Lazy;

import dagger.Module;

import dagger.Provides;



import java.util.Optional;



/**

 * Provides basic dependencies from {@link com.android.wm.shell}, these dependencies are only

 * accessible from components within the WM subcomponent (can be explicitly exposed to the
@@ -469,40 +463,6 @@ public abstract class WMShellBaseModule { 
        return Optional.empty();

    }



    //

    // Pip (optional feature)

    //



    @WMSingleton

    @Provides

    static FloatingContentCoordinator provideFloatingContentCoordinator() {

        return new FloatingContentCoordinator();

    }



    // Needs handler for registering broadcast receivers

    @WMSingleton

    @Provides

    static PipMediaController providePipMediaController(Context context,

            @ShellMainThread Handler mainHandler) {

        return new PipMediaController(context, mainHandler);

    }



    @WMSingleton

    @Provides

    static PipSurfaceTransactionHelper providePipSurfaceTransactionHelper(Context context) {

        return new PipSurfaceTransactionHelper(context);

    }



    @WMSingleton

    @Provides

    static PipUiEventLogger providePipUiEventLogger(UiEventLogger uiEventLogger,

            PackageManager packageManager) {

        return new PipUiEventLogger(uiEventLogger, packageManager);

    }



    @BindsOptionalOf

    abstract PipTouchHandler optionalPipTouchHandler();



    //

    // Recent tasks

    //
@@ -838,7 +798,6 @@ public abstract class WMShellBaseModule { 
            Optional<BubbleController> bubblesOptional,

            Optional<SplitScreenController> splitScreenOptional,

            Optional<Pip> pipOptional,

            Optional<PipTouchHandler> pipTouchHandlerOptional,

            FullscreenTaskListener fullscreenTaskListener,

            Optional<UnfoldAnimationController> unfoldAnimationController,

            Optional<UnfoldTransitionHandler> unfoldTransitionHandler,

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

+10 −215
Original line number Diff line number Diff line
@@ -16,6 +16,7 @@ 


package com.android.wm.shell.dagger;



import android.annotation.Nullable;

import android.content.Context;

import android.content.pm.LauncherApps;

import android.os.Handler;
@@ -46,13 +47,12 @@ import com.android.wm.shell.common.FloatingContentCoordinator; 
import com.android.wm.shell.common.LaunchAdjacentController;

import com.android.wm.shell.common.ShellExecutor;

import com.android.wm.shell.common.SyncTransactionQueue;

import com.android.wm.shell.common.SystemWindows;

import com.android.wm.shell.common.TabletopModeController;

import com.android.wm.shell.common.TaskStackListenerImpl;

import com.android.wm.shell.common.TransactionPool;

import com.android.wm.shell.common.annotations.ShellAnimationThread;

import com.android.wm.shell.common.annotations.ShellBackgroundThread;

import com.android.wm.shell.common.annotations.ShellMainThread;

import com.android.wm.shell.dagger.pip.PipModule;

import com.android.wm.shell.desktopmode.DesktopModeController;

import com.android.wm.shell.desktopmode.DesktopModeStatus;

import com.android.wm.shell.desktopmode.DesktopModeTaskRepository;
@@ -67,27 +67,7 @@ import com.android.wm.shell.freeform.FreeformTaskTransitionHandler; 
import com.android.wm.shell.freeform.FreeformTaskTransitionObserver;

import com.android.wm.shell.keyguard.KeyguardTransitionHandler;

import com.android.wm.shell.onehanded.OneHandedController;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

import com.android.wm.shell.recents.RecentTasksController;

import com.android.wm.shell.recents.RecentsTransitionHandler;

import com.android.wm.shell.splitscreen.SplitScreenController;
@@ -127,7 +107,10 @@ import java.util.Optional; 
 * This module only defines Shell dependencies for handheld SystemUI implementation.  Common

 * dependencies should go into {@link WMShellBaseModule}.

 */

@Module(includes = WMShellBaseModule.class)

@Module(includes = {

        WMShellBaseModule.class,

        PipModule.class

})

public abstract class WMShellModule {



    //
@@ -350,195 +333,6 @@ public abstract class WMShellModule { 
                windowDecorViewModel, mainExecutor);

    }



    //

    // Pip

    //



    @WMSingleton

    @Provides

    static Optional<Pip> providePip(Context context,

            ShellInit shellInit,

            ShellCommandHandler shellCommandHandler,

            ShellController shellController,

            DisplayController displayController,

            PipAnimationController pipAnimationController,

            PipAppOpsListener pipAppOpsListener,

            PipBoundsAlgorithm pipBoundsAlgorithm,

            PhonePipKeepClearAlgorithm pipKeepClearAlgorithm,

            PipBoundsState pipBoundsState,

            PipSizeSpecHandler pipSizeSpecHandler,

            PipDisplayLayoutState pipDisplayLayoutState,

            PipMotionHelper pipMotionHelper,

            PipMediaController pipMediaController,

            PhonePipMenuController phonePipMenuController,

            PipTaskOrganizer pipTaskOrganizer,

            PipTransitionState pipTransitionState,

            PipTouchHandler pipTouchHandler,

            PipTransitionController pipTransitionController,

            WindowManagerShellWrapper windowManagerShellWrapper,

            TaskStackListenerImpl taskStackListener,

            PipParamsChangedForwarder pipParamsChangedForwarder,

            DisplayInsetsController displayInsetsController,

            TabletopModeController pipTabletopController,

            Optional<OneHandedController> oneHandedController,

            @ShellMainThread ShellExecutor mainExecutor) {

        return Optional.ofNullable(PipController.create(

                context, shellInit, shellCommandHandler, shellController,

                displayController, pipAnimationController, pipAppOpsListener, pipBoundsAlgorithm,

                pipKeepClearAlgorithm, pipBoundsState, pipSizeSpecHandler, pipDisplayLayoutState,

                pipMotionHelper, pipMediaController, phonePipMenuController, pipTaskOrganizer,

                pipTransitionState, pipTouchHandler, pipTransitionController,

                windowManagerShellWrapper, taskStackListener, pipParamsChangedForwarder,

                displayInsetsController, pipTabletopController, oneHandedController, mainExecutor));

    }



    @WMSingleton

    @Provides

    static PipBoundsState providePipBoundsState(Context context,

            PipSizeSpecHandler pipSizeSpecHandler, PipDisplayLayoutState pipDisplayLayoutState) {

        return new PipBoundsState(context, pipSizeSpecHandler, pipDisplayLayoutState);

    }



    @WMSingleton

    @Provides

    static PipSnapAlgorithm providePipSnapAlgorithm() {

        return new PipSnapAlgorithm();

    }



    @WMSingleton

    @Provides

    static PhonePipKeepClearAlgorithm providePhonePipKeepClearAlgorithm(Context context) {

        return new PhonePipKeepClearAlgorithm(context);

    }



    @WMSingleton

    @Provides

    static PipSizeSpecHandler providePipSizeSpecHelper(Context context,

            PipDisplayLayoutState pipDisplayLayoutState) {

        return new PipSizeSpecHandler(context, pipDisplayLayoutState);

    }



    @WMSingleton

    @Provides

    static PipBoundsAlgorithm providesPipBoundsAlgorithm(Context context,

            PipBoundsState pipBoundsState, PipSnapAlgorithm pipSnapAlgorithm,

            PhonePipKeepClearAlgorithm pipKeepClearAlgorithm,

            PipSizeSpecHandler pipSizeSpecHandler) {

        return new PipBoundsAlgorithm(context, pipBoundsState, pipSnapAlgorithm,

                pipKeepClearAlgorithm, pipSizeSpecHandler);

    }



    // Handler is used by Icon.loadDrawableAsync

    @WMSingleton

    @Provides

    static PhonePipMenuController providesPipPhoneMenuController(Context context,

            PipBoundsState pipBoundsState, PipMediaController pipMediaController,

            SystemWindows systemWindows,

            Optional<SplitScreenController> splitScreenOptional,

            PipUiEventLogger pipUiEventLogger,

            @ShellMainThread ShellExecutor mainExecutor,

            @ShellMainThread Handler mainHandler) {

        return new PhonePipMenuController(context, pipBoundsState, pipMediaController,

                systemWindows, splitScreenOptional, pipUiEventLogger, mainExecutor, mainHandler);

    }



    @WMSingleton

    @Provides

    static PipTouchHandler providePipTouchHandler(Context context,

            ShellInit shellInit,

            PhonePipMenuController menuPhoneController,

            PipBoundsAlgorithm pipBoundsAlgorithm,

            PipBoundsState pipBoundsState,

            PipSizeSpecHandler pipSizeSpecHandler,

            PipTaskOrganizer pipTaskOrganizer,

            PipMotionHelper pipMotionHelper,

            FloatingContentCoordinator floatingContentCoordinator,

            PipUiEventLogger pipUiEventLogger,

            @ShellMainThread ShellExecutor mainExecutor) {

        return new PipTouchHandler(context, shellInit, menuPhoneController, pipBoundsAlgorithm,

                pipBoundsState, pipSizeSpecHandler, pipTaskOrganizer, pipMotionHelper,

                floatingContentCoordinator, pipUiEventLogger, mainExecutor);

    }



    @WMSingleton

    @Provides

    static PipTransitionState providePipTransitionState() {

        return new PipTransitionState();

    }



    @WMSingleton

    @Provides

    static PipTaskOrganizer providePipTaskOrganizer(Context context,

            SyncTransactionQueue syncTransactionQueue,

            PipTransitionState pipTransitionState,

            PipBoundsState pipBoundsState,

            PipDisplayLayoutState pipDisplayLayoutState,

            PipBoundsAlgorithm pipBoundsAlgorithm,

            PhonePipMenuController menuPhoneController,

            PipAnimationController pipAnimationController,

            PipSurfaceTransactionHelper pipSurfaceTransactionHelper,

            PipTransitionController pipTransitionController,

            PipParamsChangedForwarder pipParamsChangedForwarder,

            Optional<SplitScreenController> splitScreenControllerOptional,

            DisplayController displayController,

            PipUiEventLogger pipUiEventLogger, ShellTaskOrganizer shellTaskOrganizer,

            @ShellMainThread ShellExecutor mainExecutor) {

        return new PipTaskOrganizer(context,

                syncTransactionQueue, pipTransitionState, pipBoundsState, pipDisplayLayoutState,

                pipBoundsAlgorithm, menuPhoneController, pipAnimationController,

                pipSurfaceTransactionHelper, pipTransitionController, pipParamsChangedForwarder,

                splitScreenControllerOptional, displayController, pipUiEventLogger,

                shellTaskOrganizer, mainExecutor);

    }



    @WMSingleton

    @Provides

    static PipAnimationController providePipAnimationController(PipSurfaceTransactionHelper

            pipSurfaceTransactionHelper) {

        return new PipAnimationController(pipSurfaceTransactionHelper);

    }



    @WMSingleton

    @Provides

    static PipTransitionController providePipTransitionController(Context context,

            ShellInit shellInit, ShellTaskOrganizer shellTaskOrganizer, Transitions transitions,

            PipAnimationController pipAnimationController, PipBoundsAlgorithm pipBoundsAlgorithm,

            PipBoundsState pipBoundsState, PipDisplayLayoutState pipDisplayLayoutState,

            PipTransitionState pipTransitionState, PhonePipMenuController pipMenuController,

            PipSurfaceTransactionHelper pipSurfaceTransactionHelper,

            Optional<SplitScreenController> splitScreenOptional) {

        return new PipTransition(context, shellInit, shellTaskOrganizer, transitions,

                pipBoundsState, pipDisplayLayoutState, pipTransitionState, pipMenuController,

                pipBoundsAlgorithm, pipAnimationController, pipSurfaceTransactionHelper,

                splitScreenOptional);

    }



    @WMSingleton

    @Provides

    static PipAppOpsListener providePipAppOpsListener(Context context,

            PipTouchHandler pipTouchHandler,

            @ShellMainThread ShellExecutor mainExecutor) {

        return new PipAppOpsListener(context, pipTouchHandler.getMotionHelper(), mainExecutor);

    }



    @WMSingleton

    @Provides

    static PipMotionHelper providePipMotionHelper(Context context,

            PipBoundsState pipBoundsState, PipTaskOrganizer pipTaskOrganizer,

            PhonePipMenuController menuController, PipSnapAlgorithm pipSnapAlgorithm,

            PipTransitionController pipTransitionController,

            FloatingContentCoordinator floatingContentCoordinator) {

        return new PipMotionHelper(context, pipBoundsState, pipTaskOrganizer,

                menuController, pipSnapAlgorithm, pipTransitionController,

                floatingContentCoordinator);

    }



    @WMSingleton

    @Provides

    static PipParamsChangedForwarder providePipParamsChangedForwarder() {

        return new PipParamsChangedForwarder();

    }



    //

    // Transitions

    //
@@ -548,7 +342,7 @@ public abstract class WMShellModule { 
    static DefaultMixedHandler provideDefaultMixedHandler(

            ShellInit shellInit,

            Optional<SplitScreenController> splitScreenOptional,

            Optional<PipTouchHandler> pipTouchHandlerOptional,

            @Nullable PipTransitionController pipTransitionController,

            Optional<RecentsTransitionHandler> recentsTransitionHandler,

            KeyguardTransitionHandler keyguardTransitionHandler,

            Optional<DesktopModeController> desktopModeController,
@@ -556,8 +350,9 @@ public abstract class WMShellModule { 
            Optional<UnfoldTransitionHandler> unfoldHandler,

            Transitions transitions) {

        return new DefaultMixedHandler(shellInit, transitions, splitScreenOptional,

                pipTouchHandlerOptional, recentsTransitionHandler, keyguardTransitionHandler,

                desktopModeController, desktopTasksController, unfoldHandler);

                pipTransitionController, recentsTransitionHandler,

                keyguardTransitionHandler, desktopModeController, desktopTasksController,

                unfoldHandler);

    }



    @WMSingleton

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

0 → 100644
+271 −0

File added.

Preview size limit exceeded, changes collapsed.

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

0 → 100644
+66 −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 com.android.wm.shell.dagger.pip;



import android.content.Context;

import android.content.pm.PackageManager;

import android.os.Handler;



import com.android.internal.logging.UiEventLogger;

import com.android.wm.shell.common.FloatingContentCoordinator;

import com.android.wm.shell.common.annotations.ShellMainThread;

import com.android.wm.shell.dagger.WMSingleton;

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

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

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



import dagger.Module;

import dagger.Provides;



/**

 * Provides shared dependencies from {@link com.android.wm.shell.pip}, this implementation is

 * shared with {@link TvPipModule} and possibly other form factors.

 */

@Module

public abstract class Pip1SharedModule {

    @WMSingleton

    @Provides

    static FloatingContentCoordinator provideFloatingContentCoordinator() {

        return new FloatingContentCoordinator();

    }



    // Needs handler for registering broadcast receivers

    @WMSingleton

    @Provides

    static PipMediaController providePipMediaController(Context context,

            @ShellMainThread Handler mainHandler) {

        return new PipMediaController(context, mainHandler);

    }



    @WMSingleton

    @Provides

    static PipSurfaceTransactionHelper providePipSurfaceTransactionHelper(Context context) {

        return new PipSurfaceTransactionHelper(context);

    }



    @WMSingleton

    @Provides

    static PipUiEventLogger providePipUiEventLogger(UiEventLogger uiEventLogger,

            PackageManager packageManager) {

        return new PipUiEventLogger(uiEventLogger, packageManager);

    }

}