blob: 061e121950f99f5aca8ede1fa576772d91fd4afc [file] [log] [blame]
chaviw3efadb12020-07-27 10:07:15 -07001/*
2 * Copyright (C) 2020 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17// TODO(b/129481165): remove the #pragma below and fix conversion issues
Melody Hsue69bb172023-10-27 13:51:17 +000018#include <sys/types.h>
19#include <cstdint>
chaviw3efadb12020-07-27 10:07:15 -070020#pragma clang diagnostic push
21#pragma clang diagnostic ignored "-Wconversion"
22
chaviw70cb6a42020-07-30 13:57:36 -070023#include <private/android_filesystem_config.h>
Patrick Williams1c8d8422023-07-06 11:23:17 -050024#include <ui/DisplayState.h>
chaviw70cb6a42020-07-30 13:57:36 -070025
chaviw3efadb12020-07-27 10:07:15 -070026#include "LayerTransactionTest.h"
27
28namespace android {
29
30class ScreenCaptureTest : public LayerTransactionTest {
31protected:
32 virtual void SetUp() {
33 LayerTransactionTest::SetUp();
34 ASSERT_EQ(NO_ERROR, mClient->initCheck());
35
Melody Hsue69bb172023-10-27 13:51:17 +000036 // Root surface
37 mRootSurfaceControl =
38 createLayer(String8("RootTestSurface"), mDisplayWidth, mDisplayHeight, 0);
39 ASSERT_TRUE(mRootSurfaceControl != nullptr);
40 ASSERT_TRUE(mRootSurfaceControl->isValid());
chaviw79468ab2021-10-27 11:11:24 -050041
chaviw3efadb12020-07-27 10:07:15 -070042 // Background surface
Melody Hsue69bb172023-10-27 13:51:17 +000043 mBGSurfaceControl = createLayer(String8("BG Test Surface"), mDisplayWidth, mDisplayHeight,
44 0, mRootSurfaceControl.get());
chaviw3efadb12020-07-27 10:07:15 -070045 ASSERT_TRUE(mBGSurfaceControl != nullptr);
46 ASSERT_TRUE(mBGSurfaceControl->isValid());
47 TransactionUtils::fillSurfaceRGBA8(mBGSurfaceControl, 63, 63, 195);
48
49 // Foreground surface
Melody Hsue69bb172023-10-27 13:51:17 +000050 mFGSurfaceControl =
51 createLayer(String8("FG Test Surface"), 64, 64, 0, mRootSurfaceControl.get());
chaviw3efadb12020-07-27 10:07:15 -070052
53 ASSERT_TRUE(mFGSurfaceControl != nullptr);
54 ASSERT_TRUE(mFGSurfaceControl->isValid());
55
56 TransactionUtils::fillSurfaceRGBA8(mFGSurfaceControl, 195, 63, 63);
57
58 asTransaction([&](Transaction& t) {
Melody Hsue69bb172023-10-27 13:51:17 +000059 t.setDisplayLayerStack(mDisplay, ui::DEFAULT_LAYER_STACK);
chaviw3efadb12020-07-27 10:07:15 -070060
61 t.setLayer(mBGSurfaceControl, INT32_MAX - 2).show(mBGSurfaceControl);
62
63 t.setLayer(mFGSurfaceControl, INT32_MAX - 1)
64 .setPosition(mFGSurfaceControl, 64, 64)
65 .show(mFGSurfaceControl);
66 });
Melody Hsue69bb172023-10-27 13:51:17 +000067
68 mCaptureArgs.sourceCrop = mDisplayRect;
69 mCaptureArgs.layerHandle = mRootSurfaceControl->getHandle();
chaviw3efadb12020-07-27 10:07:15 -070070 }
71
72 virtual void TearDown() {
73 LayerTransactionTest::TearDown();
74 mBGSurfaceControl = 0;
75 mFGSurfaceControl = 0;
76 }
77
Melody Hsue69bb172023-10-27 13:51:17 +000078 sp<SurfaceControl> mRootSurfaceControl;
chaviw3efadb12020-07-27 10:07:15 -070079 sp<SurfaceControl> mBGSurfaceControl;
80 sp<SurfaceControl> mFGSurfaceControl;
81 std::unique_ptr<ScreenCapture> mCapture;
Melody Hsue69bb172023-10-27 13:51:17 +000082 LayerCaptureArgs mCaptureArgs;
chaviw3efadb12020-07-27 10:07:15 -070083};
84
chaviw4b9d5e12020-08-04 18:30:35 -070085TEST_F(ScreenCaptureTest, SetFlagsSecureEUidSystem) {
86 sp<SurfaceControl> layer;
87 ASSERT_NO_FATAL_FAILURE(
88 layer = createLayer("test", 32, 32,
89 ISurfaceComposerClient::eSecure |
Melody Hsue69bb172023-10-27 13:51:17 +000090 ISurfaceComposerClient::eFXSurfaceBufferQueue,
91 mRootSurfaceControl.get()));
chaviw4b9d5e12020-08-04 18:30:35 -070092 ASSERT_NO_FATAL_FAILURE(fillBufferQueueLayerColor(layer, Color::RED, 32, 32));
93
94 Transaction().show(layer).setLayer(layer, INT32_MAX).apply(true);
95
chaviwf5bb97b2021-04-28 15:35:37 -050096 {
97 // Ensure the UID is not root because root has all permissions
98 UIDFaker f(AID_APP_START);
Melody Hsue69bb172023-10-27 13:51:17 +000099 ASSERT_EQ(PERMISSION_DENIED, ScreenCapture::captureLayers(mCaptureArgs, mCaptureResults));
chaviwf5bb97b2021-04-28 15:35:37 -0500100 }
chaviw4b9d5e12020-08-04 18:30:35 -0700101
102 UIDFaker f(AID_SYSTEM);
103
104 // By default the system can capture screenshots with secure layers but they
105 // will be blacked out
Melody Hsue69bb172023-10-27 13:51:17 +0000106 ASSERT_EQ(NO_ERROR, ScreenCapture::captureLayers(mCaptureArgs, mCaptureResults));
chaviw4b9d5e12020-08-04 18:30:35 -0700107
108 {
109 SCOPED_TRACE("as system");
110 auto shot = screenshot();
111 shot->expectColor(Rect(0, 0, 32, 32), Color::BLACK);
112 }
113
114 // Here we pass captureSecureLayers = true and since we are AID_SYSTEM we should be able
115 // to receive them...we are expected to take care with the results.
Melody Hsue69bb172023-10-27 13:51:17 +0000116 mCaptureArgs.captureSecureLayers = true;
117 ASSERT_EQ(NO_ERROR, ScreenCapture::captureLayers(mCaptureArgs, mCaptureResults));
chaviw4b9d5e12020-08-04 18:30:35 -0700118 ASSERT_TRUE(mCaptureResults.capturedSecureLayers);
Alec Mouri14d5b862022-04-27 21:20:04 +0000119 ScreenCapture sc(mCaptureResults.buffer, mCaptureResults.capturedHdrLayers);
chaviw4b9d5e12020-08-04 18:30:35 -0700120 sc.expectColor(Rect(0, 0, 32, 32), Color::RED);
121}
122
Garfield Tande619fa2020-10-02 17:13:53 -0700123TEST_F(ScreenCaptureTest, CaptureChildSetParentFlagsSecureEUidSystem) {
124 sp<SurfaceControl> parentLayer;
125 ASSERT_NO_FATAL_FAILURE(
126 parentLayer = createLayer("parent-test", 32, 32,
127 ISurfaceComposerClient::eSecure |
Melody Hsue69bb172023-10-27 13:51:17 +0000128 ISurfaceComposerClient::eFXSurfaceBufferQueue,
129 mRootSurfaceControl.get()));
Garfield Tande619fa2020-10-02 17:13:53 -0700130 ASSERT_NO_FATAL_FAILURE(fillBufferQueueLayerColor(parentLayer, Color::RED, 32, 32));
131
132 sp<SurfaceControl> childLayer;
133 ASSERT_NO_FATAL_FAILURE(childLayer = createLayer("child-test", 10, 10,
134 ISurfaceComposerClient::eFXSurfaceBufferQueue,
135 parentLayer.get()));
136 ASSERT_NO_FATAL_FAILURE(fillBufferQueueLayerColor(childLayer, Color::BLUE, 10, 10));
137
138 Transaction().show(parentLayer).setLayer(parentLayer, INT32_MAX).show(childLayer).apply(true);
139
140 UIDFaker f(AID_SYSTEM);
141
142 {
143 SCOPED_TRACE("as system");
144 auto shot = screenshot();
145 shot->expectColor(Rect(0, 0, 10, 10), Color::BLACK);
146 }
147
148 // Here we pass captureSecureLayers = true and since we are AID_SYSTEM we should be able
149 // to receive them...we are expected to take care with the results.
Melody Hsue69bb172023-10-27 13:51:17 +0000150 mCaptureArgs.captureSecureLayers = true;
151 ASSERT_EQ(NO_ERROR, ScreenCapture::captureLayers(mCaptureArgs, mCaptureResults));
Garfield Tande619fa2020-10-02 17:13:53 -0700152 ASSERT_TRUE(mCaptureResults.capturedSecureLayers);
Alec Mouri14d5b862022-04-27 21:20:04 +0000153 ScreenCapture sc(mCaptureResults.buffer, mCaptureResults.capturedHdrLayers);
Garfield Tande619fa2020-10-02 17:13:53 -0700154 sc.expectColor(Rect(0, 0, 10, 10), Color::BLUE);
155}
156
Chavi Weingarten4aa22af2023-11-17 19:37:07 +0000157/**
158 * If a parent layer sets the secure flag, but the screenshot requests is for the child hierarchy,
159 * we need to ensure the secure flag is respected from the parent even though the parent isn't
160 * in the captured sub-hierarchy
161 */
162TEST_F(ScreenCaptureTest, CaptureChildRespectsParentSecureFlag) {
163 Rect size(0, 0, 100, 100);
164 Transaction().hide(mBGSurfaceControl).hide(mFGSurfaceControl).apply();
165 sp<SurfaceControl> parentLayer;
166 ASSERT_NO_FATAL_FAILURE(parentLayer = createLayer("parent-test", 0, 0,
167 ISurfaceComposerClient::eHidden,
168 mRootSurfaceControl.get()));
169
170 sp<SurfaceControl> childLayer;
171 ASSERT_NO_FATAL_FAILURE(childLayer = createLayer("child-test", 0, 0,
172 ISurfaceComposerClient::eFXSurfaceBufferState,
173 parentLayer.get()));
174 ASSERT_NO_FATAL_FAILURE(
175 fillBufferLayerColor(childLayer, Color::GREEN, size.width(), size.height()));
176
177 // hide the parent layer to ensure secure flag is passed down to child when screenshotting
178 Transaction().setLayer(parentLayer, INT32_MAX).show(childLayer).apply(true);
179 Transaction()
180 .setFlags(parentLayer, layer_state_t::eLayerSecure, layer_state_t::eLayerSecure)
181 .apply();
182 LayerCaptureArgs captureArgs;
183 captureArgs.layerHandle = childLayer->getHandle();
184 captureArgs.sourceCrop = size;
185 captureArgs.captureSecureLayers = false;
186 {
187 SCOPED_TRACE("parent hidden");
188 ASSERT_EQ(NO_ERROR, ScreenCapture::captureLayers(captureArgs, mCaptureResults));
189 ASSERT_TRUE(mCaptureResults.capturedSecureLayers);
190 ScreenCapture sc(mCaptureResults.buffer, mCaptureResults.capturedHdrLayers);
191 sc.expectColor(size, Color::BLACK);
192 }
193
194 captureArgs.captureSecureLayers = true;
195 {
196 SCOPED_TRACE("capture secure parent not visible");
197 ASSERT_EQ(NO_ERROR, ScreenCapture::captureLayers(captureArgs, mCaptureResults));
198 ASSERT_TRUE(mCaptureResults.capturedSecureLayers);
199 ScreenCapture sc(mCaptureResults.buffer, mCaptureResults.capturedHdrLayers);
200 sc.expectColor(size, Color::GREEN);
201 }
202
203 Transaction().show(parentLayer).apply();
204 captureArgs.captureSecureLayers = false;
205 {
206 SCOPED_TRACE("parent visible");
207 ASSERT_EQ(NO_ERROR, ScreenCapture::captureLayers(captureArgs, mCaptureResults));
208 ASSERT_TRUE(mCaptureResults.capturedSecureLayers);
209 ScreenCapture sc(mCaptureResults.buffer, mCaptureResults.capturedHdrLayers);
210 sc.expectColor(size, Color::BLACK);
211 }
212
213 captureArgs.captureSecureLayers = true;
214 {
215 SCOPED_TRACE("capture secure parent visible");
216 ASSERT_EQ(NO_ERROR, ScreenCapture::captureLayers(captureArgs, mCaptureResults));
217 ASSERT_TRUE(mCaptureResults.capturedSecureLayers);
218 ScreenCapture sc(mCaptureResults.buffer, mCaptureResults.capturedHdrLayers);
219 sc.expectColor(size, Color::GREEN);
220 }
221}
222
223TEST_F(ScreenCaptureTest, CaptureOffscreenChildRespectsParentSecureFlag) {
224 Rect size(0, 0, 100, 100);
225 Transaction().hide(mBGSurfaceControl).hide(mFGSurfaceControl).apply();
226 // Parent layer should be offscreen.
227 sp<SurfaceControl> parentLayer;
228 ASSERT_NO_FATAL_FAILURE(
229 parentLayer = createLayer("parent-test", 0, 0, ISurfaceComposerClient::eHidden));
230
231 sp<SurfaceControl> childLayer;
232 ASSERT_NO_FATAL_FAILURE(childLayer = createLayer("child-test", 0, 0,
233 ISurfaceComposerClient::eFXSurfaceBufferState,
234 parentLayer.get()));
235 ASSERT_NO_FATAL_FAILURE(
236 fillBufferLayerColor(childLayer, Color::GREEN, size.width(), size.height()));
237
238 // hide the parent layer to ensure secure flag is passed down to child when screenshotting
239 Transaction().setLayer(parentLayer, INT32_MAX).show(childLayer).apply(true);
240 Transaction()
241 .setFlags(parentLayer, layer_state_t::eLayerSecure, layer_state_t::eLayerSecure)
242 .apply();
243 LayerCaptureArgs captureArgs;
244 captureArgs.layerHandle = childLayer->getHandle();
245 captureArgs.sourceCrop = size;
246 captureArgs.captureSecureLayers = false;
247 {
248 SCOPED_TRACE("parent hidden");
249 ASSERT_EQ(NO_ERROR, ScreenCapture::captureLayers(captureArgs, mCaptureResults));
250 ASSERT_TRUE(mCaptureResults.capturedSecureLayers);
251 ScreenCapture sc(mCaptureResults.buffer, mCaptureResults.capturedHdrLayers);
252 sc.expectColor(size, Color::BLACK);
253 }
254
255 captureArgs.captureSecureLayers = true;
256 {
257 SCOPED_TRACE("capture secure parent not visible");
258 ASSERT_EQ(NO_ERROR, ScreenCapture::captureLayers(captureArgs, mCaptureResults));
259 ASSERT_TRUE(mCaptureResults.capturedSecureLayers);
260 ScreenCapture sc(mCaptureResults.buffer, mCaptureResults.capturedHdrLayers);
261 sc.expectColor(size, Color::GREEN);
262 }
263
264 Transaction().show(parentLayer).apply();
265 captureArgs.captureSecureLayers = false;
266 {
267 SCOPED_TRACE("parent visible");
268 ASSERT_EQ(NO_ERROR, ScreenCapture::captureLayers(captureArgs, mCaptureResults));
269 ASSERT_TRUE(mCaptureResults.capturedSecureLayers);
270 ScreenCapture sc(mCaptureResults.buffer, mCaptureResults.capturedHdrLayers);
271 sc.expectColor(size, Color::BLACK);
272 }
273
274 captureArgs.captureSecureLayers = true;
275 {
276 SCOPED_TRACE("capture secure parent visible");
277 ASSERT_EQ(NO_ERROR, ScreenCapture::captureLayers(captureArgs, mCaptureResults));
278 ASSERT_TRUE(mCaptureResults.capturedSecureLayers);
279 ScreenCapture sc(mCaptureResults.buffer, mCaptureResults.capturedHdrLayers);
280 sc.expectColor(size, Color::GREEN);
281 }
282}
283
chaviw3efadb12020-07-27 10:07:15 -0700284TEST_F(ScreenCaptureTest, CaptureSingleLayer) {
chaviw70cb6a42020-07-30 13:57:36 -0700285 LayerCaptureArgs captureArgs;
286 captureArgs.layerHandle = mBGSurfaceControl->getHandle();
287 ScreenCapture::captureLayers(&mCapture, captureArgs);
chaviw3efadb12020-07-27 10:07:15 -0700288 mCapture->expectBGColor(0, 0);
289 // Doesn't capture FG layer which is at 64, 64
290 mCapture->expectBGColor(64, 64);
291}
292
293TEST_F(ScreenCaptureTest, CaptureLayerWithChild) {
chaviw3efadb12020-07-27 10:07:15 -0700294 sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
295 PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
296 TransactionUtils::fillSurfaceRGBA8(child, 200, 200, 200);
297
298 SurfaceComposerClient::Transaction().show(child).apply(true);
299
300 // Captures mFGSurfaceControl layer and its child.
chaviw70cb6a42020-07-30 13:57:36 -0700301 LayerCaptureArgs captureArgs;
302 captureArgs.layerHandle = mFGSurfaceControl->getHandle();
303 ScreenCapture::captureLayers(&mCapture, captureArgs);
chaviw3efadb12020-07-27 10:07:15 -0700304 mCapture->expectFGColor(10, 10);
305 mCapture->expectChildColor(0, 0);
306}
307
308TEST_F(ScreenCaptureTest, CaptureLayerChildOnly) {
309 auto fgHandle = mFGSurfaceControl->getHandle();
310
311 sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
312 PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
313 TransactionUtils::fillSurfaceRGBA8(child, 200, 200, 200);
314
315 SurfaceComposerClient::Transaction().show(child).apply(true);
316
317 // Captures mFGSurfaceControl's child
chaviw70cb6a42020-07-30 13:57:36 -0700318 LayerCaptureArgs captureArgs;
319 captureArgs.layerHandle = fgHandle;
320 captureArgs.childrenOnly = true;
321 ScreenCapture::captureLayers(&mCapture, captureArgs);
chaviw3efadb12020-07-27 10:07:15 -0700322 mCapture->checkPixel(10, 10, 0, 0, 0);
323 mCapture->expectChildColor(0, 0);
324}
325
326TEST_F(ScreenCaptureTest, CaptureLayerExclude) {
327 auto fgHandle = mFGSurfaceControl->getHandle();
328
329 sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
330 PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
331 TransactionUtils::fillSurfaceRGBA8(child, 200, 200, 200);
332 sp<SurfaceControl> child2 = createSurface(mClient, "Child surface", 10, 10,
333 PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
334 TransactionUtils::fillSurfaceRGBA8(child2, 200, 0, 200);
335
336 SurfaceComposerClient::Transaction()
337 .show(child)
338 .show(child2)
339 .setLayer(child, 1)
340 .setLayer(child2, 2)
341 .apply(true);
342
343 // Child2 would be visible but its excluded, so we should see child1 color instead.
chaviw70cb6a42020-07-30 13:57:36 -0700344 LayerCaptureArgs captureArgs;
345 captureArgs.layerHandle = fgHandle;
346 captureArgs.childrenOnly = true;
347 captureArgs.excludeHandles = {child2->getHandle()};
348 ScreenCapture::captureLayers(&mCapture, captureArgs);
chaviw3efadb12020-07-27 10:07:15 -0700349 mCapture->checkPixel(10, 10, 0, 0, 0);
350 mCapture->checkPixel(0, 0, 200, 200, 200);
351}
352
Ajinkya Chalke02844632023-03-01 12:10:14 +0000353TEST_F(ScreenCaptureTest, CaptureLayerExcludeThroughDisplayArgs) {
354 mCaptureArgs.excludeHandles = {mFGSurfaceControl->getHandle()};
Melody Hsue69bb172023-10-27 13:51:17 +0000355 ScreenCapture::captureLayers(&mCapture, mCaptureArgs);
Ajinkya Chalke02844632023-03-01 12:10:14 +0000356 mCapture->expectBGColor(0, 0);
357 // Doesn't capture FG layer which is at 64, 64
358 mCapture->expectBGColor(64, 64);
359}
360
chaviw3efadb12020-07-27 10:07:15 -0700361// Like the last test but verifies that children are also exclude.
362TEST_F(ScreenCaptureTest, CaptureLayerExcludeTree) {
363 auto fgHandle = mFGSurfaceControl->getHandle();
364
365 sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
366 PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
367 TransactionUtils::fillSurfaceRGBA8(child, 200, 200, 200);
368 sp<SurfaceControl> child2 = createSurface(mClient, "Child surface", 10, 10,
369 PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
370 TransactionUtils::fillSurfaceRGBA8(child2, 200, 0, 200);
371 sp<SurfaceControl> child3 = createSurface(mClient, "Child surface", 10, 10,
372 PIXEL_FORMAT_RGBA_8888, 0, child2.get());
373 TransactionUtils::fillSurfaceRGBA8(child2, 200, 0, 200);
374
375 SurfaceComposerClient::Transaction()
376 .show(child)
377 .show(child2)
378 .show(child3)
379 .setLayer(child, 1)
380 .setLayer(child2, 2)
381 .apply(true);
382
383 // Child2 would be visible but its excluded, so we should see child1 color instead.
chaviw70cb6a42020-07-30 13:57:36 -0700384 LayerCaptureArgs captureArgs;
385 captureArgs.layerHandle = fgHandle;
386 captureArgs.childrenOnly = true;
387 captureArgs.excludeHandles = {child2->getHandle()};
388 ScreenCapture::captureLayers(&mCapture, captureArgs);
chaviw3efadb12020-07-27 10:07:15 -0700389 mCapture->checkPixel(10, 10, 0, 0, 0);
390 mCapture->checkPixel(0, 0, 200, 200, 200);
391}
392
393TEST_F(ScreenCaptureTest, CaptureTransparent) {
394 sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
395 PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
396
397 TransactionUtils::fillSurfaceRGBA8(child, 200, 200, 200);
398
399 SurfaceComposerClient::Transaction().show(child).apply(true);
400
chaviw3efadb12020-07-27 10:07:15 -0700401 // Captures child
chaviw70cb6a42020-07-30 13:57:36 -0700402 LayerCaptureArgs captureArgs;
403 captureArgs.layerHandle = child->getHandle();
404 captureArgs.sourceCrop = {0, 0, 10, 20};
405 ScreenCapture::captureLayers(&mCapture, captureArgs);
chaviw3efadb12020-07-27 10:07:15 -0700406 mCapture->expectColor(Rect(0, 0, 9, 9), {200, 200, 200, 255});
407 // Area outside of child's bounds is transparent.
408 mCapture->expectColor(Rect(0, 10, 9, 19), {0, 0, 0, 0});
409}
410
411TEST_F(ScreenCaptureTest, DontCaptureRelativeOutsideTree) {
chaviw3efadb12020-07-27 10:07:15 -0700412 sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
413 PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
414 ASSERT_NE(nullptr, child.get()) << "failed to create surface";
415 sp<SurfaceControl> relative = createLayer(String8("Relative surface"), 10, 10, 0);
416 TransactionUtils::fillSurfaceRGBA8(child, 200, 200, 200);
417 TransactionUtils::fillSurfaceRGBA8(relative, 100, 100, 100);
418
419 SurfaceComposerClient::Transaction()
420 .show(child)
421 // Set relative layer above fg layer so should be shown above when computing all layers.
Pablo Gamito11dcc222020-09-12 15:49:39 +0000422 .setRelativeLayer(relative, mFGSurfaceControl, 1)
chaviw3efadb12020-07-27 10:07:15 -0700423 .show(relative)
424 .apply(true);
425
426 // Captures mFGSurfaceControl layer and its child. Relative layer shouldn't be captured.
chaviw70cb6a42020-07-30 13:57:36 -0700427 LayerCaptureArgs captureArgs;
428 captureArgs.layerHandle = mFGSurfaceControl->getHandle();
429 ScreenCapture::captureLayers(&mCapture, captureArgs);
chaviw3efadb12020-07-27 10:07:15 -0700430 mCapture->expectFGColor(10, 10);
431 mCapture->expectChildColor(0, 0);
432}
433
434TEST_F(ScreenCaptureTest, CaptureRelativeInTree) {
chaviw3efadb12020-07-27 10:07:15 -0700435 sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
436 PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
437 sp<SurfaceControl> relative = createSurface(mClient, "Relative surface", 10, 10,
438 PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
439 TransactionUtils::fillSurfaceRGBA8(child, 200, 200, 200);
440 TransactionUtils::fillSurfaceRGBA8(relative, 100, 100, 100);
441
442 SurfaceComposerClient::Transaction()
443 .show(child)
444 // Set relative layer below fg layer but relative to child layer so it should be shown
445 // above child layer.
446 .setLayer(relative, -1)
Pablo Gamito11dcc222020-09-12 15:49:39 +0000447 .setRelativeLayer(relative, child, 1)
chaviw3efadb12020-07-27 10:07:15 -0700448 .show(relative)
449 .apply(true);
450
451 // Captures mFGSurfaceControl layer and its children. Relative layer is a child of fg so its
452 // relative value should be taken into account, placing it above child layer.
chaviw70cb6a42020-07-30 13:57:36 -0700453 LayerCaptureArgs captureArgs;
454 captureArgs.layerHandle = mFGSurfaceControl->getHandle();
455 ScreenCapture::captureLayers(&mCapture, captureArgs);
chaviw3efadb12020-07-27 10:07:15 -0700456 mCapture->expectFGColor(10, 10);
457 // Relative layer is showing on top of child layer
458 mCapture->expectColor(Rect(0, 0, 9, 9), {100, 100, 100, 255});
459}
460
461TEST_F(ScreenCaptureTest, CaptureBoundlessLayerWithSourceCrop) {
462 sp<SurfaceControl> child = createColorLayer("Child layer", Color::RED, mFGSurfaceControl.get());
463 SurfaceComposerClient::Transaction().show(child).apply(true);
464
chaviw70cb6a42020-07-30 13:57:36 -0700465 LayerCaptureArgs captureArgs;
466 captureArgs.layerHandle = child->getHandle();
467 captureArgs.sourceCrop = {0, 0, 10, 10};
468 ScreenCapture::captureLayers(&mCapture, captureArgs);
chaviw3efadb12020-07-27 10:07:15 -0700469
470 mCapture->expectColor(Rect(0, 0, 9, 9), Color::RED);
471}
472
473TEST_F(ScreenCaptureTest, CaptureBoundedLayerWithoutSourceCrop) {
474 sp<SurfaceControl> child = createColorLayer("Child layer", Color::RED, mFGSurfaceControl.get());
475 Rect layerCrop(0, 0, 10, 10);
chaviw25714502021-02-11 10:01:08 -0800476 SurfaceComposerClient::Transaction().setCrop(child, layerCrop).show(child).apply(true);
chaviw3efadb12020-07-27 10:07:15 -0700477
chaviw70cb6a42020-07-30 13:57:36 -0700478 LayerCaptureArgs captureArgs;
479 captureArgs.layerHandle = child->getHandle();
480 ScreenCapture::captureLayers(&mCapture, captureArgs);
chaviw3efadb12020-07-27 10:07:15 -0700481
482 mCapture->expectColor(Rect(0, 0, 9, 9), Color::RED);
483}
484
485TEST_F(ScreenCaptureTest, CaptureBoundlessLayerWithoutSourceCropFails) {
486 sp<SurfaceControl> child = createColorLayer("Child layer", Color::RED, mFGSurfaceControl.get());
487 SurfaceComposerClient::Transaction().show(child).apply(true);
488
chaviw3efadb12020-07-27 10:07:15 -0700489 LayerCaptureArgs args;
490 args.layerHandle = child->getHandle();
491
492 ScreenCaptureResults captureResults;
chaviw8ffc7b82020-08-18 11:25:37 -0700493 ASSERT_EQ(BAD_VALUE, ScreenCapture::captureLayers(args, captureResults));
chaviw3efadb12020-07-27 10:07:15 -0700494}
495
496TEST_F(ScreenCaptureTest, CaptureBufferLayerWithoutBufferFails) {
497 sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
Robert Carr5b3b9142021-02-22 12:27:32 -0800498 PIXEL_FORMAT_RGBA_8888,
499 ISurfaceComposerClient::eFXSurfaceBufferState,
500 mFGSurfaceControl.get());
501
chaviw3efadb12020-07-27 10:07:15 -0700502 SurfaceComposerClient::Transaction().show(child).apply(true);
chaviw3efadb12020-07-27 10:07:15 -0700503 sp<GraphicBuffer> outBuffer;
504
505 LayerCaptureArgs args;
506 args.layerHandle = child->getHandle();
507 args.childrenOnly = false;
508
509 ScreenCaptureResults captureResults;
chaviw8ffc7b82020-08-18 11:25:37 -0700510 ASSERT_EQ(BAD_VALUE, ScreenCapture::captureLayers(args, captureResults));
chaviw3efadb12020-07-27 10:07:15 -0700511
Patrick Williams83f36b22022-09-14 17:57:35 +0000512 ASSERT_NO_FATAL_FAILURE(fillBufferLayerColor(child, Color::RED, 32, 32));
chaviw3efadb12020-07-27 10:07:15 -0700513 SurfaceComposerClient::Transaction().apply(true);
chaviw8ffc7b82020-08-18 11:25:37 -0700514 ASSERT_EQ(NO_ERROR, ScreenCapture::captureLayers(args, captureResults));
Alec Mouri14d5b862022-04-27 21:20:04 +0000515 ScreenCapture sc(captureResults.buffer, captureResults.capturedHdrLayers);
chaviw3efadb12020-07-27 10:07:15 -0700516 sc.expectColor(Rect(0, 0, 9, 9), Color::RED);
517}
518
519TEST_F(ScreenCaptureTest, CaptureLayerWithGrandchild) {
chaviw3efadb12020-07-27 10:07:15 -0700520 sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
521 PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
522 TransactionUtils::fillSurfaceRGBA8(child, 200, 200, 200);
523
524 sp<SurfaceControl> grandchild = createSurface(mClient, "Grandchild surface", 5, 5,
525 PIXEL_FORMAT_RGBA_8888, 0, child.get());
526
527 TransactionUtils::fillSurfaceRGBA8(grandchild, 50, 50, 50);
528 SurfaceComposerClient::Transaction()
529 .show(child)
530 .setPosition(grandchild, 5, 5)
531 .show(grandchild)
532 .apply(true);
533
534 // Captures mFGSurfaceControl, its child, and the grandchild.
chaviw70cb6a42020-07-30 13:57:36 -0700535 LayerCaptureArgs captureArgs;
536 captureArgs.layerHandle = mFGSurfaceControl->getHandle();
537 ScreenCapture::captureLayers(&mCapture, captureArgs);
chaviw3efadb12020-07-27 10:07:15 -0700538 mCapture->expectFGColor(10, 10);
539 mCapture->expectChildColor(0, 0);
540 mCapture->checkPixel(5, 5, 50, 50, 50);
541}
542
543TEST_F(ScreenCaptureTest, CaptureChildOnly) {
544 sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
545 PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
546 TransactionUtils::fillSurfaceRGBA8(child, 200, 200, 200);
chaviw3efadb12020-07-27 10:07:15 -0700547
548 SurfaceComposerClient::Transaction().setPosition(child, 5, 5).show(child).apply(true);
549
550 // Captures only the child layer, and not the parent.
chaviw70cb6a42020-07-30 13:57:36 -0700551 LayerCaptureArgs captureArgs;
552 captureArgs.layerHandle = child->getHandle();
553 ScreenCapture::captureLayers(&mCapture, captureArgs);
chaviw3efadb12020-07-27 10:07:15 -0700554 mCapture->expectChildColor(0, 0);
555 mCapture->expectChildColor(9, 9);
556}
557
558TEST_F(ScreenCaptureTest, CaptureGrandchildOnly) {
559 sp<SurfaceControl> child = createSurface(mClient, "Child surface", 10, 10,
560 PIXEL_FORMAT_RGBA_8888, 0, mFGSurfaceControl.get());
561 TransactionUtils::fillSurfaceRGBA8(child, 200, 200, 200);
562 auto childHandle = child->getHandle();
563
564 sp<SurfaceControl> grandchild = createSurface(mClient, "Grandchild surface", 5, 5,
565 PIXEL_FORMAT_RGBA_8888, 0, child.get());
566 TransactionUtils::fillSurfaceRGBA8(grandchild, 50, 50, 50);
567
568 SurfaceComposerClient::Transaction()
569 .show(child)
570 .setPosition(grandchild, 5, 5)
571 .show(grandchild)
572 .apply(true);
573
chaviw3efadb12020-07-27 10:07:15 -0700574 // Captures only the grandchild.
chaviw70cb6a42020-07-30 13:57:36 -0700575 LayerCaptureArgs captureArgs;
576 captureArgs.layerHandle = grandchild->getHandle();
577 ScreenCapture::captureLayers(&mCapture, captureArgs);
chaviw3efadb12020-07-27 10:07:15 -0700578 mCapture->checkPixel(0, 0, 50, 50, 50);
579 mCapture->checkPixel(4, 4, 50, 50, 50);
580}
581
582TEST_F(ScreenCaptureTest, CaptureCrop) {
Robert Carr5b3b9142021-02-22 12:27:32 -0800583 sp<SurfaceControl> redLayer = createLayer(String8("Red surface"), 60, 60,
584 ISurfaceComposerClient::eFXSurfaceBufferState);
chaviw3efadb12020-07-27 10:07:15 -0700585 sp<SurfaceControl> blueLayer = createSurface(mClient, "Blue surface", 30, 30,
Robert Carr5b3b9142021-02-22 12:27:32 -0800586 PIXEL_FORMAT_RGBA_8888,
587 ISurfaceComposerClient::eFXSurfaceBufferState,
588 redLayer.get());
chaviw3efadb12020-07-27 10:07:15 -0700589
Patrick Williams83f36b22022-09-14 17:57:35 +0000590 ASSERT_NO_FATAL_FAILURE(fillBufferLayerColor(redLayer, Color::RED, 60, 60));
591 ASSERT_NO_FATAL_FAILURE(fillBufferLayerColor(blueLayer, Color::BLUE, 30, 30));
chaviw3efadb12020-07-27 10:07:15 -0700592
593 SurfaceComposerClient::Transaction()
594 .setLayer(redLayer, INT32_MAX - 1)
595 .show(redLayer)
596 .show(blueLayer)
597 .apply(true);
598
chaviw3efadb12020-07-27 10:07:15 -0700599 // Capturing full screen should have both red and blue are visible.
chaviw70cb6a42020-07-30 13:57:36 -0700600 LayerCaptureArgs captureArgs;
601 captureArgs.layerHandle = redLayer->getHandle();
602 ScreenCapture::captureLayers(&mCapture, captureArgs);
chaviw3efadb12020-07-27 10:07:15 -0700603 mCapture->expectColor(Rect(0, 0, 29, 29), Color::BLUE);
604 // red area below the blue area
605 mCapture->expectColor(Rect(0, 30, 59, 59), Color::RED);
606 // red area to the right of the blue area
607 mCapture->expectColor(Rect(30, 0, 59, 59), Color::RED);
608
chaviw70cb6a42020-07-30 13:57:36 -0700609 captureArgs.sourceCrop = {0, 0, 30, 30};
610 ScreenCapture::captureLayers(&mCapture, captureArgs);
chaviw3efadb12020-07-27 10:07:15 -0700611 // Capturing the cropped screen, cropping out the shown red area, should leave only the blue
612 // area visible.
613 mCapture->expectColor(Rect(0, 0, 29, 29), Color::BLUE);
614 mCapture->checkPixel(30, 30, 0, 0, 0);
615}
616
617TEST_F(ScreenCaptureTest, CaptureSize) {
Robert Carr5b3b9142021-02-22 12:27:32 -0800618 sp<SurfaceControl> redLayer =
619 createLayer(String8("Red surface"), 60, 60, ISurfaceComposerClient::eFXSurfaceBufferState);
chaviw3efadb12020-07-27 10:07:15 -0700620 sp<SurfaceControl> blueLayer = createSurface(mClient, "Blue surface", 30, 30,
Robert Carr5b3b9142021-02-22 12:27:32 -0800621 PIXEL_FORMAT_RGBA_8888,
622 ISurfaceComposerClient::eFXSurfaceBufferState,
623 redLayer.get());
chaviw3efadb12020-07-27 10:07:15 -0700624
Patrick Williams83f36b22022-09-14 17:57:35 +0000625 ASSERT_NO_FATAL_FAILURE(fillBufferLayerColor(redLayer, Color::RED, 60, 60));
626 ASSERT_NO_FATAL_FAILURE(fillBufferLayerColor(blueLayer, Color::BLUE, 30, 30));
chaviw3efadb12020-07-27 10:07:15 -0700627
628 SurfaceComposerClient::Transaction()
629 .setLayer(redLayer, INT32_MAX - 1)
630 .show(redLayer)
631 .show(blueLayer)
632 .apply(true);
633
chaviw3efadb12020-07-27 10:07:15 -0700634 // Capturing full screen should have both red and blue are visible.
chaviw70cb6a42020-07-30 13:57:36 -0700635 LayerCaptureArgs captureArgs;
636 captureArgs.layerHandle = redLayer->getHandle();
637 ScreenCapture::captureLayers(&mCapture, captureArgs);
chaviw3efadb12020-07-27 10:07:15 -0700638 mCapture->expectColor(Rect(0, 0, 29, 29), Color::BLUE);
639 // red area below the blue area
640 mCapture->expectColor(Rect(0, 30, 59, 59), Color::RED);
641 // red area to the right of the blue area
642 mCapture->expectColor(Rect(30, 0, 59, 59), Color::RED);
643
chaviw17ac24b2021-01-28 18:50:05 -0800644 captureArgs.frameScaleX = 0.5f;
645 captureArgs.frameScaleY = 0.5f;
Robert Carr5b3b9142021-02-22 12:27:32 -0800646 sleep(1);
chaviw17ac24b2021-01-28 18:50:05 -0800647
chaviw70cb6a42020-07-30 13:57:36 -0700648 ScreenCapture::captureLayers(&mCapture, captureArgs);
chaviw3efadb12020-07-27 10:07:15 -0700649 // Capturing the downsized area (30x30) should leave both red and blue but in a smaller area.
650 mCapture->expectColor(Rect(0, 0, 14, 14), Color::BLUE);
651 // red area below the blue area
652 mCapture->expectColor(Rect(0, 15, 29, 29), Color::RED);
653 // red area to the right of the blue area
654 mCapture->expectColor(Rect(15, 0, 29, 29), Color::RED);
655 mCapture->checkPixel(30, 30, 0, 0, 0);
656}
657
658TEST_F(ScreenCaptureTest, CaptureInvalidLayer) {
chaviw3efadb12020-07-27 10:07:15 -0700659 LayerCaptureArgs args;
Ady Abrahamd11bade2022-08-01 16:18:03 -0700660 args.layerHandle = sp<BBinder>::make();
chaviw3efadb12020-07-27 10:07:15 -0700661
662 ScreenCaptureResults captureResults;
chaviw3efadb12020-07-27 10:07:15 -0700663 // Layer was deleted so captureLayers should fail with NAME_NOT_FOUND
chaviw8ffc7b82020-08-18 11:25:37 -0700664 ASSERT_EQ(NAME_NOT_FOUND, ScreenCapture::captureLayers(args, captureResults));
chaviw3efadb12020-07-27 10:07:15 -0700665}
666
Garfield Tan9c9c1912021-07-19 12:02:16 -0700667TEST_F(ScreenCaptureTest, CaptureTooLargeLayer) {
668 sp<SurfaceControl> redLayer = createLayer(String8("Red surface"), 60, 60);
669 ASSERT_NO_FATAL_FAILURE(fillBufferQueueLayerColor(redLayer, Color::RED, 60, 60));
670
671 Transaction().show(redLayer).setLayer(redLayer, INT32_MAX).apply(true);
672
673 LayerCaptureArgs captureArgs;
674 captureArgs.layerHandle = redLayer->getHandle();
675 captureArgs.frameScaleX = INT32_MAX / 60;
676 captureArgs.frameScaleY = INT32_MAX / 60;
677
678 ScreenCaptureResults captureResults;
679 ASSERT_EQ(BAD_VALUE, ScreenCapture::captureLayers(captureArgs, captureResults));
680}
681
chaviwf5bb97b2021-04-28 15:35:37 -0500682TEST_F(ScreenCaptureTest, CaptureSecureLayer) {
Robert Carr5b3b9142021-02-22 12:27:32 -0800683 sp<SurfaceControl> redLayer = createLayer(String8("Red surface"), 60, 60,
684 ISurfaceComposerClient::eFXSurfaceBufferState);
chaviw70cb6a42020-07-30 13:57:36 -0700685 sp<SurfaceControl> secureLayer =
686 createLayer(String8("Secure surface"), 30, 30,
687 ISurfaceComposerClient::eSecure |
Robert Carr5b3b9142021-02-22 12:27:32 -0800688 ISurfaceComposerClient::eFXSurfaceBufferState,
chaviw70cb6a42020-07-30 13:57:36 -0700689 redLayer.get());
Patrick Williams83f36b22022-09-14 17:57:35 +0000690 ASSERT_NO_FATAL_FAILURE(fillBufferLayerColor(redLayer, Color::RED, 60, 60));
691 ASSERT_NO_FATAL_FAILURE(fillBufferLayerColor(secureLayer, Color::BLUE, 30, 30));
chaviw70cb6a42020-07-30 13:57:36 -0700692
693 auto redLayerHandle = redLayer->getHandle();
694 Transaction()
695 .show(redLayer)
696 .show(secureLayer)
Dominik Laskowski29fa1462021-04-27 15:51:50 -0700697 .setLayerStack(redLayer, ui::DEFAULT_LAYER_STACK)
chaviw70cb6a42020-07-30 13:57:36 -0700698 .setLayer(redLayer, INT32_MAX)
699 .apply();
700
chaviw70cb6a42020-07-30 13:57:36 -0700701 LayerCaptureArgs args;
702 args.layerHandle = redLayerHandle;
703 args.childrenOnly = false;
704 ScreenCaptureResults captureResults;
705
chaviwf5bb97b2021-04-28 15:35:37 -0500706 {
707 // Ensure the UID is not root because root has all permissions
708 UIDFaker f(AID_APP_START);
709 // Call from outside system with secure layers will result in permission denied
710 ASSERT_EQ(PERMISSION_DENIED, ScreenCapture::captureLayers(args, captureResults));
711 }
chaviw70cb6a42020-07-30 13:57:36 -0700712
713 UIDFaker f(AID_SYSTEM);
714
715 // From system request, only red layer will be screenshot since the blue layer is secure.
716 // Black will be present where the secure layer is.
717 ScreenCapture::captureLayers(&mCapture, args);
718 mCapture->expectColor(Rect(0, 0, 30, 30), Color::BLACK);
719 mCapture->expectColor(Rect(30, 30, 60, 60), Color::RED);
720
721 // Passing flag secure so the blue layer should be screenshot too.
722 args.captureSecureLayers = true;
723 ScreenCapture::captureLayers(&mCapture, args);
724 mCapture->expectColor(Rect(0, 0, 30, 30), Color::BLUE);
725 mCapture->expectColor(Rect(30, 30, 60, 60), Color::RED);
726}
727
Melody Hsue69bb172023-10-27 13:51:17 +0000728TEST_F(ScreenCaptureTest, ScreenshotProtectedBuffer) {
729 const uint32_t bufferWidth = 60;
730 const uint32_t bufferHeight = 60;
chaviw4b9d5e12020-08-04 18:30:35 -0700731
Melody Hsue69bb172023-10-27 13:51:17 +0000732 sp<SurfaceControl> layer =
733 createLayer(String8("Colored surface"), bufferWidth, bufferHeight,
734 ISurfaceComposerClient::eFXSurfaceBufferState, mRootSurfaceControl.get());
chaviw4b9d5e12020-08-04 18:30:35 -0700735
Melody Hsue69bb172023-10-27 13:51:17 +0000736 Transaction().show(layer).setLayer(layer, INT32_MAX).apply(true);
chaviw4b9d5e12020-08-04 18:30:35 -0700737
Melody Hsue69bb172023-10-27 13:51:17 +0000738 sp<Surface> surface = layer->getSurface();
739 ASSERT_TRUE(surface != nullptr);
740 sp<ANativeWindow> anw(surface);
chaviw4b9d5e12020-08-04 18:30:35 -0700741
Melody Hsue69bb172023-10-27 13:51:17 +0000742 ASSERT_EQ(NO_ERROR, native_window_api_connect(anw.get(), NATIVE_WINDOW_API_CPU));
743 ASSERT_EQ(NO_ERROR, native_window_set_usage(anw.get(), GRALLOC_USAGE_PROTECTED));
chaviw4b9d5e12020-08-04 18:30:35 -0700744
Melody Hsue69bb172023-10-27 13:51:17 +0000745 int fenceFd;
746 ANativeWindowBuffer* buf = nullptr;
chaviw4b9d5e12020-08-04 18:30:35 -0700747
Melody Hsue69bb172023-10-27 13:51:17 +0000748 // End test if device does not support USAGE_PROTECTED
749 // b/309965549 This check does not exit the test when running on AVDs
750 status_t err = anw->dequeueBuffer(anw.get(), &buf, &fenceFd);
751 if (err) {
752 return;
753 }
754 anw->queueBuffer(anw.get(), buf, fenceFd);
chaviw4b9d5e12020-08-04 18:30:35 -0700755
Melody Hsue69bb172023-10-27 13:51:17 +0000756 // USAGE_PROTECTED buffer is read as a black screen
757 ScreenCaptureResults captureResults;
758 ASSERT_EQ(NO_ERROR, ScreenCapture::captureLayers(mCaptureArgs, captureResults));
chaviw4b9d5e12020-08-04 18:30:35 -0700759
Melody Hsue69bb172023-10-27 13:51:17 +0000760 ScreenCapture sc(captureResults.buffer, captureResults.capturedHdrLayers);
761 sc.expectColor(Rect(0, 0, bufferWidth, bufferHeight), Color::BLACK);
762
763 // Reading color data will expectedly result in crash, only check usage bit
764 // b/309965549 Checking that the usage bit is protected does not work for
765 // devices that do not support usage protected.
766 mCaptureArgs.allowProtected = true;
767 ASSERT_EQ(NO_ERROR, ScreenCapture::captureLayers(mCaptureArgs, captureResults));
768 // ASSERT_EQ(GRALLOC_USAGE_PROTECTED, GRALLOC_USAGE_PROTECTED &
769 // captureResults.buffer->getUsage());
chaviw4b9d5e12020-08-04 18:30:35 -0700770}
771
Melody Hsue69bb172023-10-27 13:51:17 +0000772TEST_F(ScreenCaptureTest, CaptureLayer) {
chaviwc5676c62020-09-18 15:01:04 -0700773 sp<SurfaceControl> layer;
Melody Hsue69bb172023-10-27 13:51:17 +0000774 ASSERT_NO_FATAL_FAILURE(layer = createLayer("test layer", 0, 0,
775 ISurfaceComposerClient::eFXSurfaceEffect,
776 mRootSurfaceControl.get()));
chaviwc5676c62020-09-18 15:01:04 -0700777
778 const Color layerColor = Color::RED;
779 const Rect bounds = Rect(10, 10, 40, 40);
780
781 Transaction()
782 .show(layer)
783 .hide(mFGSurfaceControl)
chaviwc5676c62020-09-18 15:01:04 -0700784 .setLayer(layer, INT32_MAX)
785 .setColor(layer, {layerColor.r / 255, layerColor.g / 255, layerColor.b / 255})
chaviw25714502021-02-11 10:01:08 -0800786 .setCrop(layer, bounds)
chaviwc5676c62020-09-18 15:01:04 -0700787 .apply();
788
chaviwc5676c62020-09-18 15:01:04 -0700789 {
Melody Hsue69bb172023-10-27 13:51:17 +0000790 ScreenCapture::captureLayers(&mCapture, mCaptureArgs);
chaviwc5676c62020-09-18 15:01:04 -0700791 mCapture->expectColor(bounds, layerColor);
792 mCapture->expectBorder(bounds, {63, 63, 195, 255});
793 }
794
795 Transaction()
796 .setFlags(layer, layer_state_t::eLayerSkipScreenshot,
797 layer_state_t::eLayerSkipScreenshot)
798 .apply();
799
800 {
801 // Can't screenshot test layer since it now has flag
802 // eLayerSkipScreenshot
Melody Hsue69bb172023-10-27 13:51:17 +0000803 ScreenCapture::captureLayers(&mCapture, mCaptureArgs);
chaviwc5676c62020-09-18 15:01:04 -0700804 mCapture->expectColor(bounds, {63, 63, 195, 255});
805 mCapture->expectBorder(bounds, {63, 63, 195, 255});
806 }
807}
808
Melody Hsue69bb172023-10-27 13:51:17 +0000809TEST_F(ScreenCaptureTest, CaptureLayerChild) {
chaviwc5676c62020-09-18 15:01:04 -0700810 sp<SurfaceControl> layer;
811 sp<SurfaceControl> childLayer;
Melody Hsue69bb172023-10-27 13:51:17 +0000812 ASSERT_NO_FATAL_FAILURE(layer = createLayer("test layer", 0, 0,
813 ISurfaceComposerClient::eFXSurfaceEffect,
814 mRootSurfaceControl.get()));
chaviwc5676c62020-09-18 15:01:04 -0700815 ASSERT_NO_FATAL_FAILURE(childLayer = createLayer("test layer", 0, 0,
816 ISurfaceComposerClient::eFXSurfaceEffect,
817 layer.get()));
818
819 const Color layerColor = Color::RED;
820 const Color childColor = Color::BLUE;
821 const Rect bounds = Rect(10, 10, 40, 40);
822 const Rect childBounds = Rect(20, 20, 30, 30);
823
824 Transaction()
825 .show(layer)
826 .show(childLayer)
827 .hide(mFGSurfaceControl)
chaviwc5676c62020-09-18 15:01:04 -0700828 .setLayer(layer, INT32_MAX)
829 .setColor(layer, {layerColor.r / 255, layerColor.g / 255, layerColor.b / 255})
830 .setColor(childLayer, {childColor.r / 255, childColor.g / 255, childColor.b / 255})
chaviw25714502021-02-11 10:01:08 -0800831 .setCrop(layer, bounds)
832 .setCrop(childLayer, childBounds)
chaviwc5676c62020-09-18 15:01:04 -0700833 .apply();
834
chaviwc5676c62020-09-18 15:01:04 -0700835 {
Melody Hsue69bb172023-10-27 13:51:17 +0000836 ScreenCapture::captureLayers(&mCapture, mCaptureArgs);
chaviwc5676c62020-09-18 15:01:04 -0700837 mCapture->expectColor(childBounds, childColor);
838 mCapture->expectBorder(childBounds, layerColor);
839 mCapture->expectBorder(bounds, {63, 63, 195, 255});
840 }
841
842 Transaction()
843 .setFlags(layer, layer_state_t::eLayerSkipScreenshot,
844 layer_state_t::eLayerSkipScreenshot)
845 .apply();
846
847 {
848 // Can't screenshot child layer since the parent has the flag
849 // eLayerSkipScreenshot
Melody Hsue69bb172023-10-27 13:51:17 +0000850 ScreenCapture::captureLayers(&mCapture, mCaptureArgs);
chaviwc5676c62020-09-18 15:01:04 -0700851 mCapture->expectColor(childBounds, {63, 63, 195, 255});
852 mCapture->expectBorder(childBounds, {63, 63, 195, 255});
853 mCapture->expectBorder(bounds, {63, 63, 195, 255});
854 }
855}
856
chaviw4b9d5e12020-08-04 18:30:35 -0700857TEST_F(ScreenCaptureTest, CaptureLayerWithUid) {
858 uid_t fakeUid = 12345;
859
860 sp<SurfaceControl> layer;
861 ASSERT_NO_FATAL_FAILURE(layer = createLayer("test layer", 32, 32,
862 ISurfaceComposerClient::eFXSurfaceBufferQueue,
863 mBGSurfaceControl.get()));
864 ASSERT_NO_FATAL_FAILURE(fillBufferQueueLayerColor(layer, Color::RED, 32, 32));
865
866 Transaction().show(layer).setLayer(layer, INT32_MAX).apply();
867
868 LayerCaptureArgs captureArgs;
869 captureArgs.layerHandle = mBGSurfaceControl->getHandle();
870 captureArgs.childrenOnly = false;
871
872 // Make sure red layer with the background layer is screenshot.
873 ScreenCapture::captureLayers(&mCapture, captureArgs);
874 mCapture->expectColor(Rect(0, 0, 32, 32), Color::RED);
875 mCapture->expectBorder(Rect(0, 0, 32, 32), {63, 63, 195, 255});
876
877 // From non system uid, can't request screenshot without a specified uid.
878 std::unique_ptr<UIDFaker> uidFaker = std::make_unique<UIDFaker>(fakeUid);
879
chaviw8ffc7b82020-08-18 11:25:37 -0700880 ASSERT_EQ(PERMISSION_DENIED, ScreenCapture::captureLayers(captureArgs, mCaptureResults));
chaviw4b9d5e12020-08-04 18:30:35 -0700881
882 // Make screenshot request with current uid set. No layers were created with the current
883 // uid so screenshot will be black.
884 captureArgs.uid = fakeUid;
885 ScreenCapture::captureLayers(&mCapture, captureArgs);
886 mCapture->expectColor(Rect(0, 0, 32, 32), Color::TRANSPARENT);
887 mCapture->expectBorder(Rect(0, 0, 32, 32), Color::TRANSPARENT);
888
889 sp<SurfaceControl> layerWithFakeUid;
890 // Create a new layer with the current uid
891 ASSERT_NO_FATAL_FAILURE(layerWithFakeUid =
892 createLayer("new test layer", 32, 32,
893 ISurfaceComposerClient::eFXSurfaceBufferQueue,
894 mBGSurfaceControl.get()));
895 ASSERT_NO_FATAL_FAILURE(fillBufferQueueLayerColor(layerWithFakeUid, Color::GREEN, 32, 32));
896 Transaction()
897 .show(layerWithFakeUid)
898 .setLayer(layerWithFakeUid, INT32_MAX)
899 .setPosition(layerWithFakeUid, 128, 128)
900 // reparent a layer that was created with a different uid to the new layer.
Pablo Gamito11dcc222020-09-12 15:49:39 +0000901 .reparent(layer, layerWithFakeUid)
chaviw4b9d5e12020-08-04 18:30:35 -0700902 .apply();
903
904 // Screenshot from the fakeUid caller with the uid requested allows the layer
905 // with that uid to be screenshotted. The child layer is skipped since it was created
906 // from a different uid.
907 ScreenCapture::captureLayers(&mCapture, captureArgs);
908 mCapture->expectColor(Rect(128, 128, 160, 160), Color::GREEN);
909 mCapture->expectBorder(Rect(128, 128, 160, 160), Color::TRANSPARENT);
910
911 // Clear fake calling uid so it's back to system.
912 uidFaker = nullptr;
913 // Screenshot from the test caller with the uid requested allows the layer
914 // with that uid to be screenshotted. The child layer is skipped since it was created
915 // from a different uid.
916 ScreenCapture::captureLayers(&mCapture, captureArgs);
917 mCapture->expectColor(Rect(128, 128, 160, 160), Color::GREEN);
918 mCapture->expectBorder(Rect(128, 128, 160, 160), Color::TRANSPARENT);
919
920 // Screenshot from the fakeUid caller with no uid requested allows everything to be screenshot.
921 captureArgs.uid = -1;
922 ScreenCapture::captureLayers(&mCapture, captureArgs);
923 mCapture->expectColor(Rect(128, 128, 160, 160), Color::RED);
924 mCapture->expectBorder(Rect(128, 128, 160, 160), {63, 63, 195, 255});
925}
926
chaviw17ac24b2021-01-28 18:50:05 -0800927TEST_F(ScreenCaptureTest, CaptureWithGrayscale) {
928 sp<SurfaceControl> layer;
929 ASSERT_NO_FATAL_FAILURE(layer = createLayer("test layer", 32, 32,
930 ISurfaceComposerClient::eFXSurfaceBufferState,
931 mBGSurfaceControl.get()));
Patrick Williams83f36b22022-09-14 17:57:35 +0000932 ASSERT_NO_FATAL_FAILURE(fillBufferLayerColor(layer, Color::RED, 32, 32));
chaviw17ac24b2021-01-28 18:50:05 -0800933 Transaction().show(layer).setLayer(layer, INT32_MAX).apply();
934
935 LayerCaptureArgs captureArgs;
936 captureArgs.layerHandle = layer->getHandle();
937
938 ScreenCapture::captureLayers(&mCapture, captureArgs);
939 mCapture->expectColor(Rect(0, 0, 32, 32), Color::RED);
940
941 captureArgs.grayscale = true;
942
943 const uint8_t tolerance = 1;
944
945 // Values based on SurfaceFlinger::calculateColorMatrix
946 float3 luminance{0.213f, 0.715f, 0.072f};
947
948 ScreenCapture::captureLayers(&mCapture, captureArgs);
949
950 uint8_t expectedColor = luminance.r * 255;
951 mCapture->expectColor(Rect(0, 0, 32, 32),
952 Color{expectedColor, expectedColor, expectedColor, 255}, tolerance);
953
Patrick Williams83f36b22022-09-14 17:57:35 +0000954 ASSERT_NO_FATAL_FAILURE(fillBufferLayerColor(layer, Color::BLUE, 32, 32));
chaviw17ac24b2021-01-28 18:50:05 -0800955 ScreenCapture::captureLayers(&mCapture, captureArgs);
956
957 expectedColor = luminance.b * 255;
958 mCapture->expectColor(Rect(0, 0, 32, 32),
959 Color{expectedColor, expectedColor, expectedColor, 255}, tolerance);
960}
961
chaviw79468ab2021-10-27 11:11:24 -0500962TEST_F(ScreenCaptureTest, CaptureOffscreen) {
963 sp<SurfaceControl> layer;
964 ASSERT_NO_FATAL_FAILURE(layer = createLayer("test layer", 32, 32,
965 ISurfaceComposerClient::eFXSurfaceBufferState,
966 mBGSurfaceControl.get()));
Patrick Williams83f36b22022-09-14 17:57:35 +0000967 ASSERT_NO_FATAL_FAILURE(fillBufferLayerColor(layer, Color::RED, 32, 32));
chaviw79468ab2021-10-27 11:11:24 -0500968
969 Transaction().show(layer).hide(mFGSurfaceControl).reparent(layer, nullptr).apply();
970
chaviw79468ab2021-10-27 11:11:24 -0500971 {
972 // Validate that the red layer is not on screen
Melody Hsue69bb172023-10-27 13:51:17 +0000973 ScreenCapture::captureLayers(&mCapture, mCaptureArgs);
974 mCapture->expectColor(Rect(0, 0, mDisplayWidth, mDisplayHeight), {63, 63, 195, 255});
chaviw79468ab2021-10-27 11:11:24 -0500975 }
976
977 LayerCaptureArgs captureArgs;
978 captureArgs.layerHandle = layer->getHandle();
979
980 ScreenCapture::captureLayers(&mCapture, captureArgs);
981 mCapture->expectSize(32, 32);
982 mCapture->expectColor(Rect(0, 0, 32, 32), Color::RED);
983}
984
Alec Mouri14d5b862022-04-27 21:20:04 +0000985TEST_F(ScreenCaptureTest, CaptureNonHdrLayer) {
986 sp<SurfaceControl> layer;
987 ASSERT_NO_FATAL_FAILURE(layer = createLayer("test layer", 32, 32,
988 ISurfaceComposerClient::eFXSurfaceBufferState,
989 mBGSurfaceControl.get()));
Patrick Williams83f36b22022-09-14 17:57:35 +0000990 ASSERT_NO_FATAL_FAILURE(fillBufferLayerColor(layer, Color::BLACK, 32, 32));
Alec Mouri14d5b862022-04-27 21:20:04 +0000991 Transaction()
992 .show(layer)
993 .setLayer(layer, INT32_MAX)
994 .setDataspace(layer, ui::Dataspace::V0_SRGB)
995 .apply();
996
997 LayerCaptureArgs captureArgs;
998 captureArgs.layerHandle = layer->getHandle();
999
1000 ScreenCapture::captureLayers(&mCapture, captureArgs);
1001 mCapture->expectColor(Rect(0, 0, 32, 32), Color::BLACK);
1002 ASSERT_FALSE(mCapture->capturedHdrLayers());
1003}
1004
1005TEST_F(ScreenCaptureTest, CaptureHdrLayer) {
1006 sp<SurfaceControl> layer;
1007 ASSERT_NO_FATAL_FAILURE(layer = createLayer("test layer", 32, 32,
1008 ISurfaceComposerClient::eFXSurfaceBufferState,
1009 mBGSurfaceControl.get()));
Patrick Williams83f36b22022-09-14 17:57:35 +00001010 ASSERT_NO_FATAL_FAILURE(fillBufferLayerColor(layer, Color::BLACK, 32, 32));
Alec Mouri14d5b862022-04-27 21:20:04 +00001011 Transaction()
1012 .show(layer)
1013 .setLayer(layer, INT32_MAX)
1014 .setDataspace(layer, ui::Dataspace::BT2020_ITU_PQ)
1015 .apply();
1016
1017 LayerCaptureArgs captureArgs;
1018 captureArgs.layerHandle = layer->getHandle();
1019
1020 ScreenCapture::captureLayers(&mCapture, captureArgs);
1021 mCapture->expectColor(Rect(0, 0, 32, 32), Color::BLACK);
1022 ASSERT_TRUE(mCapture->capturedHdrLayers());
1023}
1024
chaviw3efadb12020-07-27 10:07:15 -07001025// In the following tests we verify successful skipping of a parent layer,
1026// so we use the same verification logic and only change how we mutate
1027// the parent layer to verify that various properties are ignored.
1028class ScreenCaptureChildOnlyTest : public ScreenCaptureTest {
1029public:
1030 void SetUp() override {
1031 ScreenCaptureTest::SetUp();
1032
1033 mChild = createSurface(mClient, "Child surface", 10, 10, PIXEL_FORMAT_RGBA_8888, 0,
1034 mFGSurfaceControl.get());
1035 TransactionUtils::fillSurfaceRGBA8(mChild, 200, 200, 200);
1036
1037 SurfaceComposerClient::Transaction().show(mChild).apply(true);
1038 }
1039
1040 void verify(std::function<void()> verifyStartingState) {
1041 // Verify starting state before a screenshot is taken.
1042 verifyStartingState();
1043
1044 // Verify child layer does not inherit any of the properties of its
1045 // parent when its screenshot is captured.
chaviw70cb6a42020-07-30 13:57:36 -07001046 LayerCaptureArgs captureArgs;
1047 captureArgs.layerHandle = mFGSurfaceControl->getHandle();
1048 captureArgs.childrenOnly = true;
1049 ScreenCapture::captureLayers(&mCapture, captureArgs);
chaviw3efadb12020-07-27 10:07:15 -07001050 mCapture->checkPixel(10, 10, 0, 0, 0);
1051 mCapture->expectChildColor(0, 0);
1052
1053 // Verify all assumptions are still true after the screenshot is taken.
1054 verifyStartingState();
1055 }
1056
1057 std::unique_ptr<ScreenCapture> mCapture;
1058 sp<SurfaceControl> mChild;
1059};
1060
1061// Regression test b/76099859
1062TEST_F(ScreenCaptureChildOnlyTest, CaptureLayerIgnoresParentVisibility) {
1063 SurfaceComposerClient::Transaction().hide(mFGSurfaceControl).apply(true);
1064
1065 // Even though the parent is hidden we should still capture the child.
1066
1067 // Before and after reparenting, verify child is properly hidden
1068 // when rendering full-screen.
1069 verify([&] { screenshot()->expectBGColor(64, 64); });
1070}
1071
1072TEST_F(ScreenCaptureChildOnlyTest, CaptureLayerIgnoresParentCrop) {
chaviw25714502021-02-11 10:01:08 -08001073 SurfaceComposerClient::Transaction().setCrop(mFGSurfaceControl, Rect(0, 0, 1, 1)).apply(true);
chaviw3efadb12020-07-27 10:07:15 -07001074
1075 // Even though the parent is cropped out we should still capture the child.
1076
1077 // Before and after reparenting, verify child is cropped by parent.
1078 verify([&] { screenshot()->expectBGColor(65, 65); });
1079}
1080
1081// Regression test b/124372894
1082TEST_F(ScreenCaptureChildOnlyTest, CaptureLayerIgnoresTransform) {
1083 SurfaceComposerClient::Transaction().setMatrix(mFGSurfaceControl, 2, 0, 0, 2).apply(true);
1084
1085 // We should not inherit the parent scaling.
1086
1087 // Before and after reparenting, verify child is properly scaled.
1088 verify([&] { screenshot()->expectChildColor(80, 80); });
1089}
1090
Garfield Tande619fa2020-10-02 17:13:53 -07001091} // namespace android
Marin Shalamanovbed7fd32020-12-21 20:02:20 +01001092
1093// TODO(b/129481165): remove the #pragma below and fix conversion issues
Robert Carr5b3b9142021-02-22 12:27:32 -08001094#pragma clang diagnostic pop // ignored "-Wconversion"