blob: 40ebe1ed4dd3fa36218e00aef93dda9d4f94e228 [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>
25#include <layerproto/LayerProtoHeader.h>
26#include <math/vec4.h>
27#include <renderengine/Mesh.h>
28#include <renderengine/Texture.h>
Dan Stoza80d61162017-12-20 15:57:52 -080029#include <ui/FloatRect.h>
Svetoslavd85084b2014-03-20 10:28:31 -070030#include <ui/FrameStats.h>
Mathias Agopian13127d82013-03-05 17:47:11 -080031#include <ui/GraphicBuffer.h>
32#include <ui/PixelFormat.h>
33#include <ui/Region.h>
Peiyong Linefefaac2018-08-17 12:27:51 -070034#include <ui/Transform.h>
Peiyong Lincbc184f2018-08-22 13:24:10 -070035#include <utils/RefBase.h>
36#include <utils/String8.h>
37#include <utils/Timers.h>
Mathias Agopian13127d82013-03-05 17:47:11 -080038
Robert Carrcdf83202018-03-07 12:48:34 -080039#include <cstdint>
Peiyong Lincbc184f2018-08-22 13:24:10 -070040#include <list>
Dominik Laskowski075d3172018-05-24 15:50:06 -070041#include <optional>
Peiyong Lincbc184f2018-08-22 13:24:10 -070042#include <vector>
Dan Stoza7dde5992015-05-22 09:51:44 -070043
Mathias Agopian13127d82013-03-05 17:47:11 -080044#include "Client.h"
David Sodman41fdfc92017-11-06 16:09:56 -080045#include "FrameTracker.h"
Yiwei Zhangfaf3ded2018-05-02 17:37:17 -070046#include "LayerBE.h"
Robert Carr1f0a16a2016-10-24 16:27:39 -070047#include "LayerVector.h"
Dan Stozab9b08832014-03-13 11:55:57 -070048#include "MonitoredProducer.h"
Mathias Agopian13127d82013-03-05 17:47:11 -080049#include "SurfaceFlinger.h"
Yiwei Zhangfaf3ded2018-05-02 17:37:17 -070050#include "TimeStats/TimeStats.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,
112 };
113
114 struct Geometry {
115 uint32_t w;
116 uint32_t h;
Peiyong Linefefaac2018-08-17 12:27:51 -0700117 ui::Transform transform;
Robert Carr3dcabfa2016-03-01 18:36:58 -0800118
David Sodman41fdfc92017-11-06 16:09:56 -0800119 inline bool operator==(const Geometry& rhs) const {
120 return (w == rhs.w && h == rhs.h) && (transform.tx() == rhs.transform.tx()) &&
Robert Carr99e27f02016-06-16 15:18:02 -0700121 (transform.ty() == rhs.transform.ty());
Mathias Agopian13127d82013-03-05 17:47:11 -0800122 }
David Sodman41fdfc92017-11-06 16:09:56 -0800123 inline bool operator!=(const Geometry& rhs) const { return !operator==(rhs); }
Mathias Agopian13127d82013-03-05 17:47:11 -0800124 };
125
126 struct State {
Marissa Wallf58c14b2018-07-24 10:50:43 -0700127 Geometry active_legacy;
128 Geometry requested_legacy;
Robert Carrae060832016-11-28 10:51:00 -0800129 int32_t z;
Fabien Sanglardf0c53d62017-03-03 18:58:50 -0800130
131 // The identifier of the layer stack this layer belongs to. A layer can
132 // only be associated to a single layer stack. A layer stack is a
133 // z-ordered group of layers which can be associated to one or more
134 // displays. Using the same layer stack on different displays is a way
135 // to achieve mirroring.
Mathias Agopian13127d82013-03-05 17:47:11 -0800136 uint32_t layerStack;
Fabien Sanglardf0c53d62017-03-03 18:58:50 -0800137
Mathias Agopian13127d82013-03-05 17:47:11 -0800138 uint8_t flags;
139 uint8_t reserved[2];
140 int32_t sequence; // changes when visible regions can change
Dan Stoza7dde5992015-05-22 09:51:44 -0700141 bool modified;
142
Fabien Sanglard4ed383c2016-12-13 14:02:41 -0800143 // Crop is expressed in layer space coordinate.
Marissa Wallf58c14b2018-07-24 10:50:43 -0700144 Rect crop_legacy;
145 Rect requestedCrop_legacy;
Robert Carr99e27f02016-06-16 15:18:02 -0700146
Robert Carr0d480722017-01-10 16:42:54 -0800147 // If set, defers this state update until the identified Layer
Dan Stoza7dde5992015-05-22 09:51:44 -0700148 // receives a frame with the given frameNumber
Marissa Wallf58c14b2018-07-24 10:50:43 -0700149 wp<Layer> barrierLayer_legacy;
150 uint64_t frameNumber_legacy;
Dan Stoza7dde5992015-05-22 09:51:44 -0700151
Mathias Agopian2ca79392013-04-02 18:30:32 -0700152 // the transparentRegion hint is a bit special, it's latched only
153 // when we receive a buffer -- this is because it's "content"
154 // dependent.
Marissa Wallf58c14b2018-07-24 10:50:43 -0700155 Region activeTransparentRegion_legacy;
156 Region requestedTransparentRegion_legacy;
Daniel Nicoara2f5f8a52016-12-20 16:11:58 -0500157
rongliucfb187b2018-03-14 12:26:23 -0700158 int32_t appId;
159 int32_t type;
Robert Carrdb66e622017-04-10 16:55:57 -0700160
161 // If non-null, a Surface this Surface's Z-order is interpreted relative to.
162 wp<Layer> zOrderRelativeOf;
163
164 // A list of surfaces whose Z-order is interpreted relative to ours.
165 SortedVector<wp<Layer>> zOrderRelatives;
chaviw13fdc492017-06-27 12:40:18 -0700166
167 half4 color;
Marissa Wall61c58622018-07-18 10:12:20 -0700168
169 // The fields below this point are only used by BufferStateLayer
170 Geometry active;
171
172 uint32_t transform;
173 bool transformToDisplayInverse;
174
175 Rect crop;
176 Region transparentRegionHint;
177
178 sp<GraphicBuffer> buffer;
179 sp<Fence> acquireFence;
180 ui::Dataspace dataspace;
181 HdrMetadata hdrMetadata;
182 Region surfaceDamageRegion;
183 int32_t api;
184
185 sp<NativeHandle> sidebandStream;
Peiyong Lind3788632018-09-18 16:01:31 -0700186 mat4 colorTransform;
Peiyong Lin747321c2018-10-01 10:03:11 -0700187 bool hasColorTransform;
Marissa Walle2ffb422018-10-12 11:33:52 -0700188
189 // The deque of callback handles for this frame. The back of the deque contains the most
190 // recent callback handle.
191 std::deque<sp<CallbackHandle>> callbackHandles;
Mathias Agopian13127d82013-03-05 17:47:11 -0800192 };
193
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700194 explicit Layer(const LayerCreationArgs& args);
Mathias Agopianb7e930d2010-06-01 15:12:58 -0700195 virtual ~Layer();
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800196
Chia-I Wuab0c3192017-08-01 11:29:00 -0700197 void setPrimaryDisplayOnly() { mPrimaryDisplayOnly = true; }
198
Robert Carr7bf247e2017-05-18 14:02:49 -0700199 // ------------------------------------------------------------------------
200 // Geometry setting functions.
201 //
202 // The following group of functions are used to specify the layers
203 // bounds, and the mapping of the texture on to those bounds. According
204 // to various settings changes to them may apply immediately, or be delayed until
205 // a pending resize is completed by the producer submitting a buffer. For example
206 // if we were to change the buffer size, and update the matrix ahead of the
207 // new buffer arriving, then we would be stretching the buffer to a different
208 // aspect before and after the buffer arriving, which probably isn't what we wanted.
209 //
210 // The first set of geometry functions are controlled by the scaling mode, described
211 // in window.h. The scaling mode may be set by the client, as it submits buffers.
212 // This value may be overriden through SurfaceControl, with setOverrideScalingMode.
213 //
214 // Put simply, if our scaling mode is SCALING_MODE_FREEZE, then
215 // matrix updates will not be applied while a resize is pending
216 // and the size and transform will remain in their previous state
217 // until a new buffer is submitted. If the scaling mode is another value
218 // then the old-buffer will immediately be scaled to the pending size
219 // and the new matrix will be immediately applied following this scaling
220 // transformation.
Robert Carr8d5227b2017-03-16 15:41:03 -0700221
Robert Carr7bf247e2017-05-18 14:02:49 -0700222 // Set the default buffer size for the assosciated Producer, in pixels. This is
223 // also the rendered size of the layer prior to any transformations. Parent
224 // or local matrix transformations will not affect the size of the buffer,
225 // but may affect it's on-screen size or clipping.
Marissa Wall61c58622018-07-18 10:12:20 -0700226 virtual bool setSize(uint32_t w, uint32_t h);
Robert Carr7bf247e2017-05-18 14:02:49 -0700227 // Set a 2x2 transformation matrix on the layer. This transform
228 // will be applied after parent transforms, but before any final
229 // producer specified transform.
Marissa Wall61c58622018-07-18 10:12:20 -0700230 virtual bool setMatrix(const layer_state_t::matrix22_t& matrix,
231 bool allowNonRectPreservingTransforms);
Robert Carr7bf247e2017-05-18 14:02:49 -0700232
233 // This second set of geometry attributes are controlled by
234 // setGeometryAppliesWithResize, and their default mode is to be
235 // immediate. If setGeometryAppliesWithResize is specified
236 // while a resize is pending, then update of these attributes will
237 // be delayed until the resize completes.
238
239 // setPosition operates in parent buffer space (pre parent-transform) or display
240 // space for top-level layers.
Marissa Wall61c58622018-07-18 10:12:20 -0700241 virtual bool setPosition(float x, float y, bool immediate);
Robert Carr7bf247e2017-05-18 14:02:49 -0700242 // Buffer space
Marissa Wall61c58622018-07-18 10:12:20 -0700243 virtual bool setCrop_legacy(const Rect& crop, bool immediate);
Robert Carr8d5227b2017-03-16 15:41:03 -0700244
Robert Carr7bf247e2017-05-18 14:02:49 -0700245 // TODO(b/38182121): Could we eliminate the various latching modes by
246 // using the layer hierarchy?
247 // -----------------------------------------------------------------------
Marissa Wall61c58622018-07-18 10:12:20 -0700248 virtual bool setLayer(int32_t z);
249 virtual bool setRelativeLayer(const sp<IBinder>& relativeToHandle, int32_t relativeZ);
Robert Carrdb66e622017-04-10 16:55:57 -0700250
Marissa Wall61c58622018-07-18 10:12:20 -0700251 virtual bool setAlpha(float alpha);
252 virtual bool setColor(const half3& color);
253 virtual bool setTransparentRegionHint(const Region& transparent);
254 virtual bool setFlags(uint8_t flags, uint8_t mask);
255 virtual bool setLayerStack(uint32_t layerStack);
256 virtual uint32_t getLayerStack() const;
257 virtual void deferTransactionUntil_legacy(const sp<IBinder>& barrierHandle,
258 uint64_t frameNumber);
259 virtual void deferTransactionUntil_legacy(const sp<Layer>& barrierLayer, uint64_t frameNumber);
260 virtual bool setOverrideScalingMode(int32_t overrideScalingMode);
261 virtual void setInfo(int32_t type, int32_t appId);
262 virtual bool reparentChildren(const sp<IBinder>& layer);
263 virtual void setChildrenDrawingParent(const sp<Layer>& layer);
264 virtual bool reparent(const sp<IBinder>& newParentHandle);
265 virtual bool detachChildren();
Peiyong Lind3788632018-09-18 16:01:31 -0700266 virtual bool setColorTransform(const mat4& matrix);
267 virtual const mat4& getColorTransform() const;
268 virtual bool hasColorTransform() const;
Marissa Wall61c58622018-07-18 10:12:20 -0700269
270 // Used only to set BufferStateLayer state
271 virtual bool setTransform(uint32_t /*transform*/) { return false; };
272 virtual bool setTransformToDisplayInverse(bool /*transformToDisplayInverse*/) { return false; };
273 virtual bool setCrop(const Rect& /*crop*/) { return false; };
Marissa Wallfda30bb2018-10-12 11:34:28 -0700274 virtual bool setBuffer(const sp<GraphicBuffer>& /*buffer*/) { return false; };
Marissa Wall61c58622018-07-18 10:12:20 -0700275 virtual bool setAcquireFence(const sp<Fence>& /*fence*/) { return false; };
276 virtual bool setDataspace(ui::Dataspace /*dataspace*/) { return false; };
277 virtual bool setHdrMetadata(const HdrMetadata& /*hdrMetadata*/) { return false; };
278 virtual bool setSurfaceDamageRegion(const Region& /*surfaceDamage*/) { return false; };
279 virtual bool setApi(int32_t /*api*/) { return false; };
280 virtual bool setSidebandStream(const sp<NativeHandle>& /*sidebandStream*/) { return false; };
Marissa Walle2ffb422018-10-12 11:33:52 -0700281 virtual bool setTransactionCompletedListeners(
282 const std::vector<sp<CallbackHandle>>& /*handles*/) {
283 return false;
284 };
Mathias Agopian13127d82013-03-05 17:47:11 -0800285
Chia-I Wu01591c92018-05-22 12:03:00 -0700286 ui::Dataspace getDataSpace() const { return mCurrentDataSpace; }
287
Peiyong Lindd9b2ae2018-03-01 16:22:45 -0800288 // Before color management is introduced, contents on Android have to be
289 // desaturated in order to match what they appears like visually.
290 // With color management, these contents will appear desaturated, thus
291 // needed to be saturated so that they match what they are designed for
Chia-I Wu11481472018-05-04 10:43:19 -0700292 // visually.
293 bool isLegacyDataSpace() const;
Peiyong Lindd9b2ae2018-03-01 16:22:45 -0800294
Dan Stozaee44edd2015-03-23 15:50:23 -0700295 // If we have received a new buffer this frame, we will pass its surface
296 // damage down to hardware composer. Otherwise, we must send a region with
297 // one empty rect.
Robert Carr105e64b2018-03-07 12:47:50 -0800298 virtual void useSurfaceDamage() {}
299 virtual void useEmptyDamage() {}
Dan Stozaee44edd2015-03-23 15:50:23 -0700300
Lloyd Piquef1c675b2018-09-12 20:45:39 -0700301 uint32_t getTransactionFlags() const { return mTransactionFlags; }
Mathias Agopian13127d82013-03-05 17:47:11 -0800302 uint32_t getTransactionFlags(uint32_t flags);
303 uint32_t setTransactionFlags(uint32_t flags);
304
Chia-I Wuab0c3192017-08-01 11:29:00 -0700305 bool belongsToDisplay(uint32_t layerStack, bool isPrimaryDisplay) const {
306 return getLayerStack() == layerStack && (!mPrimaryDisplayOnly || isPrimaryDisplay);
307 }
308
Peiyong Lin833074a2018-08-28 11:53:54 -0700309 void computeGeometry(const RenderArea& renderArea, renderengine::Mesh& mesh,
310 bool useIdentityTransform) const;
Dan Stoza80d61162017-12-20 15:57:52 -0800311 FloatRect computeBounds(const Region& activeTransparentRegion) const;
312 FloatRect computeBounds() const;
Mathias Agopian13127d82013-03-05 17:47:11 -0800313
Pablo Ceballos40845df2016-01-25 17:41:15 -0800314 int32_t getSequence() const { return sequence; }
315
Mathias Agopian13127d82013-03-05 17:47:11 -0800316 // -----------------------------------------------------------------------
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700317 // Virtuals
David Sodman0c69cad2017-08-21 12:12:51 -0700318 virtual const char* getTypeId() const = 0;
Mathias Agopian13127d82013-03-05 17:47:11 -0800319
Mathias Agopian13127d82013-03-05 17:47:11 -0800320 /*
321 * isOpaque - true if this surface is opaque
Andy McFadden4125a4f2014-01-29 17:17:11 -0800322 *
323 * This takes into account the buffer format (i.e. whether or not the
324 * pixel format includes an alpha channel) and the "opaque" flag set
325 * on the layer. It does not examine the current plane alpha value.
Mathias Agopian13127d82013-03-05 17:47:11 -0800326 */
Robert Carr105e64b2018-03-07 12:47:50 -0800327 virtual bool isOpaque(const Layer::State&) const { return false; }
Mathias Agopian13127d82013-03-05 17:47:11 -0800328
329 /*
330 * isSecure - true if this surface is secure, that is if it prevents
331 * screenshots or VNC servers.
332 */
David Sodman0c69cad2017-08-21 12:12:51 -0700333 bool isSecure() const;
Mathias Agopian13127d82013-03-05 17:47:11 -0800334
335 /*
336 * isVisible - true if this layer is visible, false otherwise
337 */
David Sodman0c69cad2017-08-21 12:12:51 -0700338 virtual bool isVisible() const = 0;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800339
Mathias Agopian13127d82013-03-05 17:47:11 -0800340 /*
Robert Carr1f0a16a2016-10-24 16:27:39 -0700341 * isHiddenByPolicy - true if this layer has been forced invisible.
342 * just because this is false, doesn't mean isVisible() is true.
343 * For example if this layer has no active buffer, it may not be hidden by
344 * policy, but it still can not be visible.
345 */
David Sodman0c69cad2017-08-21 12:12:51 -0700346 bool isHiddenByPolicy() const;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700347
348 /*
Mathias Agopian13127d82013-03-05 17:47:11 -0800349 * isFixedSize - true if content has a fixed size
350 */
Robert Carr105e64b2018-03-07 12:47:50 -0800351 virtual bool isFixedSize() const { return true; }
352
Dan Stoza436ccf32018-06-21 12:10:12 -0700353 // Most layers aren't created from the main thread, and therefore need to
354 // grab the SF state lock to access HWC, but ContainerLayer does, so we need
355 // to avoid grabbing the lock again to avoid deadlock
356 virtual bool isCreatedFromMainThread() const { return false; }
357
Jamie Gennis582270d2011-08-17 18:19:00 -0700358
Robert Carr2e102c92018-10-23 12:11:15 -0700359 bool isRemovedFromCurrentState() const;
chaviw8b3871a2017-11-01 17:41:01 -0700360
David Sodman41fdfc92017-11-06 16:09:56 -0800361 void writeToProto(LayerProto* layerInfo,
362 LayerVector::StateSet stateSet = LayerVector::StateSet::Drawing);
chaviw1d044282017-09-27 12:19:28 -0700363
Dominik Laskowski075d3172018-05-24 15:50:06 -0700364 void writeToProto(LayerProto* layerInfo, DisplayId displayId);
Yiwei Zhang7124ad32018-02-21 13:02:45 -0800365
Marissa Wall61c58622018-07-18 10:12:20 -0700366 virtual Geometry getActiveGeometry(const Layer::State& s) const { return s.active_legacy; }
367 virtual uint32_t getActiveWidth(const Layer::State& s) const { return s.active_legacy.w; }
368 virtual uint32_t getActiveHeight(const Layer::State& s) const { return s.active_legacy.h; }
Peiyong Linefefaac2018-08-17 12:27:51 -0700369 virtual ui::Transform getActiveTransform(const Layer::State& s) const {
Marissa Wall61c58622018-07-18 10:12:20 -0700370 return s.active_legacy.transform;
371 }
372 virtual Region getActiveTransparentRegion(const Layer::State& s) const {
373 return s.activeTransparentRegion_legacy;
374 }
375 virtual Rect getCrop(const Layer::State& s) const { return s.crop_legacy; }
Marissa Wall61c58622018-07-18 10:12:20 -0700376
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700377protected:
378 /*
379 * onDraw - draws the surface.
380 */
chaviwa76b2712017-09-20 12:02:26 -0700381 virtual void onDraw(const RenderArea& renderArea, const Region& clip,
Marissa Wall61c58622018-07-18 10:12:20 -0700382 bool useIdentityTransform) = 0;
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700383
384public:
Robert Carr105e64b2018-03-07 12:47:50 -0800385 virtual void setDefaultBufferSize(uint32_t /*w*/, uint32_t /*h*/) {}
David Sodmaneb085e02017-10-05 18:49:04 -0700386
Chia-I Wu692e0832018-06-05 15:46:58 -0700387 virtual bool isHdrY410() const { return false; }
388
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700389 void setGeometry(const sp<const DisplayDevice>& display, uint32_t z);
Dominik Laskowski075d3172018-05-24 15:50:06 -0700390 void forceClientComposition(DisplayId displayId);
391 bool getForceClientComposition(DisplayId displayId);
392 virtual void setPerFrameData(DisplayId displayId, const ui::Transform& transform,
393 const Rect& viewport, int32_t supportedPerFrameMetadata) = 0;
Dan Stoza9e56aa02015-11-02 13:00:03 -0800394
395 // callIntoHwc exists so we can update our local state and call
396 // acceptDisplayChanges without unnecessarily updating the device's state
Dominik Laskowski075d3172018-05-24 15:50:06 -0700397 void setCompositionType(DisplayId displayId, HWC2::Composition type, bool callIntoHwc = true);
398 HWC2::Composition getCompositionType(const std::optional<DisplayId>& displayId) const;
399 void setClearClientTarget(DisplayId displayId, bool clear);
400 bool getClearClientTarget(DisplayId displayId) const;
Dominik Laskowskia2edf612018-06-01 13:15:16 -0700401 void updateCursorPosition(const sp<const DisplayDevice>& display);
Riley Andrews03414a12014-07-01 14:22:59 -0700402
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700403 /*
404 * called after page-flip
405 */
David Sodmaneb085e02017-10-05 18:49:04 -0700406 virtual void onLayerDisplayed(const sp<Fence>& releaseFence);
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700407
Ana Krulec010d2192018-10-08 06:29:54 -0700408 virtual bool shouldPresentNow(nsecs_t /*expectedPresentTime*/) const { return false; }
Robert Carr105e64b2018-03-07 12:47:50 -0800409 virtual void setTransformHint(uint32_t /*orientation*/) const { }
Dan Stoza6b9454d2014-11-07 16:00:59 -0800410
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700411 /*
412 * called before composition.
413 * returns true if the layer has pending updates.
414 */
Ady Abraham0d028792018-11-06 16:26:51 -0800415 virtual bool onPreComposition(nsecs_t refreshStartTime) = 0;
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700416
417 /*
Dan Stozae77c7662016-05-13 11:37:28 -0700418 * called after composition.
419 * returns true if the layer latched a new buffer this frame.
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700420 */
Dominik Laskowski075d3172018-05-24 15:50:06 -0700421 virtual bool onPostComposition(const std::optional<DisplayId>& /*displayId*/,
422 const std::shared_ptr<FenceTime>& /*glDoneFence*/,
Robert Carr105e64b2018-03-07 12:47:50 -0800423 const std::shared_ptr<FenceTime>& /*presentFence*/,
424 const CompositorTiming& /*compositorTiming*/) {
425 return false;
426 }
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700427
Dan Stoza9e56aa02015-11-02 13:00:03 -0800428 // If a buffer was replaced this frame, release the former buffer
Robert Carr105e64b2018-03-07 12:47:50 -0800429 virtual void releasePendingBuffer(nsecs_t /*dequeueReadyTime*/) { }
430
Dan Stoza9e56aa02015-11-02 13:00:03 -0800431
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700432 /*
433 * draw - performs some global clipping optimizations
434 * and calls onDraw().
435 */
Marissa Wall61c58622018-07-18 10:12:20 -0700436 void draw(const RenderArea& renderArea, const Region& clip);
437 void draw(const RenderArea& renderArea, bool useIdentityTransform);
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700438
439 /*
440 * doTransaction - process the transaction. This is a good place to figure
441 * out which attributes of the surface have changed.
442 */
443 uint32_t doTransaction(uint32_t transactionFlags);
444
445 /*
446 * setVisibleRegion - called to set the new visible region. This gives
447 * a chance to update the new visible region or record the fact it changed.
448 */
449 void setVisibleRegion(const Region& visibleRegion);
450
451 /*
452 * setCoveredRegion - called when the covered region changes. The covered
453 * region corresponds to any area of the surface that is covered
454 * (transparently or not) by another surface.
455 */
456 void setCoveredRegion(const Region& coveredRegion);
457
458 /*
459 * setVisibleNonTransparentRegion - called when the visible and
460 * non-transparent region changes.
461 */
David Sodman41fdfc92017-11-06 16:09:56 -0800462 void setVisibleNonTransparentRegion(const Region& visibleNonTransparentRegion);
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700463
464 /*
Robert Carre5f4f692018-01-12 13:12:28 -0800465 * Clear the visible, covered, and non-transparent regions.
466 */
467 void clearVisibilityRegions();
468
469 /*
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700470 * latchBuffer - called each time the screen is redrawn and returns whether
471 * the visible regions need to be recomputed (this is a fairly heavy
472 * operation, so this should be set only if needed). Typically this is used
473 * to figure out if the content or size of a surface has changed.
474 */
Alec Mouri86770e52018-09-24 22:40:58 +0000475 virtual Region latchBuffer(bool& /*recomputeVisibleRegions*/, nsecs_t /*latchTime*/,
476 const sp<Fence>& /*releaseFence*/) {
Robert Carr105e64b2018-03-07 12:47:50 -0800477 return {};
478 }
479
480 virtual bool isBufferLatched() const { return false; }
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700481
Mathias Agopian13127d82013-03-05 17:47:11 -0800482 /*
Chia-I Wuc6657022017-08-15 11:18:17 -0700483 * called with the state lock from a binder thread when the layer is
484 * removed from the current list to the pending removal list
485 */
486 void onRemovedFromCurrentState();
487
Andy McFaddenbf974ab2012-12-04 16:51:15 -0800488 // Updates the transform hint in our SurfaceFlingerConsumer to match
Mathias Agopian84300952012-11-21 16:02:13 -0800489 // the current orientation of the display device.
Dominik Laskowskia2edf612018-06-01 13:15:16 -0700490 void updateTransformHint(const sp<const DisplayDevice>& display) const;
Andy McFadden69052052012-09-14 16:10:11 -0700491
Mathias Agopian13127d82013-03-05 17:47:11 -0800492 /*
493 * returns the rectangle that crops the content of the layer and scales it
494 * to the layer's size.
495 */
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700496 Rect getContentCrop() const;
Mathias Agopian13127d82013-03-05 17:47:11 -0800497
Eric Penner51c59cd2014-07-28 19:51:58 -0700498 /*
Marissa Wallfd668622018-05-10 10:21:13 -0700499 * Returns if a frame is ready
Eric Penner51c59cd2014-07-28 19:51:58 -0700500 */
Marissa Wallfd668622018-05-10 10:21:13 -0700501 virtual bool hasReadyFrame() const { return false; }
Eric Penner51c59cd2014-07-28 19:51:58 -0700502
Marissa Wallfd668622018-05-10 10:21:13 -0700503 virtual int32_t getQueuedFrameCount() const { return 0; }
Kalle Raitaa099a242017-01-11 11:17:29 -0800504
Dan Stoza9e56aa02015-11-02 13:00:03 -0800505 // -----------------------------------------------------------------------
506
Dominik Laskowski075d3172018-05-24 15:50:06 -0700507 bool createHwcLayer(HWComposer* hwc, DisplayId displayId);
508 bool destroyHwcLayer(DisplayId displayId);
Steven Thomasb02664d2017-07-26 18:48:28 -0700509 void destroyAllHwcLayers();
510
Dominik Laskowski34157762018-10-31 13:07:19 -0700511 bool hasHwcLayer(DisplayId displayId) const { return getBE().mHwcLayers.count(displayId) > 0; }
Dan Stoza9e56aa02015-11-02 13:00:03 -0800512
Dominik Laskowski075d3172018-05-24 15:50:06 -0700513 HWC2::Layer* getHwcLayer(DisplayId displayId) {
514 if (!hasHwcLayer(displayId)) {
Dan Stoza9e56aa02015-11-02 13:00:03 -0800515 return nullptr;
516 }
David Sodmanb8aaea12017-12-14 15:54:51 -0800517 return getBE().mHwcLayers[displayId].layer.get();
Dan Stoza9e56aa02015-11-02 13:00:03 -0800518 }
519
Dominik Laskowski075d3172018-05-24 15:50:06 -0700520 bool setHwcLayer(DisplayId displayId) {
521 if (!hasHwcLayer(displayId)) {
David Sodmanba340492018-08-05 21:51:33 -0700522 return false;
523 }
Dominik Laskowski075d3172018-05-24 15:50:06 -0700524 getBE().compositionInfo.hwc.hwcLayer = getBE().mHwcLayers[displayId].layer;
David Sodmanba340492018-08-05 21:51:33 -0700525 return true;
526 }
527
Mathias Agopian13127d82013-03-05 17:47:11 -0800528 // -----------------------------------------------------------------------
David Sodmanc1498e62018-09-12 14:36:26 -0700529 void clearWithOpenGL(const RenderArea& renderArea) const;
Mathias Agopian13127d82013-03-05 17:47:11 -0800530
David Sodman41fdfc92017-11-06 16:09:56 -0800531 inline const State& getDrawingState() const { return mDrawingState; }
532 inline const State& getCurrentState() const { return mCurrentState; }
533 inline State& getCurrentState() { return mCurrentState; }
Mathias Agopian13127d82013-03-05 17:47:11 -0800534
Kalle Raitaa099a242017-01-11 11:17:29 -0800535 LayerDebugInfo getLayerDebugInfo() const;
Mathias Agopian13127d82013-03-05 17:47:11 -0800536
537 /* always call base class first */
Dan Stozae22aec72016-08-01 13:20:59 -0700538 static void miniDumpHeader(String8& result);
Dominik Laskowski075d3172018-05-24 15:50:06 -0700539 void miniDump(String8& result, DisplayId displayId) const;
Svetoslavd85084b2014-03-20 10:28:31 -0700540 void dumpFrameStats(String8& result) const;
Brian Andersond6927fb2016-07-23 23:37:30 -0700541 void dumpFrameEvents(String8& result);
Svetoslavd85084b2014-03-20 10:28:31 -0700542 void clearFrameStats();
Jamie Gennis6547ff42013-07-16 20:12:42 -0700543 void logFrameStats();
Svetoslavd85084b2014-03-20 10:28:31 -0700544 void getFrameStats(FrameStats* outStats) const;
Mathias Agopian1b5e1022010-04-20 17:55:49 -0700545
Robert Carr105e64b2018-03-07 12:47:50 -0800546 virtual std::vector<OccupancyTracker::Segment> getOccupancyHistory(bool /*forceFlush*/) {
547 return {};
548 }
Dan Stozae77c7662016-05-13 11:37:28 -0700549
Brian Anderson5ea5e592016-12-01 16:54:33 -0800550 void onDisconnect();
Brian Anderson3890c392016-07-25 12:48:08 -0700551 void addAndGetFrameTimestamps(const NewFrameEventsEntry* newEntry,
David Sodman41fdfc92017-11-06 16:09:56 -0800552 FrameEventHistoryDelta* outDelta);
Pablo Ceballosce796e72016-02-04 19:10:51 -0800553
Robert Carr105e64b2018-03-07 12:47:50 -0800554 virtual bool getTransformToDisplayInverse() const { return false; }
Robert Carr367c5682016-06-20 11:55:28 -0700555
Peiyong Linefefaac2018-08-17 12:27:51 -0700556 ui::Transform getTransform() const;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700557
Robert Carr6452f122017-03-21 10:41:29 -0700558 // Returns the Alpha of the Surface, accounting for the Alpha
559 // of parent Surfaces in the hierarchy (alpha's will be multiplied
560 // down the hierarchy).
chaviw13fdc492017-06-27 12:40:18 -0700561 half getAlpha() const;
562 half4 getColor() const;
Robert Carr6452f122017-03-21 10:41:29 -0700563
Dan Stoza412903f2017-04-27 13:42:17 -0700564 void traverseInReverseZOrder(LayerVector::StateSet stateSet,
565 const LayerVector::Visitor& visitor);
566 void traverseInZOrder(LayerVector::StateSet stateSet, const LayerVector::Visitor& visitor);
Robert Carr1f0a16a2016-10-24 16:27:39 -0700567
chaviw4b129c22018-04-09 16:19:43 -0700568 /**
569 * Traverse only children in z order, ignoring relative layers that are not children of the
570 * parent.
571 */
chaviwa76b2712017-09-20 12:02:26 -0700572 void traverseChildrenInZOrder(LayerVector::StateSet stateSet,
573 const LayerVector::Visitor& visitor);
574
Chia-I Wu98f1c102017-05-30 14:54:08 -0700575 size_t getChildrenCount() const;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700576 void addChild(const sp<Layer>& layer);
577 // Returns index if removed, or negative value otherwise
578 // for symmetry with Vector::remove
579 ssize_t removeChild(const sp<Layer>& layer);
Chia-I Wue41dbe62017-06-13 14:10:56 -0700580 sp<Layer> getParent() const { return mCurrentParent.promote(); }
Robert Carr1f0a16a2016-10-24 16:27:39 -0700581 bool hasParent() const { return getParent() != nullptr; }
Vishnu Nair60356342018-11-13 13:00:45 -0800582 Rect computeScreenBounds() const;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700583 bool setChildLayer(const sp<Layer>& childLayer, int32_t z);
Robert Carr503c7042017-09-27 15:06:08 -0700584 bool setChildRelativeLayer(const sp<Layer>& childLayer,
585 const sp<IBinder>& relativeToHandle, int32_t relativeZ);
Robert Carr1f0a16a2016-10-24 16:27:39 -0700586
587 // Copy the current list of children to the drawing state. Called by
588 // SurfaceFlinger to complete a transaction.
589 void commitChildList();
Robert Carr1f0a16a2016-10-24 16:27:39 -0700590 int32_t getZ() const;
Marissa Wall61c58622018-07-18 10:12:20 -0700591 virtual void pushPendingState();
David Sodman41fdfc92017-11-06 16:09:56 -0800592
Mathias Agopian13127d82013-03-05 17:47:11 -0800593protected:
594 // constant
595 sp<SurfaceFlinger> mFlinger;
Mathias Agopian13127d82013-03-05 17:47:11 -0800596 /*
597 * Trivial class, used to ensure that mFlinger->onLayerDestroyed(mLayer)
598 * is called.
599 */
600 class LayerCleaner {
601 sp<SurfaceFlinger> mFlinger;
Robert Carr2e102c92018-10-23 12:11:15 -0700602 sp<Layer> mLayer;
David Sodman41fdfc92017-11-06 16:09:56 -0800603
Mathias Agopian13127d82013-03-05 17:47:11 -0800604 protected:
Irvel468051e2016-06-13 16:44:44 -0700605 ~LayerCleaner() {
606 // destroy client resources
Robert Carr2e102c92018-10-23 12:11:15 -0700607 mFlinger->onHandleDestroyed(mLayer);
Irvel468051e2016-06-13 16:44:44 -0700608 }
David Sodman41fdfc92017-11-06 16:09:56 -0800609
Mathias Agopian13127d82013-03-05 17:47:11 -0800610 public:
David Sodman41fdfc92017-11-06 16:09:56 -0800611 LayerCleaner(const sp<SurfaceFlinger>& flinger, const sp<Layer>& layer)
612 : mFlinger(flinger), mLayer(layer) {}
Mathias Agopian13127d82013-03-05 17:47:11 -0800613 };
614
Lloyd Pique4dccc412018-01-22 17:21:36 -0800615 friend class impl::SurfaceInterceptor;
David Sodmaneb085e02017-10-05 18:49:04 -0700616
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700617 // For unit tests
618 friend class TestableSurfaceFlinger;
619
Pablo Ceballos05289c22016-04-14 15:49:55 -0700620 void commitTransaction(const State& stateToCommit);
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700621
Mathias Agopian3330b202009-10-05 17:07:12 -0700622 uint32_t getEffectiveUsage(uint32_t usage) const;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700623
Yichi Chenf6833402018-06-22 17:32:10 +0800624 virtual FloatRect computeCrop(const sp<const DisplayDevice>& display) const;
David Sodman0c69cad2017-08-21 12:12:51 -0700625 // Compute the initial crop as specified by parent layers and the
626 // SurfaceControl for this layer. Does not include buffer crop from the
627 // IGraphicBufferProducer client, as that should not affect child clipping.
628 // Returns in screen space.
Dominik Laskowskia2edf612018-06-01 13:15:16 -0700629 Rect computeInitialCrop(const sp<const DisplayDevice>& display) const;
Mathias Agopian0aa758d2009-04-22 15:23:34 -0700630
Mathias Agopian13127d82013-03-05 17:47:11 -0800631 // drawing
David Sodman41fdfc92017-11-06 16:09:56 -0800632 void clearWithOpenGL(const RenderArea& renderArea, float r, float g, float b,
633 float alpha) const;
Dan Stozac5da2712016-07-20 15:38:12 -0700634
Robert Carr1f0a16a2016-10-24 16:27:39 -0700635 void setParent(const sp<Layer>& layer);
636
Robert Carr29abff82017-12-04 13:51:20 -0800637 LayerVector makeTraversalList(LayerVector::StateSet stateSet, bool* outSkipRelativeZUsers);
Robert Carrdb66e622017-04-10 16:55:57 -0700638 void addZOrderRelative(const wp<Layer>& relative);
639 void removeZOrderRelative(const wp<Layer>& relative);
640
David Sodman41fdfc92017-11-06 16:09:56 -0800641 class SyncPoint {
Dan Stoza7dde5992015-05-22 09:51:44 -0700642 public:
David Sodman41fdfc92017-11-06 16:09:56 -0800643 explicit SyncPoint(uint64_t frameNumber)
644 : mFrameNumber(frameNumber), mFrameIsAvailable(false), mTransactionIsApplied(false) {}
Dan Stoza7dde5992015-05-22 09:51:44 -0700645
David Sodman41fdfc92017-11-06 16:09:56 -0800646 uint64_t getFrameNumber() const { return mFrameNumber; }
Dan Stoza7dde5992015-05-22 09:51:44 -0700647
David Sodman41fdfc92017-11-06 16:09:56 -0800648 bool frameIsAvailable() const { return mFrameIsAvailable; }
Dan Stoza7dde5992015-05-22 09:51:44 -0700649
David Sodman41fdfc92017-11-06 16:09:56 -0800650 void setFrameAvailable() { mFrameIsAvailable = true; }
Dan Stoza7dde5992015-05-22 09:51:44 -0700651
David Sodman41fdfc92017-11-06 16:09:56 -0800652 bool transactionIsApplied() const { return mTransactionIsApplied; }
Dan Stoza7dde5992015-05-22 09:51:44 -0700653
David Sodman41fdfc92017-11-06 16:09:56 -0800654 void setTransactionApplied() { mTransactionIsApplied = true; }
Dan Stoza7dde5992015-05-22 09:51:44 -0700655
656 private:
657 const uint64_t mFrameNumber;
658 std::atomic<bool> mFrameIsAvailable;
659 std::atomic<bool> mTransactionIsApplied;
660 };
661
Dan Stozacac35382016-01-27 12:21:06 -0800662 // SyncPoints which will be signaled when the correct frame is at the head
663 // of the queue and dropped after the frame has been latched. Protected by
664 // mLocalSyncPointMutex.
665 Mutex mLocalSyncPointMutex;
Dan Stoza7dde5992015-05-22 09:51:44 -0700666 std::list<std::shared_ptr<SyncPoint>> mLocalSyncPoints;
667
Dan Stozacac35382016-01-27 12:21:06 -0800668 // SyncPoints which will be signaled and then dropped when the transaction
669 // is applied
Dan Stoza7dde5992015-05-22 09:51:44 -0700670 std::list<std::shared_ptr<SyncPoint>> mRemoteSyncPoints;
671
Dan Stozacac35382016-01-27 12:21:06 -0800672 // Returns false if the relevant frame has already been latched
673 bool addSyncPoint(const std::shared_ptr<SyncPoint>& point);
Dan Stoza7dde5992015-05-22 09:51:44 -0700674
Pablo Ceballos05289c22016-04-14 15:49:55 -0700675 void popPendingState(State* stateToCommit);
Marissa Wall61c58622018-07-18 10:12:20 -0700676 virtual bool applyPendingStates(State* stateToCommit);
677 virtual uint32_t doTransactionResize(uint32_t flags, Layer::State* stateToCommit);
Robert Carrc3574f72016-03-24 12:19:32 -0700678
Robert Carr1f0a16a2016-10-24 16:27:39 -0700679 void clearSyncPoints();
680
Robert Carrc3574f72016-03-24 12:19:32 -0700681 // Returns mCurrentScaling mode (originating from the
682 // Client) or mOverrideScalingMode mode (originating from
683 // the Surface Controller) if set.
Robert Carr105e64b2018-03-07 12:47:50 -0800684 virtual uint32_t getEffectiveScalingMode() const { return 0; }
David Sodman41fdfc92017-11-06 16:09:56 -0800685
Dan Stoza7dde5992015-05-22 09:51:44 -0700686public:
Irvel468051e2016-06-13 16:44:44 -0700687 /*
688 * The layer handle is just a BBinder object passed to the client
689 * (remote process) -- we don't keep any reference on our side such that
690 * the dtor is called when the remote side let go of its reference.
691 *
692 * LayerCleaner ensures that mFlinger->onLayerDestroyed() is called for
693 * this layer when the handle is destroyed.
694 */
695 class Handle : public BBinder, public LayerCleaner {
David Sodman41fdfc92017-11-06 16:09:56 -0800696 public:
697 Handle(const sp<SurfaceFlinger>& flinger, const sp<Layer>& layer)
698 : LayerCleaner(flinger, layer), owner(layer) {}
Irvel468051e2016-06-13 16:44:44 -0700699
David Sodman41fdfc92017-11-06 16:09:56 -0800700 wp<Layer> owner;
Irvel468051e2016-06-13 16:44:44 -0700701 };
702
703 sp<IBinder> getHandle();
Irvel468051e2016-06-13 16:44:44 -0700704 const String8& getName() const;
Robert Carr105e64b2018-03-07 12:47:50 -0800705 virtual void notifyAvailableFrames() {}
706 virtual PixelFormat getPixelFormat() const { return PIXEL_FORMAT_NONE; }
chaviw13fdc492017-06-27 12:40:18 -0700707 bool getPremultipledAlpha() const;
Igor Murashkina4a31492012-10-29 13:36:11 -0700708
Robert Carr2e102c92018-10-23 12:11:15 -0700709 bool mPendingHWCDestroy{false};
710
David Sodman41fdfc92017-11-06 16:09:56 -0800711protected:
Mathias Agopianb7e930d2010-06-01 15:12:58 -0700712 // -----------------------------------------------------------------------
Robert Carr29abff82017-12-04 13:51:20 -0800713 bool usingRelativeZ(LayerVector::StateSet stateSet);
Mathias Agopianb7e930d2010-06-01 15:12:58 -0700714
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700715 bool mPremultipliedAlpha{true};
Mathias Agopian13127d82013-03-05 17:47:11 -0800716 String8 mName;
David Sodman41fdfc92017-11-06 16:09:56 -0800717 String8 mTransactionName; // A cached version of "TX - " + mName for systraces
Mathias Agopian13127d82013-03-05 17:47:11 -0800718
Chia-I Wuab0c3192017-08-01 11:29:00 -0700719 bool mPrimaryDisplayOnly = false;
720
Mathias Agopian13127d82013-03-05 17:47:11 -0800721 // these are protected by an external lock
722 State mCurrentState;
723 State mDrawingState;
Lloyd Piquef1c675b2018-09-12 20:45:39 -0700724 std::atomic<uint32_t> mTransactionFlags{0};
Mathias Agopiand606de62010-05-10 20:06:11 -0700725
Dan Stoza7dde5992015-05-22 09:51:44 -0700726 // Accessed from main thread and binder threads
727 Mutex mPendingStateMutex;
728 Vector<State> mPendingStates;
729
Brian Andersond6927fb2016-07-23 23:37:30 -0700730 // Timestamp history for UIAutomation. Thread safe.
Jamie Gennis4b0eba92013-02-05 13:30:24 -0800731 FrameTracker mFrameTracker;
Mathias Agopiana67932f2011-04-20 14:20:59 -0700732
Brian Andersond6927fb2016-07-23 23:37:30 -0700733 // Timestamp history for the consumer to query.
734 // Accessed by both consumer and producer on main and binder threads.
735 Mutex mFrameEventHistoryMutex;
Brian Anderson3890c392016-07-25 12:48:08 -0700736 ConsumerFrameEventHistory mFrameEventHistory;
Brian Anderson3d4039d2016-09-23 16:31:30 -0700737 FenceTimeline mAcquireTimeline;
738 FenceTimeline mReleaseTimeline;
Brian Andersond6927fb2016-07-23 23:37:30 -0700739
Yiwei Zhangfaf3ded2018-05-02 17:37:17 -0700740 TimeStats& mTimeStats = TimeStats::getInstance();
741
Mathias Agopiana67932f2011-04-20 14:20:59 -0700742 // main thread
743 sp<GraphicBuffer> mActiveBuffer;
Chia-I Wu01591c92018-05-22 12:03:00 -0700744 ui::Dataspace mCurrentDataSpace = ui::Dataspace::UNKNOWN;
Mathias Agopiana67932f2011-04-20 14:20:59 -0700745 Rect mCurrentCrop;
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700746 uint32_t mCurrentTransform{0};
Robert Carrc3574f72016-03-24 12:19:32 -0700747 // We encode unset as -1.
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700748 int32_t mOverrideScalingMode{-1};
749 std::atomic<uint64_t> mCurrentFrameNumber{0};
750 bool mFrameLatencyNeeded{false};
Mathias Agopian13127d82013-03-05 17:47:11 -0800751 // Whether filtering is needed b/c of the drawingstate
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700752 bool mNeedsFiltering{false};
David Sodman0c69cad2017-08-21 12:12:51 -0700753
Robert Carr2e102c92018-10-23 12:11:15 -0700754 std::atomic<bool> mRemovedFromCurrentState{false};
chaviw8b3871a2017-11-01 17:41:01 -0700755
Mathias Agopianb7e930d2010-06-01 15:12:58 -0700756 // page-flip thread (currently main thread)
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700757 bool mProtectedByApp{false}; // application requires protected path to external sink
Mathias Agopian13127d82013-03-05 17:47:11 -0800758
759 // protected by mLock
760 mutable Mutex mLock;
David Sodman0c69cad2017-08-21 12:12:51 -0700761
Mathias Agopian13127d82013-03-05 17:47:11 -0800762 const wp<Client> mClientRef;
Riley Andrews03414a12014-07-01 14:22:59 -0700763
764 // This layer can be a cursor on some displays.
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700765 bool mPotentialCursor{false};
Dan Stoza6b9454d2014-11-07 16:00:59 -0800766
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700767 bool mFreezeGeometryUpdates{false};
Robert Carr1f0a16a2016-10-24 16:27:39 -0700768
769 // Child list about to be committed/used for editing.
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700770 LayerVector mCurrentChildren{LayerVector::StateSet::Current};
Robert Carr1f0a16a2016-10-24 16:27:39 -0700771 // Child list used for rendering.
Lloyd Pique42ab75e2018-09-12 20:46:03 -0700772 LayerVector mDrawingChildren{LayerVector::StateSet::Drawing};
Robert Carr1f0a16a2016-10-24 16:27:39 -0700773
Chia-I Wue41dbe62017-06-13 14:10:56 -0700774 wp<Layer> mCurrentParent;
775 wp<Layer> mDrawingParent;
David Sodman9eeae692017-11-02 10:53:32 -0700776
777 mutable LayerBE mBE;
chaviw4b129c22018-04-09 16:19:43 -0700778
779private:
780 /**
781 * Returns an unsorted vector of all layers that are part of this tree.
782 * That includes the current layer and all its descendants.
783 */
784 std::vector<Layer*> getLayersInTree(LayerVector::StateSet stateSet);
785 /**
786 * Traverses layers that are part of this tree in the correct z order.
787 * layersInTree must be sorted before calling this method.
788 */
789 void traverseChildrenInZOrderInner(const std::vector<Layer*>& layersInTree,
790 LayerVector::StateSet stateSet,
791 const LayerVector::Visitor& visitor);
792 LayerVector makeChildrenTraversalList(LayerVector::StateSet stateSet,
793 const std::vector<Layer*>& layersInTree);
Vishnu Nair60356342018-11-13 13:00:45 -0800794
795 /**
796 * Retuns the child bounds in layer space cropped to its bounds as well all its parent bounds.
797 * The cropped bounds must be transformed back from parent layer space to child layer space by
798 * applying the inverse of the child's transformation.
799 */
800 FloatRect cropChildBounds(const FloatRect& childBounds) const;
801
802 /**
803 * Returns the cropped buffer size or the layer crop if the layer has no buffer. Return
804 * INVALID_RECT if the layer has no buffer and no crop.
805 * A layer with an invalid buffer size and no crop is considered to be boundless. The layer
806 * bounds are constrained by its parent bounds.
807 */
808 Rect getCroppedBufferSize(const Layer::State& s) const;
809
810 /**
811 * Returns active buffer size in the correct orientation. Buffer size is determined by undoing
812 * any buffer transformations. If the layer has no buffer then return INVALID_RECT.
813 */
814 virtual Rect getBufferSize(const Layer::State&) const { return Rect::INVALID_RECT; }
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800815};
816
Dominik Laskowski34157762018-10-31 13:07:19 -0700817} // namespace android
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800818
Dominik Laskowski34157762018-10-31 13:07:19 -0700819#define RETURN_IF_NO_HWC_LAYER(displayId, ...) \
820 do { \
821 if (!hasHwcLayer(displayId)) { \
822 ALOGE("[%s] %s failed: no HWC layer found for display %s", mName.string(), \
823 __FUNCTION__, to_string(displayId).c_str()); \
824 return __VA_ARGS__; \
825 } \
826 } while (false)
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800827
828#endif // ANDROID_LAYER_H