blob: f333d0a6f997f1b7780e4adf7de17cb4d9688f67 [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
17#ifndef ANDROID_LAYER_H
18#define ANDROID_LAYER_H
19
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080020#include <sys/types.h>
21
Lloyd Piquefeb73d72018-12-04 17:23:44 -080022#include <compositionengine/LayerFE.h>
Peiyong Lincbc184f2018-08-22 13:24:10 -070023#include <gui/BufferQueue.h>
24#include <gui/ISurfaceComposerClient.h>
25#include <gui/LayerState.h>
Robert Carr720e5062018-07-30 17:45:14 -070026#include <input/InputWindow.h>
Peiyong Lincbc184f2018-08-22 13:24:10 -070027#include <layerproto/LayerProtoHeader.h>
28#include <math/vec4.h>
29#include <renderengine/Mesh.h>
30#include <renderengine/Texture.h>
Dan Stoza80d61162017-12-20 15:57:52 -080031#include <ui/FloatRect.h>
Svetoslavd85084b2014-03-20 10:28:31 -070032#include <ui/FrameStats.h>
Mathias Agopian13127d82013-03-05 17:47:11 -080033#include <ui/GraphicBuffer.h>
34#include <ui/PixelFormat.h>
35#include <ui/Region.h>
Peiyong Linefefaac2018-08-17 12:27:51 -070036#include <ui/Transform.h>
Peiyong Lincbc184f2018-08-22 13:24:10 -070037#include <utils/RefBase.h>
38#include <utils/String8.h>
39#include <utils/Timers.h>
Mathias Agopian13127d82013-03-05 17:47:11 -080040
Robert Carrcdf83202018-03-07 12:48:34 -080041#include <cstdint>
Peiyong Lincbc184f2018-08-22 13:24:10 -070042#include <list>
Dominik Laskowski075d3172018-05-24 15:50:06 -070043#include <optional>
Peiyong Lincbc184f2018-08-22 13:24:10 -070044#include <vector>
Dan Stoza7dde5992015-05-22 09:51:44 -070045
Mathias Agopian13127d82013-03-05 17:47:11 -080046#include "Client.h"
David Sodman41fdfc92017-11-06 16:09:56 -080047#include "FrameTracker.h"
Robert Carr1f0a16a2016-10-24 16:27:39 -070048#include "LayerVector.h"
Dan Stozab9b08832014-03-13 11:55:57 -070049#include "MonitoredProducer.h"
Mathias Agopian13127d82013-03-05 17:47:11 -080050#include "SurfaceFlinger.h"
Marissa Walle2ffb422018-10-12 11:33:52 -070051#include "TransactionCompletedThread.h"
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080052
Lloyd Pique37c2c9b2018-12-04 17:25:10 -080053#include "DisplayHardware/ComposerHal.h"
Mathias Agopian13127d82013-03-05 17:47:11 -080054#include "DisplayHardware/HWComposer.h"
David Sodman41fdfc92017-11-06 16:09:56 -080055#include "RenderArea.h"
chaviw13fdc492017-06-27 12:40:18 -070056
chaviw1d044282017-09-27 12:19:28 -070057using namespace android::surfaceflinger;
58
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080059namespace android {
60
61// ---------------------------------------------------------------------------
62
Mathias Agopian1f7bec62010-06-25 18:02:21 -070063class Client;
Mathias Agopian3e25fd82013-04-22 17:52:16 +020064class Colorizer;
Mathias Agopian13127d82013-03-05 17:47:11 -080065class DisplayDevice;
66class GraphicBuffer;
67class SurfaceFlinger;
Kalle Raitaa099a242017-01-11 11:17:29 -080068class LayerDebugInfo;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080069
Lloyd Piquefeb73d72018-12-04 17:23:44 -080070namespace compositionengine {
71class Layer;
Lloyd Pique37c2c9b2018-12-04 17:25:10 -080072class OutputLayer;
Lloyd Piquefeb73d72018-12-04 17:23:44 -080073}
74
Lloyd Pique4dccc412018-01-22 17:21:36 -080075namespace impl {
76class SurfaceInterceptor;
77}
78
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080079// ---------------------------------------------------------------------------
80
Lloyd Pique42ab75e2018-09-12 20:46:03 -070081struct LayerCreationArgs {
82 LayerCreationArgs(SurfaceFlinger* flinger, const sp<Client>& client, const String8& name,
Evan Roskya1f1e152019-01-24 16:17:46 -080083 uint32_t w, uint32_t h, uint32_t flags, LayerMetadata metadata)
84 : flinger(flinger), client(client), name(name), w(w), h(h), flags(flags),
85 metadata(std::move(metadata)) {}
Lloyd Pique42ab75e2018-09-12 20:46:03 -070086
87 SurfaceFlinger* flinger;
88 const sp<Client>& client;
89 const String8& name;
90 uint32_t w;
91 uint32_t h;
92 uint32_t flags;
Evan Roskya1f1e152019-01-24 16:17:46 -080093 LayerMetadata metadata;
Lloyd Pique42ab75e2018-09-12 20:46:03 -070094};
95
Lloyd Piquefeb73d72018-12-04 17:23:44 -080096class Layer : public virtual compositionengine::LayerFE {
Lloyd Piquef1c675b2018-09-12 20:45:39 -070097 static std::atomic<int32_t> sSequence;
Mathias Agopian13127d82013-03-05 17:47:11 -080098
Mathias Agopiand606de62010-05-10 20:06:11 -070099public:
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700100 mutable bool contentDirty{false};
Mathias Agopian13127d82013-03-05 17:47:11 -0800101 // regions below are in window-manager space
102 Region visibleRegion;
103 Region coveredRegion;
104 Region visibleNonTransparentRegion;
Dan Stozaee44edd2015-03-23 15:50:23 -0700105 Region surfaceDamageRegion;
Andy McFadden4df87bd2014-04-21 18:08:54 -0700106
107 // Layer serial number. This gives layers an explicit ordering, so we
108 // have a stable sort order when their layer stack and Z-order are
109 // the same.
Lloyd Piquef1c675b2018-09-12 20:45:39 -0700110 int32_t sequence{sSequence++};
Mathias Agopian13127d82013-03-05 17:47:11 -0800111
112 enum { // flags for doTransaction()
113 eDontUpdateGeometryState = 0x00000001,
114 eVisibleRegion = 0x00000002,
Robert Carr720e5062018-07-30 17:45:14 -0700115 eInputInfoChanged = 0x00000004
Mathias Agopian13127d82013-03-05 17:47:11 -0800116 };
117
118 struct Geometry {
119 uint32_t w;
120 uint32_t h;
Peiyong Linefefaac2018-08-17 12:27:51 -0700121 ui::Transform transform;
Robert Carr3dcabfa2016-03-01 18:36:58 -0800122
David Sodman41fdfc92017-11-06 16:09:56 -0800123 inline bool operator==(const Geometry& rhs) const {
124 return (w == rhs.w && h == rhs.h) && (transform.tx() == rhs.transform.tx()) &&
Robert Carr99e27f02016-06-16 15:18:02 -0700125 (transform.ty() == rhs.transform.ty());
Mathias Agopian13127d82013-03-05 17:47:11 -0800126 }
David Sodman41fdfc92017-11-06 16:09:56 -0800127 inline bool operator!=(const Geometry& rhs) const { return !operator==(rhs); }
Mathias Agopian13127d82013-03-05 17:47:11 -0800128 };
129
Lucas Dupin1b6531c2018-07-05 17:18:21 -0700130 struct RoundedCornerState {
131 RoundedCornerState() = default;
132 RoundedCornerState(FloatRect cropRect, float radius)
133 : cropRect(cropRect), radius(radius) {}
134
135 // Rounded rectangle in local layer coordinate space.
136 FloatRect cropRect = FloatRect();
137 // Radius of the rounded rectangle.
138 float radius = 0.0f;
139 };
140
Mathias Agopian13127d82013-03-05 17:47:11 -0800141 struct State {
Marissa Wallf58c14b2018-07-24 10:50:43 -0700142 Geometry active_legacy;
143 Geometry requested_legacy;
Robert Carrae060832016-11-28 10:51:00 -0800144 int32_t z;
Fabien Sanglardf0c53d62017-03-03 18:58:50 -0800145
146 // The identifier of the layer stack this layer belongs to. A layer can
147 // only be associated to a single layer stack. A layer stack is a
148 // z-ordered group of layers which can be associated to one or more
149 // displays. Using the same layer stack on different displays is a way
150 // to achieve mirroring.
Mathias Agopian13127d82013-03-05 17:47:11 -0800151 uint32_t layerStack;
Fabien Sanglardf0c53d62017-03-03 18:58:50 -0800152
Mathias Agopian13127d82013-03-05 17:47:11 -0800153 uint8_t flags;
154 uint8_t reserved[2];
155 int32_t sequence; // changes when visible regions can change
Dan Stoza7dde5992015-05-22 09:51:44 -0700156 bool modified;
157
Fabien Sanglard4ed383c2016-12-13 14:02:41 -0800158 // Crop is expressed in layer space coordinate.
Marissa Wallf58c14b2018-07-24 10:50:43 -0700159 Rect crop_legacy;
160 Rect requestedCrop_legacy;
Robert Carr99e27f02016-06-16 15:18:02 -0700161
Robert Carr0d480722017-01-10 16:42:54 -0800162 // If set, defers this state update until the identified Layer
Dan Stoza7dde5992015-05-22 09:51:44 -0700163 // receives a frame with the given frameNumber
Marissa Wallf58c14b2018-07-24 10:50:43 -0700164 wp<Layer> barrierLayer_legacy;
165 uint64_t frameNumber_legacy;
Dan Stoza7dde5992015-05-22 09:51:44 -0700166
Mathias Agopian2ca79392013-04-02 18:30:32 -0700167 // the transparentRegion hint is a bit special, it's latched only
168 // when we receive a buffer -- this is because it's "content"
169 // dependent.
Marissa Wallf58c14b2018-07-24 10:50:43 -0700170 Region activeTransparentRegion_legacy;
171 Region requestedTransparentRegion_legacy;
Daniel Nicoara2f5f8a52016-12-20 16:11:58 -0500172
Evan Rosky1f6d6d52018-12-06 10:47:26 -0800173 LayerMetadata metadata;
Robert Carrdb66e622017-04-10 16:55:57 -0700174
175 // If non-null, a Surface this Surface's Z-order is interpreted relative to.
176 wp<Layer> zOrderRelativeOf;
177
178 // A list of surfaces whose Z-order is interpreted relative to ours.
179 SortedVector<wp<Layer>> zOrderRelatives;
chaviw13fdc492017-06-27 12:40:18 -0700180
181 half4 color;
Lucas Dupin1b6531c2018-07-05 17:18:21 -0700182 float cornerRadius;
Marissa Wall61c58622018-07-18 10:12:20 -0700183
Robert Carr720e5062018-07-30 17:45:14 -0700184 bool inputInfoChanged;
185 InputWindowInfo inputInfo;
186
Valerie Haub153bab2019-03-05 10:47:28 -0800187 // dataspace is only used by BufferStateLayer and ColorLayer
188 ui::Dataspace dataspace;
189
Marissa Wall61c58622018-07-18 10:12:20 -0700190 // The fields below this point are only used by BufferStateLayer
191 Geometry active;
192
193 uint32_t transform;
194 bool transformToDisplayInverse;
195
196 Rect crop;
197 Region transparentRegionHint;
198
199 sp<GraphicBuffer> buffer;
200 sp<Fence> acquireFence;
Marissa Wall61c58622018-07-18 10:12:20 -0700201 HdrMetadata hdrMetadata;
202 Region surfaceDamageRegion;
203 int32_t api;
204
205 sp<NativeHandle> sidebandStream;
Peiyong Lind3788632018-09-18 16:01:31 -0700206 mat4 colorTransform;
Peiyong Lin747321c2018-10-01 10:03:11 -0700207 bool hasColorTransform;
Marissa Walle2ffb422018-10-12 11:33:52 -0700208
Valerie Haua72e2812019-01-23 13:40:39 -0800209 // pointer to background color layer that, if set, appears below the buffer state layer
210 // and the buffer state layer's children. Z order will be set to
211 // INT_MIN
212 sp<Layer> bgColorLayer;
Valerie Haued54efa2019-01-11 20:03:14 -0800213
Marissa Walle2ffb422018-10-12 11:33:52 -0700214 // The deque of callback handles for this frame. The back of the deque contains the most
215 // recent callback handle.
216 std::deque<sp<CallbackHandle>> callbackHandles;
Peiyong Linc502cb72019-03-01 15:00:23 -0800217 bool colorSpaceAgnostic;
Mathias Agopian13127d82013-03-05 17:47:11 -0800218 };
219
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700220 explicit Layer(const LayerCreationArgs& args);
Mathias Agopianb7e930d2010-06-01 15:12:58 -0700221 virtual ~Layer();
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800222
Chia-I Wuab0c3192017-08-01 11:29:00 -0700223 void setPrimaryDisplayOnly() { mPrimaryDisplayOnly = true; }
Lloyd Piqueef36b002019-01-23 17:52:04 -0800224 bool getPrimaryDisplayOnly() const { return mPrimaryDisplayOnly; }
Chia-I Wuab0c3192017-08-01 11:29:00 -0700225
Robert Carr7bf247e2017-05-18 14:02:49 -0700226 // ------------------------------------------------------------------------
227 // Geometry setting functions.
228 //
229 // The following group of functions are used to specify the layers
230 // bounds, and the mapping of the texture on to those bounds. According
231 // to various settings changes to them may apply immediately, or be delayed until
232 // a pending resize is completed by the producer submitting a buffer. For example
233 // if we were to change the buffer size, and update the matrix ahead of the
234 // new buffer arriving, then we would be stretching the buffer to a different
235 // aspect before and after the buffer arriving, which probably isn't what we wanted.
236 //
237 // The first set of geometry functions are controlled by the scaling mode, described
238 // in window.h. The scaling mode may be set by the client, as it submits buffers.
239 // This value may be overriden through SurfaceControl, with setOverrideScalingMode.
240 //
241 // Put simply, if our scaling mode is SCALING_MODE_FREEZE, then
242 // matrix updates will not be applied while a resize is pending
243 // and the size and transform will remain in their previous state
244 // until a new buffer is submitted. If the scaling mode is another value
245 // then the old-buffer will immediately be scaled to the pending size
246 // and the new matrix will be immediately applied following this scaling
247 // transformation.
Robert Carr8d5227b2017-03-16 15:41:03 -0700248
Robert Carr7bf247e2017-05-18 14:02:49 -0700249 // Set the default buffer size for the assosciated Producer, in pixels. This is
250 // also the rendered size of the layer prior to any transformations. Parent
251 // or local matrix transformations will not affect the size of the buffer,
252 // but may affect it's on-screen size or clipping.
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800253 virtual bool setSize(uint32_t w, uint32_t h);
Robert Carr7bf247e2017-05-18 14:02:49 -0700254 // Set a 2x2 transformation matrix on the layer. This transform
255 // will be applied after parent transforms, but before any final
256 // producer specified transform.
Marissa Wall61c58622018-07-18 10:12:20 -0700257 virtual bool setMatrix(const layer_state_t::matrix22_t& matrix,
258 bool allowNonRectPreservingTransforms);
Robert Carr7bf247e2017-05-18 14:02:49 -0700259
260 // This second set of geometry attributes are controlled by
261 // setGeometryAppliesWithResize, and their default mode is to be
262 // immediate. If setGeometryAppliesWithResize is specified
263 // while a resize is pending, then update of these attributes will
264 // be delayed until the resize completes.
265
266 // setPosition operates in parent buffer space (pre parent-transform) or display
267 // space for top-level layers.
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800268 virtual bool setPosition(float x, float y, bool immediate);
Robert Carr7bf247e2017-05-18 14:02:49 -0700269 // Buffer space
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800270 virtual bool setCrop_legacy(const Rect& crop, bool immediate);
Robert Carr8d5227b2017-03-16 15:41:03 -0700271
Robert Carr7bf247e2017-05-18 14:02:49 -0700272 // TODO(b/38182121): Could we eliminate the various latching modes by
273 // using the layer hierarchy?
274 // -----------------------------------------------------------------------
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800275 virtual bool setLayer(int32_t z);
276 virtual bool setRelativeLayer(const sp<IBinder>& relativeToHandle, int32_t relativeZ);
Robert Carrdb66e622017-04-10 16:55:57 -0700277
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800278 virtual bool setAlpha(float alpha);
Valerie Haudd0b7572019-01-29 14:59:27 -0800279 virtual bool setColor(const half3& /*color*/) { return false; };
Lucas Dupin1b6531c2018-07-05 17:18:21 -0700280
281 // Set rounded corner radius for this layer and its children.
282 //
283 // We only support 1 radius per layer in the hierarchy, where parent layers have precedence.
284 // The shape of the rounded corner rectangle is specified by the crop rectangle of the layer
285 // from which we inferred the rounded corner radius.
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800286 virtual bool setCornerRadius(float cornerRadius);
287 virtual bool setTransparentRegionHint(const Region& transparent);
288 virtual bool setFlags(uint8_t flags, uint8_t mask);
289 virtual bool setLayerStack(uint32_t layerStack);
290 virtual uint32_t getLayerStack() const;
Marissa Wall61c58622018-07-18 10:12:20 -0700291 virtual void deferTransactionUntil_legacy(const sp<IBinder>& barrierHandle,
292 uint64_t frameNumber);
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800293 virtual void deferTransactionUntil_legacy(const sp<Layer>& barrierLayer, uint64_t frameNumber);
294 virtual bool setOverrideScalingMode(int32_t overrideScalingMode);
Evan Roskyef876c92019-01-25 17:46:06 -0800295 virtual bool setMetadata(const LayerMetadata& data);
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800296 virtual bool reparentChildren(const sp<IBinder>& layer);
Marissa Wall61c58622018-07-18 10:12:20 -0700297 virtual void setChildrenDrawingParent(const sp<Layer>& layer);
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800298 virtual bool reparent(const sp<IBinder>& newParentHandle);
Marissa Wall61c58622018-07-18 10:12:20 -0700299 virtual bool detachChildren();
chaviw5aedec92018-10-22 10:40:38 -0700300 bool attachChildren();
301 bool isLayerDetached() const { return mLayerDetached; }
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800302 virtual bool setColorTransform(const mat4& matrix);
303 virtual mat4 getColorTransform() const;
304 virtual bool hasColorTransform() const;
Peiyong Linc502cb72019-03-01 15:00:23 -0800305 virtual bool isColorSpaceAgnostic() const { return mDrawingState.colorSpaceAgnostic; }
Marissa Wall61c58622018-07-18 10:12:20 -0700306
307 // Used only to set BufferStateLayer state
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800308 virtual bool setTransform(uint32_t /*transform*/) { return false; };
309 virtual bool setTransformToDisplayInverse(bool /*transformToDisplayInverse*/) { return false; };
310 virtual bool setCrop(const Rect& /*crop*/) { return false; };
311 virtual bool setFrame(const Rect& /*frame*/) { return false; };
312 virtual bool setBuffer(const sp<GraphicBuffer>& /*buffer*/) { return false; };
313 virtual bool setAcquireFence(const sp<Fence>& /*fence*/) { return false; };
314 virtual bool setDataspace(ui::Dataspace /*dataspace*/) { return false; };
315 virtual bool setHdrMetadata(const HdrMetadata& /*hdrMetadata*/) { return false; };
316 virtual bool setSurfaceDamageRegion(const Region& /*surfaceDamage*/) { return false; };
317 virtual bool setApi(int32_t /*api*/) { return false; };
318 virtual bool setSidebandStream(const sp<NativeHandle>& /*sidebandStream*/) { return false; };
Marissa Walle2ffb422018-10-12 11:33:52 -0700319 virtual bool setTransactionCompletedListeners(
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800320 const std::vector<sp<CallbackHandle>>& /*handles*/) {
Marissa Walle2ffb422018-10-12 11:33:52 -0700321 return false;
322 };
Valerie Haudd0b7572019-01-29 14:59:27 -0800323 virtual bool setBackgroundColor(const half3& color, float alpha, ui::Dataspace dataspace);
Peiyong Linc502cb72019-03-01 15:00:23 -0800324 virtual bool setColorSpaceAgnostic(const bool agnostic);
Mathias Agopian13127d82013-03-05 17:47:11 -0800325
Chia-I Wu01591c92018-05-22 12:03:00 -0700326 ui::Dataspace getDataSpace() const { return mCurrentDataSpace; }
327
Peiyong Lindd9b2ae2018-03-01 16:22:45 -0800328 // Before color management is introduced, contents on Android have to be
329 // desaturated in order to match what they appears like visually.
330 // With color management, these contents will appear desaturated, thus
331 // needed to be saturated so that they match what they are designed for
Chia-I Wu11481472018-05-04 10:43:19 -0700332 // visually.
333 bool isLegacyDataSpace() const;
Peiyong Lindd9b2ae2018-03-01 16:22:45 -0800334
Lloyd Piquefeb73d72018-12-04 17:23:44 -0800335 virtual std::shared_ptr<compositionengine::Layer> getCompositionLayer() const;
336
Dan Stozaee44edd2015-03-23 15:50:23 -0700337 // If we have received a new buffer this frame, we will pass its surface
338 // damage down to hardware composer. Otherwise, we must send a region with
339 // one empty rect.
Robert Carr105e64b2018-03-07 12:47:50 -0800340 virtual void useSurfaceDamage() {}
341 virtual void useEmptyDamage() {}
Dan Stozaee44edd2015-03-23 15:50:23 -0700342
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800343 uint32_t getTransactionFlags() const { return mTransactionFlags; }
344 uint32_t getTransactionFlags(uint32_t flags);
345 uint32_t setTransactionFlags(uint32_t flags);
Mathias Agopian13127d82013-03-05 17:47:11 -0800346
Lloyd Piqueef36b002019-01-23 17:52:04 -0800347 // Deprecated, please use compositionengine::Output::belongsInOutput()
348 // instead.
349 // TODO(lpique): Move the remaining callers (screencap) to the new function.
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800350 bool belongsToDisplay(uint32_t layerStack, bool isPrimaryDisplay) const {
Chia-I Wuab0c3192017-08-01 11:29:00 -0700351 return getLayerStack() == layerStack && (!mPrimaryDisplayOnly || isPrimaryDisplay);
352 }
353
Peiyong Lin833074a2018-08-28 11:53:54 -0700354 void computeGeometry(const RenderArea& renderArea, renderengine::Mesh& mesh,
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800355 bool useIdentityTransform) const;
Vishnu Nair4351ad52019-02-11 14:13:02 -0800356 FloatRect getBounds(const Region& activeTransparentRegion) const;
357 FloatRect getBounds() const;
358
359 // Compute bounds for the layer and cache the results.
360 void computeBounds(FloatRect parentBounds, ui::Transform parentTransform);
361
Vishnu Nairc652ff82019-03-15 12:48:54 -0700362 // Returns the buffer scale transform if a scaling mode is set.
363 ui::Transform getBufferScaleTransform() const;
364
Vishnu Nair4351ad52019-02-11 14:13:02 -0800365 // Get effective layer transform, taking into account all its parent transform with any
366 // scaling if the parent scaling more is not NATIVE_WINDOW_SCALING_MODE_FREEZE.
Vishnu Nairc652ff82019-03-15 12:48:54 -0700367 ui::Transform getTransformWithScale(const ui::Transform& bufferScaleTransform) const;
368
369 // Returns the bounds of the layer without any buffer scaling.
370 FloatRect getBoundsPreScaling(const ui::Transform& bufferScaleTransform) const;
Mathias Agopian13127d82013-03-05 17:47:11 -0800371
Pablo Ceballos40845df2016-01-25 17:41:15 -0800372 int32_t getSequence() const { return sequence; }
373
Mathias Agopian13127d82013-03-05 17:47:11 -0800374 // -----------------------------------------------------------------------
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700375 // Virtuals
David Sodman0c69cad2017-08-21 12:12:51 -0700376 virtual const char* getTypeId() const = 0;
Mathias Agopian13127d82013-03-05 17:47:11 -0800377
Mathias Agopian13127d82013-03-05 17:47:11 -0800378 /*
379 * isOpaque - true if this surface is opaque
Andy McFadden4125a4f2014-01-29 17:17:11 -0800380 *
381 * This takes into account the buffer format (i.e. whether or not the
382 * pixel format includes an alpha channel) and the "opaque" flag set
383 * on the layer. It does not examine the current plane alpha value.
Mathias Agopian13127d82013-03-05 17:47:11 -0800384 */
Robert Carr105e64b2018-03-07 12:47:50 -0800385 virtual bool isOpaque(const Layer::State&) const { return false; }
Mathias Agopian13127d82013-03-05 17:47:11 -0800386
387 /*
388 * isSecure - true if this surface is secure, that is if it prevents
389 * screenshots or VNC servers.
390 */
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800391 bool isSecure() const;
Mathias Agopian13127d82013-03-05 17:47:11 -0800392
393 /*
394 * isVisible - true if this layer is visible, false otherwise
395 */
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800396 virtual bool isVisible() const = 0;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800397
Mathias Agopian13127d82013-03-05 17:47:11 -0800398 /*
Robert Carr1f0a16a2016-10-24 16:27:39 -0700399 * isHiddenByPolicy - true if this layer has been forced invisible.
400 * just because this is false, doesn't mean isVisible() is true.
401 * For example if this layer has no active buffer, it may not be hidden by
402 * policy, but it still can not be visible.
403 */
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800404 bool isHiddenByPolicy() const;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700405
406 /*
chaviw3e727cd2019-01-31 13:41:05 -0800407 * Returns whether this layer can receive input.
408 */
409 virtual bool canReceiveInput() const;
410
411 /*
Peiyong Linfb530cf2018-12-15 05:07:38 +0000412 * isProtected - true if the layer may contain protected content in the
413 * GRALLOC_USAGE_PROTECTED sense.
414 */
415 virtual bool isProtected() const { return false; }
416
417 /*
Mathias Agopian13127d82013-03-05 17:47:11 -0800418 * isFixedSize - true if content has a fixed size
419 */
Robert Carr105e64b2018-03-07 12:47:50 -0800420 virtual bool isFixedSize() const { return true; }
421
Dan Stoza436ccf32018-06-21 12:10:12 -0700422 // Most layers aren't created from the main thread, and therefore need to
423 // grab the SF state lock to access HWC, but ContainerLayer does, so we need
424 // to avoid grabbing the lock again to avoid deadlock
425 virtual bool isCreatedFromMainThread() const { return false; }
426
Robert Carr2e102c92018-10-23 12:11:15 -0700427 bool isRemovedFromCurrentState() const;
chaviw8b3871a2017-11-01 17:41:01 -0700428
David Sodman41fdfc92017-11-06 16:09:56 -0800429 void writeToProto(LayerProto* layerInfo,
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800430 LayerVector::StateSet stateSet = LayerVector::StateSet::Drawing);
chaviw1d044282017-09-27 12:19:28 -0700431
Lloyd Pique37c2c9b2018-12-04 17:25:10 -0800432 void writeToProto(LayerProto* layerInfo, const sp<DisplayDevice>& displayDevice);
Yiwei Zhang7124ad32018-02-21 13:02:45 -0800433
Marissa Wall61c58622018-07-18 10:12:20 -0700434 virtual Geometry getActiveGeometry(const Layer::State& s) const { return s.active_legacy; }
435 virtual uint32_t getActiveWidth(const Layer::State& s) const { return s.active_legacy.w; }
436 virtual uint32_t getActiveHeight(const Layer::State& s) const { return s.active_legacy.h; }
Peiyong Linefefaac2018-08-17 12:27:51 -0700437 virtual ui::Transform getActiveTransform(const Layer::State& s) const {
Marissa Wall61c58622018-07-18 10:12:20 -0700438 return s.active_legacy.transform;
439 }
440 virtual Region getActiveTransparentRegion(const Layer::State& s) const {
441 return s.activeTransparentRegion_legacy;
442 }
443 virtual Rect getCrop(const Layer::State& s) const { return s.crop_legacy; }
Marissa Wall61c58622018-07-18 10:12:20 -0700444
Valerie Haubc6ddb12019-03-08 11:10:15 -0800445 virtual void setPostTime(nsecs_t /*postTime*/) {}
446 virtual void setDesiredPresentTime(nsecs_t /*desiredPresentTime*/) {}
447
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700448protected:
Alec Mourie7d1d4a2019-02-05 01:13:46 +0000449 virtual bool prepareClientLayer(const RenderArea& renderArea, const Region& clip,
450 bool useIdentityTransform, Region& clearRegion,
Peiyong Lin8f28a1d2019-02-07 17:25:12 -0800451 const bool supportProtectedContent,
452 renderengine::LayerSettings& layer);
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700453
454public:
Lloyd Piquecb54b3b2019-01-29 18:42:54 -0800455 /*
456 * compositionengine::LayerFE overrides
457 */
458 void onLayerDisplayed(const sp<Fence>& releaseFence) override;
459
Robert Carr105e64b2018-03-07 12:47:50 -0800460 virtual void setDefaultBufferSize(uint32_t /*w*/, uint32_t /*h*/) {}
David Sodmaneb085e02017-10-05 18:49:04 -0700461
Chia-I Wu692e0832018-06-05 15:46:58 -0700462 virtual bool isHdrY410() const { return false; }
463
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800464 void setGeometry(const sp<const DisplayDevice>& display, uint32_t z);
Lloyd Pique37c2c9b2018-12-04 17:25:10 -0800465 void forceClientComposition(const sp<DisplayDevice>& display);
466 bool getForceClientComposition(const sp<DisplayDevice>& display);
467 virtual void setPerFrameData(const sp<const DisplayDevice>& display,
468 const ui::Transform& transform, const Rect& viewport,
Peiyong Linc502cb72019-03-01 15:00:23 -0800469 int32_t supportedPerFrameMetadata,
470 const ui::Dataspace targetDataspace) = 0;
Dan Stoza9e56aa02015-11-02 13:00:03 -0800471
472 // callIntoHwc exists so we can update our local state and call
473 // acceptDisplayChanges without unnecessarily updating the device's state
Lloyd Pique37c2c9b2018-12-04 17:25:10 -0800474 void setCompositionType(const sp<const DisplayDevice>& display,
475 Hwc2::IComposerClient::Composition type);
476 Hwc2::IComposerClient::Composition getCompositionType(
477 const sp<const DisplayDevice>& display) const;
478 bool getClearClientTarget(const sp<const DisplayDevice>& display) const;
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800479 void updateCursorPosition(const sp<const DisplayDevice>& display);
Riley Andrews03414a12014-07-01 14:22:59 -0700480
Ana Krulec010d2192018-10-08 06:29:54 -0700481 virtual bool shouldPresentNow(nsecs_t /*expectedPresentTime*/) const { return false; }
Robert Carr105e64b2018-03-07 12:47:50 -0800482 virtual void setTransformHint(uint32_t /*orientation*/) const { }
Dan Stoza6b9454d2014-11-07 16:00:59 -0800483
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700484 /*
485 * called before composition.
486 * returns true if the layer has pending updates.
487 */
Ady Abraham0d028792018-11-06 16:26:51 -0800488 virtual bool onPreComposition(nsecs_t refreshStartTime) = 0;
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700489
490 /*
Dan Stozae77c7662016-05-13 11:37:28 -0700491 * called after composition.
492 * returns true if the layer latched a new buffer this frame.
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700493 */
Dominik Laskowski075d3172018-05-24 15:50:06 -0700494 virtual bool onPostComposition(const std::optional<DisplayId>& /*displayId*/,
495 const std::shared_ptr<FenceTime>& /*glDoneFence*/,
Robert Carr105e64b2018-03-07 12:47:50 -0800496 const std::shared_ptr<FenceTime>& /*presentFence*/,
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800497 const CompositorTiming& /*compositorTiming*/) {
Robert Carr105e64b2018-03-07 12:47:50 -0800498 return false;
499 }
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700500
Dan Stoza9e56aa02015-11-02 13:00:03 -0800501 // If a buffer was replaced this frame, release the former buffer
Robert Carr105e64b2018-03-07 12:47:50 -0800502 virtual void releasePendingBuffer(nsecs_t /*dequeueReadyTime*/) { }
503
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700504 /*
Alec Mourie7d1d4a2019-02-05 01:13:46 +0000505 * prepareClientLayer - populates a renderengine::LayerSettings to passed to
506 * RenderEngine::drawLayers. Returns true if the layer can be used, and
507 * false otherwise.
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700508 */
Alec Mourie7d1d4a2019-02-05 01:13:46 +0000509 bool prepareClientLayer(const RenderArea& renderArea, const Region& clip, Region& clearRegion,
Peiyong Lin8f28a1d2019-02-07 17:25:12 -0800510 const bool supportProtectedContent, renderengine::LayerSettings& layer);
Alec Mourie7d1d4a2019-02-05 01:13:46 +0000511 bool prepareClientLayer(const RenderArea& renderArea, bool useIdentityTransform,
Peiyong Lin8f28a1d2019-02-07 17:25:12 -0800512 Region& clearRegion, const bool supportProtectedContent,
513 renderengine::LayerSettings& layer);
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700514
515 /*
516 * doTransaction - process the transaction. This is a good place to figure
517 * out which attributes of the surface have changed.
518 */
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800519 uint32_t doTransaction(uint32_t transactionFlags);
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700520
521 /*
522 * setVisibleRegion - called to set the new visible region. This gives
523 * a chance to update the new visible region or record the fact it changed.
524 */
525 void setVisibleRegion(const Region& visibleRegion);
526
527 /*
528 * setCoveredRegion - called when the covered region changes. The covered
529 * region corresponds to any area of the surface that is covered
530 * (transparently or not) by another surface.
531 */
532 void setCoveredRegion(const Region& coveredRegion);
533
534 /*
535 * setVisibleNonTransparentRegion - called when the visible and
536 * non-transparent region changes.
537 */
David Sodman41fdfc92017-11-06 16:09:56 -0800538 void setVisibleNonTransparentRegion(const Region& visibleNonTransparentRegion);
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700539
540 /*
Robert Carre5f4f692018-01-12 13:12:28 -0800541 * Clear the visible, covered, and non-transparent regions.
542 */
543 void clearVisibilityRegions();
544
545 /*
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700546 * latchBuffer - called each time the screen is redrawn and returns whether
547 * the visible regions need to be recomputed (this is a fairly heavy
548 * operation, so this should be set only if needed). Typically this is used
549 * to figure out if the content or size of a surface has changed.
550 */
Alec Mouri56e538f2019-01-14 15:22:01 -0800551 virtual bool latchBuffer(bool& /*recomputeVisibleRegions*/, nsecs_t /*latchTime*/) {
Robert Carr105e64b2018-03-07 12:47:50 -0800552 return {};
553 }
554
555 virtual bool isBufferLatched() const { return false; }
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700556
Mathias Agopian13127d82013-03-05 17:47:11 -0800557 /*
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800558 * called with the state lock from a binder thread when the layer is
Chia-I Wuc6657022017-08-15 11:18:17 -0700559 * removed from the current list to the pending removal list
560 */
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800561 void onRemovedFromCurrentState();
Chia-I Wuc6657022017-08-15 11:18:17 -0700562
chaviw61626f22018-11-15 16:26:27 -0800563 /*
564 * Called when the layer is added back to the current state list.
565 */
566 void addToCurrentState();
567
Andy McFaddenbf974ab2012-12-04 16:51:15 -0800568 // Updates the transform hint in our SurfaceFlingerConsumer to match
Mathias Agopian84300952012-11-21 16:02:13 -0800569 // the current orientation of the display device.
Dominik Laskowskia2edf612018-06-01 13:15:16 -0700570 void updateTransformHint(const sp<const DisplayDevice>& display) const;
Andy McFadden69052052012-09-14 16:10:11 -0700571
Mathias Agopian13127d82013-03-05 17:47:11 -0800572 /*
573 * returns the rectangle that crops the content of the layer and scales it
574 * to the layer's size.
575 */
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700576 Rect getContentCrop() const;
Mathias Agopian13127d82013-03-05 17:47:11 -0800577
Eric Penner51c59cd2014-07-28 19:51:58 -0700578 /*
Marissa Wallfd668622018-05-10 10:21:13 -0700579 * Returns if a frame is ready
Eric Penner51c59cd2014-07-28 19:51:58 -0700580 */
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800581 virtual bool hasReadyFrame() const { return false; }
Eric Penner51c59cd2014-07-28 19:51:58 -0700582
Marissa Wallfd668622018-05-10 10:21:13 -0700583 virtual int32_t getQueuedFrameCount() const { return 0; }
Kalle Raitaa099a242017-01-11 11:17:29 -0800584
Dan Stoza9e56aa02015-11-02 13:00:03 -0800585 // -----------------------------------------------------------------------
586
Lloyd Pique37c2c9b2018-12-04 17:25:10 -0800587 bool hasHwcLayer(const sp<const DisplayDevice>& displayDevice);
588 HWC2::Layer* getHwcLayer(const sp<const DisplayDevice>& displayDevice);
David Sodmanba340492018-08-05 21:51:33 -0700589
Mathias Agopian13127d82013-03-05 17:47:11 -0800590 // -----------------------------------------------------------------------
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800591 void clearWithOpenGL(const RenderArea& renderArea) const;
Mathias Agopian13127d82013-03-05 17:47:11 -0800592
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800593 inline const State& getDrawingState() const { return mDrawingState; }
594 inline const State& getCurrentState() const { return mCurrentState; }
595 inline State& getCurrentState() { return mCurrentState; }
Mathias Agopian13127d82013-03-05 17:47:11 -0800596
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800597 LayerDebugInfo getLayerDebugInfo() const;
Mathias Agopian13127d82013-03-05 17:47:11 -0800598
599 /* always call base class first */
Yiwei Zhang5434a782018-12-05 18:06:32 -0800600 static void miniDumpHeader(std::string& result);
Lloyd Pique37c2c9b2018-12-04 17:25:10 -0800601 void miniDump(std::string& result, const sp<DisplayDevice>& display) const;
Yiwei Zhang5434a782018-12-05 18:06:32 -0800602 void dumpFrameStats(std::string& result) const;
603 void dumpFrameEvents(std::string& result);
Svetoslavd85084b2014-03-20 10:28:31 -0700604 void clearFrameStats();
Jamie Gennis6547ff42013-07-16 20:12:42 -0700605 void logFrameStats();
Svetoslavd85084b2014-03-20 10:28:31 -0700606 void getFrameStats(FrameStats* outStats) const;
Mathias Agopian1b5e1022010-04-20 17:55:49 -0700607
Robert Carr105e64b2018-03-07 12:47:50 -0800608 virtual std::vector<OccupancyTracker::Segment> getOccupancyHistory(bool /*forceFlush*/) {
609 return {};
610 }
Dan Stozae77c7662016-05-13 11:37:28 -0700611
Brian Anderson5ea5e592016-12-01 16:54:33 -0800612 void onDisconnect();
Brian Anderson3890c392016-07-25 12:48:08 -0700613 void addAndGetFrameTimestamps(const NewFrameEventsEntry* newEntry,
David Sodman41fdfc92017-11-06 16:09:56 -0800614 FrameEventHistoryDelta* outDelta);
Pablo Ceballosce796e72016-02-04 19:10:51 -0800615
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800616 virtual bool getTransformToDisplayInverse() const { return false; }
Robert Carr367c5682016-06-20 11:55:28 -0700617
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800618 ui::Transform getTransform() const;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700619
Robert Carr6452f122017-03-21 10:41:29 -0700620 // Returns the Alpha of the Surface, accounting for the Alpha
621 // of parent Surfaces in the hierarchy (alpha's will be multiplied
622 // down the hierarchy).
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800623 half getAlpha() const;
624 half4 getColor() const;
Robert Carr6452f122017-03-21 10:41:29 -0700625
Lucas Dupin1b6531c2018-07-05 17:18:21 -0700626 // Returns how rounded corners should be drawn for this layer.
627 // This will traverse the hierarchy until it reaches its root, finding topmost rounded
628 // corner definition and converting it into current layer's coordinates.
629 // As of now, only 1 corner radius per display list is supported. Subsequent ones will be
630 // ignored.
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800631 RoundedCornerState getRoundedCornerState() const;
Lucas Dupin1b6531c2018-07-05 17:18:21 -0700632
Dan Stoza412903f2017-04-27 13:42:17 -0700633 void traverseInReverseZOrder(LayerVector::StateSet stateSet,
634 const LayerVector::Visitor& visitor);
635 void traverseInZOrder(LayerVector::StateSet stateSet, const LayerVector::Visitor& visitor);
Robert Carr1f0a16a2016-10-24 16:27:39 -0700636
chaviw4b129c22018-04-09 16:19:43 -0700637 /**
638 * Traverse only children in z order, ignoring relative layers that are not children of the
639 * parent.
640 */
chaviwa76b2712017-09-20 12:02:26 -0700641 void traverseChildrenInZOrder(LayerVector::StateSet stateSet,
642 const LayerVector::Visitor& visitor);
643
Chia-I Wu98f1c102017-05-30 14:54:08 -0700644 size_t getChildrenCount() const;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700645 void addChild(const sp<Layer>& layer);
646 // Returns index if removed, or negative value otherwise
647 // for symmetry with Vector::remove
648 ssize_t removeChild(const sp<Layer>& layer);
Chia-I Wue41dbe62017-06-13 14:10:56 -0700649 sp<Layer> getParent() const { return mCurrentParent.promote(); }
Robert Carr1f0a16a2016-10-24 16:27:39 -0700650 bool hasParent() const { return getParent() != nullptr; }
Vishnu Nair4351ad52019-02-11 14:13:02 -0800651 Rect getScreenBounds(bool reduceTransparentRegion = true) const;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700652 bool setChildLayer(const sp<Layer>& childLayer, int32_t z);
Robert Carr503c7042017-09-27 15:06:08 -0700653 bool setChildRelativeLayer(const sp<Layer>& childLayer,
654 const sp<IBinder>& relativeToHandle, int32_t relativeZ);
Robert Carr1f0a16a2016-10-24 16:27:39 -0700655
656 // Copy the current list of children to the drawing state. Called by
657 // SurfaceFlinger to complete a transaction.
658 void commitChildList();
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800659 int32_t getZ() const;
660 virtual void pushPendingState();
David Sodman41fdfc92017-11-06 16:09:56 -0800661
Vishnu Nair88a11f22018-11-28 18:30:57 -0800662 /**
663 * Returns active buffer size in the correct orientation. Buffer size is determined by undoing
664 * any buffer transformations. If the layer has no buffer then return INVALID_RECT.
665 */
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800666 virtual Rect getBufferSize(const Layer::State&) const { return Rect::INVALID_RECT; }
Vishnu Nair88a11f22018-11-28 18:30:57 -0800667
Vishnu Nair4351ad52019-02-11 14:13:02 -0800668 /**
669 * Returns the source bounds. If the bounds are not defined, it is inferred from the
670 * buffer size. Failing that, the bounds are determined from the passed in parent bounds.
671 * For the root layer, this is the display viewport size.
672 */
673 virtual FloatRect computeSourceBounds(const FloatRect& parentBounds) const {
674 return parentBounds;
675 }
676
Lloyd Pique37c2c9b2018-12-04 17:25:10 -0800677 compositionengine::OutputLayer* findOutputLayerForDisplay(
678 const sp<const DisplayDevice>& display) const;
679
Mathias Agopian13127d82013-03-05 17:47:11 -0800680protected:
681 // constant
682 sp<SurfaceFlinger> mFlinger;
Mathias Agopian13127d82013-03-05 17:47:11 -0800683 /*
684 * Trivial class, used to ensure that mFlinger->onLayerDestroyed(mLayer)
685 * is called.
686 */
687 class LayerCleaner {
688 sp<SurfaceFlinger> mFlinger;
Robert Carr2e102c92018-10-23 12:11:15 -0700689 sp<Layer> mLayer;
David Sodman41fdfc92017-11-06 16:09:56 -0800690
Mathias Agopian13127d82013-03-05 17:47:11 -0800691 protected:
Irvel468051e2016-06-13 16:44:44 -0700692 ~LayerCleaner() {
693 // destroy client resources
Robert Carr2e102c92018-10-23 12:11:15 -0700694 mFlinger->onHandleDestroyed(mLayer);
Irvel468051e2016-06-13 16:44:44 -0700695 }
David Sodman41fdfc92017-11-06 16:09:56 -0800696
Mathias Agopian13127d82013-03-05 17:47:11 -0800697 public:
David Sodman41fdfc92017-11-06 16:09:56 -0800698 LayerCleaner(const sp<SurfaceFlinger>& flinger, const sp<Layer>& layer)
699 : mFlinger(flinger), mLayer(layer) {}
Mathias Agopian13127d82013-03-05 17:47:11 -0800700 };
701
Lloyd Pique4dccc412018-01-22 17:21:36 -0800702 friend class impl::SurfaceInterceptor;
David Sodmaneb085e02017-10-05 18:49:04 -0700703
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700704 // For unit tests
705 friend class TestableSurfaceFlinger;
706
Valerie Haub153bab2019-03-05 10:47:28 -0800707 virtual void commitTransaction(const State& stateToCommit);
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700708
Mathias Agopian3330b202009-10-05 17:07:12 -0700709 uint32_t getEffectiveUsage(uint32_t usage) const;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700710
Alec Mouri1f3bd182019-01-24 15:20:18 +0000711 virtual FloatRect computeCrop(const sp<const DisplayDevice>& display) const;
David Sodman0c69cad2017-08-21 12:12:51 -0700712 // Compute the initial crop as specified by parent layers and the
713 // SurfaceControl for this layer. Does not include buffer crop from the
714 // IGraphicBufferProducer client, as that should not affect child clipping.
715 // Returns in screen space.
Alec Mouri1f3bd182019-01-24 15:20:18 +0000716 Rect computeInitialCrop(const sp<const DisplayDevice>& display) const;
Lucas Dupin1b6531c2018-07-05 17:18:21 -0700717 /**
718 * Setup rounded corners coordinates of this layer, taking into account the layer bounds and
719 * crop coordinates, transforming them into layer space.
720 */
721 void setupRoundedCornersCropCoordinates(Rect win, const FloatRect& roundedCornersCrop) const;
Mathias Agopian0aa758d2009-04-22 15:23:34 -0700722
Mathias Agopian13127d82013-03-05 17:47:11 -0800723 // drawing
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800724 void clearWithOpenGL(const RenderArea& renderArea, float r, float g, float b,
725 float alpha) const;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700726 void setParent(const sp<Layer>& layer);
727
Robert Carr29abff82017-12-04 13:51:20 -0800728 LayerVector makeTraversalList(LayerVector::StateSet stateSet, bool* outSkipRelativeZUsers);
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800729 void addZOrderRelative(const wp<Layer>& relative);
730 void removeZOrderRelative(const wp<Layer>& relative);
Robert Carrdb66e622017-04-10 16:55:57 -0700731
David Sodman41fdfc92017-11-06 16:09:56 -0800732 class SyncPoint {
Dan Stoza7dde5992015-05-22 09:51:44 -0700733 public:
David Sodman41fdfc92017-11-06 16:09:56 -0800734 explicit SyncPoint(uint64_t frameNumber)
735 : mFrameNumber(frameNumber), mFrameIsAvailable(false), mTransactionIsApplied(false) {}
Dan Stoza7dde5992015-05-22 09:51:44 -0700736
David Sodman41fdfc92017-11-06 16:09:56 -0800737 uint64_t getFrameNumber() const { return mFrameNumber; }
Dan Stoza7dde5992015-05-22 09:51:44 -0700738
David Sodman41fdfc92017-11-06 16:09:56 -0800739 bool frameIsAvailable() const { return mFrameIsAvailable; }
Dan Stoza7dde5992015-05-22 09:51:44 -0700740
David Sodman41fdfc92017-11-06 16:09:56 -0800741 void setFrameAvailable() { mFrameIsAvailable = true; }
Dan Stoza7dde5992015-05-22 09:51:44 -0700742
David Sodman41fdfc92017-11-06 16:09:56 -0800743 bool transactionIsApplied() const { return mTransactionIsApplied; }
Dan Stoza7dde5992015-05-22 09:51:44 -0700744
David Sodman41fdfc92017-11-06 16:09:56 -0800745 void setTransactionApplied() { mTransactionIsApplied = true; }
Dan Stoza7dde5992015-05-22 09:51:44 -0700746
747 private:
748 const uint64_t mFrameNumber;
749 std::atomic<bool> mFrameIsAvailable;
750 std::atomic<bool> mTransactionIsApplied;
751 };
752
Dan Stozacac35382016-01-27 12:21:06 -0800753 // SyncPoints which will be signaled when the correct frame is at the head
754 // of the queue and dropped after the frame has been latched. Protected by
755 // mLocalSyncPointMutex.
756 Mutex mLocalSyncPointMutex;
Dan Stoza7dde5992015-05-22 09:51:44 -0700757 std::list<std::shared_ptr<SyncPoint>> mLocalSyncPoints;
758
Dan Stozacac35382016-01-27 12:21:06 -0800759 // SyncPoints which will be signaled and then dropped when the transaction
760 // is applied
Dan Stoza7dde5992015-05-22 09:51:44 -0700761 std::list<std::shared_ptr<SyncPoint>> mRemoteSyncPoints;
762
Dan Stozacac35382016-01-27 12:21:06 -0800763 // Returns false if the relevant frame has already been latched
764 bool addSyncPoint(const std::shared_ptr<SyncPoint>& point);
Dan Stoza7dde5992015-05-22 09:51:44 -0700765
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800766 void popPendingState(State* stateToCommit);
767 virtual bool applyPendingStates(State* stateToCommit);
768 virtual uint32_t doTransactionResize(uint32_t flags, Layer::State* stateToCommit);
Robert Carrc3574f72016-03-24 12:19:32 -0700769
770 // Returns mCurrentScaling mode (originating from the
771 // Client) or mOverrideScalingMode mode (originating from
772 // the Surface Controller) if set.
Robert Carr105e64b2018-03-07 12:47:50 -0800773 virtual uint32_t getEffectiveScalingMode() const { return 0; }
David Sodman41fdfc92017-11-06 16:09:56 -0800774
Dan Stoza7dde5992015-05-22 09:51:44 -0700775public:
Irvel468051e2016-06-13 16:44:44 -0700776 /*
777 * The layer handle is just a BBinder object passed to the client
778 * (remote process) -- we don't keep any reference on our side such that
779 * the dtor is called when the remote side let go of its reference.
780 *
781 * LayerCleaner ensures that mFlinger->onLayerDestroyed() is called for
782 * this layer when the handle is destroyed.
783 */
784 class Handle : public BBinder, public LayerCleaner {
David Sodman41fdfc92017-11-06 16:09:56 -0800785 public:
786 Handle(const sp<SurfaceFlinger>& flinger, const sp<Layer>& layer)
787 : LayerCleaner(flinger, layer), owner(layer) {}
Irvel468051e2016-06-13 16:44:44 -0700788
David Sodman41fdfc92017-11-06 16:09:56 -0800789 wp<Layer> owner;
Irvel468051e2016-06-13 16:44:44 -0700790 };
791
792 sp<IBinder> getHandle();
Irvel468051e2016-06-13 16:44:44 -0700793 const String8& getName() const;
Robert Carr105e64b2018-03-07 12:47:50 -0800794 virtual void notifyAvailableFrames() {}
795 virtual PixelFormat getPixelFormat() const { return PIXEL_FORMAT_NONE; }
chaviw13fdc492017-06-27 12:40:18 -0700796 bool getPremultipledAlpha() const;
Igor Murashkina4a31492012-10-29 13:36:11 -0700797
Robert Carr2e102c92018-10-23 12:11:15 -0700798 bool mPendingHWCDestroy{false};
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800799 void setInputInfo(const InputWindowInfo& info);
Robert Carr720e5062018-07-30 17:45:14 -0700800
Arthur Hungd20b2702019-01-14 18:16:16 +0800801 InputWindowInfo fillInputInfo();
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800802 bool hasInput() const;
Robert Carr2e102c92018-10-23 12:11:15 -0700803
David Sodman41fdfc92017-11-06 16:09:56 -0800804protected:
Mathias Agopianb7e930d2010-06-01 15:12:58 -0700805 // -----------------------------------------------------------------------
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800806 bool usingRelativeZ(LayerVector::StateSet stateSet);
Mathias Agopianb7e930d2010-06-01 15:12:58 -0700807
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700808 bool mPremultipliedAlpha{true};
Mathias Agopian13127d82013-03-05 17:47:11 -0800809 String8 mName;
David Sodman41fdfc92017-11-06 16:09:56 -0800810 String8 mTransactionName; // A cached version of "TX - " + mName for systraces
Mathias Agopian13127d82013-03-05 17:47:11 -0800811
Chia-I Wuab0c3192017-08-01 11:29:00 -0700812 bool mPrimaryDisplayOnly = false;
813
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800814 // these are protected by an external lock
815 State mCurrentState;
816 State mDrawingState;
817 std::atomic<uint32_t> mTransactionFlags{0};
818
Dan Stoza7dde5992015-05-22 09:51:44 -0700819 // Accessed from main thread and binder threads
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800820 Mutex mPendingStateMutex;
821 Vector<State> mPendingStates;
Dan Stoza7dde5992015-05-22 09:51:44 -0700822
Brian Andersond6927fb2016-07-23 23:37:30 -0700823 // Timestamp history for UIAutomation. Thread safe.
Jamie Gennis4b0eba92013-02-05 13:30:24 -0800824 FrameTracker mFrameTracker;
Mathias Agopiana67932f2011-04-20 14:20:59 -0700825
Brian Andersond6927fb2016-07-23 23:37:30 -0700826 // Timestamp history for the consumer to query.
827 // Accessed by both consumer and producer on main and binder threads.
828 Mutex mFrameEventHistoryMutex;
Brian Anderson3890c392016-07-25 12:48:08 -0700829 ConsumerFrameEventHistory mFrameEventHistory;
Brian Anderson3d4039d2016-09-23 16:31:30 -0700830 FenceTimeline mAcquireTimeline;
831 FenceTimeline mReleaseTimeline;
Brian Andersond6927fb2016-07-23 23:37:30 -0700832
Mathias Agopiana67932f2011-04-20 14:20:59 -0700833 // main thread
Lloyd Pique0b785d82018-12-04 17:25:27 -0800834 sp<NativeHandle> mSidebandStream;
Alec Mourie7d1d4a2019-02-05 01:13:46 +0000835 // Active buffer fields
Mathias Agopiana67932f2011-04-20 14:20:59 -0700836 sp<GraphicBuffer> mActiveBuffer;
Alec Mourie7d1d4a2019-02-05 01:13:46 +0000837 sp<Fence> mActiveBufferFence;
838 // False if the buffer and its contents have been previously used for GPU
839 // composition, true otherwise.
840 bool mIsActiveBufferUpdatedForGpu = true;
841
Chia-I Wu01591c92018-05-22 12:03:00 -0700842 ui::Dataspace mCurrentDataSpace = ui::Dataspace::UNKNOWN;
Mathias Agopiana67932f2011-04-20 14:20:59 -0700843 Rect mCurrentCrop;
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700844 uint32_t mCurrentTransform{0};
Robert Carrc3574f72016-03-24 12:19:32 -0700845 // We encode unset as -1.
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700846 int32_t mOverrideScalingMode{-1};
847 std::atomic<uint64_t> mCurrentFrameNumber{0};
848 bool mFrameLatencyNeeded{false};
Mathias Agopian13127d82013-03-05 17:47:11 -0800849 // Whether filtering is needed b/c of the drawingstate
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700850 bool mNeedsFiltering{false};
David Sodman0c69cad2017-08-21 12:12:51 -0700851
Robert Carr2e102c92018-10-23 12:11:15 -0700852 std::atomic<bool> mRemovedFromCurrentState{false};
chaviw8b3871a2017-11-01 17:41:01 -0700853
Mathias Agopianb7e930d2010-06-01 15:12:58 -0700854 // page-flip thread (currently main thread)
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700855 bool mProtectedByApp{false}; // application requires protected path to external sink
Mathias Agopian13127d82013-03-05 17:47:11 -0800856
857 // protected by mLock
858 mutable Mutex mLock;
David Sodman0c69cad2017-08-21 12:12:51 -0700859
Mathias Agopian13127d82013-03-05 17:47:11 -0800860 const wp<Client> mClientRef;
Riley Andrews03414a12014-07-01 14:22:59 -0700861
862 // This layer can be a cursor on some displays.
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700863 bool mPotentialCursor{false};
Dan Stoza6b9454d2014-11-07 16:00:59 -0800864
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700865 bool mFreezeGeometryUpdates{false};
Robert Carr1f0a16a2016-10-24 16:27:39 -0700866
867 // Child list about to be committed/used for editing.
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700868 LayerVector mCurrentChildren{LayerVector::StateSet::Current};
Robert Carr1f0a16a2016-10-24 16:27:39 -0700869 // Child list used for rendering.
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700870 LayerVector mDrawingChildren{LayerVector::StateSet::Drawing};
Robert Carr1f0a16a2016-10-24 16:27:39 -0700871
Chia-I Wue41dbe62017-06-13 14:10:56 -0700872 wp<Layer> mCurrentParent;
873 wp<Layer> mDrawingParent;
David Sodman9eeae692017-11-02 10:53:32 -0700874
chaviw5aedec92018-10-22 10:40:38 -0700875 // Can only be accessed with the SF state lock held.
876 bool mLayerDetached{false};
Robert Carr1323c952019-01-28 18:13:27 -0800877 // Can only be accessed with the SF state lock held.
878 bool mChildrenChanged{false};
chaviw5aedec92018-10-22 10:40:38 -0700879
chaviw4b129c22018-04-09 16:19:43 -0700880private:
881 /**
882 * Returns an unsorted vector of all layers that are part of this tree.
883 * That includes the current layer and all its descendants.
884 */
885 std::vector<Layer*> getLayersInTree(LayerVector::StateSet stateSet);
886 /**
887 * Traverses layers that are part of this tree in the correct z order.
888 * layersInTree must be sorted before calling this method.
889 */
890 void traverseChildrenInZOrderInner(const std::vector<Layer*>& layersInTree,
891 LayerVector::StateSet stateSet,
892 const LayerVector::Visitor& visitor);
893 LayerVector makeChildrenTraversalList(LayerVector::StateSet stateSet,
894 const std::vector<Layer*>& layersInTree);
Vishnu Nair60356342018-11-13 13:00:45 -0800895 /**
Vishnu Nair60356342018-11-13 13:00:45 -0800896 * Returns the cropped buffer size or the layer crop if the layer has no buffer. Return
897 * INVALID_RECT if the layer has no buffer and no crop.
898 * A layer with an invalid buffer size and no crop is considered to be boundless. The layer
899 * bounds are constrained by its parent bounds.
900 */
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800901 Rect getCroppedBufferSize(const Layer::State& s) const;
Vishnu Nair4351ad52019-02-11 14:13:02 -0800902
903 // Cached properties computed from drawing state
904 // Effective transform taking into account parent transforms and any parent scaling.
905 ui::Transform mEffectiveTransform;
906
907 // Bounds of the layer before any transformation is applied and before it has been cropped
908 // by its parents.
909 FloatRect mSourceBounds;
910
911 // Bounds of the layer in layer space. This is the mSourceBounds cropped by its layer crop and
912 // its parent bounds.
913 FloatRect mBounds;
914
915 // Layer bounds in screen space.
916 FloatRect mScreenBounds;
chaviw606e5cf2019-03-01 10:12:10 -0800917
918 void setZOrderRelativeOf(const wp<Layer>& relativeOf);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800919};
920
Dominik Laskowski34157762018-10-31 13:07:19 -0700921} // namespace android
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800922
Lloyd Pique37c2c9b2018-12-04 17:25:10 -0800923#define RETURN_IF_NO_HWC_LAYER(displayDevice, ...) \
Dominik Laskowski34157762018-10-31 13:07:19 -0700924 do { \
Lloyd Pique37c2c9b2018-12-04 17:25:10 -0800925 if (!hasHwcLayer(displayDevice)) { \
Dominik Laskowski34157762018-10-31 13:07:19 -0700926 ALOGE("[%s] %s failed: no HWC layer found for display %s", mName.string(), \
Lloyd Pique37c2c9b2018-12-04 17:25:10 -0800927 __FUNCTION__, displayDevice->getDebugName().c_str()); \
Dominik Laskowski34157762018-10-31 13:07:19 -0700928 return __VA_ARGS__; \
929 } \
930 } while (false)
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800931
932#endif // ANDROID_LAYER_H