blob: 4d95c4061ee2449aacb3506a9504dca64f6a4375 [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
Peiyong Lincbc184f2018-08-22 13:24:10 -070022#include <gui/BufferQueue.h>
23#include <gui/ISurfaceComposerClient.h>
24#include <gui/LayerState.h>
Robert Carr720e5062018-07-30 17:45:14 -070025#include <input/InputWindow.h>
Peiyong Lincbc184f2018-08-22 13:24:10 -070026#include <layerproto/LayerProtoHeader.h>
27#include <math/vec4.h>
28#include <renderengine/Mesh.h>
29#include <renderengine/Texture.h>
Dan Stoza80d61162017-12-20 15:57:52 -080030#include <ui/FloatRect.h>
Svetoslavd85084b2014-03-20 10:28:31 -070031#include <ui/FrameStats.h>
Mathias Agopian13127d82013-03-05 17:47:11 -080032#include <ui/GraphicBuffer.h>
33#include <ui/PixelFormat.h>
34#include <ui/Region.h>
Peiyong Linefefaac2018-08-17 12:27:51 -070035#include <ui/Transform.h>
Peiyong Lincbc184f2018-08-22 13:24:10 -070036#include <utils/RefBase.h>
37#include <utils/String8.h>
38#include <utils/Timers.h>
Mathias Agopian13127d82013-03-05 17:47:11 -080039
Robert Carrcdf83202018-03-07 12:48:34 -080040#include <cstdint>
Peiyong Lincbc184f2018-08-22 13:24:10 -070041#include <list>
Dominik Laskowski075d3172018-05-24 15:50:06 -070042#include <optional>
Peiyong Lincbc184f2018-08-22 13:24:10 -070043#include <vector>
Dan Stoza7dde5992015-05-22 09:51:44 -070044
Mathias Agopian13127d82013-03-05 17:47:11 -080045#include "Client.h"
David Sodman41fdfc92017-11-06 16:09:56 -080046#include "FrameTracker.h"
Yiwei Zhangfaf3ded2018-05-02 17:37:17 -070047#include "LayerBE.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
Mathias Agopian13127d82013-03-05 17:47:11 -080053#include "DisplayHardware/HWComposer.h"
Chia-I Wuaaff73f2017-02-13 12:28:24 -080054#include "DisplayHardware/HWComposerBufferCache.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;
David Sodman9eeae692017-11-02 10:53:32 -070069class LayerBE;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080070
Lloyd Pique4dccc412018-01-22 17:21:36 -080071namespace impl {
72class SurfaceInterceptor;
73}
74
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080075// ---------------------------------------------------------------------------
76
Lloyd Pique42ab75e2018-09-12 20:46:03 -070077struct LayerCreationArgs {
78 LayerCreationArgs(SurfaceFlinger* flinger, const sp<Client>& client, const String8& name,
79 uint32_t w, uint32_t h, uint32_t flags)
80 : flinger(flinger), client(client), name(name), w(w), h(h), flags(flags) {}
81
82 SurfaceFlinger* flinger;
83 const sp<Client>& client;
84 const String8& name;
85 uint32_t w;
86 uint32_t h;
87 uint32_t flags;
88};
89
David Sodman41fdfc92017-11-06 16:09:56 -080090class Layer : public virtual RefBase {
Lloyd Piquef1c675b2018-09-12 20:45:39 -070091 static std::atomic<int32_t> sSequence;
Mathias Agopian13127d82013-03-05 17:47:11 -080092
Mathias Agopiand606de62010-05-10 20:06:11 -070093public:
David Sodmanfb95bcc2017-12-22 15:45:30 -080094 friend class LayerBE;
David Sodman9eeae692017-11-02 10:53:32 -070095 LayerBE& getBE() { return mBE; }
96 LayerBE& getBE() const { return mBE; }
Lloyd Pique42ab75e2018-09-12 20:46:03 -070097 mutable bool contentDirty{false};
Mathias Agopian13127d82013-03-05 17:47:11 -080098 // regions below are in window-manager space
99 Region visibleRegion;
100 Region coveredRegion;
101 Region visibleNonTransparentRegion;
Dan Stozaee44edd2015-03-23 15:50:23 -0700102 Region surfaceDamageRegion;
Andy McFadden4df87bd2014-04-21 18:08:54 -0700103
104 // Layer serial number. This gives layers an explicit ordering, so we
105 // have a stable sort order when their layer stack and Z-order are
106 // the same.
Lloyd Piquef1c675b2018-09-12 20:45:39 -0700107 int32_t sequence{sSequence++};
Mathias Agopian13127d82013-03-05 17:47:11 -0800108
109 enum { // flags for doTransaction()
110 eDontUpdateGeometryState = 0x00000001,
111 eVisibleRegion = 0x00000002,
Robert Carr720e5062018-07-30 17:45:14 -0700112 eInputInfoChanged = 0x00000004
Mathias Agopian13127d82013-03-05 17:47:11 -0800113 };
114
115 struct Geometry {
116 uint32_t w;
117 uint32_t h;
Peiyong Linefefaac2018-08-17 12:27:51 -0700118 ui::Transform transform;
Robert Carr3dcabfa2016-03-01 18:36:58 -0800119
David Sodman41fdfc92017-11-06 16:09:56 -0800120 inline bool operator==(const Geometry& rhs) const {
121 return (w == rhs.w && h == rhs.h) && (transform.tx() == rhs.transform.tx()) &&
Robert Carr99e27f02016-06-16 15:18:02 -0700122 (transform.ty() == rhs.transform.ty());
Mathias Agopian13127d82013-03-05 17:47:11 -0800123 }
David Sodman41fdfc92017-11-06 16:09:56 -0800124 inline bool operator!=(const Geometry& rhs) const { return !operator==(rhs); }
Mathias Agopian13127d82013-03-05 17:47:11 -0800125 };
126
Lucas Dupin1b6531c2018-07-05 17:18:21 -0700127 struct RoundedCornerState {
128 RoundedCornerState() = default;
129 RoundedCornerState(FloatRect cropRect, float radius)
130 : cropRect(cropRect), radius(radius) {}
131
132 // Rounded rectangle in local layer coordinate space.
133 FloatRect cropRect = FloatRect();
134 // Radius of the rounded rectangle.
135 float radius = 0.0f;
136 };
137
Mathias Agopian13127d82013-03-05 17:47:11 -0800138 struct State {
Marissa Wallf58c14b2018-07-24 10:50:43 -0700139 Geometry active_legacy;
140 Geometry requested_legacy;
Robert Carrae060832016-11-28 10:51:00 -0800141 int32_t z;
Fabien Sanglardf0c53d62017-03-03 18:58:50 -0800142
143 // The identifier of the layer stack this layer belongs to. A layer can
144 // only be associated to a single layer stack. A layer stack is a
145 // z-ordered group of layers which can be associated to one or more
146 // displays. Using the same layer stack on different displays is a way
147 // to achieve mirroring.
Mathias Agopian13127d82013-03-05 17:47:11 -0800148 uint32_t layerStack;
Fabien Sanglardf0c53d62017-03-03 18:58:50 -0800149
Mathias Agopian13127d82013-03-05 17:47:11 -0800150 uint8_t flags;
151 uint8_t reserved[2];
152 int32_t sequence; // changes when visible regions can change
Dan Stoza7dde5992015-05-22 09:51:44 -0700153 bool modified;
154
Fabien Sanglard4ed383c2016-12-13 14:02:41 -0800155 // Crop is expressed in layer space coordinate.
Marissa Wallf58c14b2018-07-24 10:50:43 -0700156 Rect crop_legacy;
157 Rect requestedCrop_legacy;
Robert Carr99e27f02016-06-16 15:18:02 -0700158
Robert Carr0d480722017-01-10 16:42:54 -0800159 // If set, defers this state update until the identified Layer
Dan Stoza7dde5992015-05-22 09:51:44 -0700160 // receives a frame with the given frameNumber
Marissa Wallf58c14b2018-07-24 10:50:43 -0700161 wp<Layer> barrierLayer_legacy;
162 uint64_t frameNumber_legacy;
Dan Stoza7dde5992015-05-22 09:51:44 -0700163
Mathias Agopian2ca79392013-04-02 18:30:32 -0700164 // the transparentRegion hint is a bit special, it's latched only
165 // when we receive a buffer -- this is because it's "content"
166 // dependent.
Marissa Wallf58c14b2018-07-24 10:50:43 -0700167 Region activeTransparentRegion_legacy;
168 Region requestedTransparentRegion_legacy;
Daniel Nicoara2f5f8a52016-12-20 16:11:58 -0500169
rongliucfb187b2018-03-14 12:26:23 -0700170 int32_t appId;
171 int32_t type;
Robert Carrdb66e622017-04-10 16:55:57 -0700172
173 // If non-null, a Surface this Surface's Z-order is interpreted relative to.
174 wp<Layer> zOrderRelativeOf;
175
176 // A list of surfaces whose Z-order is interpreted relative to ours.
177 SortedVector<wp<Layer>> zOrderRelatives;
chaviw13fdc492017-06-27 12:40:18 -0700178
179 half4 color;
Lucas Dupin1b6531c2018-07-05 17:18:21 -0700180 float cornerRadius;
Marissa Wall61c58622018-07-18 10:12:20 -0700181
Robert Carr720e5062018-07-30 17:45:14 -0700182 bool inputInfoChanged;
183 InputWindowInfo inputInfo;
184
Marissa Wall61c58622018-07-18 10:12:20 -0700185 // The fields below this point are only used by BufferStateLayer
186 Geometry active;
187
188 uint32_t transform;
189 bool transformToDisplayInverse;
190
191 Rect crop;
192 Region transparentRegionHint;
193
194 sp<GraphicBuffer> buffer;
195 sp<Fence> acquireFence;
196 ui::Dataspace dataspace;
197 HdrMetadata hdrMetadata;
198 Region surfaceDamageRegion;
199 int32_t api;
200
201 sp<NativeHandle> sidebandStream;
Peiyong Lind3788632018-09-18 16:01:31 -0700202 mat4 colorTransform;
Peiyong Lin747321c2018-10-01 10:03:11 -0700203 bool hasColorTransform;
Marissa Walle2ffb422018-10-12 11:33:52 -0700204
205 // The deque of callback handles for this frame. The back of the deque contains the most
206 // recent callback handle.
207 std::deque<sp<CallbackHandle>> callbackHandles;
Mathias Agopian13127d82013-03-05 17:47:11 -0800208 };
209
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700210 explicit Layer(const LayerCreationArgs& args);
Mathias Agopianb7e930d2010-06-01 15:12:58 -0700211 virtual ~Layer();
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800212
Chia-I Wuab0c3192017-08-01 11:29:00 -0700213 void setPrimaryDisplayOnly() { mPrimaryDisplayOnly = true; }
214
Robert Carr7bf247e2017-05-18 14:02:49 -0700215 // ------------------------------------------------------------------------
216 // Geometry setting functions.
217 //
218 // The following group of functions are used to specify the layers
219 // bounds, and the mapping of the texture on to those bounds. According
220 // to various settings changes to them may apply immediately, or be delayed until
221 // a pending resize is completed by the producer submitting a buffer. For example
222 // if we were to change the buffer size, and update the matrix ahead of the
223 // new buffer arriving, then we would be stretching the buffer to a different
224 // aspect before and after the buffer arriving, which probably isn't what we wanted.
225 //
226 // The first set of geometry functions are controlled by the scaling mode, described
227 // in window.h. The scaling mode may be set by the client, as it submits buffers.
228 // This value may be overriden through SurfaceControl, with setOverrideScalingMode.
229 //
230 // Put simply, if our scaling mode is SCALING_MODE_FREEZE, then
231 // matrix updates will not be applied while a resize is pending
232 // and the size and transform will remain in their previous state
233 // until a new buffer is submitted. If the scaling mode is another value
234 // then the old-buffer will immediately be scaled to the pending size
235 // and the new matrix will be immediately applied following this scaling
236 // transformation.
Robert Carr8d5227b2017-03-16 15:41:03 -0700237
Robert Carr7bf247e2017-05-18 14:02:49 -0700238 // Set the default buffer size for the assosciated Producer, in pixels. This is
239 // also the rendered size of the layer prior to any transformations. Parent
240 // or local matrix transformations will not affect the size of the buffer,
241 // but may affect it's on-screen size or clipping.
Marissa Wall61c58622018-07-18 10:12:20 -0700242 virtual bool setSize(uint32_t w, uint32_t h);
Robert Carr7bf247e2017-05-18 14:02:49 -0700243 // Set a 2x2 transformation matrix on the layer. This transform
244 // will be applied after parent transforms, but before any final
245 // producer specified transform.
Marissa Wall61c58622018-07-18 10:12:20 -0700246 virtual bool setMatrix(const layer_state_t::matrix22_t& matrix,
247 bool allowNonRectPreservingTransforms);
Robert Carr7bf247e2017-05-18 14:02:49 -0700248
249 // This second set of geometry attributes are controlled by
250 // setGeometryAppliesWithResize, and their default mode is to be
251 // immediate. If setGeometryAppliesWithResize is specified
252 // while a resize is pending, then update of these attributes will
253 // be delayed until the resize completes.
254
255 // setPosition operates in parent buffer space (pre parent-transform) or display
256 // space for top-level layers.
Marissa Wall61c58622018-07-18 10:12:20 -0700257 virtual bool setPosition(float x, float y, bool immediate);
Robert Carr7bf247e2017-05-18 14:02:49 -0700258 // Buffer space
Marissa Wall61c58622018-07-18 10:12:20 -0700259 virtual bool setCrop_legacy(const Rect& crop, bool immediate);
Robert Carr8d5227b2017-03-16 15:41:03 -0700260
Robert Carr7bf247e2017-05-18 14:02:49 -0700261 // TODO(b/38182121): Could we eliminate the various latching modes by
262 // using the layer hierarchy?
263 // -----------------------------------------------------------------------
Marissa Wall61c58622018-07-18 10:12:20 -0700264 virtual bool setLayer(int32_t z);
265 virtual bool setRelativeLayer(const sp<IBinder>& relativeToHandle, int32_t relativeZ);
Robert Carrdb66e622017-04-10 16:55:57 -0700266
Marissa Wall61c58622018-07-18 10:12:20 -0700267 virtual bool setAlpha(float alpha);
268 virtual bool setColor(const half3& color);
Lucas Dupin1b6531c2018-07-05 17:18:21 -0700269
270 // Set rounded corner radius for this layer and its children.
271 //
272 // We only support 1 radius per layer in the hierarchy, where parent layers have precedence.
273 // The shape of the rounded corner rectangle is specified by the crop rectangle of the layer
274 // from which we inferred the rounded corner radius.
275 virtual bool setCornerRadius(float cornerRadius);
Marissa Wall61c58622018-07-18 10:12:20 -0700276 virtual bool setTransparentRegionHint(const Region& transparent);
277 virtual bool setFlags(uint8_t flags, uint8_t mask);
278 virtual bool setLayerStack(uint32_t layerStack);
279 virtual uint32_t getLayerStack() const;
280 virtual void deferTransactionUntil_legacy(const sp<IBinder>& barrierHandle,
281 uint64_t frameNumber);
282 virtual void deferTransactionUntil_legacy(const sp<Layer>& barrierLayer, uint64_t frameNumber);
283 virtual bool setOverrideScalingMode(int32_t overrideScalingMode);
284 virtual void setInfo(int32_t type, int32_t appId);
285 virtual bool reparentChildren(const sp<IBinder>& layer);
286 virtual void setChildrenDrawingParent(const sp<Layer>& layer);
287 virtual bool reparent(const sp<IBinder>& newParentHandle);
288 virtual bool detachChildren();
chaviw5aedec92018-10-22 10:40:38 -0700289 bool attachChildren();
290 bool isLayerDetached() const { return mLayerDetached; }
Peiyong Lind3788632018-09-18 16:01:31 -0700291 virtual bool setColorTransform(const mat4& matrix);
chaviwf66724d2018-11-28 16:35:21 -0800292 virtual mat4 getColorTransform() const;
Peiyong Lind3788632018-09-18 16:01:31 -0700293 virtual bool hasColorTransform() const;
Marissa Wall61c58622018-07-18 10:12:20 -0700294
295 // Used only to set BufferStateLayer state
296 virtual bool setTransform(uint32_t /*transform*/) { return false; };
297 virtual bool setTransformToDisplayInverse(bool /*transformToDisplayInverse*/) { return false; };
298 virtual bool setCrop(const Rect& /*crop*/) { return false; };
Marissa Wallfda30bb2018-10-12 11:34:28 -0700299 virtual bool setBuffer(const sp<GraphicBuffer>& /*buffer*/) { return false; };
Marissa Wall61c58622018-07-18 10:12:20 -0700300 virtual bool setAcquireFence(const sp<Fence>& /*fence*/) { return false; };
301 virtual bool setDataspace(ui::Dataspace /*dataspace*/) { return false; };
302 virtual bool setHdrMetadata(const HdrMetadata& /*hdrMetadata*/) { return false; };
303 virtual bool setSurfaceDamageRegion(const Region& /*surfaceDamage*/) { return false; };
304 virtual bool setApi(int32_t /*api*/) { return false; };
305 virtual bool setSidebandStream(const sp<NativeHandle>& /*sidebandStream*/) { return false; };
Marissa Walle2ffb422018-10-12 11:33:52 -0700306 virtual bool setTransactionCompletedListeners(
307 const std::vector<sp<CallbackHandle>>& /*handles*/) {
308 return false;
309 };
Mathias Agopian13127d82013-03-05 17:47:11 -0800310
Chia-I Wu01591c92018-05-22 12:03:00 -0700311 ui::Dataspace getDataSpace() const { return mCurrentDataSpace; }
312
Peiyong Lindd9b2ae2018-03-01 16:22:45 -0800313 // Before color management is introduced, contents on Android have to be
314 // desaturated in order to match what they appears like visually.
315 // With color management, these contents will appear desaturated, thus
316 // needed to be saturated so that they match what they are designed for
Chia-I Wu11481472018-05-04 10:43:19 -0700317 // visually.
318 bool isLegacyDataSpace() const;
Peiyong Lindd9b2ae2018-03-01 16:22:45 -0800319
Dan Stozaee44edd2015-03-23 15:50:23 -0700320 // If we have received a new buffer this frame, we will pass its surface
321 // damage down to hardware composer. Otherwise, we must send a region with
322 // one empty rect.
Robert Carr105e64b2018-03-07 12:47:50 -0800323 virtual void useSurfaceDamage() {}
324 virtual void useEmptyDamage() {}
Dan Stozaee44edd2015-03-23 15:50:23 -0700325
Lloyd Piquef1c675b2018-09-12 20:45:39 -0700326 uint32_t getTransactionFlags() const { return mTransactionFlags; }
Mathias Agopian13127d82013-03-05 17:47:11 -0800327 uint32_t getTransactionFlags(uint32_t flags);
328 uint32_t setTransactionFlags(uint32_t flags);
329
Chia-I Wuab0c3192017-08-01 11:29:00 -0700330 bool belongsToDisplay(uint32_t layerStack, bool isPrimaryDisplay) const {
331 return getLayerStack() == layerStack && (!mPrimaryDisplayOnly || isPrimaryDisplay);
332 }
333
Peiyong Lin833074a2018-08-28 11:53:54 -0700334 void computeGeometry(const RenderArea& renderArea, renderengine::Mesh& mesh,
335 bool useIdentityTransform) const;
Dan Stoza80d61162017-12-20 15:57:52 -0800336 FloatRect computeBounds(const Region& activeTransparentRegion) const;
337 FloatRect computeBounds() const;
Mathias Agopian13127d82013-03-05 17:47:11 -0800338
Pablo Ceballos40845df2016-01-25 17:41:15 -0800339 int32_t getSequence() const { return sequence; }
340
Mathias Agopian13127d82013-03-05 17:47:11 -0800341 // -----------------------------------------------------------------------
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700342 // Virtuals
David Sodman0c69cad2017-08-21 12:12:51 -0700343 virtual const char* getTypeId() const = 0;
Mathias Agopian13127d82013-03-05 17:47:11 -0800344
Mathias Agopian13127d82013-03-05 17:47:11 -0800345 /*
346 * isOpaque - true if this surface is opaque
Andy McFadden4125a4f2014-01-29 17:17:11 -0800347 *
348 * This takes into account the buffer format (i.e. whether or not the
349 * pixel format includes an alpha channel) and the "opaque" flag set
350 * on the layer. It does not examine the current plane alpha value.
Mathias Agopian13127d82013-03-05 17:47:11 -0800351 */
Robert Carr105e64b2018-03-07 12:47:50 -0800352 virtual bool isOpaque(const Layer::State&) const { return false; }
Mathias Agopian13127d82013-03-05 17:47:11 -0800353
354 /*
355 * isSecure - true if this surface is secure, that is if it prevents
356 * screenshots or VNC servers.
357 */
David Sodman0c69cad2017-08-21 12:12:51 -0700358 bool isSecure() const;
Mathias Agopian13127d82013-03-05 17:47:11 -0800359
360 /*
361 * isVisible - true if this layer is visible, false otherwise
362 */
David Sodman0c69cad2017-08-21 12:12:51 -0700363 virtual bool isVisible() const = 0;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800364
Mathias Agopian13127d82013-03-05 17:47:11 -0800365 /*
Robert Carr1f0a16a2016-10-24 16:27:39 -0700366 * isHiddenByPolicy - true if this layer has been forced invisible.
367 * just because this is false, doesn't mean isVisible() is true.
368 * For example if this layer has no active buffer, it may not be hidden by
369 * policy, but it still can not be visible.
370 */
David Sodman0c69cad2017-08-21 12:12:51 -0700371 bool isHiddenByPolicy() const;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700372
373 /*
Mathias Agopian13127d82013-03-05 17:47:11 -0800374 * isFixedSize - true if content has a fixed size
375 */
Robert Carr105e64b2018-03-07 12:47:50 -0800376 virtual bool isFixedSize() const { return true; }
377
Dan Stoza436ccf32018-06-21 12:10:12 -0700378 // Most layers aren't created from the main thread, and therefore need to
379 // grab the SF state lock to access HWC, but ContainerLayer does, so we need
380 // to avoid grabbing the lock again to avoid deadlock
381 virtual bool isCreatedFromMainThread() const { return false; }
382
Robert Carr2e102c92018-10-23 12:11:15 -0700383 bool isRemovedFromCurrentState() const;
chaviw8b3871a2017-11-01 17:41:01 -0700384
David Sodman41fdfc92017-11-06 16:09:56 -0800385 void writeToProto(LayerProto* layerInfo,
386 LayerVector::StateSet stateSet = LayerVector::StateSet::Drawing);
chaviw1d044282017-09-27 12:19:28 -0700387
Dominik Laskowski075d3172018-05-24 15:50:06 -0700388 void writeToProto(LayerProto* layerInfo, DisplayId displayId);
Yiwei Zhang7124ad32018-02-21 13:02:45 -0800389
Marissa Wall61c58622018-07-18 10:12:20 -0700390 virtual Geometry getActiveGeometry(const Layer::State& s) const { return s.active_legacy; }
391 virtual uint32_t getActiveWidth(const Layer::State& s) const { return s.active_legacy.w; }
392 virtual uint32_t getActiveHeight(const Layer::State& s) const { return s.active_legacy.h; }
Peiyong Linefefaac2018-08-17 12:27:51 -0700393 virtual ui::Transform getActiveTransform(const Layer::State& s) const {
Marissa Wall61c58622018-07-18 10:12:20 -0700394 return s.active_legacy.transform;
395 }
396 virtual Region getActiveTransparentRegion(const Layer::State& s) const {
397 return s.activeTransparentRegion_legacy;
398 }
399 virtual Rect getCrop(const Layer::State& s) const { return s.crop_legacy; }
Marissa Wall61c58622018-07-18 10:12:20 -0700400
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700401protected:
402 /*
403 * onDraw - draws the surface.
404 */
chaviwa76b2712017-09-20 12:02:26 -0700405 virtual void onDraw(const RenderArea& renderArea, const Region& clip,
Marissa Wall61c58622018-07-18 10:12:20 -0700406 bool useIdentityTransform) = 0;
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700407
408public:
Robert Carr105e64b2018-03-07 12:47:50 -0800409 virtual void setDefaultBufferSize(uint32_t /*w*/, uint32_t /*h*/) {}
David Sodmaneb085e02017-10-05 18:49:04 -0700410
Chia-I Wu692e0832018-06-05 15:46:58 -0700411 virtual bool isHdrY410() const { return false; }
412
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700413 void setGeometry(const sp<const DisplayDevice>& display, uint32_t z);
Dominik Laskowski075d3172018-05-24 15:50:06 -0700414 void forceClientComposition(DisplayId displayId);
415 bool getForceClientComposition(DisplayId displayId);
416 virtual void setPerFrameData(DisplayId displayId, const ui::Transform& transform,
417 const Rect& viewport, int32_t supportedPerFrameMetadata) = 0;
Dan Stoza9e56aa02015-11-02 13:00:03 -0800418
419 // callIntoHwc exists so we can update our local state and call
420 // acceptDisplayChanges without unnecessarily updating the device's state
Dominik Laskowski075d3172018-05-24 15:50:06 -0700421 void setCompositionType(DisplayId displayId, HWC2::Composition type, bool callIntoHwc = true);
422 HWC2::Composition getCompositionType(const std::optional<DisplayId>& displayId) const;
423 void setClearClientTarget(DisplayId displayId, bool clear);
424 bool getClearClientTarget(DisplayId displayId) const;
Dominik Laskowskia2edf612018-06-01 13:15:16 -0700425 void updateCursorPosition(const sp<const DisplayDevice>& display);
Riley Andrews03414a12014-07-01 14:22:59 -0700426
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700427 /*
428 * called after page-flip
429 */
David Sodmaneb085e02017-10-05 18:49:04 -0700430 virtual void onLayerDisplayed(const sp<Fence>& releaseFence);
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700431
Ana Krulec010d2192018-10-08 06:29:54 -0700432 virtual bool shouldPresentNow(nsecs_t /*expectedPresentTime*/) const { return false; }
Robert Carr105e64b2018-03-07 12:47:50 -0800433 virtual void setTransformHint(uint32_t /*orientation*/) const { }
Dan Stoza6b9454d2014-11-07 16:00:59 -0800434
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700435 /*
436 * called before composition.
437 * returns true if the layer has pending updates.
438 */
Ady Abraham0d028792018-11-06 16:26:51 -0800439 virtual bool onPreComposition(nsecs_t refreshStartTime) = 0;
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700440
441 /*
Dan Stozae77c7662016-05-13 11:37:28 -0700442 * called after composition.
443 * returns true if the layer latched a new buffer this frame.
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700444 */
Dominik Laskowski075d3172018-05-24 15:50:06 -0700445 virtual bool onPostComposition(const std::optional<DisplayId>& /*displayId*/,
446 const std::shared_ptr<FenceTime>& /*glDoneFence*/,
Robert Carr105e64b2018-03-07 12:47:50 -0800447 const std::shared_ptr<FenceTime>& /*presentFence*/,
448 const CompositorTiming& /*compositorTiming*/) {
449 return false;
450 }
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700451
Dan Stoza9e56aa02015-11-02 13:00:03 -0800452 // If a buffer was replaced this frame, release the former buffer
Robert Carr105e64b2018-03-07 12:47:50 -0800453 virtual void releasePendingBuffer(nsecs_t /*dequeueReadyTime*/) { }
454
Dan Stoza9e56aa02015-11-02 13:00:03 -0800455
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700456 /*
457 * draw - performs some global clipping optimizations
458 * and calls onDraw().
459 */
Marissa Wall61c58622018-07-18 10:12:20 -0700460 void draw(const RenderArea& renderArea, const Region& clip);
461 void draw(const RenderArea& renderArea, bool useIdentityTransform);
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700462
463 /*
464 * doTransaction - process the transaction. This is a good place to figure
465 * out which attributes of the surface have changed.
466 */
467 uint32_t doTransaction(uint32_t transactionFlags);
468
469 /*
470 * setVisibleRegion - called to set the new visible region. This gives
471 * a chance to update the new visible region or record the fact it changed.
472 */
473 void setVisibleRegion(const Region& visibleRegion);
474
475 /*
476 * setCoveredRegion - called when the covered region changes. The covered
477 * region corresponds to any area of the surface that is covered
478 * (transparently or not) by another surface.
479 */
480 void setCoveredRegion(const Region& coveredRegion);
481
482 /*
483 * setVisibleNonTransparentRegion - called when the visible and
484 * non-transparent region changes.
485 */
David Sodman41fdfc92017-11-06 16:09:56 -0800486 void setVisibleNonTransparentRegion(const Region& visibleNonTransparentRegion);
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700487
488 /*
Robert Carre5f4f692018-01-12 13:12:28 -0800489 * Clear the visible, covered, and non-transparent regions.
490 */
491 void clearVisibilityRegions();
492
493 /*
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700494 * latchBuffer - called each time the screen is redrawn and returns whether
495 * the visible regions need to be recomputed (this is a fairly heavy
496 * operation, so this should be set only if needed). Typically this is used
497 * to figure out if the content or size of a surface has changed.
498 */
Alec Mouri86770e52018-09-24 22:40:58 +0000499 virtual Region latchBuffer(bool& /*recomputeVisibleRegions*/, nsecs_t /*latchTime*/,
500 const sp<Fence>& /*releaseFence*/) {
Robert Carr105e64b2018-03-07 12:47:50 -0800501 return {};
502 }
503
504 virtual bool isBufferLatched() const { return false; }
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700505
Mathias Agopian13127d82013-03-05 17:47:11 -0800506 /*
Chia-I Wuc6657022017-08-15 11:18:17 -0700507 * called with the state lock from a binder thread when the layer is
508 * removed from the current list to the pending removal list
509 */
510 void onRemovedFromCurrentState();
511
chaviw61626f22018-11-15 16:26:27 -0800512 /*
513 * Called when the layer is added back to the current state list.
514 */
515 void addToCurrentState();
516
Andy McFaddenbf974ab2012-12-04 16:51:15 -0800517 // Updates the transform hint in our SurfaceFlingerConsumer to match
Mathias Agopian84300952012-11-21 16:02:13 -0800518 // the current orientation of the display device.
Dominik Laskowskia2edf612018-06-01 13:15:16 -0700519 void updateTransformHint(const sp<const DisplayDevice>& display) const;
Andy McFadden69052052012-09-14 16:10:11 -0700520
Mathias Agopian13127d82013-03-05 17:47:11 -0800521 /*
522 * returns the rectangle that crops the content of the layer and scales it
523 * to the layer's size.
524 */
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700525 Rect getContentCrop() const;
Mathias Agopian13127d82013-03-05 17:47:11 -0800526
Eric Penner51c59cd2014-07-28 19:51:58 -0700527 /*
Marissa Wallfd668622018-05-10 10:21:13 -0700528 * Returns if a frame is ready
Eric Penner51c59cd2014-07-28 19:51:58 -0700529 */
Marissa Wallfd668622018-05-10 10:21:13 -0700530 virtual bool hasReadyFrame() const { return false; }
Eric Penner51c59cd2014-07-28 19:51:58 -0700531
Marissa Wallfd668622018-05-10 10:21:13 -0700532 virtual int32_t getQueuedFrameCount() const { return 0; }
Kalle Raitaa099a242017-01-11 11:17:29 -0800533
Dan Stoza9e56aa02015-11-02 13:00:03 -0800534 // -----------------------------------------------------------------------
535
Dominik Laskowski075d3172018-05-24 15:50:06 -0700536 bool createHwcLayer(HWComposer* hwc, DisplayId displayId);
537 bool destroyHwcLayer(DisplayId displayId);
chaviw61626f22018-11-15 16:26:27 -0800538 void destroyHwcLayersForAllDisplays();
539 void destroyAllHwcLayersPlusChildren();
Steven Thomasb02664d2017-07-26 18:48:28 -0700540
Dominik Laskowski34157762018-10-31 13:07:19 -0700541 bool hasHwcLayer(DisplayId displayId) const { return getBE().mHwcLayers.count(displayId) > 0; }
Dan Stoza9e56aa02015-11-02 13:00:03 -0800542
Dominik Laskowski075d3172018-05-24 15:50:06 -0700543 HWC2::Layer* getHwcLayer(DisplayId displayId) {
544 if (!hasHwcLayer(displayId)) {
Dan Stoza9e56aa02015-11-02 13:00:03 -0800545 return nullptr;
546 }
David Sodmanb8aaea12017-12-14 15:54:51 -0800547 return getBE().mHwcLayers[displayId].layer.get();
Dan Stoza9e56aa02015-11-02 13:00:03 -0800548 }
549
Dominik Laskowski075d3172018-05-24 15:50:06 -0700550 bool setHwcLayer(DisplayId displayId) {
551 if (!hasHwcLayer(displayId)) {
David Sodmanba340492018-08-05 21:51:33 -0700552 return false;
553 }
Dominik Laskowski075d3172018-05-24 15:50:06 -0700554 getBE().compositionInfo.hwc.hwcLayer = getBE().mHwcLayers[displayId].layer;
David Sodmanba340492018-08-05 21:51:33 -0700555 return true;
556 }
557
Mathias Agopian13127d82013-03-05 17:47:11 -0800558 // -----------------------------------------------------------------------
David Sodmanc1498e62018-09-12 14:36:26 -0700559 void clearWithOpenGL(const RenderArea& renderArea) const;
Mathias Agopian13127d82013-03-05 17:47:11 -0800560
David Sodman41fdfc92017-11-06 16:09:56 -0800561 inline const State& getDrawingState() const { return mDrawingState; }
562 inline const State& getCurrentState() const { return mCurrentState; }
563 inline State& getCurrentState() { return mCurrentState; }
Mathias Agopian13127d82013-03-05 17:47:11 -0800564
Kalle Raitaa099a242017-01-11 11:17:29 -0800565 LayerDebugInfo getLayerDebugInfo() const;
Mathias Agopian13127d82013-03-05 17:47:11 -0800566
567 /* always call base class first */
Yiwei Zhang5434a782018-12-05 18:06:32 -0800568 static void miniDumpHeader(std::string& result);
569 void miniDump(std::string& result, DisplayId displayId) const;
570 void dumpFrameStats(std::string& result) const;
571 void dumpFrameEvents(std::string& result);
Svetoslavd85084b2014-03-20 10:28:31 -0700572 void clearFrameStats();
Jamie Gennis6547ff42013-07-16 20:12:42 -0700573 void logFrameStats();
Svetoslavd85084b2014-03-20 10:28:31 -0700574 void getFrameStats(FrameStats* outStats) const;
Mathias Agopian1b5e1022010-04-20 17:55:49 -0700575
Robert Carr105e64b2018-03-07 12:47:50 -0800576 virtual std::vector<OccupancyTracker::Segment> getOccupancyHistory(bool /*forceFlush*/) {
577 return {};
578 }
Dan Stozae77c7662016-05-13 11:37:28 -0700579
Brian Anderson5ea5e592016-12-01 16:54:33 -0800580 void onDisconnect();
Brian Anderson3890c392016-07-25 12:48:08 -0700581 void addAndGetFrameTimestamps(const NewFrameEventsEntry* newEntry,
David Sodman41fdfc92017-11-06 16:09:56 -0800582 FrameEventHistoryDelta* outDelta);
Pablo Ceballosce796e72016-02-04 19:10:51 -0800583
Robert Carr105e64b2018-03-07 12:47:50 -0800584 virtual bool getTransformToDisplayInverse() const { return false; }
Robert Carr367c5682016-06-20 11:55:28 -0700585
Peiyong Linefefaac2018-08-17 12:27:51 -0700586 ui::Transform getTransform() const;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700587
Robert Carr6452f122017-03-21 10:41:29 -0700588 // Returns the Alpha of the Surface, accounting for the Alpha
589 // of parent Surfaces in the hierarchy (alpha's will be multiplied
590 // down the hierarchy).
chaviw13fdc492017-06-27 12:40:18 -0700591 half getAlpha() const;
592 half4 getColor() const;
Robert Carr6452f122017-03-21 10:41:29 -0700593
Lucas Dupin1b6531c2018-07-05 17:18:21 -0700594 // Returns how rounded corners should be drawn for this layer.
595 // This will traverse the hierarchy until it reaches its root, finding topmost rounded
596 // corner definition and converting it into current layer's coordinates.
597 // As of now, only 1 corner radius per display list is supported. Subsequent ones will be
598 // ignored.
599 RoundedCornerState getRoundedCornerState() const;
600
Dan Stoza412903f2017-04-27 13:42:17 -0700601 void traverseInReverseZOrder(LayerVector::StateSet stateSet,
602 const LayerVector::Visitor& visitor);
603 void traverseInZOrder(LayerVector::StateSet stateSet, const LayerVector::Visitor& visitor);
Robert Carr1f0a16a2016-10-24 16:27:39 -0700604
chaviw4b129c22018-04-09 16:19:43 -0700605 /**
606 * Traverse only children in z order, ignoring relative layers that are not children of the
607 * parent.
608 */
chaviwa76b2712017-09-20 12:02:26 -0700609 void traverseChildrenInZOrder(LayerVector::StateSet stateSet,
610 const LayerVector::Visitor& visitor);
611
Chia-I Wu98f1c102017-05-30 14:54:08 -0700612 size_t getChildrenCount() const;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700613 void addChild(const sp<Layer>& layer);
614 // Returns index if removed, or negative value otherwise
615 // for symmetry with Vector::remove
616 ssize_t removeChild(const sp<Layer>& layer);
Chia-I Wue41dbe62017-06-13 14:10:56 -0700617 sp<Layer> getParent() const { return mCurrentParent.promote(); }
Robert Carr1f0a16a2016-10-24 16:27:39 -0700618 bool hasParent() const { return getParent() != nullptr; }
Vishnu Nair60356342018-11-13 13:00:45 -0800619 Rect computeScreenBounds() const;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700620 bool setChildLayer(const sp<Layer>& childLayer, int32_t z);
Robert Carr503c7042017-09-27 15:06:08 -0700621 bool setChildRelativeLayer(const sp<Layer>& childLayer,
622 const sp<IBinder>& relativeToHandle, int32_t relativeZ);
Robert Carr1f0a16a2016-10-24 16:27:39 -0700623
624 // Copy the current list of children to the drawing state. Called by
625 // SurfaceFlinger to complete a transaction.
626 void commitChildList();
Robert Carr1f0a16a2016-10-24 16:27:39 -0700627 int32_t getZ() const;
Marissa Wall61c58622018-07-18 10:12:20 -0700628 virtual void pushPendingState();
David Sodman41fdfc92017-11-06 16:09:56 -0800629
Vishnu Nair88a11f22018-11-28 18:30:57 -0800630 /**
631 * Returns active buffer size in the correct orientation. Buffer size is determined by undoing
632 * any buffer transformations. If the layer has no buffer then return INVALID_RECT.
633 */
634 virtual Rect getBufferSize(const Layer::State&) const { return Rect::INVALID_RECT; }
635
Mathias Agopian13127d82013-03-05 17:47:11 -0800636protected:
637 // constant
638 sp<SurfaceFlinger> mFlinger;
Mathias Agopian13127d82013-03-05 17:47:11 -0800639 /*
640 * Trivial class, used to ensure that mFlinger->onLayerDestroyed(mLayer)
641 * is called.
642 */
643 class LayerCleaner {
644 sp<SurfaceFlinger> mFlinger;
Robert Carr2e102c92018-10-23 12:11:15 -0700645 sp<Layer> mLayer;
David Sodman41fdfc92017-11-06 16:09:56 -0800646
Mathias Agopian13127d82013-03-05 17:47:11 -0800647 protected:
Irvel468051e2016-06-13 16:44:44 -0700648 ~LayerCleaner() {
649 // destroy client resources
Robert Carr2e102c92018-10-23 12:11:15 -0700650 mFlinger->onHandleDestroyed(mLayer);
Irvel468051e2016-06-13 16:44:44 -0700651 }
David Sodman41fdfc92017-11-06 16:09:56 -0800652
Mathias Agopian13127d82013-03-05 17:47:11 -0800653 public:
David Sodman41fdfc92017-11-06 16:09:56 -0800654 LayerCleaner(const sp<SurfaceFlinger>& flinger, const sp<Layer>& layer)
655 : mFlinger(flinger), mLayer(layer) {}
Mathias Agopian13127d82013-03-05 17:47:11 -0800656 };
657
Lloyd Pique4dccc412018-01-22 17:21:36 -0800658 friend class impl::SurfaceInterceptor;
David Sodmaneb085e02017-10-05 18:49:04 -0700659
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700660 // For unit tests
661 friend class TestableSurfaceFlinger;
662
Pablo Ceballos05289c22016-04-14 15:49:55 -0700663 void commitTransaction(const State& stateToCommit);
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700664
Mathias Agopian3330b202009-10-05 17:07:12 -0700665 uint32_t getEffectiveUsage(uint32_t usage) const;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700666
Yichi Chenf6833402018-06-22 17:32:10 +0800667 virtual FloatRect computeCrop(const sp<const DisplayDevice>& display) const;
David Sodman0c69cad2017-08-21 12:12:51 -0700668 // Compute the initial crop as specified by parent layers and the
669 // SurfaceControl for this layer. Does not include buffer crop from the
670 // IGraphicBufferProducer client, as that should not affect child clipping.
671 // Returns in screen space.
Dominik Laskowskia2edf612018-06-01 13:15:16 -0700672 Rect computeInitialCrop(const sp<const DisplayDevice>& display) const;
Lucas Dupin1b6531c2018-07-05 17:18:21 -0700673 /**
674 * Setup rounded corners coordinates of this layer, taking into account the layer bounds and
675 * crop coordinates, transforming them into layer space.
676 */
677 void setupRoundedCornersCropCoordinates(Rect win, const FloatRect& roundedCornersCrop) const;
Mathias Agopian0aa758d2009-04-22 15:23:34 -0700678
Mathias Agopian13127d82013-03-05 17:47:11 -0800679 // drawing
David Sodman41fdfc92017-11-06 16:09:56 -0800680 void clearWithOpenGL(const RenderArea& renderArea, float r, float g, float b,
681 float alpha) const;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700682 void setParent(const sp<Layer>& layer);
683
Robert Carr29abff82017-12-04 13:51:20 -0800684 LayerVector makeTraversalList(LayerVector::StateSet stateSet, bool* outSkipRelativeZUsers);
Robert Carrdb66e622017-04-10 16:55:57 -0700685 void addZOrderRelative(const wp<Layer>& relative);
686 void removeZOrderRelative(const wp<Layer>& relative);
687
David Sodman41fdfc92017-11-06 16:09:56 -0800688 class SyncPoint {
Dan Stoza7dde5992015-05-22 09:51:44 -0700689 public:
David Sodman41fdfc92017-11-06 16:09:56 -0800690 explicit SyncPoint(uint64_t frameNumber)
691 : mFrameNumber(frameNumber), mFrameIsAvailable(false), mTransactionIsApplied(false) {}
Dan Stoza7dde5992015-05-22 09:51:44 -0700692
David Sodman41fdfc92017-11-06 16:09:56 -0800693 uint64_t getFrameNumber() const { return mFrameNumber; }
Dan Stoza7dde5992015-05-22 09:51:44 -0700694
David Sodman41fdfc92017-11-06 16:09:56 -0800695 bool frameIsAvailable() const { return mFrameIsAvailable; }
Dan Stoza7dde5992015-05-22 09:51:44 -0700696
David Sodman41fdfc92017-11-06 16:09:56 -0800697 void setFrameAvailable() { mFrameIsAvailable = true; }
Dan Stoza7dde5992015-05-22 09:51:44 -0700698
David Sodman41fdfc92017-11-06 16:09:56 -0800699 bool transactionIsApplied() const { return mTransactionIsApplied; }
Dan Stoza7dde5992015-05-22 09:51:44 -0700700
David Sodman41fdfc92017-11-06 16:09:56 -0800701 void setTransactionApplied() { mTransactionIsApplied = true; }
Dan Stoza7dde5992015-05-22 09:51:44 -0700702
703 private:
704 const uint64_t mFrameNumber;
705 std::atomic<bool> mFrameIsAvailable;
706 std::atomic<bool> mTransactionIsApplied;
707 };
708
Dan Stozacac35382016-01-27 12:21:06 -0800709 // SyncPoints which will be signaled when the correct frame is at the head
710 // of the queue and dropped after the frame has been latched. Protected by
711 // mLocalSyncPointMutex.
712 Mutex mLocalSyncPointMutex;
Dan Stoza7dde5992015-05-22 09:51:44 -0700713 std::list<std::shared_ptr<SyncPoint>> mLocalSyncPoints;
714
Dan Stozacac35382016-01-27 12:21:06 -0800715 // SyncPoints which will be signaled and then dropped when the transaction
716 // is applied
Dan Stoza7dde5992015-05-22 09:51:44 -0700717 std::list<std::shared_ptr<SyncPoint>> mRemoteSyncPoints;
718
Dan Stozacac35382016-01-27 12:21:06 -0800719 // Returns false if the relevant frame has already been latched
720 bool addSyncPoint(const std::shared_ptr<SyncPoint>& point);
Dan Stoza7dde5992015-05-22 09:51:44 -0700721
Pablo Ceballos05289c22016-04-14 15:49:55 -0700722 void popPendingState(State* stateToCommit);
Marissa Wall61c58622018-07-18 10:12:20 -0700723 virtual bool applyPendingStates(State* stateToCommit);
724 virtual uint32_t doTransactionResize(uint32_t flags, Layer::State* stateToCommit);
Robert Carrc3574f72016-03-24 12:19:32 -0700725
Robert Carr1f0a16a2016-10-24 16:27:39 -0700726 void clearSyncPoints();
727
Robert Carrc3574f72016-03-24 12:19:32 -0700728 // Returns mCurrentScaling mode (originating from the
729 // Client) or mOverrideScalingMode mode (originating from
730 // the Surface Controller) if set.
Robert Carr105e64b2018-03-07 12:47:50 -0800731 virtual uint32_t getEffectiveScalingMode() const { return 0; }
David Sodman41fdfc92017-11-06 16:09:56 -0800732
Dan Stoza7dde5992015-05-22 09:51:44 -0700733public:
Irvel468051e2016-06-13 16:44:44 -0700734 /*
735 * The layer handle is just a BBinder object passed to the client
736 * (remote process) -- we don't keep any reference on our side such that
737 * the dtor is called when the remote side let go of its reference.
738 *
739 * LayerCleaner ensures that mFlinger->onLayerDestroyed() is called for
740 * this layer when the handle is destroyed.
741 */
742 class Handle : public BBinder, public LayerCleaner {
David Sodman41fdfc92017-11-06 16:09:56 -0800743 public:
744 Handle(const sp<SurfaceFlinger>& flinger, const sp<Layer>& layer)
745 : LayerCleaner(flinger, layer), owner(layer) {}
Irvel468051e2016-06-13 16:44:44 -0700746
David Sodman41fdfc92017-11-06 16:09:56 -0800747 wp<Layer> owner;
Irvel468051e2016-06-13 16:44:44 -0700748 };
749
750 sp<IBinder> getHandle();
Irvel468051e2016-06-13 16:44:44 -0700751 const String8& getName() const;
Robert Carr105e64b2018-03-07 12:47:50 -0800752 virtual void notifyAvailableFrames() {}
753 virtual PixelFormat getPixelFormat() const { return PIXEL_FORMAT_NONE; }
chaviw13fdc492017-06-27 12:40:18 -0700754 bool getPremultipledAlpha() const;
Igor Murashkina4a31492012-10-29 13:36:11 -0700755
Robert Carr2e102c92018-10-23 12:11:15 -0700756 bool mPendingHWCDestroy{false};
Robert Carr720e5062018-07-30 17:45:14 -0700757 void setInputInfo(const InputWindowInfo& info);
758
759 InputWindowInfo fillInputInfo(const Rect& screenBounds);
760 bool hasInput() const;
Robert Carr2e102c92018-10-23 12:11:15 -0700761
David Sodman41fdfc92017-11-06 16:09:56 -0800762protected:
Mathias Agopianb7e930d2010-06-01 15:12:58 -0700763 // -----------------------------------------------------------------------
Robert Carr29abff82017-12-04 13:51:20 -0800764 bool usingRelativeZ(LayerVector::StateSet stateSet);
Mathias Agopianb7e930d2010-06-01 15:12:58 -0700765
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700766 bool mPremultipliedAlpha{true};
Mathias Agopian13127d82013-03-05 17:47:11 -0800767 String8 mName;
David Sodman41fdfc92017-11-06 16:09:56 -0800768 String8 mTransactionName; // A cached version of "TX - " + mName for systraces
Mathias Agopian13127d82013-03-05 17:47:11 -0800769
Chia-I Wuab0c3192017-08-01 11:29:00 -0700770 bool mPrimaryDisplayOnly = false;
771
Mathias Agopian13127d82013-03-05 17:47:11 -0800772 // these are protected by an external lock
773 State mCurrentState;
774 State mDrawingState;
Lloyd Piquef1c675b2018-09-12 20:45:39 -0700775 std::atomic<uint32_t> mTransactionFlags{0};
Mathias Agopiand606de62010-05-10 20:06:11 -0700776
Dan Stoza7dde5992015-05-22 09:51:44 -0700777 // Accessed from main thread and binder threads
778 Mutex mPendingStateMutex;
779 Vector<State> mPendingStates;
780
Brian Andersond6927fb2016-07-23 23:37:30 -0700781 // Timestamp history for UIAutomation. Thread safe.
Jamie Gennis4b0eba92013-02-05 13:30:24 -0800782 FrameTracker mFrameTracker;
Mathias Agopiana67932f2011-04-20 14:20:59 -0700783
Brian Andersond6927fb2016-07-23 23:37:30 -0700784 // Timestamp history for the consumer to query.
785 // Accessed by both consumer and producer on main and binder threads.
786 Mutex mFrameEventHistoryMutex;
Brian Anderson3890c392016-07-25 12:48:08 -0700787 ConsumerFrameEventHistory mFrameEventHistory;
Brian Anderson3d4039d2016-09-23 16:31:30 -0700788 FenceTimeline mAcquireTimeline;
789 FenceTimeline mReleaseTimeline;
Brian Andersond6927fb2016-07-23 23:37:30 -0700790
Mathias Agopiana67932f2011-04-20 14:20:59 -0700791 // main thread
792 sp<GraphicBuffer> mActiveBuffer;
Chia-I Wu01591c92018-05-22 12:03:00 -0700793 ui::Dataspace mCurrentDataSpace = ui::Dataspace::UNKNOWN;
Mathias Agopiana67932f2011-04-20 14:20:59 -0700794 Rect mCurrentCrop;
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700795 uint32_t mCurrentTransform{0};
Robert Carrc3574f72016-03-24 12:19:32 -0700796 // We encode unset as -1.
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700797 int32_t mOverrideScalingMode{-1};
798 std::atomic<uint64_t> mCurrentFrameNumber{0};
799 bool mFrameLatencyNeeded{false};
Mathias Agopian13127d82013-03-05 17:47:11 -0800800 // Whether filtering is needed b/c of the drawingstate
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700801 bool mNeedsFiltering{false};
David Sodman0c69cad2017-08-21 12:12:51 -0700802
Robert Carr2e102c92018-10-23 12:11:15 -0700803 std::atomic<bool> mRemovedFromCurrentState{false};
chaviw8b3871a2017-11-01 17:41:01 -0700804
Mathias Agopianb7e930d2010-06-01 15:12:58 -0700805 // page-flip thread (currently main thread)
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700806 bool mProtectedByApp{false}; // application requires protected path to external sink
Mathias Agopian13127d82013-03-05 17:47:11 -0800807
808 // protected by mLock
809 mutable Mutex mLock;
David Sodman0c69cad2017-08-21 12:12:51 -0700810
Mathias Agopian13127d82013-03-05 17:47:11 -0800811 const wp<Client> mClientRef;
Riley Andrews03414a12014-07-01 14:22:59 -0700812
813 // This layer can be a cursor on some displays.
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700814 bool mPotentialCursor{false};
Dan Stoza6b9454d2014-11-07 16:00:59 -0800815
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700816 bool mFreezeGeometryUpdates{false};
Robert Carr1f0a16a2016-10-24 16:27:39 -0700817
818 // Child list about to be committed/used for editing.
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700819 LayerVector mCurrentChildren{LayerVector::StateSet::Current};
Robert Carr1f0a16a2016-10-24 16:27:39 -0700820 // Child list used for rendering.
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700821 LayerVector mDrawingChildren{LayerVector::StateSet::Drawing};
Robert Carr1f0a16a2016-10-24 16:27:39 -0700822
Chia-I Wue41dbe62017-06-13 14:10:56 -0700823 wp<Layer> mCurrentParent;
824 wp<Layer> mDrawingParent;
David Sodman9eeae692017-11-02 10:53:32 -0700825
826 mutable LayerBE mBE;
chaviw4b129c22018-04-09 16:19:43 -0700827
chaviw5aedec92018-10-22 10:40:38 -0700828 // Can only be accessed with the SF state lock held.
829 bool mLayerDetached{false};
830
chaviw4b129c22018-04-09 16:19:43 -0700831private:
832 /**
833 * Returns an unsorted vector of all layers that are part of this tree.
834 * That includes the current layer and all its descendants.
835 */
836 std::vector<Layer*> getLayersInTree(LayerVector::StateSet stateSet);
837 /**
838 * Traverses layers that are part of this tree in the correct z order.
839 * layersInTree must be sorted before calling this method.
840 */
841 void traverseChildrenInZOrderInner(const std::vector<Layer*>& layersInTree,
842 LayerVector::StateSet stateSet,
843 const LayerVector::Visitor& visitor);
844 LayerVector makeChildrenTraversalList(LayerVector::StateSet stateSet,
845 const std::vector<Layer*>& layersInTree);
Vishnu Nair60356342018-11-13 13:00:45 -0800846
847 /**
848 * Retuns the child bounds in layer space cropped to its bounds as well all its parent bounds.
849 * The cropped bounds must be transformed back from parent layer space to child layer space by
850 * applying the inverse of the child's transformation.
851 */
852 FloatRect cropChildBounds(const FloatRect& childBounds) const;
853
854 /**
855 * Returns the cropped buffer size or the layer crop if the layer has no buffer. Return
856 * INVALID_RECT if the layer has no buffer and no crop.
857 * A layer with an invalid buffer size and no crop is considered to be boundless. The layer
858 * bounds are constrained by its parent bounds.
859 */
860 Rect getCroppedBufferSize(const Layer::State& s) const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800861};
862
Dominik Laskowski34157762018-10-31 13:07:19 -0700863} // namespace android
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800864
Dominik Laskowski34157762018-10-31 13:07:19 -0700865#define RETURN_IF_NO_HWC_LAYER(displayId, ...) \
866 do { \
867 if (!hasHwcLayer(displayId)) { \
868 ALOGE("[%s] %s failed: no HWC layer found for display %s", mName.string(), \
869 __FUNCTION__, to_string(displayId).c_str()); \
870 return __VA_ARGS__; \
871 } \
872 } while (false)
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800873
874#endif // ANDROID_LAYER_H