Gitiles
Code Review Sign In
gerrit.omnirom.org / android_frameworks_native / 712c9ccbe88a11d0aa47d719ffb57d5cef708616 / . / services / surfaceflinger / tests / LayerUpdate_test.cpp
blob: 0ad122b5ed4889b979991264d5b558ee77b12971 [file] [log] [blame]
/*
* Copyright (C) 2019 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.
*/
#include "LayerTransactionTest.h"
namespace android {
using android::hardware::graphics::common::V1_1::BufferUsage;
::testing::Environment* const binderEnv =
::testing::AddGlobalTestEnvironment(new BinderEnvironment());
class LayerUpdateTest : public LayerTransactionTest {
protected:
virtual void SetUp() {
LayerTransactionTest::SetUp();
ASSERT_EQ(NO_ERROR, mClient->initCheck());
const auto display = SurfaceComposerClient::getInternalDisplayToken();
ASSERT_FALSE(display == nullptr);
DisplayInfo info;
ASSERT_EQ(NO_ERROR, SurfaceComposerClient::getDisplayInfo(display, &info));
ssize_t displayWidth = info.w;
ssize_t displayHeight = info.h;
// Background surface
mBGSurfaceControl = createLayer(String8("BG Test Surface"), displayWidth, displayHeight, 0);
ASSERT_TRUE(mBGSurfaceControl != nullptr);
ASSERT_TRUE(mBGSurfaceControl->isValid());
TransactionUtils::fillSurfaceRGBA8(mBGSurfaceControl, 63, 63, 195);
// Foreground surface
mFGSurfaceControl = createLayer(String8("FG Test Surface"), 64, 64, 0);
ASSERT_TRUE(mFGSurfaceControl != nullptr);
ASSERT_TRUE(mFGSurfaceControl->isValid());
TransactionUtils::fillSurfaceRGBA8(mFGSurfaceControl, 195, 63, 63);
// Synchronization surface
mSyncSurfaceControl = createLayer(String8("Sync Test Surface"), 1, 1, 0);
ASSERT_TRUE(mSyncSurfaceControl != nullptr);
ASSERT_TRUE(mSyncSurfaceControl->isValid());
TransactionUtils::fillSurfaceRGBA8(mSyncSurfaceControl, 31, 31, 31);
asTransaction([&](Transaction& t) {
t.setDisplayLayerStack(display, 0);
t.setLayer(mBGSurfaceControl, INT32_MAX - 2).show(mBGSurfaceControl);
t.setLayer(mFGSurfaceControl, INT32_MAX - 1)
.setPosition(mFGSurfaceControl, 64, 64)
.show(mFGSurfaceControl);
t.setLayer(mSyncSurfaceControl, INT32_MAX - 1)
.setPosition(mSyncSurfaceControl, displayWidth - 2, displayHeight - 2)
.show(mSyncSurfaceControl);
});
}
virtual void TearDown() {
LayerTransactionTest::TearDown();
mBGSurfaceControl = 0;
mFGSurfaceControl = 0;
mSyncSurfaceControl = 0;
}
void waitForPostedBuffers() {
// Since the sync surface is in synchronous mode (i.e. double buffered)
// posting three buffers to it should ensure that at least two
// SurfaceFlinger::handlePageFlip calls have been made, which should
// guaranteed that a buffer posted to another Surface has been retired.
TransactionUtils::fillSurfaceRGBA8(mSyncSurfaceControl, 31, 31, 31);
TransactionUtils::fillSurfaceRGBA8(mSyncSurfaceControl, 31, 31, 31);
TransactionUtils::fillSurfaceRGBA8(mSyncSurfaceControl, 31, 31, 31);
}
sp<SurfaceControl> mBGSurfaceControl;
sp<SurfaceControl> mFGSurfaceControl;
// This surface is used to ensure that the buffers posted to
// mFGSurfaceControl have been picked up by SurfaceFlinger.
sp<SurfaceControl> mSyncSurfaceControl;
};
TEST_F(LayerUpdateTest, RelativesAreNotDetached) {
std::unique_ptr<ScreenCapture> sc;
sp<SurfaceControl> relative = createLayer(String8("relativeTestSurface"), 10, 10, 0);
TransactionUtils::fillSurfaceRGBA8(relative, 10, 10, 10);
waitForPostedBuffers();
Transaction{}
.setRelativeLayer(relative, mFGSurfaceControl->getHandle(), 1)
.setPosition(relative, 64, 64)
.apply();
{
// The relative should be on top of the FG control.
ScreenCapture::captureScreen(&sc);
sc->checkPixel(64, 64, 10, 10, 10);
}
Transaction{}.detachChildren(mFGSurfaceControl).apply();
{
// Nothing should change at this point.
ScreenCapture::captureScreen(&sc);
sc->checkPixel(64, 64, 10, 10, 10);
}
Transaction{}.hide(relative).apply();
{
// Ensure that the relative was actually hidden, rather than
// being left in the detached but visible state.
ScreenCapture::captureScreen(&sc);
sc->expectFGColor(64, 64);
}
}
class GeometryLatchingTest : public LayerUpdateTest {
protected:
void EXPECT_INITIAL_STATE(const char* trace) {
SCOPED_TRACE(trace);
ScreenCapture::captureScreen(&sc);
// We find the leading edge of the FG surface.
sc->expectFGColor(127, 127);
sc->expectBGColor(128, 128);
}
void lockAndFillFGBuffer() {
TransactionUtils::fillSurfaceRGBA8(mFGSurfaceControl, 195, 63, 63, false);
}
void unlockFGBuffer() {
sp<Surface> s = mFGSurfaceControl->getSurface();
ASSERT_EQ(NO_ERROR, s->unlockAndPost());
waitForPostedBuffers();
}
void completeFGResize() {
TransactionUtils::fillSurfaceRGBA8(mFGSurfaceControl, 195, 63, 63);
waitForPostedBuffers();
}
void restoreInitialState() {
asTransaction([&](Transaction& t) {
t.setSize(mFGSurfaceControl, 64, 64);
t.setPosition(mFGSurfaceControl, 64, 64);
t.setCrop_legacy(mFGSurfaceControl, Rect(0, 0, 64, 64));
});
EXPECT_INITIAL_STATE("After restoring initial state");
}
std::unique_ptr<ScreenCapture> sc;
};
class CropLatchingTest : public GeometryLatchingTest {
protected:
void EXPECT_CROPPED_STATE(const char* trace) {
SCOPED_TRACE(trace);
ScreenCapture::captureScreen(&sc);
// The edge should be moved back one pixel by our crop.
sc->expectFGColor(126, 126);
sc->expectBGColor(127, 127);
sc->expectBGColor(128, 128);
}
void EXPECT_RESIZE_STATE(const char* trace) {
SCOPED_TRACE(trace);
ScreenCapture::captureScreen(&sc);
// The FG is now resized too 128,128 at 64,64
sc->expectFGColor(64, 64);
sc->expectFGColor(191, 191);
sc->expectBGColor(192, 192);
}
};
TEST_F(LayerUpdateTest, DeferredTransactionTest) {
std::unique_ptr<ScreenCapture> sc;
{
SCOPED_TRACE("before anything");
ScreenCapture::captureScreen(&sc);
sc->expectBGColor(32, 32);
sc->expectFGColor(96, 96);
sc->expectBGColor(160, 160);
}
// set up two deferred transactions on different frames
asTransaction([&](Transaction& t) {
t.setAlpha(mFGSurfaceControl, 0.75);
t.deferTransactionUntil_legacy(mFGSurfaceControl, mSyncSurfaceControl->getHandle(),
mSyncSurfaceControl->getSurface()->getNextFrameNumber());
});
asTransaction([&](Transaction& t) {
t.setPosition(mFGSurfaceControl, 128, 128);
t.deferTransactionUntil_legacy(mFGSurfaceControl, mSyncSurfaceControl->getHandle(),
mSyncSurfaceControl->getSurface()->getNextFrameNumber() + 1);
});
{
SCOPED_TRACE("before any trigger");
ScreenCapture::captureScreen(&sc);
sc->expectBGColor(32, 32);
sc->expectFGColor(96, 96);
sc->expectBGColor(160, 160);
}
// should trigger the first deferred transaction, but not the second one
TransactionUtils::fillSurfaceRGBA8(mSyncSurfaceControl, 31, 31, 31);
{
SCOPED_TRACE("after first trigger");
ScreenCapture::captureScreen(&sc);
sc->expectBGColor(32, 32);
sc->checkPixel(96, 96, 162, 63, 96);
sc->expectBGColor(160, 160);
}
// should show up immediately since it's not deferred
asTransaction([&](Transaction& t) { t.setAlpha(mFGSurfaceControl, 1.0); });
// trigger the second deferred transaction
TransactionUtils::fillSurfaceRGBA8(mSyncSurfaceControl, 31, 31, 31);
{
SCOPED_TRACE("after second trigger");
ScreenCapture::captureScreen(&sc);
sc->expectBGColor(32, 32);
sc->expectBGColor(96, 96);
sc->expectFGColor(160, 160);
}
}
TEST_F(LayerUpdateTest, LayerWithNoBuffersResizesImmediately) {
std::unique_ptr<ScreenCapture> sc;
sp<SurfaceControl> childNoBuffer =
createSurface(mClient, "Bufferless child", 0 /* buffer width */, 0 /* buffer height */,
PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
sp<SurfaceControl> childBuffer = createSurface(mClient, "Buffered child", 20, 20,
PIXEL_FORMAT_RGBA_8888, 0, childNoBuffer.get());
TransactionUtils::fillSurfaceRGBA8(childBuffer, 200, 200, 200);
SurfaceComposerClient::Transaction{}
.setCrop_legacy(childNoBuffer, Rect(0, 0, 10, 10))
.show(childNoBuffer)
.show(childBuffer)
.apply(true);
{
ScreenCapture::captureScreen(&sc);
sc->expectChildColor(73, 73);
sc->expectFGColor(74, 74);
}
SurfaceComposerClient::Transaction{}
.setCrop_legacy(childNoBuffer, Rect(0, 0, 20, 20))
.apply(true);
{
ScreenCapture::captureScreen(&sc);
sc->expectChildColor(73, 73);
sc->expectChildColor(74, 74);
}
}
TEST_F(LayerUpdateTest, MergingTransactions) {
std::unique_ptr<ScreenCapture> sc;
{
SCOPED_TRACE("before move");
ScreenCapture::captureScreen(&sc);
sc->expectBGColor(0, 12);
sc->expectFGColor(75, 75);
sc->expectBGColor(145, 145);
}
Transaction t1, t2;
t1.setPosition(mFGSurfaceControl, 128, 128);
t2.setPosition(mFGSurfaceControl, 0, 0);
// We expect that the position update from t2 now
// overwrites the position update from t1.
t1.merge(std::move(t2));
t1.apply();
{
ScreenCapture::captureScreen(&sc);
sc->expectFGColor(1, 1);
}
}
TEST_F(LayerUpdateTest, MergingTransactionFlags) {
Transaction().hide(mFGSurfaceControl).apply();
std::unique_ptr<ScreenCapture> sc;
{
SCOPED_TRACE("before merge");
ScreenCapture::captureScreen(&sc);
sc->expectBGColor(0, 12);
sc->expectBGColor(75, 75);
sc->expectBGColor(145, 145);
}
Transaction t1, t2;
t1.show(mFGSurfaceControl);
t2.setFlags(mFGSurfaceControl, 0 /* flags */, layer_state_t::eLayerSecure /* mask */);
t1.merge(std::move(t2));
t1.apply();
{
SCOPED_TRACE("after merge");
ScreenCapture::captureScreen(&sc);
sc->expectFGColor(75, 75);
}
}
class ChildLayerTest : public LayerUpdateTest {
protected:
void SetUp() override {
LayerUpdateTest::SetUp();
mChild = createSurface(mClient, "Child surface", 10, 15, PIXEL_FORMAT_RGBA_8888, 0,
mFGSurfaceControl.get());
TransactionUtils::fillSurfaceRGBA8(mChild, 200, 200, 200);
{
SCOPED_TRACE("before anything");
mCapture = screenshot();
mCapture->expectChildColor(64, 64);
}
}
void TearDown() override {
LayerUpdateTest::TearDown();
mChild = 0;
}
sp<SurfaceControl> mChild;
std::unique_ptr<ScreenCapture> mCapture;
};
TEST_F(ChildLayerTest, ChildLayerPositioning) {
asTransaction([&](Transaction& t) {
t.show(mChild);
t.setPosition(mChild, 10, 10);
t.setPosition(mFGSurfaceControl, 64, 64);
});
{
mCapture = screenshot();
// Top left of foreground must now be visible
mCapture->expectFGColor(64, 64);
// But 10 pixels in we should see the child surface
mCapture->expectChildColor(74, 74);
// And 10 more pixels we should be back to the foreground surface
mCapture->expectFGColor(84, 84);
}
asTransaction([&](Transaction& t) { t.setPosition(mFGSurfaceControl, 0, 0); });
{
mCapture = screenshot();
// Top left of foreground should now be at 0, 0
mCapture->expectFGColor(0, 0);
// But 10 pixels in we should see the child surface
mCapture->expectChildColor(10, 10);
// And 10 more pixels we should be back to the foreground surface
mCapture->expectFGColor(20, 20);
}
}
TEST_F(ChildLayerTest, ChildLayerCropping) {
asTransaction([&](Transaction& t) {
t.show(mChild);
t.setPosition(mChild, 0, 0);
t.setPosition(mFGSurfaceControl, 0, 0);
t.setCrop_legacy(mFGSurfaceControl, Rect(0, 0, 5, 5));
});
{
mCapture = screenshot();
mCapture->expectChildColor(0, 0);
mCapture->expectChildColor(4, 4);
mCapture->expectBGColor(5, 5);
}
}
TEST_F(ChildLayerTest, ChildLayerConstraints) {
asTransaction([&](Transaction& t) {
t.show(mChild);
t.setPosition(mFGSurfaceControl, 0, 0);
t.setPosition(mChild, 63, 63);
});
{
mCapture = screenshot();
mCapture->expectFGColor(0, 0);
// Last pixel in foreground should now be the child.
mCapture->expectChildColor(63, 63);
// But the child should be constrained and the next pixel
// must be the background
mCapture->expectBGColor(64, 64);
}
}
TEST_F(ChildLayerTest, ChildLayerScaling) {
asTransaction([&](Transaction& t) { t.setPosition(mFGSurfaceControl, 0, 0); });
// Find the boundary between the parent and child
{
mCapture = screenshot();
mCapture->expectChildColor(9, 9);
mCapture->expectFGColor(10, 10);
}
asTransaction([&](Transaction& t) { t.setMatrix(mFGSurfaceControl, 2.0, 0, 0, 2.0); });
// The boundary should be twice as far from the origin now.
// The pixels from the last test should all be child now
{
mCapture = screenshot();
mCapture->expectChildColor(9, 9);
mCapture->expectChildColor(10, 10);
mCapture->expectChildColor(19, 19);
mCapture->expectFGColor(20, 20);
}
}
// A child with a scale transform should be cropped by its parent bounds.
TEST_F(ChildLayerTest, ChildLayerScalingCroppedByParent) {
asTransaction([&](Transaction& t) {
t.setPosition(mFGSurfaceControl, 0, 0);
t.setPosition(mChild, 0, 0);
});
// Find the boundary between the parent and child.
{
mCapture = screenshot();
mCapture->expectChildColor(0, 0);
mCapture->expectChildColor(9, 9);
mCapture->expectFGColor(10, 10);
}
asTransaction([&](Transaction& t) { t.setMatrix(mChild, 10.0, 0, 0, 10.0); });
// The child should fill its parent bounds and be cropped by it.
{
mCapture = screenshot();
mCapture->expectChildColor(0, 0);
mCapture->expectChildColor(63, 63);
mCapture->expectBGColor(64, 64);
}
}
TEST_F(ChildLayerTest, ChildLayerAlpha) {
TransactionUtils::fillSurfaceRGBA8(mBGSurfaceControl, 0, 0, 254);
TransactionUtils::fillSurfaceRGBA8(mFGSurfaceControl, 254, 0, 0);
TransactionUtils::fillSurfaceRGBA8(mChild, 0, 254, 0);
waitForPostedBuffers();
asTransaction([&](Transaction& t) {
t.show(mChild);
t.setPosition(mChild, 0, 0);
t.setPosition(mFGSurfaceControl, 0, 0);
});
{
mCapture = screenshot();
// Unblended child color
mCapture->checkPixel(0, 0, 0, 254, 0);
}
asTransaction([&](Transaction& t) { t.setAlpha(mChild, 0.5); });
{
mCapture = screenshot();
// Child and BG blended.
mCapture->checkPixel(0, 0, 127, 127, 0);
}
asTransaction([&](Transaction& t) { t.setAlpha(mFGSurfaceControl, 0.5); });
{
mCapture = screenshot();
// Child and BG blended.
mCapture->checkPixel(0, 0, 95, 64, 95);
}
}
TEST_F(ChildLayerTest, ReparentChildren) {
asTransaction([&](Transaction& t) {
t.show(mChild);
t.setPosition(mChild, 10, 10);
t.setPosition(mFGSurfaceControl, 64, 64);
});
{
mCapture = screenshot();
// Top left of foreground must now be visible
mCapture->expectFGColor(64, 64);
// But 10 pixels in we should see the child surface
mCapture->expectChildColor(74, 74);
// And 10 more pixels we should be back to the foreground surface
mCapture->expectFGColor(84, 84);
}
asTransaction([&](Transaction& t) {
t.reparentChildren(mFGSurfaceControl, mBGSurfaceControl->getHandle());
});
{
mCapture = screenshot();
mCapture->expectFGColor(64, 64);
// In reparenting we should have exposed the entire foreground surface.
mCapture->expectFGColor(74, 74);
// And the child layer should now begin at 10, 10 (since the BG
// layer is at (0, 0)).
mCapture->expectBGColor(9, 9);
mCapture->expectChildColor(10, 10);
}
}
TEST_F(ChildLayerTest, ChildrenSurviveParentDestruction) {
sp<SurfaceControl> mGrandChild =
createSurface(mClient, "Grand Child", 10, 10, PIXEL_FORMAT_RGBA_8888, 0, mChild.get());
TransactionUtils::fillSurfaceRGBA8(mGrandChild, 111, 111, 111);
{
SCOPED_TRACE("Grandchild visible");
ScreenCapture::captureScreen(&mCapture);
mCapture->checkPixel(64, 64, 111, 111, 111);
}
mChild.clear();
{
SCOPED_TRACE("After destroying child");
ScreenCapture::captureScreen(&mCapture);
mCapture->expectFGColor(64, 64);
}
asTransaction([&](Transaction& t) { t.reparent(mGrandChild, mFGSurfaceControl->getHandle()); });
{
SCOPED_TRACE("After reparenting grandchild");
ScreenCapture::captureScreen(&mCapture);
mCapture->checkPixel(64, 64, 111, 111, 111);
}
}
TEST_F(ChildLayerTest, ChildrenRelativeZSurvivesParentDestruction) {
sp<SurfaceControl> mGrandChild =
createSurface(mClient, "Grand Child", 10, 10, PIXEL_FORMAT_RGBA_8888, 0, mChild.get());
TransactionUtils::fillSurfaceRGBA8(mGrandChild, 111, 111, 111);
// draw grand child behind the foreground surface
asTransaction([&](Transaction& t) {
t.setRelativeLayer(mGrandChild, mFGSurfaceControl->getHandle(), -1);
});
{
SCOPED_TRACE("Child visible");
ScreenCapture::captureScreen(&mCapture);
mCapture->checkPixel(64, 64, 200, 200, 200);
}
asTransaction([&](Transaction& t) {
t.reparent(mChild, nullptr);
t.reparentChildren(mChild, mFGSurfaceControl->getHandle());
});
{
SCOPED_TRACE("foreground visible reparenting grandchild");
ScreenCapture::captureScreen(&mCapture);
mCapture->checkPixel(64, 64, 195, 63, 63);
}
}
TEST_F(ChildLayerTest, DetachChildrenSameClient) {
asTransaction([&](Transaction& t) {
t.show(mChild);
t.setPosition(mChild, 10, 10);
t.setPosition(mFGSurfaceControl, 64, 64);
});
{
mCapture = screenshot();
// Top left of foreground must now be visible
mCapture->expectFGColor(64, 64);
// But 10 pixels in we should see the child surface
mCapture->expectChildColor(74, 74);
// And 10 more pixels we should be back to the foreground surface
mCapture->expectFGColor(84, 84);
}
asTransaction([&](Transaction& t) { t.detachChildren(mFGSurfaceControl); });
asTransaction([&](Transaction& t) { t.hide(mChild); });
// Since the child has the same client as the parent, it will not get
// detached and will be hidden.
{
mCapture = screenshot();
mCapture->expectFGColor(64, 64);
mCapture->expectFGColor(74, 74);
mCapture->expectFGColor(84, 84);
}
}
TEST_F(ChildLayerTest, DetachChildrenDifferentClient) {
sp<SurfaceComposerClient> mNewComposerClient = new SurfaceComposerClient;
sp<SurfaceControl> mChildNewClient =
createSurface(mNewComposerClient, "New Child Test Surface", 10, 10,
PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
ASSERT_TRUE(mChildNewClient->isValid());
TransactionUtils::fillSurfaceRGBA8(mChildNewClient, 200, 200, 200);
asTransaction([&](Transaction& t) {
t.hide(mChild);
t.show(mChildNewClient);
t.setPosition(mChildNewClient, 10, 10);
t.setPosition(mFGSurfaceControl, 64, 64);
});
{
mCapture = screenshot();
// Top left of foreground must now be visible
mCapture->expectFGColor(64, 64);
// But 10 pixels in we should see the child surface
mCapture->expectChildColor(74, 74);
// And 10 more pixels we should be back to the foreground surface
mCapture->expectFGColor(84, 84);
}
asTransaction([&](Transaction& t) { t.detachChildren(mFGSurfaceControl); });
asTransaction([&](Transaction& t) { t.hide(mChildNewClient); });
// Nothing should have changed.
{
mCapture = screenshot();
mCapture->expectFGColor(64, 64);
mCapture->expectChildColor(74, 74);
mCapture->expectFGColor(84, 84);
}
}
TEST_F(ChildLayerTest, DetachChildrenThenAttach) {
sp<SurfaceComposerClient> newComposerClient = new SurfaceComposerClient;
sp<SurfaceControl> childNewClient =
newComposerClient->createSurface(String8("New Child Test Surface"), 10, 10,
PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
ASSERT_TRUE(childNewClient != nullptr);
ASSERT_TRUE(childNewClient->isValid());
TransactionUtils::fillSurfaceRGBA8(childNewClient, 200, 200, 200);
Transaction()
.hide(mChild)
.show(childNewClient)
.setPosition(childNewClient, 10, 10)
.setPosition(mFGSurfaceControl, 64, 64)
.apply();
{
mCapture = screenshot();
// Top left of foreground must now be visible
mCapture->expectFGColor(64, 64);
// But 10 pixels in we should see the child surface
mCapture->expectChildColor(74, 74);
// And 10 more pixels we should be back to the foreground surface
mCapture->expectFGColor(84, 84);
}
Transaction().detachChildren(mFGSurfaceControl).apply();
Transaction().hide(childNewClient).apply();
// Nothing should have changed.
{
mCapture = screenshot();
mCapture->expectFGColor(64, 64);
mCapture->expectChildColor(74, 74);
mCapture->expectFGColor(84, 84);
}
sp<SurfaceControl> newParentSurface = createLayer(String8("New Parent Surface"), 32, 32, 0);
fillLayerColor(ISurfaceComposerClient::eFXSurfaceBufferQueue, newParentSurface, Color::RED, 32,
32);
Transaction()
.setLayer(newParentSurface, INT32_MAX - 1)
.show(newParentSurface)
.setPosition(newParentSurface, 20, 20)
.reparent(childNewClient, newParentSurface->getHandle())
.apply();
{
mCapture = screenshot();
// Child is now hidden.
mCapture->expectColor(Rect(20, 20, 52, 52), Color::RED);
}
}
TEST_F(ChildLayerTest, DetachChildrenWithDeferredTransaction) {
sp<SurfaceComposerClient> newComposerClient = new SurfaceComposerClient;
sp<SurfaceControl> childNewClient =
newComposerClient->createSurface(String8("New Child Test Surface"), 10, 10,
PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
ASSERT_TRUE(childNewClient != nullptr);
ASSERT_TRUE(childNewClient->isValid());
TransactionUtils::fillSurfaceRGBA8(childNewClient, 200, 200, 200);
Transaction()
.hide(mChild)
.show(childNewClient)
.setPosition(childNewClient, 10, 10)
.setPosition(mFGSurfaceControl, 64, 64)
.apply();
{
mCapture = screenshot();
Rect rect = Rect(74, 74, 84, 84);
mCapture->expectBorder(rect, Color{195, 63, 63, 255});
mCapture->expectColor(rect, Color{200, 200, 200, 255});
}
Transaction()
.deferTransactionUntil_legacy(childNewClient, mFGSurfaceControl->getHandle(),
mFGSurfaceControl->getSurface()->getNextFrameNumber())
.apply();
Transaction().detachChildren(mFGSurfaceControl).apply();
ASSERT_NO_FATAL_FAILURE(fillBufferQueueLayerColor(mFGSurfaceControl, Color::RED, 32, 32));
// BufferLayer can still dequeue buffers even though there's a detached layer with a
// deferred transaction.
{
SCOPED_TRACE("new buffer");
mCapture = screenshot();
Rect rect = Rect(74, 74, 84, 84);
mCapture->expectBorder(rect, Color::RED);
mCapture->expectColor(rect, Color{200, 200, 200, 255});
}
}
TEST_F(ChildLayerTest, ChildrenInheritNonTransformScalingFromParent) {
asTransaction([&](Transaction& t) {
t.show(mChild);
t.setPosition(mChild, 0, 0);
t.setPosition(mFGSurfaceControl, 0, 0);
});
{
mCapture = screenshot();
// We've positioned the child in the top left.
mCapture->expectChildColor(0, 0);
// But it's only 10x15.
mCapture->expectFGColor(10, 15);
}
asTransaction([&](Transaction& t) {
t.setOverrideScalingMode(mFGSurfaceControl, NATIVE_WINDOW_SCALING_MODE_SCALE_TO_WINDOW);
// We cause scaling by 2.
t.setSize(mFGSurfaceControl, 128, 128);
});
{
mCapture = screenshot();
// We've positioned the child in the top left.
mCapture->expectChildColor(0, 0);
mCapture->expectChildColor(10, 10);
mCapture->expectChildColor(19, 29);
// And now it should be scaled all the way to 20x30
mCapture->expectFGColor(20, 30);
}
}
// Regression test for b/37673612
TEST_F(ChildLayerTest, ChildrenWithParentBufferTransform) {
asTransaction([&](Transaction& t) {
t.show(mChild);
t.setPosition(mChild, 0, 0);
t.setPosition(mFGSurfaceControl, 0, 0);
});
{
mCapture = screenshot();
// We've positioned the child in the top left.
mCapture->expectChildColor(0, 0);
mCapture->expectChildColor(9, 14);
// But it's only 10x15.
mCapture->expectFGColor(10, 15);
}
// We set things up as in b/37673612 so that there is a mismatch between the buffer size and
// the WM specified state size.
asTransaction([&](Transaction& t) { t.setSize(mFGSurfaceControl, 128, 64); });
sp<Surface> s = mFGSurfaceControl->getSurface();
auto anw = static_cast<ANativeWindow*>(s.get());
native_window_set_buffers_transform(anw, NATIVE_WINDOW_TRANSFORM_ROT_90);
native_window_set_buffers_dimensions(anw, 64, 128);
TransactionUtils::fillSurfaceRGBA8(mFGSurfaceControl, 195, 63, 63);
waitForPostedBuffers();
{
// The child should still be in the same place and not have any strange scaling as in
// b/37673612.
mCapture = screenshot();
mCapture->expectChildColor(0, 0);
mCapture->expectFGColor(10, 10);
}
}
// A child with a buffer transform from its parents should be cropped by its parent bounds.
TEST_F(ChildLayerTest, ChildCroppedByParentWithBufferTransform) {
asTransaction([&](Transaction& t) {
t.show(mChild);
t.setPosition(mChild, 0, 0);
t.setPosition(mFGSurfaceControl, 0, 0);
t.setSize(mChild, 100, 100);
});
TransactionUtils::fillSurfaceRGBA8(mChild, 200, 200, 200);
{
mCapture = screenshot();
mCapture->expectChildColor(0, 0);
mCapture->expectChildColor(63, 63);
mCapture->expectBGColor(64, 64);
}
asTransaction([&](Transaction& t) { t.setSize(mFGSurfaceControl, 128, 64); });
sp<Surface> s = mFGSurfaceControl->getSurface();
auto anw = static_cast<ANativeWindow*>(s.get());
// Apply a 90 transform on the buffer.
native_window_set_buffers_transform(anw, NATIVE_WINDOW_TRANSFORM_ROT_90);
native_window_set_buffers_dimensions(anw, 64, 128);
TransactionUtils::fillSurfaceRGBA8(mFGSurfaceControl, 195, 63, 63);
waitForPostedBuffers();
// The child should be cropped by the new parent bounds.
{
mCapture = screenshot();
mCapture->expectChildColor(0, 0);
mCapture->expectChildColor(99, 63);
mCapture->expectFGColor(100, 63);
mCapture->expectBGColor(128, 64);
}
}
// A child with a scale transform from its parents should be cropped by its parent bounds.
TEST_F(ChildLayerTest, ChildCroppedByParentWithBufferScale) {
asTransaction([&](Transaction& t) {
t.show(mChild);
t.setPosition(mChild, 0, 0);
t.setPosition(mFGSurfaceControl, 0, 0);
t.setSize(mChild, 200, 200);
});
TransactionUtils::fillSurfaceRGBA8(mChild, 200, 200, 200);
{
mCapture = screenshot();
mCapture->expectChildColor(0, 0);
mCapture->expectChildColor(63, 63);
mCapture->expectBGColor(64, 64);
}
asTransaction([&](Transaction& t) {
t.setOverrideScalingMode(mFGSurfaceControl, NATIVE_WINDOW_SCALING_MODE_SCALE_TO_WINDOW);
// Set a scaling by 2.
t.setSize(mFGSurfaceControl, 128, 128);
});
// Child should inherit its parents scale but should be cropped by its parent bounds.
{
mCapture = screenshot();
mCapture->expectChildColor(0, 0);
mCapture->expectChildColor(127, 127);
mCapture->expectBGColor(128, 128);
}
}
// Regression test for b/127368943
// Child should ignore the buffer transform but apply parent scale transform.
TEST_F(ChildLayerTest, ChildrenWithParentBufferTransformAndScale) {
asTransaction([&](Transaction& t) {
t.show(mChild);
t.setPosition(mChild, 0, 0);
t.setPosition(mFGSurfaceControl, 0, 0);
});
{
mCapture = screenshot();
mCapture->expectChildColor(0, 0);
mCapture->expectChildColor(9, 14);
mCapture->expectFGColor(10, 15);
}
// Change the size of the foreground to 128 * 64 so we can test rotation as well.
asTransaction([&](Transaction& t) {
t.setOverrideScalingMode(mFGSurfaceControl, NATIVE_WINDOW_SCALING_MODE_SCALE_TO_WINDOW);
t.setSize(mFGSurfaceControl, 128, 64);
});
sp<Surface> s = mFGSurfaceControl->getSurface();
auto anw = static_cast<ANativeWindow*>(s.get());
// Apply a 90 transform on the buffer and submit a buffer half the expected size so that we
// have an effective scale of 2.0 applied to the buffer along with a rotation transform.
native_window_set_buffers_transform(anw, NATIVE_WINDOW_TRANSFORM_ROT_90);
native_window_set_buffers_dimensions(anw, 32, 64);
TransactionUtils::fillSurfaceRGBA8(mFGSurfaceControl, 195, 63, 63);
waitForPostedBuffers();
// The child should ignore the buffer transform but apply the 2.0 scale from parent.
{
mCapture = screenshot();
mCapture->expectChildColor(0, 0);
mCapture->expectChildColor(19, 29);
mCapture->expectFGColor(20, 30);
}
}
TEST_F(ChildLayerTest, Bug36858924) {
// Destroy the child layer
mChild.clear();
// Now recreate it as hidden
mChild = createSurface(mClient, "Child surface", 10, 10, PIXEL_FORMAT_RGBA_8888,
ISurfaceComposerClient::eHidden, mFGSurfaceControl.get());
// Show the child layer in a deferred transaction
asTransaction([&](Transaction& t) {
t.deferTransactionUntil_legacy(mChild, mFGSurfaceControl->getHandle(),
mFGSurfaceControl->getSurface()->getNextFrameNumber());
t.show(mChild);
});
// Render the foreground surface a few times
//
// Prior to the bugfix for b/36858924, this would usually hang while trying to fill the third
// frame because SurfaceFlinger would never process the deferred transaction and would therefore
// never acquire/release the first buffer
ALOGI("Filling 1");
TransactionUtils::fillSurfaceRGBA8(mFGSurfaceControl, 0, 255, 0);
ALOGI("Filling 2");
TransactionUtils::fillSurfaceRGBA8(mFGSurfaceControl, 0, 0, 255);
ALOGI("Filling 3");
TransactionUtils::fillSurfaceRGBA8(mFGSurfaceControl, 255, 0, 0);
ALOGI("Filling 4");
TransactionUtils::fillSurfaceRGBA8(mFGSurfaceControl, 0, 255, 0);
}
TEST_F(ChildLayerTest, Reparent) {
asTransaction([&](Transaction& t) {
t.show(mChild);
t.setPosition(mChild, 10, 10);
t.setPosition(mFGSurfaceControl, 64, 64);
});
{
mCapture = screenshot();
// Top left of foreground must now be visible
mCapture->expectFGColor(64, 64);
// But 10 pixels in we should see the child surface
mCapture->expectChildColor(74, 74);
// And 10 more pixels we should be back to the foreground surface
mCapture->expectFGColor(84, 84);
}
asTransaction([&](Transaction& t) { t.reparent(mChild, mBGSurfaceControl->getHandle()); });
{
mCapture = screenshot();
mCapture->expectFGColor(64, 64);
// In reparenting we should have exposed the entire foreground surface.
mCapture->expectFGColor(74, 74);
// And the child layer should now begin at 10, 10 (since the BG
// layer is at (0, 0)).
mCapture->expectBGColor(9, 9);
mCapture->expectChildColor(10, 10);
}
}
TEST_F(ChildLayerTest, ReparentToNoParent) {
asTransaction([&](Transaction& t) {
t.show(mChild);
t.setPosition(mChild, 10, 10);
t.setPosition(mFGSurfaceControl, 64, 64);
});
{
mCapture = screenshot();
// Top left of foreground must now be visible
mCapture->expectFGColor(64, 64);
// But 10 pixels in we should see the child surface
mCapture->expectChildColor(74, 74);
// And 10 more pixels we should be back to the foreground surface
mCapture->expectFGColor(84, 84);
}
asTransaction([&](Transaction& t) { t.reparent(mChild, nullptr); });
{
mCapture = screenshot();
// The surface should now be offscreen.
mCapture->expectFGColor(64, 64);
mCapture->expectFGColor(74, 74);
mCapture->expectFGColor(84, 84);
}
}
TEST_F(ChildLayerTest, ReparentFromNoParent) {
sp<SurfaceControl> newSurface = createLayer(String8("New Surface"), 10, 10, 0);
ASSERT_TRUE(newSurface != nullptr);
ASSERT_TRUE(newSurface->isValid());
TransactionUtils::fillSurfaceRGBA8(newSurface, 63, 195, 63);
asTransaction([&](Transaction& t) {
t.hide(mChild);
t.show(newSurface);
t.setPosition(newSurface, 10, 10);
t.setLayer(newSurface, INT32_MAX - 2);
t.setPosition(mFGSurfaceControl, 64, 64);
});
{
mCapture = screenshot();
// Top left of foreground must now be visible
mCapture->expectFGColor(64, 64);
// At 10, 10 we should see the new surface
mCapture->checkPixel(10, 10, 63, 195, 63);
}
asTransaction([&](Transaction& t) { t.reparent(newSurface, mFGSurfaceControl->getHandle()); });
{
mCapture = screenshot();
// newSurface will now be a child of mFGSurface so it will be 10, 10 offset from
// mFGSurface, putting it at 74, 74.
mCapture->expectFGColor(64, 64);
mCapture->checkPixel(74, 74, 63, 195, 63);
mCapture->expectFGColor(84, 84);
}
}
TEST_F(ChildLayerTest, NestedChildren) {
sp<SurfaceControl> grandchild = createSurface(mClient, "Grandchild surface", 10, 10,
PIXEL_FORMAT_RGBA_8888, 0, mChild.get());
TransactionUtils::fillSurfaceRGBA8(grandchild, 50, 50, 50);
{
mCapture = screenshot();
// Expect the grandchild to begin at 64, 64 because it's a child of mChild layer
// which begins at 64, 64
mCapture->checkPixel(64, 64, 50, 50, 50);
}
}
TEST_F(ChildLayerTest, ChildLayerRelativeLayer) {
sp<SurfaceControl> relative = createLayer(String8("Relative surface"), 128, 128, 0);
TransactionUtils::fillSurfaceRGBA8(relative, 255, 255, 255);
Transaction t;
t.setLayer(relative, INT32_MAX)
.setRelativeLayer(mChild, relative->getHandle(), 1)
.setPosition(mFGSurfaceControl, 0, 0)
.apply(true);
// We expect that the child should have been elevated above our
// INT_MAX layer even though it's not a child of it.
{
mCapture = screenshot();
mCapture->expectChildColor(0, 0);
mCapture->expectChildColor(9, 9);
mCapture->checkPixel(10, 10, 255, 255, 255);
}
}
class BoundlessLayerTest : public LayerUpdateTest {
protected:
std::unique_ptr<ScreenCapture> mCapture;
};
// Verify setting a size on a buffer layer has no effect.
TEST_F(BoundlessLayerTest, BufferLayerIgnoresSize) {
sp<SurfaceControl> bufferLayer =
createSurface(mClient, "BufferLayer", 45, 45, PIXEL_FORMAT_RGBA_8888, 0,
mFGSurfaceControl.get());
ASSERT_TRUE(bufferLayer->isValid());
ASSERT_NO_FATAL_FAILURE(fillBufferQueueLayerColor(bufferLayer, Color::BLACK, 30, 30));
asTransaction([&](Transaction& t) { t.show(bufferLayer); });
{
mCapture = screenshot();
// Top left of background must now be visible
mCapture->expectBGColor(0, 0);
// Foreground Surface bounds must be color layer
mCapture->expectColor(Rect(64, 64, 94, 94), Color::BLACK);
// Buffer layer should not extend past buffer bounds
mCapture->expectFGColor(95, 95);
}
}
// Verify a boundless color layer will fill its parent bounds. The parent has a buffer size
// which will crop the color layer.
TEST_F(BoundlessLayerTest, BoundlessColorLayerFillsParentBufferBounds) {
sp<SurfaceControl> colorLayer =
createSurface(mClient, "ColorLayer", 0, 0, PIXEL_FORMAT_RGBA_8888,
ISurfaceComposerClient::eFXSurfaceColor, mFGSurfaceControl.get());
ASSERT_TRUE(colorLayer->isValid());
asTransaction([&](Transaction& t) {
t.setColor(colorLayer, half3{0, 0, 0});
t.show(colorLayer);
});
{
mCapture = screenshot();
// Top left of background must now be visible
mCapture->expectBGColor(0, 0);
// Foreground Surface bounds must be color layer
mCapture->expectColor(Rect(64, 64, 128, 128), Color::BLACK);
// Color layer should not extend past foreground bounds
mCapture->expectBGColor(129, 129);
}
}
// Verify a boundless color layer will fill its parent bounds. The parent has no buffer but has
// a crop which will be used to crop the color layer.
TEST_F(BoundlessLayerTest, BoundlessColorLayerFillsParentCropBounds) {
sp<SurfaceControl> cropLayer = createSurface(mClient, "CropLayer", 0, 0, PIXEL_FORMAT_RGBA_8888,
0 /* flags */, mFGSurfaceControl.get());
ASSERT_TRUE(cropLayer->isValid());
sp<SurfaceControl> colorLayer =
createSurface(mClient, "ColorLayer", 0, 0, PIXEL_FORMAT_RGBA_8888,
ISurfaceComposerClient::eFXSurfaceColor, cropLayer.get());
ASSERT_TRUE(colorLayer->isValid());
asTransaction([&](Transaction& t) {
t.setCrop_legacy(cropLayer, Rect(5, 5, 10, 10));
t.setColor(colorLayer, half3{0, 0, 0});
t.show(cropLayer);
t.show(colorLayer);
});
{
mCapture = screenshot();
// Top left of background must now be visible
mCapture->expectBGColor(0, 0);
// Top left of foreground must now be visible
mCapture->expectFGColor(64, 64);
// 5 pixels from the foreground we should see the child surface
mCapture->expectColor(Rect(69, 69, 74, 74), Color::BLACK);
// 10 pixels from the foreground we should be back to the foreground surface
mCapture->expectFGColor(74, 74);
}
}
// Verify for boundless layer with no children, their transforms have no effect.
TEST_F(BoundlessLayerTest, BoundlessColorLayerTransformHasNoEffect) {
sp<SurfaceControl> colorLayer =
createSurface(mClient, "ColorLayer", 0, 0, PIXEL_FORMAT_RGBA_8888,
ISurfaceComposerClient::eFXSurfaceColor, mFGSurfaceControl.get());
ASSERT_TRUE(colorLayer->isValid());
asTransaction([&](Transaction& t) {
t.setPosition(colorLayer, 320, 320);
t.setMatrix(colorLayer, 2, 0, 0, 2);
t.setColor(colorLayer, half3{0, 0, 0});
t.show(colorLayer);
});
{
mCapture = screenshot();
// Top left of background must now be visible
mCapture->expectBGColor(0, 0);
// Foreground Surface bounds must be color layer
mCapture->expectColor(Rect(64, 64, 128, 128), Color::BLACK);
// Color layer should not extend past foreground bounds
mCapture->expectBGColor(129, 129);
}
}
// Verify for boundless layer with children, their transforms have an effect.
TEST_F(BoundlessLayerTest, IntermediateBoundlessLayerCanSetTransform) {
sp<SurfaceControl> boundlessLayerRightShift =
createSurface(mClient, "BoundlessLayerRightShift", 0, 0, PIXEL_FORMAT_RGBA_8888,
0 /* flags */, mFGSurfaceControl.get());
ASSERT_TRUE(boundlessLayerRightShift->isValid());
sp<SurfaceControl> boundlessLayerDownShift =
createSurface(mClient, "BoundlessLayerLeftShift", 0, 0, PIXEL_FORMAT_RGBA_8888,
0 /* flags */, boundlessLayerRightShift.get());
ASSERT_TRUE(boundlessLayerDownShift->isValid());
sp<SurfaceControl> colorLayer =
createSurface(mClient, "ColorLayer", 0, 0, PIXEL_FORMAT_RGBA_8888,
ISurfaceComposerClient::eFXSurfaceColor, boundlessLayerDownShift.get());
ASSERT_TRUE(colorLayer->isValid());
asTransaction([&](Transaction& t) {
t.setPosition(boundlessLayerRightShift, 32, 0);
t.show(boundlessLayerRightShift);
t.setPosition(boundlessLayerDownShift, 0, 32);
t.show(boundlessLayerDownShift);
t.setCrop_legacy(colorLayer, Rect(0, 0, 64, 64));
t.setColor(colorLayer, half3{0, 0, 0});
t.show(colorLayer);
});
{
mCapture = screenshot();
// Top left of background must now be visible
mCapture->expectBGColor(0, 0);
// Top left of foreground must now be visible
mCapture->expectFGColor(64, 64);
// Foreground Surface bounds must be color layer
mCapture->expectColor(Rect(96, 96, 128, 128), Color::BLACK);
// Color layer should not extend past foreground bounds
mCapture->expectBGColor(129, 129);
}
}
// Verify child layers do not get clipped if they temporarily move into the negative
// coordinate space as the result of an intermediate transformation.
TEST_F(BoundlessLayerTest, IntermediateBoundlessLayerDoNotCrop) {
sp<SurfaceControl> boundlessLayer =
mClient->createSurface(String8("BoundlessLayer"), 0, 0, PIXEL_FORMAT_RGBA_8888,
0 /* flags */, mFGSurfaceControl.get());
ASSERT_TRUE(boundlessLayer != nullptr);
ASSERT_TRUE(boundlessLayer->isValid());
sp<SurfaceControl> colorLayer =
mClient->createSurface(String8("ColorLayer"), 0, 0, PIXEL_FORMAT_RGBA_8888,
ISurfaceComposerClient::eFXSurfaceColor, boundlessLayer.get());
ASSERT_TRUE(colorLayer != nullptr);
ASSERT_TRUE(colorLayer->isValid());
asTransaction([&](Transaction& t) {
// shift child layer off bounds. If this layer was not boundless, we will
// expect the child layer to be cropped.
t.setPosition(boundlessLayer, 32, 32);
t.show(boundlessLayer);
t.setCrop_legacy(colorLayer, Rect(0, 0, 64, 64));
// undo shift by parent
t.setPosition(colorLayer, -32, -32);
t.setColor(colorLayer, half3{0, 0, 0});
t.show(colorLayer);
});
{
mCapture = screenshot();
// Top left of background must now be visible
mCapture->expectBGColor(0, 0);
// Foreground Surface bounds must be color layer
mCapture->expectColor(Rect(64, 64, 128, 128), Color::BLACK);
// Color layer should not extend past foreground bounds
mCapture->expectBGColor(129, 129);
}
}
// Verify for boundless root layers with children, their transforms have an effect.
TEST_F(BoundlessLayerTest, RootBoundlessLayerCanSetTransform) {
sp<SurfaceControl> rootBoundlessLayer = createSurface(mClient, "RootBoundlessLayer", 0, 0,
PIXEL_FORMAT_RGBA_8888, 0 /* flags */);
ASSERT_TRUE(rootBoundlessLayer->isValid());
sp<SurfaceControl> colorLayer =
createSurface(mClient, "ColorLayer", 0, 0, PIXEL_FORMAT_RGBA_8888,
ISurfaceComposerClient::eFXSurfaceColor, rootBoundlessLayer.get());
ASSERT_TRUE(colorLayer->isValid());
asTransaction([&](Transaction& t) {
t.setLayer(rootBoundlessLayer, INT32_MAX - 1);
t.setPosition(rootBoundlessLayer, 32, 32);
t.show(rootBoundlessLayer);
t.setCrop_legacy(colorLayer, Rect(0, 0, 64, 64));
t.setColor(colorLayer, half3{0, 0, 0});
t.show(colorLayer);
t.hide(mFGSurfaceControl);
});
{
mCapture = screenshot();
// Top left of background must now be visible
mCapture->expectBGColor(0, 0);
// Top left of foreground must now be visible
mCapture->expectBGColor(31, 31);
// Foreground Surface bounds must be color layer
mCapture->expectColor(Rect(32, 32, 96, 96), Color::BLACK);
// Color layer should not extend past foreground bounds
mCapture->expectBGColor(97, 97);
}
}
class ScreenCaptureTest : public LayerUpdateTest {
protected:
std::unique_ptr<ScreenCapture> mCapture;
};
TEST_F(ScreenCaptureTest, CaptureSingleLayer) {
auto bgHandle = mBGSurfaceControl->getHandle();
ScreenCapture::captureLayers(&mCapture, bgHandle);
mCapture->expectBGColor(0, 0);
// Doesn't capture FG layer which is at 64, 64
mCapture->expectBGColor(64, 64);
}
TEST_F(ScreenCaptureTest, CaptureLayerWithChild) {
auto fgHandle = mFGSurfaceControl->getHandle();
sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
TransactionUtils::fillSurfaceRGBA8(child, 200, 200, 200);
SurfaceComposerClient::Transaction().show(child).apply(true);
// Captures mFGSurfaceControl layer and its child.
ScreenCapture::captureLayers(&mCapture, fgHandle);
mCapture->expectFGColor(10, 10);
mCapture->expectChildColor(0, 0);
}
TEST_F(ScreenCaptureTest, CaptureLayerChildOnly) {
auto fgHandle = mFGSurfaceControl->getHandle();
sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
TransactionUtils::fillSurfaceRGBA8(child, 200, 200, 200);
SurfaceComposerClient::Transaction().show(child).apply(true);
// Captures mFGSurfaceControl's child
ScreenCapture::captureChildLayers(&mCapture, fgHandle);
mCapture->checkPixel(10, 10, 0, 0, 0);
mCapture->expectChildColor(0, 0);
}
TEST_F(ScreenCaptureTest, CaptureLayerExclude) {
auto fgHandle = mFGSurfaceControl->getHandle();
sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
TransactionUtils::fillSurfaceRGBA8(child, 200, 200, 200);
sp<SurfaceControl> child2 = createSurface(mClient, "Child surface", 10, 10,
PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
TransactionUtils::fillSurfaceRGBA8(child2, 200, 0, 200);
SurfaceComposerClient::Transaction()
.show(child)
.show(child2)
.setLayer(child, 1)
.setLayer(child2, 2)
.apply(true);
// Child2 would be visible but its excluded, so we should see child1 color instead.
ScreenCapture::captureChildLayersExcluding(&mCapture, fgHandle, {child2->getHandle()});
mCapture->checkPixel(10, 10, 0, 0, 0);
mCapture->checkPixel(0, 0, 200, 200, 200);
}
// Like the last test but verifies that children are also exclude.
TEST_F(ScreenCaptureTest, CaptureLayerExcludeTree) {
auto fgHandle = mFGSurfaceControl->getHandle();
sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
TransactionUtils::fillSurfaceRGBA8(child, 200, 200, 200);
sp<SurfaceControl> child2 = createSurface(mClient, "Child surface", 10, 10,
PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
TransactionUtils::fillSurfaceRGBA8(child2, 200, 0, 200);
sp<SurfaceControl> child3 = createSurface(mClient, "Child surface", 10, 10,
PIXEL_FORMAT_RGBA_8888, 0, child2.get());
TransactionUtils::fillSurfaceRGBA8(child2, 200, 0, 200);
SurfaceComposerClient::Transaction()
.show(child)
.show(child2)
.show(child3)
.setLayer(child, 1)
.setLayer(child2, 2)
.apply(true);
// Child2 would be visible but its excluded, so we should see child1 color instead.
ScreenCapture::captureChildLayersExcluding(&mCapture, fgHandle, {child2->getHandle()});
mCapture->checkPixel(10, 10, 0, 0, 0);
mCapture->checkPixel(0, 0, 200, 200, 200);
}
TEST_F(ScreenCaptureTest, CaptureTransparent) {
sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
TransactionUtils::fillSurfaceRGBA8(child, 200, 200, 200);
SurfaceComposerClient::Transaction().show(child).apply(true);
auto childHandle = child->getHandle();
// Captures child
ScreenCapture::captureLayers(&mCapture, childHandle, {0, 0, 10, 20});
mCapture->expectColor(Rect(0, 0, 9, 9), {200, 200, 200, 255});
// Area outside of child's bounds is transparent.
mCapture->expectColor(Rect(0, 10, 9, 19), {0, 0, 0, 0});
}
TEST_F(ScreenCaptureTest, DontCaptureRelativeOutsideTree) {
auto fgHandle = mFGSurfaceControl->getHandle();
sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
ASSERT_NE(nullptr, child.get()) << "failed to create surface";
sp<SurfaceControl> relative = createLayer(String8("Relative surface"), 10, 10, 0);
TransactionUtils::fillSurfaceRGBA8(child, 200, 200, 200);
TransactionUtils::fillSurfaceRGBA8(relative, 100, 100, 100);
SurfaceComposerClient::Transaction()
.show(child)
// Set relative layer above fg layer so should be shown above when computing all layers.
.setRelativeLayer(relative, fgHandle, 1)
.show(relative)
.apply(true);
// Captures mFGSurfaceControl layer and its child. Relative layer shouldn't be captured.
ScreenCapture::captureLayers(&mCapture, fgHandle);
mCapture->expectFGColor(10, 10);
mCapture->expectChildColor(0, 0);
}
TEST_F(ScreenCaptureTest, CaptureRelativeInTree) {
auto fgHandle = mFGSurfaceControl->getHandle();
sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
sp<SurfaceControl> relative = createSurface(mClient, "Relative surface", 10, 10,
PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
TransactionUtils::fillSurfaceRGBA8(child, 200, 200, 200);
TransactionUtils::fillSurfaceRGBA8(relative, 100, 100, 100);
SurfaceComposerClient::Transaction()
.show(child)
// Set relative layer below fg layer but relative to child layer so it should be shown
// above child layer.
.setLayer(relative, -1)
.setRelativeLayer(relative, child->getHandle(), 1)
.show(relative)
.apply(true);
// Captures mFGSurfaceControl layer and its children. Relative layer is a child of fg so its
// relative value should be taken into account, placing it above child layer.
ScreenCapture::captureLayers(&mCapture, fgHandle);
mCapture->expectFGColor(10, 10);
// Relative layer is showing on top of child layer
mCapture->expectColor(Rect(0, 0, 9, 9), {100, 100, 100, 255});
}
TEST_F(ScreenCaptureTest, CaptureBoundlessLayerWithSourceCrop) {
sp<SurfaceControl> child = createColorLayer("Child layer", Color::RED, mFGSurfaceControl.get());
SurfaceComposerClient::Transaction().show(child).apply(true);
sp<ISurfaceComposer> sf(ComposerService::getComposerService());
sp<GraphicBuffer> outBuffer;
Rect sourceCrop(0, 0, 10, 10);
ASSERT_EQ(NO_ERROR, sf->captureLayers(child->getHandle(), &outBuffer, sourceCrop));
ScreenCapture sc(outBuffer);
sc.expectColor(Rect(0, 0, 9, 9), Color::RED);
}
TEST_F(ScreenCaptureTest, CaptureBoundedLayerWithoutSourceCrop) {
sp<SurfaceControl> child = createColorLayer("Child layer", Color::RED, mFGSurfaceControl.get());
Rect layerCrop(0, 0, 10, 10);
SurfaceComposerClient::Transaction().setCrop_legacy(child, layerCrop).show(child).apply(true);
sp<ISurfaceComposer> sf(ComposerService::getComposerService());
sp<GraphicBuffer> outBuffer;
Rect sourceCrop = Rect();
ASSERT_EQ(NO_ERROR, sf->captureLayers(child->getHandle(), &outBuffer, sourceCrop));
ScreenCapture sc(outBuffer);
sc.expectColor(Rect(0, 0, 9, 9), Color::RED);
}
TEST_F(ScreenCaptureTest, CaptureBoundlessLayerWithoutSourceCropFails) {
sp<SurfaceControl> child = createColorLayer("Child layer", Color::RED, mFGSurfaceControl.get());
SurfaceComposerClient::Transaction().show(child).apply(true);
sp<ISurfaceComposer> sf(ComposerService::getComposerService());
sp<GraphicBuffer> outBuffer;
Rect sourceCrop = Rect();
ASSERT_EQ(BAD_VALUE, sf->captureLayers(child->getHandle(), &outBuffer, sourceCrop));
}
TEST_F(ScreenCaptureTest, CaptureBufferLayerWithoutBufferFails) {
sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
SurfaceComposerClient::Transaction().show(child).apply(true);
sp<ISurfaceComposer> sf(ComposerService::getComposerService());
sp<GraphicBuffer> outBuffer;
Rect sourceCrop = Rect();
ASSERT_EQ(BAD_VALUE, sf->captureLayers(child->getHandle(), &outBuffer, sourceCrop));
TransactionUtils::fillSurfaceRGBA8(child, Color::RED);
SurfaceComposerClient::Transaction().apply(true);
ASSERT_EQ(NO_ERROR, sf->captureLayers(child->getHandle(), &outBuffer, sourceCrop));
ScreenCapture sc(outBuffer);
sc.expectColor(Rect(0, 0, 9, 9), Color::RED);
}
// In the following tests we verify successful skipping of a parent layer,
// so we use the same verification logic and only change how we mutate
// the parent layer to verify that various properties are ignored.
class ScreenCaptureChildOnlyTest : public LayerUpdateTest {
public:
void SetUp() override {
LayerUpdateTest::SetUp();
mChild = createSurface(mClient, "Child surface", 10, 10, PIXEL_FORMAT_RGBA_8888, 0,
mFGSurfaceControl.get());
TransactionUtils::fillSurfaceRGBA8(mChild, 200, 200, 200);
SurfaceComposerClient::Transaction().show(mChild).apply(true);
}
void verify(std::function<void()> verifyStartingState) {
// Verify starting state before a screenshot is taken.
verifyStartingState();
// Verify child layer does not inherit any of the properties of its
// parent when its screenshot is captured.
auto fgHandle = mFGSurfaceControl->getHandle();
ScreenCapture::captureChildLayers(&mCapture, fgHandle);
mCapture->checkPixel(10, 10, 0, 0, 0);
mCapture->expectChildColor(0, 0);
// Verify all assumptions are still true after the screenshot is taken.
verifyStartingState();
}
std::unique_ptr<ScreenCapture> mCapture;
sp<SurfaceControl> mChild;
};
// Regression test b/76099859
TEST_F(ScreenCaptureChildOnlyTest, CaptureLayerIgnoresParentVisibility) {
SurfaceComposerClient::Transaction().hide(mFGSurfaceControl).apply(true);
// Even though the parent is hidden we should still capture the child.
// Before and after reparenting, verify child is properly hidden
// when rendering full-screen.
verify([&] { screenshot()->expectBGColor(64, 64); });
}
TEST_F(ScreenCaptureChildOnlyTest, CaptureLayerIgnoresParentCrop) {
SurfaceComposerClient::Transaction()
.setCrop_legacy(mFGSurfaceControl, Rect(0, 0, 1, 1))
.apply(true);
// Even though the parent is cropped out we should still capture the child.
// Before and after reparenting, verify child is cropped by parent.
verify([&] { screenshot()->expectBGColor(65, 65); });
}
// Regression test b/124372894
TEST_F(ScreenCaptureChildOnlyTest, CaptureLayerIgnoresTransform) {
SurfaceComposerClient::Transaction().setMatrix(mFGSurfaceControl, 2, 0, 0, 2).apply(true);
// We should not inherit the parent scaling.
// Before and after reparenting, verify child is properly scaled.
verify([&] { screenshot()->expectChildColor(80, 80); });
}
TEST_F(ScreenCaptureTest, CaptureLayerWithGrandchild) {
auto fgHandle = mFGSurfaceControl->getHandle();
sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
TransactionUtils::fillSurfaceRGBA8(child, 200, 200, 200);
sp<SurfaceControl> grandchild = createSurface(mClient, "Grandchild surface", 5, 5,
PIXEL_FORMAT_RGBA_8888, 0, child.get());
TransactionUtils::fillSurfaceRGBA8(grandchild, 50, 50, 50);
SurfaceComposerClient::Transaction()
.show(child)
.setPosition(grandchild, 5, 5)
.show(grandchild)
.apply(true);
// Captures mFGSurfaceControl, its child, and the grandchild.
ScreenCapture::captureLayers(&mCapture, fgHandle);
mCapture->expectFGColor(10, 10);
mCapture->expectChildColor(0, 0);
mCapture->checkPixel(5, 5, 50, 50, 50);
}
TEST_F(ScreenCaptureTest, CaptureChildOnly) {
sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
TransactionUtils::fillSurfaceRGBA8(child, 200, 200, 200);
auto childHandle = child->getHandle();
SurfaceComposerClient::Transaction().setPosition(child, 5, 5).show(child).apply(true);
// Captures only the child layer, and not the parent.
ScreenCapture::captureLayers(&mCapture, childHandle);
mCapture->expectChildColor(0, 0);
mCapture->expectChildColor(9, 9);
}
TEST_F(ScreenCaptureTest, CaptureGrandchildOnly) {
sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
TransactionUtils::fillSurfaceRGBA8(child, 200, 200, 200);
auto childHandle = child->getHandle();
sp<SurfaceControl> grandchild = createSurface(mClient, "Grandchild surface", 5, 5,
PIXEL_FORMAT_RGBA_8888, 0, child.get());
TransactionUtils::fillSurfaceRGBA8(grandchild, 50, 50, 50);
SurfaceComposerClient::Transaction()
.show(child)
.setPosition(grandchild, 5, 5)
.show(grandchild)
.apply(true);
auto grandchildHandle = grandchild->getHandle();
// Captures only the grandchild.
ScreenCapture::captureLayers(&mCapture, grandchildHandle);
mCapture->checkPixel(0, 0, 50, 50, 50);
mCapture->checkPixel(4, 4, 50, 50, 50);
}
TEST_F(ScreenCaptureTest, CaptureCrop) {
sp<SurfaceControl> redLayer = createLayer(String8("Red surface"), 60, 60, 0);
sp<SurfaceControl> blueLayer = createSurface(mClient, "Blue surface", 30, 30,
PIXEL_FORMAT_RGBA_8888, 0, redLayer.get());
ASSERT_NO_FATAL_FAILURE(fillBufferQueueLayerColor(redLayer, Color::RED, 60, 60));
ASSERT_NO_FATAL_FAILURE(fillBufferQueueLayerColor(blueLayer, Color::BLUE, 30, 30));
SurfaceComposerClient::Transaction()
.setLayer(redLayer, INT32_MAX - 1)
.show(redLayer)
.show(blueLayer)
.apply(true);
auto redLayerHandle = redLayer->getHandle();
// Capturing full screen should have both red and blue are visible.
ScreenCapture::captureLayers(&mCapture, redLayerHandle);
mCapture->expectColor(Rect(0, 0, 29, 29), Color::BLUE);
// red area below the blue area
mCapture->expectColor(Rect(0, 30, 59, 59), Color::RED);
// red area to the right of the blue area
mCapture->expectColor(Rect(30, 0, 59, 59), Color::RED);
const Rect crop = Rect(0, 0, 30, 30);
ScreenCapture::captureLayers(&mCapture, redLayerHandle, crop);
// Capturing the cropped screen, cropping out the shown red area, should leave only the blue
// area visible.
mCapture->expectColor(Rect(0, 0, 29, 29), Color::BLUE);
mCapture->checkPixel(30, 30, 0, 0, 0);
}
TEST_F(ScreenCaptureTest, CaptureSize) {
sp<SurfaceControl> redLayer = createLayer(String8("Red surface"), 60, 60, 0);
sp<SurfaceControl> blueLayer = createSurface(mClient, "Blue surface", 30, 30,
PIXEL_FORMAT_RGBA_8888, 0, redLayer.get());
ASSERT_NO_FATAL_FAILURE(fillBufferQueueLayerColor(redLayer, Color::RED, 60, 60));
ASSERT_NO_FATAL_FAILURE(fillBufferQueueLayerColor(blueLayer, Color::BLUE, 30, 30));
SurfaceComposerClient::Transaction()
.setLayer(redLayer, INT32_MAX - 1)
.show(redLayer)
.show(blueLayer)
.apply(true);
auto redLayerHandle = redLayer->getHandle();
// Capturing full screen should have both red and blue are visible.
ScreenCapture::captureLayers(&mCapture, redLayerHandle);
mCapture->expectColor(Rect(0, 0, 29, 29), Color::BLUE);
// red area below the blue area
mCapture->expectColor(Rect(0, 30, 59, 59), Color::RED);
// red area to the right of the blue area
mCapture->expectColor(Rect(30, 0, 59, 59), Color::RED);
ScreenCapture::captureLayers(&mCapture, redLayerHandle, Rect::EMPTY_RECT, 0.5);
// Capturing the downsized area (30x30) should leave both red and blue but in a smaller area.
mCapture->expectColor(Rect(0, 0, 14, 14), Color::BLUE);
// red area below the blue area
mCapture->expectColor(Rect(0, 15, 29, 29), Color::RED);
// red area to the right of the blue area
mCapture->expectColor(Rect(15, 0, 29, 29), Color::RED);
mCapture->checkPixel(30, 30, 0, 0, 0);
}
TEST_F(ScreenCaptureTest, CaptureInvalidLayer) {
sp<SurfaceControl> redLayer = createLayer(String8("Red surface"), 60, 60, 0);
ASSERT_NO_FATAL_FAILURE(fillBufferQueueLayerColor(redLayer, Color::RED, 60, 60));
auto redLayerHandle = redLayer->getHandle();
redLayer.clear();
SurfaceComposerClient::Transaction().apply(true);
sp<GraphicBuffer> outBuffer;
// Layer was deleted so captureLayers should fail with NAME_NOT_FOUND
sp<ISurfaceComposer> sf(ComposerService::getComposerService());
ASSERT_EQ(NAME_NOT_FOUND, sf->captureLayers(redLayerHandle, &outBuffer, Rect::EMPTY_RECT, 1.0));
}
} // namespace android