Merge "Expose interface for setting stop layer" into main

Author: Treehugger Robot

libs/gui/SurfaceComposerClient.cpp

@@ -2707,14 +2707,16 @@ status_t SurfaceComposerClient::createSurfaceChecked(const String8& name, uint32
     return err;
 }
 
-sp<SurfaceControl> SurfaceComposerClient::mirrorSurface(SurfaceControl* mirrorFromSurface) {
+sp<SurfaceControl> SurfaceComposerClient::mirrorSurface(SurfaceControl* mirrorFromSurface,
+                                                        SurfaceControl* stopAt) {
     if (mirrorFromSurface == nullptr) {
         return nullptr;
     }
 
     sp<IBinder> mirrorFromHandle = mirrorFromSurface->getHandle();
+    sp<IBinder> stopAtHandle = stopAt ? stopAt->getHandle() : nullptr;
     gui::CreateSurfaceResult result;
-    const binder::Status status = mClient->mirrorSurface(mirrorFromHandle, &result);
+    const binder::Status status = mClient->mirrorSurface(mirrorFromHandle, stopAtHandle, &result);
     const status_t err = statusTFromBinderStatus(status);
     if (err == NO_ERROR) {
         return sp<SurfaceControl>::make(this, result.handle, result.layerId,

libs/gui/aidl/android/gui/ISurfaceComposerClient.aidl

@@ -58,7 +58,7 @@ interface ISurfaceComposerClient {
      */
     FrameStats getLayerFrameStats(IBinder handle);
 
-    CreateSurfaceResult mirrorSurface(IBinder mirrorFromHandle);
+    CreateSurfaceResult mirrorSurface(IBinder mirrorFromHandle, @nullable IBinder stopAtHandle);
 
     CreateSurfaceResult mirrorDisplay(long displayId);
 

libs/gui/include/gui/SurfaceComposerClient.h

@@ -389,7 +389,19 @@ class SurfaceComposerClient : public RefBase
     //      A               A'
     //      |               |
     //      B               B'
-    sp<SurfaceControl> mirrorSurface(SurfaceControl* mirrorFromSurface);
+    //
+    // The mirrored hierarchy will exclude all layers z-ordered above the layer specified by
+    // stopAt. With stopAt specified as B:
+    //
+    //  Real Hierarchy    Mirror
+    //                      SC (value that's returned)
+    //                      |
+    //      A               A'
+    //      |
+    //      B
+    //
+    sp<SurfaceControl> mirrorSurface(SurfaceControl* mirrorFromSurface,
+                                     SurfaceControl* stopAt = nullptr);
 
     sp<SurfaceControl> mirrorDisplay(DisplayId displayId);
 

services/surfaceflinger/Client.cpp

@@ -99,10 +99,11 @@ binder::Status Client::getLayerFrameStats(const sp<IBinder>& handle, gui::FrameS
 }
 
 binder::Status Client::mirrorSurface(const sp<IBinder>& mirrorFromHandle,
+                                     const sp<IBinder>& stopAtHandle,
                                      gui::CreateSurfaceResult* outResult) {
     LayerCreationArgs args(mFlinger.get(), sp<Client>::fromExisting(this), "MirrorRoot",
                            0 /* flags */, gui::LayerMetadata());
-    status_t status = mFlinger->mirrorLayer(args, mirrorFromHandle, *outResult);
+    status_t status = mFlinger->mirrorLayer(args, mirrorFromHandle, stopAtHandle, *outResult);
     return binderStatusFromStatusT(status);
 }
 

services/surfaceflinger/Client.h

@@ -51,6 +51,7 @@ class Client : public gui::BnSurfaceComposerClient {
                                       gui::FrameStats* outStats) override;
 
     binder::Status mirrorSurface(const sp<IBinder>& mirrorFromHandle,
+                                 const sp<IBinder>& stopAtHandle,
                                  gui::CreateSurfaceResult* outResult) override;
 
     binder::Status mirrorDisplay(int64_t displayId, gui::CreateSurfaceResult* outResult) override;

services/surfaceflinger/SurfaceFlinger.cpp

@@ -5442,6 +5442,7 @@ uint32_t SurfaceFlinger::addInputWindowCommands(const InputWindowCommands& input
 
 status_t SurfaceFlinger::mirrorLayer(const LayerCreationArgs& args,
                                      const sp<IBinder>& mirrorFromHandle,
+                                     const sp<IBinder>& stopAtHandle,
                                      gui::CreateSurfaceResult& outResult) {
     if (!mirrorFromHandle) {
         return NAME_NOT_FOUND;
@@ -5459,6 +5460,13 @@ status_t SurfaceFlinger::mirrorLayer(const LayerCreationArgs& args,
         mirrorArgs.flags |= ISurfaceComposerClient::eNoColorFill;
         mirrorArgs.mirrorLayerHandle = mirrorFromHandle;
         mirrorArgs.addToRoot = false;
+        if (stopAtHandle) {
+            uint32_t stopLayerId = LayerHandle::getLayerId(stopAtHandle);
+            if (stopLayerId == UNASSIGNED_LAYER_ID) {
+                return NAME_NOT_FOUND;
+            }
+            mirrorArgs.stopLayerId = stopLayerId;
+        }
         status_t result = createLayer(mirrorArgs, &outResult.handle, &mirrorLayer);
         if (result != NO_ERROR) {
             return result;

services/surfaceflinger/SurfaceFlinger.h

@@ -860,7 +860,7 @@ class SurfaceFlinger : public BnSurfaceComposer,
     status_t checkLayerLeaks();
 
     status_t mirrorLayer(const LayerCreationArgs& args, const sp<IBinder>& mirrorFromHandle,
-                         gui::CreateSurfaceResult& outResult);
+                         const sp<IBinder>& stopAtHandle, gui::CreateSurfaceResult& outResult);
 
     status_t mirrorDisplay(DisplayId displayId, const LayerCreationArgs& args,
                            gui::CreateSurfaceResult& outResult);

services/surfaceflinger/tests/MirrorLayer_test.cpp

@@ -360,6 +360,35 @@ TEST_F(MirrorLayerTest, OffscreenMirrorScreenshot) {
     }
 }
 
+TEST_F(MirrorLayerTest, MirrorLayerWithStopLayer) {
+    if (!FlagManager::getInstance().stop_layer()) {
+        GTEST_SKIP() << "skipping test - stop_layer feature flag disabled";
+    }
+
+    sp<SurfaceControl> grandchild =
+            createColorLayer("Grandchild layer", Color::BLUE, mChildLayer.get());
+    Transaction()
+            .setFlags(grandchild, layer_state_t::eLayerOpaque, layer_state_t::eLayerOpaque)
+            .setCrop(grandchild, Rect(0, 0, 200, 200))
+            .show(grandchild)
+            .apply();
+
+    // Mirror child with stop layer set to grandchild.
+    sp<SurfaceControl> mirrorLayer = mClient->mirrorSurface(mChildLayer.get(), grandchild.get());
+    ASSERT_NE(mirrorLayer, nullptr);
+
+    // Add mirrorLayer as child of mParentLayer so it's shown on the display
+    Transaction()
+            .reparent(mirrorLayer, mParentLayer)
+            .setPosition(mirrorLayer, 500, 500)
+            .show(mirrorLayer)
+            .apply();
+
+    auto shot = screenshot();
+    // Assert that we see the child's color and not the grandchild's color
+    shot->expectColor(Rect(550, 550, 600, 600), Color::GREEN);
+}
+
 } // namespace android
 
 // TODO(b/129481165): remove the #pragma below and fix conversion issues

services/surfaceflinger/tests/unittests/TestableSurfaceFlinger.h

@@ -572,8 +572,8 @@ class TestableSurfaceFlinger {
     }
 
     auto mirrorLayer(const LayerCreationArgs& args, const sp<IBinder>& mirrorFromHandle,
-                     gui::CreateSurfaceResult& outResult) {
-        return mFlinger->mirrorLayer(args, mirrorFromHandle, outResult);
+                     const sp<IBinder>& stopAtHandle, gui::CreateSurfaceResult& outResult) {
+        return mFlinger->mirrorLayer(args, mirrorFromHandle, stopAtHandle, outResult);
     }
 
     void getDynamicDisplayInfoFromToken(const sp<IBinder>& displayToken,