blob: 977709286bdb0fbe512ccb96f5235534a0603536 [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>
Vishnu Nair71fcf912022-10-18 09:14:20 -070065#include <optional>
Alec Mourie60041e2019-06-14 18:59:51 -070066#include <sstream>
67
Mathias Agopian0f2f5ff2012-07-31 23:09:07 -070068#include "DisplayDevice.h"
Lloyd Pique37c2c9b2018-12-04 17:25:10 -080069#include "DisplayHardware/HWComposer.h"
Ady Abraham22c7b5c2020-09-22 19:33:40 -070070#include "FrameTimeline.h"
Mikael Pessa90092f42019-08-26 17:22:04 -070071#include "FrameTracer/FrameTracer.h"
Vishnu Naircb8be502022-10-12 19:03:23 +000072#include "FrontEnd/LayerCreationArgs.h"
Vishnu Nair07e2a482022-10-18 19:18:16 +000073#include "FrontEnd/LayerHandle.h"
Lloyd Pique37c2c9b2018-12-04 17:25:10 -080074#include "LayerProtoHelper.h"
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080075#include "SurfaceFlinger.h"
Yiwei Zhang7e666a52018-11-15 13:33:42 -080076#include "TimeStats/TimeStats.h"
Robert Carr3e2a2992021-06-11 13:42:55 -070077#include "TunnelModeEnabledReporter.h"
Mathias Agopian1b031492012-06-20 17:51:20 -070078
David Sodman41fdfc92017-11-06 16:09:56 -080079#define DEBUG_RESIZE 0
Patrick Williamsbb25f802022-08-30 23:02:34 +000080#define EARLY_RELEASE_ENABLED false
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080081
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080082namespace android {
Marin Shalamanov1876e2e2020-12-04 13:23:59 +010083namespace {
84constexpr int kDumpTableRowLength = 159;
Patrick Williamsbb25f802022-08-30 23:02:34 +000085
Prabir Pradhanda0f62c2022-07-22 19:53:04 +000086const ui::Transform kIdentityTransform;
Patrick Williamsbb25f802022-08-30 23:02:34 +000087
Patrick Williamsbb25f802022-08-30 23:02:34 +000088bool assignTransform(ui::Transform* dst, ui::Transform& from) {
89 if (*dst == from) {
90 return false;
91 }
92 *dst = from;
93 return true;
94}
95
96TimeStats::SetFrameRateVote frameRateToSetFrameRateVotePayload(Layer::FrameRate frameRate) {
97 using FrameRateCompatibility = TimeStats::SetFrameRateVote::FrameRateCompatibility;
98 using Seamlessness = TimeStats::SetFrameRateVote::Seamlessness;
99 const auto frameRateCompatibility = [frameRate] {
100 switch (frameRate.type) {
101 case Layer::FrameRateCompatibility::Default:
102 return FrameRateCompatibility::Default;
103 case Layer::FrameRateCompatibility::ExactOrMultiple:
104 return FrameRateCompatibility::ExactOrMultiple;
105 default:
106 return FrameRateCompatibility::Undefined;
107 }
108 }();
109
110 const auto seamlessness = [frameRate] {
111 switch (frameRate.seamlessness) {
112 case scheduler::Seamlessness::OnlySeamless:
113 return Seamlessness::ShouldBeSeamless;
114 case scheduler::Seamlessness::SeamedAndSeamless:
115 return Seamlessness::NotRequired;
116 default:
117 return Seamlessness::Undefined;
118 }
119 }();
120
121 return TimeStats::SetFrameRateVote{.frameRate = frameRate.rate.getValue(),
122 .frameRateCompatibility = frameRateCompatibility,
123 .seamlessness = seamlessness};
124}
125
Marin Shalamanov1876e2e2020-12-04 13:23:59 +0100126} // namespace
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800127
Dominik Laskowski2f01d772022-03-23 16:01:29 -0700128using namespace ftl::flag_operators;
129
Yiwei Zhang5434a782018-12-05 18:06:32 -0800130using base::StringAppendF;
Huihong Luod3d8f8e2022-03-08 14:48:46 -0800131using gui::GameMode;
132using gui::LayerMetadata;
chaviw3277faf2021-05-19 16:45:23 -0500133using gui::WindowInfo;
Yiwei Zhang5434a782018-12-05 18:06:32 -0800134
Dominik Laskowski2f01d772022-03-23 16:01:29 -0700135using PresentState = frametimeline::SurfaceFrame::PresentState;
136
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700137Layer::Layer(const LayerCreationArgs& args)
Vishnu Naircb8be502022-10-12 19:03:23 +0000138 : sequence(args.sequence),
Ady Abrahamd11bade2022-08-01 16:18:03 -0700139 mFlinger(sp<SurfaceFlinger>::fromExisting(args.flinger)),
Arthur Hung23e07502021-10-15 11:58:19 +0000140 mName(base::StringPrintf("%s#%d", args.name.c_str(), sequence)),
Ady Abraham8f1ee7f2019-04-05 10:32:50 -0700141 mClientRef(args.client),
Huihong Luod3d8f8e2022-03-08 14:48:46 -0800142 mWindowType(static_cast<WindowInfo::Type>(
143 args.metadata.getInt32(gui::METADATA_WINDOW_TYPE, 0))),
Tianhao Yao67dd7122022-02-22 17:48:33 +0000144 mLayerCreationFlags(args.flags),
Patrick Williamsbb25f802022-08-30 23:02:34 +0000145 mBorderEnabled(false),
146 mTextureName(args.textureName),
Vishnu Naire14c6b32022-08-06 04:20:15 +0000147 mHwcSlotGenerator(sp<HwcSlotGenerator>::make()),
148 mLayerFE(args.flinger->getFactory().createLayerFE(mName)) {
Patrick Williamsbb25f802022-08-30 23:02:34 +0000149 ALOGV("Creating Layer %s", getDebugName());
150
Mathias Agopian4d9b8222013-03-12 17:11:48 -0700151 uint32_t layerFlags = 0;
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700152 if (args.flags & ISurfaceComposerClient::eHidden) layerFlags |= layer_state_t::eLayerHidden;
153 if (args.flags & ISurfaceComposerClient::eOpaque) layerFlags |= layer_state_t::eLayerOpaque;
154 if (args.flags & ISurfaceComposerClient::eSecure) layerFlags |= layer_state_t::eLayerSecure;
chaviwc5676c62020-09-18 15:01:04 -0700155 if (args.flags & ISurfaceComposerClient::eSkipScreenshot)
156 layerFlags |= layer_state_t::eLayerSkipScreenshot;
Robert Carr6a160312021-05-17 12:08:20 -0700157 mDrawingState.flags = layerFlags;
Robert Carr6a160312021-05-17 12:08:20 -0700158 mDrawingState.crop.makeInvalid();
Robert Carr6a160312021-05-17 12:08:20 -0700159 mDrawingState.z = 0;
160 mDrawingState.color.a = 1.0f;
Dominik Laskowski29fa1462021-04-27 15:51:50 -0700161 mDrawingState.layerStack = ui::DEFAULT_LAYER_STACK;
Robert Carr6a160312021-05-17 12:08:20 -0700162 mDrawingState.sequence = 0;
Robert Carr6a160312021-05-17 12:08:20 -0700163 mDrawingState.transform.set(0, 0);
164 mDrawingState.frameNumber = 0;
165 mDrawingState.bufferTransform = 0;
166 mDrawingState.transformToDisplayInverse = false;
167 mDrawingState.crop.makeInvalid();
168 mDrawingState.acquireFence = sp<Fence>::make(-1);
169 mDrawingState.acquireFenceTime = std::make_shared<FenceTime>(mDrawingState.acquireFence);
170 mDrawingState.dataspace = ui::Dataspace::UNKNOWN;
Vishnu Nairbc4ee5c2022-08-16 03:19:37 +0000171 mDrawingState.dataspaceRequested = false;
Robert Carr6a160312021-05-17 12:08:20 -0700172 mDrawingState.hdrMetadata.validTypes = 0;
173 mDrawingState.surfaceDamageRegion = Region::INVALID_REGION;
174 mDrawingState.cornerRadius = 0.0f;
175 mDrawingState.backgroundBlurRadius = 0;
176 mDrawingState.api = -1;
177 mDrawingState.hasColorTransform = false;
178 mDrawingState.colorSpaceAgnostic = false;
179 mDrawingState.frameRateSelectionPriority = PRIORITY_UNSET;
180 mDrawingState.metadata = args.metadata;
181 mDrawingState.shadowRadius = 0.f;
182 mDrawingState.fixedTransformHint = ui::Transform::ROT_INVALID;
183 mDrawingState.frameTimelineInfo = {};
184 mDrawingState.postTime = -1;
185 mDrawingState.destinationFrame.makeInvalid();
Robin Leeedb375d2021-09-10 12:03:42 +0000186 mDrawingState.isTrustedOverlay = false;
Vishnu Nair9cf4a4d2021-09-17 12:16:08 -0700187 mDrawingState.dropInputMode = gui::DropInputMode::NONE;
Sally Qi81d95e62022-03-21 19:41:33 -0700188 mDrawingState.dimmingEnabled = true;
Andy Labrada096227e2022-06-15 16:58:11 +0000189 mDrawingState.defaultFrameRateCompatibility = FrameRateCompatibility::Default;
Mathias Agopian4d9b8222013-03-12 17:11:48 -0700190
Vishnu Nairc43a23c2020-05-29 14:32:27 -0700191 if (args.flags & ISurfaceComposerClient::eNoColorFill) {
192 // Set an invalid color so there is no color fill.
Robert Carr6a160312021-05-17 12:08:20 -0700193 mDrawingState.color.r = -1.0_hf;
194 mDrawingState.color.g = -1.0_hf;
195 mDrawingState.color.b = -1.0_hf;
Vishnu Nairc43a23c2020-05-29 14:32:27 -0700196 }
Dominik Laskowski4376bd82022-07-07 11:50:20 -0700197
198 mFrameTracker.setDisplayRefreshPeriod(
199 args.flinger->mScheduler->getVsyncPeriodFromRefreshRateConfigs());
Robert Carr2e102c92018-10-23 12:11:15 -0700200
Vishnu Naircb8be502022-10-12 19:03:23 +0000201 mOwnerUid = args.ownerUid;
202 mOwnerPid = args.ownerPid;
Patrick Williamsbb25f802022-08-30 23:02:34 +0000203
204 mPremultipliedAlpha = !(args.flags & ISurfaceComposerClient::eNonPremultiplied);
205 mPotentialCursor = args.flags & ISurfaceComposerClient::eCursorWindow;
206 mProtectedByApp = args.flags & ISurfaceComposerClient::eProtectedByApp;
207 mDrawingState.dataspace = ui::Dataspace::V0_SRGB;
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000208
209 mSnapshot->sequence = sequence;
210 mSnapshot->name = getDebugName();
211 mSnapshot->textureName = mTextureName;
212 mSnapshot->premultipliedAlpha = mPremultipliedAlpha;
213 mSnapshot->transform = {};
Dominik Laskowski75848362019-11-11 17:57:20 -0800214}
215
216void Layer::onFirstRef() {
217 mFlinger->onLayerFirstRef(this);
Dan Stoza436ccf32018-06-21 12:10:12 -0700218}
Mathias Agopianb7e930d2010-06-01 15:12:58 -0700219
Mathias Agopian4d9b8222013-03-12 17:11:48 -0700220Layer::~Layer() {
Patrick Williamsbb25f802022-08-30 23:02:34 +0000221 // The original layer and the clone layer share the same texture and buffer. Therefore, only
222 // one of the layers, in this case the original layer, needs to handle the deletion. The
223 // original layer and the clone should be removed at the same time so there shouldn't be any
224 // issue with the clone layer trying to use the texture.
225 if (mBufferInfo.mBuffer != nullptr) {
226 callReleaseBufferCallback(mDrawingState.releaseBufferListener,
227 mBufferInfo.mBuffer->getBuffer(), mBufferInfo.mFrameNumber,
228 mBufferInfo.mFence,
229 mFlinger->getMaxAcquiredBufferCountForCurrentRefreshRate(
230 mOwnerUid));
231 }
232 if (!isClone()) {
233 // The original layer and the clone layer share the same texture. Therefore, only one of
234 // the layers, in this case the original layer, needs to handle the deletion. The original
235 // layer and the clone should be removed at the same time so there shouldn't be any issue
236 // with the clone layer trying to use the deleted texture.
237 mFlinger->deleteTextureAsync(mTextureName);
238 }
239 const int32_t layerId = getSequence();
240 mFlinger->mTimeStats->onDestroy(layerId);
241 mFlinger->mFrameTracer->onDestroy(layerId);
242
David Sodman577c8962017-12-08 14:50:53 -0800243 sp<Client> c(mClientRef.promote());
244 if (c != 0) {
245 c->detachLayer(this);
246 }
247
Jorim Jaggi10c985e2018-10-23 11:17:45 +0000248 mFrameTracker.logAndResetStats(mName);
chaviw74d90ad2019-04-26 14:45:26 -0700249 mFlinger->onLayerDestroyed(this);
Robert Carr3e2a2992021-06-11 13:42:55 -0700250
251 if (mDrawingState.sidebandStream != nullptr) {
252 mFlinger->mTunnelModeEnabledReporter->decrementTunnelModeCount();
253 }
Robert Carr6a0382d2021-07-01 15:57:17 -0700254 if (mHadClonedChild) {
255 mFlinger->mNumClones--;
256 }
Mathias Agopian96f08192010-06-02 23:28:45 -0700257}
258
Mathias Agopian13127d82013-03-05 17:47:11 -0800259// ---------------------------------------------------------------------------
260// callbacks
261// ---------------------------------------------------------------------------
262
Vishnu Nairda9c85a2019-06-03 17:26:48 -0700263void Layer::removeRelativeZ(const std::vector<Layer*>& layersInTree) {
Robert Carr6a160312021-05-17 12:08:20 -0700264 if (mDrawingState.zOrderRelativeOf == nullptr) {
Vishnu Nairda9c85a2019-06-03 17:26:48 -0700265 return;
266 }
Robert Carr2e102c92018-10-23 12:11:15 -0700267
Robert Carr6a160312021-05-17 12:08:20 -0700268 sp<Layer> strongRelative = mDrawingState.zOrderRelativeOf.promote();
Vishnu Nairda9c85a2019-06-03 17:26:48 -0700269 if (strongRelative == nullptr) {
270 setZOrderRelativeOf(nullptr);
271 return;
272 }
273
274 if (!std::binary_search(layersInTree.begin(), layersInTree.end(), strongRelative.get())) {
Ady Abrahamd11bade2022-08-01 16:18:03 -0700275 strongRelative->removeZOrderRelative(wp<Layer>::fromExisting(this));
Vishnu Nairda9c85a2019-06-03 17:26:48 -0700276 mFlinger->setTransactionFlags(eTraversalNeeded);
chaviw606e5cf2019-03-01 10:12:10 -0800277 setZOrderRelativeOf(nullptr);
Robert Carr5edb1ad2017-04-25 10:54:24 -0700278 }
Vishnu Nairda9c85a2019-06-03 17:26:48 -0700279}
280
281void Layer::removeFromCurrentState() {
Robert Carr6a160312021-05-17 12:08:20 -0700282 if (!mRemovedFromDrawingState) {
283 mRemovedFromDrawingState = true;
Ady Abrahambe09aad2021-05-03 18:59:38 -0700284 mFlinger->mScheduler->deregisterLayer(this);
285 }
Rob Carr4bba3702018-10-08 21:53:30 +0000286
Ady Abrahamd11bade2022-08-01 16:18:03 -0700287 mFlinger->markLayerPendingRemovalLocked(sp<Layer>::fromExisting(this));
Chia-I Wuc6657022017-08-15 11:18:17 -0700288}
Chia-I Wu38512252017-05-17 14:36:16 -0700289
chaviw68d4dab2020-06-08 15:07:32 -0700290sp<Layer> Layer::getRootLayer() {
Rob Carrc6d2d2b2021-10-25 16:51:49 +0000291 sp<Layer> parent = getParent();
chaviw68d4dab2020-06-08 15:07:32 -0700292 if (parent == nullptr) {
Ady Abrahamd11bade2022-08-01 16:18:03 -0700293 return sp<Layer>::fromExisting(this);
chaviw68d4dab2020-06-08 15:07:32 -0700294 }
295 return parent->getRootLayer();
296}
297
Vishnu Nairda9c85a2019-06-03 17:26:48 -0700298void Layer::onRemovedFromCurrentState() {
chaviw68d4dab2020-06-08 15:07:32 -0700299 // Use the root layer since we want to maintain the hierarchy for the entire subtree.
300 auto layersInTree = getRootLayer()->getLayersInTree(LayerVector::StateSet::Current);
Vishnu Nairda9c85a2019-06-03 17:26:48 -0700301 std::sort(layersInTree.begin(), layersInTree.end());
chaviw68d4dab2020-06-08 15:07:32 -0700302
303 traverse(LayerVector::StateSet::Current, [&](Layer* layer) {
Vishnu Nairda9c85a2019-06-03 17:26:48 -0700304 layer->removeFromCurrentState();
305 layer->removeRelativeZ(layersInTree);
chaviw68d4dab2020-06-08 15:07:32 -0700306 });
Vishnu Nairda9c85a2019-06-03 17:26:48 -0700307}
308
chaviw61626f22018-11-15 16:26:27 -0800309void Layer::addToCurrentState() {
Robert Carr6a160312021-05-17 12:08:20 -0700310 if (mRemovedFromDrawingState) {
311 mRemovedFromDrawingState = false;
Ady Abrahambe09aad2021-05-03 18:59:38 -0700312 mFlinger->mScheduler->registerLayer(this);
Robert Carr867be372021-06-29 17:36:02 -0700313 mFlinger->removeFromOffscreenLayers(this);
Ady Abrahambe09aad2021-05-03 18:59:38 -0700314 }
chaviw61626f22018-11-15 16:26:27 -0800315
316 for (const auto& child : mCurrentChildren) {
317 child->addToCurrentState();
318 }
319}
320
Mathias Agopian13127d82013-03-05 17:47:11 -0800321// ---------------------------------------------------------------------------
322// set-up
323// ---------------------------------------------------------------------------
324
chaviw13fdc492017-06-27 12:40:18 -0700325bool Layer::getPremultipledAlpha() const {
326 return mPremultipliedAlpha;
327}
328
Mathias Agopian4d9b8222013-03-12 17:11:48 -0700329sp<IBinder> Layer::getHandle() {
Mathias Agopian13127d82013-03-05 17:47:11 -0800330 Mutex::Autolock _l(mLock);
Robert Carrc0df3122019-04-11 13:18:21 -0700331 if (mGetHandleCalled) {
332 ALOGE("Get handle called twice" );
333 return nullptr;
334 }
335 mGetHandleCalled = true;
Vishnu Nair07e2a482022-10-18 19:18:16 +0000336 return sp<LayerHandle>::make(mFlinger, sp<Layer>::fromExisting(this));
Mathias Agopian13127d82013-03-05 17:47:11 -0800337}
338
339// ---------------------------------------------------------------------------
340// h/w composer set-up
341// ---------------------------------------------------------------------------
342
Mathias Agopianf3e85d42013-05-10 18:01:12 -0700343static Rect reduce(const Rect& win, const Region& exclude) {
344 if (CC_LIKELY(exclude.isEmpty())) {
345 return win;
346 }
347 if (exclude.isRect()) {
348 return win.reduce(exclude.getBounds());
349 }
350 return Region(win).subtract(exclude).getBounds();
351}
352
Dan Stoza80d61162017-12-20 15:57:52 -0800353static FloatRect reduce(const FloatRect& win, const Region& exclude) {
354 if (CC_LIKELY(exclude.isEmpty())) {
355 return win;
356 }
357 // Convert through Rect (by rounding) for lack of FloatRegion
358 return Region(Rect{win}).subtract(exclude).getBounds().toFloatRect();
359}
360
Vishnu Nair4351ad52019-02-11 14:13:02 -0800361Rect Layer::getScreenBounds(bool reduceTransparentRegion) const {
Vishnu Nairf0c28512019-02-08 12:40:28 -0800362 if (!reduceTransparentRegion) {
363 return Rect{mScreenBounds};
364 }
365
366 FloatRect bounds = getBounds();
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800367 ui::Transform t = getTransform();
Vishnu Nair60356342018-11-13 13:00:45 -0800368 // Transform to screen space.
369 bounds = t.transform(bounds);
370 return Rect{bounds};
Robert Carr1f0a16a2016-10-24 16:27:39 -0700371}
372
Vishnu Nair4351ad52019-02-11 14:13:02 -0800373FloatRect Layer::getBounds() const {
Alec Mourib416efd2018-09-06 21:01:59 +0000374 const State& s(getDrawingState());
Vishnu Nair4351ad52019-02-11 14:13:02 -0800375 return getBounds(getActiveTransparentRegion(s));
Michael Lentine6c925ed2014-09-26 17:55:01 -0700376}
377
Vishnu Nairf0c28512019-02-08 12:40:28 -0800378FloatRect Layer::getBounds(const Region& activeTransparentRegion) const {
379 // Subtract the transparent region and snap to the bounds.
380 return reduce(mBounds, activeTransparentRegion);
381}
382
Vishnu Nairc97b8db2019-10-29 18:19:35 -0700383void Layer::computeBounds(FloatRect parentBounds, ui::Transform parentTransform,
384 float parentShadowRadius) {
Vishnu Nair4351ad52019-02-11 14:13:02 -0800385 const State& s(getDrawingState());
386
387 // Calculate effective layer transform
388 mEffectiveTransform = parentTransform * getActiveTransform(s);
389
Garfield Tan2c1782c2022-02-16 15:25:05 -0800390 if (CC_UNLIKELY(!isTransformValid())) {
391 ALOGW("Stop computing bounds for %s because it has invalid transformation.",
392 getDebugName());
393 return;
394 }
395
Vishnu Nair4351ad52019-02-11 14:13:02 -0800396 // Transform parent bounds to layer space
397 parentBounds = getActiveTransform(s).inverse().transform(parentBounds);
398
Vishnu Nairc652ff82019-03-15 12:48:54 -0700399 // Calculate source bounds
Vishnu Nair4351ad52019-02-11 14:13:02 -0800400 mSourceBounds = computeSourceBounds(parentBounds);
401
402 // Calculate bounds by croping diplay frame with layer crop and parent bounds
403 FloatRect bounds = mSourceBounds;
404 const Rect layerCrop = getCrop(s);
405 if (!layerCrop.isEmpty()) {
406 bounds = mSourceBounds.intersect(layerCrop.toFloatRect());
407 }
408 bounds = bounds.intersect(parentBounds);
409
410 mBounds = bounds;
411 mScreenBounds = mEffectiveTransform.transform(mBounds);
Vishnu Nairc652ff82019-03-15 12:48:54 -0700412
Vishnu Nairc97b8db2019-10-29 18:19:35 -0700413 // Use the layer's own shadow radius if set. Otherwise get the radius from
414 // parent.
415 if (s.shadowRadius > 0.f) {
416 mEffectiveShadowRadius = s.shadowRadius;
417 } else {
418 mEffectiveShadowRadius = parentShadowRadius;
419 }
420
421 // Shadow radius is passed down to only one layer so if the layer can draw shadows,
422 // don't pass it to its children.
423 const float childShadowRadius = canDrawShadows() ? 0.f : mEffectiveShadowRadius;
424
Vishnu Nair4351ad52019-02-11 14:13:02 -0800425 for (const sp<Layer>& child : mDrawingChildren) {
Vishnu Nair6bdec7d2021-05-10 15:01:13 -0700426 child->computeBounds(mBounds, mEffectiveTransform, childShadowRadius);
Vishnu Nair4351ad52019-02-11 14:13:02 -0800427 }
Vishnu Nairba354102022-08-01 00:14:18 +0000428
429 if (mPotentialCursor) {
430 prepareCursorCompositionState();
431 }
Vishnu Nair4351ad52019-02-11 14:13:02 -0800432}
433
Vishnu Nair60356342018-11-13 13:00:45 -0800434Rect Layer::getCroppedBufferSize(const State& s) const {
435 Rect size = getBufferSize(s);
436 Rect crop = getCrop(s);
437 if (!crop.isEmpty() && size.isValid()) {
438 size.intersect(crop, &size);
439 } else if (!crop.isEmpty()) {
440 size = crop;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700441 }
Vishnu Nair60356342018-11-13 13:00:45 -0800442 return size;
Mathias Agopian13127d82013-03-05 17:47:11 -0800443}
444
Lucas Dupin1b6531c2018-07-05 17:18:21 -0700445void Layer::setupRoundedCornersCropCoordinates(Rect win,
446 const FloatRect& roundedCornersCrop) const {
447 // Translate win by the rounded corners rect coordinates, to have all values in
448 // layer coordinate space.
449 win.left -= roundedCornersCrop.left;
450 win.right -= roundedCornersCrop.left;
451 win.top -= roundedCornersCrop.top;
452 win.bottom -= roundedCornersCrop.top;
Lucas Dupin1b6531c2018-07-05 17:18:21 -0700453}
454
Lloyd Piquede196652020-01-22 17:29:58 -0800455void Layer::prepareBasicGeometryCompositionState() {
Lloyd Piquec6687342019-03-07 21:34:57 -0800456 const auto& drawingState{getDrawingState()};
Lloyd Piquec6687342019-03-07 21:34:57 -0800457 const auto alpha = static_cast<float>(getAlpha());
458 const bool opaque = isOpaque(drawingState);
Vishnu Nair50c0afe2022-07-11 15:04:07 -0700459 const bool usesRoundedCorners = hasRoundedCorners();
Lloyd Piquec6687342019-03-07 21:34:57 -0800460
461 auto blendMode = Hwc2::IComposerClient::BlendMode::NONE;
462 if (!opaque || alpha != 1.0f) {
463 blendMode = mPremultipliedAlpha ? Hwc2::IComposerClient::BlendMode::PREMULTIPLIED
464 : Hwc2::IComposerClient::BlendMode::COVERAGE;
465 }
466
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000467 auto* snapshot = editLayerSnapshot();
468 snapshot->outputFilter = getOutputFilter();
469 snapshot->isVisible = isVisible();
470 snapshot->isOpaque = opaque && !usesRoundedCorners && alpha == 1.f;
471 snapshot->shadowRadius = mEffectiveShadowRadius;
Lloyd Piquec6687342019-03-07 21:34:57 -0800472
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000473 snapshot->contentDirty = contentDirty;
Lloyd Piquec6687342019-03-07 21:34:57 -0800474 contentDirty = false;
475
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000476 snapshot->geomLayerBounds = mBounds;
477 snapshot->geomLayerTransform = getTransform();
478 snapshot->geomInverseLayerTransform = snapshot->geomLayerTransform.inverse();
479 snapshot->transparentRegionHint = getActiveTransparentRegion(drawingState);
Lloyd Piquec6687342019-03-07 21:34:57 -0800480
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000481 snapshot->blendMode = static_cast<Hwc2::IComposerClient::BlendMode>(blendMode);
482 snapshot->alpha = alpha;
483 snapshot->backgroundBlurRadius = drawingState.backgroundBlurRadius;
484 snapshot->blurRegions = drawingState.blurRegions;
485 snapshot->stretchEffect = getStretchEffect();
Lloyd Piquec6687342019-03-07 21:34:57 -0800486}
487
Lloyd Piquede196652020-01-22 17:29:58 -0800488void Layer::prepareGeometryCompositionState() {
Lloyd Piquea83776c2019-01-29 18:42:32 -0800489 const auto& drawingState{getDrawingState()};
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000490 auto* snapshot = editLayerSnapshot();
David Sodman15094112018-10-11 09:39:37 -0700491
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000492 snapshot->geomBufferSize = getBufferSize(drawingState);
493 snapshot->geomContentCrop = getBufferCrop();
494 snapshot->geomCrop = getCrop(drawingState);
495 snapshot->geomBufferTransform = getBufferTransform();
496 snapshot->geomBufferUsesDisplayInverseTransform = getTransformToDisplayInverse();
497 snapshot->geomUsesSourceCrop = usesSourceCrop();
498 snapshot->isSecure = isSecure();
Lloyd Piquede196652020-01-22 17:29:58 -0800499
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000500 snapshot->metadata.clear();
Lloyd Pique8d9f8362020-02-11 19:13:09 -0800501 const auto& supportedMetadata = mFlinger->getHwComposer().getSupportedLayerGenericMetadata();
502 for (const auto& [key, mandatory] : supportedMetadata) {
503 const auto& genericLayerMetadataCompatibilityMap =
504 mFlinger->getGenericLayerMetadataKeyMap();
505 auto compatIter = genericLayerMetadataCompatibilityMap.find(key);
506 if (compatIter == std::end(genericLayerMetadataCompatibilityMap)) {
507 continue;
508 }
509 const uint32_t id = compatIter->second;
510
511 auto it = drawingState.metadata.mMap.find(id);
512 if (it == std::end(drawingState.metadata.mMap)) {
513 continue;
514 }
515
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000516 snapshot->metadata.emplace(key,
517 compositionengine::GenericLayerMetadataEntry{mandatory,
518 it->second});
Lloyd Pique8d9f8362020-02-11 19:13:09 -0800519 }
Lloyd Piquea83776c2019-01-29 18:42:32 -0800520}
David Sodmanba340492018-08-05 21:51:33 -0700521
Lloyd Piquede196652020-01-22 17:29:58 -0800522void Layer::preparePerFrameCompositionState() {
Lloyd Pique688abd42019-02-15 15:42:24 -0800523 const auto& drawingState{getDrawingState()};
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000524 auto* snapshot = editLayerSnapshot();
Lloyd Piquef5275482019-01-29 18:42:42 -0800525
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000526 snapshot->forceClientComposition = false;
Lloyd Piquede196652020-01-22 17:29:58 -0800527
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000528 snapshot->isColorspaceAgnostic = isColorSpaceAgnostic();
529 snapshot->dataspace = getDataSpace();
530 snapshot->colorTransform = getColorTransform();
531 snapshot->colorTransformIsIdentity = !hasColorTransform();
532 snapshot->surfaceDamage = surfaceDamageRegion;
533 snapshot->hasProtectedContent = isProtected();
534 snapshot->dimmingEnabled = isDimmingEnabled();
Lloyd Pique688abd42019-02-15 15:42:24 -0800535
Vishnu Nair50c0afe2022-07-11 15:04:07 -0700536 const bool usesRoundedCorners = hasRoundedCorners();
Vishnu Nairc97b8db2019-10-29 18:19:35 -0700537
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000538 snapshot->isOpaque = isOpaque(drawingState) && !usesRoundedCorners && getAlpha() == 1.0_hf;
Lloyd Piquef5275482019-01-29 18:42:42 -0800539
540 // Force client composition for special cases known only to the front-end.
Leon Scroggins IIId305ef22021-04-06 09:53:26 -0400541 // Rounded corners no longer force client composition, since we may use a
542 // hole punch so that the layer will appear to have rounded corners.
543 if (isHdrY410() || drawShadows() || drawingState.blurRegions.size() > 0 ||
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000544 snapshot->stretchEffect.hasEffect()) {
545 snapshot->forceClientComposition = true;
Lloyd Piquef5275482019-01-29 18:42:42 -0800546 }
Vishnu Nairb801a982021-11-02 15:12:08 -0700547 // If there are no visible region changes, we still need to update blur parameters.
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000548 snapshot->blurRegions = drawingState.blurRegions;
549 snapshot->backgroundBlurRadius = drawingState.backgroundBlurRadius;
Nathaniel Nifong1303d912021-10-06 09:41:24 -0400550
551 // Layer framerate is used in caching decisions.
552 // Retrieve it from the scheduler which maintains an instance of LayerHistory, and store it in
553 // LayerFECompositionState where it would be visible to Flattener.
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000554 snapshot->fps = mFlinger->getLayerFramerate(systemTime(), getSequence());
Patrick Williamsbb25f802022-08-30 23:02:34 +0000555
556 if (hasBufferOrSidebandStream()) {
557 preparePerFrameBufferCompositionState();
558 } else {
559 preparePerFrameEffectsCompositionState();
560 }
561}
562
563void Layer::preparePerFrameBufferCompositionState() {
564 // Sideband layers
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000565 auto* snapshot = editLayerSnapshot();
566 if (snapshot->sidebandStream.get() && !snapshot->sidebandStreamHasFrame) {
567 snapshot->compositionType =
Patrick Williamsbb25f802022-08-30 23:02:34 +0000568 aidl::android::hardware::graphics::composer3::Composition::SIDEBAND;
569 return;
570 } else if ((mDrawingState.flags & layer_state_t::eLayerIsDisplayDecoration) != 0) {
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000571 snapshot->compositionType =
Patrick Williamsbb25f802022-08-30 23:02:34 +0000572 aidl::android::hardware::graphics::composer3::Composition::DISPLAY_DECORATION;
573 } else {
574 // Normal buffer layers
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000575 snapshot->hdrMetadata = mBufferInfo.mHdrMetadata;
576 snapshot->compositionType = mPotentialCursor
Patrick Williamsbb25f802022-08-30 23:02:34 +0000577 ? aidl::android::hardware::graphics::composer3::Composition::CURSOR
578 : aidl::android::hardware::graphics::composer3::Composition::DEVICE;
579 }
580
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000581 snapshot->buffer = getBuffer();
582 snapshot->bufferSlot = (mBufferInfo.mBufferSlot == BufferQueue::INVALID_BUFFER_SLOT)
Patrick Williamsbb25f802022-08-30 23:02:34 +0000583 ? 0
584 : mBufferInfo.mBufferSlot;
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000585 snapshot->acquireFence = mBufferInfo.mFence;
586 snapshot->frameNumber = mBufferInfo.mFrameNumber;
587 snapshot->sidebandStreamHasFrame = false;
Patrick Williamsbb25f802022-08-30 23:02:34 +0000588}
589
590void Layer::preparePerFrameEffectsCompositionState() {
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000591 auto* snapshot = editLayerSnapshot();
592 snapshot->color = getColor();
593 snapshot->compositionType =
Patrick Williamsbb25f802022-08-30 23:02:34 +0000594 aidl::android::hardware::graphics::composer3::Composition::SOLID_COLOR;
Lloyd Piquef5275482019-01-29 18:42:42 -0800595}
596
Lloyd Piquede196652020-01-22 17:29:58 -0800597void Layer::prepareCursorCompositionState() {
Lloyd Piquec7b0c752019-03-07 20:59:59 -0800598 const State& drawingState{getDrawingState()};
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000599 auto* snapshot = editLayerSnapshot();
Lloyd Piquec7b0c752019-03-07 20:59:59 -0800600
601 // Apply the layer's transform, followed by the display's global transform
602 // Here we're guaranteed that the layer's transform preserves rects
603 Rect win = getCroppedBufferSize(drawingState);
604 // Subtract the transparent region and snap to the bounds
605 Rect bounds = reduce(win, getActiveTransparentRegion(drawingState));
606 Rect frame(getTransform().transform(bounds));
607
Vishnu Nairbedb44b2022-08-02 21:47:40 +0000608 snapshot->cursorFrame = frame;
Lloyd Piquede196652020-01-22 17:29:58 -0800609}
610
Lloyd Piquea83776c2019-01-29 18:42:32 -0800611const char* Layer::getDebugName() const {
Dominik Laskowski87a07e42019-10-10 20:38:02 -0700612 return mName.c_str();
David Sodman4b7c4bc2017-11-17 12:13:59 -0800613}
614
Mathias Agopian13127d82013-03-05 17:47:11 -0800615// ---------------------------------------------------------------------------
616// drawing...
617// ---------------------------------------------------------------------------
618
Leon Scroggins III2e1aa182021-12-01 17:33:12 -0500619aidl::android::hardware::graphics::composer3::Composition Layer::getCompositionType(
620 const DisplayDevice& display) const {
Dominik Laskowskib7251f42020-04-20 17:42:59 -0700621 const auto outputLayer = findOutputLayerForDisplay(&display);
Alec Mouri6b9e9912020-01-21 10:50:24 -0800622 if (outputLayer == nullptr) {
Leon Scroggins III2e1aa182021-12-01 17:33:12 -0500623 return aidl::android::hardware::graphics::composer3::Composition::INVALID;
Alec Mouri6b9e9912020-01-21 10:50:24 -0800624 }
625 if (outputLayer->getState().hwc) {
626 return (*outputLayer->getState().hwc).hwcCompositionType;
627 } else {
Leon Scroggins III2e1aa182021-12-01 17:33:12 -0500628 return aidl::android::hardware::graphics::composer3::Composition::CLIENT;
Alec Mouri6b9e9912020-01-21 10:50:24 -0800629 }
Dan Stoza9e56aa02015-11-02 13:00:03 -0800630}
631
Mathias Agopian13127d82013-03-05 17:47:11 -0800632// ----------------------------------------------------------------------------
633// local state
634// ----------------------------------------------------------------------------
635
David Sodman41fdfc92017-11-06 16:09:56 -0800636bool Layer::isSecure() const {
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800637 const State& s(mDrawingState);
Garfield Tande619fa2020-10-02 17:13:53 -0700638 if (s.flags & layer_state_t::eLayerSecure) {
639 return true;
640 }
641
Rob Carrc6d2d2b2021-10-25 16:51:49 +0000642 const auto p = mDrawingParent.promote();
Garfield Tande619fa2020-10-02 17:13:53 -0700643 return (p != nullptr) ? p->isSecure() : false;
Dan Stoza23116082015-06-18 14:58:39 -0700644}
645
Mathias Agopian13127d82013-03-05 17:47:11 -0800646// ----------------------------------------------------------------------------
647// transaction
648// ----------------------------------------------------------------------------
Ady Abraham83729882018-12-07 12:26:48 -0800649
Marissa Wall61c58622018-07-18 10:12:20 -0700650uint32_t Layer::doTransaction(uint32_t flags) {
651 ATRACE_CALL();
652
Robert Carr0758e5d2021-03-11 22:15:04 -0800653 // TODO: This is unfortunate.
Robert Carr6a160312021-05-17 12:08:20 -0700654 mDrawingStateModified = mDrawingState.modified;
655 mDrawingState.modified = false;
Marissa Wall61c58622018-07-18 10:12:20 -0700656
Alec Mourib416efd2018-09-06 21:01:59 +0000657 const State& s(getDrawingState());
Marissa Wall61c58622018-07-18 10:12:20 -0700658
Robert Carr6a160312021-05-17 12:08:20 -0700659 if (updateGeometry()) {
Mathias Agopian13127d82013-03-05 17:47:11 -0800660 // invalidate and recompute the visible regions if needed
661 flags |= Layer::eVisibleRegion;
662 }
663
Robert Carr6a160312021-05-17 12:08:20 -0700664 if (s.sequence != mLastCommittedTxSequence) {
Mathias Agopian13127d82013-03-05 17:47:11 -0800665 // invalidate and recompute the visible regions if needed
Arthur Hung9ed43392022-05-27 06:31:57 +0000666 mLastCommittedTxSequence = s.sequence;
Mathias Agopian13127d82013-03-05 17:47:11 -0800667 flags |= eVisibleRegion;
668 this->contentDirty = true;
669
670 // we may use linear filtering, if the matrix scales us
Robert Carr6a160312021-05-17 12:08:20 -0700671 mNeedsFiltering = getActiveTransform(s).needsBilinearFiltering();
Mathias Agopian13127d82013-03-05 17:47:11 -0800672 }
673
Arthur Hung9ed43392022-05-27 06:31:57 +0000674 if (!mPotentialCursor && (flags & Layer::eVisibleRegion)) {
675 mFlinger->mUpdateInputInfo = true;
676 }
677
Robert Carr6a160312021-05-17 12:08:20 -0700678 commitTransaction(mDrawingState);
Robert Carra1257842020-01-31 13:48:28 -0800679
Mathias Agopian13127d82013-03-05 17:47:11 -0800680 return flags;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800681}
682
Robert Carr6a160312021-05-17 12:08:20 -0700683void Layer::commitTransaction(State&) {
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +0000684 // Set the present state for all bufferlessSurfaceFramesTX to Presented. The
685 // bufferSurfaceFrameTX will be presented in latchBuffer.
686 for (auto& [token, surfaceFrame] : mDrawingState.bufferlessSurfaceFramesTX) {
687 if (surfaceFrame->getPresentState() != PresentState::Presented) {
688 // With applyPendingStates, we could end up having presented surfaceframes from previous
689 // states
690 surfaceFrame->setPresentState(PresentState::Presented);
691 mFlinger->mFrameTimeline->addSurfaceFrame(surfaceFrame);
692 }
693 }
Robert Carr6a160312021-05-17 12:08:20 -0700694 mDrawingState.bufferlessSurfaceFramesTX.clear();
Mathias Agopiana67932f2011-04-20 14:20:59 -0700695}
696
Dominik Laskowski9e168db2021-05-27 16:05:12 -0700697uint32_t Layer::clearTransactionFlags(uint32_t mask) {
698 const auto flags = mTransactionFlags & mask;
699 mTransactionFlags &= ~mask;
700 return flags;
Mathias Agopian13127d82013-03-05 17:47:11 -0800701}
702
Dominik Laskowski9e168db2021-05-27 16:05:12 -0700703void Layer::setTransactionFlags(uint32_t mask) {
704 mTransactionFlags |= mask;
Mathias Agopian13127d82013-03-05 17:47:11 -0800705}
706
Robert Carr1f0a16a2016-10-24 16:27:39 -0700707bool Layer::setChildLayer(const sp<Layer>& childLayer, int32_t z) {
708 ssize_t idx = mCurrentChildren.indexOf(childLayer);
709 if (idx < 0) {
710 return false;
711 }
712 if (childLayer->setLayer(z)) {
713 mCurrentChildren.removeAt(idx);
714 mCurrentChildren.add(childLayer);
Robert Carr503d2bd2017-12-04 15:49:47 -0800715 return true;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700716 }
Robert Carr503d2bd2017-12-04 15:49:47 -0800717 return false;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700718}
719
Robert Carr503c7042017-09-27 15:06:08 -0700720bool Layer::setChildRelativeLayer(const sp<Layer>& childLayer,
721 const sp<IBinder>& relativeToHandle, int32_t relativeZ) {
722 ssize_t idx = mCurrentChildren.indexOf(childLayer);
723 if (idx < 0) {
724 return false;
725 }
726 if (childLayer->setRelativeLayer(relativeToHandle, relativeZ)) {
727 mCurrentChildren.removeAt(idx);
728 mCurrentChildren.add(childLayer);
Robert Carr503d2bd2017-12-04 15:49:47 -0800729 return true;
Robert Carr503c7042017-09-27 15:06:08 -0700730 }
Robert Carr503d2bd2017-12-04 15:49:47 -0800731 return false;
Robert Carr503c7042017-09-27 15:06:08 -0700732}
733
Robert Carrae060832016-11-28 10:51:00 -0800734bool Layer::setLayer(int32_t z) {
Robert Carr6a160312021-05-17 12:08:20 -0700735 if (mDrawingState.z == z && !usingRelativeZ(LayerVector::StateSet::Current)) return false;
736 mDrawingState.sequence++;
737 mDrawingState.z = z;
738 mDrawingState.modified = true;
Robert Carrdb66e622017-04-10 16:55:57 -0700739
Robert Carra70e91c2021-06-11 13:59:52 -0700740 mFlinger->mSomeChildrenChanged = true;
741
Robert Carrdb66e622017-04-10 16:55:57 -0700742 // Discard all relative layering.
Robert Carr6a160312021-05-17 12:08:20 -0700743 if (mDrawingState.zOrderRelativeOf != nullptr) {
744 sp<Layer> strongRelative = mDrawingState.zOrderRelativeOf.promote();
Robert Carrdb66e622017-04-10 16:55:57 -0700745 if (strongRelative != nullptr) {
Ady Abrahamd11bade2022-08-01 16:18:03 -0700746 strongRelative->removeZOrderRelative(wp<Layer>::fromExisting(this));
Robert Carrdb66e622017-04-10 16:55:57 -0700747 }
chaviw606e5cf2019-03-01 10:12:10 -0800748 setZOrderRelativeOf(nullptr);
Robert Carrdb66e622017-04-10 16:55:57 -0700749 }
Mathias Agopian13127d82013-03-05 17:47:11 -0800750 setTransactionFlags(eTransactionNeeded);
751 return true;
752}
Robert Carr1f0a16a2016-10-24 16:27:39 -0700753
Robert Carrdb66e622017-04-10 16:55:57 -0700754void Layer::removeZOrderRelative(const wp<Layer>& relative) {
Robert Carr6a160312021-05-17 12:08:20 -0700755 mDrawingState.zOrderRelatives.remove(relative);
756 mDrawingState.sequence++;
757 mDrawingState.modified = true;
Robert Carrdb66e622017-04-10 16:55:57 -0700758 setTransactionFlags(eTransactionNeeded);
759}
760
761void Layer::addZOrderRelative(const wp<Layer>& relative) {
Robert Carr6a160312021-05-17 12:08:20 -0700762 mDrawingState.zOrderRelatives.add(relative);
763 mDrawingState.modified = true;
764 mDrawingState.sequence++;
Robert Carrdb66e622017-04-10 16:55:57 -0700765 setTransactionFlags(eTransactionNeeded);
766}
767
chaviw606e5cf2019-03-01 10:12:10 -0800768void Layer::setZOrderRelativeOf(const wp<Layer>& relativeOf) {
Robert Carr6a160312021-05-17 12:08:20 -0700769 mDrawingState.zOrderRelativeOf = relativeOf;
770 mDrawingState.sequence++;
771 mDrawingState.modified = true;
772 mDrawingState.isRelativeOf = relativeOf != nullptr;
chaviwbdb8b802019-10-14 09:17:12 -0700773
chaviw606e5cf2019-03-01 10:12:10 -0800774 setTransactionFlags(eTransactionNeeded);
775}
776
Robert Carr503d2bd2017-12-04 15:49:47 -0800777bool Layer::setRelativeLayer(const sp<IBinder>& relativeToHandle, int32_t relativeZ) {
Vishnu Nair07e2a482022-10-18 19:18:16 +0000778 sp<Layer> relative = LayerHandle::getLayer(relativeToHandle);
Robert Carrdb66e622017-04-10 16:55:57 -0700779 if (relative == nullptr) {
780 return false;
781 }
782
Robert Carr6a160312021-05-17 12:08:20 -0700783 if (mDrawingState.z == relativeZ && usingRelativeZ(LayerVector::StateSet::Current) &&
784 mDrawingState.zOrderRelativeOf == relative) {
Robert Carr503d2bd2017-12-04 15:49:47 -0800785 return false;
786 }
787
Robert Carr88b85e12022-03-21 15:47:35 -0700788 if (CC_UNLIKELY(relative->usingRelativeZ(LayerVector::StateSet::Drawing)) &&
789 (relative->mDrawingState.zOrderRelativeOf == this)) {
790 ALOGE("Detected relative layer loop between %s and %s",
791 mName.c_str(), relative->mName.c_str());
792 ALOGE("Ignoring new call to set relative layer");
793 return false;
794 }
795
Robert Carra70e91c2021-06-11 13:59:52 -0700796 mFlinger->mSomeChildrenChanged = true;
797
Robert Carr6a160312021-05-17 12:08:20 -0700798 mDrawingState.sequence++;
799 mDrawingState.modified = true;
800 mDrawingState.z = relativeZ;
Robert Carrdb66e622017-04-10 16:55:57 -0700801
Robert Carr6a160312021-05-17 12:08:20 -0700802 auto oldZOrderRelativeOf = mDrawingState.zOrderRelativeOf.promote();
chaviw9ab4bd12017-11-03 13:11:00 -0700803 if (oldZOrderRelativeOf != nullptr) {
Ady Abrahamd11bade2022-08-01 16:18:03 -0700804 oldZOrderRelativeOf->removeZOrderRelative(wp<Layer>::fromExisting(this));
chaviw9ab4bd12017-11-03 13:11:00 -0700805 }
chaviw606e5cf2019-03-01 10:12:10 -0800806 setZOrderRelativeOf(relative);
Ady Abrahamd11bade2022-08-01 16:18:03 -0700807 relative->addZOrderRelative(wp<Layer>::fromExisting(this));
Robert Carrdb66e622017-04-10 16:55:57 -0700808
809 setTransactionFlags(eTransactionNeeded);
810
811 return true;
812}
813
Winson Chunga30f7c92021-06-29 15:42:56 -0700814bool Layer::setTrustedOverlay(bool isTrustedOverlay) {
815 if (mDrawingState.isTrustedOverlay == isTrustedOverlay) return false;
816 mDrawingState.isTrustedOverlay = isTrustedOverlay;
817 mDrawingState.modified = true;
Arthur Hung9ed43392022-05-27 06:31:57 +0000818 mFlinger->mUpdateInputInfo = true;
Winson Chunga30f7c92021-06-29 15:42:56 -0700819 setTransactionFlags(eTransactionNeeded);
820 return true;
821}
822
823bool Layer::isTrustedOverlay() const {
824 if (getDrawingState().isTrustedOverlay) {
825 return true;
826 }
Rob Carrc6d2d2b2021-10-25 16:51:49 +0000827 const auto& p = mDrawingParent.promote();
Winson Chunga30f7c92021-06-29 15:42:56 -0700828 return (p != nullptr) && p->isTrustedOverlay();
829}
830
Dan Stoza9e56aa02015-11-02 13:00:03 -0800831bool Layer::setAlpha(float alpha) {
Robert Carr6a160312021-05-17 12:08:20 -0700832 if (mDrawingState.color.a == alpha) return false;
833 mDrawingState.sequence++;
834 mDrawingState.color.a = alpha;
835 mDrawingState.modified = true;
Mathias Agopian13127d82013-03-05 17:47:11 -0800836 setTransactionFlags(eTransactionNeeded);
837 return true;
838}
chaviw13fdc492017-06-27 12:40:18 -0700839
Valerie Haudd0b7572019-01-29 14:59:27 -0800840bool Layer::setBackgroundColor(const half3& color, float alpha, ui::Dataspace dataspace) {
Robert Carr6a160312021-05-17 12:08:20 -0700841 if (!mDrawingState.bgColorLayer && alpha == 0) {
chaviw13fdc492017-06-27 12:40:18 -0700842 return false;
Valerie Hauaa194562019-02-05 16:21:38 -0800843 }
Robert Carr6a160312021-05-17 12:08:20 -0700844 mDrawingState.sequence++;
845 mDrawingState.modified = true;
Valerie Hauaa194562019-02-05 16:21:38 -0800846 setTransactionFlags(eTransactionNeeded);
847
Robert Carr6a160312021-05-17 12:08:20 -0700848 if (!mDrawingState.bgColorLayer && alpha != 0) {
Valerie Haudd0b7572019-01-29 14:59:27 -0800849 // create background color layer if one does not yet exist
Vishnu Nairfa247b12020-02-11 08:58:26 -0800850 uint32_t flags = ISurfaceComposerClient::eFXSurfaceEffect;
Dominik Laskowski87a07e42019-10-10 20:38:02 -0700851 std::string name = mName + "BackgroundColorLayer";
Robert Carr6a160312021-05-17 12:08:20 -0700852 mDrawingState.bgColorLayer = mFlinger->getFactory().createEffectLayer(
Vishnu Nair7fb9e5a2021-11-08 12:44:05 -0800853 LayerCreationArgs(mFlinger.get(), nullptr, std::move(name), flags,
Dominik Laskowski87a07e42019-10-10 20:38:02 -0700854 LayerMetadata()));
chaviw13fdc492017-06-27 12:40:18 -0700855
Valerie Haudd0b7572019-01-29 14:59:27 -0800856 // add to child list
Robert Carr6a160312021-05-17 12:08:20 -0700857 addChild(mDrawingState.bgColorLayer);
Valerie Haudd0b7572019-01-29 14:59:27 -0800858 mFlinger->mLayersAdded = true;
859 // set up SF to handle added color layer
860 if (isRemovedFromCurrentState()) {
Robert Carr6a160312021-05-17 12:08:20 -0700861 mDrawingState.bgColorLayer->onRemovedFromCurrentState();
Valerie Haudd0b7572019-01-29 14:59:27 -0800862 }
863 mFlinger->setTransactionFlags(eTransactionNeeded);
Robert Carr6a160312021-05-17 12:08:20 -0700864 } else if (mDrawingState.bgColorLayer && alpha == 0) {
865 mDrawingState.bgColorLayer->reparent(nullptr);
866 mDrawingState.bgColorLayer = nullptr;
Valerie Haudd0b7572019-01-29 14:59:27 -0800867 return true;
868 }
869
Robert Carr6a160312021-05-17 12:08:20 -0700870 mDrawingState.bgColorLayer->setColor(color);
871 mDrawingState.bgColorLayer->setLayer(std::numeric_limits<int32_t>::min());
872 mDrawingState.bgColorLayer->setAlpha(alpha);
873 mDrawingState.bgColorLayer->setDataspace(dataspace);
Valerie Haudd0b7572019-01-29 14:59:27 -0800874
chaviw13fdc492017-06-27 12:40:18 -0700875 return true;
876}
877
Lucas Dupin1b6531c2018-07-05 17:18:21 -0700878bool Layer::setCornerRadius(float cornerRadius) {
Robert Carr6a160312021-05-17 12:08:20 -0700879 if (mDrawingState.cornerRadius == cornerRadius) return false;
Lucas Dupin1b6531c2018-07-05 17:18:21 -0700880
Robert Carr6a160312021-05-17 12:08:20 -0700881 mDrawingState.sequence++;
882 mDrawingState.cornerRadius = cornerRadius;
883 mDrawingState.modified = true;
Lucas Dupin1b6531c2018-07-05 17:18:21 -0700884 setTransactionFlags(eTransactionNeeded);
885 return true;
886}
887
Lucas Dupin19c8f0e2019-11-25 17:55:44 -0800888bool Layer::setBackgroundBlurRadius(int backgroundBlurRadius) {
Robert Carr6a160312021-05-17 12:08:20 -0700889 if (mDrawingState.backgroundBlurRadius == backgroundBlurRadius) return false;
Vishnu Nairb801a982021-11-02 15:12:08 -0700890 // If we start or stop drawing blur then the layer's visibility state may change so increment
891 // the magic sequence number.
892 if (mDrawingState.backgroundBlurRadius == 0 || backgroundBlurRadius == 0) {
893 mDrawingState.sequence++;
894 }
Robert Carr6a160312021-05-17 12:08:20 -0700895 mDrawingState.backgroundBlurRadius = backgroundBlurRadius;
896 mDrawingState.modified = true;
Lucas Dupin19c8f0e2019-11-25 17:55:44 -0800897 setTransactionFlags(eTransactionNeeded);
898 return true;
899}
Marissa Wall61c58622018-07-18 10:12:20 -0700900
Mathias Agopian13127d82013-03-05 17:47:11 -0800901bool Layer::setTransparentRegionHint(const Region& transparent) {
Vishnu Nairea04b6f2022-08-19 21:28:17 +0000902 mDrawingState.sequence++;
903 mDrawingState.transparentRegionHint = transparent;
Robert Carr6a160312021-05-17 12:08:20 -0700904 mDrawingState.modified = true;
Mathias Agopian13127d82013-03-05 17:47:11 -0800905 setTransactionFlags(eTransactionNeeded);
906 return true;
907}
Ana Krulecc84d09b2019-11-02 23:10:29 +0100908
Lucas Dupinc3800b82020-10-02 16:24:48 -0700909bool Layer::setBlurRegions(const std::vector<BlurRegion>& blurRegions) {
Vishnu Nairb801a982021-11-02 15:12:08 -0700910 // If we start or stop drawing blur then the layer's visibility state may change so increment
911 // the magic sequence number.
912 if (mDrawingState.blurRegions.size() == 0 || blurRegions.size() == 0) {
913 mDrawingState.sequence++;
914 }
Robert Carr6a160312021-05-17 12:08:20 -0700915 mDrawingState.blurRegions = blurRegions;
916 mDrawingState.modified = true;
Lucas Dupinc3800b82020-10-02 16:24:48 -0700917 setTransactionFlags(eTransactionNeeded);
918 return true;
919}
920
Vishnu Nairf6eddb62021-01-27 22:02:11 -0800921bool Layer::setFlags(uint32_t flags, uint32_t mask) {
Robert Carr6a160312021-05-17 12:08:20 -0700922 const uint32_t newFlags = (mDrawingState.flags & ~mask) | (flags & mask);
923 if (mDrawingState.flags == newFlags) return false;
924 mDrawingState.sequence++;
925 mDrawingState.flags = newFlags;
926 mDrawingState.modified = true;
Mathias Agopian13127d82013-03-05 17:47:11 -0800927 setTransactionFlags(eTransactionNeeded);
928 return true;
929}
Robert Carr99e27f02016-06-16 15:18:02 -0700930
chaviw25714502021-02-11 10:01:08 -0800931bool Layer::setCrop(const Rect& crop) {
Vishnu Nairea04b6f2022-08-19 21:28:17 +0000932 if (mDrawingState.crop == crop) return false;
Robert Carr6a160312021-05-17 12:08:20 -0700933 mDrawingState.sequence++;
Robert Carr6a160312021-05-17 12:08:20 -0700934 mDrawingState.crop = crop;
Robert Carr7bf247e2017-05-18 14:02:49 -0700935
Robert Carr6a160312021-05-17 12:08:20 -0700936 mDrawingState.modified = true;
Mathias Agopian13127d82013-03-05 17:47:11 -0800937 setTransactionFlags(eTransactionNeeded);
938 return true;
939}
Robert Carr8d5227b2017-03-16 15:41:03 -0700940
Evan Roskyef876c92019-01-25 17:46:06 -0800941bool Layer::setMetadata(const LayerMetadata& data) {
Robert Carr6a160312021-05-17 12:08:20 -0700942 if (!mDrawingState.metadata.merge(data, true /* eraseEmpty */)) return false;
943 mDrawingState.modified = true;
David Sodman41fdfc92017-11-06 16:09:56 -0800944 setTransactionFlags(eTransactionNeeded);
Evan Rosky1f6d6d52018-12-06 10:47:26 -0800945 return true;
Daniel Nicoara2f5f8a52016-12-20 16:11:58 -0500946}
947
Dominik Laskowski29fa1462021-04-27 15:51:50 -0700948bool Layer::setLayerStack(ui::LayerStack layerStack) {
Robert Carr6a160312021-05-17 12:08:20 -0700949 if (mDrawingState.layerStack == layerStack) return false;
950 mDrawingState.sequence++;
951 mDrawingState.layerStack = layerStack;
952 mDrawingState.modified = true;
Mathias Agopian13127d82013-03-05 17:47:11 -0800953 setTransactionFlags(eTransactionNeeded);
954 return true;
Mathias Agopiana67932f2011-04-20 14:20:59 -0700955}
956
Peiyong Linc502cb72019-03-01 15:00:23 -0800957bool Layer::setColorSpaceAgnostic(const bool agnostic) {
Robert Carr6a160312021-05-17 12:08:20 -0700958 if (mDrawingState.colorSpaceAgnostic == agnostic) {
Peiyong Linc502cb72019-03-01 15:00:23 -0800959 return false;
960 }
Robert Carr6a160312021-05-17 12:08:20 -0700961 mDrawingState.sequence++;
962 mDrawingState.colorSpaceAgnostic = agnostic;
963 mDrawingState.modified = true;
Peiyong Linc502cb72019-03-01 15:00:23 -0800964 setTransactionFlags(eTransactionNeeded);
965 return true;
966}
967
Sally Qi81d95e62022-03-21 19:41:33 -0700968bool Layer::setDimmingEnabled(const bool dimmingEnabled) {
969 if (mDrawingState.dimmingEnabled == dimmingEnabled) return false;
970
971 mDrawingState.sequence++;
972 mDrawingState.dimmingEnabled = dimmingEnabled;
973 mDrawingState.modified = true;
974 setTransactionFlags(eTransactionNeeded);
975 return true;
976}
977
Ana Krulecc84d09b2019-11-02 23:10:29 +0100978bool Layer::setFrameRateSelectionPriority(int32_t priority) {
Robert Carr6a160312021-05-17 12:08:20 -0700979 if (mDrawingState.frameRateSelectionPriority == priority) return false;
980 mDrawingState.frameRateSelectionPriority = priority;
981 mDrawingState.sequence++;
982 mDrawingState.modified = true;
Ana Krulecc84d09b2019-11-02 23:10:29 +0100983 setTransactionFlags(eTransactionNeeded);
984 return true;
985}
986
987int32_t Layer::getFrameRateSelectionPriority() const {
988 // Check if layer has priority set.
989 if (mDrawingState.frameRateSelectionPriority != PRIORITY_UNSET) {
990 return mDrawingState.frameRateSelectionPriority;
991 }
992 // If not, search whether its parents have it set.
Rob Carrc6d2d2b2021-10-25 16:51:49 +0000993 sp<Layer> parent = getParent();
Ana Krulecc84d09b2019-11-02 23:10:29 +0100994 if (parent != nullptr) {
995 return parent->getFrameRateSelectionPriority();
996 }
997
998 return Layer::PRIORITY_UNSET;
999}
1000
Andy Labrada096227e2022-06-15 16:58:11 +00001001bool Layer::setDefaultFrameRateCompatibility(FrameRateCompatibility compatibility) {
1002 if (mDrawingState.defaultFrameRateCompatibility == compatibility) return false;
1003 mDrawingState.defaultFrameRateCompatibility = compatibility;
1004 mDrawingState.modified = true;
1005 mFlinger->mScheduler->setDefaultFrameRateCompatibility(this);
1006 setTransactionFlags(eTransactionNeeded);
1007 return true;
1008}
1009
1010scheduler::LayerInfo::FrameRateCompatibility Layer::getDefaultFrameRateCompatibility() const {
1011 return mDrawingState.defaultFrameRateCompatibility;
1012}
1013
Ady Abrahamaae5ed52020-06-26 09:32:43 -07001014bool Layer::isLayerFocusedBasedOnPriority(int32_t priority) {
1015 return priority == PRIORITY_FOCUSED_WITH_MODE || priority == PRIORITY_FOCUSED_WITHOUT_MODE;
1016};
1017
Vishnu Nair73908d12022-10-24 21:46:42 -07001018ui::LayerStack Layer::getLayerStack(LayerVector::StateSet state) const {
1019 bool useDrawing = state == LayerVector::StateSet::Drawing;
1020 const auto parent = useDrawing ? mDrawingParent.promote() : mCurrentParent.promote();
1021 if (parent) {
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001022 return parent->getLayerStack();
Robert Carr1f0a16a2016-10-24 16:27:39 -07001023 }
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001024 return getDrawingState().layerStack;
Robert Carr1f0a16a2016-10-24 16:27:39 -07001025}
1026
Vishnu Nairc97b8db2019-10-29 18:19:35 -07001027bool Layer::setShadowRadius(float shadowRadius) {
Robert Carr6a160312021-05-17 12:08:20 -07001028 if (mDrawingState.shadowRadius == shadowRadius) {
Vishnu Nairc97b8db2019-10-29 18:19:35 -07001029 return false;
1030 }
1031
Robert Carr6a160312021-05-17 12:08:20 -07001032 mDrawingState.sequence++;
1033 mDrawingState.shadowRadius = shadowRadius;
1034 mDrawingState.modified = true;
Vishnu Nairc97b8db2019-10-29 18:19:35 -07001035 setTransactionFlags(eTransactionNeeded);
1036 return true;
1037}
1038
Vishnu Nair6213bd92020-05-08 17:42:25 -07001039bool Layer::setFixedTransformHint(ui::Transform::RotationFlags fixedTransformHint) {
Robert Carr6a160312021-05-17 12:08:20 -07001040 if (mDrawingState.fixedTransformHint == fixedTransformHint) {
Vishnu Nair6213bd92020-05-08 17:42:25 -07001041 return false;
1042 }
1043
Robert Carr6a160312021-05-17 12:08:20 -07001044 mDrawingState.sequence++;
1045 mDrawingState.fixedTransformHint = fixedTransformHint;
1046 mDrawingState.modified = true;
Vishnu Nair6213bd92020-05-08 17:42:25 -07001047 setTransactionFlags(eTransactionNeeded);
1048 return true;
1049}
1050
John Reckcdb4ed72021-02-04 13:39:33 -05001051bool Layer::setStretchEffect(const StretchEffect& effect) {
1052 StretchEffect temp = effect;
1053 temp.sanitize();
Robert Carr6a160312021-05-17 12:08:20 -07001054 if (mDrawingState.stretchEffect == temp) {
John Reckcdb4ed72021-02-04 13:39:33 -05001055 return false;
1056 }
Robert Carr6a160312021-05-17 12:08:20 -07001057 mDrawingState.sequence++;
1058 mDrawingState.stretchEffect = temp;
1059 mDrawingState.modified = true;
John Reckcdb4ed72021-02-04 13:39:33 -05001060 setTransactionFlags(eTransactionNeeded);
1061 return true;
1062}
1063
John Reckc00c6692021-02-16 11:37:33 -05001064StretchEffect Layer::getStretchEffect() const {
1065 if (mDrawingState.stretchEffect.hasEffect()) {
1066 return mDrawingState.stretchEffect;
1067 }
1068
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001069 sp<Layer> parent = getParent();
John Reckc00c6692021-02-16 11:37:33 -05001070 if (parent != nullptr) {
1071 auto effect = parent->getStretchEffect();
1072 if (effect.hasEffect()) {
1073 // TODO(b/179047472): Map it? Or do we make the effect be in global space?
1074 return effect;
1075 }
1076 }
1077 return StretchEffect{};
1078}
1079
Tianhao Yao10cea3c2022-03-30 01:37:22 +00001080bool Layer::enableBorder(bool shouldEnable, float width, const half4& color) {
1081 if (mBorderEnabled == shouldEnable && mBorderWidth == width && mBorderColor == color) {
Tianhao Yao67dd7122022-02-22 17:48:33 +00001082 return false;
1083 }
1084 mBorderEnabled = shouldEnable;
Tianhao Yao10cea3c2022-03-30 01:37:22 +00001085 mBorderWidth = width;
1086 mBorderColor = color;
Tianhao Yao67dd7122022-02-22 17:48:33 +00001087 return true;
1088}
1089
1090bool Layer::isBorderEnabled() {
1091 return mBorderEnabled;
1092}
1093
Tianhao Yao10cea3c2022-03-30 01:37:22 +00001094float Layer::getBorderWidth() {
1095 return mBorderWidth;
1096}
1097
1098const half4& Layer::getBorderColor() {
1099 return mBorderColor;
1100}
1101
Ady Abrahama850c182021-08-04 13:04:37 -07001102bool Layer::propagateFrameRateForLayerTree(FrameRate parentFrameRate, bool* transactionNeeded) {
1103 // The frame rate for layer tree is this layer's frame rate if present, or the parent frame rate
1104 const auto frameRate = [&] {
1105 if (mDrawingState.frameRate.rate.isValid() ||
1106 mDrawingState.frameRate.type == FrameRateCompatibility::NoVote) {
1107 return mDrawingState.frameRate;
1108 }
1109
1110 return parentFrameRate;
1111 }();
1112
1113 *transactionNeeded |= setFrameRateForLayerTree(frameRate);
1114
1115 // The frame rate is propagated to the children
1116 bool childrenHaveFrameRate = false;
1117 for (const sp<Layer>& child : mCurrentChildren) {
1118 childrenHaveFrameRate |=
1119 child->propagateFrameRateForLayerTree(frameRate, transactionNeeded);
1120 }
1121
1122 // If we don't have a valid frame rate, but the children do, we set this
1123 // layer as NoVote to allow the children to control the refresh rate
1124 if (!frameRate.rate.isValid() && frameRate.type != FrameRateCompatibility::NoVote &&
1125 childrenHaveFrameRate) {
1126 *transactionNeeded |=
Dominik Laskowski6eab42d2021-09-13 14:34:13 -07001127 setFrameRateForLayerTree(FrameRate(Fps(), FrameRateCompatibility::NoVote));
Ady Abrahama850c182021-08-04 13:04:37 -07001128 }
1129
1130 // We return whether this layer ot its children has a vote. We ignore ExactOrMultiple votes for
1131 // the same reason we are allowing touch boost for those layers. See
1132 // RefreshRateConfigs::getBestRefreshRate for more details.
1133 const auto layerVotedWithDefaultCompatibility =
1134 frameRate.rate.isValid() && frameRate.type == FrameRateCompatibility::Default;
1135 const auto layerVotedWithNoVote = frameRate.type == FrameRateCompatibility::NoVote;
1136 const auto layerVotedWithExactCompatibility =
1137 frameRate.rate.isValid() && frameRate.type == FrameRateCompatibility::Exact;
1138 return layerVotedWithDefaultCompatibility || layerVotedWithNoVote ||
1139 layerVotedWithExactCompatibility || childrenHaveFrameRate;
1140}
1141
Ady Abraham60e42ea2020-03-09 19:17:31 -07001142void Layer::updateTreeHasFrameRateVote() {
Ady Abrahama850c182021-08-04 13:04:37 -07001143 const auto root = [&]() -> sp<Layer> {
Ady Abrahamd11bade2022-08-01 16:18:03 -07001144 sp<Layer> layer = sp<Layer>::fromExisting(this);
Ady Abrahama850c182021-08-04 13:04:37 -07001145 while (auto parent = layer->getParent()) {
1146 layer = parent;
Ady Abraham60e42ea2020-03-09 19:17:31 -07001147 }
Ady Abrahama850c182021-08-04 13:04:37 -07001148 return layer;
1149 }();
Ady Abraham60e42ea2020-03-09 19:17:31 -07001150
Ady Abraham60e42ea2020-03-09 19:17:31 -07001151 bool transactionNeeded = false;
Ady Abrahama850c182021-08-04 13:04:37 -07001152 root->propagateFrameRateForLayerTree({}, &transactionNeeded);
Robert Carr6a160312021-05-17 12:08:20 -07001153
Ady Abrahama850c182021-08-04 13:04:37 -07001154 // TODO(b/195668952): we probably don't need eTraversalNeeded here
Ady Abraham60e42ea2020-03-09 19:17:31 -07001155 if (transactionNeeded) {
1156 mFlinger->setTransactionFlags(eTraversalNeeded);
1157 }
1158}
1159
Ady Abraham71c437d2020-01-31 15:56:57 -08001160bool Layer::setFrameRate(FrameRate frameRate) {
Robert Carr6a160312021-05-17 12:08:20 -07001161 if (mDrawingState.frameRate == frameRate) {
Steven Thomas3172e202020-01-06 19:25:30 -08001162 return false;
1163 }
1164
Robert Carr6a160312021-05-17 12:08:20 -07001165 mDrawingState.sequence++;
1166 mDrawingState.frameRate = frameRate;
1167 mDrawingState.modified = true;
Ady Abraham60e42ea2020-03-09 19:17:31 -07001168
1169 updateTreeHasFrameRateVote();
1170
Steven Thomas3172e202020-01-06 19:25:30 -08001171 setTransactionFlags(eTransactionNeeded);
1172 return true;
1173}
1174
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001175void Layer::setFrameTimelineVsyncForBufferTransaction(const FrameTimelineInfo& info,
1176 nsecs_t postTime) {
Robert Carr6a160312021-05-17 12:08:20 -07001177 mDrawingState.postTime = postTime;
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001178
1179 // Check if one of the bufferlessSurfaceFramesTX contains the same vsyncId. This can happen if
1180 // there are two transactions with the same token, the first one without a buffer and the
1181 // second one with a buffer. We promote the bufferlessSurfaceFrame to a bufferSurfaceFrameTX
1182 // in that case.
Robert Carr6a160312021-05-17 12:08:20 -07001183 auto it = mDrawingState.bufferlessSurfaceFramesTX.find(info.vsyncId);
1184 if (it != mDrawingState.bufferlessSurfaceFramesTX.end()) {
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001185 // Promote the bufferlessSurfaceFrame to a bufferSurfaceFrameTX
Robert Carr6a160312021-05-17 12:08:20 -07001186 mDrawingState.bufferSurfaceFrameTX = it->second;
1187 mDrawingState.bufferlessSurfaceFramesTX.erase(it);
1188 mDrawingState.bufferSurfaceFrameTX->promoteToBuffer();
1189 mDrawingState.bufferSurfaceFrameTX->setActualQueueTime(postTime);
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001190 } else {
Robert Carr6a160312021-05-17 12:08:20 -07001191 mDrawingState.bufferSurfaceFrameTX =
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001192 createSurfaceFrameForBuffer(info, postTime, mTransactionName);
1193 }
1194}
1195
1196void Layer::setFrameTimelineVsyncForBufferlessTransaction(const FrameTimelineInfo& info,
1197 nsecs_t postTime) {
Robert Carr6a160312021-05-17 12:08:20 -07001198 mDrawingState.frameTimelineInfo = info;
1199 mDrawingState.postTime = postTime;
1200 mDrawingState.modified = true;
Ady Abraham22c7b5c2020-09-22 19:33:40 -07001201 setTransactionFlags(eTransactionNeeded);
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001202
Robert Carr6a160312021-05-17 12:08:20 -07001203 if (const auto& bufferSurfaceFrameTX = mDrawingState.bufferSurfaceFrameTX;
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001204 bufferSurfaceFrameTX != nullptr) {
1205 if (bufferSurfaceFrameTX->getToken() == info.vsyncId) {
1206 // BufferSurfaceFrame takes precedence over BufferlessSurfaceFrame. If the same token is
1207 // being used for BufferSurfaceFrame, don't create a new one.
1208 return;
1209 }
1210 }
1211 // For Transactions without a buffer, we create only one SurfaceFrame per vsyncId. If multiple
1212 // transactions use the same vsyncId, we just treat them as one SurfaceFrame (unless they are
1213 // targeting different vsyncs).
Robert Carr6a160312021-05-17 12:08:20 -07001214 auto it = mDrawingState.bufferlessSurfaceFramesTX.find(info.vsyncId);
1215 if (it == mDrawingState.bufferlessSurfaceFramesTX.end()) {
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001216 auto surfaceFrame = createSurfaceFrameForTransaction(info, postTime);
Robert Carr6a160312021-05-17 12:08:20 -07001217 mDrawingState.bufferlessSurfaceFramesTX[info.vsyncId] = surfaceFrame;
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001218 } else {
1219 if (it->second->getPresentState() == PresentState::Presented) {
1220 // If the SurfaceFrame was already presented, its safe to overwrite it since it must
1221 // have been from previous vsync.
1222 it->second = createSurfaceFrameForTransaction(info, postTime);
1223 }
1224 }
1225}
1226
1227void Layer::addSurfaceFrameDroppedForBuffer(
1228 std::shared_ptr<frametimeline::SurfaceFrame>& surfaceFrame) {
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001229 surfaceFrame->setDropTime(systemTime());
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001230 surfaceFrame->setPresentState(PresentState::Dropped);
1231 mFlinger->mFrameTimeline->addSurfaceFrame(surfaceFrame);
1232}
1233
1234void Layer::addSurfaceFramePresentedForBuffer(
1235 std::shared_ptr<frametimeline::SurfaceFrame>& surfaceFrame, nsecs_t acquireFenceTime,
1236 nsecs_t currentLatchTime) {
1237 surfaceFrame->setAcquireFenceTime(acquireFenceTime);
1238 surfaceFrame->setPresentState(PresentState::Presented, mLastLatchTime);
1239 mFlinger->mFrameTimeline->addSurfaceFrame(surfaceFrame);
1240 mLastLatchTime = currentLatchTime;
1241}
1242
1243std::shared_ptr<frametimeline::SurfaceFrame> Layer::createSurfaceFrameForTransaction(
1244 const FrameTimelineInfo& info, nsecs_t postTime) {
1245 auto surfaceFrame =
Alec Mouriadebf5c2021-01-05 12:57:36 -08001246 mFlinger->mFrameTimeline->createSurfaceFrameForToken(info, mOwnerPid, mOwnerUid,
1247 getSequence(), mName,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001248 mTransactionName,
Adithya Srinivasan58069dc2021-06-04 20:37:02 +00001249 /*isBuffer*/ false, getGameMode());
Rachel Leeed511ef2021-10-11 15:09:51 -07001250 surfaceFrame->setActualStartTime(info.startTimeNanos);
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001251 // For Transactions, the post time is considered to be both queue and acquire fence time.
1252 surfaceFrame->setActualQueueTime(postTime);
1253 surfaceFrame->setAcquireFenceTime(postTime);
Alec Mouri7d436ec2021-01-27 20:40:50 -08001254 const auto fps = mFlinger->mScheduler->getFrameRateOverride(getOwnerUid());
1255 if (fps) {
Alec Mouri819f6302021-02-12 15:37:21 -08001256 surfaceFrame->setRenderRate(*fps);
Alec Mouri7d436ec2021-01-27 20:40:50 -08001257 }
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001258 onSurfaceFrameCreated(surfaceFrame);
1259 return surfaceFrame;
1260}
1261
1262std::shared_ptr<frametimeline::SurfaceFrame> Layer::createSurfaceFrameForBuffer(
1263 const FrameTimelineInfo& info, nsecs_t queueTime, std::string debugName) {
1264 auto surfaceFrame =
Alec Mouriadebf5c2021-01-05 12:57:36 -08001265 mFlinger->mFrameTimeline->createSurfaceFrameForToken(info, mOwnerPid, mOwnerUid,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001266 getSequence(), mName, debugName,
Adithya Srinivasan58069dc2021-06-04 20:37:02 +00001267 /*isBuffer*/ true, getGameMode());
Rachel Leeed511ef2021-10-11 15:09:51 -07001268 surfaceFrame->setActualStartTime(info.startTimeNanos);
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001269 // For buffers, acquire fence time will set during latch.
1270 surfaceFrame->setActualQueueTime(queueTime);
Alec Mouri7d436ec2021-01-27 20:40:50 -08001271 const auto fps = mFlinger->mScheduler->getFrameRateOverride(getOwnerUid());
1272 if (fps) {
Alec Mouri819f6302021-02-12 15:37:21 -08001273 surfaceFrame->setRenderRate(*fps);
Alec Mouri7d436ec2021-01-27 20:40:50 -08001274 }
Adithya Srinivasanb9a7dab2021-01-14 23:49:46 +00001275 onSurfaceFrameCreated(surfaceFrame);
1276 return surfaceFrame;
Ady Abraham74e17562020-08-24 18:18:19 -07001277}
1278
Ady Abrahama850c182021-08-04 13:04:37 -07001279bool Layer::setFrameRateForLayerTree(FrameRate frameRate) {
1280 if (mDrawingState.frameRateForLayerTree == frameRate) {
1281 return false;
Ady Abraham60e42ea2020-03-09 19:17:31 -07001282 }
1283
Ady Abrahama850c182021-08-04 13:04:37 -07001284 mDrawingState.frameRateForLayerTree = frameRate;
Ady Abrahamf467f892020-07-31 16:01:53 -07001285
Ady Abrahama850c182021-08-04 13:04:37 -07001286 // TODO(b/195668952): we probably don't need to dirty visible regions here
1287 // or even store frameRateForLayerTree in mDrawingState
1288 mDrawingState.sequence++;
1289 mDrawingState.modified = true;
1290 setTransactionFlags(eTransactionNeeded);
Ady Abraham60e42ea2020-03-09 19:17:31 -07001291
Dominik Laskowski068173d2021-08-11 17:22:59 -07001292 using LayerUpdateType = scheduler::LayerHistory::LayerUpdateType;
1293 mFlinger->mScheduler->recordLayerHistory(this, systemTime(), LayerUpdateType::SetFrameRate);
Ady Abrahama850c182021-08-04 13:04:37 -07001294
1295 return true;
Steven Thomas3172e202020-01-06 19:25:30 -08001296}
1297
Ady Abraham59fd8ff2021-04-15 20:13:30 -07001298Layer::FrameRate Layer::getFrameRateForLayerTree() const {
1299 return getDrawingState().frameRateForLayerTree;
1300}
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -08001301
Robert Carr1f0a16a2016-10-24 16:27:39 -07001302bool Layer::isHiddenByPolicy() const {
Lloyd Pique0449b0f2018-12-20 16:23:45 -08001303 const State& s(mDrawingState);
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001304 const auto& parent = mDrawingParent.promote();
Robert Carr1f0a16a2016-10-24 16:27:39 -07001305 if (parent != nullptr && parent->isHiddenByPolicy()) {
1306 return true;
1307 }
Robert Carr1c5481e2019-07-01 14:42:27 -07001308 if (usingRelativeZ(LayerVector::StateSet::Drawing)) {
1309 auto zOrderRelativeOf = mDrawingState.zOrderRelativeOf.promote();
1310 if (zOrderRelativeOf != nullptr) {
1311 if (zOrderRelativeOf->isHiddenByPolicy()) {
1312 return true;
1313 }
1314 }
1315 }
Garfield Tan2c1782c2022-02-16 15:25:05 -08001316 if (CC_UNLIKELY(!isTransformValid())) {
1317 ALOGW("Hide layer %s because it has invalid transformation.", getDebugName());
1318 return true;
1319 }
Robert Carr1f0a16a2016-10-24 16:27:39 -07001320 return s.flags & layer_state_t::eLayerHidden;
1321}
1322
David Sodman41fdfc92017-11-06 16:09:56 -08001323uint32_t Layer::getEffectiveUsage(uint32_t usage) const {
Mathias Agopiana67932f2011-04-20 14:20:59 -07001324 // TODO: should we do something special if mSecure is set?
1325 if (mProtectedByApp) {
1326 // need a hardware-protected path to external video sink
1327 usage |= GraphicBuffer::USAGE_PROTECTED;
Jamie Gennis54cc83e2010-11-02 11:51:32 -07001328 }
Riley Andrews03414a12014-07-01 14:22:59 -07001329 if (mPotentialCursor) {
1330 usage |= GraphicBuffer::USAGE_CURSOR;
1331 }
Jamie Gennis3599bf22011-08-10 11:48:07 -07001332 usage |= GraphicBuffer::USAGE_HW_COMPOSER;
Mathias Agopiana67932f2011-04-20 14:20:59 -07001333 return usage;
Mathias Agopianb5b7f262010-05-07 15:58:44 -07001334}
1335
Vishnu Nair71fcf912022-10-18 09:14:20 -07001336void Layer::skipReportingTransformHint() {
1337 mSkipReportingTransformHint = true;
1338}
1339
Dominik Laskowskib7251f42020-04-20 17:42:59 -07001340void Layer::updateTransformHint(ui::Transform::RotationFlags transformHint) {
1341 if (mFlinger->mDebugDisableTransformHint || transformHint & ui::Transform::ROT_INVALID) {
1342 transformHint = ui::Transform::ROT_0;
Mathias Agopiana4583642011-08-23 18:03:18 -07001343 }
Dominik Laskowskib7251f42020-04-20 17:42:59 -07001344
Vishnu Nair6213bd92020-05-08 17:42:25 -07001345 setTransformHint(transformHint);
Mathias Agopiana4583642011-08-23 18:03:18 -07001346}
1347
Mathias Agopian13127d82013-03-05 17:47:11 -08001348// ----------------------------------------------------------------------------
1349// debugging
1350// ----------------------------------------------------------------------------
1351
Marissa Wall61c58622018-07-18 10:12:20 -07001352// TODO(marissaw): add new layer state info to layer debugging
Huihong Luo05539a12022-02-23 10:29:40 -08001353gui::LayerDebugInfo Layer::getLayerDebugInfo(const DisplayDevice* display) const {
Dominik Laskowski87a07e42019-10-10 20:38:02 -07001354 using namespace std::string_literals;
1355
Huihong Luo05539a12022-02-23 10:29:40 -08001356 gui::LayerDebugInfo info;
Alec Mourib416efd2018-09-06 21:01:59 +00001357 const State& ds = getDrawingState();
Kalle Raitaa099a242017-01-11 11:17:29 -08001358 info.mName = getName();
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001359 sp<Layer> parent = mDrawingParent.promote();
Dominik Laskowski87a07e42019-10-10 20:38:02 -07001360 info.mParentName = parent ? parent->getName() : "none"s;
chaviw8a01fa42019-08-19 12:39:31 -07001361 info.mType = getType();
Lloyd Piquea2468662019-03-07 21:31:06 -08001362
Dominik Laskowskib7251f42020-04-20 17:42:59 -07001363 info.mVisibleRegion = getVisibleRegion(display);
Kalle Raitaa099a242017-01-11 11:17:29 -08001364 info.mSurfaceDamageRegion = surfaceDamageRegion;
Dominik Laskowski29fa1462021-04-27 15:51:50 -07001365 info.mLayerStack = getLayerStack().id;
chaviw4e765532021-04-30 12:11:39 -05001366 info.mX = ds.transform.tx();
1367 info.mY = ds.transform.ty();
Kalle Raitaa099a242017-01-11 11:17:29 -08001368 info.mZ = ds.z;
chaviw25714502021-02-11 10:01:08 -08001369 info.mCrop = ds.crop;
chaviw13fdc492017-06-27 12:40:18 -07001370 info.mColor = ds.color;
Kalle Raitaa099a242017-01-11 11:17:29 -08001371 info.mFlags = ds.flags;
1372 info.mPixelFormat = getPixelFormat();
chaviw4244e032019-09-04 11:27:49 -07001373 info.mDataSpace = static_cast<android_dataspace>(getDataSpace());
chaviw4e765532021-04-30 12:11:39 -05001374 info.mMatrix[0][0] = ds.transform[0][0];
1375 info.mMatrix[0][1] = ds.transform[0][1];
1376 info.mMatrix[1][0] = ds.transform[1][0];
1377 info.mMatrix[1][1] = ds.transform[1][1];
Kalle Raitaa099a242017-01-11 11:17:29 -08001378 {
chaviwd62d3062019-09-04 14:48:02 -07001379 sp<const GraphicBuffer> buffer = getBuffer();
David Sodman5b4cffc2017-11-23 13:20:29 -08001380 if (buffer != 0) {
1381 info.mActiveBufferWidth = buffer->getWidth();
1382 info.mActiveBufferHeight = buffer->getHeight();
1383 info.mActiveBufferStride = buffer->getStride();
1384 info.mActiveBufferFormat = buffer->format;
Kalle Raitaa099a242017-01-11 11:17:29 -08001385 } else {
1386 info.mActiveBufferWidth = 0;
1387 info.mActiveBufferHeight = 0;
1388 info.mActiveBufferStride = 0;
1389 info.mActiveBufferFormat = 0;
1390 }
Mathias Agopian13127d82013-03-05 17:47:11 -08001391 }
Kalle Raitaa099a242017-01-11 11:17:29 -08001392 info.mNumQueuedFrames = getQueuedFrameCount();
Kalle Raitaa099a242017-01-11 11:17:29 -08001393 info.mIsOpaque = isOpaque(ds);
1394 info.mContentDirty = contentDirty;
John Reckc00c6692021-02-16 11:37:33 -05001395 info.mStretchEffect = getStretchEffect();
Kalle Raitaa099a242017-01-11 11:17:29 -08001396 return info;
Mathias Agopian13127d82013-03-05 17:47:11 -08001397}
Chia-I Wu83ce7c12017-10-19 15:18:55 -07001398
Yiwei Zhang5434a782018-12-05 18:06:32 -08001399void Layer::miniDumpHeader(std::string& result) {
Marin Shalamanov1876e2e2020-12-04 13:23:59 +01001400 result.append(kDumpTableRowLength, '-');
1401 result.append("\n");
Dan Stozae22aec72016-08-01 13:20:59 -07001402 result.append(" Layer name\n");
1403 result.append(" Z | ");
Ady Abraham8f1ee7f2019-04-05 10:32:50 -07001404 result.append(" Window Type | ");
Dan Stozae22aec72016-08-01 13:20:59 -07001405 result.append(" Comp Type | ");
Yichi Chen6ca35192018-05-29 12:20:43 +08001406 result.append(" Transform | ");
Dan Stozae22aec72016-08-01 13:20:59 -07001407 result.append(" Disp Frame (LTRB) | ");
Ady Abrahambe23e6a2020-05-04 14:51:16 -07001408 result.append(" Source Crop (LTRB) | ");
Marin Shalamanov1876e2e2020-12-04 13:23:59 +01001409 result.append(" Frame Rate (Explicit) (Seamlessness) [Focused]\n");
1410 result.append(kDumpTableRowLength, '-');
1411 result.append("\n");
Ady Abrahambe23e6a2020-05-04 14:51:16 -07001412}
1413
Dominik Laskowskib7251f42020-04-20 17:42:59 -07001414void Layer::miniDump(std::string& result, const DisplayDevice& display) const {
1415 const auto outputLayer = findOutputLayerForDisplay(&display);
Lloyd Pique37c2c9b2018-12-04 17:25:10 -08001416 if (!outputLayer) {
Dan Stozae22aec72016-08-01 13:20:59 -07001417 return;
1418 }
1419
Yiwei Zhang5434a782018-12-05 18:06:32 -08001420 std::string name;
Dan Stozae22aec72016-08-01 13:20:59 -07001421 if (mName.length() > 77) {
1422 std::string shortened;
Dominik Laskowski87a07e42019-10-10 20:38:02 -07001423 shortened.append(mName, 0, 36);
Dan Stozae22aec72016-08-01 13:20:59 -07001424 shortened.append("[...]");
Dominik Laskowski87a07e42019-10-10 20:38:02 -07001425 shortened.append(mName, mName.length() - 36);
1426 name = std::move(shortened);
Dan Stozae22aec72016-08-01 13:20:59 -07001427 } else {
Dominik Laskowski87a07e42019-10-10 20:38:02 -07001428 name = mName;
Dan Stozae22aec72016-08-01 13:20:59 -07001429 }
1430
Yiwei Zhang5434a782018-12-05 18:06:32 -08001431 StringAppendF(&result, " %s\n", name.c_str());
Dan Stozae22aec72016-08-01 13:20:59 -07001432
Alec Mourib416efd2018-09-06 21:01:59 +00001433 const State& layerState(getDrawingState());
Lloyd Piquede196652020-01-22 17:29:58 -08001434 const auto& outputLayerState = outputLayer->getState();
Lloyd Pique37c2c9b2018-12-04 17:25:10 -08001435
Chia-I Wu1e043612018-03-01 09:45:09 -08001436 if (layerState.zOrderRelativeOf != nullptr || mDrawingParent != nullptr) {
Yiwei Zhang5434a782018-12-05 18:06:32 -08001437 StringAppendF(&result, " rel %6d | ", layerState.z);
Chia-I Wu1e043612018-03-01 09:45:09 -08001438 } else {
Yiwei Zhang5434a782018-12-05 18:06:32 -08001439 StringAppendF(&result, " %10d | ", layerState.z);
Chia-I Wu1e043612018-03-01 09:45:09 -08001440 }
Ady Abraham8f1ee7f2019-04-05 10:32:50 -07001441 StringAppendF(&result, " %10d | ", mWindowType);
Dominik Laskowskib7251f42020-04-20 17:42:59 -07001442 StringAppendF(&result, "%10s | ", toString(getCompositionType(display)).c_str());
Lloyd Piquede196652020-01-22 17:29:58 -08001443 StringAppendF(&result, "%10s | ", toString(outputLayerState.bufferTransform).c_str());
1444 const Rect& frame = outputLayerState.displayFrame;
Yiwei Zhang5434a782018-12-05 18:06:32 -08001445 StringAppendF(&result, "%4d %4d %4d %4d | ", frame.left, frame.top, frame.right, frame.bottom);
Lloyd Piquede196652020-01-22 17:29:58 -08001446 const FloatRect& crop = outputLayerState.sourceCrop;
Ady Abrahambe23e6a2020-05-04 14:51:16 -07001447 StringAppendF(&result, "%6.1f %6.1f %6.1f %6.1f | ", crop.left, crop.top, crop.right,
Yiwei Zhang5434a782018-12-05 18:06:32 -08001448 crop.bottom);
Ady Abrahamf467f892020-07-31 16:01:53 -07001449 const auto frameRate = getFrameRateForLayerTree();
1450 if (frameRate.rate.isValid() || frameRate.type != FrameRateCompatibility::Default) {
1451 StringAppendF(&result, "%s %15s %17s", to_string(frameRate.rate).c_str(),
Dominik Laskowskif5d0ea52021-09-26 17:27:01 -07001452 ftl::enum_string(frameRate.type).c_str(),
1453 ftl::enum_string(frameRate.seamlessness).c_str());
Ady Abrahambe23e6a2020-05-04 14:51:16 -07001454 } else {
Marin Shalamanov1876e2e2020-12-04 13:23:59 +01001455 result.append(41, ' ');
Ady Abrahambe23e6a2020-05-04 14:51:16 -07001456 }
Dan Stozae22aec72016-08-01 13:20:59 -07001457
Ady Abrahamaae5ed52020-06-26 09:32:43 -07001458 const auto focused = isLayerFocusedBasedOnPriority(getFrameRateSelectionPriority());
1459 StringAppendF(&result, " [%s]\n", focused ? "*" : " ");
1460
Marin Shalamanov1876e2e2020-12-04 13:23:59 +01001461 result.append(kDumpTableRowLength, '-');
1462 result.append("\n");
Dan Stozae22aec72016-08-01 13:20:59 -07001463}
Dan Stozae22aec72016-08-01 13:20:59 -07001464
Yiwei Zhang5434a782018-12-05 18:06:32 -08001465void Layer::dumpFrameStats(std::string& result) const {
Svetoslavd85084b2014-03-20 10:28:31 -07001466 mFrameTracker.dumpStats(result);
Mathias Agopian13127d82013-03-05 17:47:11 -08001467}
1468
Svetoslavd85084b2014-03-20 10:28:31 -07001469void Layer::clearFrameStats() {
1470 mFrameTracker.clearStats();
Mathias Agopian13127d82013-03-05 17:47:11 -08001471}
1472
Jamie Gennis6547ff42013-07-16 20:12:42 -07001473void Layer::logFrameStats() {
1474 mFrameTracker.logAndResetStats(mName);
1475}
1476
Svetoslavd85084b2014-03-20 10:28:31 -07001477void Layer::getFrameStats(FrameStats* outStats) const {
1478 mFrameTracker.getStats(outStats);
1479}
1480
Vishnu Nair0f085c62019-08-30 08:49:12 -07001481void Layer::dumpCallingUidPid(std::string& result) const {
Vishnu Naircb8be502022-10-12 19:03:23 +00001482 StringAppendF(&result, "Layer %s (%s) ownerPid:%d ownerUid:%d\n", getName().c_str(), getType(),
1483 mOwnerPid, mOwnerUid);
Vishnu Nair0f085c62019-08-30 08:49:12 -07001484}
1485
Brian Anderson5ea5e592016-12-01 16:54:33 -08001486void Layer::onDisconnect() {
Yiwei Zhang1a88c402019-11-18 10:43:58 -08001487 const int32_t layerId = getSequence();
1488 mFlinger->mTimeStats->onDestroy(layerId);
1489 mFlinger->mFrameTracer->onDestroy(layerId);
Brian Anderson5ea5e592016-12-01 16:54:33 -08001490}
1491
Chia-I Wu98f1c102017-05-30 14:54:08 -07001492size_t Layer::getChildrenCount() const {
1493 size_t count = 0;
1494 for (const sp<Layer>& child : mCurrentChildren) {
1495 count += 1 + child->getChildrenCount();
1496 }
1497 return count;
1498}
1499
Dominik Laskowskif5d0ea52021-09-26 17:27:01 -07001500void Layer::setGameModeForTree(GameMode gameMode) {
1501 const auto& currentState = getDrawingState();
Huihong Luod3d8f8e2022-03-08 14:48:46 -08001502 if (currentState.metadata.has(gui::METADATA_GAME_MODE)) {
1503 gameMode =
1504 static_cast<GameMode>(currentState.metadata.getInt32(gui::METADATA_GAME_MODE, 0));
Adithya Srinivasanac977e62021-05-21 22:50:56 +00001505 }
1506 setGameMode(gameMode);
1507 for (const sp<Layer>& child : mCurrentChildren) {
1508 child->setGameModeForTree(gameMode);
1509 }
1510}
1511
Robert Carr1f0a16a2016-10-24 16:27:39 -07001512void Layer::addChild(const sp<Layer>& layer) {
Robert Carre450fb52021-06-11 13:21:09 -07001513 mFlinger->mSomeChildrenChanged = true;
Robert Carr7f2ed8b2019-02-07 14:45:11 -08001514 setTransactionFlags(eTransactionNeeded);
Robert Carr1323c952019-01-28 18:13:27 -08001515
Robert Carr1f0a16a2016-10-24 16:27:39 -07001516 mCurrentChildren.add(layer);
Ady Abrahamd11bade2022-08-01 16:18:03 -07001517 layer->setParent(sp<Layer>::fromExisting(this));
Adithya Srinivasanac977e62021-05-21 22:50:56 +00001518 layer->setGameModeForTree(mGameMode);
Ady Abraham60e42ea2020-03-09 19:17:31 -07001519 updateTreeHasFrameRateVote();
Robert Carr1f0a16a2016-10-24 16:27:39 -07001520}
1521
1522ssize_t Layer::removeChild(const sp<Layer>& layer) {
Robert Carre450fb52021-06-11 13:21:09 -07001523 mFlinger->mSomeChildrenChanged = true;
Robert Carr7f2ed8b2019-02-07 14:45:11 -08001524 setTransactionFlags(eTransactionNeeded);
Robert Carr6fb1a7e2018-12-11 12:07:25 -08001525
Robert Carr1323c952019-01-28 18:13:27 -08001526 layer->setParent(nullptr);
Ady Abraham60e42ea2020-03-09 19:17:31 -07001527 const auto removeResult = mCurrentChildren.remove(layer);
1528
1529 updateTreeHasFrameRateVote();
Dominik Laskowskif5d0ea52021-09-26 17:27:01 -07001530 layer->setGameModeForTree(GameMode::Unsupported);
Ady Abraham60e42ea2020-03-09 19:17:31 -07001531 layer->updateTreeHasFrameRateVote();
1532
1533 return removeResult;
1534}
1535
Robert Carr15eae092018-03-23 13:43:53 -07001536void Layer::setChildrenDrawingParent(const sp<Layer>& newParent) {
Robert Carr578038f2018-03-09 12:25:24 -08001537 for (const sp<Layer>& child : mDrawingChildren) {
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001538 child->mDrawingParent = newParent;
xinying1f4200e62022-04-26 14:41:30 +08001539 const float parentShadowRadius =
1540 newParent->canDrawShadows() ? 0.f : newParent->mEffectiveShadowRadius;
Vishnu Nair6bdec7d2021-05-10 15:01:13 -07001541 child->computeBounds(newParent->mBounds, newParent->mEffectiveTransform,
xinying1f4200e62022-04-26 14:41:30 +08001542 parentShadowRadius);
Robert Carr578038f2018-03-09 12:25:24 -08001543 }
1544}
1545
chaviwf1961f72017-09-18 16:41:07 -07001546bool Layer::reparent(const sp<IBinder>& newParentHandle) {
Robert Carr54cf5b12019-01-25 14:02:28 -08001547 sp<Layer> newParent;
1548 if (newParentHandle != nullptr) {
Vishnu Nair07e2a482022-10-18 19:18:16 +00001549 newParent = LayerHandle::getLayer(newParentHandle);
Robert Carr54cf5b12019-01-25 14:02:28 -08001550 if (newParent == nullptr) {
1551 ALOGE("Unable to promote Layer handle");
1552 return false;
1553 }
1554 if (newParent == this) {
1555 ALOGE("Invalid attempt to reparent Layer (%s) to itself", getName().c_str());
1556 return false;
1557 }
1558 }
1559
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001560 sp<Layer> parent = getParent();
chaviwf1961f72017-09-18 16:41:07 -07001561 if (parent != nullptr) {
Ady Abrahamd11bade2022-08-01 16:18:03 -07001562 parent->removeChild(sp<Layer>::fromExisting(this));
chaviw06178942017-07-27 10:25:59 -07001563 }
1564
Robert Carr6fb1a7e2018-12-11 12:07:25 -08001565 if (newParentHandle != nullptr) {
Ady Abrahamd11bade2022-08-01 16:18:03 -07001566 newParent->addChild(sp<Layer>::fromExisting(this));
Robert Carr6fb1a7e2018-12-11 12:07:25 -08001567 if (!newParent->isRemovedFromCurrentState()) {
1568 addToCurrentState();
1569 } else {
1570 onRemovedFromCurrentState();
1571 }
Robert Carr6fb1a7e2018-12-11 12:07:25 -08001572 } else {
1573 onRemovedFromCurrentState();
chaviw61626f22018-11-15 16:26:27 -08001574 }
1575
chaviw06178942017-07-27 10:25:59 -07001576 return true;
1577}
1578
Peiyong Lind3788632018-09-18 16:01:31 -07001579bool Layer::setColorTransform(const mat4& matrix) {
Peiyong Lin747321c2018-10-01 10:03:11 -07001580 static const mat4 identityMatrix = mat4();
1581
Robert Carr6a160312021-05-17 12:08:20 -07001582 if (mDrawingState.colorTransform == matrix) {
Peiyong Lind3788632018-09-18 16:01:31 -07001583 return false;
1584 }
Robert Carr6a160312021-05-17 12:08:20 -07001585 ++mDrawingState.sequence;
1586 mDrawingState.colorTransform = matrix;
1587 mDrawingState.hasColorTransform = matrix != identityMatrix;
1588 mDrawingState.modified = true;
Peiyong Lind3788632018-09-18 16:01:31 -07001589 setTransactionFlags(eTransactionNeeded);
1590 return true;
1591}
1592
chaviwf66724d2018-11-28 16:35:21 -08001593mat4 Layer::getColorTransform() const {
1594 mat4 colorTransform = mat4(getDrawingState().colorTransform);
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001595 if (sp<Layer> parent = mDrawingParent.promote(); parent != nullptr) {
chaviwf66724d2018-11-28 16:35:21 -08001596 colorTransform = parent->getColorTransform() * colorTransform;
1597 }
1598 return colorTransform;
Peiyong Lind3788632018-09-18 16:01:31 -07001599}
1600
1601bool Layer::hasColorTransform() const {
chaviwf66724d2018-11-28 16:35:21 -08001602 bool hasColorTransform = getDrawingState().hasColorTransform;
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001603 if (sp<Layer> parent = mDrawingParent.promote(); parent != nullptr) {
chaviwf66724d2018-11-28 16:35:21 -08001604 hasColorTransform = hasColorTransform || parent->hasColorTransform();
1605 }
1606 return hasColorTransform;
Peiyong Lind3788632018-09-18 16:01:31 -07001607}
1608
Chia-I Wu11481472018-05-04 10:43:19 -07001609bool Layer::isLegacyDataSpace() const {
1610 // return true when no higher bits are set
chaviw4244e032019-09-04 11:27:49 -07001611 return !(getDataSpace() &
1612 (ui::Dataspace::STANDARD_MASK | ui::Dataspace::TRANSFER_MASK |
1613 ui::Dataspace::RANGE_MASK));
Peiyong Lindd9b2ae2018-03-01 16:22:45 -08001614}
1615
Robert Carr1f0a16a2016-10-24 16:27:39 -07001616void Layer::setParent(const sp<Layer>& layer) {
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001617 mCurrentParent = layer;
Robert Carr1f0a16a2016-10-24 16:27:39 -07001618}
1619
Robert Carr6a160312021-05-17 12:08:20 -07001620int32_t Layer::getZ(LayerVector::StateSet) const {
1621 return mDrawingState.z;
Robert Carr1f0a16a2016-10-24 16:27:39 -07001622}
1623
Robert Carr1c5481e2019-07-01 14:42:27 -07001624bool Layer::usingRelativeZ(LayerVector::StateSet stateSet) const {
Robert Carr29abff82017-12-04 13:51:20 -08001625 const bool useDrawing = stateSet == LayerVector::StateSet::Drawing;
Robert Carr6a160312021-05-17 12:08:20 -07001626 const State& state = useDrawing ? mDrawingState : mDrawingState;
chaviwe5ac40f2019-09-24 16:36:55 -07001627 return state.isRelativeOf;
Robert Carr29abff82017-12-04 13:51:20 -08001628}
1629
David Sodman41fdfc92017-11-06 16:09:56 -08001630__attribute__((no_sanitize("unsigned-integer-overflow"))) LayerVector Layer::makeTraversalList(
Robert Carr29abff82017-12-04 13:51:20 -08001631 LayerVector::StateSet stateSet, bool* outSkipRelativeZUsers) {
Dan Stoza412903f2017-04-27 13:42:17 -07001632 LOG_ALWAYS_FATAL_IF(stateSet == LayerVector::StateSet::Invalid,
1633 "makeTraversalList received invalid stateSet");
1634 const bool useDrawing = stateSet == LayerVector::StateSet::Drawing;
1635 const LayerVector& children = useDrawing ? mDrawingChildren : mCurrentChildren;
Robert Carr6a160312021-05-17 12:08:20 -07001636 const State& state = useDrawing ? mDrawingState : mDrawingState;
Dan Stoza412903f2017-04-27 13:42:17 -07001637
Robert Carr29abff82017-12-04 13:51:20 -08001638 if (state.zOrderRelatives.size() == 0) {
1639 *outSkipRelativeZUsers = true;
1640 return children;
1641 }
1642
chaviwfd462612018-05-31 16:11:27 -07001643 LayerVector traverse(stateSet);
Dan Stoza412903f2017-04-27 13:42:17 -07001644 for (const wp<Layer>& weakRelative : state.zOrderRelatives) {
Robert Carrdb66e622017-04-10 16:55:57 -07001645 sp<Layer> strongRelative = weakRelative.promote();
1646 if (strongRelative != nullptr) {
1647 traverse.add(strongRelative);
Robert Carrdb66e622017-04-10 16:55:57 -07001648 }
1649 }
1650
Dan Stoza412903f2017-04-27 13:42:17 -07001651 for (const sp<Layer>& child : children) {
chaviwe5ac40f2019-09-24 16:36:55 -07001652 if (child->usingRelativeZ(stateSet)) {
Robert Carr503c7042017-09-27 15:06:08 -07001653 continue;
1654 }
Robert Carrdb66e622017-04-10 16:55:57 -07001655 traverse.add(child);
1656 }
1657
1658 return traverse;
1659}
1660
Robert Carr1f0a16a2016-10-24 16:27:39 -07001661/**
Robert Carrdb66e622017-04-10 16:55:57 -07001662 * Negatively signed relatives are before 'this' in Z-order.
Robert Carr1f0a16a2016-10-24 16:27:39 -07001663 */
Dan Stoza412903f2017-04-27 13:42:17 -07001664void Layer::traverseInZOrder(LayerVector::StateSet stateSet, const LayerVector::Visitor& visitor) {
Robert Carr29abff82017-12-04 13:51:20 -08001665 // In the case we have other layers who are using a relative Z to us, makeTraversalList will
1666 // produce a new list for traversing, including our relatives, and not including our children
1667 // who are relatives of another surface. In the case that there are no relative Z,
1668 // makeTraversalList returns our children directly to avoid significant overhead.
1669 // However in this case we need to take the responsibility for filtering children which
1670 // are relatives of another surface here.
1671 bool skipRelativeZUsers = false;
1672 const LayerVector list = makeTraversalList(stateSet, &skipRelativeZUsers);
Robert Carrdb66e622017-04-10 16:55:57 -07001673
Robert Carr1f0a16a2016-10-24 16:27:39 -07001674 size_t i = 0;
Robert Carrdb66e622017-04-10 16:55:57 -07001675 for (; i < list.size(); i++) {
1676 const auto& relative = list[i];
Robert Carr29abff82017-12-04 13:51:20 -08001677 if (skipRelativeZUsers && relative->usingRelativeZ(stateSet)) {
1678 continue;
1679 }
1680
chaviw301b1d82019-11-06 13:15:09 -08001681 if (relative->getZ(stateSet) >= 0) {
Robert Carr1f0a16a2016-10-24 16:27:39 -07001682 break;
Robert Carrdb66e622017-04-10 16:55:57 -07001683 }
Dan Stoza412903f2017-04-27 13:42:17 -07001684 relative->traverseInZOrder(stateSet, visitor);
Robert Carr1f0a16a2016-10-24 16:27:39 -07001685 }
Robert Carr29abff82017-12-04 13:51:20 -08001686
Dan Stoza412903f2017-04-27 13:42:17 -07001687 visitor(this);
Robert Carrdb66e622017-04-10 16:55:57 -07001688 for (; i < list.size(); i++) {
1689 const auto& relative = list[i];
Lloyd Pique0449b0f2018-12-20 16:23:45 -08001690
Robert Carr29abff82017-12-04 13:51:20 -08001691 if (skipRelativeZUsers && relative->usingRelativeZ(stateSet)) {
1692 continue;
1693 }
Dan Stoza412903f2017-04-27 13:42:17 -07001694 relative->traverseInZOrder(stateSet, visitor);
Robert Carr1f0a16a2016-10-24 16:27:39 -07001695 }
1696}
1697
1698/**
Robert Carrdb66e622017-04-10 16:55:57 -07001699 * Positively signed relatives are before 'this' in reverse Z-order.
Robert Carr1f0a16a2016-10-24 16:27:39 -07001700 */
Dan Stoza412903f2017-04-27 13:42:17 -07001701void Layer::traverseInReverseZOrder(LayerVector::StateSet stateSet,
1702 const LayerVector::Visitor& visitor) {
Robert Carr29abff82017-12-04 13:51:20 -08001703 // See traverseInZOrder for documentation.
1704 bool skipRelativeZUsers = false;
1705 LayerVector list = makeTraversalList(stateSet, &skipRelativeZUsers);
Robert Carrdb66e622017-04-10 16:55:57 -07001706
Robert Carr1f0a16a2016-10-24 16:27:39 -07001707 int32_t i = 0;
Joel Galensonbf324992017-11-06 11:04:12 -08001708 for (i = int32_t(list.size()) - 1; i >= 0; i--) {
Robert Carrdb66e622017-04-10 16:55:57 -07001709 const auto& relative = list[i];
Robert Carr29abff82017-12-04 13:51:20 -08001710
1711 if (skipRelativeZUsers && relative->usingRelativeZ(stateSet)) {
1712 continue;
1713 }
1714
chaviw301b1d82019-11-06 13:15:09 -08001715 if (relative->getZ(stateSet) < 0) {
Robert Carr1f0a16a2016-10-24 16:27:39 -07001716 break;
1717 }
Dan Stoza412903f2017-04-27 13:42:17 -07001718 relative->traverseInReverseZOrder(stateSet, visitor);
Robert Carr1f0a16a2016-10-24 16:27:39 -07001719 }
Dan Stoza412903f2017-04-27 13:42:17 -07001720 visitor(this);
David Sodman41fdfc92017-11-06 16:09:56 -08001721 for (; i >= 0; i--) {
Robert Carrdb66e622017-04-10 16:55:57 -07001722 const auto& relative = list[i];
Robert Carr29abff82017-12-04 13:51:20 -08001723
1724 if (skipRelativeZUsers && relative->usingRelativeZ(stateSet)) {
1725 continue;
1726 }
1727
Dan Stoza412903f2017-04-27 13:42:17 -07001728 relative->traverseInReverseZOrder(stateSet, visitor);
Robert Carr1f0a16a2016-10-24 16:27:39 -07001729 }
1730}
1731
Edgar Arriaga844fa672020-01-16 14:21:42 -08001732void Layer::traverse(LayerVector::StateSet state, const LayerVector::Visitor& visitor) {
1733 visitor(this);
1734 const LayerVector& children =
Robert Carr6a160312021-05-17 12:08:20 -07001735 state == LayerVector::StateSet::Drawing ? mDrawingChildren : mCurrentChildren;
Edgar Arriaga844fa672020-01-16 14:21:42 -08001736 for (const sp<Layer>& child : children) {
1737 child->traverse(state, visitor);
1738 }
1739}
1740
chaviw4b129c22018-04-09 16:19:43 -07001741LayerVector Layer::makeChildrenTraversalList(LayerVector::StateSet stateSet,
1742 const std::vector<Layer*>& layersInTree) {
1743 LOG_ALWAYS_FATAL_IF(stateSet == LayerVector::StateSet::Invalid,
1744 "makeTraversalList received invalid stateSet");
chaviwa76b2712017-09-20 12:02:26 -07001745 const bool useDrawing = stateSet == LayerVector::StateSet::Drawing;
1746 const LayerVector& children = useDrawing ? mDrawingChildren : mCurrentChildren;
Robert Carr6a160312021-05-17 12:08:20 -07001747 const State& state = useDrawing ? mDrawingState : mDrawingState;
chaviw4b129c22018-04-09 16:19:43 -07001748
chaviwfd462612018-05-31 16:11:27 -07001749 LayerVector traverse(stateSet);
chaviw4b129c22018-04-09 16:19:43 -07001750 for (const wp<Layer>& weakRelative : state.zOrderRelatives) {
1751 sp<Layer> strongRelative = weakRelative.promote();
1752 // Only add relative layers that are also descendents of the top most parent of the tree.
1753 // If a relative layer is not a descendent, then it should be ignored.
1754 if (std::binary_search(layersInTree.begin(), layersInTree.end(), strongRelative.get())) {
1755 traverse.add(strongRelative);
1756 }
1757 }
1758
1759 for (const sp<Layer>& child : children) {
Robert Carr6a160312021-05-17 12:08:20 -07001760 const State& childState = useDrawing ? child->mDrawingState : child->mDrawingState;
chaviw4b129c22018-04-09 16:19:43 -07001761 // If a layer has a relativeOf layer, only ignore if the layer it's relative to is a
1762 // descendent of the top most parent of the tree. If it's not a descendent, then just add
1763 // the child here since it won't be added later as a relative.
1764 if (std::binary_search(layersInTree.begin(), layersInTree.end(),
1765 childState.zOrderRelativeOf.promote().get())) {
1766 continue;
1767 }
1768 traverse.add(child);
1769 }
1770
1771 return traverse;
1772}
1773
1774void Layer::traverseChildrenInZOrderInner(const std::vector<Layer*>& layersInTree,
1775 LayerVector::StateSet stateSet,
1776 const LayerVector::Visitor& visitor) {
1777 const LayerVector list = makeChildrenTraversalList(stateSet, layersInTree);
chaviwa76b2712017-09-20 12:02:26 -07001778
1779 size_t i = 0;
chaviw4b129c22018-04-09 16:19:43 -07001780 for (; i < list.size(); i++) {
1781 const auto& relative = list[i];
chaviw301b1d82019-11-06 13:15:09 -08001782 if (relative->getZ(stateSet) >= 0) {
chaviwa76b2712017-09-20 12:02:26 -07001783 break;
1784 }
chaviw4b129c22018-04-09 16:19:43 -07001785 relative->traverseChildrenInZOrderInner(layersInTree, stateSet, visitor);
chaviwa76b2712017-09-20 12:02:26 -07001786 }
chaviw4b129c22018-04-09 16:19:43 -07001787
chaviwa76b2712017-09-20 12:02:26 -07001788 visitor(this);
chaviw4b129c22018-04-09 16:19:43 -07001789 for (; i < list.size(); i++) {
1790 const auto& relative = list[i];
1791 relative->traverseChildrenInZOrderInner(layersInTree, stateSet, visitor);
chaviwa76b2712017-09-20 12:02:26 -07001792 }
1793}
1794
chaviw4b129c22018-04-09 16:19:43 -07001795std::vector<Layer*> Layer::getLayersInTree(LayerVector::StateSet stateSet) {
1796 const bool useDrawing = stateSet == LayerVector::StateSet::Drawing;
1797 const LayerVector& children = useDrawing ? mDrawingChildren : mCurrentChildren;
1798
1799 std::vector<Layer*> layersInTree = {this};
1800 for (size_t i = 0; i < children.size(); i++) {
1801 const auto& child = children[i];
1802 std::vector<Layer*> childLayers = child->getLayersInTree(stateSet);
1803 layersInTree.insert(layersInTree.end(), childLayers.cbegin(), childLayers.cend());
1804 }
1805
1806 return layersInTree;
1807}
1808
1809void Layer::traverseChildrenInZOrder(LayerVector::StateSet stateSet,
1810 const LayerVector::Visitor& visitor) {
1811 std::vector<Layer*> layersInTree = getLayersInTree(stateSet);
1812 std::sort(layersInTree.begin(), layersInTree.end());
1813 traverseChildrenInZOrderInner(layersInTree, stateSet, visitor);
1814}
1815
Peiyong Linefefaac2018-08-17 12:27:51 -07001816ui::Transform Layer::getTransform() const {
Vishnu Nairf0c28512019-02-08 12:40:28 -08001817 return mEffectiveTransform;
Robert Carr1f0a16a2016-10-24 16:27:39 -07001818}
1819
Garfield Tan2c1782c2022-02-16 15:25:05 -08001820bool Layer::isTransformValid() const {
1821 float transformDet = getTransform().det();
1822 return transformDet != 0 && !isinf(transformDet) && !isnan(transformDet);
1823}
1824
chaviw13fdc492017-06-27 12:40:18 -07001825half Layer::getAlpha() const {
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001826 const auto& p = mDrawingParent.promote();
Lloyd Pique0449b0f2018-12-20 16:23:45 -08001827
chaviw13fdc492017-06-27 12:40:18 -07001828 half parentAlpha = (p != nullptr) ? p->getAlpha() : 1.0_hf;
1829 return parentAlpha * getDrawingState().color.a;
Robert Carr6452f122017-03-21 10:41:29 -07001830}
Robert Carr6452f122017-03-21 10:41:29 -07001831
Vishnu Nair6213bd92020-05-08 17:42:25 -07001832ui::Transform::RotationFlags Layer::getFixedTransformHint() const {
Robert Carr6a160312021-05-17 12:08:20 -07001833 ui::Transform::RotationFlags fixedTransformHint = mDrawingState.fixedTransformHint;
Vishnu Nair6213bd92020-05-08 17:42:25 -07001834 if (fixedTransformHint != ui::Transform::ROT_INVALID) {
1835 return fixedTransformHint;
1836 }
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001837 const auto& p = mCurrentParent.promote();
Vishnu Nair6213bd92020-05-08 17:42:25 -07001838 if (!p) return fixedTransformHint;
1839 return p->getFixedTransformHint();
1840}
1841
chaviw13fdc492017-06-27 12:40:18 -07001842half4 Layer::getColor() const {
1843 const half4 color(getDrawingState().color);
Lloyd Pique0449b0f2018-12-20 16:23:45 -08001844 return half4(color.r, color.g, color.b, getAlpha());
Robert Carr6452f122017-03-21 10:41:29 -07001845}
Robert Carr6452f122017-03-21 10:41:29 -07001846
Lucas Dupin19c8f0e2019-11-25 17:55:44 -08001847int32_t Layer::getBackgroundBlurRadius() const {
Vishnu Nair29810f72022-07-01 16:38:41 +00001848 if (getDrawingState().backgroundBlurRadius == 0) {
1849 return 0;
1850 }
Galia Peychevada7de0e2020-12-03 17:24:35 +01001851
Vishnu Nair29810f72022-07-01 16:38:41 +00001852 const auto& p = mDrawingParent.promote();
Galia Peychevada7de0e2020-12-03 17:24:35 +01001853 half parentAlpha = (p != nullptr) ? p->getAlpha() : 1.0_hf;
1854 return parentAlpha * getDrawingState().backgroundBlurRadius;
Lucas Dupin19c8f0e2019-11-25 17:55:44 -08001855}
1856
Galia Peychevae0acf382021-04-12 21:22:34 +02001857const std::vector<BlurRegion> Layer::getBlurRegions() const {
1858 auto regionsCopy(getDrawingState().blurRegions);
Galia Peycheva3c286542021-06-17 15:21:28 +02001859 float layerAlpha = getAlpha();
Galia Peychevae0acf382021-04-12 21:22:34 +02001860 for (auto& region : regionsCopy) {
1861 region.alpha = region.alpha * layerAlpha;
1862 }
1863 return regionsCopy;
Lucas Dupinc3800b82020-10-02 16:24:48 -07001864}
1865
Vishnu Naire14c6b32022-08-06 04:20:15 +00001866RoundedCornerState Layer::getRoundedCornerState() const {
Vishnu Nair9dbf8e82021-09-16 16:24:47 -07001867 // Get parent settings
1868 RoundedCornerState parentSettings;
Rob Carrc6d2d2b2021-10-25 16:51:49 +00001869 const auto& parent = mDrawingParent.promote();
1870 if (parent != nullptr) {
1871 parentSettings = parent->getRoundedCornerState();
Vishnu Nair50c0afe2022-07-11 15:04:07 -07001872 if (parentSettings.hasRoundedCorners()) {
Lucas Dupin1b6531c2018-07-05 17:18:21 -07001873 ui::Transform t = getActiveTransform(getDrawingState());
1874 t = t.inverse();
Vishnu Nair9dbf8e82021-09-16 16:24:47 -07001875 parentSettings.cropRect = t.transform(parentSettings.cropRect);
Vishnu Nair50c0afe2022-07-11 15:04:07 -07001876 parentSettings.radius.x *= t.getScaleX();
1877 parentSettings.radius.y *= t.getScaleY();
Lucas Dupin1b6531c2018-07-05 17:18:21 -07001878 }
1879 }
Vishnu Nair9dbf8e82021-09-16 16:24:47 -07001880
1881 // Get layer settings
1882 Rect layerCropRect = getCroppedBufferSize(getDrawingState());
Vishnu Nair50c0afe2022-07-11 15:04:07 -07001883 const vec2 radius(getDrawingState().cornerRadius, getDrawingState().cornerRadius);
Vishnu Nair9dbf8e82021-09-16 16:24:47 -07001884 RoundedCornerState layerSettings(layerCropRect.toFloatRect(), radius);
Vishnu Nair50c0afe2022-07-11 15:04:07 -07001885 const bool layerSettingsValid = layerSettings.hasRoundedCorners() && layerCropRect.isValid();
Vishnu Nair9dbf8e82021-09-16 16:24:47 -07001886
Vishnu Nair50c0afe2022-07-11 15:04:07 -07001887 if (layerSettingsValid && parentSettings.hasRoundedCorners()) {
Vishnu Nair9dbf8e82021-09-16 16:24:47 -07001888 // If the parent and the layer have rounded corner settings, use the parent settings if the
1889 // parent crop is entirely inside the layer crop.
1890 // This has limitations and cause rendering artifacts. See b/200300845 for correct fix.
1891 if (parentSettings.cropRect.left > layerCropRect.left &&
1892 parentSettings.cropRect.top > layerCropRect.top &&
1893 parentSettings.cropRect.right < layerCropRect.right &&
1894 parentSettings.cropRect.bottom < layerCropRect.bottom) {
1895 return parentSettings;
1896 } else {
1897 return layerSettings;
1898 }
Vishnu Nairb1845592021-10-07 12:17:57 -07001899 } else if (layerSettingsValid) {
Vishnu Nair9dbf8e82021-09-16 16:24:47 -07001900 return layerSettings;
Vishnu Nair50c0afe2022-07-11 15:04:07 -07001901 } else if (parentSettings.hasRoundedCorners()) {
Vishnu Nair9dbf8e82021-09-16 16:24:47 -07001902 return parentSettings;
1903 }
1904 return {};
Lucas Dupin1b6531c2018-07-05 17:18:21 -07001905}
1906
Robert Carr88b85e12022-03-21 15:47:35 -07001907bool Layer::findInHierarchy(const sp<Layer>& l) {
1908 if (l == this) {
1909 return true;
1910 }
1911 for (auto& child : mDrawingChildren) {
1912 if (child->findInHierarchy(l)) {
1913 return true;
1914 }
1915 }
1916 return false;
1917}
1918
Robert Carr1f0a16a2016-10-24 16:27:39 -07001919void Layer::commitChildList() {
1920 for (size_t i = 0; i < mCurrentChildren.size(); i++) {
1921 const auto& child = mCurrentChildren[i];
1922 child->commitChildList();
1923 }
1924 mDrawingChildren = mCurrentChildren;
Chia-I Wue41dbe62017-06-13 14:10:56 -07001925 mDrawingParent = mCurrentParent;
Robert Carr88b85e12022-03-21 15:47:35 -07001926 if (CC_UNLIKELY(usingRelativeZ(LayerVector::StateSet::Drawing))) {
1927 auto zOrderRelativeOf = mDrawingState.zOrderRelativeOf.promote();
1928 if (zOrderRelativeOf == nullptr) return;
1929 if (findInHierarchy(zOrderRelativeOf)) {
1930 ALOGE("Detected Z ordering loop between %s and %s", mName.c_str(),
1931 zOrderRelativeOf->mName.c_str());
1932 ALOGE("Severing rel Z loop, potentially dangerous");
1933 mDrawingState.isRelativeOf = false;
Ady Abrahamd11bade2022-08-01 16:18:03 -07001934 zOrderRelativeOf->removeZOrderRelative(wp<Layer>::fromExisting(this));
Robert Carr88b85e12022-03-21 15:47:35 -07001935 }
1936 }
Robert Carr1f0a16a2016-10-24 16:27:39 -07001937}
1938
Vishnu Nair6fabeec2019-03-12 13:42:49 -07001939
chaviw3277faf2021-05-19 16:45:23 -05001940void Layer::setInputInfo(const WindowInfo& info) {
Robert Carr6a160312021-05-17 12:08:20 -07001941 mDrawingState.inputInfo = info;
Vishnu Nair07e2a482022-10-18 19:18:16 +00001942 mDrawingState.touchableRegionCrop =
1943 LayerHandle::getLayer(info.touchableRegionCropHandle.promote());
Robert Carr6a160312021-05-17 12:08:20 -07001944 mDrawingState.modified = true;
Arthur Hung9ed43392022-05-27 06:31:57 +00001945 mFlinger->mUpdateInputInfo = true;
Robert Carr720e5062018-07-30 17:45:14 -07001946 setTransactionFlags(eTransactionNeeded);
1947}
1948
Vishnu Naird8f5e9f2022-02-03 10:23:28 -08001949LayerProto* Layer::writeToProto(LayersProto& layersProto, uint32_t traceFlags) {
chaviw08f3cb22020-01-13 13:17:21 -08001950 LayerProto* layerProto = layersProto.add_layers();
Vishnu Naird8f5e9f2022-02-03 10:23:28 -08001951 writeToProtoDrawingState(layerProto);
chaviw08f3cb22020-01-13 13:17:21 -08001952 writeToProtoCommonState(layerProto, LayerVector::StateSet::Drawing, traceFlags);
1953
Vishnu Nair00b90132021-11-05 14:03:40 -07001954 if (traceFlags & LayerTracing::TRACE_COMPOSITION) {
Dominik Laskowski298b08e2022-02-15 13:45:02 -08001955 ftl::FakeGuard guard(mFlinger->mStateLock); // Called from the main thread.
1956
Vishnu Nair60db8c02020-04-02 11:55:16 -07001957 // Only populate for the primary display.
Dominik Laskowski298b08e2022-02-15 13:45:02 -08001958 if (const auto display = mFlinger->getDefaultDisplayDeviceLocked()) {
Leon Scroggins III2e1aa182021-12-01 17:33:12 -05001959 const auto compositionType = getCompositionType(*display);
Vishnu Nair60db8c02020-04-02 11:55:16 -07001960 layerProto->set_hwc_composition_type(static_cast<HwcCompositionType>(compositionType));
Vishnu Naird8f5e9f2022-02-03 10:23:28 -08001961 LayerProtoHelper::writeToProto(getVisibleRegion(display.get()),
1962 [&]() { return layerProto->mutable_visible_region(); });
Vishnu Nair60db8c02020-04-02 11:55:16 -07001963 }
Alec Mouri6b9e9912020-01-21 10:50:24 -08001964 }
1965
chaviw08f3cb22020-01-13 13:17:21 -08001966 for (const sp<Layer>& layer : mDrawingChildren) {
Vishnu Naird8f5e9f2022-02-03 10:23:28 -08001967 layer->writeToProto(layersProto, traceFlags);
chaviw08f3cb22020-01-13 13:17:21 -08001968 }
chaviw6d89e2d2020-01-14 14:42:01 -08001969
1970 return layerProto;
chaviw08f3cb22020-01-13 13:17:21 -08001971}
1972
Vishnu Naird8f5e9f2022-02-03 10:23:28 -08001973void Layer::writeToProtoDrawingState(LayerProto* layerInfo) {
Vishnu Nair6b7c5c92020-09-29 17:27:05 -07001974 const ui::Transform transform = getTransform();
Vishnu Naird37343b2022-01-12 16:18:56 -08001975 auto buffer = getExternalTexture();
Vishnu Nair00b90132021-11-05 14:03:40 -07001976 if (buffer != nullptr) {
Vishnu Naird37343b2022-01-12 16:18:56 -08001977 LayerProtoHelper::writeToProto(*buffer,
Vishnu Nair00b90132021-11-05 14:03:40 -07001978 [&]() { return layerInfo->mutable_active_buffer(); });
1979 LayerProtoHelper::writeToProtoDeprecated(ui::Transform(getBufferTransform()),
1980 layerInfo->mutable_buffer_transform());
1981 }
1982 layerInfo->set_invalidate(contentDirty);
1983 layerInfo->set_is_protected(isProtected());
1984 layerInfo->set_dataspace(dataspaceDetails(static_cast<android_dataspace>(getDataSpace())));
1985 layerInfo->set_queued_frames(getQueuedFrameCount());
Vishnu Nair00b90132021-11-05 14:03:40 -07001986 layerInfo->set_curr_frame(mCurrentFrameNumber);
Vishnu Nair00b90132021-11-05 14:03:40 -07001987 layerInfo->set_requested_corner_radius(getDrawingState().cornerRadius);
Vishnu Nair50c0afe2022-07-11 15:04:07 -07001988 layerInfo->set_corner_radius(
1989 (getRoundedCornerState().radius.x + getRoundedCornerState().radius.y) / 2.0);
Vishnu Nair00b90132021-11-05 14:03:40 -07001990 layerInfo->set_background_blur_radius(getBackgroundBlurRadius());
1991 layerInfo->set_is_trusted_overlay(isTrustedOverlay());
1992 LayerProtoHelper::writeToProtoDeprecated(transform, layerInfo->mutable_transform());
1993 LayerProtoHelper::writePositionToProto(transform.tx(), transform.ty(),
1994 [&]() { return layerInfo->mutable_position(); });
1995 LayerProtoHelper::writeToProto(mBounds, [&]() { return layerInfo->mutable_bounds(); });
Vishnu Nair00b90132021-11-05 14:03:40 -07001996 LayerProtoHelper::writeToProto(surfaceDamageRegion,
1997 [&]() { return layerInfo->mutable_damage_region(); });
Vishnu Nair8406fd72019-07-30 11:29:31 -07001998
Vishnu Nair00b90132021-11-05 14:03:40 -07001999 if (hasColorTransform()) {
2000 LayerProtoHelper::writeToProto(getColorTransform(), layerInfo->mutable_color_transform());
Vishnu Nair8406fd72019-07-30 11:29:31 -07002001 }
2002
Vishnu Nair60db8c02020-04-02 11:55:16 -07002003 LayerProtoHelper::writeToProto(mSourceBounds,
2004 [&]() { return layerInfo->mutable_source_bounds(); });
2005 LayerProtoHelper::writeToProto(mScreenBounds,
2006 [&]() { return layerInfo->mutable_screen_bounds(); });
2007 LayerProtoHelper::writeToProto(getRoundedCornerState().cropRect,
2008 [&]() { return layerInfo->mutable_corner_radius_crop(); });
2009 layerInfo->set_shadow_radius(mEffectiveShadowRadius);
Vishnu Nair8406fd72019-07-30 11:29:31 -07002010}
2011
2012void Layer::writeToProtoCommonState(LayerProto* layerInfo, LayerVector::StateSet stateSet,
chaviw4c34a092020-07-08 11:30:06 -07002013 uint32_t traceFlags) {
chaviw1d044282017-09-27 12:19:28 -07002014 const bool useDrawing = stateSet == LayerVector::StateSet::Drawing;
2015 const LayerVector& children = useDrawing ? mDrawingChildren : mCurrentChildren;
Robert Carr6a160312021-05-17 12:08:20 -07002016 const State& state = useDrawing ? mDrawingState : mDrawingState;
chaviw1d044282017-09-27 12:19:28 -07002017
chaviw766c9c52021-02-10 17:36:47 -08002018 ui::Transform requestedTransform = state.transform;
chaviw1d044282017-09-27 12:19:28 -07002019
Vishnu Nair00b90132021-11-05 14:03:40 -07002020 layerInfo->set_id(sequence);
2021 layerInfo->set_name(getName().c_str());
2022 layerInfo->set_type(getType());
chaviw1d044282017-09-27 12:19:28 -07002023
Vishnu Nair00b90132021-11-05 14:03:40 -07002024 for (const auto& child : children) {
2025 layerInfo->add_children(child->sequence);
chaviwadc40c22018-07-10 16:57:27 -07002026 }
Evan Rosky1f6d6d52018-12-06 10:47:26 -08002027
Vishnu Nair00b90132021-11-05 14:03:40 -07002028 for (const wp<Layer>& weakRelative : state.zOrderRelatives) {
2029 sp<Layer> strongRelative = weakRelative.promote();
2030 if (strongRelative != nullptr) {
2031 layerInfo->add_relatives(strongRelative->sequence);
2032 }
2033 }
2034
Vishnu Nairea04b6f2022-08-19 21:28:17 +00002035 LayerProtoHelper::writeToProto(state.transparentRegionHint,
Vishnu Nair00b90132021-11-05 14:03:40 -07002036 [&]() { return layerInfo->mutable_transparent_region(); });
2037
2038 layerInfo->set_layer_stack(getLayerStack().id);
2039 layerInfo->set_z(state.z);
2040
2041 LayerProtoHelper::writePositionToProto(requestedTransform.tx(), requestedTransform.ty(), [&]() {
2042 return layerInfo->mutable_requested_position();
2043 });
2044
Vishnu Nair00b90132021-11-05 14:03:40 -07002045 LayerProtoHelper::writeToProto(state.crop, [&]() { return layerInfo->mutable_crop(); });
2046
2047 layerInfo->set_is_opaque(isOpaque(state));
2048
2049 layerInfo->set_pixel_format(decodePixelFormat(getPixelFormat()));
2050 LayerProtoHelper::writeToProto(getColor(), [&]() { return layerInfo->mutable_color(); });
2051 LayerProtoHelper::writeToProto(state.color,
2052 [&]() { return layerInfo->mutable_requested_color(); });
2053 layerInfo->set_flags(state.flags);
2054
2055 LayerProtoHelper::writeToProtoDeprecated(requestedTransform,
2056 layerInfo->mutable_requested_transform());
2057
2058 auto parent = useDrawing ? mDrawingParent.promote() : mCurrentParent.promote();
2059 if (parent != nullptr) {
2060 layerInfo->set_parent(parent->sequence);
2061 } else {
2062 layerInfo->set_parent(-1);
2063 }
2064
2065 auto zOrderRelativeOf = state.zOrderRelativeOf.promote();
2066 if (zOrderRelativeOf != nullptr) {
2067 layerInfo->set_z_order_relative_of(zOrderRelativeOf->sequence);
2068 } else {
2069 layerInfo->set_z_order_relative_of(-1);
2070 }
2071
2072 layerInfo->set_is_relative_of(state.isRelativeOf);
2073
2074 layerInfo->set_owner_uid(mOwnerUid);
2075
Arthur Hung4cf2d8c2022-04-07 14:52:00 +00002076 if ((traceFlags & LayerTracing::TRACE_INPUT) && needsInputInfo()) {
chaviw3277faf2021-05-19 16:45:23 -05002077 WindowInfo info;
chaviw4c34a092020-07-08 11:30:06 -07002078 if (useDrawing) {
Prabir Pradhanda0f62c2022-07-22 19:53:04 +00002079 info = fillInputInfo(
2080 InputDisplayArgs{.transform = &kIdentityTransform, .isSecure = true});
chaviw4c34a092020-07-08 11:30:06 -07002081 } else {
2082 info = state.inputInfo;
2083 }
2084
2085 LayerProtoHelper::writeToProto(info, state.touchableRegionCrop,
Vishnu Nair9245d3b2019-03-22 13:38:56 -07002086 [&]() { return layerInfo->mutable_input_window_info(); });
Evan Rosky1f6d6d52018-12-06 10:47:26 -08002087 }
Vishnu Nair9245d3b2019-03-22 13:38:56 -07002088
Vishnu Nair00b90132021-11-05 14:03:40 -07002089 if (traceFlags & LayerTracing::TRACE_EXTRA) {
Vishnu Nair9245d3b2019-03-22 13:38:56 -07002090 auto protoMap = layerInfo->mutable_metadata();
2091 for (const auto& entry : state.metadata.mMap) {
2092 (*protoMap)[entry.first] = std::string(entry.second.cbegin(), entry.second.cend());
2093 }
Vishnu Nair9245d3b2019-03-22 13:38:56 -07002094 }
Vishnu Naird2aaab12022-02-10 14:49:09 -08002095
2096 LayerProtoHelper::writeToProto(state.destinationFrame,
2097 [&]() { return layerInfo->mutable_destination_frame(); });
chaviw1d044282017-09-27 12:19:28 -07002098}
2099
Robert Carr2e102c92018-10-23 12:11:15 -07002100bool Layer::isRemovedFromCurrentState() const {
Robert Carr6a160312021-05-17 12:08:20 -07002101 return mRemovedFromDrawingState;
Robert Carr2e102c92018-10-23 12:11:15 -07002102}
2103
Prabir Pradhan33da9462022-06-14 14:55:57 +00002104// Applies the given transform to the region, while protecting against overflows caused by any
2105// offsets. If applying the offset in the transform to any of the Rects in the region would result
2106// in an overflow, they are not added to the output Region.
2107static Region transformTouchableRegionSafely(const ui::Transform& t, const Region& r,
2108 const std::string& debugWindowName) {
2109 // Round the translation using the same rounding strategy used by ui::Transform.
2110 const auto tx = static_cast<int32_t>(t.tx() + 0.5);
2111 const auto ty = static_cast<int32_t>(t.ty() + 0.5);
2112
2113 ui::Transform transformWithoutOffset = t;
2114 transformWithoutOffset.set(0.f, 0.f);
2115
2116 const Region transformed = transformWithoutOffset.transform(r);
2117
2118 // Apply the translation to each of the Rects in the region while discarding any that overflow.
2119 Region ret;
2120 for (const auto& rect : transformed) {
2121 Rect newRect;
2122 if (__builtin_add_overflow(rect.left, tx, &newRect.left) ||
2123 __builtin_add_overflow(rect.top, ty, &newRect.top) ||
2124 __builtin_add_overflow(rect.right, tx, &newRect.right) ||
2125 __builtin_add_overflow(rect.bottom, ty, &newRect.bottom)) {
2126 ALOGE("Applying transform to touchable region of window '%s' resulted in an overflow.",
2127 debugWindowName.c_str());
2128 continue;
2129 }
2130 ret.orSelf(newRect);
2131 }
2132 return ret;
2133}
2134
Prabir Pradhanc9589c12021-09-22 06:11:43 -07002135void Layer::fillInputFrameInfo(WindowInfo& info, const ui::Transform& screenToDisplay) {
2136 Rect tmpBounds = getInputBounds();
2137 if (!tmpBounds.isValid()) {
Prabir Pradhan6fa425a2021-12-16 07:16:04 -08002138 info.touchableRegion.clear();
2139 // A layer could have invalid input bounds and still expect to receive touch input if it has
2140 // replaceTouchableRegionWithCrop. For that case, the input transform needs to be calculated
2141 // correctly to determine the coordinate space for input events. Use an empty rect so that
2142 // the layer will receive input in its own layer space.
Prabir Pradhanc9589c12021-09-22 06:11:43 -07002143 tmpBounds = Rect::EMPTY_RECT;
chaviw7e72caf2020-12-02 16:50:43 -08002144 }
2145
Prabir Pradhanc9589c12021-09-22 06:11:43 -07002146 // InputDispatcher works in the display device's coordinate space. Here, we calculate the
2147 // frame and transform used for the layer, which determines the bounds and the coordinate space
2148 // within which the layer will receive input.
2149 //
2150 // The coordinate space within which each of the bounds are specified is explicitly documented
2151 // in the variable name. For example "inputBoundsInLayer" is specified in layer space. A
2152 // Transform converts one coordinate space to another, which is apparent in its naming. For
2153 // example, "layerToDisplay" transforms layer space to display space.
2154 //
2155 // Coordinate space definitions:
2156 // - display: The display device's coordinate space. Correlates to pixels on the display.
2157 // - screen: The post-rotation coordinate space for the display, a.k.a. logical display space.
2158 // - layer: The coordinate space of this layer.
2159 // - input: The coordinate space in which this layer will receive input events. This could be
2160 // different than layer space if a surfaceInset is used, which changes the origin
2161 // of the input space.
2162 const FloatRect inputBoundsInLayer = tmpBounds.toFloatRect();
chaviw7e72caf2020-12-02 16:50:43 -08002163
Prabir Pradhanc9589c12021-09-22 06:11:43 -07002164 // Clamp surface inset to the input bounds.
2165 const auto surfaceInset = static_cast<float>(info.surfaceInset);
2166 const float xSurfaceInset =
2167 std::max(0.f, std::min(surfaceInset, inputBoundsInLayer.getWidth() / 2.f));
2168 const float ySurfaceInset =
2169 std::max(0.f, std::min(surfaceInset, inputBoundsInLayer.getHeight() / 2.f));
chaviw1ff3d1e2020-07-01 15:53:47 -07002170
Prabir Pradhanc9589c12021-09-22 06:11:43 -07002171 // Apply the insets to the input bounds.
2172 const FloatRect insetBoundsInLayer(inputBoundsInLayer.left + xSurfaceInset,
2173 inputBoundsInLayer.top + ySurfaceInset,
2174 inputBoundsInLayer.right - xSurfaceInset,
2175 inputBoundsInLayer.bottom - ySurfaceInset);
Ady Abraham282f1d72019-07-24 18:05:56 -07002176
Prabir Pradhanc9589c12021-09-22 06:11:43 -07002177 // Crop the input bounds to ensure it is within the parent's bounds.
2178 const FloatRect croppedInsetBoundsInLayer = mBounds.intersect(insetBoundsInLayer);
Ady Abraham282f1d72019-07-24 18:05:56 -07002179
Prabir Pradhanc9589c12021-09-22 06:11:43 -07002180 const ui::Transform layerToScreen = getInputTransform();
2181 const ui::Transform layerToDisplay = screenToDisplay * layerToScreen;
Vishnu Nair8033a492018-12-05 07:27:23 -08002182
Prabir Pradhanc9589c12021-09-22 06:11:43 -07002183 const Rect roundedFrameInDisplay{layerToDisplay.transform(croppedInsetBoundsInLayer)};
2184 info.frameLeft = roundedFrameInDisplay.left;
2185 info.frameTop = roundedFrameInDisplay.top;
2186 info.frameRight = roundedFrameInDisplay.right;
2187 info.frameBottom = roundedFrameInDisplay.bottom;
chaviw1ff3d1e2020-07-01 15:53:47 -07002188
Prabir Pradhanc9589c12021-09-22 06:11:43 -07002189 ui::Transform inputToLayer;
2190 inputToLayer.set(insetBoundsInLayer.left, insetBoundsInLayer.top);
2191 const ui::Transform inputToDisplay = layerToDisplay * inputToLayer;
chaviw39cfa2e2020-11-04 14:19:02 -08002192
Prabir Pradhanc9589c12021-09-22 06:11:43 -07002193 // InputDispatcher expects a display-to-input transform.
2194 info.transform = inputToDisplay.inverse();
2195
2196 // The touchable region is specified in the input coordinate space. Change it to display space.
Prabir Pradhan33da9462022-06-14 14:55:57 +00002197 info.touchableRegion =
2198 transformTouchableRegionSafely(inputToDisplay, info.touchableRegion, mName);
chaviw7e72caf2020-12-02 16:50:43 -08002199}
2200
chaviw3277faf2021-05-19 16:45:23 -05002201void Layer::fillTouchOcclusionMode(WindowInfo& info) {
Ady Abrahamd11bade2022-08-01 16:18:03 -07002202 sp<Layer> p = sp<Layer>::fromExisting(this);
Bernardo Rufinoa9d0a532021-06-11 15:59:12 +01002203 while (p != nullptr && !p->hasInputInfo()) {
Rob Carrc6d2d2b2021-10-25 16:51:49 +00002204 p = p->mDrawingParent.promote();
Bernardo Rufinoa9d0a532021-06-11 15:59:12 +01002205 }
2206 if (p != nullptr) {
2207 info.touchOcclusionMode = p->mDrawingState.inputInfo.touchOcclusionMode;
2208 }
2209}
2210
Vishnu Naira066d902021-09-13 18:40:17 -07002211gui::DropInputMode Layer::getDropInputMode() const {
2212 gui::DropInputMode mode = mDrawingState.dropInputMode;
2213 if (mode == gui::DropInputMode::ALL) {
2214 return mode;
2215 }
Rob Carrc6d2d2b2021-10-25 16:51:49 +00002216 sp<Layer> parent = mDrawingParent.promote();
2217 if (parent) {
2218 gui::DropInputMode parentMode = parent->getDropInputMode();
Vishnu Naira066d902021-09-13 18:40:17 -07002219 if (parentMode != gui::DropInputMode::NONE) {
2220 return parentMode;
2221 }
2222 }
2223 return mode;
2224}
2225
2226void Layer::handleDropInputMode(gui::WindowInfo& info) const {
Prabir Pradhan51e7db02022-02-07 06:02:57 -08002227 if (mDrawingState.inputInfo.inputConfig.test(WindowInfo::InputConfig::NO_INPUT_CHANNEL)) {
Vishnu Naira066d902021-09-13 18:40:17 -07002228 return;
2229 }
2230
2231 // Check if we need to drop input unconditionally
2232 gui::DropInputMode dropInputMode = getDropInputMode();
2233 if (dropInputMode == gui::DropInputMode::ALL) {
Prabir Pradhan51e7db02022-02-07 06:02:57 -08002234 info.inputConfig |= WindowInfo::InputConfig::DROP_INPUT;
Vishnu Naira066d902021-09-13 18:40:17 -07002235 ALOGV("Dropping input for %s as requested by policy.", getDebugName());
2236 return;
2237 }
2238
2239 // Check if we need to check if the window is obscured by parent
2240 if (dropInputMode != gui::DropInputMode::OBSCURED) {
2241 return;
2242 }
2243
2244 // Check if the parent has set an alpha on the layer
Rob Carrc6d2d2b2021-10-25 16:51:49 +00002245 sp<Layer> parent = mDrawingParent.promote();
2246 if (parent && parent->getAlpha() != 1.0_hf) {
Prabir Pradhan51e7db02022-02-07 06:02:57 -08002247 info.inputConfig |= WindowInfo::InputConfig::DROP_INPUT;
Vishnu Naira066d902021-09-13 18:40:17 -07002248 ALOGV("Dropping input for %s as requested by policy because alpha=%f", getDebugName(),
2249 static_cast<float>(getAlpha()));
2250 }
2251
2252 // Check if the parent has cropped the buffer
2253 Rect bufferSize = getCroppedBufferSize(getDrawingState());
2254 if (!bufferSize.isValid()) {
Prabir Pradhan51e7db02022-02-07 06:02:57 -08002255 info.inputConfig |= WindowInfo::InputConfig::DROP_INPUT_IF_OBSCURED;
Vishnu Naira066d902021-09-13 18:40:17 -07002256 return;
2257 }
2258
2259 // Screenbounds are the layer bounds cropped by parents, transformed to screenspace.
2260 // To check if the layer has been cropped, we take the buffer bounds, apply the local
2261 // layer crop and apply the same set of transforms to move to screenspace. If the bounds
2262 // match then the layer has not been cropped by its parents.
2263 Rect bufferInScreenSpace(getTransform().transform(bufferSize));
2264 bool croppedByParent = bufferInScreenSpace != Rect{mScreenBounds};
2265
2266 if (croppedByParent) {
Prabir Pradhan51e7db02022-02-07 06:02:57 -08002267 info.inputConfig |= WindowInfo::InputConfig::DROP_INPUT;
Vishnu Naira066d902021-09-13 18:40:17 -07002268 ALOGV("Dropping input for %s as requested by policy because buffer is cropped by parent",
2269 getDebugName());
2270 } else {
2271 // If the layer is not obscured by its parents (by setting an alpha or crop), then only drop
2272 // input if the window is obscured. This check should be done in surfaceflinger but the
2273 // logic currently resides in inputflinger. So pass the if_obscured check to input to only
2274 // drop input events if the window is obscured.
Prabir Pradhan51e7db02022-02-07 06:02:57 -08002275 info.inputConfig |= WindowInfo::InputConfig::DROP_INPUT_IF_OBSCURED;
Vishnu Naira066d902021-09-13 18:40:17 -07002276 }
2277}
2278
Prabir Pradhanda0f62c2022-07-22 19:53:04 +00002279WindowInfo Layer::fillInputInfo(const InputDisplayArgs& displayArgs) {
chaviw7e72caf2020-12-02 16:50:43 -08002280 if (!hasInputInfo()) {
2281 mDrawingState.inputInfo.name = getName();
2282 mDrawingState.inputInfo.ownerUid = mOwnerUid;
2283 mDrawingState.inputInfo.ownerPid = mOwnerPid;
Prabir Pradhan51e7db02022-02-07 06:02:57 -08002284 mDrawingState.inputInfo.inputConfig |= WindowInfo::InputConfig::NO_INPUT_CHANNEL;
Dominik Laskowski29fa1462021-04-27 15:51:50 -07002285 mDrawingState.inputInfo.displayId = getLayerStack().id;
chaviw7e72caf2020-12-02 16:50:43 -08002286 }
2287
Prabir Pradhanda0f62c2022-07-22 19:53:04 +00002288 const ui::Transform& displayTransform =
2289 displayArgs.transform != nullptr ? *displayArgs.transform : kIdentityTransform;
2290
chaviw3277faf2021-05-19 16:45:23 -05002291 WindowInfo info = mDrawingState.inputInfo;
chaviw7e72caf2020-12-02 16:50:43 -08002292 info.id = sequence;
Dominik Laskowski29fa1462021-04-27 15:51:50 -07002293 info.displayId = getLayerStack().id;
chaviw7e72caf2020-12-02 16:50:43 -08002294
Dominik Laskowski29fa1462021-04-27 15:51:50 -07002295 fillInputFrameInfo(info, displayTransform);
chaviw7e72caf2020-12-02 16:50:43 -08002296
Prabir Pradhanda0f62c2022-07-22 19:53:04 +00002297 if (displayArgs.transform == nullptr) {
2298 // Do not let the window receive touches if it is not associated with a valid display
2299 // transform. We still allow the window to receive keys and prevent ANRs.
2300 info.inputConfig |= WindowInfo::InputConfig::NOT_TOUCHABLE;
2301 }
2302
Robert Carr5dc426e2020-06-10 14:29:14 -07002303 // For compatibility reasons we let layers which can receive input
2304 // receive input before they have actually submitted a buffer. Because
2305 // of this we use canReceiveInput instead of isVisible to check the
2306 // policy-visibility, ignoring the buffer state. However for layers with
2307 // hasInputInfo()==false we can use the real visibility state.
2308 // We are just using these layers for occlusion detection in
2309 // InputDispatcher, and obviously if they aren't visible they can't occlude
2310 // anything.
Prabir Pradhan4d5c52f2022-01-31 08:52:10 -08002311 const bool visible = hasInputInfo() ? canReceiveInput() : isVisible();
2312 info.setInputConfig(WindowInfo::InputConfig::NOT_VISIBLE, !visible);
2313
Bernardo Rufinoea97d182020-08-19 14:43:14 +01002314 info.alpha = getAlpha();
Bernardo Rufinoa9d0a532021-06-11 15:59:12 +01002315 fillTouchOcclusionMode(info);
Vishnu Naira066d902021-09-13 18:40:17 -07002316 handleDropInputMode(info);
Vishnu Nair6fabeec2019-03-12 13:42:49 -07002317
Vishnu Nair16a938f2021-09-24 07:14:54 -07002318 // If the window will be blacked out on a display because the display does not have the secure
2319 // flag and the layer has the secure flag set, then drop input.
Prabir Pradhanda0f62c2022-07-22 19:53:04 +00002320 if (!displayArgs.isSecure && isSecure()) {
Prabir Pradhan51e7db02022-02-07 06:02:57 -08002321 info.inputConfig |= WindowInfo::InputConfig::DROP_INPUT;
Vishnu Nair16a938f2021-09-24 07:14:54 -07002322 }
2323
Vishnu Nair6fabeec2019-03-12 13:42:49 -07002324 auto cropLayer = mDrawingState.touchableRegionCrop.promote();
2325 if (info.replaceTouchableRegionWithCrop) {
Dominik Laskowski29fa1462021-04-27 15:51:50 -07002326 const Rect bounds(cropLayer ? cropLayer->mScreenBounds : mScreenBounds);
2327 info.touchableRegion = Region(displayTransform.transform(bounds));
Vishnu Nair6fabeec2019-03-12 13:42:49 -07002328 } else if (cropLayer != nullptr) {
[1;3C2b9fc252021-02-04 16:16:50 -08002329 info.touchableRegion = info.touchableRegion.intersect(
Dominik Laskowski29fa1462021-04-27 15:51:50 -07002330 displayTransform.transform(Rect{cropLayer->mScreenBounds}));
Vishnu Nair6fabeec2019-03-12 13:42:49 -07002331 }
2332
Winson Chunga30f7c92021-06-29 15:42:56 -07002333 // Inherit the trusted state from the parent hierarchy, but don't clobber the trusted state
2334 // if it was set by WM for a known system overlay
Prabir Pradhan4d5c52f2022-01-31 08:52:10 -08002335 if (isTrustedOverlay()) {
2336 info.inputConfig |= WindowInfo::InputConfig::TRUSTED_OVERLAY;
2337 }
Winson Chunga30f7c92021-06-29 15:42:56 -07002338
chaviwaf87b3e2019-10-01 16:59:28 -07002339 // If the layer is a clone, we need to crop the input region to cloned root to prevent
2340 // touches from going outside the cloned area.
2341 if (isClone()) {
chaviw8577ea82022-06-01 16:32:26 -05002342 info.inputConfig |= WindowInfo::InputConfig::CLONE;
Dominik Laskowski29fa1462021-04-27 15:51:50 -07002343 if (const sp<Layer> clonedRoot = getClonedRoot()) {
2344 const Rect rect = displayTransform.transform(Rect{clonedRoot->mScreenBounds});
chaviwaf87b3e2019-10-01 16:59:28 -07002345 info.touchableRegion = info.touchableRegion.intersect(rect);
2346 }
2347 }
2348
Robert Carr720e5062018-07-30 17:45:14 -07002349 return info;
2350}
2351
chaviwaf87b3e2019-10-01 16:59:28 -07002352sp<Layer> Layer::getClonedRoot() {
2353 if (mClonedChild != nullptr) {
Ady Abrahamd11bade2022-08-01 16:18:03 -07002354 return sp<Layer>::fromExisting(this);
chaviwaf87b3e2019-10-01 16:59:28 -07002355 }
Rob Carrc6d2d2b2021-10-25 16:51:49 +00002356 if (mDrawingParent == nullptr || mDrawingParent.promote() == nullptr) {
chaviwaf87b3e2019-10-01 16:59:28 -07002357 return nullptr;
2358 }
Rob Carrc6d2d2b2021-10-25 16:51:49 +00002359 return mDrawingParent.promote()->getClonedRoot();
chaviwaf87b3e2019-10-01 16:59:28 -07002360}
2361
Robert Carredd13602020-04-13 17:24:34 -07002362bool Layer::hasInputInfo() const {
Linus Tufvessona1858822022-03-04 09:32:07 +00002363 return mDrawingState.inputInfo.token != nullptr ||
2364 mDrawingState.inputInfo.inputConfig.test(WindowInfo::InputConfig::NO_INPUT_CHANNEL);
Robert Carr720e5062018-07-30 17:45:14 -07002365}
2366
Lloyd Pique37c2c9b2018-12-04 17:25:10 -08002367compositionengine::OutputLayer* Layer::findOutputLayerForDisplay(
Dominik Laskowskib7251f42020-04-20 17:42:59 -07002368 const DisplayDevice* display) const {
2369 if (!display) return nullptr;
Lloyd Piquede196652020-01-22 17:29:58 -08002370 return display->getCompositionDisplay()->getOutputLayerForLayer(getCompositionEngineLayerFE());
Lloyd Pique37c2c9b2018-12-04 17:25:10 -08002371}
2372
Dominik Laskowskib7251f42020-04-20 17:42:59 -07002373Region Layer::getVisibleRegion(const DisplayDevice* display) const {
2374 const auto outputLayer = findOutputLayerForDisplay(display);
2375 return outputLayer ? outputLayer->getState().visibleRegion : Region();
Lloyd Piquea2468662019-03-07 21:31:06 -08002376}
2377
chaviwb4c6e582019-08-16 14:35:07 -07002378void Layer::setInitialValuesForClone(const sp<Layer>& clonedFrom) {
Vishnu Nair3bb11d02021-11-26 09:24:11 -08002379 cloneDrawingState(clonedFrom.get());
chaviwb4c6e582019-08-16 14:35:07 -07002380 mClonedFrom = clonedFrom;
Patrick Williamsbb25f802022-08-30 23:02:34 +00002381 mPremultipliedAlpha = clonedFrom->mPremultipliedAlpha;
2382 mPotentialCursor = clonedFrom->mPotentialCursor;
2383 mProtectedByApp = clonedFrom->mProtectedByApp;
2384 updateCloneBufferInfo();
2385}
2386
2387void Layer::updateCloneBufferInfo() {
2388 if (!isClone() || !isClonedFromAlive()) {
2389 return;
2390 }
2391
2392 sp<Layer> clonedFrom = getClonedFrom();
2393 mBufferInfo = clonedFrom->mBufferInfo;
2394 mSidebandStream = clonedFrom->mSidebandStream;
2395 surfaceDamageRegion = clonedFrom->surfaceDamageRegion;
2396 mCurrentFrameNumber = clonedFrom->mCurrentFrameNumber.load();
2397 mPreviousFrameNumber = clonedFrom->mPreviousFrameNumber;
2398
2399 // After buffer info is updated, the drawingState from the real layer needs to be copied into
2400 // the cloned. This is because some properties of drawingState can change when latchBuffer is
2401 // called. However, copying the drawingState would also overwrite the cloned layer's relatives
2402 // and touchableRegionCrop. Therefore, temporarily store the relatives so they can be set in
2403 // the cloned drawingState again.
2404 wp<Layer> tmpZOrderRelativeOf = mDrawingState.zOrderRelativeOf;
2405 SortedVector<wp<Layer>> tmpZOrderRelatives = mDrawingState.zOrderRelatives;
2406 wp<Layer> tmpTouchableRegionCrop = mDrawingState.touchableRegionCrop;
2407 WindowInfo tmpInputInfo = mDrawingState.inputInfo;
2408
2409 cloneDrawingState(clonedFrom.get());
2410
2411 mDrawingState.touchableRegionCrop = tmpTouchableRegionCrop;
2412 mDrawingState.zOrderRelativeOf = tmpZOrderRelativeOf;
2413 mDrawingState.zOrderRelatives = tmpZOrderRelatives;
2414 mDrawingState.inputInfo = tmpInputInfo;
chaviwb4c6e582019-08-16 14:35:07 -07002415}
chaviw74b03172019-08-19 11:09:03 -07002416
2417void Layer::updateMirrorInfo() {
2418 if (mClonedChild == nullptr || !mClonedChild->isClonedFromAlive()) {
2419 // If mClonedChild is null, there is nothing to mirror. If isClonedFromAlive returns false,
2420 // it means that there is a clone, but the layer it was cloned from has been destroyed. In
2421 // that case, we want to delete the reference to the clone since we want it to get
2422 // destroyed. The root, this layer, will still be around since the client can continue
2423 // to hold a reference, but no cloned layers will be displayed.
2424 mClonedChild = nullptr;
2425 return;
2426 }
2427
2428 std::map<sp<Layer>, sp<Layer>> clonedLayersMap;
2429 // If the real layer exists and is in current state, add the clone as a child of the root.
2430 // There's no need to remove from drawingState when the layer is offscreen since currentState is
2431 // copied to drawingState for the root layer. So the clonedChild is always removed from
2432 // drawingState and then needs to be added back each traversal.
2433 if (!mClonedChild->getClonedFrom()->isRemovedFromCurrentState()) {
2434 addChildToDrawing(mClonedChild);
2435 }
2436
2437 mClonedChild->updateClonedDrawingState(clonedLayersMap);
Ady Abrahamd11bade2022-08-01 16:18:03 -07002438 mClonedChild->updateClonedChildren(sp<Layer>::fromExisting(this), clonedLayersMap);
chaviw74b03172019-08-19 11:09:03 -07002439 mClonedChild->updateClonedRelatives(clonedLayersMap);
2440}
2441
2442void Layer::updateClonedDrawingState(std::map<sp<Layer>, sp<Layer>>& clonedLayersMap) {
2443 // If the layer the clone was cloned from is alive, copy the content of the drawingState
2444 // to the clone. If the real layer is no longer alive, continue traversing the children
2445 // since we may be able to pull out other children that are still alive.
2446 if (isClonedFromAlive()) {
2447 sp<Layer> clonedFrom = getClonedFrom();
Vishnu Nair3bb11d02021-11-26 09:24:11 -08002448 cloneDrawingState(clonedFrom.get());
Ady Abrahamd11bade2022-08-01 16:18:03 -07002449 clonedLayersMap.emplace(clonedFrom, sp<Layer>::fromExisting(this));
chaviw74b03172019-08-19 11:09:03 -07002450 }
2451
2452 // The clone layer may have children in drawingState since they may have been created and
2453 // added from a previous request to updateMirorInfo. This is to ensure we don't recreate clones
2454 // that already exist, since we can just re-use them.
2455 // The drawingChildren will not get overwritten by the currentChildren since the clones are
2456 // not updated in the regular traversal. They are skipped since the root will lose the
2457 // reference to them when it copies its currentChildren to drawing.
2458 for (sp<Layer>& child : mDrawingChildren) {
2459 child->updateClonedDrawingState(clonedLayersMap);
2460 }
2461}
2462
2463void Layer::updateClonedChildren(const sp<Layer>& mirrorRoot,
2464 std::map<sp<Layer>, sp<Layer>>& clonedLayersMap) {
2465 mDrawingChildren.clear();
2466
2467 if (!isClonedFromAlive()) {
2468 return;
2469 }
2470
2471 sp<Layer> clonedFrom = getClonedFrom();
2472 for (sp<Layer>& child : clonedFrom->mDrawingChildren) {
2473 if (child == mirrorRoot) {
2474 // This is to avoid cyclical mirroring.
2475 continue;
2476 }
2477 sp<Layer> clonedChild = clonedLayersMap[child];
2478 if (clonedChild == nullptr) {
2479 clonedChild = child->createClone();
2480 clonedLayersMap[child] = clonedChild;
2481 }
2482 addChildToDrawing(clonedChild);
2483 clonedChild->updateClonedChildren(mirrorRoot, clonedLayersMap);
2484 }
2485}
2486
chaviwaf87b3e2019-10-01 16:59:28 -07002487void Layer::updateClonedInputInfo(const std::map<sp<Layer>, sp<Layer>>& clonedLayersMap) {
2488 auto cropLayer = mDrawingState.touchableRegionCrop.promote();
2489 if (cropLayer != nullptr) {
2490 if (clonedLayersMap.count(cropLayer) == 0) {
2491 // Real layer had a crop layer but it's not in the cloned hierarchy. Just set to
2492 // self as crop layer to avoid going outside bounds.
Ady Abrahamd11bade2022-08-01 16:18:03 -07002493 mDrawingState.touchableRegionCrop = wp<Layer>::fromExisting(this);
chaviwaf87b3e2019-10-01 16:59:28 -07002494 } else {
2495 const sp<Layer>& clonedCropLayer = clonedLayersMap.at(cropLayer);
2496 mDrawingState.touchableRegionCrop = clonedCropLayer;
2497 }
2498 }
2499 // Cloned layers shouldn't handle watch outside since their z order is not determined by
2500 // WM or the client.
Prabir Pradhan4d5c52f2022-01-31 08:52:10 -08002501 mDrawingState.inputInfo.setInputConfig(WindowInfo::InputConfig::WATCH_OUTSIDE_TOUCH, false);
chaviwaf87b3e2019-10-01 16:59:28 -07002502}
2503
2504void Layer::updateClonedRelatives(const std::map<sp<Layer>, sp<Layer>>& clonedLayersMap) {
Ady Abrahamd11bade2022-08-01 16:18:03 -07002505 mDrawingState.zOrderRelativeOf = wp<Layer>();
chaviw74b03172019-08-19 11:09:03 -07002506 mDrawingState.zOrderRelatives.clear();
2507
2508 if (!isClonedFromAlive()) {
2509 return;
2510 }
2511
chaviwaf87b3e2019-10-01 16:59:28 -07002512 const sp<Layer>& clonedFrom = getClonedFrom();
chaviw74b03172019-08-19 11:09:03 -07002513 for (wp<Layer>& relativeWeak : clonedFrom->mDrawingState.zOrderRelatives) {
chaviwaf87b3e2019-10-01 16:59:28 -07002514 const sp<Layer>& relative = relativeWeak.promote();
2515 if (clonedLayersMap.count(relative) > 0) {
2516 auto& clonedRelative = clonedLayersMap.at(relative);
chaviw74b03172019-08-19 11:09:03 -07002517 mDrawingState.zOrderRelatives.add(clonedRelative);
2518 }
2519 }
2520
2521 // Check if the relativeLayer for the real layer is part of the cloned hierarchy.
2522 // It's possible that the layer it's relative to is outside the requested cloned hierarchy.
2523 // In that case, we treat the layer as if the relativeOf has been removed. This way, it will
2524 // still traverse the children, but the layer with the missing relativeOf will not be shown
2525 // on screen.
chaviwaf87b3e2019-10-01 16:59:28 -07002526 const sp<Layer>& relativeOf = clonedFrom->mDrawingState.zOrderRelativeOf.promote();
2527 if (clonedLayersMap.count(relativeOf) > 0) {
2528 const sp<Layer>& clonedRelativeOf = clonedLayersMap.at(relativeOf);
chaviw74b03172019-08-19 11:09:03 -07002529 mDrawingState.zOrderRelativeOf = clonedRelativeOf;
2530 }
2531
chaviwaf87b3e2019-10-01 16:59:28 -07002532 updateClonedInputInfo(clonedLayersMap);
2533
chaviw74b03172019-08-19 11:09:03 -07002534 for (sp<Layer>& child : mDrawingChildren) {
2535 child->updateClonedRelatives(clonedLayersMap);
2536 }
2537}
2538
2539void Layer::addChildToDrawing(const sp<Layer>& layer) {
2540 mDrawingChildren.add(layer);
Ady Abrahamd11bade2022-08-01 16:18:03 -07002541 layer->mDrawingParent = sp<Layer>::fromExisting(this);
chaviw74b03172019-08-19 11:09:03 -07002542}
2543
Steven Thomas62a4cf82020-01-31 12:04:03 -08002544Layer::FrameRateCompatibility Layer::FrameRate::convertCompatibility(int8_t compatibility) {
2545 switch (compatibility) {
2546 case ANATIVEWINDOW_FRAME_RATE_COMPATIBILITY_DEFAULT:
2547 return FrameRateCompatibility::Default;
2548 case ANATIVEWINDOW_FRAME_RATE_COMPATIBILITY_FIXED_SOURCE:
2549 return FrameRateCompatibility::ExactOrMultiple;
Ady Abrahamdd5bfa92021-01-07 17:56:08 -08002550 case ANATIVEWINDOW_FRAME_RATE_EXACT:
2551 return FrameRateCompatibility::Exact;
Andy Labrada096227e2022-06-15 16:58:11 +00002552 case ANATIVEWINDOW_FRAME_RATE_MIN:
2553 return FrameRateCompatibility::Min;
Dominik Laskowski1f6fc702022-03-21 08:34:50 -07002554 case ANATIVEWINDOW_FRAME_RATE_NO_VOTE:
2555 return FrameRateCompatibility::NoVote;
Steven Thomas62a4cf82020-01-31 12:04:03 -08002556 default:
2557 LOG_ALWAYS_FATAL("Invalid frame rate compatibility value %d", compatibility);
2558 return FrameRateCompatibility::Default;
2559 }
2560}
2561
Marin Shalamanovc5986772021-03-16 16:09:49 +01002562scheduler::Seamlessness Layer::FrameRate::convertChangeFrameRateStrategy(int8_t strategy) {
2563 switch (strategy) {
2564 case ANATIVEWINDOW_CHANGE_FRAME_RATE_ONLY_IF_SEAMLESS:
2565 return Seamlessness::OnlySeamless;
2566 case ANATIVEWINDOW_CHANGE_FRAME_RATE_ALWAYS:
2567 return Seamlessness::SeamedAndSeamless;
2568 default:
2569 LOG_ALWAYS_FATAL("Invalid change frame sate strategy value %d", strategy);
2570 return Seamlessness::Default;
2571 }
2572}
2573
Dominik Laskowski29fa1462021-04-27 15:51:50 -07002574bool Layer::isInternalDisplayOverlay() const {
chaviwc5676c62020-09-18 15:01:04 -07002575 const State& s(mDrawingState);
2576 if (s.flags & layer_state_t::eLayerSkipScreenshot) {
2577 return true;
2578 }
2579
Rob Carrc6d2d2b2021-10-25 16:51:49 +00002580 sp<Layer> parent = mDrawingParent.promote();
2581 return parent && parent->isInternalDisplayOverlay();
chaviwc5676c62020-09-18 15:01:04 -07002582}
2583
Robert Carr6a0382d2021-07-01 15:57:17 -07002584void Layer::setClonedChild(const sp<Layer>& clonedChild) {
2585 mClonedChild = clonedChild;
2586 mHadClonedChild = true;
2587 mFlinger->mNumClones++;
2588}
2589
Vishnu Nair9cf4a4d2021-09-17 12:16:08 -07002590bool Layer::setDropInputMode(gui::DropInputMode mode) {
2591 if (mDrawingState.dropInputMode == mode) {
2592 return false;
2593 }
2594 mDrawingState.dropInputMode = mode;
2595 return true;
2596}
2597
Vishnu Nair3bb11d02021-11-26 09:24:11 -08002598void Layer::cloneDrawingState(const Layer* from) {
2599 mDrawingState = from->mDrawingState;
2600 // Skip callback info since they are not applicable for cloned layers.
2601 mDrawingState.releaseBufferListener = nullptr;
2602 mDrawingState.callbackHandles = {};
2603}
2604
Patrick Williamsbb25f802022-08-30 23:02:34 +00002605void Layer::callReleaseBufferCallback(const sp<ITransactionCompletedListener>& listener,
2606 const sp<GraphicBuffer>& buffer, uint64_t framenumber,
2607 const sp<Fence>& releaseFence,
2608 uint32_t currentMaxAcquiredBufferCount) {
2609 if (!listener) {
2610 return;
2611 }
2612 ATRACE_FORMAT_INSTANT("callReleaseBufferCallback %s - %" PRIu64, getDebugName(), framenumber);
2613 listener->onReleaseBuffer({buffer->getId(), framenumber},
2614 releaseFence ? releaseFence : Fence::NO_FENCE,
2615 currentMaxAcquiredBufferCount);
2616}
2617
2618void Layer::onLayerDisplayed(ftl::SharedFuture<FenceResult> futureFenceResult) {
2619 // If we are displayed on multiple displays in a single composition cycle then we would
2620 // need to do careful tracking to enable the use of the mLastClientCompositionFence.
2621 // For example we can only use it if all the displays are client comp, and we need
2622 // to merge all the client comp fences. We could do this, but for now we just
2623 // disable the optimization when a layer is composed on multiple displays.
2624 if (mClearClientCompositionFenceOnLayerDisplayed) {
2625 mLastClientCompositionFence = nullptr;
2626 } else {
2627 mClearClientCompositionFenceOnLayerDisplayed = true;
2628 }
2629
2630 // The previous release fence notifies the client that SurfaceFlinger is done with the previous
2631 // buffer that was presented on this layer. The first transaction that came in this frame that
2632 // replaced the previous buffer on this layer needs this release fence, because the fence will
2633 // let the client know when that previous buffer is removed from the screen.
2634 //
2635 // Every other transaction on this layer does not need a release fence because no other
2636 // Transactions that were set on this layer this frame are going to have their preceding buffer
2637 // removed from the display this frame.
2638 //
2639 // For example, if we have 3 transactions this frame. The first transaction doesn't contain a
2640 // buffer so it doesn't need a previous release fence because the layer still needs the previous
2641 // buffer. The second transaction contains a buffer so it needs a previous release fence because
2642 // the previous buffer will be released this frame. The third transaction also contains a
2643 // buffer. It replaces the buffer in the second transaction. The buffer in the second
2644 // transaction will now no longer be presented so it is released immediately and the third
2645 // transaction doesn't need a previous release fence.
2646 sp<CallbackHandle> ch;
2647 for (auto& handle : mDrawingState.callbackHandles) {
2648 if (handle->releasePreviousBuffer &&
2649 mDrawingState.releaseBufferEndpoint == handle->listener) {
2650 ch = handle;
2651 break;
2652 }
2653 }
2654
2655 // Prevent tracing the same release multiple times.
2656 if (mPreviousFrameNumber != mPreviousReleasedFrameNumber) {
2657 mPreviousReleasedFrameNumber = mPreviousFrameNumber;
2658 }
2659
2660 if (ch != nullptr) {
2661 ch->previousReleaseCallbackId = mPreviousReleaseCallbackId;
2662 ch->previousReleaseFences.emplace_back(std::move(futureFenceResult));
2663 ch->name = mName;
2664 }
2665}
2666
2667void Layer::onSurfaceFrameCreated(
2668 const std::shared_ptr<frametimeline::SurfaceFrame>& surfaceFrame) {
Vishnu Nair22491b82022-10-18 14:59:14 -07002669 if (!hasBufferOrSidebandStreamInDrawing()) {
2670 return;
2671 }
2672
Patrick Williamsbb25f802022-08-30 23:02:34 +00002673 while (mPendingJankClassifications.size() >= kPendingClassificationMaxSurfaceFrames) {
2674 // Too many SurfaceFrames pending classification. The front of the deque is probably not
2675 // tracked by FrameTimeline and will never be presented. This will only result in a memory
2676 // leak.
2677 ALOGW("Removing the front of pending jank deque from layer - %s to prevent memory leak",
2678 mName.c_str());
2679 std::string miniDump = mPendingJankClassifications.front()->miniDump();
2680 ALOGD("Head SurfaceFrame mini dump\n%s", miniDump.c_str());
2681 mPendingJankClassifications.pop_front();
2682 }
2683 mPendingJankClassifications.emplace_back(surfaceFrame);
2684}
2685
2686void Layer::releasePendingBuffer(nsecs_t dequeueReadyTime) {
2687 for (const auto& handle : mDrawingState.callbackHandles) {
Vishnu Nair71fcf912022-10-18 09:14:20 -07002688 handle->transformHint = mSkipReportingTransformHint
2689 ? std::nullopt
2690 : std::make_optional<uint32_t>(mTransformHint);
Patrick Williamsbb25f802022-08-30 23:02:34 +00002691 handle->dequeueReadyTime = dequeueReadyTime;
2692 handle->currentMaxAcquiredBufferCount =
2693 mFlinger->getMaxAcquiredBufferCountForCurrentRefreshRate(mOwnerUid);
2694 ATRACE_FORMAT_INSTANT("releasePendingBuffer %s - %" PRIu64, getDebugName(),
2695 handle->previousReleaseCallbackId.framenumber);
2696 }
2697
2698 for (auto& handle : mDrawingState.callbackHandles) {
2699 if (handle->releasePreviousBuffer &&
2700 mDrawingState.releaseBufferEndpoint == handle->listener) {
2701 handle->previousReleaseCallbackId = mPreviousReleaseCallbackId;
2702 break;
2703 }
2704 }
2705
2706 std::vector<JankData> jankData;
2707 jankData.reserve(mPendingJankClassifications.size());
2708 while (!mPendingJankClassifications.empty() &&
2709 mPendingJankClassifications.front()->getJankType()) {
2710 std::shared_ptr<frametimeline::SurfaceFrame> surfaceFrame =
2711 mPendingJankClassifications.front();
2712 mPendingJankClassifications.pop_front();
2713 jankData.emplace_back(
2714 JankData(surfaceFrame->getToken(), surfaceFrame->getJankType().value()));
2715 }
2716
2717 mFlinger->getTransactionCallbackInvoker().addCallbackHandles(mDrawingState.callbackHandles,
2718 jankData);
Patrick Williamsbb25f802022-08-30 23:02:34 +00002719 mDrawingState.callbackHandles = {};
2720}
2721
2722bool Layer::willPresentCurrentTransaction() const {
2723 // Returns true if the most recent Transaction applied to CurrentState will be presented.
2724 return (getSidebandStreamChanged() || getAutoRefresh() ||
2725 (mDrawingState.modified &&
2726 (mDrawingState.buffer != nullptr || mDrawingState.bgColorLayer != nullptr)));
2727}
2728
2729bool Layer::setTransform(uint32_t transform) {
2730 if (mDrawingState.bufferTransform == transform) return false;
2731 mDrawingState.bufferTransform = transform;
2732 mDrawingState.modified = true;
2733 setTransactionFlags(eTransactionNeeded);
2734 return true;
2735}
2736
2737bool Layer::setTransformToDisplayInverse(bool transformToDisplayInverse) {
2738 if (mDrawingState.transformToDisplayInverse == transformToDisplayInverse) return false;
2739 mDrawingState.sequence++;
2740 mDrawingState.transformToDisplayInverse = transformToDisplayInverse;
2741 mDrawingState.modified = true;
2742 setTransactionFlags(eTransactionNeeded);
2743 return true;
2744}
2745
2746bool Layer::setBufferCrop(const Rect& bufferCrop) {
2747 if (mDrawingState.bufferCrop == bufferCrop) return false;
2748
2749 mDrawingState.sequence++;
2750 mDrawingState.bufferCrop = bufferCrop;
2751
2752 mDrawingState.modified = true;
2753 setTransactionFlags(eTransactionNeeded);
2754 return true;
2755}
2756
2757bool Layer::setDestinationFrame(const Rect& destinationFrame) {
2758 if (mDrawingState.destinationFrame == destinationFrame) return false;
2759
2760 mDrawingState.sequence++;
2761 mDrawingState.destinationFrame = destinationFrame;
2762
2763 mDrawingState.modified = true;
2764 setTransactionFlags(eTransactionNeeded);
2765 return true;
2766}
2767
2768// Translate destination frame into scale and position. If a destination frame is not set, use the
2769// provided scale and position
2770bool Layer::updateGeometry() {
2771 if ((mDrawingState.flags & layer_state_t::eIgnoreDestinationFrame) ||
2772 mDrawingState.destinationFrame.isEmpty()) {
2773 // If destination frame is not set, use the requested transform set via
2774 // Layer::setPosition and Layer::setMatrix.
2775 return assignTransform(&mDrawingState.transform, mRequestedTransform);
2776 }
2777
2778 Rect destRect = mDrawingState.destinationFrame;
2779 int32_t destW = destRect.width();
2780 int32_t destH = destRect.height();
2781 if (destRect.left < 0) {
2782 destRect.left = 0;
2783 destRect.right = destW;
2784 }
2785 if (destRect.top < 0) {
2786 destRect.top = 0;
2787 destRect.bottom = destH;
2788 }
2789
2790 if (!mDrawingState.buffer) {
2791 ui::Transform t;
2792 t.set(destRect.left, destRect.top);
2793 return assignTransform(&mDrawingState.transform, t);
2794 }
2795
2796 uint32_t bufferWidth = mDrawingState.buffer->getWidth();
2797 uint32_t bufferHeight = mDrawingState.buffer->getHeight();
2798 // Undo any transformations on the buffer.
2799 if (mDrawingState.bufferTransform & ui::Transform::ROT_90) {
2800 std::swap(bufferWidth, bufferHeight);
2801 }
2802 uint32_t invTransform = DisplayDevice::getPrimaryDisplayRotationFlags();
2803 if (mDrawingState.transformToDisplayInverse) {
2804 if (invTransform & ui::Transform::ROT_90) {
2805 std::swap(bufferWidth, bufferHeight);
2806 }
2807 }
2808
2809 float sx = destW / static_cast<float>(bufferWidth);
2810 float sy = destH / static_cast<float>(bufferHeight);
2811 ui::Transform t;
2812 t.set(sx, 0, 0, sy);
2813 t.set(destRect.left, destRect.top);
2814 return assignTransform(&mDrawingState.transform, t);
2815}
2816
2817bool Layer::setMatrix(const layer_state_t::matrix22_t& matrix) {
2818 if (mRequestedTransform.dsdx() == matrix.dsdx && mRequestedTransform.dtdy() == matrix.dtdy &&
2819 mRequestedTransform.dtdx() == matrix.dtdx && mRequestedTransform.dsdy() == matrix.dsdy) {
2820 return false;
2821 }
2822
2823 mRequestedTransform.set(matrix.dsdx, matrix.dtdy, matrix.dtdx, matrix.dsdy);
2824
2825 mDrawingState.sequence++;
2826 mDrawingState.modified = true;
2827 setTransactionFlags(eTransactionNeeded);
2828
2829 return true;
2830}
2831
2832bool Layer::setPosition(float x, float y) {
2833 if (mRequestedTransform.tx() == x && mRequestedTransform.ty() == y) {
2834 return false;
2835 }
2836
2837 mRequestedTransform.set(x, y);
2838
2839 mDrawingState.sequence++;
2840 mDrawingState.modified = true;
2841 setTransactionFlags(eTransactionNeeded);
2842
2843 return true;
2844}
2845
2846bool Layer::setBuffer(std::shared_ptr<renderengine::ExternalTexture>& buffer,
2847 const BufferData& bufferData, nsecs_t postTime, nsecs_t desiredPresentTime,
2848 bool isAutoTimestamp, std::optional<nsecs_t> dequeueTime,
2849 const FrameTimelineInfo& info) {
Chavi Weingarten009619f2022-09-15 20:27:25 +00002850 ATRACE_FORMAT("setBuffer %s - hasBuffer=%s", getDebugName(), (buffer ? "true" : "false"));
Patrick Williamsbb25f802022-08-30 23:02:34 +00002851 if (!buffer) {
2852 return false;
2853 }
2854
2855 const bool frameNumberChanged =
2856 bufferData.flags.test(BufferData::BufferDataChange::frameNumberChanged);
2857 const uint64_t frameNumber =
2858 frameNumberChanged ? bufferData.frameNumber : mDrawingState.frameNumber + 1;
Chavi Weingarten009619f2022-09-15 20:27:25 +00002859 ATRACE_FORMAT_INSTANT("setBuffer %s - %" PRIu64, getDebugName(), frameNumber);
Patrick Williamsbb25f802022-08-30 23:02:34 +00002860
2861 if (mDrawingState.buffer) {
2862 mReleasePreviousBuffer = true;
2863 if (!mBufferInfo.mBuffer ||
2864 (!mDrawingState.buffer->hasSameBuffer(*mBufferInfo.mBuffer) ||
2865 mDrawingState.frameNumber != mBufferInfo.mFrameNumber)) {
2866 // If mDrawingState has a buffer, and we are about to update again
2867 // before swapping to drawing state, then the first buffer will be
2868 // dropped and we should decrement the pending buffer count and
2869 // call any release buffer callbacks if set.
2870 callReleaseBufferCallback(mDrawingState.releaseBufferListener,
2871 mDrawingState.buffer->getBuffer(), mDrawingState.frameNumber,
2872 mDrawingState.acquireFence,
2873 mFlinger->getMaxAcquiredBufferCountForCurrentRefreshRate(
2874 mOwnerUid));
2875 decrementPendingBufferCount();
2876 if (mDrawingState.bufferSurfaceFrameTX != nullptr &&
2877 mDrawingState.bufferSurfaceFrameTX->getPresentState() != PresentState::Presented) {
2878 addSurfaceFrameDroppedForBuffer(mDrawingState.bufferSurfaceFrameTX);
2879 mDrawingState.bufferSurfaceFrameTX.reset();
2880 }
2881 } else if (EARLY_RELEASE_ENABLED && mLastClientCompositionFence != nullptr) {
2882 callReleaseBufferCallback(mDrawingState.releaseBufferListener,
2883 mDrawingState.buffer->getBuffer(), mDrawingState.frameNumber,
2884 mLastClientCompositionFence,
2885 mFlinger->getMaxAcquiredBufferCountForCurrentRefreshRate(
2886 mOwnerUid));
2887 mLastClientCompositionFence = nullptr;
2888 }
2889 }
2890
2891 mDrawingState.frameNumber = frameNumber;
2892 mDrawingState.releaseBufferListener = bufferData.releaseBufferListener;
2893 mDrawingState.buffer = std::move(buffer);
2894 mDrawingState.clientCacheId = bufferData.cachedBuffer;
2895
2896 mDrawingState.acquireFence = bufferData.flags.test(BufferData::BufferDataChange::fenceChanged)
2897 ? bufferData.acquireFence
2898 : Fence::NO_FENCE;
2899 mDrawingState.acquireFenceTime = std::make_unique<FenceTime>(mDrawingState.acquireFence);
2900 if (mDrawingState.acquireFenceTime->getSignalTime() == Fence::SIGNAL_TIME_PENDING) {
2901 // We latched this buffer unsiganled, so we need to pass the acquire fence
2902 // on the callback instead of just the acquire time, since it's unknown at
2903 // this point.
2904 mCallbackHandleAcquireTimeOrFence = mDrawingState.acquireFence;
2905 } else {
2906 mCallbackHandleAcquireTimeOrFence = mDrawingState.acquireFenceTime->getSignalTime();
2907 }
2908
2909 mDrawingState.modified = true;
2910 setTransactionFlags(eTransactionNeeded);
2911
2912 const int32_t layerId = getSequence();
2913 mFlinger->mTimeStats->setPostTime(layerId, mDrawingState.frameNumber, getName().c_str(),
2914 mOwnerUid, postTime, getGameMode());
2915 mDrawingState.desiredPresentTime = desiredPresentTime;
2916 mDrawingState.isAutoTimestamp = isAutoTimestamp;
2917
2918 const nsecs_t presentTime = [&] {
2919 if (!isAutoTimestamp) return desiredPresentTime;
2920
2921 const auto prediction =
2922 mFlinger->mFrameTimeline->getTokenManager()->getPredictionsForToken(info.vsyncId);
2923 if (prediction.has_value()) return prediction->presentTime;
2924
2925 return static_cast<nsecs_t>(0);
2926 }();
2927
2928 using LayerUpdateType = scheduler::LayerHistory::LayerUpdateType;
2929 mFlinger->mScheduler->recordLayerHistory(this, presentTime, LayerUpdateType::Buffer);
2930
2931 setFrameTimelineVsyncForBufferTransaction(info, postTime);
2932
2933 if (dequeueTime && *dequeueTime != 0) {
2934 const uint64_t bufferId = mDrawingState.buffer->getId();
2935 mFlinger->mFrameTracer->traceNewLayer(layerId, getName().c_str());
2936 mFlinger->mFrameTracer->traceTimestamp(layerId, bufferId, frameNumber, *dequeueTime,
2937 FrameTracer::FrameEvent::DEQUEUE);
2938 mFlinger->mFrameTracer->traceTimestamp(layerId, bufferId, frameNumber, postTime,
2939 FrameTracer::FrameEvent::QUEUE);
2940 }
2941
2942 mDrawingState.releaseBufferEndpoint = bufferData.releaseBufferEndpoint;
2943 return true;
2944}
2945
2946bool Layer::setDataspace(ui::Dataspace dataspace) {
2947 mDrawingState.dataspaceRequested = true;
2948 if (mDrawingState.dataspace == dataspace) return false;
2949 mDrawingState.dataspace = dataspace;
2950 mDrawingState.modified = true;
2951 setTransactionFlags(eTransactionNeeded);
2952 return true;
2953}
2954
2955bool Layer::setHdrMetadata(const HdrMetadata& hdrMetadata) {
2956 if (mDrawingState.hdrMetadata == hdrMetadata) return false;
2957 mDrawingState.hdrMetadata = hdrMetadata;
2958 mDrawingState.modified = true;
2959 setTransactionFlags(eTransactionNeeded);
2960 return true;
2961}
2962
2963bool Layer::setSurfaceDamageRegion(const Region& surfaceDamage) {
2964 mDrawingState.surfaceDamageRegion = surfaceDamage;
2965 mDrawingState.modified = true;
2966 setTransactionFlags(eTransactionNeeded);
2967 return true;
2968}
2969
2970bool Layer::setApi(int32_t api) {
2971 if (mDrawingState.api == api) return false;
2972 mDrawingState.api = api;
2973 mDrawingState.modified = true;
2974 setTransactionFlags(eTransactionNeeded);
2975 return true;
2976}
2977
2978bool Layer::setSidebandStream(const sp<NativeHandle>& sidebandStream) {
2979 if (mDrawingState.sidebandStream == sidebandStream) return false;
2980
2981 if (mDrawingState.sidebandStream != nullptr && sidebandStream == nullptr) {
2982 mFlinger->mTunnelModeEnabledReporter->decrementTunnelModeCount();
2983 } else if (sidebandStream != nullptr) {
2984 mFlinger->mTunnelModeEnabledReporter->incrementTunnelModeCount();
2985 }
2986
2987 mDrawingState.sidebandStream = sidebandStream;
2988 mDrawingState.modified = true;
2989 setTransactionFlags(eTransactionNeeded);
2990 if (!mSidebandStreamChanged.exchange(true)) {
2991 // mSidebandStreamChanged was false
2992 mFlinger->onLayerUpdate();
2993 }
2994 return true;
2995}
2996
2997bool Layer::setTransactionCompletedListeners(const std::vector<sp<CallbackHandle>>& handles) {
2998 // If there is no handle, we will not send a callback so reset mReleasePreviousBuffer and return
2999 if (handles.empty()) {
3000 mReleasePreviousBuffer = false;
3001 return false;
3002 }
3003
3004 const bool willPresent = willPresentCurrentTransaction();
3005
3006 for (const auto& handle : handles) {
3007 // If this transaction set a buffer on this layer, release its previous buffer
3008 handle->releasePreviousBuffer = mReleasePreviousBuffer;
3009
3010 // If this layer will be presented in this frame
3011 if (willPresent) {
3012 // If this transaction set an acquire fence on this layer, set its acquire time
3013 handle->acquireTimeOrFence = mCallbackHandleAcquireTimeOrFence;
3014 handle->frameNumber = mDrawingState.frameNumber;
3015
3016 // Store so latched time and release fence can be set
3017 mDrawingState.callbackHandles.push_back(handle);
3018
3019 } else { // If this layer will NOT need to be relatched and presented this frame
3020 // Notify the transaction completed thread this handle is done
3021 mFlinger->getTransactionCallbackInvoker().registerUnpresentedCallbackHandle(handle);
3022 }
3023 }
3024
3025 mReleasePreviousBuffer = false;
3026 mCallbackHandleAcquireTimeOrFence = -1;
3027
3028 return willPresent;
3029}
3030
3031Rect Layer::getBufferSize(const State& /*s*/) const {
3032 // for buffer state layers we use the display frame size as the buffer size.
3033
3034 if (mBufferInfo.mBuffer == nullptr) {
3035 return Rect::INVALID_RECT;
3036 }
3037
3038 uint32_t bufWidth = mBufferInfo.mBuffer->getWidth();
3039 uint32_t bufHeight = mBufferInfo.mBuffer->getHeight();
3040
3041 // Undo any transformations on the buffer and return the result.
3042 if (mBufferInfo.mTransform & ui::Transform::ROT_90) {
3043 std::swap(bufWidth, bufHeight);
3044 }
3045
3046 if (getTransformToDisplayInverse()) {
3047 uint32_t invTransform = DisplayDevice::getPrimaryDisplayRotationFlags();
3048 if (invTransform & ui::Transform::ROT_90) {
3049 std::swap(bufWidth, bufHeight);
3050 }
3051 }
3052
3053 return Rect(0, 0, static_cast<int32_t>(bufWidth), static_cast<int32_t>(bufHeight));
3054}
3055
3056FloatRect Layer::computeSourceBounds(const FloatRect& parentBounds) const {
3057 if (mBufferInfo.mBuffer == nullptr) {
3058 return parentBounds;
3059 }
3060
3061 return getBufferSize(getDrawingState()).toFloatRect();
3062}
3063
3064bool Layer::fenceHasSignaled() const {
3065 if (SurfaceFlinger::enableLatchUnsignaledConfig != LatchUnsignaledConfig::Disabled) {
3066 return true;
3067 }
3068
3069 const bool fenceSignaled =
3070 getDrawingState().acquireFence->getStatus() == Fence::Status::Signaled;
3071 if (!fenceSignaled) {
3072 mFlinger->mTimeStats->incrementLatchSkipped(getSequence(),
3073 TimeStats::LatchSkipReason::LateAcquire);
3074 }
3075
3076 return fenceSignaled;
3077}
3078
Vishnu Naire14c6b32022-08-06 04:20:15 +00003079bool Layer::onPreComposition(nsecs_t refreshStartTime) {
Patrick Williamsbb25f802022-08-30 23:02:34 +00003080 for (const auto& handle : mDrawingState.callbackHandles) {
3081 handle->refreshStartTime = refreshStartTime;
3082 }
3083 return hasReadyFrame();
3084}
3085
3086void Layer::setAutoRefresh(bool autoRefresh) {
3087 mDrawingState.autoRefresh = autoRefresh;
3088}
3089
3090bool Layer::latchSidebandStream(bool& recomputeVisibleRegions) {
3091 // 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 +00003092 auto* snapshot = editLayerSnapshot();
3093 snapshot->sidebandStreamHasFrame = hasFrameUpdate() && mSidebandStream.get();
Patrick Williamsbb25f802022-08-30 23:02:34 +00003094
3095 if (mSidebandStreamChanged.exchange(false)) {
3096 const State& s(getDrawingState());
3097 // mSidebandStreamChanged was true
3098 mSidebandStream = s.sidebandStream;
Vishnu Nairbedb44b2022-08-02 21:47:40 +00003099 snapshot->sidebandStream = mSidebandStream;
Patrick Williamsbb25f802022-08-30 23:02:34 +00003100 if (mSidebandStream != nullptr) {
3101 setTransactionFlags(eTransactionNeeded);
3102 mFlinger->setTransactionFlags(eTraversalNeeded);
3103 }
3104 recomputeVisibleRegions = true;
3105
3106 return true;
3107 }
3108 return false;
3109}
3110
3111bool Layer::hasFrameUpdate() const {
3112 const State& c(getDrawingState());
3113 return (mDrawingStateModified || mDrawingState.modified) &&
3114 (c.buffer != nullptr || c.bgColorLayer != nullptr);
3115}
3116
3117void Layer::updateTexImage(nsecs_t latchTime) {
3118 const State& s(getDrawingState());
3119
3120 if (!s.buffer) {
3121 if (s.bgColorLayer) {
3122 for (auto& handle : mDrawingState.callbackHandles) {
3123 handle->latchTime = latchTime;
3124 }
3125 }
3126 return;
3127 }
3128
3129 for (auto& handle : mDrawingState.callbackHandles) {
3130 if (handle->frameNumber == mDrawingState.frameNumber) {
3131 handle->latchTime = latchTime;
3132 }
3133 }
3134
3135 const int32_t layerId = getSequence();
3136 const uint64_t bufferId = mDrawingState.buffer->getId();
3137 const uint64_t frameNumber = mDrawingState.frameNumber;
3138 const auto acquireFence = std::make_shared<FenceTime>(mDrawingState.acquireFence);
3139 mFlinger->mTimeStats->setAcquireFence(layerId, frameNumber, acquireFence);
3140 mFlinger->mTimeStats->setLatchTime(layerId, frameNumber, latchTime);
3141
3142 mFlinger->mFrameTracer->traceFence(layerId, bufferId, frameNumber, acquireFence,
3143 FrameTracer::FrameEvent::ACQUIRE_FENCE);
3144 mFlinger->mFrameTracer->traceTimestamp(layerId, bufferId, frameNumber, latchTime,
3145 FrameTracer::FrameEvent::LATCH);
3146
3147 auto& bufferSurfaceFrame = mDrawingState.bufferSurfaceFrameTX;
3148 if (bufferSurfaceFrame != nullptr &&
3149 bufferSurfaceFrame->getPresentState() != PresentState::Presented) {
3150 // Update only if the bufferSurfaceFrame wasn't already presented. A Presented
3151 // bufferSurfaceFrame could be seen here if a pending state was applied successfully and we
3152 // are processing the next state.
3153 addSurfaceFramePresentedForBuffer(bufferSurfaceFrame,
3154 mDrawingState.acquireFenceTime->getSignalTime(),
3155 latchTime);
3156 mDrawingState.bufferSurfaceFrameTX.reset();
3157 }
3158
3159 std::deque<sp<CallbackHandle>> remainingHandles;
3160 mFlinger->getTransactionCallbackInvoker()
3161 .addOnCommitCallbackHandles(mDrawingState.callbackHandles, remainingHandles);
3162 mDrawingState.callbackHandles = remainingHandles;
3163
3164 mDrawingStateModified = false;
3165}
3166
3167void Layer::gatherBufferInfo() {
3168 if (!mBufferInfo.mBuffer || !mDrawingState.buffer->hasSameBuffer(*mBufferInfo.mBuffer)) {
3169 decrementPendingBufferCount();
3170 }
3171
3172 mPreviousReleaseCallbackId = {getCurrentBufferId(), mBufferInfo.mFrameNumber};
3173 mBufferInfo.mBuffer = mDrawingState.buffer;
3174 mBufferInfo.mFence = mDrawingState.acquireFence;
3175 mBufferInfo.mFrameNumber = mDrawingState.frameNumber;
3176 mBufferInfo.mPixelFormat =
3177 !mBufferInfo.mBuffer ? PIXEL_FORMAT_NONE : mBufferInfo.mBuffer->getPixelFormat();
3178 mBufferInfo.mFrameLatencyNeeded = true;
3179 mBufferInfo.mDesiredPresentTime = mDrawingState.desiredPresentTime;
3180 mBufferInfo.mFenceTime = std::make_shared<FenceTime>(mDrawingState.acquireFence);
3181 mBufferInfo.mFence = mDrawingState.acquireFence;
3182 mBufferInfo.mTransform = mDrawingState.bufferTransform;
3183 auto lastDataspace = mBufferInfo.mDataspace;
3184 mBufferInfo.mDataspace = translateDataspace(mDrawingState.dataspace);
3185 if (lastDataspace != mBufferInfo.mDataspace) {
3186 mFlinger->mSomeDataspaceChanged = true;
3187 }
3188 mBufferInfo.mCrop = computeBufferCrop(mDrawingState);
3189 mBufferInfo.mScaleMode = NATIVE_WINDOW_SCALING_MODE_SCALE_TO_WINDOW;
3190 mBufferInfo.mSurfaceDamage = mDrawingState.surfaceDamageRegion;
3191 mBufferInfo.mHdrMetadata = mDrawingState.hdrMetadata;
3192 mBufferInfo.mApi = mDrawingState.api;
3193 mBufferInfo.mTransformToDisplayInverse = mDrawingState.transformToDisplayInverse;
3194 mBufferInfo.mBufferSlot = mHwcSlotGenerator->getHwcCacheSlot(mDrawingState.clientCacheId);
3195}
3196
3197Rect Layer::computeBufferCrop(const State& s) {
3198 if (s.buffer && !s.bufferCrop.isEmpty()) {
3199 Rect bufferCrop;
3200 s.buffer->getBounds().intersect(s.bufferCrop, &bufferCrop);
3201 return bufferCrop;
3202 } else if (s.buffer) {
3203 return s.buffer->getBounds();
3204 } else {
3205 return s.bufferCrop;
3206 }
3207}
3208
3209sp<Layer> Layer::createClone() {
3210 LayerCreationArgs args(mFlinger.get(), nullptr, mName + " (Mirror)", 0, LayerMetadata());
3211 args.textureName = mTextureName;
Patrick Williams83f36b22022-09-14 17:57:35 +00003212 sp<Layer> layer = mFlinger->getFactory().createBufferStateLayer(args);
Patrick Williamsbb25f802022-08-30 23:02:34 +00003213 layer->mHwcSlotGenerator = mHwcSlotGenerator;
3214 layer->setInitialValuesForClone(sp<Layer>::fromExisting(this));
3215 return layer;
3216}
3217
3218bool Layer::bufferNeedsFiltering() const {
3219 const State& s(getDrawingState());
3220 if (!s.buffer) {
3221 return false;
3222 }
3223
3224 int32_t bufferWidth = static_cast<int32_t>(s.buffer->getWidth());
3225 int32_t bufferHeight = static_cast<int32_t>(s.buffer->getHeight());
3226
3227 // Undo any transformations on the buffer and return the result.
3228 if (s.bufferTransform & ui::Transform::ROT_90) {
3229 std::swap(bufferWidth, bufferHeight);
3230 }
3231
3232 if (s.transformToDisplayInverse) {
3233 uint32_t invTransform = DisplayDevice::getPrimaryDisplayRotationFlags();
3234 if (invTransform & ui::Transform::ROT_90) {
3235 std::swap(bufferWidth, bufferHeight);
3236 }
3237 }
3238
3239 const Rect layerSize{getBounds()};
3240 int32_t layerWidth = layerSize.getWidth();
3241 int32_t layerHeight = layerSize.getHeight();
3242
3243 // Align the layer orientation with the buffer before comparism
3244 if (mTransformHint & ui::Transform::ROT_90) {
3245 std::swap(layerWidth, layerHeight);
3246 }
3247
3248 return layerWidth != bufferWidth || layerHeight != bufferHeight;
3249}
3250
3251void Layer::decrementPendingBufferCount() {
3252 int32_t pendingBuffers = --mPendingBufferTransactions;
3253 tracePendingBufferCount(pendingBuffers);
3254}
3255
3256void Layer::tracePendingBufferCount(int32_t pendingBuffers) {
3257 ATRACE_INT(mBlastTransactionName.c_str(), pendingBuffers);
3258}
3259
3260/*
3261 * We don't want to send the layer's transform to input, but rather the
3262 * parent's transform. This is because Layer's transform is
3263 * information about how the buffer is placed on screen. The parent's
3264 * transform makes more sense to send since it's information about how the
3265 * layer is placed on screen. This transform is used by input to determine
3266 * how to go from screen space back to window space.
3267 */
3268ui::Transform Layer::getInputTransform() const {
3269 if (!hasBufferOrSidebandStream()) {
3270 return getTransform();
3271 }
3272 sp<Layer> parent = mDrawingParent.promote();
3273 if (parent == nullptr) {
3274 return ui::Transform();
3275 }
3276
3277 return parent->getTransform();
3278}
3279
3280/**
3281 * Similar to getInputTransform, we need to update the bounds to include the transform.
3282 * This is because bounds don't include the buffer transform, where the input assumes
3283 * that's already included.
3284 */
3285Rect Layer::getInputBounds() const {
3286 if (!hasBufferOrSidebandStream()) {
3287 return getCroppedBufferSize(getDrawingState());
3288 }
3289
3290 Rect bufferBounds = getCroppedBufferSize(getDrawingState());
3291 if (mDrawingState.transform.getType() == ui::Transform::IDENTITY || !bufferBounds.isValid()) {
3292 return bufferBounds;
3293 }
3294 return mDrawingState.transform.transform(bufferBounds);
3295}
3296
3297bool Layer::simpleBufferUpdate(const layer_state_t& s) const {
3298 const uint64_t requiredFlags = layer_state_t::eBufferChanged;
3299
3300 const uint64_t deniedFlags = layer_state_t::eProducerDisconnect | layer_state_t::eLayerChanged |
3301 layer_state_t::eRelativeLayerChanged | layer_state_t::eTransparentRegionChanged |
3302 layer_state_t::eFlagsChanged | layer_state_t::eBlurRegionsChanged |
3303 layer_state_t::eLayerStackChanged | layer_state_t::eAutoRefreshChanged |
3304 layer_state_t::eReparent;
3305
3306 const uint64_t allowedFlags = layer_state_t::eHasListenerCallbacksChanged |
3307 layer_state_t::eFrameRateSelectionPriority | layer_state_t::eFrameRateChanged |
3308 layer_state_t::eSurfaceDamageRegionChanged | layer_state_t::eApiChanged |
3309 layer_state_t::eMetadataChanged | layer_state_t::eDropInputModeChanged |
3310 layer_state_t::eInputInfoChanged;
3311
3312 if ((s.what & requiredFlags) != requiredFlags) {
3313 ALOGV("%s: false [missing required flags 0x%" PRIx64 "]", __func__,
3314 (s.what | requiredFlags) & ~s.what);
3315 return false;
3316 }
3317
3318 if (s.what & deniedFlags) {
3319 ALOGV("%s: false [has denied flags 0x%" PRIx64 "]", __func__, s.what & deniedFlags);
3320 return false;
3321 }
3322
3323 if (s.what & allowedFlags) {
3324 ALOGV("%s: [has allowed flags 0x%" PRIx64 "]", __func__, s.what & allowedFlags);
3325 }
3326
3327 if (s.what & layer_state_t::ePositionChanged) {
3328 if (mRequestedTransform.tx() != s.x || mRequestedTransform.ty() != s.y) {
3329 ALOGV("%s: false [ePositionChanged changed]", __func__);
3330 return false;
3331 }
3332 }
3333
3334 if (s.what & layer_state_t::eAlphaChanged) {
Vishnu Nairbbceb462022-10-10 04:52:13 +00003335 if (mDrawingState.color.a != s.color.a) {
Patrick Williamsbb25f802022-08-30 23:02:34 +00003336 ALOGV("%s: false [eAlphaChanged changed]", __func__);
3337 return false;
3338 }
3339 }
3340
3341 if (s.what & layer_state_t::eColorTransformChanged) {
3342 if (mDrawingState.colorTransform != s.colorTransform) {
3343 ALOGV("%s: false [eColorTransformChanged changed]", __func__);
3344 return false;
3345 }
3346 }
3347
3348 if (s.what & layer_state_t::eBackgroundColorChanged) {
3349 if (mDrawingState.bgColorLayer || s.bgColorAlpha != 0) {
3350 ALOGV("%s: false [eBackgroundColorChanged changed]", __func__);
3351 return false;
3352 }
3353 }
3354
3355 if (s.what & layer_state_t::eMatrixChanged) {
3356 if (mRequestedTransform.dsdx() != s.matrix.dsdx ||
3357 mRequestedTransform.dtdy() != s.matrix.dtdy ||
3358 mRequestedTransform.dtdx() != s.matrix.dtdx ||
3359 mRequestedTransform.dsdy() != s.matrix.dsdy) {
3360 ALOGV("%s: false [eMatrixChanged changed]", __func__);
3361 return false;
3362 }
3363 }
3364
3365 if (s.what & layer_state_t::eCornerRadiusChanged) {
3366 if (mDrawingState.cornerRadius != s.cornerRadius) {
3367 ALOGV("%s: false [eCornerRadiusChanged changed]", __func__);
3368 return false;
3369 }
3370 }
3371
3372 if (s.what & layer_state_t::eBackgroundBlurRadiusChanged) {
3373 if (mDrawingState.backgroundBlurRadius != static_cast<int>(s.backgroundBlurRadius)) {
3374 ALOGV("%s: false [eBackgroundBlurRadiusChanged changed]", __func__);
3375 return false;
3376 }
3377 }
3378
Vishnu Nairbbceb462022-10-10 04:52:13 +00003379 if (s.what & layer_state_t::eBufferTransformChanged) {
3380 if (mDrawingState.bufferTransform != s.bufferTransform) {
3381 ALOGV("%s: false [eBufferTransformChanged changed]", __func__);
Patrick Williamsbb25f802022-08-30 23:02:34 +00003382 return false;
3383 }
3384 }
3385
3386 if (s.what & layer_state_t::eTransformToDisplayInverseChanged) {
3387 if (mDrawingState.transformToDisplayInverse != s.transformToDisplayInverse) {
3388 ALOGV("%s: false [eTransformToDisplayInverseChanged changed]", __func__);
3389 return false;
3390 }
3391 }
3392
3393 if (s.what & layer_state_t::eCropChanged) {
3394 if (mDrawingState.crop != s.crop) {
3395 ALOGV("%s: false [eCropChanged changed]", __func__);
3396 return false;
3397 }
3398 }
3399
3400 if (s.what & layer_state_t::eDataspaceChanged) {
3401 if (mDrawingState.dataspace != s.dataspace) {
3402 ALOGV("%s: false [eDataspaceChanged changed]", __func__);
3403 return false;
3404 }
3405 }
3406
3407 if (s.what & layer_state_t::eHdrMetadataChanged) {
3408 if (mDrawingState.hdrMetadata != s.hdrMetadata) {
3409 ALOGV("%s: false [eHdrMetadataChanged changed]", __func__);
3410 return false;
3411 }
3412 }
3413
3414 if (s.what & layer_state_t::eSidebandStreamChanged) {
3415 if (mDrawingState.sidebandStream != s.sidebandStream) {
3416 ALOGV("%s: false [eSidebandStreamChanged changed]", __func__);
3417 return false;
3418 }
3419 }
3420
3421 if (s.what & layer_state_t::eColorSpaceAgnosticChanged) {
3422 if (mDrawingState.colorSpaceAgnostic != s.colorSpaceAgnostic) {
3423 ALOGV("%s: false [eColorSpaceAgnosticChanged changed]", __func__);
3424 return false;
3425 }
3426 }
3427
3428 if (s.what & layer_state_t::eShadowRadiusChanged) {
3429 if (mDrawingState.shadowRadius != s.shadowRadius) {
3430 ALOGV("%s: false [eShadowRadiusChanged changed]", __func__);
3431 return false;
3432 }
3433 }
3434
3435 if (s.what & layer_state_t::eFixedTransformHintChanged) {
3436 if (mDrawingState.fixedTransformHint != s.fixedTransformHint) {
3437 ALOGV("%s: false [eFixedTransformHintChanged changed]", __func__);
3438 return false;
3439 }
3440 }
3441
3442 if (s.what & layer_state_t::eTrustedOverlayChanged) {
3443 if (mDrawingState.isTrustedOverlay != s.isTrustedOverlay) {
3444 ALOGV("%s: false [eTrustedOverlayChanged changed]", __func__);
3445 return false;
3446 }
3447 }
3448
3449 if (s.what & layer_state_t::eStretchChanged) {
3450 StretchEffect temp = s.stretchEffect;
3451 temp.sanitize();
3452 if (mDrawingState.stretchEffect != temp) {
3453 ALOGV("%s: false [eStretchChanged changed]", __func__);
3454 return false;
3455 }
3456 }
3457
3458 if (s.what & layer_state_t::eBufferCropChanged) {
3459 if (mDrawingState.bufferCrop != s.bufferCrop) {
3460 ALOGV("%s: false [eBufferCropChanged changed]", __func__);
3461 return false;
3462 }
3463 }
3464
3465 if (s.what & layer_state_t::eDestinationFrameChanged) {
3466 if (mDrawingState.destinationFrame != s.destinationFrame) {
3467 ALOGV("%s: false [eDestinationFrameChanged changed]", __func__);
3468 return false;
3469 }
3470 }
3471
3472 if (s.what & layer_state_t::eDimmingEnabledChanged) {
3473 if (mDrawingState.dimmingEnabled != s.dimmingEnabled) {
3474 ALOGV("%s: false [eDimmingEnabledChanged changed]", __func__);
3475 return false;
3476 }
3477 }
3478
3479 ALOGV("%s: true", __func__);
3480 return true;
3481}
3482
3483bool Layer::isHdrY410() const {
3484 // pixel format is HDR Y410 masquerading as RGBA_1010102
3485 return (mBufferInfo.mDataspace == ui::Dataspace::BT2020_ITU_PQ &&
3486 mBufferInfo.mApi == NATIVE_WINDOW_API_MEDIA &&
3487 mBufferInfo.mPixelFormat == HAL_PIXEL_FORMAT_RGBA_1010102);
3488}
3489
Vishnu Naire14c6b32022-08-06 04:20:15 +00003490sp<LayerFE> Layer::getCompositionEngineLayerFE() const {
Patrick Williamsbb25f802022-08-30 23:02:34 +00003491 // 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 +00003492 return hasSomethingToDraw() ? mLayerFE : nullptr;
Patrick Williamsbb25f802022-08-30 23:02:34 +00003493}
3494
Vishnu Naire14c6b32022-08-06 04:20:15 +00003495const LayerSnapshot* Layer::getLayerSnapshot() const {
Vishnu Nairbedb44b2022-08-02 21:47:40 +00003496 return mSnapshot.get();
Patrick Williamsbb25f802022-08-30 23:02:34 +00003497}
3498
Vishnu Naire14c6b32022-08-06 04:20:15 +00003499LayerSnapshot* Layer::editLayerSnapshot() {
Vishnu Nairbedb44b2022-08-02 21:47:40 +00003500 return mSnapshot.get();
3501}
Vishnu Naire14c6b32022-08-06 04:20:15 +00003502
Patrick Williamsbb25f802022-08-30 23:02:34 +00003503const compositionengine::LayerFECompositionState* Layer::getCompositionState() const {
Vishnu Nairbedb44b2022-08-02 21:47:40 +00003504 return mSnapshot.get();
Patrick Williamsbb25f802022-08-30 23:02:34 +00003505}
3506
3507void Layer::useSurfaceDamage() {
3508 if (mFlinger->mForceFullDamage) {
3509 surfaceDamageRegion = Region::INVALID_REGION;
3510 } else {
3511 surfaceDamageRegion = mBufferInfo.mSurfaceDamage;
3512 }
3513}
3514
3515void Layer::useEmptyDamage() {
3516 surfaceDamageRegion.clear();
3517}
3518
3519bool Layer::isOpaque(const Layer::State& s) const {
3520 // if we don't have a buffer or sidebandStream yet, we're translucent regardless of the
3521 // layer's opaque flag.
3522 if (!hasSomethingToDraw()) {
3523 return false;
3524 }
3525
3526 // if the layer has the opaque flag, then we're always opaque
3527 if ((s.flags & layer_state_t::eLayerOpaque) == layer_state_t::eLayerOpaque) {
3528 return true;
3529 }
3530
3531 // If the buffer has no alpha channel, then we are opaque
3532 if (hasBufferOrSidebandStream() && isOpaqueFormat(getPixelFormat())) {
3533 return true;
3534 }
3535
3536 // Lastly consider the layer opaque if drawing a color with alpha == 1.0
3537 return fillsColor() && getAlpha() == 1.0_hf;
3538}
3539
3540bool Layer::canReceiveInput() const {
3541 return !isHiddenByPolicy() && (mBufferInfo.mBuffer == nullptr || getAlpha() > 0.0f);
3542}
3543
3544bool Layer::isVisible() const {
3545 if (!hasSomethingToDraw()) {
3546 return false;
3547 }
3548
3549 if (isHiddenByPolicy()) {
3550 return false;
3551 }
3552
3553 return getAlpha() > 0.0f || hasBlur();
3554}
3555
3556void Layer::onPostComposition(const DisplayDevice* display,
3557 const std::shared_ptr<FenceTime>& glDoneFence,
3558 const std::shared_ptr<FenceTime>& presentFence,
3559 const CompositorTiming& compositorTiming) {
3560 // mFrameLatencyNeeded is true when a new frame was latched for the
3561 // composition.
3562 if (!mBufferInfo.mFrameLatencyNeeded) return;
3563
3564 for (const auto& handle : mDrawingState.callbackHandles) {
3565 handle->gpuCompositionDoneFence = glDoneFence;
3566 handle->compositorTiming = compositorTiming;
3567 }
3568
3569 // Update mFrameTracker.
3570 nsecs_t desiredPresentTime = mBufferInfo.mDesiredPresentTime;
3571 mFrameTracker.setDesiredPresentTime(desiredPresentTime);
3572
3573 const int32_t layerId = getSequence();
3574 mFlinger->mTimeStats->setDesiredTime(layerId, mCurrentFrameNumber, desiredPresentTime);
3575
3576 const auto outputLayer = findOutputLayerForDisplay(display);
3577 if (outputLayer && outputLayer->requiresClientComposition()) {
3578 nsecs_t clientCompositionTimestamp = outputLayer->getState().clientCompositionTimestamp;
3579 mFlinger->mFrameTracer->traceTimestamp(layerId, getCurrentBufferId(), mCurrentFrameNumber,
3580 clientCompositionTimestamp,
3581 FrameTracer::FrameEvent::FALLBACK_COMPOSITION);
3582 // Update the SurfaceFrames in the drawing state
3583 if (mDrawingState.bufferSurfaceFrameTX) {
3584 mDrawingState.bufferSurfaceFrameTX->setGpuComposition();
3585 }
3586 for (auto& [token, surfaceFrame] : mDrawingState.bufferlessSurfaceFramesTX) {
3587 surfaceFrame->setGpuComposition();
3588 }
3589 }
3590
3591 std::shared_ptr<FenceTime> frameReadyFence = mBufferInfo.mFenceTime;
3592 if (frameReadyFence->isValid()) {
3593 mFrameTracker.setFrameReadyFence(std::move(frameReadyFence));
3594 } else {
3595 // There was no fence for this frame, so assume that it was ready
3596 // to be presented at the desired present time.
3597 mFrameTracker.setFrameReadyTime(desiredPresentTime);
3598 }
3599
3600 if (display) {
Dominik Laskowskif8734e02022-08-26 09:06:59 -07003601 const Fps refreshRate = display->refreshRateConfigs().getActiveModePtr()->getFps();
Patrick Williamsbb25f802022-08-30 23:02:34 +00003602 const std::optional<Fps> renderRate =
3603 mFlinger->mScheduler->getFrameRateOverride(getOwnerUid());
3604
3605 const auto vote = frameRateToSetFrameRateVotePayload(mDrawingState.frameRate);
3606 const auto gameMode = getGameMode();
3607
3608 if (presentFence->isValid()) {
3609 mFlinger->mTimeStats->setPresentFence(layerId, mCurrentFrameNumber, presentFence,
3610 refreshRate, renderRate, vote, gameMode);
3611 mFlinger->mFrameTracer->traceFence(layerId, getCurrentBufferId(), mCurrentFrameNumber,
3612 presentFence,
3613 FrameTracer::FrameEvent::PRESENT_FENCE);
3614 mFrameTracker.setActualPresentFence(std::shared_ptr<FenceTime>(presentFence));
3615 } else if (const auto displayId = PhysicalDisplayId::tryCast(display->getId());
3616 displayId && mFlinger->getHwComposer().isConnected(*displayId)) {
Dominik Laskowskidc2bb802022-09-28 16:02:59 -04003617 // The HWC doesn't support present fences, so use the present timestamp instead.
3618 const nsecs_t presentTimestamp =
3619 mFlinger->getHwComposer().getPresentTimestamp(*displayId);
3620
3621 const nsecs_t now = systemTime(CLOCK_MONOTONIC);
3622 const nsecs_t vsyncPeriod = display->getVsyncPeriodFromHWC();
3623 const nsecs_t actualPresentTime = now - ((now - presentTimestamp) % vsyncPeriod);
3624
Patrick Williamsbb25f802022-08-30 23:02:34 +00003625 mFlinger->mTimeStats->setPresentTime(layerId, mCurrentFrameNumber, actualPresentTime,
3626 refreshRate, renderRate, vote, gameMode);
3627 mFlinger->mFrameTracer->traceTimestamp(layerId, getCurrentBufferId(),
3628 mCurrentFrameNumber, actualPresentTime,
3629 FrameTracer::FrameEvent::PRESENT_FENCE);
3630 mFrameTracker.setActualPresentTime(actualPresentTime);
3631 }
3632 }
3633
3634 mFrameTracker.advanceFrame();
3635 mBufferInfo.mFrameLatencyNeeded = false;
3636}
3637
3638bool Layer::latchBuffer(bool& recomputeVisibleRegions, nsecs_t latchTime) {
3639 ATRACE_FORMAT_INSTANT("latchBuffer %s - %" PRIu64, getDebugName(),
3640 getDrawingState().frameNumber);
3641
3642 bool refreshRequired = latchSidebandStream(recomputeVisibleRegions);
3643
3644 if (refreshRequired) {
3645 return refreshRequired;
3646 }
3647
3648 // If the head buffer's acquire fence hasn't signaled yet, return and
3649 // try again later
3650 if (!fenceHasSignaled()) {
3651 ATRACE_NAME("!fenceHasSignaled()");
3652 mFlinger->onLayerUpdate();
3653 return false;
3654 }
3655
3656 updateTexImage(latchTime);
3657 if (mDrawingState.buffer == nullptr) {
3658 return false;
3659 }
3660
3661 // Capture the old state of the layer for comparisons later
3662 BufferInfo oldBufferInfo = mBufferInfo;
3663 const bool oldOpacity = isOpaque(mDrawingState);
3664 mPreviousFrameNumber = mCurrentFrameNumber;
3665 mCurrentFrameNumber = mDrawingState.frameNumber;
3666 gatherBufferInfo();
3667
3668 if (oldBufferInfo.mBuffer == nullptr) {
3669 // the first time we receive a buffer, we need to trigger a
3670 // geometry invalidation.
3671 recomputeVisibleRegions = true;
3672 }
3673
3674 if ((mBufferInfo.mCrop != oldBufferInfo.mCrop) ||
3675 (mBufferInfo.mTransform != oldBufferInfo.mTransform) ||
3676 (mBufferInfo.mScaleMode != oldBufferInfo.mScaleMode) ||
3677 (mBufferInfo.mTransformToDisplayInverse != oldBufferInfo.mTransformToDisplayInverse)) {
3678 recomputeVisibleRegions = true;
3679 }
3680
3681 if (oldBufferInfo.mBuffer != nullptr) {
3682 uint32_t bufWidth = mBufferInfo.mBuffer->getWidth();
3683 uint32_t bufHeight = mBufferInfo.mBuffer->getHeight();
3684 if (bufWidth != oldBufferInfo.mBuffer->getWidth() ||
3685 bufHeight != oldBufferInfo.mBuffer->getHeight()) {
3686 recomputeVisibleRegions = true;
3687 }
3688 }
3689
3690 if (oldOpacity != isOpaque(mDrawingState)) {
3691 recomputeVisibleRegions = true;
3692 }
3693
3694 return true;
3695}
3696
3697bool Layer::hasReadyFrame() const {
3698 return hasFrameUpdate() || getSidebandStreamChanged() || getAutoRefresh();
3699}
3700
3701bool Layer::isProtected() const {
3702 return (mBufferInfo.mBuffer != nullptr) &&
3703 (mBufferInfo.mBuffer->getUsage() & GRALLOC_USAGE_PROTECTED);
3704}
3705
3706// As documented in libhardware header, formats in the range
3707// 0x100 - 0x1FF are specific to the HAL implementation, and
3708// are known to have no alpha channel
3709// TODO: move definition for device-specific range into
3710// hardware.h, instead of using hard-coded values here.
3711#define HARDWARE_IS_DEVICE_FORMAT(f) ((f) >= 0x100 && (f) <= 0x1FF)
3712
3713bool Layer::isOpaqueFormat(PixelFormat format) {
3714 if (HARDWARE_IS_DEVICE_FORMAT(format)) {
3715 return true;
3716 }
3717 switch (format) {
3718 case PIXEL_FORMAT_RGBA_8888:
3719 case PIXEL_FORMAT_BGRA_8888:
3720 case PIXEL_FORMAT_RGBA_FP16:
3721 case PIXEL_FORMAT_RGBA_1010102:
3722 case PIXEL_FORMAT_R_8:
3723 return false;
3724 }
3725 // in all other case, we have no blending (also for unknown formats)
3726 return true;
3727}
3728
3729bool Layer::needsFiltering(const DisplayDevice* display) const {
3730 if (!hasBufferOrSidebandStream()) {
3731 return false;
3732 }
3733 const auto outputLayer = findOutputLayerForDisplay(display);
3734 if (outputLayer == nullptr) {
3735 return false;
3736 }
3737
3738 // We need filtering if the sourceCrop rectangle size does not match the
3739 // displayframe rectangle size (not a 1:1 render)
3740 const auto& compositionState = outputLayer->getState();
3741 const auto displayFrame = compositionState.displayFrame;
3742 const auto sourceCrop = compositionState.sourceCrop;
3743 return sourceCrop.getHeight() != displayFrame.getHeight() ||
3744 sourceCrop.getWidth() != displayFrame.getWidth();
3745}
3746
3747bool Layer::needsFilteringForScreenshots(const DisplayDevice* display,
3748 const ui::Transform& inverseParentTransform) const {
3749 if (!hasBufferOrSidebandStream()) {
3750 return false;
3751 }
3752 const auto outputLayer = findOutputLayerForDisplay(display);
3753 if (outputLayer == nullptr) {
3754 return false;
3755 }
3756
3757 // We need filtering if the sourceCrop rectangle size does not match the
3758 // viewport rectangle size (not a 1:1 render)
3759 const auto& compositionState = outputLayer->getState();
3760 const ui::Transform& displayTransform = display->getTransform();
3761 const ui::Transform inverseTransform = inverseParentTransform * displayTransform.inverse();
3762 // Undo the transformation of the displayFrame so that we're back into
3763 // layer-stack space.
3764 const Rect frame = inverseTransform.transform(compositionState.displayFrame);
3765 const FloatRect sourceCrop = compositionState.sourceCrop;
3766
3767 int32_t frameHeight = frame.getHeight();
3768 int32_t frameWidth = frame.getWidth();
3769 // If the display transform had a rotational component then undo the
3770 // rotation so that the orientation matches the source crop.
3771 if (displayTransform.getOrientation() & ui::Transform::ROT_90) {
3772 std::swap(frameHeight, frameWidth);
3773 }
3774 return sourceCrop.getHeight() != frameHeight || sourceCrop.getWidth() != frameWidth;
3775}
3776
3777void Layer::latchAndReleaseBuffer() {
3778 if (hasReadyFrame()) {
3779 bool ignored = false;
3780 latchBuffer(ignored, systemTime());
3781 }
3782 releasePendingBuffer(systemTime());
3783}
3784
3785PixelFormat Layer::getPixelFormat() const {
3786 return mBufferInfo.mPixelFormat;
3787}
3788
3789bool Layer::getTransformToDisplayInverse() const {
3790 return mBufferInfo.mTransformToDisplayInverse;
3791}
3792
3793Rect Layer::getBufferCrop() const {
3794 // this is the crop rectangle that applies to the buffer
3795 // itself (as opposed to the window)
3796 if (!mBufferInfo.mCrop.isEmpty()) {
3797 // if the buffer crop is defined, we use that
3798 return mBufferInfo.mCrop;
3799 } else if (mBufferInfo.mBuffer != nullptr) {
3800 // otherwise we use the whole buffer
3801 return mBufferInfo.mBuffer->getBounds();
3802 } else {
3803 // if we don't have a buffer yet, we use an empty/invalid crop
3804 return Rect();
3805 }
3806}
3807
3808uint32_t Layer::getBufferTransform() const {
3809 return mBufferInfo.mTransform;
3810}
3811
3812ui::Dataspace Layer::getDataSpace() const {
3813 return mDrawingState.dataspaceRequested ? getRequestedDataSpace() : ui::Dataspace::UNKNOWN;
3814}
3815
3816ui::Dataspace Layer::getRequestedDataSpace() const {
3817 return hasBufferOrSidebandStream() ? mBufferInfo.mDataspace : mDrawingState.dataspace;
3818}
3819
3820ui::Dataspace Layer::translateDataspace(ui::Dataspace dataspace) {
3821 ui::Dataspace updatedDataspace = dataspace;
3822 // translate legacy dataspaces to modern dataspaces
3823 switch (dataspace) {
3824 case ui::Dataspace::SRGB:
3825 updatedDataspace = ui::Dataspace::V0_SRGB;
3826 break;
3827 case ui::Dataspace::SRGB_LINEAR:
3828 updatedDataspace = ui::Dataspace::V0_SRGB_LINEAR;
3829 break;
3830 case ui::Dataspace::JFIF:
3831 updatedDataspace = ui::Dataspace::V0_JFIF;
3832 break;
3833 case ui::Dataspace::BT601_625:
3834 updatedDataspace = ui::Dataspace::V0_BT601_625;
3835 break;
3836 case ui::Dataspace::BT601_525:
3837 updatedDataspace = ui::Dataspace::V0_BT601_525;
3838 break;
3839 case ui::Dataspace::BT709:
3840 updatedDataspace = ui::Dataspace::V0_BT709;
3841 break;
3842 default:
3843 break;
3844 }
3845
3846 return updatedDataspace;
3847}
3848
3849sp<GraphicBuffer> Layer::getBuffer() const {
3850 return mBufferInfo.mBuffer ? mBufferInfo.mBuffer->getBuffer() : nullptr;
3851}
3852
Patrick Williamsbb25f802022-08-30 23:02:34 +00003853void Layer::setTransformHint(ui::Transform::RotationFlags displayTransformHint) {
3854 mTransformHint = getFixedTransformHint();
3855 if (mTransformHint == ui::Transform::ROT_INVALID) {
3856 mTransformHint = displayTransformHint;
3857 }
Vishnu Nair71fcf912022-10-18 09:14:20 -07003858 mSkipReportingTransformHint = false;
Patrick Williamsbb25f802022-08-30 23:02:34 +00003859}
3860
3861const std::shared_ptr<renderengine::ExternalTexture>& Layer::getExternalTexture() const {
3862 return mBufferInfo.mBuffer;
3863}
3864
3865bool Layer::setColor(const half3& color) {
Vishnu Nairbbceb462022-10-10 04:52:13 +00003866 if (mDrawingState.color.rgb == color) {
Patrick Williamsbb25f802022-08-30 23:02:34 +00003867 return false;
3868 }
3869
3870 mDrawingState.sequence++;
Vishnu Nairbbceb462022-10-10 04:52:13 +00003871 mDrawingState.color.rgb = color;
Patrick Williamsbb25f802022-08-30 23:02:34 +00003872 mDrawingState.modified = true;
3873 setTransactionFlags(eTransactionNeeded);
3874 return true;
3875}
3876
3877bool Layer::fillsColor() const {
3878 return !hasBufferOrSidebandStream() && mDrawingState.color.r >= 0.0_hf &&
3879 mDrawingState.color.g >= 0.0_hf && mDrawingState.color.b >= 0.0_hf;
3880}
3881
3882bool Layer::hasBlur() const {
3883 return getBackgroundBlurRadius() > 0 || getDrawingState().blurRegions.size() > 0;
3884}
3885
Vishnu Nairba354102022-08-01 00:14:18 +00003886void Layer::updateSnapshot(bool updateGeometry) {
3887 if (!getCompositionEngineLayerFE()) {
3888 return;
3889 }
3890
Vishnu Nairbedb44b2022-08-02 21:47:40 +00003891 auto* snapshot = editLayerSnapshot();
Vishnu Nairba354102022-08-01 00:14:18 +00003892 if (updateGeometry) {
3893 prepareBasicGeometryCompositionState();
3894 prepareGeometryCompositionState();
Vishnu Nairbedb44b2022-08-02 21:47:40 +00003895 snapshot->roundedCorner = getRoundedCornerState();
3896 snapshot->stretchEffect = getStretchEffect();
3897 snapshot->transformedBounds = mScreenBounds;
3898 if (mEffectiveShadowRadius > 0.f) {
3899 snapshot->shadowSettings = mFlinger->mDrawingState.globalShadowSettings;
3900
3901 // Note: this preserves existing behavior of shadowing the entire layer and not cropping
3902 // it if transparent regions are present. This may not be necessary since shadows are
3903 // typically cast by layers without transparent regions.
3904 snapshot->shadowSettings.boundaries = mBounds;
3905
3906 const float casterAlpha = snapshot->alpha;
3907 const bool casterIsOpaque =
3908 ((mBufferInfo.mBuffer != nullptr) && isOpaque(mDrawingState));
3909
3910 // If the casting layer is translucent, we need to fill in the shadow underneath the
3911 // layer. Otherwise the generated shadow will only be shown around the casting layer.
3912 snapshot->shadowSettings.casterIsTranslucent = !casterIsOpaque || (casterAlpha < 1.0f);
3913 snapshot->shadowSettings.ambientColor *= casterAlpha;
3914 snapshot->shadowSettings.spotColor *= casterAlpha;
3915 }
3916 snapshot->shadowSettings.length = mEffectiveShadowRadius;
Vishnu Nairba354102022-08-01 00:14:18 +00003917 }
Vishnu Nairbedb44b2022-08-02 21:47:40 +00003918 snapshot->contentOpaque = isOpaque(mDrawingState);
3919 snapshot->isHdrY410 = isHdrY410();
3920 snapshot->bufferNeedsFiltering = bufferNeedsFiltering();
3921 sp<Layer> p = mDrawingParent.promote();
3922 if (p != nullptr) {
3923 snapshot->transform = p->getTransform();
3924 } else {
3925 snapshot->transform.reset();
3926 }
3927 snapshot->bufferSize = getBufferSize(mDrawingState);
3928 snapshot->externalTexture = mBufferInfo.mBuffer;
Vishnu Naire14c6b32022-08-06 04:20:15 +00003929 snapshot->hasReadyFrame = hasReadyFrame();
Vishnu Nairba354102022-08-01 00:14:18 +00003930 preparePerFrameCompositionState();
3931}
3932
Vishnu Naire14c6b32022-08-06 04:20:15 +00003933void Layer::updateChildrenSnapshots(bool updateGeometry) {
3934 for (const sp<Layer>& child : mDrawingChildren) {
3935 child->updateSnapshot(updateGeometry);
3936 child->updateChildrenSnapshots(updateGeometry);
3937 }
3938}
3939
Vishnu Nair0a4fb002022-08-08 02:40:42 +00003940void Layer::updateMetadataSnapshot(const LayerMetadata& parentMetadata) {
3941 mSnapshot->layerMetadata = parentMetadata;
3942 mSnapshot->layerMetadata.merge(mDrawingState.metadata);
3943 for (const sp<Layer>& child : mDrawingChildren) {
3944 child->updateMetadataSnapshot(mSnapshot->layerMetadata);
3945 }
3946}
3947
3948void Layer::updateRelativeMetadataSnapshot(const LayerMetadata& relativeLayerMetadata,
3949 std::unordered_set<Layer*>& visited) {
3950 if (visited.find(this) != visited.end()) {
3951 ALOGW("Cycle containing layer %s detected in z-order relatives", getDebugName());
3952 return;
3953 }
3954 visited.insert(this);
3955
3956 mSnapshot->relativeLayerMetadata = relativeLayerMetadata;
3957
3958 if (mDrawingState.zOrderRelatives.empty()) {
3959 return;
3960 }
3961 LayerMetadata childRelativeLayerMetadata = mSnapshot->relativeLayerMetadata;
3962 childRelativeLayerMetadata.merge(mSnapshot->layerMetadata);
3963 for (wp<Layer> weakRelative : mDrawingState.zOrderRelatives) {
3964 sp<Layer> relative = weakRelative.promote();
3965 if (!relative) {
3966 continue;
3967 }
3968 relative->updateRelativeMetadataSnapshot(childRelativeLayerMetadata, visited);
3969 }
3970}
3971
Patrick Williams377c0142022-10-13 17:33:38 +00003972LayerSnapshotGuard::LayerSnapshotGuard(Layer* layer) : mLayer(layer) {
3973 if (mLayer) {
3974 mLayer->mLayerFE->mSnapshot = std::move(mLayer->mSnapshot);
3975 }
3976}
3977
3978LayerSnapshotGuard::~LayerSnapshotGuard() {
3979 if (mLayer) {
3980 mLayer->mSnapshot = std::move(mLayer->mLayerFE->mSnapshot);
3981 }
3982}
3983
3984LayerSnapshotGuard::LayerSnapshotGuard(LayerSnapshotGuard&& other) : mLayer(other.mLayer) {
3985 other.mLayer = nullptr;
3986}
3987
3988LayerSnapshotGuard& LayerSnapshotGuard::operator=(LayerSnapshotGuard&& other) {
3989 mLayer = other.mLayer;
3990 other.mLayer = nullptr;
3991 return *this;
3992}
3993
Mathias Agopian13127d82013-03-05 17:47:11 -08003994// ---------------------------------------------------------------------------
3995
Marin Shalamanov46084422020-10-13 12:33:42 +02003996std::ostream& operator<<(std::ostream& stream, const Layer::FrameRate& rate) {
Dominik Laskowskif5d0ea52021-09-26 17:27:01 -07003997 return stream << "{rate=" << rate.rate << " type=" << ftl::enum_string(rate.type)
3998 << " seamlessness=" << ftl::enum_string(rate.seamlessness) << '}';
Marin Shalamanov46084422020-10-13 12:33:42 +02003999}
4000
Dominik Laskowskif5d0ea52021-09-26 17:27:01 -07004001} // namespace android
Mathias Agopian3f844832013-08-07 21:24:32 -07004002
4003#if defined(__gl_h_)
4004#error "don't include gl/gl.h in this file"
4005#endif
4006
4007#if defined(__gl2_h_)
4008#error "don't include gl2/gl2.h in this file"
4009#endif
Ady Abrahamb0dbdaa2020-01-06 16:19:42 -08004010
4011// TODO(b/129481165): remove the #pragma below and fix conversion issues
4012#pragma clang diagnostic pop // ignored "-Wconversion"