blob: c79b7f5a08483c172da52e19cbf4362695552bd0 [file] [log] [blame]
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -08001/*
2 * Copyright (C) 2007 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
Ady Abrahamb0dbdaa2020-01-06 16:19:42 -080017// TODO(b/129481165): remove the #pragma below and fix conversion issues
18#pragma clang diagnostic push
19#pragma clang diagnostic ignored "-Wconversion"
20
Dan Stoza9e56aa02015-11-02 13:00:03 -080021//#define LOG_NDEBUG 0
22#undef LOG_TAG
23#define LOG_TAG "Layer"
Jamie Gennis1c8e95c2012-02-23 19:27:23 -080024#define ATRACE_TAG ATRACE_TAG_GRAPHICS
25
Alec Mourie60041e2019-06-14 18:59:51 -070026#include "Layer.h"
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080027
[1;3C2b9fc252021-02-04 16:16:50 -080028#include <android-base/properties.h>
Yiwei Zhang5434a782018-12-05 18:06:32 -080029#include <android-base/stringprintf.h>
Steven Thomas62a4cf82020-01-31 12:04:03 -080030#include <android/native_window.h>
Vishnu Nair0f085c62019-08-30 08:49:12 -070031#include <binder/IPCThreadState.h>
Patrick Williamsbb25f802022-08-30 23:02:34 +000032#include <compositionengine/CompositionEngine.h>
Lloyd Pique37c2c9b2018-12-04 17:25:10 -080033#include <compositionengine/Display.h>
Lloyd Piquea83776c2019-01-29 18:42:32 -080034#include <compositionengine/LayerFECompositionState.h>
Lloyd Pique37c2c9b2018-12-04 17:25:10 -080035#include <compositionengine/OutputLayer.h>
36#include <compositionengine/impl/OutputLayerCompositionState.h>
Mathias Agopiana67932f2011-04-20 14:20:59 -070037#include <cutils/compiler.h>
Mathias Agopian076b1cc2009-04-10 14:24:30 -070038#include <cutils/native_handle.h>
Mathias Agopiana67932f2011-04-20 14:20:59 -070039#include <cutils/properties.h>
Dominik Laskowskif5d0ea52021-09-26 17:27:01 -070040#include <ftl/enum.h>
Dominik Laskowski298b08e2022-02-15 13:45:02 -080041#include <ftl/fake_guard.h>
Lloyd Pique37c2c9b2018-12-04 17:25:10 -080042#include <gui/BufferItem.h>
43#include <gui/LayerDebugInfo.h>
44#include <gui/Surface.h>
Patrick Williamsbb25f802022-08-30 23:02:34 +000045#include <gui/TraceUtils.h>
Alec Mourie60041e2019-06-14 18:59:51 -070046#include <math.h>
chaviw250bcbb2020-08-05 11:17:54 -070047#include <private/android_filesystem_config.h>
Lloyd Pique37c2c9b2018-12-04 17:25:10 -080048#include <renderengine/RenderEngine.h>
Alec Mourie60041e2019-06-14 18:59:51 -070049#include <stdint.h>
50#include <stdlib.h>
51#include <sys/types.h>
Alec Mouridda07d92022-04-25 22:39:25 +000052#include <system/graphics-base-v1.0.h>
Alec Mouricdf6cbc2021-11-01 17:21:15 -070053#include <ui/DataspaceUtils.h>
Lloyd Pique37c2c9b2018-12-04 17:25:10 -080054#include <ui/DebugUtils.h>
55#include <ui/GraphicBuffer.h>
56#include <ui/PixelFormat.h>
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080057#include <utils/Errors.h>
58#include <utils/Log.h>
Jesse Hall399184a2014-03-03 15:42:54 -080059#include <utils/NativeHandle.h>
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080060#include <utils/StopWatch.h>
Jamie Gennis1c8e95c2012-02-23 19:27:23 -080061#include <utils/Trace.h>
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080062
Alec Mourie60041e2019-06-14 18:59:51 -070063#include <algorithm>
64#include <mutex>
65#include <sstream>
66
Mathias Agopian0f2f5ff2012-07-31 23:09:07 -070067#include "DisplayDevice.h"
Lloyd Pique37c2c9b2018-12-04 17:25:10 -080068#include "DisplayHardware/HWComposer.h"
Ady Abraham22c7b5c2020-09-22 19:33:40 -070069#include "FrameTimeline.h"
Mikael Pessa90092f42019-08-26 17:22:04 -070070#include "FrameTracer/FrameTracer.h"
Vishnu Naircb8be502022-10-12 19:03:23 +000071#include "FrontEnd/LayerCreationArgs.h"
Lloyd Pique37c2c9b2018-12-04 17:25:10 -080072#include "LayerProtoHelper.h"
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080073#include "SurfaceFlinger.h"
Yiwei Zhang7e666a52018-11-15 13:33:42 -080074#include "TimeStats/TimeStats.h"
Robert Carr3e2a2992021-06-11 13:42:55 -070075#include "TunnelModeEnabledReporter.h"
Mathias Agopian1b031492012-06-20 17:51:20 -070076
David Sodman41fdfc92017-11-06 16:09:56 -080077#define DEBUG_RESIZE 0
Patrick Williamsbb25f802022-08-30 23:02:34 +000078#define EARLY_RELEASE_ENABLED false
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080079
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080080namespace android {
Marin Shalamanov1876e2e2020-12-04 13:23:59 +010081namespace {
82constexpr int kDumpTableRowLength = 159;
Patrick Williamsbb25f802022-08-30 23:02:34 +000083
Prabir Pradhanda0f62c2022-07-22 19:53:04 +000084const ui::Transform kIdentityTransform;
Patrick Williamsbb25f802022-08-30 23:02:34 +000085
Patrick Williamsbb25f802022-08-30 23:02:34 +000086bool assignTransform(ui::Transform* dst, ui::Transform& from) {
87 if (*dst == from) {
88 return false;
89 }
90 *dst = from;
91 return true;
92}
93
94TimeStats::SetFrameRateVote frameRateToSetFrameRateVotePayload(Layer::FrameRate frameRate) {
95 using FrameRateCompatibility = TimeStats::SetFrameRateVote::FrameRateCompatibility;
96 using Seamlessness = TimeStats::SetFrameRateVote::Seamlessness;
97 const auto frameRateCompatibility = [frameRate] {
98 switch (frameRate.type) {
99 case Layer::FrameRateCompatibility::Default:
100 return FrameRateCompatibility::Default;
101 case Layer::FrameRateCompatibility::ExactOrMultiple:
102 return FrameRateCompatibility::ExactOrMultiple;
103 default:
104 return FrameRateCompatibility::Undefined;
105 }
106 }();
107
108 const auto seamlessness = [frameRate] {
109 switch (frameRate.seamlessness) {
110 case scheduler::Seamlessness::OnlySeamless:
111 return Seamlessness::ShouldBeSeamless;
112 case scheduler::Seamlessness::SeamedAndSeamless:
113 return Seamlessness::NotRequired;
114 default:
115 return Seamlessness::Undefined;
116 }
117 }();
118
119 return TimeStats::SetFrameRateVote{.frameRate = frameRate.rate.getValue(),
120 .frameRateCompatibility = frameRateCompatibility,
121 .seamlessness = seamlessness};
122}
123
Marin Shalamanov1876e2e2020-12-04 13:23:59 +0100124} // namespace
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800125
Dominik Laskowski2f01d772022-03-23 16:01:29 -0700126using namespace ftl::flag_operators;
127
Yiwei Zhang5434a782018-12-05 18:06:32 -0800128using base::StringAppendF;
Huihong Luod3d8f8e2022-03-08 14:48:46 -0800129using gui::GameMode;
130using gui::LayerMetadata;
chaviw3277faf2021-05-19 16:45:23 -0500131using gui::WindowInfo;
Yiwei Zhang5434a782018-12-05 18:06:32 -0800132
Dominik Laskowski2f01d772022-03-23 16:01:29 -0700133using PresentState = frametimeline::SurfaceFrame::PresentState;
134
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700135Layer::Layer(const LayerCreationArgs& args)
Vishnu Naircb8be502022-10-12 19:03:23 +0000136 : sequence(args.sequence),
Ady Abrahamd11bade2022-08-01 16:18:03 -0700137 mFlinger(sp<SurfaceFlinger>::fromExisting(args.flinger)),
Arthur Hung23e07502021-10-15 11:58:19 +0000138 mName(base::StringPrintf("%s#%d", args.name.c_str(), sequence)),
Ady Abraham8f1ee7f2019-04-05 10:32:50 -0700139 mClientRef(args.client),
Huihong Luod3d8f8e2022-03-08 14:48:46 -0800140 mWindowType(static_cast<WindowInfo::Type>(
141 args.metadata.getInt32(gui::METADATA_WINDOW_TYPE, 0))),
Tianhao Yao67dd7122022-02-22 17:48:33 +0000142 mLayerCreationFlags(args.flags),
Patrick Williamsbb25f802022-08-30 23:02:34 +0000143 mBorderEnabled(false),
144 mTextureName(args.textureName),
Vishnu Naire14c6b32022-08-06 04:20:15 +0000145 mHwcSlotGenerator(sp<HwcSlotGenerator>::make()),
146 mLayerFE(args.flinger->getFactory().createLayerFE(mName)) {
Patrick Williamsbb25f802022-08-30 23:02:34 +0000147 ALOGV("Creating Layer %s", getDebugName());
148
Mathias Agopian4d9b8222013-03-12 17:11:48 -0700149 uint32_t layerFlags = 0;
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700150 if (args.flags & ISurfaceComposerClient::eHidden) layerFlags |= layer_state_t::eLayerHidden;
151 if (args.flags & ISurfaceComposerClient::eOpaque) layerFlags |= layer_state_t::eLayerOpaque;
152 if (args.flags & ISurfaceComposerClient::eSecure) layerFlags |= layer_state_t::eLayerSecure;
chaviwc5676c62020-09-18 15:01:04 -0700153 if (args.flags & ISurfaceComposerClient::eSkipScreenshot)
154 layerFlags |= layer_state_t::eLayerSkipScreenshot;
Robert Carr6a160312021-05-17 12:08:20 -0700155 mDrawingState.flags = layerFlags;
Robert Carr6a160312021-05-17 12:08:20 -0700156 mDrawingState.crop.makeInvalid();
Robert Carr6a160312021-05-17 12:08:20 -0700157 mDrawingState.z = 0;
158 mDrawingState.color.a = 1.0f;
Dominik Laskowski29fa1462021-04-27 15:51:50 -0700159 mDrawingState.layerStack = ui::DEFAULT_LAYER_STACK;
Robert Carr6a160312021-05-17 12:08:20 -0700160 mDrawingState.sequence = 0;
Robert Carr6a160312021-05-17 12:08:20 -0700161 mDrawingState.transform.set(0, 0);
162 mDrawingState.frameNumber = 0;
163 mDrawingState.bufferTransform = 0;
164 mDrawingState.transformToDisplayInverse = false;
165 mDrawingState.crop.makeInvalid();
166 mDrawingState.acquireFence = sp<Fence>::make(-1);
167 mDrawingState.acquireFenceTime = std::make_shared<FenceTime>(mDrawingState.acquireFence);
168 mDrawingState.dataspace = ui::Dataspace::UNKNOWN;
Vishnu Nairbc4ee5c2022-08-16 03:19:37 +0000169 mDrawingState.dataspaceRequested = false;
Robert Carr6a160312021-05-17 12:08:20 -0700170 mDrawingState.hdrMetadata.validTypes = 0;
171 mDrawingState.surfaceDamageRegion = Region::INVALID_REGION;
172 mDrawingState.cornerRadius = 0.0f;
173 mDrawingState.backgroundBlurRadius = 0;
174 mDrawingState.api = -1;
175 mDrawingState.hasColorTransform = false;
176 mDrawingState.colorSpaceAgnostic = false;
177 mDrawingState.frameRateSelectionPriority = PRIORITY_UNSET;
178 mDrawingState.metadata = args.metadata;
179 mDrawingState.shadowRadius = 0.f;
180 mDrawingState.fixedTransformHint = ui::Transform::ROT_INVALID;
181 mDrawingState.frameTimelineInfo = {};
182 mDrawingState.postTime = -1;
183 mDrawingState.destinationFrame.makeInvalid();
Robin Leeedb375d2021-09-10 12:03:42 +0000184 mDrawingState.isTrustedOverlay = false;
Vishnu Nair9cf4a4d2021-09-17 12:16:08 -0700185 mDrawingState.dropInputMode = gui::DropInputMode::NONE;
Sally Qi81d95e62022-03-21 19:41:33 -0700186 mDrawingState.dimmingEnabled = true;
Andy Labrada096227e2022-06-15 16:58:11 +0000187 mDrawingState.defaultFrameRateCompatibility = FrameRateCompatibility::Default;
Mathias Agopian4d9b8222013-03-12 17:11:48 -0700188
Vishnu Nairc43a23c2020-05-29 14:32:27 -0700189 if (args.flags & ISurfaceComposerClient::eNoColorFill) {
190 // Set an invalid color so there is no color fill.
Robert Carr6a160312021-05-17 12:08:20 -0700191 mDrawingState.color.r = -1.0_hf;
192 mDrawingState.color.g = -1.0_hf;
193 mDrawingState.color.b = -1.0_hf;
Vishnu Nairc43a23c2020-05-29 14:32:27 -0700194 }
Dominik Laskowski4376bd82022-07-07 11:50:20 -0700195
196 mFrameTracker.setDisplayRefreshPeriod(
197 args.flinger->mScheduler->getVsyncPeriodFromRefreshRateConfigs());
Robert Carr2e102c92018-10-23 12:11:15 -0700198
Vishnu Naircb8be502022-10-12 19:03:23 +0000199 mOwnerUid = args.ownerUid;
200 mOwnerPid = args.ownerPid;
Patrick Williamsbb25f802022-08-30 23:02:34 +0000201
202 mPremultipliedAlpha = !(args.flags & ISurfaceComposerClient::eNonPremultiplied);
203 mPotentialCursor = args.flags & ISurfaceComposerClient::eCursorWindow;
204 mProtectedByApp = args.flags & ISurfaceComposerClient::eProtectedByApp;
205 mDrawingState.dataspace = ui::Dataspace::V0_SRGB;
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000206
207 mSnapshot->sequence = sequence;
208 mSnapshot->name = getDebugName();
209 mSnapshot->textureName = mTextureName;
210 mSnapshot->premultipliedAlpha = mPremultipliedAlpha;
211 mSnapshot->transform = {};
Dominik Laskowski75848362019-11-11 17:57:20 -0800212}
213
214void Layer::onFirstRef() {
215 mFlinger->onLayerFirstRef(this);
Dan Stoza436ccf32018-06-21 12:10:12 -0700216}
Mathias Agopianb7e930d2010-06-01 15:12:58 -0700217
Mathias Agopian4d9b8222013-03-12 17:11:48 -0700218Layer::~Layer() {
Patrick Williamsbb25f802022-08-30 23:02:34 +0000219 // The original layer and the clone layer share the same texture and buffer. Therefore, only
220 // one of the layers, in this case the original layer, needs to handle the deletion. The
221 // original layer and the clone should be removed at the same time so there shouldn't be any
222 // issue with the clone layer trying to use the texture.
223 if (mBufferInfo.mBuffer != nullptr) {
224 callReleaseBufferCallback(mDrawingState.releaseBufferListener,
225 mBufferInfo.mBuffer->getBuffer(), mBufferInfo.mFrameNumber,
226 mBufferInfo.mFence,
227 mFlinger->getMaxAcquiredBufferCountForCurrentRefreshRate(
228 mOwnerUid));
229 }
230 if (!isClone()) {
231 // The original layer and the clone layer share the same texture. Therefore, only one of
232 // the layers, in this case the original layer, needs to handle the deletion. The original
233 // layer and the clone should be removed at the same time so there shouldn't be any issue
234 // with the clone layer trying to use the deleted texture.
235 mFlinger->deleteTextureAsync(mTextureName);
236 }
237 const int32_t layerId = getSequence();
238 mFlinger->mTimeStats->onDestroy(layerId);
239 mFlinger->mFrameTracer->onDestroy(layerId);
240
David Sodman577c8962017-12-08 14:50:53 -0800241 sp<Client> c(mClientRef.promote());
242 if (c != 0) {
243 c->detachLayer(this);
244 }
245
Jorim Jaggi10c985e2018-10-23 11:17:45 +0000246 mFrameTracker.logAndResetStats(mName);
chaviw74d90ad2019-04-26 14:45:26 -0700247 mFlinger->onLayerDestroyed(this);
Robert Carr3e2a2992021-06-11 13:42:55 -0700248
249 if (mDrawingState.sidebandStream != nullptr) {
250 mFlinger->mTunnelModeEnabledReporter->decrementTunnelModeCount();
251 }
Robert Carr6a0382d2021-07-01 15:57:17 -0700252 if (mHadClonedChild) {
253 mFlinger->mNumClones--;
254 }
Mathias Agopian96f08192010-06-02 23:28:45 -0700255}
256
Mathias Agopian13127d82013-03-05 17:47:11 -0800257// ---------------------------------------------------------------------------
258// callbacks
259// ---------------------------------------------------------------------------
260
Vishnu Nairda9c85a2019-06-03 17:26:48 -0700261void Layer::removeRelativeZ(const std::vector<Layer*>& layersInTree) {
Robert Carr6a160312021-05-17 12:08:20 -0700262 if (mDrawingState.zOrderRelativeOf == nullptr) {
Vishnu Nairda9c85a2019-06-03 17:26:48 -0700263 return;
264 }
Robert Carr2e102c92018-10-23 12:11:15 -0700265
Robert Carr6a160312021-05-17 12:08:20 -0700266 sp<Layer> strongRelative = mDrawingState.zOrderRelativeOf.promote();
Vishnu Nairda9c85a2019-06-03 17:26:48 -0700267 if (strongRelative == nullptr) {
268 setZOrderRelativeOf(nullptr);
269 return;
270 }
271
272 if (!std::binary_search(layersInTree.begin(), layersInTree.end(), strongRelative.get())) {
Ady Abrahamd11bade2022-08-01 16:18:03 -0700273 strongRelative->removeZOrderRelative(wp<Layer>::fromExisting(this));
Vishnu Nairda9c85a2019-06-03 17:26:48 -0700274 mFlinger->setTransactionFlags(eTraversalNeeded);
chaviw606e5cf2019-03-01 10:12:10 -0800275 setZOrderRelativeOf(nullptr);
Robert Carr5edb1ad2017-04-25 10:54:24 -0700276 }
Vishnu Nairda9c85a2019-06-03 17:26:48 -0700277}
278
279void Layer::removeFromCurrentState() {
Robert Carr6a160312021-05-17 12:08:20 -0700280 if (!mRemovedFromDrawingState) {
281 mRemovedFromDrawingState = true;
Ady Abrahambe09aad2021-05-03 18:59:38 -0700282 mFlinger->mScheduler->deregisterLayer(this);
283 }
Rob Carr4bba3702018-10-08 21:53:30 +0000284
Ady Abrahamd11bade2022-08-01 16:18:03 -0700285 mFlinger->markLayerPendingRemovalLocked(sp<Layer>::fromExisting(this));
Chia-I Wuc6657022017-08-15 11:18:17 -0700286}
Chia-I Wu38512252017-05-17 14:36:16 -0700287
chaviw68d4dab2020-06-08 15:07:32 -0700288sp<Layer> Layer::getRootLayer() {
Rob Carrc6d2d2b2021-10-25 16:51:49 +0000289 sp<Layer> parent = getParent();
chaviw68d4dab2020-06-08 15:07:32 -0700290 if (parent == nullptr) {
Ady Abrahamd11bade2022-08-01 16:18:03 -0700291 return sp<Layer>::fromExisting(this);
chaviw68d4dab2020-06-08 15:07:32 -0700292 }
293 return parent->getRootLayer();
294}
295
Vishnu Nairda9c85a2019-06-03 17:26:48 -0700296void Layer::onRemovedFromCurrentState() {
chaviw68d4dab2020-06-08 15:07:32 -0700297 // Use the root layer since we want to maintain the hierarchy for the entire subtree.
298 auto layersInTree = getRootLayer()->getLayersInTree(LayerVector::StateSet::Current);
Vishnu Nairda9c85a2019-06-03 17:26:48 -0700299 std::sort(layersInTree.begin(), layersInTree.end());
chaviw68d4dab2020-06-08 15:07:32 -0700300
301 traverse(LayerVector::StateSet::Current, [&](Layer* layer) {
Vishnu Nairda9c85a2019-06-03 17:26:48 -0700302 layer->removeFromCurrentState();
303 layer->removeRelativeZ(layersInTree);
chaviw68d4dab2020-06-08 15:07:32 -0700304 });
Vishnu Nairda9c85a2019-06-03 17:26:48 -0700305}
306
chaviw61626f22018-11-15 16:26:27 -0800307void Layer::addToCurrentState() {
Robert Carr6a160312021-05-17 12:08:20 -0700308 if (mRemovedFromDrawingState) {
309 mRemovedFromDrawingState = false;
Ady Abrahambe09aad2021-05-03 18:59:38 -0700310 mFlinger->mScheduler->registerLayer(this);
Robert Carr867be372021-06-29 17:36:02 -0700311 mFlinger->removeFromOffscreenLayers(this);
Ady Abrahambe09aad2021-05-03 18:59:38 -0700312 }
chaviw61626f22018-11-15 16:26:27 -0800313
314 for (const auto& child : mCurrentChildren) {
315 child->addToCurrentState();
316 }
317}
318
Mathias Agopian13127d82013-03-05 17:47:11 -0800319// ---------------------------------------------------------------------------
320// set-up
321// ---------------------------------------------------------------------------
322
chaviw13fdc492017-06-27 12:40:18 -0700323bool Layer::getPremultipledAlpha() const {
324 return mPremultipliedAlpha;
325}
326
Mathias Agopian4d9b8222013-03-12 17:11:48 -0700327sp<IBinder> Layer::getHandle() {
Mathias Agopian13127d82013-03-05 17:47:11 -0800328 Mutex::Autolock _l(mLock);
Robert Carrc0df3122019-04-11 13:18:21 -0700329 if (mGetHandleCalled) {
330 ALOGE("Get handle called twice" );
331 return nullptr;
332 }
333 mGetHandleCalled = true;
Ady Abrahamd11bade2022-08-01 16:18:03 -0700334 return sp<Handle>::make(mFlinger, sp<Layer>::fromExisting(this));
Mathias Agopian13127d82013-03-05 17:47:11 -0800335}
336
337// ---------------------------------------------------------------------------
338// h/w composer set-up
339// ---------------------------------------------------------------------------
340
Mathias Agopianf3e85d42013-05-10 18:01:12 -0700341static Rect reduce(const Rect& win, const Region& exclude) {
342 if (CC_LIKELY(exclude.isEmpty())) {
343 return win;
344 }
345 if (exclude.isRect()) {
346 return win.reduce(exclude.getBounds());
347 }
348 return Region(win).subtract(exclude).getBounds();
349}
350
Dan Stoza80d61162017-12-20 15:57:52 -0800351static FloatRect reduce(const FloatRect& win, const Region& exclude) {
352 if (CC_LIKELY(exclude.isEmpty())) {
353 return win;
354 }
355 // Convert through Rect (by rounding) for lack of FloatRegion
356 return Region(Rect{win}).subtract(exclude).getBounds().toFloatRect();
357}
358
Vishnu Nair4351ad52019-02-11 14:13:02 -0800359Rect Layer::getScreenBounds(bool reduceTransparentRegion) const {
Vishnu Nairf0c28512019-02-08 12:40:28 -0800360 if (!reduceTransparentRegion) {
361 return Rect{mScreenBounds};
362 }
363
364 FloatRect bounds = getBounds();
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800365 ui::Transform t = getTransform();
Vishnu Nair60356342018-11-13 13:00:45 -0800366 // Transform to screen space.
367 bounds = t.transform(bounds);
368 return Rect{bounds};
Robert Carr1f0a16a2016-10-24 16:27:39 -0700369}
370
Vishnu Nair4351ad52019-02-11 14:13:02 -0800371FloatRect Layer::getBounds() const {
Alec Mourib416efd2018-09-06 21:01:59 +0000372 const State& s(getDrawingState());
Vishnu Nair4351ad52019-02-11 14:13:02 -0800373 return getBounds(getActiveTransparentRegion(s));
Michael Lentine6c925ed2014-09-26 17:55:01 -0700374}
375
Vishnu Nairf0c28512019-02-08 12:40:28 -0800376FloatRect Layer::getBounds(const Region& activeTransparentRegion) const {
377 // Subtract the transparent region and snap to the bounds.
378 return reduce(mBounds, activeTransparentRegion);
379}
380
Vishnu Nairc97b8db2019-10-29 18:19:35 -0700381void Layer::computeBounds(FloatRect parentBounds, ui::Transform parentTransform,
382 float parentShadowRadius) {
Vishnu Nair4351ad52019-02-11 14:13:02 -0800383 const State& s(getDrawingState());
384
385 // Calculate effective layer transform
386 mEffectiveTransform = parentTransform * getActiveTransform(s);
387
Garfield Tan2c1782c2022-02-16 15:25:05 -0800388 if (CC_UNLIKELY(!isTransformValid())) {
389 ALOGW("Stop computing bounds for %s because it has invalid transformation.",
390 getDebugName());
391 return;
392 }
393
Vishnu Nair4351ad52019-02-11 14:13:02 -0800394 // Transform parent bounds to layer space
395 parentBounds = getActiveTransform(s).inverse().transform(parentBounds);
396
Vishnu Nairc652ff82019-03-15 12:48:54 -0700397 // Calculate source bounds
Vishnu Nair4351ad52019-02-11 14:13:02 -0800398 mSourceBounds = computeSourceBounds(parentBounds);
399
400 // Calculate bounds by croping diplay frame with layer crop and parent bounds
401 FloatRect bounds = mSourceBounds;
402 const Rect layerCrop = getCrop(s);
403 if (!layerCrop.isEmpty()) {
404 bounds = mSourceBounds.intersect(layerCrop.toFloatRect());
405 }
406 bounds = bounds.intersect(parentBounds);
407
408 mBounds = bounds;
409 mScreenBounds = mEffectiveTransform.transform(mBounds);
Vishnu Nairc652ff82019-03-15 12:48:54 -0700410
Vishnu Nairc97b8db2019-10-29 18:19:35 -0700411 // Use the layer's own shadow radius if set. Otherwise get the radius from
412 // parent.
413 if (s.shadowRadius > 0.f) {
414 mEffectiveShadowRadius = s.shadowRadius;
415 } else {
416 mEffectiveShadowRadius = parentShadowRadius;
417 }
418
419 // Shadow radius is passed down to only one layer so if the layer can draw shadows,
420 // don't pass it to its children.
421 const float childShadowRadius = canDrawShadows() ? 0.f : mEffectiveShadowRadius;
422
Vishnu Nair4351ad52019-02-11 14:13:02 -0800423 for (const sp<Layer>& child : mDrawingChildren) {
Vishnu Nair6bdec7d2021-05-10 15:01:13 -0700424 child->computeBounds(mBounds, mEffectiveTransform, childShadowRadius);
Vishnu Nair4351ad52019-02-11 14:13:02 -0800425 }
Vishnu Nairba354102022-08-01 00:14:18 +0000426
427 if (mPotentialCursor) {
428 prepareCursorCompositionState();
429 }
Vishnu Nair4351ad52019-02-11 14:13:02 -0800430}
431
Vishnu Nair60356342018-11-13 13:00:45 -0800432Rect Layer::getCroppedBufferSize(const State& s) const {
433 Rect size = getBufferSize(s);
434 Rect crop = getCrop(s);
435 if (!crop.isEmpty() && size.isValid()) {
436 size.intersect(crop, &size);
437 } else if (!crop.isEmpty()) {
438 size = crop;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700439 }
Vishnu Nair60356342018-11-13 13:00:45 -0800440 return size;
Mathias Agopian13127d82013-03-05 17:47:11 -0800441}
442
Lucas Dupin1b6531c2018-07-05 17:18:21 -0700443void Layer::setupRoundedCornersCropCoordinates(Rect win,
444 const FloatRect& roundedCornersCrop) const {
445 // Translate win by the rounded corners rect coordinates, to have all values in
446 // layer coordinate space.
447 win.left -= roundedCornersCrop.left;
448 win.right -= roundedCornersCrop.left;
449 win.top -= roundedCornersCrop.top;
450 win.bottom -= roundedCornersCrop.top;
Lucas Dupin1b6531c2018-07-05 17:18:21 -0700451}
452
Lloyd Piquede196652020-01-22 17:29:58 -0800453void Layer::prepareBasicGeometryCompositionState() {
Lloyd Piquec6687342019-03-07 21:34:57 -0800454 const auto& drawingState{getDrawingState()};
Lloyd Piquec6687342019-03-07 21:34:57 -0800455 const auto alpha = static_cast<float>(getAlpha());
456 const bool opaque = isOpaque(drawingState);
Vishnu Nair50c0afe2022-07-11 15:04:07 -0700457 const bool usesRoundedCorners = hasRoundedCorners();
Lloyd Piquec6687342019-03-07 21:34:57 -0800458
459 auto blendMode = Hwc2::IComposerClient::BlendMode::NONE;
460 if (!opaque || alpha != 1.0f) {
461 blendMode = mPremultipliedAlpha ? Hwc2::IComposerClient::BlendMode::PREMULTIPLIED
462 : Hwc2::IComposerClient::BlendMode::COVERAGE;
463 }
464
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000465 auto* snapshot = editLayerSnapshot();
466 snapshot->outputFilter = getOutputFilter();
467 snapshot->isVisible = isVisible();
468 snapshot->isOpaque = opaque && !usesRoundedCorners && alpha == 1.f;
469 snapshot->shadowRadius = mEffectiveShadowRadius;
Lloyd Piquec6687342019-03-07 21:34:57 -0800470
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000471 snapshot->contentDirty = contentDirty;
Lloyd Piquec6687342019-03-07 21:34:57 -0800472 contentDirty = false;
473
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000474 snapshot->geomLayerBounds = mBounds;
475 snapshot->geomLayerTransform = getTransform();
476 snapshot->geomInverseLayerTransform = snapshot->geomLayerTransform.inverse();
477 snapshot->transparentRegionHint = getActiveTransparentRegion(drawingState);
Lloyd Piquec6687342019-03-07 21:34:57 -0800478
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000479 snapshot->blendMode = static_cast<Hwc2::IComposerClient::BlendMode>(blendMode);
480 snapshot->alpha = alpha;
481 snapshot->backgroundBlurRadius = drawingState.backgroundBlurRadius;
482 snapshot->blurRegions = drawingState.blurRegions;
483 snapshot->stretchEffect = getStretchEffect();
Lloyd Piquec6687342019-03-07 21:34:57 -0800484}
485
Lloyd Piquede196652020-01-22 17:29:58 -0800486void Layer::prepareGeometryCompositionState() {
Lloyd Piquea83776c2019-01-29 18:42:32 -0800487 const auto& drawingState{getDrawingState()};
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000488 auto* snapshot = editLayerSnapshot();
David Sodman15094112018-10-11 09:39:37 -0700489
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000490 snapshot->geomBufferSize = getBufferSize(drawingState);
491 snapshot->geomContentCrop = getBufferCrop();
492 snapshot->geomCrop = getCrop(drawingState);
493 snapshot->geomBufferTransform = getBufferTransform();
494 snapshot->geomBufferUsesDisplayInverseTransform = getTransformToDisplayInverse();
495 snapshot->geomUsesSourceCrop = usesSourceCrop();
496 snapshot->isSecure = isSecure();
Lloyd Piquede196652020-01-22 17:29:58 -0800497
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000498 snapshot->metadata.clear();
Lloyd Pique8d9f8362020-02-11 19:13:09 -0800499 const auto& supportedMetadata = mFlinger->getHwComposer().getSupportedLayerGenericMetadata();
500 for (const auto& [key, mandatory] : supportedMetadata) {
501 const auto& genericLayerMetadataCompatibilityMap =
502 mFlinger->getGenericLayerMetadataKeyMap();
503 auto compatIter = genericLayerMetadataCompatibilityMap.find(key);
504 if (compatIter == std::end(genericLayerMetadataCompatibilityMap)) {
505 continue;
506 }
507 const uint32_t id = compatIter->second;
508
509 auto it = drawingState.metadata.mMap.find(id);
510 if (it == std::end(drawingState.metadata.mMap)) {
511 continue;
512 }
513
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000514 snapshot->metadata.emplace(key,
515 compositionengine::GenericLayerMetadataEntry{mandatory,
516 it->second});
Lloyd Pique8d9f8362020-02-11 19:13:09 -0800517 }
Lloyd Piquea83776c2019-01-29 18:42:32 -0800518}
David Sodmanba340492018-08-05 21:51:33 -0700519
Lloyd Piquede196652020-01-22 17:29:58 -0800520void Layer::preparePerFrameCompositionState() {
Lloyd Pique688abd42019-02-15 15:42:24 -0800521 const auto& drawingState{getDrawingState()};
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000522 auto* snapshot = editLayerSnapshot();
Lloyd Piquef5275482019-01-29 18:42:42 -0800523
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000524 snapshot->forceClientComposition = false;
Lloyd Piquede196652020-01-22 17:29:58 -0800525
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000526 snapshot->isColorspaceAgnostic = isColorSpaceAgnostic();
527 snapshot->dataspace = getDataSpace();
528 snapshot->colorTransform = getColorTransform();
529 snapshot->colorTransformIsIdentity = !hasColorTransform();
530 snapshot->surfaceDamage = surfaceDamageRegion;
531 snapshot->hasProtectedContent = isProtected();
532 snapshot->dimmingEnabled = isDimmingEnabled();
Lloyd Pique688abd42019-02-15 15:42:24 -0800533
Vishnu Nair50c0afe2022-07-11 15:04:07 -0700534 const bool usesRoundedCorners = hasRoundedCorners();
Vishnu Nairc97b8db2019-10-29 18:19:35 -0700535
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000536 snapshot->isOpaque = isOpaque(drawingState) && !usesRoundedCorners && getAlpha() == 1.0_hf;
Lloyd Piquef5275482019-01-29 18:42:42 -0800537
538 // Force client composition for special cases known only to the front-end.
Leon Scroggins IIId305ef22021-04-06 09:53:26 -0400539 // Rounded corners no longer force client composition, since we may use a
540 // hole punch so that the layer will appear to have rounded corners.
541 if (isHdrY410() || drawShadows() || drawingState.blurRegions.size() > 0 ||
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000542 snapshot->stretchEffect.hasEffect()) {
543 snapshot->forceClientComposition = true;
Lloyd Piquef5275482019-01-29 18:42:42 -0800544 }
Vishnu Nairb801a982021-11-02 15:12:08 -0700545 // If there are no visible region changes, we still need to update blur parameters.
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000546 snapshot->blurRegions = drawingState.blurRegions;
547 snapshot->backgroundBlurRadius = drawingState.backgroundBlurRadius;
Nathaniel Nifong1303d912021-10-06 09:41:24 -0400548
549 // Layer framerate is used in caching decisions.
550 // Retrieve it from the scheduler which maintains an instance of LayerHistory, and store it in
551 // LayerFECompositionState where it would be visible to Flattener.
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000552 snapshot->fps = mFlinger->getLayerFramerate(systemTime(), getSequence());
Patrick Williamsbb25f802022-08-30 23:02:34 +0000553
554 if (hasBufferOrSidebandStream()) {
555 preparePerFrameBufferCompositionState();
556 } else {
557 preparePerFrameEffectsCompositionState();
558 }
559}
560
561void Layer::preparePerFrameBufferCompositionState() {
562 // Sideband layers
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000563 auto* snapshot = editLayerSnapshot();
564 if (snapshot->sidebandStream.get() && !snapshot->sidebandStreamHasFrame) {
565 snapshot->compositionType =
Patrick Williamsbb25f802022-08-30 23:02:34 +0000566 aidl::android::hardware::graphics::composer3::Composition::SIDEBAND;
567 return;
568 } else if ((mDrawingState.flags & layer_state_t::eLayerIsDisplayDecoration) != 0) {
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000569 snapshot->compositionType =
Patrick Williamsbb25f802022-08-30 23:02:34 +0000570 aidl::android::hardware::graphics::composer3::Composition::DISPLAY_DECORATION;
571 } else {
572 // Normal buffer layers
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000573 snapshot->hdrMetadata = mBufferInfo.mHdrMetadata;
574 snapshot->compositionType = mPotentialCursor
Patrick Williamsbb25f802022-08-30 23:02:34 +0000575 ? aidl::android::hardware::graphics::composer3::Composition::CURSOR
576 : aidl::android::hardware::graphics::composer3::Composition::DEVICE;
577 }
578
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000579 snapshot->buffer = getBuffer();
580 snapshot->bufferSlot = (mBufferInfo.mBufferSlot == BufferQueue::INVALID_BUFFER_SLOT)
Patrick Williamsbb25f802022-08-30 23:02:34 +0000581 ? 0
582 : mBufferInfo.mBufferSlot;
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000583 snapshot->acquireFence = mBufferInfo.mFence;
584 snapshot->frameNumber = mBufferInfo.mFrameNumber;
585 snapshot->sidebandStreamHasFrame = false;
Patrick Williamsbb25f802022-08-30 23:02:34 +0000586}
587
588void Layer::preparePerFrameEffectsCompositionState() {
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000589 auto* snapshot = editLayerSnapshot();
590 snapshot->color = getColor();
591 snapshot->compositionType =
Patrick Williamsbb25f802022-08-30 23:02:34 +0000592 aidl::android::hardware::graphics::composer3::Composition::SOLID_COLOR;
Lloyd Piquef5275482019-01-29 18:42:42 -0800593}
594
Lloyd Piquede196652020-01-22 17:29:58 -0800595void Layer::prepareCursorCompositionState() {
Lloyd Piquec7b0c752019-03-07 20:59:59 -0800596 const State& drawingState{getDrawingState()};
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000597 auto* snapshot = editLayerSnapshot();
Lloyd Piquec7b0c752019-03-07 20:59:59 -0800598
599 // Apply the layer's transform, followed by the display's global transform
600 // Here we're guaranteed that the layer's transform preserves rects
601 Rect win = getCroppedBufferSize(drawingState);
602 // Subtract the transparent region and snap to the bounds
603 Rect bounds = reduce(win, getActiveTransparentRegion(drawingState));
604 Rect frame(getTransform().transform(bounds));
605
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000606 snapshot->cursorFrame = frame;
Lloyd Piquede196652020-01-22 17:29:58 -0800607}
608
Lloyd Piquea83776c2019-01-29 18:42:32 -0800609const char* Layer::getDebugName() const {
Dominik Laskowski87a07e42019-10-10 20:38:02 -0700610 return mName.c_str();
David Sodman4b7c4bc2017-11-17 12:13:59 -0800611}
612
Mathias Agopian13127d82013-03-05 17:47:11 -0800613// ---------------------------------------------------------------------------
614// drawing...
615// ---------------------------------------------------------------------------
616
Leon Scroggins III2e1aa182021-12-01 17:33:12 -0500617aidl::android::hardware::graphics::composer3::Composition Layer::getCompositionType(
618 const DisplayDevice& display) const {
Dominik Laskowskib7251f42020-04-20 17:42:59 -0700619 const auto outputLayer = findOutputLayerForDisplay(&display);
Alec Mouri6b9e9912020-01-21 10:50:24 -0800620 if (outputLayer == nullptr) {
Leon Scroggins III2e1aa182021-12-01 17:33:12 -0500621 return aidl::android::hardware::graphics::composer3::Composition::INVALID;
Alec Mouri6b9e9912020-01-21 10:50:24 -0800622 }
623 if (outputLayer->getState().hwc) {
624 return (*outputLayer->getState().hwc).hwcCompositionType;
625 } else {
Leon Scroggins III2e1aa182021-12-01 17:33:12 -0500626 return aidl::android::hardware::graphics::composer3::Composition::CLIENT;
Alec Mouri6b9e9912020-01-21 10:50:24 -0800627 }
Dan Stoza9e56aa02015-11-02 13:00:03 -0800628}
629
Mathias Agopian13127d82013-03-05 17:47:11 -0800630// ----------------------------------------------------------------------------
631// local state
632// ----------------------------------------------------------------------------
633
David Sodman41fdfc92017-11-06 16:09:56 -0800634bool Layer::isSecure() const {
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800635 const State& s(mDrawingState);
Garfield Tande619fa2020-10-02 17:13:53 -0700636 if (s.flags & layer_state_t::eLayerSecure) {
637 return true;
638 }
639
Rob Carrc6d2d2b2021-10-25 16:51:49 +0000640 const auto p = mDrawingParent.promote();
Garfield Tande619fa2020-10-02 17:13:53 -0700641 return (p != nullptr) ? p->isSecure() : false;
Dan Stoza23116082015-06-18 14:58:39 -0700642}
643
Mathias Agopian13127d82013-03-05 17:47:11 -0800644// ----------------------------------------------------------------------------
645// transaction
646// ----------------------------------------------------------------------------
Ady Abraham83729882018-12-07 12:26:48 -0800647
Marissa Wall61c58622018-07-18 10:12:20 -0700648uint32_t Layer::doTransaction(uint32_t flags) {
649 ATRACE_CALL();
650
Robert Carr0758e5d2021-03-11 22:15:04 -0800651 // TODO: This is unfortunate.
Robert Carr6a160312021-05-17 12:08:20 -0700652 mDrawingStateModified = mDrawingState.modified;
653 mDrawingState.modified = false;
Marissa Wall61c58622018-07-18 10:12:20 -0700654
Alec Mourib416efd2018-09-06 21:01:59 +0000655 const State& s(getDrawingState());
Marissa Wall61c58622018-07-18 10:12:20 -0700656
Robert Carr6a160312021-05-17 12:08:20 -0700657 if (updateGeometry()) {
Mathias Agopian13127d82013-03-05 17:47:11 -0800658 // invalidate and recompute the visible regions if needed
659 flags |= Layer::eVisibleRegion;
660 }
661
Robert Carr6a160312021-05-17 12:08:20 -0700662 if (s.sequence != mLastCommittedTxSequence) {
Mathias Agopian13127d82013-03-05 17:47:11 -0800663 // invalidate and recompute the visible regions if needed
Arthur Hung9ed43392022-05-27 06:31:57 +0000664 mLastCommittedTxSequence = s.sequence;
Mathias Agopian13127d82013-03-05 17:47:11 -0800665 flags |= eVisibleRegion;
666 this->contentDirty = true;
667
668 // we may use linear filtering, if the matrix scales us
Robert Carr6a160312021-05-17 12:08:20 -0700669 mNeedsFiltering = getActiveTransform(s).needsBilinearFiltering();
Mathias Agopian13127d82013-03-05 17:47:11 -0800670 }
671
Arthur Hung9ed43392022-05-27 06:31:57 +0000672 if (!mPotentialCursor && (flags & Layer::eVisibleRegion)) {
673 mFlinger->mUpdateInputInfo = true;
674 }
675
Robert Carr6a160312021-05-17 12:08:20 -0700676 commitTransaction(mDrawingState);
Robert Carra1257842020-01-31 13:48:28 -0800677
Mathias Agopian13127d82013-03-05 17:47:11 -0800678 return flags;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800679}
680
Robert Carr6a160312021-05-17 12:08:20 -0700681void Layer::commitTransaction(State&) {
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +0000682 // Set the present state for all bufferlessSurfaceFramesTX to Presented. The
683 // bufferSurfaceFrameTX will be presented in latchBuffer.
684 for (auto& [token, surfaceFrame] : mDrawingState.bufferlessSurfaceFramesTX) {
685 if (surfaceFrame->getPresentState() != PresentState::Presented) {
686 // With applyPendingStates, we could end up having presented surfaceframes from previous
687 // states
688 surfaceFrame->setPresentState(PresentState::Presented);
689 mFlinger->mFrameTimeline->addSurfaceFrame(surfaceFrame);
690 }
691 }
Robert Carr6a160312021-05-17 12:08:20 -0700692 mDrawingState.bufferlessSurfaceFramesTX.clear();
Mathias Agopiana67932f2011-04-20 14:20:59 -0700693}
694
Dominik Laskowski9e168db2021-05-27 16:05:12 -0700695uint32_t Layer::clearTransactionFlags(uint32_t mask) {
696 const auto flags = mTransactionFlags & mask;
697 mTransactionFlags &= ~mask;
698 return flags;
Mathias Agopian13127d82013-03-05 17:47:11 -0800699}
700
Dominik Laskowski9e168db2021-05-27 16:05:12 -0700701void Layer::setTransactionFlags(uint32_t mask) {
702 mTransactionFlags |= mask;
Mathias Agopian13127d82013-03-05 17:47:11 -0800703}
704
Robert Carr1f0a16a2016-10-24 16:27:39 -0700705bool Layer::setChildLayer(const sp<Layer>& childLayer, int32_t z) {
706 ssize_t idx = mCurrentChildren.indexOf(childLayer);
707 if (idx < 0) {
708 return false;
709 }
710 if (childLayer->setLayer(z)) {
711 mCurrentChildren.removeAt(idx);
712 mCurrentChildren.add(childLayer);
Robert Carr503d2bd2017-12-04 15:49:47 -0800713 return true;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700714 }
Robert Carr503d2bd2017-12-04 15:49:47 -0800715 return false;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700716}
717
Robert Carr503c7042017-09-27 15:06:08 -0700718bool Layer::setChildRelativeLayer(const sp<Layer>& childLayer,
719 const sp<IBinder>& relativeToHandle, int32_t relativeZ) {
720 ssize_t idx = mCurrentChildren.indexOf(childLayer);
721 if (idx < 0) {
722 return false;
723 }
724 if (childLayer->setRelativeLayer(relativeToHandle, relativeZ)) {
725 mCurrentChildren.removeAt(idx);
726 mCurrentChildren.add(childLayer);
Robert Carr503d2bd2017-12-04 15:49:47 -0800727 return true;
Robert Carr503c7042017-09-27 15:06:08 -0700728 }
Robert Carr503d2bd2017-12-04 15:49:47 -0800729 return false;
Robert Carr503c7042017-09-27 15:06:08 -0700730}
731
Robert Carrae060832016-11-28 10:51:00 -0800732bool Layer::setLayer(int32_t z) {
Robert Carr6a160312021-05-17 12:08:20 -0700733 if (mDrawingState.z == z && !usingRelativeZ(LayerVector::StateSet::Current)) return false;
734 mDrawingState.sequence++;
735 mDrawingState.z = z;
736 mDrawingState.modified = true;
Robert Carrdb66e622017-04-10 16:55:57 -0700737
Robert Carra70e91c2021-06-11 13:59:52 -0700738 mFlinger->mSomeChildrenChanged = true;
739
Robert Carrdb66e622017-04-10 16:55:57 -0700740 // Discard all relative layering.
Robert Carr6a160312021-05-17 12:08:20 -0700741 if (mDrawingState.zOrderRelativeOf != nullptr) {
742 sp<Layer> strongRelative = mDrawingState.zOrderRelativeOf.promote();
Robert Carrdb66e622017-04-10 16:55:57 -0700743 if (strongRelative != nullptr) {
Ady Abrahamd11bade2022-08-01 16:18:03 -0700744 strongRelative->removeZOrderRelative(wp<Layer>::fromExisting(this));
Robert Carrdb66e622017-04-10 16:55:57 -0700745 }
chaviw606e5cf2019-03-01 10:12:10 -0800746 setZOrderRelativeOf(nullptr);
Robert Carrdb66e622017-04-10 16:55:57 -0700747 }
Mathias Agopian13127d82013-03-05 17:47:11 -0800748 setTransactionFlags(eTransactionNeeded);
749 return true;
750}
Robert Carr1f0a16a2016-10-24 16:27:39 -0700751
Robert Carrdb66e622017-04-10 16:55:57 -0700752void Layer::removeZOrderRelative(const wp<Layer>& relative) {
Robert Carr6a160312021-05-17 12:08:20 -0700753 mDrawingState.zOrderRelatives.remove(relative);
754 mDrawingState.sequence++;
755 mDrawingState.modified = true;
Robert Carrdb66e622017-04-10 16:55:57 -0700756 setTransactionFlags(eTransactionNeeded);
757}
758
759void Layer::addZOrderRelative(const wp<Layer>& relative) {
Robert Carr6a160312021-05-17 12:08:20 -0700760 mDrawingState.zOrderRelatives.add(relative);
761 mDrawingState.modified = true;
762 mDrawingState.sequence++;
Robert Carrdb66e622017-04-10 16:55:57 -0700763 setTransactionFlags(eTransactionNeeded);
764}
765
chaviw606e5cf2019-03-01 10:12:10 -0800766void Layer::setZOrderRelativeOf(const wp<Layer>& relativeOf) {
Robert Carr6a160312021-05-17 12:08:20 -0700767 mDrawingState.zOrderRelativeOf = relativeOf;
768 mDrawingState.sequence++;
769 mDrawingState.modified = true;
770 mDrawingState.isRelativeOf = relativeOf != nullptr;
chaviwbdb8b802019-10-14 09:17:12 -0700771
chaviw606e5cf2019-03-01 10:12:10 -0800772 setTransactionFlags(eTransactionNeeded);
773}
774
Robert Carr503d2bd2017-12-04 15:49:47 -0800775bool Layer::setRelativeLayer(const sp<IBinder>& relativeToHandle, int32_t relativeZ) {
Vishnu Nairf9096652021-07-20 18:49:42 -0700776 sp<Layer> relative = fromHandle(relativeToHandle).promote();
Robert Carrdb66e622017-04-10 16:55:57 -0700777 if (relative == nullptr) {
778 return false;
779 }
780
Robert Carr6a160312021-05-17 12:08:20 -0700781 if (mDrawingState.z == relativeZ && usingRelativeZ(LayerVector::StateSet::Current) &&
782 mDrawingState.zOrderRelativeOf == relative) {
Robert Carr503d2bd2017-12-04 15:49:47 -0800783 return false;
784 }
785
Robert Carr88b85e12022-03-21 15:47:35 -0700786 if (CC_UNLIKELY(relative->usingRelativeZ(LayerVector::StateSet::Drawing)) &&
787 (relative->mDrawingState.zOrderRelativeOf == this)) {
788 ALOGE("Detected relative layer loop between %s and %s",
789 mName.c_str(), relative->mName.c_str());
790 ALOGE("Ignoring new call to set relative layer");
791 return false;
792 }
793
Robert Carra70e91c2021-06-11 13:59:52 -0700794 mFlinger->mSomeChildrenChanged = true;
795
Robert Carr6a160312021-05-17 12:08:20 -0700796 mDrawingState.sequence++;
797 mDrawingState.modified = true;
798 mDrawingState.z = relativeZ;
Robert Carrdb66e622017-04-10 16:55:57 -0700799
Robert Carr6a160312021-05-17 12:08:20 -0700800 auto oldZOrderRelativeOf = mDrawingState.zOrderRelativeOf.promote();
chaviw9ab4bd12017-11-03 13:11:00 -0700801 if (oldZOrderRelativeOf != nullptr) {
Ady Abrahamd11bade2022-08-01 16:18:03 -0700802 oldZOrderRelativeOf->removeZOrderRelative(wp<Layer>::fromExisting(this));
chaviw9ab4bd12017-11-03 13:11:00 -0700803 }
chaviw606e5cf2019-03-01 10:12:10 -0800804 setZOrderRelativeOf(relative);
Ady Abrahamd11bade2022-08-01 16:18:03 -0700805 relative->addZOrderRelative(wp<Layer>::fromExisting(this));
Robert Carrdb66e622017-04-10 16:55:57 -0700806
807 setTransactionFlags(eTransactionNeeded);
808
809 return true;
810}
811
Winson Chunga30f7c92021-06-29 15:42:56 -0700812bool Layer::setTrustedOverlay(bool isTrustedOverlay) {
813 if (mDrawingState.isTrustedOverlay == isTrustedOverlay) return false;
814 mDrawingState.isTrustedOverlay = isTrustedOverlay;
815 mDrawingState.modified = true;
Arthur Hung9ed43392022-05-27 06:31:57 +0000816 mFlinger->mUpdateInputInfo = true;
Winson Chunga30f7c92021-06-29 15:42:56 -0700817 setTransactionFlags(eTransactionNeeded);
818 return true;
819}
820
821bool Layer::isTrustedOverlay() const {
822 if (getDrawingState().isTrustedOverlay) {
823 return true;
824 }
Rob Carrc6d2d2b2021-10-25 16:51:49 +0000825 const auto& p = mDrawingParent.promote();
Winson Chunga30f7c92021-06-29 15:42:56 -0700826 return (p != nullptr) && p->isTrustedOverlay();
827}
828
Dan Stoza9e56aa02015-11-02 13:00:03 -0800829bool Layer::setAlpha(float alpha) {
Robert Carr6a160312021-05-17 12:08:20 -0700830 if (mDrawingState.color.a == alpha) return false;
831 mDrawingState.sequence++;
832 mDrawingState.color.a = alpha;
833 mDrawingState.modified = true;
Mathias Agopian13127d82013-03-05 17:47:11 -0800834 setTransactionFlags(eTransactionNeeded);
835 return true;
836}
chaviw13fdc492017-06-27 12:40:18 -0700837
Valerie Haudd0b7572019-01-29 14:59:27 -0800838bool Layer::setBackgroundColor(const half3& color, float alpha, ui::Dataspace dataspace) {
Robert Carr6a160312021-05-17 12:08:20 -0700839 if (!mDrawingState.bgColorLayer && alpha == 0) {
chaviw13fdc492017-06-27 12:40:18 -0700840 return false;
Valerie Hauaa194562019-02-05 16:21:38 -0800841 }
Robert Carr6a160312021-05-17 12:08:20 -0700842 mDrawingState.sequence++;
843 mDrawingState.modified = true;
Valerie Hauaa194562019-02-05 16:21:38 -0800844 setTransactionFlags(eTransactionNeeded);
845
Robert Carr6a160312021-05-17 12:08:20 -0700846 if (!mDrawingState.bgColorLayer && alpha != 0) {
Valerie Haudd0b7572019-01-29 14:59:27 -0800847 // create background color layer if one does not yet exist
Vishnu Nairfa247b12020-02-11 08:58:26 -0800848 uint32_t flags = ISurfaceComposerClient::eFXSurfaceEffect;
Dominik Laskowski87a07e42019-10-10 20:38:02 -0700849 std::string name = mName + "BackgroundColorLayer";
Robert Carr6a160312021-05-17 12:08:20 -0700850 mDrawingState.bgColorLayer = mFlinger->getFactory().createEffectLayer(
Vishnu Nair7fb9e5a2021-11-08 12:44:05 -0800851 LayerCreationArgs(mFlinger.get(), nullptr, std::move(name), flags,
Dominik Laskowski87a07e42019-10-10 20:38:02 -0700852 LayerMetadata()));
chaviw13fdc492017-06-27 12:40:18 -0700853
Valerie Haudd0b7572019-01-29 14:59:27 -0800854 // add to child list
Robert Carr6a160312021-05-17 12:08:20 -0700855 addChild(mDrawingState.bgColorLayer);
Valerie Haudd0b7572019-01-29 14:59:27 -0800856 mFlinger->mLayersAdded = true;
857 // set up SF to handle added color layer
858 if (isRemovedFromCurrentState()) {
Robert Carr6a160312021-05-17 12:08:20 -0700859 mDrawingState.bgColorLayer->onRemovedFromCurrentState();
Valerie Haudd0b7572019-01-29 14:59:27 -0800860 }
861 mFlinger->setTransactionFlags(eTransactionNeeded);
Robert Carr6a160312021-05-17 12:08:20 -0700862 } else if (mDrawingState.bgColorLayer && alpha == 0) {
863 mDrawingState.bgColorLayer->reparent(nullptr);
864 mDrawingState.bgColorLayer = nullptr;
Valerie Haudd0b7572019-01-29 14:59:27 -0800865 return true;
866 }
867
Robert Carr6a160312021-05-17 12:08:20 -0700868 mDrawingState.bgColorLayer->setColor(color);
869 mDrawingState.bgColorLayer->setLayer(std::numeric_limits<int32_t>::min());
870 mDrawingState.bgColorLayer->setAlpha(alpha);
871 mDrawingState.bgColorLayer->setDataspace(dataspace);
Valerie Haudd0b7572019-01-29 14:59:27 -0800872
chaviw13fdc492017-06-27 12:40:18 -0700873 return true;
874}
875
Lucas Dupin1b6531c2018-07-05 17:18:21 -0700876bool Layer::setCornerRadius(float cornerRadius) {
Robert Carr6a160312021-05-17 12:08:20 -0700877 if (mDrawingState.cornerRadius == cornerRadius) return false;
Lucas Dupin1b6531c2018-07-05 17:18:21 -0700878
Robert Carr6a160312021-05-17 12:08:20 -0700879 mDrawingState.sequence++;
880 mDrawingState.cornerRadius = cornerRadius;
881 mDrawingState.modified = true;
Lucas Dupin1b6531c2018-07-05 17:18:21 -0700882 setTransactionFlags(eTransactionNeeded);
883 return true;
884}
885
Lucas Dupin19c8f0e2019-11-25 17:55:44 -0800886bool Layer::setBackgroundBlurRadius(int backgroundBlurRadius) {
Robert Carr6a160312021-05-17 12:08:20 -0700887 if (mDrawingState.backgroundBlurRadius == backgroundBlurRadius) return false;
Vishnu Nairb801a982021-11-02 15:12:08 -0700888 // If we start or stop drawing blur then the layer's visibility state may change so increment
889 // the magic sequence number.
890 if (mDrawingState.backgroundBlurRadius == 0 || backgroundBlurRadius == 0) {
891 mDrawingState.sequence++;
892 }
Robert Carr6a160312021-05-17 12:08:20 -0700893 mDrawingState.backgroundBlurRadius = backgroundBlurRadius;
894 mDrawingState.modified = true;
Lucas Dupin19c8f0e2019-11-25 17:55:44 -0800895 setTransactionFlags(eTransactionNeeded);
896 return true;
897}
Marissa Wall61c58622018-07-18 10:12:20 -0700898
Mathias Agopian13127d82013-03-05 17:47:11 -0800899bool Layer::setTransparentRegionHint(const Region& transparent) {
Vishnu Nairea04b6f2022-08-19 21:28:17 +0000900 mDrawingState.sequence++;
901 mDrawingState.transparentRegionHint = transparent;
Robert Carr6a160312021-05-17 12:08:20 -0700902 mDrawingState.modified = true;
Mathias Agopian13127d82013-03-05 17:47:11 -0800903 setTransactionFlags(eTransactionNeeded);
904 return true;
905}
Ana Krulecc84d09b2019-11-02 23:10:29 +0100906
Lucas Dupinc3800b82020-10-02 16:24:48 -0700907bool Layer::setBlurRegions(const std::vector<BlurRegion>& blurRegions) {
Vishnu Nairb801a982021-11-02 15:12:08 -0700908 // If we start or stop drawing blur then the layer's visibility state may change so increment
909 // the magic sequence number.
910 if (mDrawingState.blurRegions.size() == 0 || blurRegions.size() == 0) {
911 mDrawingState.sequence++;
912 }
Robert Carr6a160312021-05-17 12:08:20 -0700913 mDrawingState.blurRegions = blurRegions;
914 mDrawingState.modified = true;
Lucas Dupinc3800b82020-10-02 16:24:48 -0700915 setTransactionFlags(eTransactionNeeded);
916 return true;
917}
918
Vishnu Nairf6eddb62021-01-27 22:02:11 -0800919bool Layer::setFlags(uint32_t flags, uint32_t mask) {
Robert Carr6a160312021-05-17 12:08:20 -0700920 const uint32_t newFlags = (mDrawingState.flags & ~mask) | (flags & mask);
921 if (mDrawingState.flags == newFlags) return false;
922 mDrawingState.sequence++;
923 mDrawingState.flags = newFlags;
924 mDrawingState.modified = true;
Mathias Agopian13127d82013-03-05 17:47:11 -0800925 setTransactionFlags(eTransactionNeeded);
926 return true;
927}
Robert Carr99e27f02016-06-16 15:18:02 -0700928
chaviw25714502021-02-11 10:01:08 -0800929bool Layer::setCrop(const Rect& crop) {
Vishnu Nairea04b6f2022-08-19 21:28:17 +0000930 if (mDrawingState.crop == crop) return false;
Robert Carr6a160312021-05-17 12:08:20 -0700931 mDrawingState.sequence++;
Robert Carr6a160312021-05-17 12:08:20 -0700932 mDrawingState.crop = crop;
Robert Carr7bf247e2017-05-18 14:02:49 -0700933
Robert Carr6a160312021-05-17 12:08:20 -0700934 mDrawingState.modified = true;
Mathias Agopian13127d82013-03-05 17:47:11 -0800935 setTransactionFlags(eTransactionNeeded);
936 return true;
937}
Robert Carr8d5227b2017-03-16 15:41:03 -0700938
Evan Roskyef876c92019-01-25 17:46:06 -0800939bool Layer::setMetadata(const LayerMetadata& data) {
Robert Carr6a160312021-05-17 12:08:20 -0700940 if (!mDrawingState.metadata.merge(data, true /* eraseEmpty */)) return false;
941 mDrawingState.modified = true;
David Sodman41fdfc92017-11-06 16:09:56 -0800942 setTransactionFlags(eTransactionNeeded);
Evan Rosky1f6d6d52018-12-06 10:47:26 -0800943 return true;
Daniel Nicoara2f5f8a52016-12-20 16:11:58 -0500944}
945
Dominik Laskowski29fa1462021-04-27 15:51:50 -0700946bool Layer::setLayerStack(ui::LayerStack layerStack) {
Robert Carr6a160312021-05-17 12:08:20 -0700947 if (mDrawingState.layerStack == layerStack) return false;
948 mDrawingState.sequence++;
949 mDrawingState.layerStack = layerStack;
950 mDrawingState.modified = true;
Mathias Agopian13127d82013-03-05 17:47:11 -0800951 setTransactionFlags(eTransactionNeeded);
952 return true;
Mathias Agopiana67932f2011-04-20 14:20:59 -0700953}
954
Peiyong Linc502cb72019-03-01 15:00:23 -0800955bool Layer::setColorSpaceAgnostic(const bool agnostic) {
Robert Carr6a160312021-05-17 12:08:20 -0700956 if (mDrawingState.colorSpaceAgnostic == agnostic) {
Peiyong Linc502cb72019-03-01 15:00:23 -0800957 return false;
958 }
Robert Carr6a160312021-05-17 12:08:20 -0700959 mDrawingState.sequence++;
960 mDrawingState.colorSpaceAgnostic = agnostic;
961 mDrawingState.modified = true;
Peiyong Linc502cb72019-03-01 15:00:23 -0800962 setTransactionFlags(eTransactionNeeded);
963 return true;
964}
965
Sally Qi81d95e62022-03-21 19:41:33 -0700966bool Layer::setDimmingEnabled(const bool dimmingEnabled) {
967 if (mDrawingState.dimmingEnabled == dimmingEnabled) return false;
968
969 mDrawingState.sequence++;
970 mDrawingState.dimmingEnabled = dimmingEnabled;
971 mDrawingState.modified = true;
972 setTransactionFlags(eTransactionNeeded);
973 return true;
974}
975
Ana Krulecc84d09b2019-11-02 23:10:29 +0100976bool Layer::setFrameRateSelectionPriority(int32_t priority) {
Robert Carr6a160312021-05-17 12:08:20 -0700977 if (mDrawingState.frameRateSelectionPriority == priority) return false;
978 mDrawingState.frameRateSelectionPriority = priority;
979 mDrawingState.sequence++;
980 mDrawingState.modified = true;
Ana Krulecc84d09b2019-11-02 23:10:29 +0100981 setTransactionFlags(eTransactionNeeded);
982 return true;
983}
984
985int32_t Layer::getFrameRateSelectionPriority() const {
986 // Check if layer has priority set.
987 if (mDrawingState.frameRateSelectionPriority != PRIORITY_UNSET) {
988 return mDrawingState.frameRateSelectionPriority;
989 }
990 // If not, search whether its parents have it set.
Rob Carrc6d2d2b2021-10-25 16:51:49 +0000991 sp<Layer> parent = getParent();
Ana Krulecc84d09b2019-11-02 23:10:29 +0100992 if (parent != nullptr) {
993 return parent->getFrameRateSelectionPriority();
994 }
995
996 return Layer::PRIORITY_UNSET;
997}
998
Andy Labrada096227e2022-06-15 16:58:11 +0000999bool Layer::setDefaultFrameRateCompatibility(FrameRateCompatibility compatibility) {
1000 if (mDrawingState.defaultFrameRateCompatibility == compatibility) return false;
1001 mDrawingState.defaultFrameRateCompatibility = compatibility;
1002 mDrawingState.modified = true;
1003 mFlinger->mScheduler->setDefaultFrameRateCompatibility(this);
1004 setTransactionFlags(eTransactionNeeded);
1005 return true;
1006}
1007
1008scheduler::LayerInfo::FrameRateCompatibility Layer::getDefaultFrameRateCompatibility() const {
1009 return mDrawingState.defaultFrameRateCompatibility;
1010}
1011
Ady Abrahamaae5ed52020-06-26 09:32:43 -07001012bool Layer::isLayerFocusedBasedOnPriority(int32_t priority) {
1013 return priority == PRIORITY_FOCUSED_WITH_MODE || priority == PRIORITY_FOCUSED_WITHOUT_MODE;
1014};
1015
Dominik Laskowski29fa1462021-04-27 15:51:50 -07001016ui::LayerStack Layer::getLayerStack() const {
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001017 if (const auto parent = mDrawingParent.promote()) {
1018 return parent->getLayerStack();
Robert Carr1f0a16a2016-10-24 16:27:39 -07001019 }
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001020 return getDrawingState().layerStack;
Robert Carr1f0a16a2016-10-24 16:27:39 -07001021}
1022
Vishnu Nairc97b8db2019-10-29 18:19:35 -07001023bool Layer::setShadowRadius(float shadowRadius) {
Robert Carr6a160312021-05-17 12:08:20 -07001024 if (mDrawingState.shadowRadius == shadowRadius) {
Vishnu Nairc97b8db2019-10-29 18:19:35 -07001025 return false;
1026 }
1027
Robert Carr6a160312021-05-17 12:08:20 -07001028 mDrawingState.sequence++;
1029 mDrawingState.shadowRadius = shadowRadius;
1030 mDrawingState.modified = true;
Vishnu Nairc97b8db2019-10-29 18:19:35 -07001031 setTransactionFlags(eTransactionNeeded);
1032 return true;
1033}
1034
Vishnu Nair6213bd92020-05-08 17:42:25 -07001035bool Layer::setFixedTransformHint(ui::Transform::RotationFlags fixedTransformHint) {
Robert Carr6a160312021-05-17 12:08:20 -07001036 if (mDrawingState.fixedTransformHint == fixedTransformHint) {
Vishnu Nair6213bd92020-05-08 17:42:25 -07001037 return false;
1038 }
1039
Robert Carr6a160312021-05-17 12:08:20 -07001040 mDrawingState.sequence++;
1041 mDrawingState.fixedTransformHint = fixedTransformHint;
1042 mDrawingState.modified = true;
Vishnu Nair6213bd92020-05-08 17:42:25 -07001043 setTransactionFlags(eTransactionNeeded);
1044 return true;
1045}
1046
John Reckcdb4ed72021-02-04 13:39:33 -05001047bool Layer::setStretchEffect(const StretchEffect& effect) {
1048 StretchEffect temp = effect;
1049 temp.sanitize();
Robert Carr6a160312021-05-17 12:08:20 -07001050 if (mDrawingState.stretchEffect == temp) {
John Reckcdb4ed72021-02-04 13:39:33 -05001051 return false;
1052 }
Robert Carr6a160312021-05-17 12:08:20 -07001053 mDrawingState.sequence++;
1054 mDrawingState.stretchEffect = temp;
1055 mDrawingState.modified = true;
John Reckcdb4ed72021-02-04 13:39:33 -05001056 setTransactionFlags(eTransactionNeeded);
1057 return true;
1058}
1059
John Reckc00c6692021-02-16 11:37:33 -05001060StretchEffect Layer::getStretchEffect() const {
1061 if (mDrawingState.stretchEffect.hasEffect()) {
1062 return mDrawingState.stretchEffect;
1063 }
1064
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001065 sp<Layer> parent = getParent();
John Reckc00c6692021-02-16 11:37:33 -05001066 if (parent != nullptr) {
1067 auto effect = parent->getStretchEffect();
1068 if (effect.hasEffect()) {
1069 // TODO(b/179047472): Map it? Or do we make the effect be in global space?
1070 return effect;
1071 }
1072 }
1073 return StretchEffect{};
1074}
1075
Tianhao Yao10cea3c2022-03-30 01:37:22 +00001076bool Layer::enableBorder(bool shouldEnable, float width, const half4& color) {
1077 if (mBorderEnabled == shouldEnable && mBorderWidth == width && mBorderColor == color) {
Tianhao Yao67dd7122022-02-22 17:48:33 +00001078 return false;
1079 }
1080 mBorderEnabled = shouldEnable;
Tianhao Yao10cea3c2022-03-30 01:37:22 +00001081 mBorderWidth = width;
1082 mBorderColor = color;
Tianhao Yao67dd7122022-02-22 17:48:33 +00001083 return true;
1084}
1085
1086bool Layer::isBorderEnabled() {
1087 return mBorderEnabled;
1088}
1089
Tianhao Yao10cea3c2022-03-30 01:37:22 +00001090float Layer::getBorderWidth() {
1091 return mBorderWidth;
1092}
1093
1094const half4& Layer::getBorderColor() {
1095 return mBorderColor;
1096}
1097
Ady Abrahama850c182021-08-04 13:04:37 -07001098bool Layer::propagateFrameRateForLayerTree(FrameRate parentFrameRate, bool* transactionNeeded) {
1099 // The frame rate for layer tree is this layer's frame rate if present, or the parent frame rate
1100 const auto frameRate = [&] {
1101 if (mDrawingState.frameRate.rate.isValid() ||
1102 mDrawingState.frameRate.type == FrameRateCompatibility::NoVote) {
1103 return mDrawingState.frameRate;
1104 }
1105
1106 return parentFrameRate;
1107 }();
1108
1109 *transactionNeeded |= setFrameRateForLayerTree(frameRate);
1110
1111 // The frame rate is propagated to the children
1112 bool childrenHaveFrameRate = false;
1113 for (const sp<Layer>& child : mCurrentChildren) {
1114 childrenHaveFrameRate |=
1115 child->propagateFrameRateForLayerTree(frameRate, transactionNeeded);
1116 }
1117
1118 // If we don't have a valid frame rate, but the children do, we set this
1119 // layer as NoVote to allow the children to control the refresh rate
1120 if (!frameRate.rate.isValid() && frameRate.type != FrameRateCompatibility::NoVote &&
1121 childrenHaveFrameRate) {
1122 *transactionNeeded |=
Dominik Laskowski6eab42d2021-09-13 14:34:13 -07001123 setFrameRateForLayerTree(FrameRate(Fps(), FrameRateCompatibility::NoVote));
Ady Abrahama850c182021-08-04 13:04:37 -07001124 }
1125
1126 // We return whether this layer ot its children has a vote. We ignore ExactOrMultiple votes for
1127 // the same reason we are allowing touch boost for those layers. See
1128 // RefreshRateConfigs::getBestRefreshRate for more details.
1129 const auto layerVotedWithDefaultCompatibility =
1130 frameRate.rate.isValid() && frameRate.type == FrameRateCompatibility::Default;
1131 const auto layerVotedWithNoVote = frameRate.type == FrameRateCompatibility::NoVote;
1132 const auto layerVotedWithExactCompatibility =
1133 frameRate.rate.isValid() && frameRate.type == FrameRateCompatibility::Exact;
1134 return layerVotedWithDefaultCompatibility || layerVotedWithNoVote ||
1135 layerVotedWithExactCompatibility || childrenHaveFrameRate;
1136}
1137
Ady Abraham60e42ea2020-03-09 19:17:31 -07001138void Layer::updateTreeHasFrameRateVote() {
Ady Abrahama850c182021-08-04 13:04:37 -07001139 const auto root = [&]() -> sp<Layer> {
Ady Abrahamd11bade2022-08-01 16:18:03 -07001140 sp<Layer> layer = sp<Layer>::fromExisting(this);
Ady Abrahama850c182021-08-04 13:04:37 -07001141 while (auto parent = layer->getParent()) {
1142 layer = parent;
Ady Abraham60e42ea2020-03-09 19:17:31 -07001143 }
Ady Abrahama850c182021-08-04 13:04:37 -07001144 return layer;
1145 }();
Ady Abraham60e42ea2020-03-09 19:17:31 -07001146
Ady Abraham60e42ea2020-03-09 19:17:31 -07001147 bool transactionNeeded = false;
Ady Abrahama850c182021-08-04 13:04:37 -07001148 root->propagateFrameRateForLayerTree({}, &transactionNeeded);
Robert Carr6a160312021-05-17 12:08:20 -07001149
Ady Abrahama850c182021-08-04 13:04:37 -07001150 // TODO(b/195668952): we probably don't need eTraversalNeeded here
Ady Abraham60e42ea2020-03-09 19:17:31 -07001151 if (transactionNeeded) {
1152 mFlinger->setTransactionFlags(eTraversalNeeded);
1153 }
1154}
1155
Ady Abraham71c437d2020-01-31 15:56:57 -08001156bool Layer::setFrameRate(FrameRate frameRate) {
Robert Carr6a160312021-05-17 12:08:20 -07001157 if (mDrawingState.frameRate == frameRate) {
Steven Thomas3172e202020-01-06 19:25:30 -08001158 return false;
1159 }
1160
Robert Carr6a160312021-05-17 12:08:20 -07001161 mDrawingState.sequence++;
1162 mDrawingState.frameRate = frameRate;
1163 mDrawingState.modified = true;
Ady Abraham60e42ea2020-03-09 19:17:31 -07001164
1165 updateTreeHasFrameRateVote();
1166
Steven Thomas3172e202020-01-06 19:25:30 -08001167 setTransactionFlags(eTransactionNeeded);
1168 return true;
1169}
1170
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001171void Layer::setFrameTimelineVsyncForBufferTransaction(const FrameTimelineInfo& info,
1172 nsecs_t postTime) {
Robert Carr6a160312021-05-17 12:08:20 -07001173 mDrawingState.postTime = postTime;
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001174
1175 // Check if one of the bufferlessSurfaceFramesTX contains the same vsyncId. This can happen if
1176 // there are two transactions with the same token, the first one without a buffer and the
1177 // second one with a buffer. We promote the bufferlessSurfaceFrame to a bufferSurfaceFrameTX
1178 // in that case.
Robert Carr6a160312021-05-17 12:08:20 -07001179 auto it = mDrawingState.bufferlessSurfaceFramesTX.find(info.vsyncId);
1180 if (it != mDrawingState.bufferlessSurfaceFramesTX.end()) {
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001181 // Promote the bufferlessSurfaceFrame to a bufferSurfaceFrameTX
Robert Carr6a160312021-05-17 12:08:20 -07001182 mDrawingState.bufferSurfaceFrameTX = it->second;
1183 mDrawingState.bufferlessSurfaceFramesTX.erase(it);
1184 mDrawingState.bufferSurfaceFrameTX->promoteToBuffer();
1185 mDrawingState.bufferSurfaceFrameTX->setActualQueueTime(postTime);
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001186 } else {
Robert Carr6a160312021-05-17 12:08:20 -07001187 mDrawingState.bufferSurfaceFrameTX =
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001188 createSurfaceFrameForBuffer(info, postTime, mTransactionName);
1189 }
1190}
1191
1192void Layer::setFrameTimelineVsyncForBufferlessTransaction(const FrameTimelineInfo& info,
1193 nsecs_t postTime) {
Robert Carr6a160312021-05-17 12:08:20 -07001194 mDrawingState.frameTimelineInfo = info;
1195 mDrawingState.postTime = postTime;
1196 mDrawingState.modified = true;
Ady Abraham22c7b5c2020-09-22 19:33:40 -07001197 setTransactionFlags(eTransactionNeeded);
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001198
Robert Carr6a160312021-05-17 12:08:20 -07001199 if (const auto& bufferSurfaceFrameTX = mDrawingState.bufferSurfaceFrameTX;
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001200 bufferSurfaceFrameTX != nullptr) {
1201 if (bufferSurfaceFrameTX->getToken() == info.vsyncId) {
1202 // BufferSurfaceFrame takes precedence over BufferlessSurfaceFrame. If the same token is
1203 // being used for BufferSurfaceFrame, don't create a new one.
1204 return;
1205 }
1206 }
1207 // For Transactions without a buffer, we create only one SurfaceFrame per vsyncId. If multiple
1208 // transactions use the same vsyncId, we just treat them as one SurfaceFrame (unless they are
1209 // targeting different vsyncs).
Robert Carr6a160312021-05-17 12:08:20 -07001210 auto it = mDrawingState.bufferlessSurfaceFramesTX.find(info.vsyncId);
1211 if (it == mDrawingState.bufferlessSurfaceFramesTX.end()) {
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001212 auto surfaceFrame = createSurfaceFrameForTransaction(info, postTime);
Robert Carr6a160312021-05-17 12:08:20 -07001213 mDrawingState.bufferlessSurfaceFramesTX[info.vsyncId] = surfaceFrame;
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001214 } else {
1215 if (it->second->getPresentState() == PresentState::Presented) {
1216 // If the SurfaceFrame was already presented, its safe to overwrite it since it must
1217 // have been from previous vsync.
1218 it->second = createSurfaceFrameForTransaction(info, postTime);
1219 }
1220 }
1221}
1222
1223void Layer::addSurfaceFrameDroppedForBuffer(
1224 std::shared_ptr<frametimeline::SurfaceFrame>& surfaceFrame) {
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001225 surfaceFrame->setDropTime(systemTime());
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001226 surfaceFrame->setPresentState(PresentState::Dropped);
1227 mFlinger->mFrameTimeline->addSurfaceFrame(surfaceFrame);
1228}
1229
1230void Layer::addSurfaceFramePresentedForBuffer(
1231 std::shared_ptr<frametimeline::SurfaceFrame>& surfaceFrame, nsecs_t acquireFenceTime,
1232 nsecs_t currentLatchTime) {
1233 surfaceFrame->setAcquireFenceTime(acquireFenceTime);
1234 surfaceFrame->setPresentState(PresentState::Presented, mLastLatchTime);
1235 mFlinger->mFrameTimeline->addSurfaceFrame(surfaceFrame);
1236 mLastLatchTime = currentLatchTime;
1237}
1238
1239std::shared_ptr<frametimeline::SurfaceFrame> Layer::createSurfaceFrameForTransaction(
1240 const FrameTimelineInfo& info, nsecs_t postTime) {
1241 auto surfaceFrame =
Alec Mouriadebf5c2021-01-05 12:57:36 -08001242 mFlinger->mFrameTimeline->createSurfaceFrameForToken(info, mOwnerPid, mOwnerUid,
1243 getSequence(), mName,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001244 mTransactionName,
Adithya Srinivasan58069dc2021-06-04 20:37:02 +00001245 /*isBuffer*/ false, getGameMode());
Rachel Leeed511ef2021-10-11 15:09:51 -07001246 surfaceFrame->setActualStartTime(info.startTimeNanos);
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001247 // For Transactions, the post time is considered to be both queue and acquire fence time.
1248 surfaceFrame->setActualQueueTime(postTime);
1249 surfaceFrame->setAcquireFenceTime(postTime);
Alec Mouri7d436ec2021-01-27 20:40:50 -08001250 const auto fps = mFlinger->mScheduler->getFrameRateOverride(getOwnerUid());
1251 if (fps) {
Alec Mouri819f6302021-02-12 15:37:21 -08001252 surfaceFrame->setRenderRate(*fps);
Alec Mouri7d436ec2021-01-27 20:40:50 -08001253 }
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001254 onSurfaceFrameCreated(surfaceFrame);
1255 return surfaceFrame;
1256}
1257
1258std::shared_ptr<frametimeline::SurfaceFrame> Layer::createSurfaceFrameForBuffer(
1259 const FrameTimelineInfo& info, nsecs_t queueTime, std::string debugName) {
1260 auto surfaceFrame =
Alec Mouriadebf5c2021-01-05 12:57:36 -08001261 mFlinger->mFrameTimeline->createSurfaceFrameForToken(info, mOwnerPid, mOwnerUid,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001262 getSequence(), mName, debugName,
Adithya Srinivasan58069dc2021-06-04 20:37:02 +00001263 /*isBuffer*/ true, getGameMode());
Rachel Leeed511ef2021-10-11 15:09:51 -07001264 surfaceFrame->setActualStartTime(info.startTimeNanos);
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001265 // For buffers, acquire fence time will set during latch.
1266 surfaceFrame->setActualQueueTime(queueTime);
Alec Mouri7d436ec2021-01-27 20:40:50 -08001267 const auto fps = mFlinger->mScheduler->getFrameRateOverride(getOwnerUid());
1268 if (fps) {
Alec Mouri819f6302021-02-12 15:37:21 -08001269 surfaceFrame->setRenderRate(*fps);
Alec Mouri7d436ec2021-01-27 20:40:50 -08001270 }
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001271 // TODO(b/178542907): Implement onSurfaceFrameCreated for BQLayer as well.
1272 onSurfaceFrameCreated(surfaceFrame);
1273 return surfaceFrame;
Ady Abraham74e17562020-08-24 18:18:19 -07001274}
1275
Ady Abrahama850c182021-08-04 13:04:37 -07001276bool Layer::setFrameRateForLayerTree(FrameRate frameRate) {
1277 if (mDrawingState.frameRateForLayerTree == frameRate) {
1278 return false;
Ady Abraham60e42ea2020-03-09 19:17:31 -07001279 }
1280
Ady Abrahama850c182021-08-04 13:04:37 -07001281 mDrawingState.frameRateForLayerTree = frameRate;
Ady Abrahamf467f892020-07-31 16:01:53 -07001282
Ady Abrahama850c182021-08-04 13:04:37 -07001283 // TODO(b/195668952): we probably don't need to dirty visible regions here
1284 // or even store frameRateForLayerTree in mDrawingState
1285 mDrawingState.sequence++;
1286 mDrawingState.modified = true;
1287 setTransactionFlags(eTransactionNeeded);
Ady Abraham60e42ea2020-03-09 19:17:31 -07001288
Dominik Laskowski068173d2021-08-11 17:22:59 -07001289 using LayerUpdateType = scheduler::LayerHistory::LayerUpdateType;
1290 mFlinger->mScheduler->recordLayerHistory(this, systemTime(), LayerUpdateType::SetFrameRate);
Ady Abrahama850c182021-08-04 13:04:37 -07001291
1292 return true;
Steven Thomas3172e202020-01-06 19:25:30 -08001293}
1294
Ady Abraham59fd8ff2021-04-15 20:13:30 -07001295Layer::FrameRate Layer::getFrameRateForLayerTree() const {
1296 return getDrawingState().frameRateForLayerTree;
1297}
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -08001298
Robert Carr1f0a16a2016-10-24 16:27:39 -07001299bool Layer::isHiddenByPolicy() const {
Lloyd Pique0449b0f2018-12-20 16:23:45 -08001300 const State& s(mDrawingState);
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001301 const auto& parent = mDrawingParent.promote();
Robert Carr1f0a16a2016-10-24 16:27:39 -07001302 if (parent != nullptr && parent->isHiddenByPolicy()) {
1303 return true;
1304 }
Robert Carr1c5481e2019-07-01 14:42:27 -07001305 if (usingRelativeZ(LayerVector::StateSet::Drawing)) {
1306 auto zOrderRelativeOf = mDrawingState.zOrderRelativeOf.promote();
1307 if (zOrderRelativeOf != nullptr) {
1308 if (zOrderRelativeOf->isHiddenByPolicy()) {
1309 return true;
1310 }
1311 }
1312 }
Garfield Tan2c1782c2022-02-16 15:25:05 -08001313 if (CC_UNLIKELY(!isTransformValid())) {
1314 ALOGW("Hide layer %s because it has invalid transformation.", getDebugName());
1315 return true;
1316 }
Robert Carr1f0a16a2016-10-24 16:27:39 -07001317 return s.flags & layer_state_t::eLayerHidden;
1318}
1319
David Sodman41fdfc92017-11-06 16:09:56 -08001320uint32_t Layer::getEffectiveUsage(uint32_t usage) const {
Mathias Agopiana67932f2011-04-20 14:20:59 -07001321 // TODO: should we do something special if mSecure is set?
1322 if (mProtectedByApp) {
1323 // need a hardware-protected path to external video sink
1324 usage |= GraphicBuffer::USAGE_PROTECTED;
Jamie Gennis54cc83e2010-11-02 11:51:32 -07001325 }
Riley Andrews03414a12014-07-01 14:22:59 -07001326 if (mPotentialCursor) {
1327 usage |= GraphicBuffer::USAGE_CURSOR;
1328 }
Jamie Gennis3599bf22011-08-10 11:48:07 -07001329 usage |= GraphicBuffer::USAGE_HW_COMPOSER;
Mathias Agopiana67932f2011-04-20 14:20:59 -07001330 return usage;
Mathias Agopianb5b7f262010-05-07 15:58:44 -07001331}
1332
Dominik Laskowskib7251f42020-04-20 17:42:59 -07001333void Layer::updateTransformHint(ui::Transform::RotationFlags transformHint) {
1334 if (mFlinger->mDebugDisableTransformHint || transformHint & ui::Transform::ROT_INVALID) {
1335 transformHint = ui::Transform::ROT_0;
Mathias Agopiana4583642011-08-23 18:03:18 -07001336 }
Dominik Laskowskib7251f42020-04-20 17:42:59 -07001337
Vishnu Nair6213bd92020-05-08 17:42:25 -07001338 setTransformHint(transformHint);
Mathias Agopiana4583642011-08-23 18:03:18 -07001339}
1340
Mathias Agopian13127d82013-03-05 17:47:11 -08001341// ----------------------------------------------------------------------------
1342// debugging
1343// ----------------------------------------------------------------------------
1344
Marissa Wall61c58622018-07-18 10:12:20 -07001345// TODO(marissaw): add new layer state info to layer debugging
Huihong Luo05539a12022-02-23 10:29:40 -08001346gui::LayerDebugInfo Layer::getLayerDebugInfo(const DisplayDevice* display) const {
Dominik Laskowski87a07e42019-10-10 20:38:02 -07001347 using namespace std::string_literals;
1348
Huihong Luo05539a12022-02-23 10:29:40 -08001349 gui::LayerDebugInfo info;
Alec Mourib416efd2018-09-06 21:01:59 +00001350 const State& ds = getDrawingState();
Kalle Raitaa099a242017-01-11 11:17:29 -08001351 info.mName = getName();
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001352 sp<Layer> parent = mDrawingParent.promote();
Dominik Laskowski87a07e42019-10-10 20:38:02 -07001353 info.mParentName = parent ? parent->getName() : "none"s;
chaviw8a01fa42019-08-19 12:39:31 -07001354 info.mType = getType();
Lloyd Piquea2468662019-03-07 21:31:06 -08001355
Dominik Laskowskib7251f42020-04-20 17:42:59 -07001356 info.mVisibleRegion = getVisibleRegion(display);
Kalle Raitaa099a242017-01-11 11:17:29 -08001357 info.mSurfaceDamageRegion = surfaceDamageRegion;
Dominik Laskowski29fa1462021-04-27 15:51:50 -07001358 info.mLayerStack = getLayerStack().id;
chaviw4e765532021-04-30 12:11:39 -05001359 info.mX = ds.transform.tx();
1360 info.mY = ds.transform.ty();
Kalle Raitaa099a242017-01-11 11:17:29 -08001361 info.mZ = ds.z;
chaviw25714502021-02-11 10:01:08 -08001362 info.mCrop = ds.crop;
chaviw13fdc492017-06-27 12:40:18 -07001363 info.mColor = ds.color;
Kalle Raitaa099a242017-01-11 11:17:29 -08001364 info.mFlags = ds.flags;
1365 info.mPixelFormat = getPixelFormat();
chaviw4244e032019-09-04 11:27:49 -07001366 info.mDataSpace = static_cast<android_dataspace>(getDataSpace());
chaviw4e765532021-04-30 12:11:39 -05001367 info.mMatrix[0][0] = ds.transform[0][0];
1368 info.mMatrix[0][1] = ds.transform[0][1];
1369 info.mMatrix[1][0] = ds.transform[1][0];
1370 info.mMatrix[1][1] = ds.transform[1][1];
Kalle Raitaa099a242017-01-11 11:17:29 -08001371 {
chaviwd62d3062019-09-04 14:48:02 -07001372 sp<const GraphicBuffer> buffer = getBuffer();
David Sodman5b4cffc2017-11-23 13:20:29 -08001373 if (buffer != 0) {
1374 info.mActiveBufferWidth = buffer->getWidth();
1375 info.mActiveBufferHeight = buffer->getHeight();
1376 info.mActiveBufferStride = buffer->getStride();
1377 info.mActiveBufferFormat = buffer->format;
Kalle Raitaa099a242017-01-11 11:17:29 -08001378 } else {
1379 info.mActiveBufferWidth = 0;
1380 info.mActiveBufferHeight = 0;
1381 info.mActiveBufferStride = 0;
1382 info.mActiveBufferFormat = 0;
1383 }
Mathias Agopian13127d82013-03-05 17:47:11 -08001384 }
Kalle Raitaa099a242017-01-11 11:17:29 -08001385 info.mNumQueuedFrames = getQueuedFrameCount();
Kalle Raitaa099a242017-01-11 11:17:29 -08001386 info.mIsOpaque = isOpaque(ds);
1387 info.mContentDirty = contentDirty;
John Reckc00c6692021-02-16 11:37:33 -05001388 info.mStretchEffect = getStretchEffect();
Kalle Raitaa099a242017-01-11 11:17:29 -08001389 return info;
Mathias Agopian13127d82013-03-05 17:47:11 -08001390}
Chia-I Wu83ce7c12017-10-19 15:18:55 -07001391
Yiwei Zhang5434a782018-12-05 18:06:32 -08001392void Layer::miniDumpHeader(std::string& result) {
Marin Shalamanov1876e2e2020-12-04 13:23:59 +01001393 result.append(kDumpTableRowLength, '-');
1394 result.append("\n");
Dan Stozae22aec72016-08-01 13:20:59 -07001395 result.append(" Layer name\n");
1396 result.append(" Z | ");
Ady Abraham8f1ee7f2019-04-05 10:32:50 -07001397 result.append(" Window Type | ");
Dan Stozae22aec72016-08-01 13:20:59 -07001398 result.append(" Comp Type | ");
Yichi Chen6ca35192018-05-29 12:20:43 +08001399 result.append(" Transform | ");
Dan Stozae22aec72016-08-01 13:20:59 -07001400 result.append(" Disp Frame (LTRB) | ");
Ady Abrahambe23e6a2020-05-04 14:51:16 -07001401 result.append(" Source Crop (LTRB) | ");
Marin Shalamanov1876e2e2020-12-04 13:23:59 +01001402 result.append(" Frame Rate (Explicit) (Seamlessness) [Focused]\n");
1403 result.append(kDumpTableRowLength, '-');
1404 result.append("\n");
Ady Abrahambe23e6a2020-05-04 14:51:16 -07001405}
1406
Dominik Laskowskib7251f42020-04-20 17:42:59 -07001407void Layer::miniDump(std::string& result, const DisplayDevice& display) const {
1408 const auto outputLayer = findOutputLayerForDisplay(&display);
Lloyd Pique37c2c9b2018-12-04 17:25:10 -08001409 if (!outputLayer) {
Dan Stozae22aec72016-08-01 13:20:59 -07001410 return;
1411 }
1412
Yiwei Zhang5434a782018-12-05 18:06:32 -08001413 std::string name;
Dan Stozae22aec72016-08-01 13:20:59 -07001414 if (mName.length() > 77) {
1415 std::string shortened;
Dominik Laskowski87a07e42019-10-10 20:38:02 -07001416 shortened.append(mName, 0, 36);
Dan Stozae22aec72016-08-01 13:20:59 -07001417 shortened.append("[...]");
Dominik Laskowski87a07e42019-10-10 20:38:02 -07001418 shortened.append(mName, mName.length() - 36);
1419 name = std::move(shortened);
Dan Stozae22aec72016-08-01 13:20:59 -07001420 } else {
Dominik Laskowski87a07e42019-10-10 20:38:02 -07001421 name = mName;
Dan Stozae22aec72016-08-01 13:20:59 -07001422 }
1423
Yiwei Zhang5434a782018-12-05 18:06:32 -08001424 StringAppendF(&result, " %s\n", name.c_str());
Dan Stozae22aec72016-08-01 13:20:59 -07001425
Alec Mourib416efd2018-09-06 21:01:59 +00001426 const State& layerState(getDrawingState());
Lloyd Piquede196652020-01-22 17:29:58 -08001427 const auto& outputLayerState = outputLayer->getState();
Lloyd Pique37c2c9b2018-12-04 17:25:10 -08001428
Chia-I Wu1e043612018-03-01 09:45:09 -08001429 if (layerState.zOrderRelativeOf != nullptr || mDrawingParent != nullptr) {
Yiwei Zhang5434a782018-12-05 18:06:32 -08001430 StringAppendF(&result, " rel %6d | ", layerState.z);
Chia-I Wu1e043612018-03-01 09:45:09 -08001431 } else {
Yiwei Zhang5434a782018-12-05 18:06:32 -08001432 StringAppendF(&result, " %10d | ", layerState.z);
Chia-I Wu1e043612018-03-01 09:45:09 -08001433 }
Ady Abraham8f1ee7f2019-04-05 10:32:50 -07001434 StringAppendF(&result, " %10d | ", mWindowType);
Dominik Laskowskib7251f42020-04-20 17:42:59 -07001435 StringAppendF(&result, "%10s | ", toString(getCompositionType(display)).c_str());
Lloyd Piquede196652020-01-22 17:29:58 -08001436 StringAppendF(&result, "%10s | ", toString(outputLayerState.bufferTransform).c_str());
1437 const Rect& frame = outputLayerState.displayFrame;
Yiwei Zhang5434a782018-12-05 18:06:32 -08001438 StringAppendF(&result, "%4d %4d %4d %4d | ", frame.left, frame.top, frame.right, frame.bottom);
Lloyd Piquede196652020-01-22 17:29:58 -08001439 const FloatRect& crop = outputLayerState.sourceCrop;
Ady Abrahambe23e6a2020-05-04 14:51:16 -07001440 StringAppendF(&result, "%6.1f %6.1f %6.1f %6.1f | ", crop.left, crop.top, crop.right,
Yiwei Zhang5434a782018-12-05 18:06:32 -08001441 crop.bottom);
Ady Abrahamf467f892020-07-31 16:01:53 -07001442 const auto frameRate = getFrameRateForLayerTree();
1443 if (frameRate.rate.isValid() || frameRate.type != FrameRateCompatibility::Default) {
1444 StringAppendF(&result, "%s %15s %17s", to_string(frameRate.rate).c_str(),
Dominik Laskowskif5d0ea52021-09-26 17:27:01 -07001445 ftl::enum_string(frameRate.type).c_str(),
1446 ftl::enum_string(frameRate.seamlessness).c_str());
Ady Abrahambe23e6a2020-05-04 14:51:16 -07001447 } else {
Marin Shalamanov1876e2e2020-12-04 13:23:59 +01001448 result.append(41, ' ');
Ady Abrahambe23e6a2020-05-04 14:51:16 -07001449 }
Dan Stozae22aec72016-08-01 13:20:59 -07001450
Ady Abrahamaae5ed52020-06-26 09:32:43 -07001451 const auto focused = isLayerFocusedBasedOnPriority(getFrameRateSelectionPriority());
1452 StringAppendF(&result, " [%s]\n", focused ? "*" : " ");
1453
Marin Shalamanov1876e2e2020-12-04 13:23:59 +01001454 result.append(kDumpTableRowLength, '-');
1455 result.append("\n");
Dan Stozae22aec72016-08-01 13:20:59 -07001456}
Dan Stozae22aec72016-08-01 13:20:59 -07001457
Yiwei Zhang5434a782018-12-05 18:06:32 -08001458void Layer::dumpFrameStats(std::string& result) const {
Svetoslavd85084b2014-03-20 10:28:31 -07001459 mFrameTracker.dumpStats(result);
Mathias Agopian13127d82013-03-05 17:47:11 -08001460}
1461
Svetoslavd85084b2014-03-20 10:28:31 -07001462void Layer::clearFrameStats() {
1463 mFrameTracker.clearStats();
Mathias Agopian13127d82013-03-05 17:47:11 -08001464}
1465
Jamie Gennis6547ff42013-07-16 20:12:42 -07001466void Layer::logFrameStats() {
1467 mFrameTracker.logAndResetStats(mName);
1468}
1469
Svetoslavd85084b2014-03-20 10:28:31 -07001470void Layer::getFrameStats(FrameStats* outStats) const {
1471 mFrameTracker.getStats(outStats);
1472}
1473
Vishnu Nair0f085c62019-08-30 08:49:12 -07001474void Layer::dumpCallingUidPid(std::string& result) const {
Vishnu Naircb8be502022-10-12 19:03:23 +00001475 StringAppendF(&result, "Layer %s (%s) ownerPid:%d ownerUid:%d\n", getName().c_str(), getType(),
1476 mOwnerPid, mOwnerUid);
Vishnu Nair0f085c62019-08-30 08:49:12 -07001477}
1478
Brian Anderson5ea5e592016-12-01 16:54:33 -08001479void Layer::onDisconnect() {
Yiwei Zhang1a88c402019-11-18 10:43:58 -08001480 const int32_t layerId = getSequence();
1481 mFlinger->mTimeStats->onDestroy(layerId);
1482 mFlinger->mFrameTracer->onDestroy(layerId);
Brian Anderson5ea5e592016-12-01 16:54:33 -08001483}
1484
Chia-I Wu98f1c102017-05-30 14:54:08 -07001485size_t Layer::getChildrenCount() const {
1486 size_t count = 0;
1487 for (const sp<Layer>& child : mCurrentChildren) {
1488 count += 1 + child->getChildrenCount();
1489 }
1490 return count;
1491}
1492
Dominik Laskowskif5d0ea52021-09-26 17:27:01 -07001493void Layer::setGameModeForTree(GameMode gameMode) {
1494 const auto& currentState = getDrawingState();
Huihong Luod3d8f8e2022-03-08 14:48:46 -08001495 if (currentState.metadata.has(gui::METADATA_GAME_MODE)) {
1496 gameMode =
1497 static_cast<GameMode>(currentState.metadata.getInt32(gui::METADATA_GAME_MODE, 0));
Adithya Srinivasanac977e62021-05-21 22:50:56 +00001498 }
1499 setGameMode(gameMode);
1500 for (const sp<Layer>& child : mCurrentChildren) {
1501 child->setGameModeForTree(gameMode);
1502 }
1503}
1504
Robert Carr1f0a16a2016-10-24 16:27:39 -07001505void Layer::addChild(const sp<Layer>& layer) {
Robert Carre450fb52021-06-11 13:21:09 -07001506 mFlinger->mSomeChildrenChanged = true;
Robert Carr7f2ed8b2019-02-07 14:45:11 -08001507 setTransactionFlags(eTransactionNeeded);
Robert Carr1323c952019-01-28 18:13:27 -08001508
Robert Carr1f0a16a2016-10-24 16:27:39 -07001509 mCurrentChildren.add(layer);
Ady Abrahamd11bade2022-08-01 16:18:03 -07001510 layer->setParent(sp<Layer>::fromExisting(this));
Adithya Srinivasanac977e62021-05-21 22:50:56 +00001511 layer->setGameModeForTree(mGameMode);
Ady Abraham60e42ea2020-03-09 19:17:31 -07001512 updateTreeHasFrameRateVote();
Robert Carr1f0a16a2016-10-24 16:27:39 -07001513}
1514
1515ssize_t Layer::removeChild(const sp<Layer>& layer) {
Robert Carre450fb52021-06-11 13:21:09 -07001516 mFlinger->mSomeChildrenChanged = true;
Robert Carr7f2ed8b2019-02-07 14:45:11 -08001517 setTransactionFlags(eTransactionNeeded);
Robert Carr6fb1a7e2018-12-11 12:07:25 -08001518
Robert Carr1323c952019-01-28 18:13:27 -08001519 layer->setParent(nullptr);
Ady Abraham60e42ea2020-03-09 19:17:31 -07001520 const auto removeResult = mCurrentChildren.remove(layer);
1521
1522 updateTreeHasFrameRateVote();
Dominik Laskowskif5d0ea52021-09-26 17:27:01 -07001523 layer->setGameModeForTree(GameMode::Unsupported);
Ady Abraham60e42ea2020-03-09 19:17:31 -07001524 layer->updateTreeHasFrameRateVote();
1525
1526 return removeResult;
1527}
1528
Robert Carr15eae092018-03-23 13:43:53 -07001529void Layer::setChildrenDrawingParent(const sp<Layer>& newParent) {
Robert Carr578038f2018-03-09 12:25:24 -08001530 for (const sp<Layer>& child : mDrawingChildren) {
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001531 child->mDrawingParent = newParent;
xinying1f4200e62022-04-26 14:41:30 +08001532 const float parentShadowRadius =
1533 newParent->canDrawShadows() ? 0.f : newParent->mEffectiveShadowRadius;
Vishnu Nair6bdec7d2021-05-10 15:01:13 -07001534 child->computeBounds(newParent->mBounds, newParent->mEffectiveTransform,
xinying1f4200e62022-04-26 14:41:30 +08001535 parentShadowRadius);
Vishnu Naire14c6b32022-08-06 04:20:15 +00001536 child->updateSnapshot(true /* updateGeometry */);
1537 child->updateChildrenSnapshots(true /* updateGeometry */);
Robert Carr578038f2018-03-09 12:25:24 -08001538 }
1539}
1540
chaviwf1961f72017-09-18 16:41:07 -07001541bool Layer::reparent(const sp<IBinder>& newParentHandle) {
Robert Carr54cf5b12019-01-25 14:02:28 -08001542 sp<Layer> newParent;
1543 if (newParentHandle != nullptr) {
Vishnu Nairf9096652021-07-20 18:49:42 -07001544 newParent = fromHandle(newParentHandle).promote();
Robert Carr54cf5b12019-01-25 14:02:28 -08001545 if (newParent == nullptr) {
1546 ALOGE("Unable to promote Layer handle");
1547 return false;
1548 }
1549 if (newParent == this) {
1550 ALOGE("Invalid attempt to reparent Layer (%s) to itself", getName().c_str());
1551 return false;
1552 }
1553 }
1554
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001555 sp<Layer> parent = getParent();
chaviwf1961f72017-09-18 16:41:07 -07001556 if (parent != nullptr) {
Ady Abrahamd11bade2022-08-01 16:18:03 -07001557 parent->removeChild(sp<Layer>::fromExisting(this));
chaviw06178942017-07-27 10:25:59 -07001558 }
1559
Robert Carr6fb1a7e2018-12-11 12:07:25 -08001560 if (newParentHandle != nullptr) {
Ady Abrahamd11bade2022-08-01 16:18:03 -07001561 newParent->addChild(sp<Layer>::fromExisting(this));
Robert Carr6fb1a7e2018-12-11 12:07:25 -08001562 if (!newParent->isRemovedFromCurrentState()) {
1563 addToCurrentState();
1564 } else {
1565 onRemovedFromCurrentState();
1566 }
Robert Carr6fb1a7e2018-12-11 12:07:25 -08001567 } else {
1568 onRemovedFromCurrentState();
chaviw61626f22018-11-15 16:26:27 -08001569 }
1570
chaviw06178942017-07-27 10:25:59 -07001571 return true;
1572}
1573
Peiyong Lind3788632018-09-18 16:01:31 -07001574bool Layer::setColorTransform(const mat4& matrix) {
Peiyong Lin747321c2018-10-01 10:03:11 -07001575 static const mat4 identityMatrix = mat4();
1576
Robert Carr6a160312021-05-17 12:08:20 -07001577 if (mDrawingState.colorTransform == matrix) {
Peiyong Lind3788632018-09-18 16:01:31 -07001578 return false;
1579 }
Robert Carr6a160312021-05-17 12:08:20 -07001580 ++mDrawingState.sequence;
1581 mDrawingState.colorTransform = matrix;
1582 mDrawingState.hasColorTransform = matrix != identityMatrix;
1583 mDrawingState.modified = true;
Peiyong Lind3788632018-09-18 16:01:31 -07001584 setTransactionFlags(eTransactionNeeded);
1585 return true;
1586}
1587
chaviwf66724d2018-11-28 16:35:21 -08001588mat4 Layer::getColorTransform() const {
1589 mat4 colorTransform = mat4(getDrawingState().colorTransform);
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001590 if (sp<Layer> parent = mDrawingParent.promote(); parent != nullptr) {
chaviwf66724d2018-11-28 16:35:21 -08001591 colorTransform = parent->getColorTransform() * colorTransform;
1592 }
1593 return colorTransform;
Peiyong Lind3788632018-09-18 16:01:31 -07001594}
1595
1596bool Layer::hasColorTransform() const {
chaviwf66724d2018-11-28 16:35:21 -08001597 bool hasColorTransform = getDrawingState().hasColorTransform;
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001598 if (sp<Layer> parent = mDrawingParent.promote(); parent != nullptr) {
chaviwf66724d2018-11-28 16:35:21 -08001599 hasColorTransform = hasColorTransform || parent->hasColorTransform();
1600 }
1601 return hasColorTransform;
Peiyong Lind3788632018-09-18 16:01:31 -07001602}
1603
Chia-I Wu11481472018-05-04 10:43:19 -07001604bool Layer::isLegacyDataSpace() const {
1605 // return true when no higher bits are set
chaviw4244e032019-09-04 11:27:49 -07001606 return !(getDataSpace() &
1607 (ui::Dataspace::STANDARD_MASK | ui::Dataspace::TRANSFER_MASK |
1608 ui::Dataspace::RANGE_MASK));
Peiyong Lindd9b2ae2018-03-01 16:22:45 -08001609}
1610
Robert Carr1f0a16a2016-10-24 16:27:39 -07001611void Layer::setParent(const sp<Layer>& layer) {
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001612 mCurrentParent = layer;
Robert Carr1f0a16a2016-10-24 16:27:39 -07001613}
1614
Robert Carr6a160312021-05-17 12:08:20 -07001615int32_t Layer::getZ(LayerVector::StateSet) const {
1616 return mDrawingState.z;
Robert Carr1f0a16a2016-10-24 16:27:39 -07001617}
1618
Robert Carr1c5481e2019-07-01 14:42:27 -07001619bool Layer::usingRelativeZ(LayerVector::StateSet stateSet) const {
Robert Carr29abff82017-12-04 13:51:20 -08001620 const bool useDrawing = stateSet == LayerVector::StateSet::Drawing;
Robert Carr6a160312021-05-17 12:08:20 -07001621 const State& state = useDrawing ? mDrawingState : mDrawingState;
chaviwe5ac40f2019-09-24 16:36:55 -07001622 return state.isRelativeOf;
Robert Carr29abff82017-12-04 13:51:20 -08001623}
1624
David Sodman41fdfc92017-11-06 16:09:56 -08001625__attribute__((no_sanitize("unsigned-integer-overflow"))) LayerVector Layer::makeTraversalList(
Robert Carr29abff82017-12-04 13:51:20 -08001626 LayerVector::StateSet stateSet, bool* outSkipRelativeZUsers) {
Dan Stoza412903f2017-04-27 13:42:17 -07001627 LOG_ALWAYS_FATAL_IF(stateSet == LayerVector::StateSet::Invalid,
1628 "makeTraversalList received invalid stateSet");
1629 const bool useDrawing = stateSet == LayerVector::StateSet::Drawing;
1630 const LayerVector& children = useDrawing ? mDrawingChildren : mCurrentChildren;
Robert Carr6a160312021-05-17 12:08:20 -07001631 const State& state = useDrawing ? mDrawingState : mDrawingState;
Dan Stoza412903f2017-04-27 13:42:17 -07001632
Robert Carr29abff82017-12-04 13:51:20 -08001633 if (state.zOrderRelatives.size() == 0) {
1634 *outSkipRelativeZUsers = true;
1635 return children;
1636 }
1637
chaviwfd462612018-05-31 16:11:27 -07001638 LayerVector traverse(stateSet);
Dan Stoza412903f2017-04-27 13:42:17 -07001639 for (const wp<Layer>& weakRelative : state.zOrderRelatives) {
Robert Carrdb66e622017-04-10 16:55:57 -07001640 sp<Layer> strongRelative = weakRelative.promote();
1641 if (strongRelative != nullptr) {
1642 traverse.add(strongRelative);
Robert Carrdb66e622017-04-10 16:55:57 -07001643 }
1644 }
1645
Dan Stoza412903f2017-04-27 13:42:17 -07001646 for (const sp<Layer>& child : children) {
chaviwe5ac40f2019-09-24 16:36:55 -07001647 if (child->usingRelativeZ(stateSet)) {
Robert Carr503c7042017-09-27 15:06:08 -07001648 continue;
1649 }
Robert Carrdb66e622017-04-10 16:55:57 -07001650 traverse.add(child);
1651 }
1652
1653 return traverse;
1654}
1655
Robert Carr1f0a16a2016-10-24 16:27:39 -07001656/**
Robert Carrdb66e622017-04-10 16:55:57 -07001657 * Negatively signed relatives are before 'this' in Z-order.
Robert Carr1f0a16a2016-10-24 16:27:39 -07001658 */
Dan Stoza412903f2017-04-27 13:42:17 -07001659void Layer::traverseInZOrder(LayerVector::StateSet stateSet, const LayerVector::Visitor& visitor) {
Robert Carr29abff82017-12-04 13:51:20 -08001660 // In the case we have other layers who are using a relative Z to us, makeTraversalList will
1661 // produce a new list for traversing, including our relatives, and not including our children
1662 // who are relatives of another surface. In the case that there are no relative Z,
1663 // makeTraversalList returns our children directly to avoid significant overhead.
1664 // However in this case we need to take the responsibility for filtering children which
1665 // are relatives of another surface here.
1666 bool skipRelativeZUsers = false;
1667 const LayerVector list = makeTraversalList(stateSet, &skipRelativeZUsers);
Robert Carrdb66e622017-04-10 16:55:57 -07001668
Robert Carr1f0a16a2016-10-24 16:27:39 -07001669 size_t i = 0;
Robert Carrdb66e622017-04-10 16:55:57 -07001670 for (; i < list.size(); i++) {
1671 const auto& relative = list[i];
Robert Carr29abff82017-12-04 13:51:20 -08001672 if (skipRelativeZUsers && relative->usingRelativeZ(stateSet)) {
1673 continue;
1674 }
1675
chaviw301b1d82019-11-06 13:15:09 -08001676 if (relative->getZ(stateSet) >= 0) {
Robert Carr1f0a16a2016-10-24 16:27:39 -07001677 break;
Robert Carrdb66e622017-04-10 16:55:57 -07001678 }
Dan Stoza412903f2017-04-27 13:42:17 -07001679 relative->traverseInZOrder(stateSet, visitor);
Robert Carr1f0a16a2016-10-24 16:27:39 -07001680 }
Robert Carr29abff82017-12-04 13:51:20 -08001681
Dan Stoza412903f2017-04-27 13:42:17 -07001682 visitor(this);
Robert Carrdb66e622017-04-10 16:55:57 -07001683 for (; i < list.size(); i++) {
1684 const auto& relative = list[i];
Lloyd Pique0449b0f2018-12-20 16:23:45 -08001685
Robert Carr29abff82017-12-04 13:51:20 -08001686 if (skipRelativeZUsers && relative->usingRelativeZ(stateSet)) {
1687 continue;
1688 }
Dan Stoza412903f2017-04-27 13:42:17 -07001689 relative->traverseInZOrder(stateSet, visitor);
Robert Carr1f0a16a2016-10-24 16:27:39 -07001690 }
1691}
1692
1693/**
Robert Carrdb66e622017-04-10 16:55:57 -07001694 * Positively signed relatives are before 'this' in reverse Z-order.
Robert Carr1f0a16a2016-10-24 16:27:39 -07001695 */
Dan Stoza412903f2017-04-27 13:42:17 -07001696void Layer::traverseInReverseZOrder(LayerVector::StateSet stateSet,
1697 const LayerVector::Visitor& visitor) {
Robert Carr29abff82017-12-04 13:51:20 -08001698 // See traverseInZOrder for documentation.
1699 bool skipRelativeZUsers = false;
1700 LayerVector list = makeTraversalList(stateSet, &skipRelativeZUsers);
Robert Carrdb66e622017-04-10 16:55:57 -07001701
Robert Carr1f0a16a2016-10-24 16:27:39 -07001702 int32_t i = 0;
Joel Galensonbf324992017-11-06 11:04:12 -08001703 for (i = int32_t(list.size()) - 1; i >= 0; i--) {
Robert Carrdb66e622017-04-10 16:55:57 -07001704 const auto& relative = list[i];
Robert Carr29abff82017-12-04 13:51:20 -08001705
1706 if (skipRelativeZUsers && relative->usingRelativeZ(stateSet)) {
1707 continue;
1708 }
1709
chaviw301b1d82019-11-06 13:15:09 -08001710 if (relative->getZ(stateSet) < 0) {
Robert Carr1f0a16a2016-10-24 16:27:39 -07001711 break;
1712 }
Dan Stoza412903f2017-04-27 13:42:17 -07001713 relative->traverseInReverseZOrder(stateSet, visitor);
Robert Carr1f0a16a2016-10-24 16:27:39 -07001714 }
Dan Stoza412903f2017-04-27 13:42:17 -07001715 visitor(this);
David Sodman41fdfc92017-11-06 16:09:56 -08001716 for (; i >= 0; i--) {
Robert Carrdb66e622017-04-10 16:55:57 -07001717 const auto& relative = list[i];
Robert Carr29abff82017-12-04 13:51:20 -08001718
1719 if (skipRelativeZUsers && relative->usingRelativeZ(stateSet)) {
1720 continue;
1721 }
1722
Dan Stoza412903f2017-04-27 13:42:17 -07001723 relative->traverseInReverseZOrder(stateSet, visitor);
Robert Carr1f0a16a2016-10-24 16:27:39 -07001724 }
1725}
1726
Edgar Arriaga844fa672020-01-16 14:21:42 -08001727void Layer::traverse(LayerVector::StateSet state, const LayerVector::Visitor& visitor) {
1728 visitor(this);
1729 const LayerVector& children =
Robert Carr6a160312021-05-17 12:08:20 -07001730 state == LayerVector::StateSet::Drawing ? mDrawingChildren : mCurrentChildren;
Edgar Arriaga844fa672020-01-16 14:21:42 -08001731 for (const sp<Layer>& child : children) {
1732 child->traverse(state, visitor);
1733 }
1734}
1735
chaviw4b129c22018-04-09 16:19:43 -07001736LayerVector Layer::makeChildrenTraversalList(LayerVector::StateSet stateSet,
1737 const std::vector<Layer*>& layersInTree) {
1738 LOG_ALWAYS_FATAL_IF(stateSet == LayerVector::StateSet::Invalid,
1739 "makeTraversalList received invalid stateSet");
chaviwa76b2712017-09-20 12:02:26 -07001740 const bool useDrawing = stateSet == LayerVector::StateSet::Drawing;
1741 const LayerVector& children = useDrawing ? mDrawingChildren : mCurrentChildren;
Robert Carr6a160312021-05-17 12:08:20 -07001742 const State& state = useDrawing ? mDrawingState : mDrawingState;
chaviw4b129c22018-04-09 16:19:43 -07001743
chaviwfd462612018-05-31 16:11:27 -07001744 LayerVector traverse(stateSet);
chaviw4b129c22018-04-09 16:19:43 -07001745 for (const wp<Layer>& weakRelative : state.zOrderRelatives) {
1746 sp<Layer> strongRelative = weakRelative.promote();
1747 // Only add relative layers that are also descendents of the top most parent of the tree.
1748 // If a relative layer is not a descendent, then it should be ignored.
1749 if (std::binary_search(layersInTree.begin(), layersInTree.end(), strongRelative.get())) {
1750 traverse.add(strongRelative);
1751 }
1752 }
1753
1754 for (const sp<Layer>& child : children) {
Robert Carr6a160312021-05-17 12:08:20 -07001755 const State& childState = useDrawing ? child->mDrawingState : child->mDrawingState;
chaviw4b129c22018-04-09 16:19:43 -07001756 // If a layer has a relativeOf layer, only ignore if the layer it's relative to is a
1757 // descendent of the top most parent of the tree. If it's not a descendent, then just add
1758 // the child here since it won't be added later as a relative.
1759 if (std::binary_search(layersInTree.begin(), layersInTree.end(),
1760 childState.zOrderRelativeOf.promote().get())) {
1761 continue;
1762 }
1763 traverse.add(child);
1764 }
1765
1766 return traverse;
1767}
1768
1769void Layer::traverseChildrenInZOrderInner(const std::vector<Layer*>& layersInTree,
1770 LayerVector::StateSet stateSet,
1771 const LayerVector::Visitor& visitor) {
1772 const LayerVector list = makeChildrenTraversalList(stateSet, layersInTree);
chaviwa76b2712017-09-20 12:02:26 -07001773
1774 size_t i = 0;
chaviw4b129c22018-04-09 16:19:43 -07001775 for (; i < list.size(); i++) {
1776 const auto& relative = list[i];
chaviw301b1d82019-11-06 13:15:09 -08001777 if (relative->getZ(stateSet) >= 0) {
chaviwa76b2712017-09-20 12:02:26 -07001778 break;
1779 }
chaviw4b129c22018-04-09 16:19:43 -07001780 relative->traverseChildrenInZOrderInner(layersInTree, stateSet, visitor);
chaviwa76b2712017-09-20 12:02:26 -07001781 }
chaviw4b129c22018-04-09 16:19:43 -07001782
chaviwa76b2712017-09-20 12:02:26 -07001783 visitor(this);
chaviw4b129c22018-04-09 16:19:43 -07001784 for (; i < list.size(); i++) {
1785 const auto& relative = list[i];
1786 relative->traverseChildrenInZOrderInner(layersInTree, stateSet, visitor);
chaviwa76b2712017-09-20 12:02:26 -07001787 }
1788}
1789
chaviw4b129c22018-04-09 16:19:43 -07001790std::vector<Layer*> Layer::getLayersInTree(LayerVector::StateSet stateSet) {
1791 const bool useDrawing = stateSet == LayerVector::StateSet::Drawing;
1792 const LayerVector& children = useDrawing ? mDrawingChildren : mCurrentChildren;
1793
1794 std::vector<Layer*> layersInTree = {this};
1795 for (size_t i = 0; i < children.size(); i++) {
1796 const auto& child = children[i];
1797 std::vector<Layer*> childLayers = child->getLayersInTree(stateSet);
1798 layersInTree.insert(layersInTree.end(), childLayers.cbegin(), childLayers.cend());
1799 }
1800
1801 return layersInTree;
1802}
1803
1804void Layer::traverseChildrenInZOrder(LayerVector::StateSet stateSet,
1805 const LayerVector::Visitor& visitor) {
1806 std::vector<Layer*> layersInTree = getLayersInTree(stateSet);
1807 std::sort(layersInTree.begin(), layersInTree.end());
1808 traverseChildrenInZOrderInner(layersInTree, stateSet, visitor);
1809}
1810
Peiyong Linefefaac2018-08-17 12:27:51 -07001811ui::Transform Layer::getTransform() const {
Vishnu Nairf0c28512019-02-08 12:40:28 -08001812 return mEffectiveTransform;
Robert Carr1f0a16a2016-10-24 16:27:39 -07001813}
1814
Garfield Tan2c1782c2022-02-16 15:25:05 -08001815bool Layer::isTransformValid() const {
1816 float transformDet = getTransform().det();
1817 return transformDet != 0 && !isinf(transformDet) && !isnan(transformDet);
1818}
1819
chaviw13fdc492017-06-27 12:40:18 -07001820half Layer::getAlpha() const {
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001821 const auto& p = mDrawingParent.promote();
Lloyd Pique0449b0f2018-12-20 16:23:45 -08001822
chaviw13fdc492017-06-27 12:40:18 -07001823 half parentAlpha = (p != nullptr) ? p->getAlpha() : 1.0_hf;
1824 return parentAlpha * getDrawingState().color.a;
Robert Carr6452f122017-03-21 10:41:29 -07001825}
Robert Carr6452f122017-03-21 10:41:29 -07001826
Vishnu Nair6213bd92020-05-08 17:42:25 -07001827ui::Transform::RotationFlags Layer::getFixedTransformHint() const {
Robert Carr6a160312021-05-17 12:08:20 -07001828 ui::Transform::RotationFlags fixedTransformHint = mDrawingState.fixedTransformHint;
Vishnu Nair6213bd92020-05-08 17:42:25 -07001829 if (fixedTransformHint != ui::Transform::ROT_INVALID) {
1830 return fixedTransformHint;
1831 }
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001832 const auto& p = mCurrentParent.promote();
Vishnu Nair6213bd92020-05-08 17:42:25 -07001833 if (!p) return fixedTransformHint;
1834 return p->getFixedTransformHint();
1835}
1836
chaviw13fdc492017-06-27 12:40:18 -07001837half4 Layer::getColor() const {
1838 const half4 color(getDrawingState().color);
Lloyd Pique0449b0f2018-12-20 16:23:45 -08001839 return half4(color.r, color.g, color.b, getAlpha());
Robert Carr6452f122017-03-21 10:41:29 -07001840}
Robert Carr6452f122017-03-21 10:41:29 -07001841
Lucas Dupin19c8f0e2019-11-25 17:55:44 -08001842int32_t Layer::getBackgroundBlurRadius() const {
Vishnu Nair29810f72022-07-01 16:38:41 +00001843 if (getDrawingState().backgroundBlurRadius == 0) {
1844 return 0;
1845 }
Galia Peychevada7de0e2020-12-03 17:24:35 +01001846
Vishnu Nair29810f72022-07-01 16:38:41 +00001847 const auto& p = mDrawingParent.promote();
Galia Peychevada7de0e2020-12-03 17:24:35 +01001848 half parentAlpha = (p != nullptr) ? p->getAlpha() : 1.0_hf;
1849 return parentAlpha * getDrawingState().backgroundBlurRadius;
Lucas Dupin19c8f0e2019-11-25 17:55:44 -08001850}
1851
Galia Peychevae0acf382021-04-12 21:22:34 +02001852const std::vector<BlurRegion> Layer::getBlurRegions() const {
1853 auto regionsCopy(getDrawingState().blurRegions);
Galia Peycheva3c286542021-06-17 15:21:28 +02001854 float layerAlpha = getAlpha();
Galia Peychevae0acf382021-04-12 21:22:34 +02001855 for (auto& region : regionsCopy) {
1856 region.alpha = region.alpha * layerAlpha;
1857 }
1858 return regionsCopy;
Lucas Dupinc3800b82020-10-02 16:24:48 -07001859}
1860
Vishnu Naire14c6b32022-08-06 04:20:15 +00001861RoundedCornerState Layer::getRoundedCornerState() const {
Vishnu Nair9dbf8e82021-09-16 16:24:47 -07001862 // Get parent settings
1863 RoundedCornerState parentSettings;
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001864 const auto& parent = mDrawingParent.promote();
1865 if (parent != nullptr) {
1866 parentSettings = parent->getRoundedCornerState();
Vishnu Nair50c0afe2022-07-11 15:04:07 -07001867 if (parentSettings.hasRoundedCorners()) {
Lucas Dupin1b6531c2018-07-05 17:18:21 -07001868 ui::Transform t = getActiveTransform(getDrawingState());
1869 t = t.inverse();
Vishnu Nair9dbf8e82021-09-16 16:24:47 -07001870 parentSettings.cropRect = t.transform(parentSettings.cropRect);
Vishnu Nair50c0afe2022-07-11 15:04:07 -07001871 parentSettings.radius.x *= t.getScaleX();
1872 parentSettings.radius.y *= t.getScaleY();
Lucas Dupin1b6531c2018-07-05 17:18:21 -07001873 }
1874 }
Vishnu Nair9dbf8e82021-09-16 16:24:47 -07001875
1876 // Get layer settings
1877 Rect layerCropRect = getCroppedBufferSize(getDrawingState());
Vishnu Nair50c0afe2022-07-11 15:04:07 -07001878 const vec2 radius(getDrawingState().cornerRadius, getDrawingState().cornerRadius);
Vishnu Nair9dbf8e82021-09-16 16:24:47 -07001879 RoundedCornerState layerSettings(layerCropRect.toFloatRect(), radius);
Vishnu Nair50c0afe2022-07-11 15:04:07 -07001880 const bool layerSettingsValid = layerSettings.hasRoundedCorners() && layerCropRect.isValid();
Vishnu Nair9dbf8e82021-09-16 16:24:47 -07001881
Vishnu Nair50c0afe2022-07-11 15:04:07 -07001882 if (layerSettingsValid && parentSettings.hasRoundedCorners()) {
Vishnu Nair9dbf8e82021-09-16 16:24:47 -07001883 // If the parent and the layer have rounded corner settings, use the parent settings if the
1884 // parent crop is entirely inside the layer crop.
1885 // This has limitations and cause rendering artifacts. See b/200300845 for correct fix.
1886 if (parentSettings.cropRect.left > layerCropRect.left &&
1887 parentSettings.cropRect.top > layerCropRect.top &&
1888 parentSettings.cropRect.right < layerCropRect.right &&
1889 parentSettings.cropRect.bottom < layerCropRect.bottom) {
1890 return parentSettings;
1891 } else {
1892 return layerSettings;
1893 }
Vishnu Nairb1845592021-10-07 12:17:57 -07001894 } else if (layerSettingsValid) {
Vishnu Nair9dbf8e82021-09-16 16:24:47 -07001895 return layerSettings;
Vishnu Nair50c0afe2022-07-11 15:04:07 -07001896 } else if (parentSettings.hasRoundedCorners()) {
Vishnu Nair9dbf8e82021-09-16 16:24:47 -07001897 return parentSettings;
1898 }
1899 return {};
Lucas Dupin1b6531c2018-07-05 17:18:21 -07001900}
1901
Robert Carr88b85e12022-03-21 15:47:35 -07001902bool Layer::findInHierarchy(const sp<Layer>& l) {
1903 if (l == this) {
1904 return true;
1905 }
1906 for (auto& child : mDrawingChildren) {
1907 if (child->findInHierarchy(l)) {
1908 return true;
1909 }
1910 }
1911 return false;
1912}
1913
Robert Carr1f0a16a2016-10-24 16:27:39 -07001914void Layer::commitChildList() {
1915 for (size_t i = 0; i < mCurrentChildren.size(); i++) {
1916 const auto& child = mCurrentChildren[i];
1917 child->commitChildList();
1918 }
1919 mDrawingChildren = mCurrentChildren;
Chia-I Wue41dbe62017-06-13 14:10:56 -07001920 mDrawingParent = mCurrentParent;
Robert Carr88b85e12022-03-21 15:47:35 -07001921 if (CC_UNLIKELY(usingRelativeZ(LayerVector::StateSet::Drawing))) {
1922 auto zOrderRelativeOf = mDrawingState.zOrderRelativeOf.promote();
1923 if (zOrderRelativeOf == nullptr) return;
1924 if (findInHierarchy(zOrderRelativeOf)) {
1925 ALOGE("Detected Z ordering loop between %s and %s", mName.c_str(),
1926 zOrderRelativeOf->mName.c_str());
1927 ALOGE("Severing rel Z loop, potentially dangerous");
1928 mDrawingState.isRelativeOf = false;
Ady Abrahamd11bade2022-08-01 16:18:03 -07001929 zOrderRelativeOf->removeZOrderRelative(wp<Layer>::fromExisting(this));
Robert Carr88b85e12022-03-21 15:47:35 -07001930 }
1931 }
Robert Carr1f0a16a2016-10-24 16:27:39 -07001932}
1933
Vishnu Nair6fabeec2019-03-12 13:42:49 -07001934
chaviw3277faf2021-05-19 16:45:23 -05001935void Layer::setInputInfo(const WindowInfo& info) {
Robert Carr6a160312021-05-17 12:08:20 -07001936 mDrawingState.inputInfo = info;
Vishnu Nairf9096652021-07-20 18:49:42 -07001937 mDrawingState.touchableRegionCrop = fromHandle(info.touchableRegionCropHandle.promote());
Robert Carr6a160312021-05-17 12:08:20 -07001938 mDrawingState.modified = true;
Arthur Hung9ed43392022-05-27 06:31:57 +00001939 mFlinger->mUpdateInputInfo = true;
Robert Carr720e5062018-07-30 17:45:14 -07001940 setTransactionFlags(eTransactionNeeded);
1941}
1942
Vishnu Naird8f5e9f2022-02-03 10:23:28 -08001943LayerProto* Layer::writeToProto(LayersProto& layersProto, uint32_t traceFlags) {
chaviw08f3cb22020-01-13 13:17:21 -08001944 LayerProto* layerProto = layersProto.add_layers();
Vishnu Naird8f5e9f2022-02-03 10:23:28 -08001945 writeToProtoDrawingState(layerProto);
chaviw08f3cb22020-01-13 13:17:21 -08001946 writeToProtoCommonState(layerProto, LayerVector::StateSet::Drawing, traceFlags);
1947
Vishnu Nair00b90132021-11-05 14:03:40 -07001948 if (traceFlags & LayerTracing::TRACE_COMPOSITION) {
Dominik Laskowski298b08e2022-02-15 13:45:02 -08001949 ftl::FakeGuard guard(mFlinger->mStateLock); // Called from the main thread.
1950
Vishnu Nair60db8c02020-04-02 11:55:16 -07001951 // Only populate for the primary display.
Dominik Laskowski298b08e2022-02-15 13:45:02 -08001952 if (const auto display = mFlinger->getDefaultDisplayDeviceLocked()) {
Leon Scroggins III2e1aa182021-12-01 17:33:12 -05001953 const auto compositionType = getCompositionType(*display);
Vishnu Nair60db8c02020-04-02 11:55:16 -07001954 layerProto->set_hwc_composition_type(static_cast<HwcCompositionType>(compositionType));
Vishnu Naird8f5e9f2022-02-03 10:23:28 -08001955 LayerProtoHelper::writeToProto(getVisibleRegion(display.get()),
1956 [&]() { return layerProto->mutable_visible_region(); });
Vishnu Nair60db8c02020-04-02 11:55:16 -07001957 }
Alec Mouri6b9e9912020-01-21 10:50:24 -08001958 }
1959
chaviw08f3cb22020-01-13 13:17:21 -08001960 for (const sp<Layer>& layer : mDrawingChildren) {
Vishnu Naird8f5e9f2022-02-03 10:23:28 -08001961 layer->writeToProto(layersProto, traceFlags);
chaviw08f3cb22020-01-13 13:17:21 -08001962 }
chaviw6d89e2d2020-01-14 14:42:01 -08001963
1964 return layerProto;
chaviw08f3cb22020-01-13 13:17:21 -08001965}
1966
Vishnu Naird8f5e9f2022-02-03 10:23:28 -08001967void Layer::writeToProtoDrawingState(LayerProto* layerInfo) {
Vishnu Nair6b7c5c92020-09-29 17:27:05 -07001968 const ui::Transform transform = getTransform();
Vishnu Naird37343b2022-01-12 16:18:56 -08001969 auto buffer = getExternalTexture();
Vishnu Nair00b90132021-11-05 14:03:40 -07001970 if (buffer != nullptr) {
Vishnu Naird37343b2022-01-12 16:18:56 -08001971 LayerProtoHelper::writeToProto(*buffer,
Vishnu Nair00b90132021-11-05 14:03:40 -07001972 [&]() { return layerInfo->mutable_active_buffer(); });
1973 LayerProtoHelper::writeToProtoDeprecated(ui::Transform(getBufferTransform()),
1974 layerInfo->mutable_buffer_transform());
1975 }
1976 layerInfo->set_invalidate(contentDirty);
1977 layerInfo->set_is_protected(isProtected());
1978 layerInfo->set_dataspace(dataspaceDetails(static_cast<android_dataspace>(getDataSpace())));
1979 layerInfo->set_queued_frames(getQueuedFrameCount());
Vishnu Nair00b90132021-11-05 14:03:40 -07001980 layerInfo->set_curr_frame(mCurrentFrameNumber);
Vishnu Nair00b90132021-11-05 14:03:40 -07001981 layerInfo->set_requested_corner_radius(getDrawingState().cornerRadius);
Vishnu Nair50c0afe2022-07-11 15:04:07 -07001982 layerInfo->set_corner_radius(
1983 (getRoundedCornerState().radius.x + getRoundedCornerState().radius.y) / 2.0);
Vishnu Nair00b90132021-11-05 14:03:40 -07001984 layerInfo->set_background_blur_radius(getBackgroundBlurRadius());
1985 layerInfo->set_is_trusted_overlay(isTrustedOverlay());
1986 LayerProtoHelper::writeToProtoDeprecated(transform, layerInfo->mutable_transform());
1987 LayerProtoHelper::writePositionToProto(transform.tx(), transform.ty(),
1988 [&]() { return layerInfo->mutable_position(); });
1989 LayerProtoHelper::writeToProto(mBounds, [&]() { return layerInfo->mutable_bounds(); });
Vishnu Nair00b90132021-11-05 14:03:40 -07001990 LayerProtoHelper::writeToProto(surfaceDamageRegion,
1991 [&]() { return layerInfo->mutable_damage_region(); });
Vishnu Nair8406fd72019-07-30 11:29:31 -07001992
Vishnu Nair00b90132021-11-05 14:03:40 -07001993 if (hasColorTransform()) {
1994 LayerProtoHelper::writeToProto(getColorTransform(), layerInfo->mutable_color_transform());
Vishnu Nair8406fd72019-07-30 11:29:31 -07001995 }
1996
Vishnu Nair60db8c02020-04-02 11:55:16 -07001997 LayerProtoHelper::writeToProto(mSourceBounds,
1998 [&]() { return layerInfo->mutable_source_bounds(); });
1999 LayerProtoHelper::writeToProto(mScreenBounds,
2000 [&]() { return layerInfo->mutable_screen_bounds(); });
2001 LayerProtoHelper::writeToProto(getRoundedCornerState().cropRect,
2002 [&]() { return layerInfo->mutable_corner_radius_crop(); });
2003 layerInfo->set_shadow_radius(mEffectiveShadowRadius);
Vishnu Nair8406fd72019-07-30 11:29:31 -07002004}
2005
2006void Layer::writeToProtoCommonState(LayerProto* layerInfo, LayerVector::StateSet stateSet,
chaviw4c34a092020-07-08 11:30:06 -07002007 uint32_t traceFlags) {
chaviw1d044282017-09-27 12:19:28 -07002008 const bool useDrawing = stateSet == LayerVector::StateSet::Drawing;
2009 const LayerVector& children = useDrawing ? mDrawingChildren : mCurrentChildren;
Robert Carr6a160312021-05-17 12:08:20 -07002010 const State& state = useDrawing ? mDrawingState : mDrawingState;
chaviw1d044282017-09-27 12:19:28 -07002011
chaviw766c9c52021-02-10 17:36:47 -08002012 ui::Transform requestedTransform = state.transform;
chaviw1d044282017-09-27 12:19:28 -07002013
Vishnu Nair00b90132021-11-05 14:03:40 -07002014 layerInfo->set_id(sequence);
2015 layerInfo->set_name(getName().c_str());
2016 layerInfo->set_type(getType());
chaviw1d044282017-09-27 12:19:28 -07002017
Vishnu Nair00b90132021-11-05 14:03:40 -07002018 for (const auto& child : children) {
2019 layerInfo->add_children(child->sequence);
chaviwadc40c22018-07-10 16:57:27 -07002020 }
Evan Rosky1f6d6d52018-12-06 10:47:26 -08002021
Vishnu Nair00b90132021-11-05 14:03:40 -07002022 for (const wp<Layer>& weakRelative : state.zOrderRelatives) {
2023 sp<Layer> strongRelative = weakRelative.promote();
2024 if (strongRelative != nullptr) {
2025 layerInfo->add_relatives(strongRelative->sequence);
2026 }
2027 }
2028
Vishnu Nairea04b6f2022-08-19 21:28:17 +00002029 LayerProtoHelper::writeToProto(state.transparentRegionHint,
Vishnu Nair00b90132021-11-05 14:03:40 -07002030 [&]() { return layerInfo->mutable_transparent_region(); });
2031
2032 layerInfo->set_layer_stack(getLayerStack().id);
2033 layerInfo->set_z(state.z);
2034
2035 LayerProtoHelper::writePositionToProto(requestedTransform.tx(), requestedTransform.ty(), [&]() {
2036 return layerInfo->mutable_requested_position();
2037 });
2038
Vishnu Nair00b90132021-11-05 14:03:40 -07002039 LayerProtoHelper::writeToProto(state.crop, [&]() { return layerInfo->mutable_crop(); });
2040
2041 layerInfo->set_is_opaque(isOpaque(state));
2042
2043 layerInfo->set_pixel_format(decodePixelFormat(getPixelFormat()));
2044 LayerProtoHelper::writeToProto(getColor(), [&]() { return layerInfo->mutable_color(); });
2045 LayerProtoHelper::writeToProto(state.color,
2046 [&]() { return layerInfo->mutable_requested_color(); });
2047 layerInfo->set_flags(state.flags);
2048
2049 LayerProtoHelper::writeToProtoDeprecated(requestedTransform,
2050 layerInfo->mutable_requested_transform());
2051
2052 auto parent = useDrawing ? mDrawingParent.promote() : mCurrentParent.promote();
2053 if (parent != nullptr) {
2054 layerInfo->set_parent(parent->sequence);
2055 } else {
2056 layerInfo->set_parent(-1);
2057 }
2058
2059 auto zOrderRelativeOf = state.zOrderRelativeOf.promote();
2060 if (zOrderRelativeOf != nullptr) {
2061 layerInfo->set_z_order_relative_of(zOrderRelativeOf->sequence);
2062 } else {
2063 layerInfo->set_z_order_relative_of(-1);
2064 }
2065
2066 layerInfo->set_is_relative_of(state.isRelativeOf);
2067
2068 layerInfo->set_owner_uid(mOwnerUid);
2069
Arthur Hung4cf2d8c2022-04-07 14:52:00 +00002070 if ((traceFlags & LayerTracing::TRACE_INPUT) && needsInputInfo()) {
chaviw3277faf2021-05-19 16:45:23 -05002071 WindowInfo info;
chaviw4c34a092020-07-08 11:30:06 -07002072 if (useDrawing) {
Prabir Pradhanda0f62c2022-07-22 19:53:04 +00002073 info = fillInputInfo(
2074 InputDisplayArgs{.transform = &kIdentityTransform, .isSecure = true});
chaviw4c34a092020-07-08 11:30:06 -07002075 } else {
2076 info = state.inputInfo;
2077 }
2078
2079 LayerProtoHelper::writeToProto(info, state.touchableRegionCrop,
Vishnu Nair9245d3b2019-03-22 13:38:56 -07002080 [&]() { return layerInfo->mutable_input_window_info(); });
Evan Rosky1f6d6d52018-12-06 10:47:26 -08002081 }
Vishnu Nair9245d3b2019-03-22 13:38:56 -07002082
Vishnu Nair00b90132021-11-05 14:03:40 -07002083 if (traceFlags & LayerTracing::TRACE_EXTRA) {
Vishnu Nair9245d3b2019-03-22 13:38:56 -07002084 auto protoMap = layerInfo->mutable_metadata();
2085 for (const auto& entry : state.metadata.mMap) {
2086 (*protoMap)[entry.first] = std::string(entry.second.cbegin(), entry.second.cend());
2087 }
Vishnu Nair9245d3b2019-03-22 13:38:56 -07002088 }
Vishnu Naird2aaab12022-02-10 14:49:09 -08002089
2090 LayerProtoHelper::writeToProto(state.destinationFrame,
2091 [&]() { return layerInfo->mutable_destination_frame(); });
chaviw1d044282017-09-27 12:19:28 -07002092}
2093
Robert Carr2e102c92018-10-23 12:11:15 -07002094bool Layer::isRemovedFromCurrentState() const {
Robert Carr6a160312021-05-17 12:08:20 -07002095 return mRemovedFromDrawingState;
Robert Carr2e102c92018-10-23 12:11:15 -07002096}
2097
Prabir Pradhan33da9462022-06-14 14:55:57 +00002098// Applies the given transform to the region, while protecting against overflows caused by any
2099// offsets. If applying the offset in the transform to any of the Rects in the region would result
2100// in an overflow, they are not added to the output Region.
2101static Region transformTouchableRegionSafely(const ui::Transform& t, const Region& r,
2102 const std::string& debugWindowName) {
2103 // Round the translation using the same rounding strategy used by ui::Transform.
2104 const auto tx = static_cast<int32_t>(t.tx() + 0.5);
2105 const auto ty = static_cast<int32_t>(t.ty() + 0.5);
2106
2107 ui::Transform transformWithoutOffset = t;
2108 transformWithoutOffset.set(0.f, 0.f);
2109
2110 const Region transformed = transformWithoutOffset.transform(r);
2111
2112 // Apply the translation to each of the Rects in the region while discarding any that overflow.
2113 Region ret;
2114 for (const auto& rect : transformed) {
2115 Rect newRect;
2116 if (__builtin_add_overflow(rect.left, tx, &newRect.left) ||
2117 __builtin_add_overflow(rect.top, ty, &newRect.top) ||
2118 __builtin_add_overflow(rect.right, tx, &newRect.right) ||
2119 __builtin_add_overflow(rect.bottom, ty, &newRect.bottom)) {
2120 ALOGE("Applying transform to touchable region of window '%s' resulted in an overflow.",
2121 debugWindowName.c_str());
2122 continue;
2123 }
2124 ret.orSelf(newRect);
2125 }
2126 return ret;
2127}
2128
Prabir Pradhanc9589c12021-09-22 06:11:43 -07002129void Layer::fillInputFrameInfo(WindowInfo& info, const ui::Transform& screenToDisplay) {
2130 Rect tmpBounds = getInputBounds();
2131 if (!tmpBounds.isValid()) {
Prabir Pradhan6fa425a2021-12-16 07:16:04 -08002132 info.touchableRegion.clear();
2133 // A layer could have invalid input bounds and still expect to receive touch input if it has
2134 // replaceTouchableRegionWithCrop. For that case, the input transform needs to be calculated
2135 // correctly to determine the coordinate space for input events. Use an empty rect so that
2136 // the layer will receive input in its own layer space.
Prabir Pradhanc9589c12021-09-22 06:11:43 -07002137 tmpBounds = Rect::EMPTY_RECT;
chaviw7e72caf2020-12-02 16:50:43 -08002138 }
2139
Prabir Pradhanc9589c12021-09-22 06:11:43 -07002140 // InputDispatcher works in the display device's coordinate space. Here, we calculate the
2141 // frame and transform used for the layer, which determines the bounds and the coordinate space
2142 // within which the layer will receive input.
2143 //
2144 // The coordinate space within which each of the bounds are specified is explicitly documented
2145 // in the variable name. For example "inputBoundsInLayer" is specified in layer space. A
2146 // Transform converts one coordinate space to another, which is apparent in its naming. For
2147 // example, "layerToDisplay" transforms layer space to display space.
2148 //
2149 // Coordinate space definitions:
2150 // - display: The display device's coordinate space. Correlates to pixels on the display.
2151 // - screen: The post-rotation coordinate space for the display, a.k.a. logical display space.
2152 // - layer: The coordinate space of this layer.
2153 // - input: The coordinate space in which this layer will receive input events. This could be
2154 // different than layer space if a surfaceInset is used, which changes the origin
2155 // of the input space.
2156 const FloatRect inputBoundsInLayer = tmpBounds.toFloatRect();
chaviw7e72caf2020-12-02 16:50:43 -08002157
Prabir Pradhanc9589c12021-09-22 06:11:43 -07002158 // Clamp surface inset to the input bounds.
2159 const auto surfaceInset = static_cast<float>(info.surfaceInset);
2160 const float xSurfaceInset =
2161 std::max(0.f, std::min(surfaceInset, inputBoundsInLayer.getWidth() / 2.f));
2162 const float ySurfaceInset =
2163 std::max(0.f, std::min(surfaceInset, inputBoundsInLayer.getHeight() / 2.f));
chaviw1ff3d1e2020-07-01 15:53:47 -07002164
Prabir Pradhanc9589c12021-09-22 06:11:43 -07002165 // Apply the insets to the input bounds.
2166 const FloatRect insetBoundsInLayer(inputBoundsInLayer.left + xSurfaceInset,
2167 inputBoundsInLayer.top + ySurfaceInset,
2168 inputBoundsInLayer.right - xSurfaceInset,
2169 inputBoundsInLayer.bottom - ySurfaceInset);
Ady Abraham282f1d72019-07-24 18:05:56 -07002170
Prabir Pradhanc9589c12021-09-22 06:11:43 -07002171 // Crop the input bounds to ensure it is within the parent's bounds.
2172 const FloatRect croppedInsetBoundsInLayer = mBounds.intersect(insetBoundsInLayer);
Ady Abraham282f1d72019-07-24 18:05:56 -07002173
Prabir Pradhanc9589c12021-09-22 06:11:43 -07002174 const ui::Transform layerToScreen = getInputTransform();
2175 const ui::Transform layerToDisplay = screenToDisplay * layerToScreen;
Vishnu Nair8033a492018-12-05 07:27:23 -08002176
Prabir Pradhanc9589c12021-09-22 06:11:43 -07002177 const Rect roundedFrameInDisplay{layerToDisplay.transform(croppedInsetBoundsInLayer)};
2178 info.frameLeft = roundedFrameInDisplay.left;
2179 info.frameTop = roundedFrameInDisplay.top;
2180 info.frameRight = roundedFrameInDisplay.right;
2181 info.frameBottom = roundedFrameInDisplay.bottom;
chaviw1ff3d1e2020-07-01 15:53:47 -07002182
Prabir Pradhanc9589c12021-09-22 06:11:43 -07002183 ui::Transform inputToLayer;
2184 inputToLayer.set(insetBoundsInLayer.left, insetBoundsInLayer.top);
2185 const ui::Transform inputToDisplay = layerToDisplay * inputToLayer;
chaviw39cfa2e2020-11-04 14:19:02 -08002186
Prabir Pradhanc9589c12021-09-22 06:11:43 -07002187 // InputDispatcher expects a display-to-input transform.
2188 info.transform = inputToDisplay.inverse();
2189
2190 // The touchable region is specified in the input coordinate space. Change it to display space.
Prabir Pradhan33da9462022-06-14 14:55:57 +00002191 info.touchableRegion =
2192 transformTouchableRegionSafely(inputToDisplay, info.touchableRegion, mName);
chaviw7e72caf2020-12-02 16:50:43 -08002193}
2194
chaviw3277faf2021-05-19 16:45:23 -05002195void Layer::fillTouchOcclusionMode(WindowInfo& info) {
Ady Abrahamd11bade2022-08-01 16:18:03 -07002196 sp<Layer> p = sp<Layer>::fromExisting(this);
Bernardo Rufinoa9d0a532021-06-11 15:59:12 +01002197 while (p != nullptr && !p->hasInputInfo()) {
Rob Carrc6d2d2b2021-10-25 16:51:49 +00002198 p = p->mDrawingParent.promote();
Bernardo Rufinoa9d0a532021-06-11 15:59:12 +01002199 }
2200 if (p != nullptr) {
2201 info.touchOcclusionMode = p->mDrawingState.inputInfo.touchOcclusionMode;
2202 }
2203}
2204
Vishnu Naira066d902021-09-13 18:40:17 -07002205gui::DropInputMode Layer::getDropInputMode() const {
2206 gui::DropInputMode mode = mDrawingState.dropInputMode;
2207 if (mode == gui::DropInputMode::ALL) {
2208 return mode;
2209 }
Rob Carrc6d2d2b2021-10-25 16:51:49 +00002210 sp<Layer> parent = mDrawingParent.promote();
2211 if (parent) {
2212 gui::DropInputMode parentMode = parent->getDropInputMode();
Vishnu Naira066d902021-09-13 18:40:17 -07002213 if (parentMode != gui::DropInputMode::NONE) {
2214 return parentMode;
2215 }
2216 }
2217 return mode;
2218}
2219
2220void Layer::handleDropInputMode(gui::WindowInfo& info) const {
Prabir Pradhan51e7db02022-02-07 06:02:57 -08002221 if (mDrawingState.inputInfo.inputConfig.test(WindowInfo::InputConfig::NO_INPUT_CHANNEL)) {
Vishnu Naira066d902021-09-13 18:40:17 -07002222 return;
2223 }
2224
2225 // Check if we need to drop input unconditionally
2226 gui::DropInputMode dropInputMode = getDropInputMode();
2227 if (dropInputMode == gui::DropInputMode::ALL) {
Prabir Pradhan51e7db02022-02-07 06:02:57 -08002228 info.inputConfig |= WindowInfo::InputConfig::DROP_INPUT;
Vishnu Naira066d902021-09-13 18:40:17 -07002229 ALOGV("Dropping input for %s as requested by policy.", getDebugName());
2230 return;
2231 }
2232
2233 // Check if we need to check if the window is obscured by parent
2234 if (dropInputMode != gui::DropInputMode::OBSCURED) {
2235 return;
2236 }
2237
2238 // Check if the parent has set an alpha on the layer
Rob Carrc6d2d2b2021-10-25 16:51:49 +00002239 sp<Layer> parent = mDrawingParent.promote();
2240 if (parent && parent->getAlpha() != 1.0_hf) {
Prabir Pradhan51e7db02022-02-07 06:02:57 -08002241 info.inputConfig |= WindowInfo::InputConfig::DROP_INPUT;
Vishnu Naira066d902021-09-13 18:40:17 -07002242 ALOGV("Dropping input for %s as requested by policy because alpha=%f", getDebugName(),
2243 static_cast<float>(getAlpha()));
2244 }
2245
2246 // Check if the parent has cropped the buffer
2247 Rect bufferSize = getCroppedBufferSize(getDrawingState());
2248 if (!bufferSize.isValid()) {
Prabir Pradhan51e7db02022-02-07 06:02:57 -08002249 info.inputConfig |= WindowInfo::InputConfig::DROP_INPUT_IF_OBSCURED;
Vishnu Naira066d902021-09-13 18:40:17 -07002250 return;
2251 }
2252
2253 // Screenbounds are the layer bounds cropped by parents, transformed to screenspace.
2254 // To check if the layer has been cropped, we take the buffer bounds, apply the local
2255 // layer crop and apply the same set of transforms to move to screenspace. If the bounds
2256 // match then the layer has not been cropped by its parents.
2257 Rect bufferInScreenSpace(getTransform().transform(bufferSize));
2258 bool croppedByParent = bufferInScreenSpace != Rect{mScreenBounds};
2259
2260 if (croppedByParent) {
Prabir Pradhan51e7db02022-02-07 06:02:57 -08002261 info.inputConfig |= WindowInfo::InputConfig::DROP_INPUT;
Vishnu Naira066d902021-09-13 18:40:17 -07002262 ALOGV("Dropping input for %s as requested by policy because buffer is cropped by parent",
2263 getDebugName());
2264 } else {
2265 // If the layer is not obscured by its parents (by setting an alpha or crop), then only drop
2266 // input if the window is obscured. This check should be done in surfaceflinger but the
2267 // logic currently resides in inputflinger. So pass the if_obscured check to input to only
2268 // drop input events if the window is obscured.
Prabir Pradhan51e7db02022-02-07 06:02:57 -08002269 info.inputConfig |= WindowInfo::InputConfig::DROP_INPUT_IF_OBSCURED;
Vishnu Naira066d902021-09-13 18:40:17 -07002270 }
2271}
2272
Prabir Pradhanda0f62c2022-07-22 19:53:04 +00002273WindowInfo Layer::fillInputInfo(const InputDisplayArgs& displayArgs) {
chaviw7e72caf2020-12-02 16:50:43 -08002274 if (!hasInputInfo()) {
2275 mDrawingState.inputInfo.name = getName();
2276 mDrawingState.inputInfo.ownerUid = mOwnerUid;
2277 mDrawingState.inputInfo.ownerPid = mOwnerPid;
Prabir Pradhan51e7db02022-02-07 06:02:57 -08002278 mDrawingState.inputInfo.inputConfig |= WindowInfo::InputConfig::NO_INPUT_CHANNEL;
Dominik Laskowski29fa1462021-04-27 15:51:50 -07002279 mDrawingState.inputInfo.displayId = getLayerStack().id;
chaviw7e72caf2020-12-02 16:50:43 -08002280 }
2281
Prabir Pradhanda0f62c2022-07-22 19:53:04 +00002282 const ui::Transform& displayTransform =
2283 displayArgs.transform != nullptr ? *displayArgs.transform : kIdentityTransform;
2284
chaviw3277faf2021-05-19 16:45:23 -05002285 WindowInfo info = mDrawingState.inputInfo;
chaviw7e72caf2020-12-02 16:50:43 -08002286 info.id = sequence;
Dominik Laskowski29fa1462021-04-27 15:51:50 -07002287 info.displayId = getLayerStack().id;
chaviw7e72caf2020-12-02 16:50:43 -08002288
Dominik Laskowski29fa1462021-04-27 15:51:50 -07002289 fillInputFrameInfo(info, displayTransform);
chaviw7e72caf2020-12-02 16:50:43 -08002290
Prabir Pradhanda0f62c2022-07-22 19:53:04 +00002291 if (displayArgs.transform == nullptr) {
2292 // Do not let the window receive touches if it is not associated with a valid display
2293 // transform. We still allow the window to receive keys and prevent ANRs.
2294 info.inputConfig |= WindowInfo::InputConfig::NOT_TOUCHABLE;
2295 }
2296
Robert Carr5dc426e2020-06-10 14:29:14 -07002297 // For compatibility reasons we let layers which can receive input
2298 // receive input before they have actually submitted a buffer. Because
2299 // of this we use canReceiveInput instead of isVisible to check the
2300 // policy-visibility, ignoring the buffer state. However for layers with
2301 // hasInputInfo()==false we can use the real visibility state.
2302 // We are just using these layers for occlusion detection in
2303 // InputDispatcher, and obviously if they aren't visible they can't occlude
2304 // anything.
Prabir Pradhan4d5c52f2022-01-31 08:52:10 -08002305 const bool visible = hasInputInfo() ? canReceiveInput() : isVisible();
2306 info.setInputConfig(WindowInfo::InputConfig::NOT_VISIBLE, !visible);
2307
Bernardo Rufinoea97d182020-08-19 14:43:14 +01002308 info.alpha = getAlpha();
Bernardo Rufinoa9d0a532021-06-11 15:59:12 +01002309 fillTouchOcclusionMode(info);
Vishnu Naira066d902021-09-13 18:40:17 -07002310 handleDropInputMode(info);
Vishnu Nair6fabeec2019-03-12 13:42:49 -07002311
Vishnu Nair16a938f2021-09-24 07:14:54 -07002312 // If the window will be blacked out on a display because the display does not have the secure
2313 // flag and the layer has the secure flag set, then drop input.
Prabir Pradhanda0f62c2022-07-22 19:53:04 +00002314 if (!displayArgs.isSecure && isSecure()) {
Prabir Pradhan51e7db02022-02-07 06:02:57 -08002315 info.inputConfig |= WindowInfo::InputConfig::DROP_INPUT;
Vishnu Nair16a938f2021-09-24 07:14:54 -07002316 }
2317
Vishnu Nair6fabeec2019-03-12 13:42:49 -07002318 auto cropLayer = mDrawingState.touchableRegionCrop.promote();
2319 if (info.replaceTouchableRegionWithCrop) {
Dominik Laskowski29fa1462021-04-27 15:51:50 -07002320 const Rect bounds(cropLayer ? cropLayer->mScreenBounds : mScreenBounds);
2321 info.touchableRegion = Region(displayTransform.transform(bounds));
Vishnu Nair6fabeec2019-03-12 13:42:49 -07002322 } else if (cropLayer != nullptr) {
[1;3C2b9fc252021-02-04 16:16:50 -08002323 info.touchableRegion = info.touchableRegion.intersect(
Dominik Laskowski29fa1462021-04-27 15:51:50 -07002324 displayTransform.transform(Rect{cropLayer->mScreenBounds}));
Vishnu Nair6fabeec2019-03-12 13:42:49 -07002325 }
2326
Winson Chunga30f7c92021-06-29 15:42:56 -07002327 // Inherit the trusted state from the parent hierarchy, but don't clobber the trusted state
2328 // if it was set by WM for a known system overlay
Prabir Pradhan4d5c52f2022-01-31 08:52:10 -08002329 if (isTrustedOverlay()) {
2330 info.inputConfig |= WindowInfo::InputConfig::TRUSTED_OVERLAY;
2331 }
Winson Chunga30f7c92021-06-29 15:42:56 -07002332
chaviwaf87b3e2019-10-01 16:59:28 -07002333 // If the layer is a clone, we need to crop the input region to cloned root to prevent
2334 // touches from going outside the cloned area.
2335 if (isClone()) {
chaviw8577ea82022-06-01 16:32:26 -05002336 info.inputConfig |= WindowInfo::InputConfig::CLONE;
Dominik Laskowski29fa1462021-04-27 15:51:50 -07002337 if (const sp<Layer> clonedRoot = getClonedRoot()) {
2338 const Rect rect = displayTransform.transform(Rect{clonedRoot->mScreenBounds});
chaviwaf87b3e2019-10-01 16:59:28 -07002339 info.touchableRegion = info.touchableRegion.intersect(rect);
2340 }
2341 }
2342
Robert Carr720e5062018-07-30 17:45:14 -07002343 return info;
2344}
2345
chaviwaf87b3e2019-10-01 16:59:28 -07002346sp<Layer> Layer::getClonedRoot() {
2347 if (mClonedChild != nullptr) {
Ady Abrahamd11bade2022-08-01 16:18:03 -07002348 return sp<Layer>::fromExisting(this);
chaviwaf87b3e2019-10-01 16:59:28 -07002349 }
Rob Carrc6d2d2b2021-10-25 16:51:49 +00002350 if (mDrawingParent == nullptr || mDrawingParent.promote() == nullptr) {
chaviwaf87b3e2019-10-01 16:59:28 -07002351 return nullptr;
2352 }
Rob Carrc6d2d2b2021-10-25 16:51:49 +00002353 return mDrawingParent.promote()->getClonedRoot();
chaviwaf87b3e2019-10-01 16:59:28 -07002354}
2355
Robert Carredd13602020-04-13 17:24:34 -07002356bool Layer::hasInputInfo() const {
Linus Tufvessona1858822022-03-04 09:32:07 +00002357 return mDrawingState.inputInfo.token != nullptr ||
2358 mDrawingState.inputInfo.inputConfig.test(WindowInfo::InputConfig::NO_INPUT_CHANNEL);
Robert Carr720e5062018-07-30 17:45:14 -07002359}
2360
Lloyd Pique37c2c9b2018-12-04 17:25:10 -08002361compositionengine::OutputLayer* Layer::findOutputLayerForDisplay(
Dominik Laskowskib7251f42020-04-20 17:42:59 -07002362 const DisplayDevice* display) const {
2363 if (!display) return nullptr;
Lloyd Piquede196652020-01-22 17:29:58 -08002364 return display->getCompositionDisplay()->getOutputLayerForLayer(getCompositionEngineLayerFE());
Lloyd Pique37c2c9b2018-12-04 17:25:10 -08002365}
2366
Dominik Laskowskib7251f42020-04-20 17:42:59 -07002367Region Layer::getVisibleRegion(const DisplayDevice* display) const {
2368 const auto outputLayer = findOutputLayerForDisplay(display);
2369 return outputLayer ? outputLayer->getState().visibleRegion : Region();
Lloyd Piquea2468662019-03-07 21:31:06 -08002370}
2371
chaviwb4c6e582019-08-16 14:35:07 -07002372void Layer::setInitialValuesForClone(const sp<Layer>& clonedFrom) {
Vishnu Nair3bb11d02021-11-26 09:24:11 -08002373 cloneDrawingState(clonedFrom.get());
chaviwb4c6e582019-08-16 14:35:07 -07002374 mClonedFrom = clonedFrom;
Patrick Williamsbb25f802022-08-30 23:02:34 +00002375 mPremultipliedAlpha = clonedFrom->mPremultipliedAlpha;
2376 mPotentialCursor = clonedFrom->mPotentialCursor;
2377 mProtectedByApp = clonedFrom->mProtectedByApp;
2378 updateCloneBufferInfo();
2379}
2380
2381void Layer::updateCloneBufferInfo() {
2382 if (!isClone() || !isClonedFromAlive()) {
2383 return;
2384 }
2385
2386 sp<Layer> clonedFrom = getClonedFrom();
2387 mBufferInfo = clonedFrom->mBufferInfo;
2388 mSidebandStream = clonedFrom->mSidebandStream;
2389 surfaceDamageRegion = clonedFrom->surfaceDamageRegion;
2390 mCurrentFrameNumber = clonedFrom->mCurrentFrameNumber.load();
2391 mPreviousFrameNumber = clonedFrom->mPreviousFrameNumber;
2392
2393 // After buffer info is updated, the drawingState from the real layer needs to be copied into
2394 // the cloned. This is because some properties of drawingState can change when latchBuffer is
2395 // called. However, copying the drawingState would also overwrite the cloned layer's relatives
2396 // and touchableRegionCrop. Therefore, temporarily store the relatives so they can be set in
2397 // the cloned drawingState again.
2398 wp<Layer> tmpZOrderRelativeOf = mDrawingState.zOrderRelativeOf;
2399 SortedVector<wp<Layer>> tmpZOrderRelatives = mDrawingState.zOrderRelatives;
2400 wp<Layer> tmpTouchableRegionCrop = mDrawingState.touchableRegionCrop;
2401 WindowInfo tmpInputInfo = mDrawingState.inputInfo;
2402
2403 cloneDrawingState(clonedFrom.get());
2404
2405 mDrawingState.touchableRegionCrop = tmpTouchableRegionCrop;
2406 mDrawingState.zOrderRelativeOf = tmpZOrderRelativeOf;
2407 mDrawingState.zOrderRelatives = tmpZOrderRelatives;
2408 mDrawingState.inputInfo = tmpInputInfo;
chaviwb4c6e582019-08-16 14:35:07 -07002409}
chaviw74b03172019-08-19 11:09:03 -07002410
2411void Layer::updateMirrorInfo() {
2412 if (mClonedChild == nullptr || !mClonedChild->isClonedFromAlive()) {
2413 // If mClonedChild is null, there is nothing to mirror. If isClonedFromAlive returns false,
2414 // it means that there is a clone, but the layer it was cloned from has been destroyed. In
2415 // that case, we want to delete the reference to the clone since we want it to get
2416 // destroyed. The root, this layer, will still be around since the client can continue
2417 // to hold a reference, but no cloned layers will be displayed.
2418 mClonedChild = nullptr;
2419 return;
2420 }
2421
2422 std::map<sp<Layer>, sp<Layer>> clonedLayersMap;
2423 // If the real layer exists and is in current state, add the clone as a child of the root.
2424 // There's no need to remove from drawingState when the layer is offscreen since currentState is
2425 // copied to drawingState for the root layer. So the clonedChild is always removed from
2426 // drawingState and then needs to be added back each traversal.
2427 if (!mClonedChild->getClonedFrom()->isRemovedFromCurrentState()) {
2428 addChildToDrawing(mClonedChild);
2429 }
2430
2431 mClonedChild->updateClonedDrawingState(clonedLayersMap);
Ady Abrahamd11bade2022-08-01 16:18:03 -07002432 mClonedChild->updateClonedChildren(sp<Layer>::fromExisting(this), clonedLayersMap);
chaviw74b03172019-08-19 11:09:03 -07002433 mClonedChild->updateClonedRelatives(clonedLayersMap);
2434}
2435
2436void Layer::updateClonedDrawingState(std::map<sp<Layer>, sp<Layer>>& clonedLayersMap) {
2437 // If the layer the clone was cloned from is alive, copy the content of the drawingState
2438 // to the clone. If the real layer is no longer alive, continue traversing the children
2439 // since we may be able to pull out other children that are still alive.
2440 if (isClonedFromAlive()) {
2441 sp<Layer> clonedFrom = getClonedFrom();
Vishnu Nair3bb11d02021-11-26 09:24:11 -08002442 cloneDrawingState(clonedFrom.get());
Ady Abrahamd11bade2022-08-01 16:18:03 -07002443 clonedLayersMap.emplace(clonedFrom, sp<Layer>::fromExisting(this));
chaviw74b03172019-08-19 11:09:03 -07002444 }
2445
2446 // The clone layer may have children in drawingState since they may have been created and
2447 // added from a previous request to updateMirorInfo. This is to ensure we don't recreate clones
2448 // that already exist, since we can just re-use them.
2449 // The drawingChildren will not get overwritten by the currentChildren since the clones are
2450 // not updated in the regular traversal. They are skipped since the root will lose the
2451 // reference to them when it copies its currentChildren to drawing.
2452 for (sp<Layer>& child : mDrawingChildren) {
2453 child->updateClonedDrawingState(clonedLayersMap);
2454 }
2455}
2456
2457void Layer::updateClonedChildren(const sp<Layer>& mirrorRoot,
2458 std::map<sp<Layer>, sp<Layer>>& clonedLayersMap) {
2459 mDrawingChildren.clear();
2460
2461 if (!isClonedFromAlive()) {
2462 return;
2463 }
2464
2465 sp<Layer> clonedFrom = getClonedFrom();
2466 for (sp<Layer>& child : clonedFrom->mDrawingChildren) {
2467 if (child == mirrorRoot) {
2468 // This is to avoid cyclical mirroring.
2469 continue;
2470 }
2471 sp<Layer> clonedChild = clonedLayersMap[child];
2472 if (clonedChild == nullptr) {
2473 clonedChild = child->createClone();
2474 clonedLayersMap[child] = clonedChild;
2475 }
2476 addChildToDrawing(clonedChild);
2477 clonedChild->updateClonedChildren(mirrorRoot, clonedLayersMap);
2478 }
2479}
2480
chaviwaf87b3e2019-10-01 16:59:28 -07002481void Layer::updateClonedInputInfo(const std::map<sp<Layer>, sp<Layer>>& clonedLayersMap) {
2482 auto cropLayer = mDrawingState.touchableRegionCrop.promote();
2483 if (cropLayer != nullptr) {
2484 if (clonedLayersMap.count(cropLayer) == 0) {
2485 // Real layer had a crop layer but it's not in the cloned hierarchy. Just set to
2486 // self as crop layer to avoid going outside bounds.
Ady Abrahamd11bade2022-08-01 16:18:03 -07002487 mDrawingState.touchableRegionCrop = wp<Layer>::fromExisting(this);
chaviwaf87b3e2019-10-01 16:59:28 -07002488 } else {
2489 const sp<Layer>& clonedCropLayer = clonedLayersMap.at(cropLayer);
2490 mDrawingState.touchableRegionCrop = clonedCropLayer;
2491 }
2492 }
2493 // Cloned layers shouldn't handle watch outside since their z order is not determined by
2494 // WM or the client.
Prabir Pradhan4d5c52f2022-01-31 08:52:10 -08002495 mDrawingState.inputInfo.setInputConfig(WindowInfo::InputConfig::WATCH_OUTSIDE_TOUCH, false);
chaviwaf87b3e2019-10-01 16:59:28 -07002496}
2497
2498void Layer::updateClonedRelatives(const std::map<sp<Layer>, sp<Layer>>& clonedLayersMap) {
Ady Abrahamd11bade2022-08-01 16:18:03 -07002499 mDrawingState.zOrderRelativeOf = wp<Layer>();
chaviw74b03172019-08-19 11:09:03 -07002500 mDrawingState.zOrderRelatives.clear();
2501
2502 if (!isClonedFromAlive()) {
2503 return;
2504 }
2505
chaviwaf87b3e2019-10-01 16:59:28 -07002506 const sp<Layer>& clonedFrom = getClonedFrom();
chaviw74b03172019-08-19 11:09:03 -07002507 for (wp<Layer>& relativeWeak : clonedFrom->mDrawingState.zOrderRelatives) {
chaviwaf87b3e2019-10-01 16:59:28 -07002508 const sp<Layer>& relative = relativeWeak.promote();
2509 if (clonedLayersMap.count(relative) > 0) {
2510 auto& clonedRelative = clonedLayersMap.at(relative);
chaviw74b03172019-08-19 11:09:03 -07002511 mDrawingState.zOrderRelatives.add(clonedRelative);
2512 }
2513 }
2514
2515 // Check if the relativeLayer for the real layer is part of the cloned hierarchy.
2516 // It's possible that the layer it's relative to is outside the requested cloned hierarchy.
2517 // In that case, we treat the layer as if the relativeOf has been removed. This way, it will
2518 // still traverse the children, but the layer with the missing relativeOf will not be shown
2519 // on screen.
chaviwaf87b3e2019-10-01 16:59:28 -07002520 const sp<Layer>& relativeOf = clonedFrom->mDrawingState.zOrderRelativeOf.promote();
2521 if (clonedLayersMap.count(relativeOf) > 0) {
2522 const sp<Layer>& clonedRelativeOf = clonedLayersMap.at(relativeOf);
chaviw74b03172019-08-19 11:09:03 -07002523 mDrawingState.zOrderRelativeOf = clonedRelativeOf;
2524 }
2525
chaviwaf87b3e2019-10-01 16:59:28 -07002526 updateClonedInputInfo(clonedLayersMap);
2527
chaviw74b03172019-08-19 11:09:03 -07002528 for (sp<Layer>& child : mDrawingChildren) {
2529 child->updateClonedRelatives(clonedLayersMap);
2530 }
2531}
2532
2533void Layer::addChildToDrawing(const sp<Layer>& layer) {
2534 mDrawingChildren.add(layer);
Ady Abrahamd11bade2022-08-01 16:18:03 -07002535 layer->mDrawingParent = sp<Layer>::fromExisting(this);
chaviw74b03172019-08-19 11:09:03 -07002536}
2537
Steven Thomas62a4cf82020-01-31 12:04:03 -08002538Layer::FrameRateCompatibility Layer::FrameRate::convertCompatibility(int8_t compatibility) {
2539 switch (compatibility) {
2540 case ANATIVEWINDOW_FRAME_RATE_COMPATIBILITY_DEFAULT:
2541 return FrameRateCompatibility::Default;
2542 case ANATIVEWINDOW_FRAME_RATE_COMPATIBILITY_FIXED_SOURCE:
2543 return FrameRateCompatibility::ExactOrMultiple;
Ady Abrahamdd5bfa92021-01-07 17:56:08 -08002544 case ANATIVEWINDOW_FRAME_RATE_EXACT:
2545 return FrameRateCompatibility::Exact;
Andy Labrada096227e2022-06-15 16:58:11 +00002546 case ANATIVEWINDOW_FRAME_RATE_MIN:
2547 return FrameRateCompatibility::Min;
Dominik Laskowski1f6fc702022-03-21 08:34:50 -07002548 case ANATIVEWINDOW_FRAME_RATE_NO_VOTE:
2549 return FrameRateCompatibility::NoVote;
Steven Thomas62a4cf82020-01-31 12:04:03 -08002550 default:
2551 LOG_ALWAYS_FATAL("Invalid frame rate compatibility value %d", compatibility);
2552 return FrameRateCompatibility::Default;
2553 }
2554}
2555
Marin Shalamanovc5986772021-03-16 16:09:49 +01002556scheduler::Seamlessness Layer::FrameRate::convertChangeFrameRateStrategy(int8_t strategy) {
2557 switch (strategy) {
2558 case ANATIVEWINDOW_CHANGE_FRAME_RATE_ONLY_IF_SEAMLESS:
2559 return Seamlessness::OnlySeamless;
2560 case ANATIVEWINDOW_CHANGE_FRAME_RATE_ALWAYS:
2561 return Seamlessness::SeamedAndSeamless;
2562 default:
2563 LOG_ALWAYS_FATAL("Invalid change frame sate strategy value %d", strategy);
2564 return Seamlessness::Default;
2565 }
2566}
2567
Dominik Laskowski29fa1462021-04-27 15:51:50 -07002568bool Layer::isInternalDisplayOverlay() const {
chaviwc5676c62020-09-18 15:01:04 -07002569 const State& s(mDrawingState);
2570 if (s.flags & layer_state_t::eLayerSkipScreenshot) {
2571 return true;
2572 }
2573
Rob Carrc6d2d2b2021-10-25 16:51:49 +00002574 sp<Layer> parent = mDrawingParent.promote();
2575 return parent && parent->isInternalDisplayOverlay();
chaviwc5676c62020-09-18 15:01:04 -07002576}
2577
Robert Carr6a0382d2021-07-01 15:57:17 -07002578void Layer::setClonedChild(const sp<Layer>& clonedChild) {
2579 mClonedChild = clonedChild;
2580 mHadClonedChild = true;
2581 mFlinger->mNumClones++;
2582}
2583
Vishnu Nairf9096652021-07-20 18:49:42 -07002584const String16 Layer::Handle::kDescriptor = String16("android.Layer.Handle");
2585
2586wp<Layer> Layer::fromHandle(const sp<IBinder>& handleBinder) {
2587 if (handleBinder == nullptr) {
2588 return nullptr;
2589 }
2590
2591 BBinder* b = handleBinder->localBinder();
2592 if (b == nullptr || b->getInterfaceDescriptor() != Handle::kDescriptor) {
2593 return nullptr;
2594 }
2595
2596 // We can safely cast this binder since its local and we verified its interface descriptor.
Ady Abrahamd11bade2022-08-01 16:18:03 -07002597 sp<Handle> handle = sp<Handle>::cast(handleBinder);
Vishnu Nairf9096652021-07-20 18:49:42 -07002598 return handle->owner;
2599}
2600
Vishnu Nair9cf4a4d2021-09-17 12:16:08 -07002601bool Layer::setDropInputMode(gui::DropInputMode mode) {
2602 if (mDrawingState.dropInputMode == mode) {
2603 return false;
2604 }
2605 mDrawingState.dropInputMode = mode;
2606 return true;
2607}
2608
Vishnu Nair3bb11d02021-11-26 09:24:11 -08002609void Layer::cloneDrawingState(const Layer* from) {
2610 mDrawingState = from->mDrawingState;
2611 // Skip callback info since they are not applicable for cloned layers.
2612 mDrawingState.releaseBufferListener = nullptr;
2613 mDrawingState.callbackHandles = {};
2614}
2615
Patrick Williamsbb25f802022-08-30 23:02:34 +00002616void Layer::callReleaseBufferCallback(const sp<ITransactionCompletedListener>& listener,
2617 const sp<GraphicBuffer>& buffer, uint64_t framenumber,
2618 const sp<Fence>& releaseFence,
2619 uint32_t currentMaxAcquiredBufferCount) {
2620 if (!listener) {
2621 return;
2622 }
2623 ATRACE_FORMAT_INSTANT("callReleaseBufferCallback %s - %" PRIu64, getDebugName(), framenumber);
2624 listener->onReleaseBuffer({buffer->getId(), framenumber},
2625 releaseFence ? releaseFence : Fence::NO_FENCE,
2626 currentMaxAcquiredBufferCount);
2627}
2628
2629void Layer::onLayerDisplayed(ftl::SharedFuture<FenceResult> futureFenceResult) {
2630 // If we are displayed on multiple displays in a single composition cycle then we would
2631 // need to do careful tracking to enable the use of the mLastClientCompositionFence.
2632 // For example we can only use it if all the displays are client comp, and we need
2633 // to merge all the client comp fences. We could do this, but for now we just
2634 // disable the optimization when a layer is composed on multiple displays.
2635 if (mClearClientCompositionFenceOnLayerDisplayed) {
2636 mLastClientCompositionFence = nullptr;
2637 } else {
2638 mClearClientCompositionFenceOnLayerDisplayed = true;
2639 }
2640
2641 // The previous release fence notifies the client that SurfaceFlinger is done with the previous
2642 // buffer that was presented on this layer. The first transaction that came in this frame that
2643 // replaced the previous buffer on this layer needs this release fence, because the fence will
2644 // let the client know when that previous buffer is removed from the screen.
2645 //
2646 // Every other transaction on this layer does not need a release fence because no other
2647 // Transactions that were set on this layer this frame are going to have their preceding buffer
2648 // removed from the display this frame.
2649 //
2650 // For example, if we have 3 transactions this frame. The first transaction doesn't contain a
2651 // buffer so it doesn't need a previous release fence because the layer still needs the previous
2652 // buffer. The second transaction contains a buffer so it needs a previous release fence because
2653 // the previous buffer will be released this frame. The third transaction also contains a
2654 // buffer. It replaces the buffer in the second transaction. The buffer in the second
2655 // transaction will now no longer be presented so it is released immediately and the third
2656 // transaction doesn't need a previous release fence.
2657 sp<CallbackHandle> ch;
2658 for (auto& handle : mDrawingState.callbackHandles) {
2659 if (handle->releasePreviousBuffer &&
2660 mDrawingState.releaseBufferEndpoint == handle->listener) {
2661 ch = handle;
2662 break;
2663 }
2664 }
2665
2666 // Prevent tracing the same release multiple times.
2667 if (mPreviousFrameNumber != mPreviousReleasedFrameNumber) {
2668 mPreviousReleasedFrameNumber = mPreviousFrameNumber;
2669 }
2670
2671 if (ch != nullptr) {
2672 ch->previousReleaseCallbackId = mPreviousReleaseCallbackId;
2673 ch->previousReleaseFences.emplace_back(std::move(futureFenceResult));
2674 ch->name = mName;
2675 }
2676}
2677
2678void Layer::onSurfaceFrameCreated(
2679 const std::shared_ptr<frametimeline::SurfaceFrame>& surfaceFrame) {
2680 while (mPendingJankClassifications.size() >= kPendingClassificationMaxSurfaceFrames) {
2681 // Too many SurfaceFrames pending classification. The front of the deque is probably not
2682 // tracked by FrameTimeline and will never be presented. This will only result in a memory
2683 // leak.
2684 ALOGW("Removing the front of pending jank deque from layer - %s to prevent memory leak",
2685 mName.c_str());
2686 std::string miniDump = mPendingJankClassifications.front()->miniDump();
2687 ALOGD("Head SurfaceFrame mini dump\n%s", miniDump.c_str());
2688 mPendingJankClassifications.pop_front();
2689 }
2690 mPendingJankClassifications.emplace_back(surfaceFrame);
2691}
2692
2693void Layer::releasePendingBuffer(nsecs_t dequeueReadyTime) {
2694 for (const auto& handle : mDrawingState.callbackHandles) {
2695 handle->transformHint = mTransformHint;
2696 handle->dequeueReadyTime = dequeueReadyTime;
2697 handle->currentMaxAcquiredBufferCount =
2698 mFlinger->getMaxAcquiredBufferCountForCurrentRefreshRate(mOwnerUid);
2699 ATRACE_FORMAT_INSTANT("releasePendingBuffer %s - %" PRIu64, getDebugName(),
2700 handle->previousReleaseCallbackId.framenumber);
2701 }
2702
2703 for (auto& handle : mDrawingState.callbackHandles) {
2704 if (handle->releasePreviousBuffer &&
2705 mDrawingState.releaseBufferEndpoint == handle->listener) {
2706 handle->previousReleaseCallbackId = mPreviousReleaseCallbackId;
2707 break;
2708 }
2709 }
2710
2711 std::vector<JankData> jankData;
2712 jankData.reserve(mPendingJankClassifications.size());
2713 while (!mPendingJankClassifications.empty() &&
2714 mPendingJankClassifications.front()->getJankType()) {
2715 std::shared_ptr<frametimeline::SurfaceFrame> surfaceFrame =
2716 mPendingJankClassifications.front();
2717 mPendingJankClassifications.pop_front();
2718 jankData.emplace_back(
2719 JankData(surfaceFrame->getToken(), surfaceFrame->getJankType().value()));
2720 }
2721
2722 mFlinger->getTransactionCallbackInvoker().addCallbackHandles(mDrawingState.callbackHandles,
2723 jankData);
Patrick Williamsbb25f802022-08-30 23:02:34 +00002724 mDrawingState.callbackHandles = {};
2725}
2726
2727bool Layer::willPresentCurrentTransaction() const {
2728 // Returns true if the most recent Transaction applied to CurrentState will be presented.
2729 return (getSidebandStreamChanged() || getAutoRefresh() ||
2730 (mDrawingState.modified &&
2731 (mDrawingState.buffer != nullptr || mDrawingState.bgColorLayer != nullptr)));
2732}
2733
2734bool Layer::setTransform(uint32_t transform) {
2735 if (mDrawingState.bufferTransform == transform) return false;
2736 mDrawingState.bufferTransform = transform;
2737 mDrawingState.modified = true;
2738 setTransactionFlags(eTransactionNeeded);
2739 return true;
2740}
2741
2742bool Layer::setTransformToDisplayInverse(bool transformToDisplayInverse) {
2743 if (mDrawingState.transformToDisplayInverse == transformToDisplayInverse) return false;
2744 mDrawingState.sequence++;
2745 mDrawingState.transformToDisplayInverse = transformToDisplayInverse;
2746 mDrawingState.modified = true;
2747 setTransactionFlags(eTransactionNeeded);
2748 return true;
2749}
2750
2751bool Layer::setBufferCrop(const Rect& bufferCrop) {
2752 if (mDrawingState.bufferCrop == bufferCrop) return false;
2753
2754 mDrawingState.sequence++;
2755 mDrawingState.bufferCrop = bufferCrop;
2756
2757 mDrawingState.modified = true;
2758 setTransactionFlags(eTransactionNeeded);
2759 return true;
2760}
2761
2762bool Layer::setDestinationFrame(const Rect& destinationFrame) {
2763 if (mDrawingState.destinationFrame == destinationFrame) return false;
2764
2765 mDrawingState.sequence++;
2766 mDrawingState.destinationFrame = destinationFrame;
2767
2768 mDrawingState.modified = true;
2769 setTransactionFlags(eTransactionNeeded);
2770 return true;
2771}
2772
2773// Translate destination frame into scale and position. If a destination frame is not set, use the
2774// provided scale and position
2775bool Layer::updateGeometry() {
2776 if ((mDrawingState.flags & layer_state_t::eIgnoreDestinationFrame) ||
2777 mDrawingState.destinationFrame.isEmpty()) {
2778 // If destination frame is not set, use the requested transform set via
2779 // Layer::setPosition and Layer::setMatrix.
2780 return assignTransform(&mDrawingState.transform, mRequestedTransform);
2781 }
2782
2783 Rect destRect = mDrawingState.destinationFrame;
2784 int32_t destW = destRect.width();
2785 int32_t destH = destRect.height();
2786 if (destRect.left < 0) {
2787 destRect.left = 0;
2788 destRect.right = destW;
2789 }
2790 if (destRect.top < 0) {
2791 destRect.top = 0;
2792 destRect.bottom = destH;
2793 }
2794
2795 if (!mDrawingState.buffer) {
2796 ui::Transform t;
2797 t.set(destRect.left, destRect.top);
2798 return assignTransform(&mDrawingState.transform, t);
2799 }
2800
2801 uint32_t bufferWidth = mDrawingState.buffer->getWidth();
2802 uint32_t bufferHeight = mDrawingState.buffer->getHeight();
2803 // Undo any transformations on the buffer.
2804 if (mDrawingState.bufferTransform & ui::Transform::ROT_90) {
2805 std::swap(bufferWidth, bufferHeight);
2806 }
2807 uint32_t invTransform = DisplayDevice::getPrimaryDisplayRotationFlags();
2808 if (mDrawingState.transformToDisplayInverse) {
2809 if (invTransform & ui::Transform::ROT_90) {
2810 std::swap(bufferWidth, bufferHeight);
2811 }
2812 }
2813
2814 float sx = destW / static_cast<float>(bufferWidth);
2815 float sy = destH / static_cast<float>(bufferHeight);
2816 ui::Transform t;
2817 t.set(sx, 0, 0, sy);
2818 t.set(destRect.left, destRect.top);
2819 return assignTransform(&mDrawingState.transform, t);
2820}
2821
2822bool Layer::setMatrix(const layer_state_t::matrix22_t& matrix) {
2823 if (mRequestedTransform.dsdx() == matrix.dsdx && mRequestedTransform.dtdy() == matrix.dtdy &&
2824 mRequestedTransform.dtdx() == matrix.dtdx && mRequestedTransform.dsdy() == matrix.dsdy) {
2825 return false;
2826 }
2827
2828 mRequestedTransform.set(matrix.dsdx, matrix.dtdy, matrix.dtdx, matrix.dsdy);
2829
2830 mDrawingState.sequence++;
2831 mDrawingState.modified = true;
2832 setTransactionFlags(eTransactionNeeded);
2833
2834 return true;
2835}
2836
2837bool Layer::setPosition(float x, float y) {
2838 if (mRequestedTransform.tx() == x && mRequestedTransform.ty() == y) {
2839 return false;
2840 }
2841
2842 mRequestedTransform.set(x, y);
2843
2844 mDrawingState.sequence++;
2845 mDrawingState.modified = true;
2846 setTransactionFlags(eTransactionNeeded);
2847
2848 return true;
2849}
2850
2851bool Layer::setBuffer(std::shared_ptr<renderengine::ExternalTexture>& buffer,
2852 const BufferData& bufferData, nsecs_t postTime, nsecs_t desiredPresentTime,
2853 bool isAutoTimestamp, std::optional<nsecs_t> dequeueTime,
2854 const FrameTimelineInfo& info) {
Chavi Weingarten009619f2022-09-15 20:27:25 +00002855 ATRACE_FORMAT("setBuffer %s - hasBuffer=%s", getDebugName(), (buffer ? "true" : "false"));
Patrick Williamsbb25f802022-08-30 23:02:34 +00002856 if (!buffer) {
2857 return false;
2858 }
2859
2860 const bool frameNumberChanged =
2861 bufferData.flags.test(BufferData::BufferDataChange::frameNumberChanged);
2862 const uint64_t frameNumber =
2863 frameNumberChanged ? bufferData.frameNumber : mDrawingState.frameNumber + 1;
Chavi Weingarten009619f2022-09-15 20:27:25 +00002864 ATRACE_FORMAT_INSTANT("setBuffer %s - %" PRIu64, getDebugName(), frameNumber);
Patrick Williamsbb25f802022-08-30 23:02:34 +00002865
2866 if (mDrawingState.buffer) {
2867 mReleasePreviousBuffer = true;
2868 if (!mBufferInfo.mBuffer ||
2869 (!mDrawingState.buffer->hasSameBuffer(*mBufferInfo.mBuffer) ||
2870 mDrawingState.frameNumber != mBufferInfo.mFrameNumber)) {
2871 // If mDrawingState has a buffer, and we are about to update again
2872 // before swapping to drawing state, then the first buffer will be
2873 // dropped and we should decrement the pending buffer count and
2874 // call any release buffer callbacks if set.
2875 callReleaseBufferCallback(mDrawingState.releaseBufferListener,
2876 mDrawingState.buffer->getBuffer(), mDrawingState.frameNumber,
2877 mDrawingState.acquireFence,
2878 mFlinger->getMaxAcquiredBufferCountForCurrentRefreshRate(
2879 mOwnerUid));
2880 decrementPendingBufferCount();
2881 if (mDrawingState.bufferSurfaceFrameTX != nullptr &&
2882 mDrawingState.bufferSurfaceFrameTX->getPresentState() != PresentState::Presented) {
2883 addSurfaceFrameDroppedForBuffer(mDrawingState.bufferSurfaceFrameTX);
2884 mDrawingState.bufferSurfaceFrameTX.reset();
2885 }
2886 } else if (EARLY_RELEASE_ENABLED && mLastClientCompositionFence != nullptr) {
2887 callReleaseBufferCallback(mDrawingState.releaseBufferListener,
2888 mDrawingState.buffer->getBuffer(), mDrawingState.frameNumber,
2889 mLastClientCompositionFence,
2890 mFlinger->getMaxAcquiredBufferCountForCurrentRefreshRate(
2891 mOwnerUid));
2892 mLastClientCompositionFence = nullptr;
2893 }
2894 }
2895
2896 mDrawingState.frameNumber = frameNumber;
2897 mDrawingState.releaseBufferListener = bufferData.releaseBufferListener;
2898 mDrawingState.buffer = std::move(buffer);
2899 mDrawingState.clientCacheId = bufferData.cachedBuffer;
2900
2901 mDrawingState.acquireFence = bufferData.flags.test(BufferData::BufferDataChange::fenceChanged)
2902 ? bufferData.acquireFence
2903 : Fence::NO_FENCE;
2904 mDrawingState.acquireFenceTime = std::make_unique<FenceTime>(mDrawingState.acquireFence);
2905 if (mDrawingState.acquireFenceTime->getSignalTime() == Fence::SIGNAL_TIME_PENDING) {
2906 // We latched this buffer unsiganled, so we need to pass the acquire fence
2907 // on the callback instead of just the acquire time, since it's unknown at
2908 // this point.
2909 mCallbackHandleAcquireTimeOrFence = mDrawingState.acquireFence;
2910 } else {
2911 mCallbackHandleAcquireTimeOrFence = mDrawingState.acquireFenceTime->getSignalTime();
2912 }
2913
2914 mDrawingState.modified = true;
2915 setTransactionFlags(eTransactionNeeded);
2916
2917 const int32_t layerId = getSequence();
2918 mFlinger->mTimeStats->setPostTime(layerId, mDrawingState.frameNumber, getName().c_str(),
2919 mOwnerUid, postTime, getGameMode());
2920 mDrawingState.desiredPresentTime = desiredPresentTime;
2921 mDrawingState.isAutoTimestamp = isAutoTimestamp;
2922
2923 const nsecs_t presentTime = [&] {
2924 if (!isAutoTimestamp) return desiredPresentTime;
2925
2926 const auto prediction =
2927 mFlinger->mFrameTimeline->getTokenManager()->getPredictionsForToken(info.vsyncId);
2928 if (prediction.has_value()) return prediction->presentTime;
2929
2930 return static_cast<nsecs_t>(0);
2931 }();
2932
2933 using LayerUpdateType = scheduler::LayerHistory::LayerUpdateType;
2934 mFlinger->mScheduler->recordLayerHistory(this, presentTime, LayerUpdateType::Buffer);
2935
2936 setFrameTimelineVsyncForBufferTransaction(info, postTime);
2937
2938 if (dequeueTime && *dequeueTime != 0) {
2939 const uint64_t bufferId = mDrawingState.buffer->getId();
2940 mFlinger->mFrameTracer->traceNewLayer(layerId, getName().c_str());
2941 mFlinger->mFrameTracer->traceTimestamp(layerId, bufferId, frameNumber, *dequeueTime,
2942 FrameTracer::FrameEvent::DEQUEUE);
2943 mFlinger->mFrameTracer->traceTimestamp(layerId, bufferId, frameNumber, postTime,
2944 FrameTracer::FrameEvent::QUEUE);
2945 }
2946
2947 mDrawingState.releaseBufferEndpoint = bufferData.releaseBufferEndpoint;
2948 return true;
2949}
2950
2951bool Layer::setDataspace(ui::Dataspace dataspace) {
2952 mDrawingState.dataspaceRequested = true;
2953 if (mDrawingState.dataspace == dataspace) return false;
2954 mDrawingState.dataspace = dataspace;
2955 mDrawingState.modified = true;
2956 setTransactionFlags(eTransactionNeeded);
2957 return true;
2958}
2959
2960bool Layer::setHdrMetadata(const HdrMetadata& hdrMetadata) {
2961 if (mDrawingState.hdrMetadata == hdrMetadata) return false;
2962 mDrawingState.hdrMetadata = hdrMetadata;
2963 mDrawingState.modified = true;
2964 setTransactionFlags(eTransactionNeeded);
2965 return true;
2966}
2967
2968bool Layer::setSurfaceDamageRegion(const Region& surfaceDamage) {
2969 mDrawingState.surfaceDamageRegion = surfaceDamage;
2970 mDrawingState.modified = true;
2971 setTransactionFlags(eTransactionNeeded);
2972 return true;
2973}
2974
2975bool Layer::setApi(int32_t api) {
2976 if (mDrawingState.api == api) return false;
2977 mDrawingState.api = api;
2978 mDrawingState.modified = true;
2979 setTransactionFlags(eTransactionNeeded);
2980 return true;
2981}
2982
2983bool Layer::setSidebandStream(const sp<NativeHandle>& sidebandStream) {
2984 if (mDrawingState.sidebandStream == sidebandStream) return false;
2985
2986 if (mDrawingState.sidebandStream != nullptr && sidebandStream == nullptr) {
2987 mFlinger->mTunnelModeEnabledReporter->decrementTunnelModeCount();
2988 } else if (sidebandStream != nullptr) {
2989 mFlinger->mTunnelModeEnabledReporter->incrementTunnelModeCount();
2990 }
2991
2992 mDrawingState.sidebandStream = sidebandStream;
2993 mDrawingState.modified = true;
2994 setTransactionFlags(eTransactionNeeded);
2995 if (!mSidebandStreamChanged.exchange(true)) {
2996 // mSidebandStreamChanged was false
2997 mFlinger->onLayerUpdate();
2998 }
2999 return true;
3000}
3001
3002bool Layer::setTransactionCompletedListeners(const std::vector<sp<CallbackHandle>>& handles) {
3003 // If there is no handle, we will not send a callback so reset mReleasePreviousBuffer and return
3004 if (handles.empty()) {
3005 mReleasePreviousBuffer = false;
3006 return false;
3007 }
3008
3009 const bool willPresent = willPresentCurrentTransaction();
3010
3011 for (const auto& handle : handles) {
3012 // If this transaction set a buffer on this layer, release its previous buffer
3013 handle->releasePreviousBuffer = mReleasePreviousBuffer;
3014
3015 // If this layer will be presented in this frame
3016 if (willPresent) {
3017 // If this transaction set an acquire fence on this layer, set its acquire time
3018 handle->acquireTimeOrFence = mCallbackHandleAcquireTimeOrFence;
3019 handle->frameNumber = mDrawingState.frameNumber;
3020
3021 // Store so latched time and release fence can be set
3022 mDrawingState.callbackHandles.push_back(handle);
3023
3024 } else { // If this layer will NOT need to be relatched and presented this frame
3025 // Notify the transaction completed thread this handle is done
3026 mFlinger->getTransactionCallbackInvoker().registerUnpresentedCallbackHandle(handle);
3027 }
3028 }
3029
3030 mReleasePreviousBuffer = false;
3031 mCallbackHandleAcquireTimeOrFence = -1;
3032
3033 return willPresent;
3034}
3035
3036Rect Layer::getBufferSize(const State& /*s*/) const {
3037 // for buffer state layers we use the display frame size as the buffer size.
3038
3039 if (mBufferInfo.mBuffer == nullptr) {
3040 return Rect::INVALID_RECT;
3041 }
3042
3043 uint32_t bufWidth = mBufferInfo.mBuffer->getWidth();
3044 uint32_t bufHeight = mBufferInfo.mBuffer->getHeight();
3045
3046 // Undo any transformations on the buffer and return the result.
3047 if (mBufferInfo.mTransform & ui::Transform::ROT_90) {
3048 std::swap(bufWidth, bufHeight);
3049 }
3050
3051 if (getTransformToDisplayInverse()) {
3052 uint32_t invTransform = DisplayDevice::getPrimaryDisplayRotationFlags();
3053 if (invTransform & ui::Transform::ROT_90) {
3054 std::swap(bufWidth, bufHeight);
3055 }
3056 }
3057
3058 return Rect(0, 0, static_cast<int32_t>(bufWidth), static_cast<int32_t>(bufHeight));
3059}
3060
3061FloatRect Layer::computeSourceBounds(const FloatRect& parentBounds) const {
3062 if (mBufferInfo.mBuffer == nullptr) {
3063 return parentBounds;
3064 }
3065
3066 return getBufferSize(getDrawingState()).toFloatRect();
3067}
3068
3069bool Layer::fenceHasSignaled() const {
3070 if (SurfaceFlinger::enableLatchUnsignaledConfig != LatchUnsignaledConfig::Disabled) {
3071 return true;
3072 }
3073
3074 const bool fenceSignaled =
3075 getDrawingState().acquireFence->getStatus() == Fence::Status::Signaled;
3076 if (!fenceSignaled) {
3077 mFlinger->mTimeStats->incrementLatchSkipped(getSequence(),
3078 TimeStats::LatchSkipReason::LateAcquire);
3079 }
3080
3081 return fenceSignaled;
3082}
3083
Vishnu Naire14c6b32022-08-06 04:20:15 +00003084bool Layer::onPreComposition(nsecs_t refreshStartTime) {
Patrick Williamsbb25f802022-08-30 23:02:34 +00003085 for (const auto& handle : mDrawingState.callbackHandles) {
3086 handle->refreshStartTime = refreshStartTime;
3087 }
3088 return hasReadyFrame();
3089}
3090
3091void Layer::setAutoRefresh(bool autoRefresh) {
3092 mDrawingState.autoRefresh = autoRefresh;
3093}
3094
3095bool Layer::latchSidebandStream(bool& recomputeVisibleRegions) {
3096 // We need to update the sideband stream if the layer has both a buffer and a sideband stream.
Vishnu Nairbedb44b2022-08-02 21:47:40 +00003097 auto* snapshot = editLayerSnapshot();
3098 snapshot->sidebandStreamHasFrame = hasFrameUpdate() && mSidebandStream.get();
Patrick Williamsbb25f802022-08-30 23:02:34 +00003099
3100 if (mSidebandStreamChanged.exchange(false)) {
3101 const State& s(getDrawingState());
3102 // mSidebandStreamChanged was true
3103 mSidebandStream = s.sidebandStream;
Vishnu Nairbedb44b2022-08-02 21:47:40 +00003104 snapshot->sidebandStream = mSidebandStream;
Patrick Williamsbb25f802022-08-30 23:02:34 +00003105 if (mSidebandStream != nullptr) {
3106 setTransactionFlags(eTransactionNeeded);
3107 mFlinger->setTransactionFlags(eTraversalNeeded);
3108 }
3109 recomputeVisibleRegions = true;
3110
3111 return true;
3112 }
3113 return false;
3114}
3115
3116bool Layer::hasFrameUpdate() const {
3117 const State& c(getDrawingState());
3118 return (mDrawingStateModified || mDrawingState.modified) &&
3119 (c.buffer != nullptr || c.bgColorLayer != nullptr);
3120}
3121
3122void Layer::updateTexImage(nsecs_t latchTime) {
3123 const State& s(getDrawingState());
3124
3125 if (!s.buffer) {
3126 if (s.bgColorLayer) {
3127 for (auto& handle : mDrawingState.callbackHandles) {
3128 handle->latchTime = latchTime;
3129 }
3130 }
3131 return;
3132 }
3133
3134 for (auto& handle : mDrawingState.callbackHandles) {
3135 if (handle->frameNumber == mDrawingState.frameNumber) {
3136 handle->latchTime = latchTime;
3137 }
3138 }
3139
3140 const int32_t layerId = getSequence();
3141 const uint64_t bufferId = mDrawingState.buffer->getId();
3142 const uint64_t frameNumber = mDrawingState.frameNumber;
3143 const auto acquireFence = std::make_shared<FenceTime>(mDrawingState.acquireFence);
3144 mFlinger->mTimeStats->setAcquireFence(layerId, frameNumber, acquireFence);
3145 mFlinger->mTimeStats->setLatchTime(layerId, frameNumber, latchTime);
3146
3147 mFlinger->mFrameTracer->traceFence(layerId, bufferId, frameNumber, acquireFence,
3148 FrameTracer::FrameEvent::ACQUIRE_FENCE);
3149 mFlinger->mFrameTracer->traceTimestamp(layerId, bufferId, frameNumber, latchTime,
3150 FrameTracer::FrameEvent::LATCH);
3151
3152 auto& bufferSurfaceFrame = mDrawingState.bufferSurfaceFrameTX;
3153 if (bufferSurfaceFrame != nullptr &&
3154 bufferSurfaceFrame->getPresentState() != PresentState::Presented) {
3155 // Update only if the bufferSurfaceFrame wasn't already presented. A Presented
3156 // bufferSurfaceFrame could be seen here if a pending state was applied successfully and we
3157 // are processing the next state.
3158 addSurfaceFramePresentedForBuffer(bufferSurfaceFrame,
3159 mDrawingState.acquireFenceTime->getSignalTime(),
3160 latchTime);
3161 mDrawingState.bufferSurfaceFrameTX.reset();
3162 }
3163
3164 std::deque<sp<CallbackHandle>> remainingHandles;
3165 mFlinger->getTransactionCallbackInvoker()
3166 .addOnCommitCallbackHandles(mDrawingState.callbackHandles, remainingHandles);
3167 mDrawingState.callbackHandles = remainingHandles;
3168
3169 mDrawingStateModified = false;
3170}
3171
3172void Layer::gatherBufferInfo() {
3173 if (!mBufferInfo.mBuffer || !mDrawingState.buffer->hasSameBuffer(*mBufferInfo.mBuffer)) {
3174 decrementPendingBufferCount();
3175 }
3176
3177 mPreviousReleaseCallbackId = {getCurrentBufferId(), mBufferInfo.mFrameNumber};
3178 mBufferInfo.mBuffer = mDrawingState.buffer;
3179 mBufferInfo.mFence = mDrawingState.acquireFence;
3180 mBufferInfo.mFrameNumber = mDrawingState.frameNumber;
3181 mBufferInfo.mPixelFormat =
3182 !mBufferInfo.mBuffer ? PIXEL_FORMAT_NONE : mBufferInfo.mBuffer->getPixelFormat();
3183 mBufferInfo.mFrameLatencyNeeded = true;
3184 mBufferInfo.mDesiredPresentTime = mDrawingState.desiredPresentTime;
3185 mBufferInfo.mFenceTime = std::make_shared<FenceTime>(mDrawingState.acquireFence);
3186 mBufferInfo.mFence = mDrawingState.acquireFence;
3187 mBufferInfo.mTransform = mDrawingState.bufferTransform;
3188 auto lastDataspace = mBufferInfo.mDataspace;
3189 mBufferInfo.mDataspace = translateDataspace(mDrawingState.dataspace);
3190 if (lastDataspace != mBufferInfo.mDataspace) {
3191 mFlinger->mSomeDataspaceChanged = true;
3192 }
3193 mBufferInfo.mCrop = computeBufferCrop(mDrawingState);
3194 mBufferInfo.mScaleMode = NATIVE_WINDOW_SCALING_MODE_SCALE_TO_WINDOW;
3195 mBufferInfo.mSurfaceDamage = mDrawingState.surfaceDamageRegion;
3196 mBufferInfo.mHdrMetadata = mDrawingState.hdrMetadata;
3197 mBufferInfo.mApi = mDrawingState.api;
3198 mBufferInfo.mTransformToDisplayInverse = mDrawingState.transformToDisplayInverse;
3199 mBufferInfo.mBufferSlot = mHwcSlotGenerator->getHwcCacheSlot(mDrawingState.clientCacheId);
3200}
3201
3202Rect Layer::computeBufferCrop(const State& s) {
3203 if (s.buffer && !s.bufferCrop.isEmpty()) {
3204 Rect bufferCrop;
3205 s.buffer->getBounds().intersect(s.bufferCrop, &bufferCrop);
3206 return bufferCrop;
3207 } else if (s.buffer) {
3208 return s.buffer->getBounds();
3209 } else {
3210 return s.bufferCrop;
3211 }
3212}
3213
3214sp<Layer> Layer::createClone() {
3215 LayerCreationArgs args(mFlinger.get(), nullptr, mName + " (Mirror)", 0, LayerMetadata());
3216 args.textureName = mTextureName;
Patrick Williams83f36b22022-09-14 17:57:35 +00003217 sp<Layer> layer = mFlinger->getFactory().createBufferStateLayer(args);
Patrick Williamsbb25f802022-08-30 23:02:34 +00003218 layer->mHwcSlotGenerator = mHwcSlotGenerator;
3219 layer->setInitialValuesForClone(sp<Layer>::fromExisting(this));
3220 return layer;
3221}
3222
3223bool Layer::bufferNeedsFiltering() const {
3224 const State& s(getDrawingState());
3225 if (!s.buffer) {
3226 return false;
3227 }
3228
3229 int32_t bufferWidth = static_cast<int32_t>(s.buffer->getWidth());
3230 int32_t bufferHeight = static_cast<int32_t>(s.buffer->getHeight());
3231
3232 // Undo any transformations on the buffer and return the result.
3233 if (s.bufferTransform & ui::Transform::ROT_90) {
3234 std::swap(bufferWidth, bufferHeight);
3235 }
3236
3237 if (s.transformToDisplayInverse) {
3238 uint32_t invTransform = DisplayDevice::getPrimaryDisplayRotationFlags();
3239 if (invTransform & ui::Transform::ROT_90) {
3240 std::swap(bufferWidth, bufferHeight);
3241 }
3242 }
3243
3244 const Rect layerSize{getBounds()};
3245 int32_t layerWidth = layerSize.getWidth();
3246 int32_t layerHeight = layerSize.getHeight();
3247
3248 // Align the layer orientation with the buffer before comparism
3249 if (mTransformHint & ui::Transform::ROT_90) {
3250 std::swap(layerWidth, layerHeight);
3251 }
3252
3253 return layerWidth != bufferWidth || layerHeight != bufferHeight;
3254}
3255
3256void Layer::decrementPendingBufferCount() {
3257 int32_t pendingBuffers = --mPendingBufferTransactions;
3258 tracePendingBufferCount(pendingBuffers);
3259}
3260
3261void Layer::tracePendingBufferCount(int32_t pendingBuffers) {
3262 ATRACE_INT(mBlastTransactionName.c_str(), pendingBuffers);
3263}
3264
3265/*
3266 * We don't want to send the layer's transform to input, but rather the
3267 * parent's transform. This is because Layer's transform is
3268 * information about how the buffer is placed on screen. The parent's
3269 * transform makes more sense to send since it's information about how the
3270 * layer is placed on screen. This transform is used by input to determine
3271 * how to go from screen space back to window space.
3272 */
3273ui::Transform Layer::getInputTransform() const {
3274 if (!hasBufferOrSidebandStream()) {
3275 return getTransform();
3276 }
3277 sp<Layer> parent = mDrawingParent.promote();
3278 if (parent == nullptr) {
3279 return ui::Transform();
3280 }
3281
3282 return parent->getTransform();
3283}
3284
3285/**
3286 * Similar to getInputTransform, we need to update the bounds to include the transform.
3287 * This is because bounds don't include the buffer transform, where the input assumes
3288 * that's already included.
3289 */
3290Rect Layer::getInputBounds() const {
3291 if (!hasBufferOrSidebandStream()) {
3292 return getCroppedBufferSize(getDrawingState());
3293 }
3294
3295 Rect bufferBounds = getCroppedBufferSize(getDrawingState());
3296 if (mDrawingState.transform.getType() == ui::Transform::IDENTITY || !bufferBounds.isValid()) {
3297 return bufferBounds;
3298 }
3299 return mDrawingState.transform.transform(bufferBounds);
3300}
3301
3302bool Layer::simpleBufferUpdate(const layer_state_t& s) const {
3303 const uint64_t requiredFlags = layer_state_t::eBufferChanged;
3304
3305 const uint64_t deniedFlags = layer_state_t::eProducerDisconnect | layer_state_t::eLayerChanged |
3306 layer_state_t::eRelativeLayerChanged | layer_state_t::eTransparentRegionChanged |
3307 layer_state_t::eFlagsChanged | layer_state_t::eBlurRegionsChanged |
3308 layer_state_t::eLayerStackChanged | layer_state_t::eAutoRefreshChanged |
3309 layer_state_t::eReparent;
3310
3311 const uint64_t allowedFlags = layer_state_t::eHasListenerCallbacksChanged |
3312 layer_state_t::eFrameRateSelectionPriority | layer_state_t::eFrameRateChanged |
3313 layer_state_t::eSurfaceDamageRegionChanged | layer_state_t::eApiChanged |
3314 layer_state_t::eMetadataChanged | layer_state_t::eDropInputModeChanged |
3315 layer_state_t::eInputInfoChanged;
3316
3317 if ((s.what & requiredFlags) != requiredFlags) {
3318 ALOGV("%s: false [missing required flags 0x%" PRIx64 "]", __func__,
3319 (s.what | requiredFlags) & ~s.what);
3320 return false;
3321 }
3322
3323 if (s.what & deniedFlags) {
3324 ALOGV("%s: false [has denied flags 0x%" PRIx64 "]", __func__, s.what & deniedFlags);
3325 return false;
3326 }
3327
3328 if (s.what & allowedFlags) {
3329 ALOGV("%s: [has allowed flags 0x%" PRIx64 "]", __func__, s.what & allowedFlags);
3330 }
3331
3332 if (s.what & layer_state_t::ePositionChanged) {
3333 if (mRequestedTransform.tx() != s.x || mRequestedTransform.ty() != s.y) {
3334 ALOGV("%s: false [ePositionChanged changed]", __func__);
3335 return false;
3336 }
3337 }
3338
3339 if (s.what & layer_state_t::eAlphaChanged) {
Vishnu Nairbbceb462022-10-10 04:52:13 +00003340 if (mDrawingState.color.a != s.color.a) {
Patrick Williamsbb25f802022-08-30 23:02:34 +00003341 ALOGV("%s: false [eAlphaChanged changed]", __func__);
3342 return false;
3343 }
3344 }
3345
3346 if (s.what & layer_state_t::eColorTransformChanged) {
3347 if (mDrawingState.colorTransform != s.colorTransform) {
3348 ALOGV("%s: false [eColorTransformChanged changed]", __func__);
3349 return false;
3350 }
3351 }
3352
3353 if (s.what & layer_state_t::eBackgroundColorChanged) {
3354 if (mDrawingState.bgColorLayer || s.bgColorAlpha != 0) {
3355 ALOGV("%s: false [eBackgroundColorChanged changed]", __func__);
3356 return false;
3357 }
3358 }
3359
3360 if (s.what & layer_state_t::eMatrixChanged) {
3361 if (mRequestedTransform.dsdx() != s.matrix.dsdx ||
3362 mRequestedTransform.dtdy() != s.matrix.dtdy ||
3363 mRequestedTransform.dtdx() != s.matrix.dtdx ||
3364 mRequestedTransform.dsdy() != s.matrix.dsdy) {
3365 ALOGV("%s: false [eMatrixChanged changed]", __func__);
3366 return false;
3367 }
3368 }
3369
3370 if (s.what & layer_state_t::eCornerRadiusChanged) {
3371 if (mDrawingState.cornerRadius != s.cornerRadius) {
3372 ALOGV("%s: false [eCornerRadiusChanged changed]", __func__);
3373 return false;
3374 }
3375 }
3376
3377 if (s.what & layer_state_t::eBackgroundBlurRadiusChanged) {
3378 if (mDrawingState.backgroundBlurRadius != static_cast<int>(s.backgroundBlurRadius)) {
3379 ALOGV("%s: false [eBackgroundBlurRadiusChanged changed]", __func__);
3380 return false;
3381 }
3382 }
3383
Vishnu Nairbbceb462022-10-10 04:52:13 +00003384 if (s.what & layer_state_t::eBufferTransformChanged) {
3385 if (mDrawingState.bufferTransform != s.bufferTransform) {
3386 ALOGV("%s: false [eBufferTransformChanged changed]", __func__);
Patrick Williamsbb25f802022-08-30 23:02:34 +00003387 return false;
3388 }
3389 }
3390
3391 if (s.what & layer_state_t::eTransformToDisplayInverseChanged) {
3392 if (mDrawingState.transformToDisplayInverse != s.transformToDisplayInverse) {
3393 ALOGV("%s: false [eTransformToDisplayInverseChanged changed]", __func__);
3394 return false;
3395 }
3396 }
3397
3398 if (s.what & layer_state_t::eCropChanged) {
3399 if (mDrawingState.crop != s.crop) {
3400 ALOGV("%s: false [eCropChanged changed]", __func__);
3401 return false;
3402 }
3403 }
3404
3405 if (s.what & layer_state_t::eDataspaceChanged) {
3406 if (mDrawingState.dataspace != s.dataspace) {
3407 ALOGV("%s: false [eDataspaceChanged changed]", __func__);
3408 return false;
3409 }
3410 }
3411
3412 if (s.what & layer_state_t::eHdrMetadataChanged) {
3413 if (mDrawingState.hdrMetadata != s.hdrMetadata) {
3414 ALOGV("%s: false [eHdrMetadataChanged changed]", __func__);
3415 return false;
3416 }
3417 }
3418
3419 if (s.what & layer_state_t::eSidebandStreamChanged) {
3420 if (mDrawingState.sidebandStream != s.sidebandStream) {
3421 ALOGV("%s: false [eSidebandStreamChanged changed]", __func__);
3422 return false;
3423 }
3424 }
3425
3426 if (s.what & layer_state_t::eColorSpaceAgnosticChanged) {
3427 if (mDrawingState.colorSpaceAgnostic != s.colorSpaceAgnostic) {
3428 ALOGV("%s: false [eColorSpaceAgnosticChanged changed]", __func__);
3429 return false;
3430 }
3431 }
3432
3433 if (s.what & layer_state_t::eShadowRadiusChanged) {
3434 if (mDrawingState.shadowRadius != s.shadowRadius) {
3435 ALOGV("%s: false [eShadowRadiusChanged changed]", __func__);
3436 return false;
3437 }
3438 }
3439
3440 if (s.what & layer_state_t::eFixedTransformHintChanged) {
3441 if (mDrawingState.fixedTransformHint != s.fixedTransformHint) {
3442 ALOGV("%s: false [eFixedTransformHintChanged changed]", __func__);
3443 return false;
3444 }
3445 }
3446
3447 if (s.what & layer_state_t::eTrustedOverlayChanged) {
3448 if (mDrawingState.isTrustedOverlay != s.isTrustedOverlay) {
3449 ALOGV("%s: false [eTrustedOverlayChanged changed]", __func__);
3450 return false;
3451 }
3452 }
3453
3454 if (s.what & layer_state_t::eStretchChanged) {
3455 StretchEffect temp = s.stretchEffect;
3456 temp.sanitize();
3457 if (mDrawingState.stretchEffect != temp) {
3458 ALOGV("%s: false [eStretchChanged changed]", __func__);
3459 return false;
3460 }
3461 }
3462
3463 if (s.what & layer_state_t::eBufferCropChanged) {
3464 if (mDrawingState.bufferCrop != s.bufferCrop) {
3465 ALOGV("%s: false [eBufferCropChanged changed]", __func__);
3466 return false;
3467 }
3468 }
3469
3470 if (s.what & layer_state_t::eDestinationFrameChanged) {
3471 if (mDrawingState.destinationFrame != s.destinationFrame) {
3472 ALOGV("%s: false [eDestinationFrameChanged changed]", __func__);
3473 return false;
3474 }
3475 }
3476
3477 if (s.what & layer_state_t::eDimmingEnabledChanged) {
3478 if (mDrawingState.dimmingEnabled != s.dimmingEnabled) {
3479 ALOGV("%s: false [eDimmingEnabledChanged changed]", __func__);
3480 return false;
3481 }
3482 }
3483
3484 ALOGV("%s: true", __func__);
3485 return true;
3486}
3487
3488bool Layer::isHdrY410() const {
3489 // pixel format is HDR Y410 masquerading as RGBA_1010102
3490 return (mBufferInfo.mDataspace == ui::Dataspace::BT2020_ITU_PQ &&
3491 mBufferInfo.mApi == NATIVE_WINDOW_API_MEDIA &&
3492 mBufferInfo.mPixelFormat == HAL_PIXEL_FORMAT_RGBA_1010102);
3493}
3494
Vishnu Naire14c6b32022-08-06 04:20:15 +00003495sp<LayerFE> Layer::getCompositionEngineLayerFE() const {
Patrick Williamsbb25f802022-08-30 23:02:34 +00003496 // There's no need to get a CE Layer if the layer isn't going to draw anything.
Vishnu Naire14c6b32022-08-06 04:20:15 +00003497 return hasSomethingToDraw() ? mLayerFE : nullptr;
Patrick Williamsbb25f802022-08-30 23:02:34 +00003498}
3499
Vishnu Naire14c6b32022-08-06 04:20:15 +00003500const LayerSnapshot* Layer::getLayerSnapshot() const {
Vishnu Nairbedb44b2022-08-02 21:47:40 +00003501 return mSnapshot.get();
Patrick Williamsbb25f802022-08-30 23:02:34 +00003502}
3503
Vishnu Naire14c6b32022-08-06 04:20:15 +00003504LayerSnapshot* Layer::editLayerSnapshot() {
Vishnu Nairbedb44b2022-08-02 21:47:40 +00003505 return mSnapshot.get();
3506}
Vishnu Naire14c6b32022-08-06 04:20:15 +00003507
Patrick Williamsbb25f802022-08-30 23:02:34 +00003508const compositionengine::LayerFECompositionState* Layer::getCompositionState() const {
Vishnu Nairbedb44b2022-08-02 21:47:40 +00003509 return mSnapshot.get();
Patrick Williamsbb25f802022-08-30 23:02:34 +00003510}
3511
Vishnu Naire14c6b32022-08-06 04:20:15 +00003512void Layer::moveSnapshotToLayerFE() {
3513 mLayerFE->mSnapshot = std::move(mSnapshot);
3514}
3515
3516void Layer::moveSnapshotToLayer() {
3517 mSnapshot = std::move(mLayerFE->mSnapshot);
3518}
3519
Patrick Williamsbb25f802022-08-30 23:02:34 +00003520void Layer::useSurfaceDamage() {
3521 if (mFlinger->mForceFullDamage) {
3522 surfaceDamageRegion = Region::INVALID_REGION;
3523 } else {
3524 surfaceDamageRegion = mBufferInfo.mSurfaceDamage;
3525 }
3526}
3527
3528void Layer::useEmptyDamage() {
3529 surfaceDamageRegion.clear();
3530}
3531
3532bool Layer::isOpaque(const Layer::State& s) const {
3533 // if we don't have a buffer or sidebandStream yet, we're translucent regardless of the
3534 // layer's opaque flag.
3535 if (!hasSomethingToDraw()) {
3536 return false;
3537 }
3538
3539 // if the layer has the opaque flag, then we're always opaque
3540 if ((s.flags & layer_state_t::eLayerOpaque) == layer_state_t::eLayerOpaque) {
3541 return true;
3542 }
3543
3544 // If the buffer has no alpha channel, then we are opaque
3545 if (hasBufferOrSidebandStream() && isOpaqueFormat(getPixelFormat())) {
3546 return true;
3547 }
3548
3549 // Lastly consider the layer opaque if drawing a color with alpha == 1.0
3550 return fillsColor() && getAlpha() == 1.0_hf;
3551}
3552
3553bool Layer::canReceiveInput() const {
3554 return !isHiddenByPolicy() && (mBufferInfo.mBuffer == nullptr || getAlpha() > 0.0f);
3555}
3556
3557bool Layer::isVisible() const {
3558 if (!hasSomethingToDraw()) {
3559 return false;
3560 }
3561
3562 if (isHiddenByPolicy()) {
3563 return false;
3564 }
3565
3566 return getAlpha() > 0.0f || hasBlur();
3567}
3568
3569void Layer::onPostComposition(const DisplayDevice* display,
3570 const std::shared_ptr<FenceTime>& glDoneFence,
3571 const std::shared_ptr<FenceTime>& presentFence,
3572 const CompositorTiming& compositorTiming) {
3573 // mFrameLatencyNeeded is true when a new frame was latched for the
3574 // composition.
3575 if (!mBufferInfo.mFrameLatencyNeeded) return;
3576
3577 for (const auto& handle : mDrawingState.callbackHandles) {
3578 handle->gpuCompositionDoneFence = glDoneFence;
3579 handle->compositorTiming = compositorTiming;
3580 }
3581
3582 // Update mFrameTracker.
3583 nsecs_t desiredPresentTime = mBufferInfo.mDesiredPresentTime;
3584 mFrameTracker.setDesiredPresentTime(desiredPresentTime);
3585
3586 const int32_t layerId = getSequence();
3587 mFlinger->mTimeStats->setDesiredTime(layerId, mCurrentFrameNumber, desiredPresentTime);
3588
3589 const auto outputLayer = findOutputLayerForDisplay(display);
3590 if (outputLayer && outputLayer->requiresClientComposition()) {
3591 nsecs_t clientCompositionTimestamp = outputLayer->getState().clientCompositionTimestamp;
3592 mFlinger->mFrameTracer->traceTimestamp(layerId, getCurrentBufferId(), mCurrentFrameNumber,
3593 clientCompositionTimestamp,
3594 FrameTracer::FrameEvent::FALLBACK_COMPOSITION);
3595 // Update the SurfaceFrames in the drawing state
3596 if (mDrawingState.bufferSurfaceFrameTX) {
3597 mDrawingState.bufferSurfaceFrameTX->setGpuComposition();
3598 }
3599 for (auto& [token, surfaceFrame] : mDrawingState.bufferlessSurfaceFramesTX) {
3600 surfaceFrame->setGpuComposition();
3601 }
3602 }
3603
3604 std::shared_ptr<FenceTime> frameReadyFence = mBufferInfo.mFenceTime;
3605 if (frameReadyFence->isValid()) {
3606 mFrameTracker.setFrameReadyFence(std::move(frameReadyFence));
3607 } else {
3608 // There was no fence for this frame, so assume that it was ready
3609 // to be presented at the desired present time.
3610 mFrameTracker.setFrameReadyTime(desiredPresentTime);
3611 }
3612
3613 if (display) {
Dominik Laskowskif8734e02022-08-26 09:06:59 -07003614 const Fps refreshRate = display->refreshRateConfigs().getActiveModePtr()->getFps();
Patrick Williamsbb25f802022-08-30 23:02:34 +00003615 const std::optional<Fps> renderRate =
3616 mFlinger->mScheduler->getFrameRateOverride(getOwnerUid());
3617
3618 const auto vote = frameRateToSetFrameRateVotePayload(mDrawingState.frameRate);
3619 const auto gameMode = getGameMode();
3620
3621 if (presentFence->isValid()) {
3622 mFlinger->mTimeStats->setPresentFence(layerId, mCurrentFrameNumber, presentFence,
3623 refreshRate, renderRate, vote, gameMode);
3624 mFlinger->mFrameTracer->traceFence(layerId, getCurrentBufferId(), mCurrentFrameNumber,
3625 presentFence,
3626 FrameTracer::FrameEvent::PRESENT_FENCE);
3627 mFrameTracker.setActualPresentFence(std::shared_ptr<FenceTime>(presentFence));
3628 } else if (const auto displayId = PhysicalDisplayId::tryCast(display->getId());
3629 displayId && mFlinger->getHwComposer().isConnected(*displayId)) {
Dominik Laskowskidc2bb802022-09-28 16:02:59 -04003630 // The HWC doesn't support present fences, so use the present timestamp instead.
3631 const nsecs_t presentTimestamp =
3632 mFlinger->getHwComposer().getPresentTimestamp(*displayId);
3633
3634 const nsecs_t now = systemTime(CLOCK_MONOTONIC);
3635 const nsecs_t vsyncPeriod = display->getVsyncPeriodFromHWC();
3636 const nsecs_t actualPresentTime = now - ((now - presentTimestamp) % vsyncPeriod);
3637
Patrick Williamsbb25f802022-08-30 23:02:34 +00003638 mFlinger->mTimeStats->setPresentTime(layerId, mCurrentFrameNumber, actualPresentTime,
3639 refreshRate, renderRate, vote, gameMode);
3640 mFlinger->mFrameTracer->traceTimestamp(layerId, getCurrentBufferId(),
3641 mCurrentFrameNumber, actualPresentTime,
3642 FrameTracer::FrameEvent::PRESENT_FENCE);
3643 mFrameTracker.setActualPresentTime(actualPresentTime);
3644 }
3645 }
3646
3647 mFrameTracker.advanceFrame();
3648 mBufferInfo.mFrameLatencyNeeded = false;
3649}
3650
3651bool Layer::latchBuffer(bool& recomputeVisibleRegions, nsecs_t latchTime) {
3652 ATRACE_FORMAT_INSTANT("latchBuffer %s - %" PRIu64, getDebugName(),
3653 getDrawingState().frameNumber);
3654
3655 bool refreshRequired = latchSidebandStream(recomputeVisibleRegions);
3656
3657 if (refreshRequired) {
3658 return refreshRequired;
3659 }
3660
3661 // If the head buffer's acquire fence hasn't signaled yet, return and
3662 // try again later
3663 if (!fenceHasSignaled()) {
3664 ATRACE_NAME("!fenceHasSignaled()");
3665 mFlinger->onLayerUpdate();
3666 return false;
3667 }
3668
3669 updateTexImage(latchTime);
3670 if (mDrawingState.buffer == nullptr) {
3671 return false;
3672 }
3673
3674 // Capture the old state of the layer for comparisons later
3675 BufferInfo oldBufferInfo = mBufferInfo;
3676 const bool oldOpacity = isOpaque(mDrawingState);
3677 mPreviousFrameNumber = mCurrentFrameNumber;
3678 mCurrentFrameNumber = mDrawingState.frameNumber;
3679 gatherBufferInfo();
3680
3681 if (oldBufferInfo.mBuffer == nullptr) {
3682 // the first time we receive a buffer, we need to trigger a
3683 // geometry invalidation.
3684 recomputeVisibleRegions = true;
3685 }
3686
3687 if ((mBufferInfo.mCrop != oldBufferInfo.mCrop) ||
3688 (mBufferInfo.mTransform != oldBufferInfo.mTransform) ||
3689 (mBufferInfo.mScaleMode != oldBufferInfo.mScaleMode) ||
3690 (mBufferInfo.mTransformToDisplayInverse != oldBufferInfo.mTransformToDisplayInverse)) {
3691 recomputeVisibleRegions = true;
3692 }
3693
3694 if (oldBufferInfo.mBuffer != nullptr) {
3695 uint32_t bufWidth = mBufferInfo.mBuffer->getWidth();
3696 uint32_t bufHeight = mBufferInfo.mBuffer->getHeight();
3697 if (bufWidth != oldBufferInfo.mBuffer->getWidth() ||
3698 bufHeight != oldBufferInfo.mBuffer->getHeight()) {
3699 recomputeVisibleRegions = true;
3700 }
3701 }
3702
3703 if (oldOpacity != isOpaque(mDrawingState)) {
3704 recomputeVisibleRegions = true;
3705 }
3706
3707 return true;
3708}
3709
3710bool Layer::hasReadyFrame() const {
3711 return hasFrameUpdate() || getSidebandStreamChanged() || getAutoRefresh();
3712}
3713
3714bool Layer::isProtected() const {
3715 return (mBufferInfo.mBuffer != nullptr) &&
3716 (mBufferInfo.mBuffer->getUsage() & GRALLOC_USAGE_PROTECTED);
3717}
3718
3719// As documented in libhardware header, formats in the range
3720// 0x100 - 0x1FF are specific to the HAL implementation, and
3721// are known to have no alpha channel
3722// TODO: move definition for device-specific range into
3723// hardware.h, instead of using hard-coded values here.
3724#define HARDWARE_IS_DEVICE_FORMAT(f) ((f) >= 0x100 && (f) <= 0x1FF)
3725
3726bool Layer::isOpaqueFormat(PixelFormat format) {
3727 if (HARDWARE_IS_DEVICE_FORMAT(format)) {
3728 return true;
3729 }
3730 switch (format) {
3731 case PIXEL_FORMAT_RGBA_8888:
3732 case PIXEL_FORMAT_BGRA_8888:
3733 case PIXEL_FORMAT_RGBA_FP16:
3734 case PIXEL_FORMAT_RGBA_1010102:
3735 case PIXEL_FORMAT_R_8:
3736 return false;
3737 }
3738 // in all other case, we have no blending (also for unknown formats)
3739 return true;
3740}
3741
3742bool Layer::needsFiltering(const DisplayDevice* display) const {
3743 if (!hasBufferOrSidebandStream()) {
3744 return false;
3745 }
3746 const auto outputLayer = findOutputLayerForDisplay(display);
3747 if (outputLayer == nullptr) {
3748 return false;
3749 }
3750
3751 // We need filtering if the sourceCrop rectangle size does not match the
3752 // displayframe rectangle size (not a 1:1 render)
3753 const auto& compositionState = outputLayer->getState();
3754 const auto displayFrame = compositionState.displayFrame;
3755 const auto sourceCrop = compositionState.sourceCrop;
3756 return sourceCrop.getHeight() != displayFrame.getHeight() ||
3757 sourceCrop.getWidth() != displayFrame.getWidth();
3758}
3759
3760bool Layer::needsFilteringForScreenshots(const DisplayDevice* display,
3761 const ui::Transform& inverseParentTransform) const {
3762 if (!hasBufferOrSidebandStream()) {
3763 return false;
3764 }
3765 const auto outputLayer = findOutputLayerForDisplay(display);
3766 if (outputLayer == nullptr) {
3767 return false;
3768 }
3769
3770 // We need filtering if the sourceCrop rectangle size does not match the
3771 // viewport rectangle size (not a 1:1 render)
3772 const auto& compositionState = outputLayer->getState();
3773 const ui::Transform& displayTransform = display->getTransform();
3774 const ui::Transform inverseTransform = inverseParentTransform * displayTransform.inverse();
3775 // Undo the transformation of the displayFrame so that we're back into
3776 // layer-stack space.
3777 const Rect frame = inverseTransform.transform(compositionState.displayFrame);
3778 const FloatRect sourceCrop = compositionState.sourceCrop;
3779
3780 int32_t frameHeight = frame.getHeight();
3781 int32_t frameWidth = frame.getWidth();
3782 // If the display transform had a rotational component then undo the
3783 // rotation so that the orientation matches the source crop.
3784 if (displayTransform.getOrientation() & ui::Transform::ROT_90) {
3785 std::swap(frameHeight, frameWidth);
3786 }
3787 return sourceCrop.getHeight() != frameHeight || sourceCrop.getWidth() != frameWidth;
3788}
3789
3790void Layer::latchAndReleaseBuffer() {
3791 if (hasReadyFrame()) {
3792 bool ignored = false;
3793 latchBuffer(ignored, systemTime());
3794 }
3795 releasePendingBuffer(systemTime());
3796}
3797
3798PixelFormat Layer::getPixelFormat() const {
3799 return mBufferInfo.mPixelFormat;
3800}
3801
3802bool Layer::getTransformToDisplayInverse() const {
3803 return mBufferInfo.mTransformToDisplayInverse;
3804}
3805
3806Rect Layer::getBufferCrop() const {
3807 // this is the crop rectangle that applies to the buffer
3808 // itself (as opposed to the window)
3809 if (!mBufferInfo.mCrop.isEmpty()) {
3810 // if the buffer crop is defined, we use that
3811 return mBufferInfo.mCrop;
3812 } else if (mBufferInfo.mBuffer != nullptr) {
3813 // otherwise we use the whole buffer
3814 return mBufferInfo.mBuffer->getBounds();
3815 } else {
3816 // if we don't have a buffer yet, we use an empty/invalid crop
3817 return Rect();
3818 }
3819}
3820
3821uint32_t Layer::getBufferTransform() const {
3822 return mBufferInfo.mTransform;
3823}
3824
3825ui::Dataspace Layer::getDataSpace() const {
3826 return mDrawingState.dataspaceRequested ? getRequestedDataSpace() : ui::Dataspace::UNKNOWN;
3827}
3828
3829ui::Dataspace Layer::getRequestedDataSpace() const {
3830 return hasBufferOrSidebandStream() ? mBufferInfo.mDataspace : mDrawingState.dataspace;
3831}
3832
3833ui::Dataspace Layer::translateDataspace(ui::Dataspace dataspace) {
3834 ui::Dataspace updatedDataspace = dataspace;
3835 // translate legacy dataspaces to modern dataspaces
3836 switch (dataspace) {
3837 case ui::Dataspace::SRGB:
3838 updatedDataspace = ui::Dataspace::V0_SRGB;
3839 break;
3840 case ui::Dataspace::SRGB_LINEAR:
3841 updatedDataspace = ui::Dataspace::V0_SRGB_LINEAR;
3842 break;
3843 case ui::Dataspace::JFIF:
3844 updatedDataspace = ui::Dataspace::V0_JFIF;
3845 break;
3846 case ui::Dataspace::BT601_625:
3847 updatedDataspace = ui::Dataspace::V0_BT601_625;
3848 break;
3849 case ui::Dataspace::BT601_525:
3850 updatedDataspace = ui::Dataspace::V0_BT601_525;
3851 break;
3852 case ui::Dataspace::BT709:
3853 updatedDataspace = ui::Dataspace::V0_BT709;
3854 break;
3855 default:
3856 break;
3857 }
3858
3859 return updatedDataspace;
3860}
3861
3862sp<GraphicBuffer> Layer::getBuffer() const {
3863 return mBufferInfo.mBuffer ? mBufferInfo.mBuffer->getBuffer() : nullptr;
3864}
3865
Patrick Williamsbb25f802022-08-30 23:02:34 +00003866void Layer::setTransformHint(ui::Transform::RotationFlags displayTransformHint) {
3867 mTransformHint = getFixedTransformHint();
3868 if (mTransformHint == ui::Transform::ROT_INVALID) {
3869 mTransformHint = displayTransformHint;
3870 }
3871}
3872
3873const std::shared_ptr<renderengine::ExternalTexture>& Layer::getExternalTexture() const {
3874 return mBufferInfo.mBuffer;
3875}
3876
3877bool Layer::setColor(const half3& color) {
Vishnu Nairbbceb462022-10-10 04:52:13 +00003878 if (mDrawingState.color.rgb == color) {
Patrick Williamsbb25f802022-08-30 23:02:34 +00003879 return false;
3880 }
3881
3882 mDrawingState.sequence++;
Vishnu Nairbbceb462022-10-10 04:52:13 +00003883 mDrawingState.color.rgb = color;
Patrick Williamsbb25f802022-08-30 23:02:34 +00003884 mDrawingState.modified = true;
3885 setTransactionFlags(eTransactionNeeded);
3886 return true;
3887}
3888
3889bool Layer::fillsColor() const {
3890 return !hasBufferOrSidebandStream() && mDrawingState.color.r >= 0.0_hf &&
3891 mDrawingState.color.g >= 0.0_hf && mDrawingState.color.b >= 0.0_hf;
3892}
3893
3894bool Layer::hasBlur() const {
3895 return getBackgroundBlurRadius() > 0 || getDrawingState().blurRegions.size() > 0;
3896}
3897
Vishnu Nairba354102022-08-01 00:14:18 +00003898void Layer::updateSnapshot(bool updateGeometry) {
3899 if (!getCompositionEngineLayerFE()) {
3900 return;
3901 }
3902
Vishnu Nairbedb44b2022-08-02 21:47:40 +00003903 auto* snapshot = editLayerSnapshot();
Vishnu Nairba354102022-08-01 00:14:18 +00003904 if (updateGeometry) {
3905 prepareBasicGeometryCompositionState();
3906 prepareGeometryCompositionState();
Vishnu Nairbedb44b2022-08-02 21:47:40 +00003907 snapshot->roundedCorner = getRoundedCornerState();
3908 snapshot->stretchEffect = getStretchEffect();
3909 snapshot->transformedBounds = mScreenBounds;
3910 if (mEffectiveShadowRadius > 0.f) {
3911 snapshot->shadowSettings = mFlinger->mDrawingState.globalShadowSettings;
3912
3913 // Note: this preserves existing behavior of shadowing the entire layer and not cropping
3914 // it if transparent regions are present. This may not be necessary since shadows are
3915 // typically cast by layers without transparent regions.
3916 snapshot->shadowSettings.boundaries = mBounds;
3917
3918 const float casterAlpha = snapshot->alpha;
3919 const bool casterIsOpaque =
3920 ((mBufferInfo.mBuffer != nullptr) && isOpaque(mDrawingState));
3921
3922 // If the casting layer is translucent, we need to fill in the shadow underneath the
3923 // layer. Otherwise the generated shadow will only be shown around the casting layer.
3924 snapshot->shadowSettings.casterIsTranslucent = !casterIsOpaque || (casterAlpha < 1.0f);
3925 snapshot->shadowSettings.ambientColor *= casterAlpha;
3926 snapshot->shadowSettings.spotColor *= casterAlpha;
3927 }
3928 snapshot->shadowSettings.length = mEffectiveShadowRadius;
Vishnu Nairba354102022-08-01 00:14:18 +00003929 }
Vishnu Nairbedb44b2022-08-02 21:47:40 +00003930 snapshot->contentOpaque = isOpaque(mDrawingState);
3931 snapshot->isHdrY410 = isHdrY410();
3932 snapshot->bufferNeedsFiltering = bufferNeedsFiltering();
3933 sp<Layer> p = mDrawingParent.promote();
3934 if (p != nullptr) {
3935 snapshot->transform = p->getTransform();
3936 } else {
3937 snapshot->transform.reset();
3938 }
3939 snapshot->bufferSize = getBufferSize(mDrawingState);
3940 snapshot->externalTexture = mBufferInfo.mBuffer;
Vishnu Naire14c6b32022-08-06 04:20:15 +00003941 snapshot->hasReadyFrame = hasReadyFrame();
Vishnu Nairba354102022-08-01 00:14:18 +00003942 preparePerFrameCompositionState();
3943}
3944
Vishnu Naire14c6b32022-08-06 04:20:15 +00003945void Layer::updateChildrenSnapshots(bool updateGeometry) {
3946 for (const sp<Layer>& child : mDrawingChildren) {
3947 child->updateSnapshot(updateGeometry);
3948 child->updateChildrenSnapshots(updateGeometry);
3949 }
3950}
3951
Vishnu Nair0a4fb002022-08-08 02:40:42 +00003952void Layer::updateMetadataSnapshot(const LayerMetadata& parentMetadata) {
3953 mSnapshot->layerMetadata = parentMetadata;
3954 mSnapshot->layerMetadata.merge(mDrawingState.metadata);
3955 for (const sp<Layer>& child : mDrawingChildren) {
3956 child->updateMetadataSnapshot(mSnapshot->layerMetadata);
3957 }
3958}
3959
3960void Layer::updateRelativeMetadataSnapshot(const LayerMetadata& relativeLayerMetadata,
3961 std::unordered_set<Layer*>& visited) {
3962 if (visited.find(this) != visited.end()) {
3963 ALOGW("Cycle containing layer %s detected in z-order relatives", getDebugName());
3964 return;
3965 }
3966 visited.insert(this);
3967
3968 mSnapshot->relativeLayerMetadata = relativeLayerMetadata;
3969
3970 if (mDrawingState.zOrderRelatives.empty()) {
3971 return;
3972 }
3973 LayerMetadata childRelativeLayerMetadata = mSnapshot->relativeLayerMetadata;
3974 childRelativeLayerMetadata.merge(mSnapshot->layerMetadata);
3975 for (wp<Layer> weakRelative : mDrawingState.zOrderRelatives) {
3976 sp<Layer> relative = weakRelative.promote();
3977 if (!relative) {
3978 continue;
3979 }
3980 relative->updateRelativeMetadataSnapshot(childRelativeLayerMetadata, visited);
3981 }
3982}
3983
Mathias Agopian13127d82013-03-05 17:47:11 -08003984// ---------------------------------------------------------------------------
3985
Marin Shalamanov46084422020-10-13 12:33:42 +02003986std::ostream& operator<<(std::ostream& stream, const Layer::FrameRate& rate) {
Dominik Laskowskif5d0ea52021-09-26 17:27:01 -07003987 return stream << "{rate=" << rate.rate << " type=" << ftl::enum_string(rate.type)
3988 << " seamlessness=" << ftl::enum_string(rate.seamlessness) << '}';
Marin Shalamanov46084422020-10-13 12:33:42 +02003989}
3990
Dominik Laskowskif5d0ea52021-09-26 17:27:01 -07003991} // namespace android
Mathias Agopian3f844832013-08-07 21:24:32 -07003992
3993#if defined(__gl_h_)
3994#error "don't include gl/gl.h in this file"
3995#endif
3996
3997#if defined(__gl2_h_)
3998#error "don't include gl2/gl2.h in this file"
3999#endif
Ady Abrahamb0dbdaa2020-01-06 16:19:42 -08004000
4001// TODO(b/129481165): remove the #pragma below and fix conversion issues
4002#pragma clang diagnostic pop // ignored "-Wconversion"