blob: ee3bb7ef3fdaa3aab92f46a6e4a21fb8dd3a9a03 [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
20#include <stdint.h>
21#include <sys/types.h>
22
Mathias Agopian076b1cc2009-04-10 14:24:30 -070023#include <EGL/egl.h>
24#include <EGL/eglext.h>
Mathias Agopian076b1cc2009-04-10 14:24:30 -070025
Mathias Agopian13127d82013-03-05 17:47:11 -080026#include <utils/RefBase.h>
27#include <utils/String8.h>
28#include <utils/Timers.h>
29
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>
34
35#include <gui/ISurfaceComposerClient.h>
Robert Carr4cdc58f2017-08-23 14:22:20 -070036#include <gui/LayerState.h>
Mathias Agopian13127d82013-03-05 17:47:11 -080037
Dan Stoza7dde5992015-05-22 09:51:44 -070038#include <list>
39
Jamie Gennis82dbc742012-11-08 19:23:28 -080040#include "FrameTracker.h"
Mathias Agopian13127d82013-03-05 17:47:11 -080041#include "Client.h"
Robert Carr1f0a16a2016-10-24 16:27:39 -070042#include "LayerVector.h"
Dan Stozab9b08832014-03-13 11:55:57 -070043#include "MonitoredProducer.h"
Mathias Agopian13127d82013-03-05 17:47:11 -080044#include "SurfaceFlinger.h"
45#include "SurfaceFlingerConsumer.h"
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080046#include "Transform.h"
47
Mathias Agopian13127d82013-03-05 17:47:11 -080048#include "DisplayHardware/HWComposer.h"
Chia-I Wuaaff73f2017-02-13 12:28:24 -080049#include "DisplayHardware/HWComposerBufferCache.h"
Mathias Agopian3f844832013-08-07 21:24:32 -070050#include "RenderEngine/Mesh.h"
Mathias Agopian49457ac2013-08-14 18:20:17 -070051#include "RenderEngine/Texture.h"
chaviw1d044282017-09-27 12:19:28 -070052#include <layerproto/LayerProtoHeader.h>
chaviwa76b2712017-09-20 12:02:26 -070053#include "RenderArea.h"
Mathias Agopian13127d82013-03-05 17:47:11 -080054
chaviw13fdc492017-06-27 12:40:18 -070055#include <math/vec4.h>
56
chaviw1d044282017-09-27 12:19:28 -070057using namespace android::surfaceflinger;
58
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080059namespace android {
60
61// ---------------------------------------------------------------------------
62
Mathias Agopian1f7bec62010-06-25 18:02:21 -070063class Client;
Mathias Agopian3e25fd82013-04-22 17:52:16 +020064class Colorizer;
Mathias Agopian13127d82013-03-05 17:47:11 -080065class DisplayDevice;
66class GraphicBuffer;
67class SurfaceFlinger;
Kalle Raitaa099a242017-01-11 11:17:29 -080068class LayerDebugInfo;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080069
70// ---------------------------------------------------------------------------
71
David Sodman0c69cad2017-08-21 12:12:51 -070072class Layer : public virtual RefBase
73{
Mathias Agopian13127d82013-03-05 17:47:11 -080074 static int32_t sSequence;
75
Mathias Agopiand606de62010-05-10 20:06:11 -070076public:
Mathias Agopian13127d82013-03-05 17:47:11 -080077 mutable bool contentDirty;
78 // regions below are in window-manager space
79 Region visibleRegion;
80 Region coveredRegion;
81 Region visibleNonTransparentRegion;
Dan Stozaee44edd2015-03-23 15:50:23 -070082 Region surfaceDamageRegion;
Andy McFadden4df87bd2014-04-21 18:08:54 -070083
84 // Layer serial number. This gives layers an explicit ordering, so we
85 // have a stable sort order when their layer stack and Z-order are
86 // the same.
Mathias Agopian13127d82013-03-05 17:47:11 -080087 int32_t sequence;
88
89 enum { // flags for doTransaction()
90 eDontUpdateGeometryState = 0x00000001,
91 eVisibleRegion = 0x00000002,
92 };
93
94 struct Geometry {
95 uint32_t w;
96 uint32_t h;
Robert Carr3dcabfa2016-03-01 18:36:58 -080097 Transform transform;
98
Mathias Agopian13127d82013-03-05 17:47:11 -080099 inline bool operator ==(const Geometry& rhs) const {
Robert Carr99e27f02016-06-16 15:18:02 -0700100 return (w == rhs.w && h == rhs.h) &&
101 (transform.tx() == rhs.transform.tx()) &&
102 (transform.ty() == rhs.transform.ty());
Mathias Agopian13127d82013-03-05 17:47:11 -0800103 }
104 inline bool operator !=(const Geometry& rhs) const {
105 return !operator ==(rhs);
106 }
107 };
108
109 struct State {
110 Geometry active;
111 Geometry requested;
Robert Carrae060832016-11-28 10:51:00 -0800112 int32_t z;
Fabien Sanglardf0c53d62017-03-03 18:58:50 -0800113
114 // The identifier of the layer stack this layer belongs to. A layer can
115 // only be associated to a single layer stack. A layer stack is a
116 // z-ordered group of layers which can be associated to one or more
117 // displays. Using the same layer stack on different displays is a way
118 // to achieve mirroring.
Mathias Agopian13127d82013-03-05 17:47:11 -0800119 uint32_t layerStack;
Fabien Sanglardf0c53d62017-03-03 18:58:50 -0800120
Mathias Agopian13127d82013-03-05 17:47:11 -0800121 uint8_t flags;
Dan Stoza7dde5992015-05-22 09:51:44 -0700122 uint8_t mask;
Mathias Agopian13127d82013-03-05 17:47:11 -0800123 uint8_t reserved[2];
124 int32_t sequence; // changes when visible regions can change
Dan Stoza7dde5992015-05-22 09:51:44 -0700125 bool modified;
126
Fabien Sanglard4ed383c2016-12-13 14:02:41 -0800127 // Crop is expressed in layer space coordinate.
Robert Carrb5d3d262016-03-25 15:08:13 -0700128 Rect crop;
Robert Carr99e27f02016-06-16 15:18:02 -0700129 Rect requestedCrop;
130
Fabien Sanglard4ed383c2016-12-13 14:02:41 -0800131 // finalCrop is expressed in display space coordinate.
Robert Carrb5d3d262016-03-25 15:08:13 -0700132 Rect finalCrop;
Robert Carr8d5227b2017-03-16 15:41:03 -0700133 Rect requestedFinalCrop;
Robert Carrb5d3d262016-03-25 15:08:13 -0700134
Robert Carr0d480722017-01-10 16:42:54 -0800135 // If set, defers this state update until the identified Layer
Dan Stoza7dde5992015-05-22 09:51:44 -0700136 // receives a frame with the given frameNumber
Robert Carr0d480722017-01-10 16:42:54 -0800137 wp<Layer> barrierLayer;
Dan Stoza7dde5992015-05-22 09:51:44 -0700138 uint64_t frameNumber;
139
Mathias Agopian2ca79392013-04-02 18:30:32 -0700140 // the transparentRegion hint is a bit special, it's latched only
141 // when we receive a buffer -- this is because it's "content"
142 // dependent.
143 Region activeTransparentRegion;
144 Region requestedTransparentRegion;
Courtney Goeltzenleuchterbb09b432016-11-30 13:51:28 -0700145 android_dataspace dataSpace;
Daniel Nicoara2f5f8a52016-12-20 16:11:58 -0500146
147 uint32_t appId;
148 uint32_t type;
Robert Carrdb66e622017-04-10 16:55:57 -0700149
150 // If non-null, a Surface this Surface's Z-order is interpreted relative to.
151 wp<Layer> zOrderRelativeOf;
152
153 // A list of surfaces whose Z-order is interpreted relative to ours.
154 SortedVector<wp<Layer>> zOrderRelatives;
chaviw13fdc492017-06-27 12:40:18 -0700155
156 half4 color;
Mathias Agopian13127d82013-03-05 17:47:11 -0800157 };
158
Mathias Agopian4d9b8222013-03-12 17:11:48 -0700159 Layer(SurfaceFlinger* flinger, const sp<Client>& client,
160 const String8& name, uint32_t w, uint32_t h, uint32_t flags);
Mathias Agopianb7e930d2010-06-01 15:12:58 -0700161 virtual ~Layer();
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800162
Chia-I Wuab0c3192017-08-01 11:29:00 -0700163 void setPrimaryDisplayOnly() { mPrimaryDisplayOnly = true; }
164
Robert Carr7bf247e2017-05-18 14:02:49 -0700165 // ------------------------------------------------------------------------
166 // Geometry setting functions.
167 //
168 // The following group of functions are used to specify the layers
169 // bounds, and the mapping of the texture on to those bounds. According
170 // to various settings changes to them may apply immediately, or be delayed until
171 // a pending resize is completed by the producer submitting a buffer. For example
172 // if we were to change the buffer size, and update the matrix ahead of the
173 // new buffer arriving, then we would be stretching the buffer to a different
174 // aspect before and after the buffer arriving, which probably isn't what we wanted.
175 //
176 // The first set of geometry functions are controlled by the scaling mode, described
177 // in window.h. The scaling mode may be set by the client, as it submits buffers.
178 // This value may be overriden through SurfaceControl, with setOverrideScalingMode.
179 //
180 // Put simply, if our scaling mode is SCALING_MODE_FREEZE, then
181 // matrix updates will not be applied while a resize is pending
182 // and the size and transform will remain in their previous state
183 // until a new buffer is submitted. If the scaling mode is another value
184 // then the old-buffer will immediately be scaled to the pending size
185 // and the new matrix will be immediately applied following this scaling
186 // transformation.
Robert Carr8d5227b2017-03-16 15:41:03 -0700187
Robert Carr7bf247e2017-05-18 14:02:49 -0700188 // Set the default buffer size for the assosciated Producer, in pixels. This is
189 // also the rendered size of the layer prior to any transformations. Parent
190 // or local matrix transformations will not affect the size of the buffer,
191 // but may affect it's on-screen size or clipping.
192 bool setSize(uint32_t w, uint32_t h);
193 // Set a 2x2 transformation matrix on the layer. This transform
194 // will be applied after parent transforms, but before any final
195 // producer specified transform.
196 bool setMatrix(const layer_state_t::matrix22_t& matrix);
197
198 // This second set of geometry attributes are controlled by
199 // setGeometryAppliesWithResize, and their default mode is to be
200 // immediate. If setGeometryAppliesWithResize is specified
201 // while a resize is pending, then update of these attributes will
202 // be delayed until the resize completes.
203
204 // setPosition operates in parent buffer space (pre parent-transform) or display
205 // space for top-level layers.
Robert Carr82364e32016-05-15 11:27:47 -0700206 bool setPosition(float x, float y, bool immediate);
Robert Carr7bf247e2017-05-18 14:02:49 -0700207 // Buffer space
Robert Carr8d5227b2017-03-16 15:41:03 -0700208 bool setCrop(const Rect& crop, bool immediate);
Robert Carr7bf247e2017-05-18 14:02:49 -0700209 // Parent buffer space/display space
Robert Carr8d5227b2017-03-16 15:41:03 -0700210 bool setFinalCrop(const Rect& crop, bool immediate);
211
Robert Carr7bf247e2017-05-18 14:02:49 -0700212 // TODO(b/38182121): Could we eliminate the various latching modes by
213 // using the layer hierarchy?
214 // -----------------------------------------------------------------------
Robert Carrae060832016-11-28 10:51:00 -0800215 bool setLayer(int32_t z);
Robert Carrdb66e622017-04-10 16:55:57 -0700216 bool setRelativeLayer(const sp<IBinder>& relativeToHandle, int32_t relativeZ);
217
Dan Stoza9e56aa02015-11-02 13:00:03 -0800218 bool setAlpha(float alpha);
chaviw13fdc492017-06-27 12:40:18 -0700219 bool setColor(const half3& color);
Mathias Agopian13127d82013-03-05 17:47:11 -0800220 bool setTransparentRegionHint(const Region& transparent);
221 bool setFlags(uint8_t flags, uint8_t mask);
Mathias Agopian13127d82013-03-05 17:47:11 -0800222 bool setLayerStack(uint32_t layerStack);
Courtney Goeltzenleuchterbb09b432016-11-30 13:51:28 -0700223 bool setDataSpace(android_dataspace dataSpace);
Courtney Goeltzenleuchter532b2632017-05-05 16:34:38 -0600224 android_dataspace getDataSpace() const;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700225 uint32_t getLayerStack() const;
Robert Carr0d480722017-01-10 16:42:54 -0800226 void deferTransactionUntil(const sp<IBinder>& barrierHandle, uint64_t frameNumber);
227 void deferTransactionUntil(const sp<Layer>& barrierLayer, uint64_t frameNumber);
Robert Carrc3574f72016-03-24 12:19:32 -0700228 bool setOverrideScalingMode(int32_t overrideScalingMode);
Daniel Nicoara2f5f8a52016-12-20 16:11:58 -0500229 void setInfo(uint32_t type, uint32_t appId);
Robert Carr1db73f62016-12-21 12:58:51 -0800230 bool reparentChildren(const sp<IBinder>& layer);
chaviwf1961f72017-09-18 16:41:07 -0700231 bool reparent(const sp<IBinder>& newParentHandle);
Robert Carr9524cb32017-02-13 11:32:32 -0800232 bool detachChildren();
Mathias Agopian13127d82013-03-05 17:47:11 -0800233
Dan Stozaee44edd2015-03-23 15:50:23 -0700234 // If we have received a new buffer this frame, we will pass its surface
235 // damage down to hardware composer. Otherwise, we must send a region with
236 // one empty rect.
237 void useSurfaceDamage();
238 void useEmptyDamage();
239
Mathias Agopian13127d82013-03-05 17:47:11 -0800240 uint32_t getTransactionFlags(uint32_t flags);
241 uint32_t setTransactionFlags(uint32_t flags);
242
Chia-I Wuab0c3192017-08-01 11:29:00 -0700243 bool belongsToDisplay(uint32_t layerStack, bool isPrimaryDisplay) const {
244 return getLayerStack() == layerStack && (!mPrimaryDisplayOnly || isPrimaryDisplay);
245 }
246
chaviwa76b2712017-09-20 12:02:26 -0700247 void computeGeometry(const RenderArea& renderArea, Mesh& mesh, bool useIdentityTransform) const;
Michael Lentine6c925ed2014-09-26 17:55:01 -0700248 Rect computeBounds(const Region& activeTransparentRegion) const;
Mathias Agopian13127d82013-03-05 17:47:11 -0800249 Rect computeBounds() const;
250
Pablo Ceballos40845df2016-01-25 17:41:15 -0800251 int32_t getSequence() const { return sequence; }
252
Mathias Agopian13127d82013-03-05 17:47:11 -0800253 // -----------------------------------------------------------------------
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700254 // Virtuals
David Sodman0c69cad2017-08-21 12:12:51 -0700255 virtual const char* getTypeId() const = 0;
Mathias Agopian13127d82013-03-05 17:47:11 -0800256
Mathias Agopian13127d82013-03-05 17:47:11 -0800257 /*
258 * isOpaque - true if this surface is opaque
Andy McFadden4125a4f2014-01-29 17:17:11 -0800259 *
260 * This takes into account the buffer format (i.e. whether or not the
261 * pixel format includes an alpha channel) and the "opaque" flag set
262 * on the layer. It does not examine the current plane alpha value.
Mathias Agopian13127d82013-03-05 17:47:11 -0800263 */
David Sodman0c69cad2017-08-21 12:12:51 -0700264 virtual bool isOpaque(const Layer::State& s) const = 0;
Mathias Agopian13127d82013-03-05 17:47:11 -0800265
266 /*
267 * isSecure - true if this surface is secure, that is if it prevents
268 * screenshots or VNC servers.
269 */
David Sodman0c69cad2017-08-21 12:12:51 -0700270 bool isSecure() const;
Mathias Agopian13127d82013-03-05 17:47:11 -0800271
272 /*
273 * isVisible - true if this layer is visible, false otherwise
274 */
David Sodman0c69cad2017-08-21 12:12:51 -0700275 virtual bool isVisible() const = 0;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800276
Mathias Agopian13127d82013-03-05 17:47:11 -0800277 /*
Robert Carr1f0a16a2016-10-24 16:27:39 -0700278 * isHiddenByPolicy - true if this layer has been forced invisible.
279 * just because this is false, doesn't mean isVisible() is true.
280 * For example if this layer has no active buffer, it may not be hidden by
281 * policy, but it still can not be visible.
282 */
David Sodman0c69cad2017-08-21 12:12:51 -0700283 bool isHiddenByPolicy() const;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700284
285 /*
Mathias Agopian13127d82013-03-05 17:47:11 -0800286 * isFixedSize - true if content has a fixed size
287 */
David Sodman0c69cad2017-08-21 12:12:51 -0700288 virtual bool isFixedSize() const = 0;
Jamie Gennis582270d2011-08-17 18:19:00 -0700289
chaviw1d044282017-09-27 12:19:28 -0700290 void writeToProto(LayerProto* layerInfo, LayerVector::StateSet stateSet = LayerVector::StateSet::Drawing);
291
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700292protected:
293 /*
294 * onDraw - draws the surface.
295 */
chaviwa76b2712017-09-20 12:02:26 -0700296 virtual void onDraw(const RenderArea& renderArea, const Region& clip,
David Sodman0c69cad2017-08-21 12:12:51 -0700297 bool useIdentityTransform) const = 0;
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700298
299public:
Fabien Sanglard9d96de42016-10-11 00:15:18 +0000300#ifdef USE_HWC2
Robert Carrae060832016-11-28 10:51:00 -0800301 void setGeometry(const sp<const DisplayDevice>& displayDevice, uint32_t z);
Dan Stoza9e56aa02015-11-02 13:00:03 -0800302 void forceClientComposition(int32_t hwcId);
303 void setPerFrameData(const sp<const DisplayDevice>& displayDevice);
304
305 // callIntoHwc exists so we can update our local state and call
306 // acceptDisplayChanges without unnecessarily updating the device's state
David Sodman0c69cad2017-08-21 12:12:51 -0700307 void setCompositionType(int32_t hwcId, HWC2::Composition type, bool callIntoHwc = true);
Dan Stoza9e56aa02015-11-02 13:00:03 -0800308 HWC2::Composition getCompositionType(int32_t hwcId) const;
Dan Stoza9e56aa02015-11-02 13:00:03 -0800309 void setClearClientTarget(int32_t hwcId, bool clear);
310 bool getClearClientTarget(int32_t hwcId) const;
Dan Stoza9e56aa02015-11-02 13:00:03 -0800311 void updateCursorPosition(const sp<const DisplayDevice>& hw);
Fabien Sanglard9d96de42016-10-11 00:15:18 +0000312#else
313 void setGeometry(const sp<const DisplayDevice>& hw,
David Sodman0c69cad2017-08-21 12:12:51 -0700314 HWComposer::HWCLayerInterface& layer);
315 void setPerFrameData(const sp<const DisplayDevice>& hw, HWComposer::HWCLayerInterface& layer);
Fabien Sanglard9d96de42016-10-11 00:15:18 +0000316 void setAcquireFence(const sp<const DisplayDevice>& hw,
David Sodman0c69cad2017-08-21 12:12:51 -0700317 HWComposer::HWCLayerInterface& layer);
Fabien Sanglard9d96de42016-10-11 00:15:18 +0000318 Rect getPosition(const sp<const DisplayDevice>& hw);
319#endif
Riley Andrews03414a12014-07-01 14:22:59 -0700320
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700321 /*
322 * called after page-flip
323 */
Fabien Sanglard9d96de42016-10-11 00:15:18 +0000324#ifdef USE_HWC2
Dan Stoza9e56aa02015-11-02 13:00:03 -0800325 void onLayerDisplayed(const sp<Fence>& releaseFence);
Fabien Sanglard9d96de42016-10-11 00:15:18 +0000326#else
327 void onLayerDisplayed(const sp<const DisplayDevice>& hw,
328 HWComposer::HWCLayerInterface* layer);
329#endif
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700330
Dan Stoza6b9454d2014-11-07 16:00:59 -0800331 bool shouldPresentNow(const DispSync& dispSync) const;
332
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700333 /*
334 * called before composition.
335 * returns true if the layer has pending updates.
336 */
David Sodman0c69cad2017-08-21 12:12:51 -0700337 virtual bool onPreComposition(nsecs_t refreshStartTime) = 0;
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700338
339 /*
Dan Stozae77c7662016-05-13 11:37:28 -0700340 * called after composition.
341 * returns true if the layer latched a new buffer this frame.
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700342 */
Brian Anderson0a61b0c2016-12-07 14:55:56 -0800343 bool onPostComposition(const std::shared_ptr<FenceTime>& glDoneFence,
Brian Anderson3d4039d2016-09-23 16:31:30 -0700344 const std::shared_ptr<FenceTime>& presentFence,
Brian Anderson0a61b0c2016-12-07 14:55:56 -0800345 const CompositorTiming& compositorTiming);
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700346
Fabien Sanglard9d96de42016-10-11 00:15:18 +0000347#ifdef USE_HWC2
Dan Stoza9e56aa02015-11-02 13:00:03 -0800348 // If a buffer was replaced this frame, release the former buffer
David Sodman0c69cad2017-08-21 12:12:51 -0700349 virtual void releasePendingBuffer(nsecs_t dequeueReadyTime) = 0;
Fabien Sanglard9d96de42016-10-11 00:15:18 +0000350#endif
Dan Stoza9e56aa02015-11-02 13:00:03 -0800351
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700352 /*
353 * draw - performs some global clipping optimizations
354 * and calls onDraw().
355 */
chaviwa76b2712017-09-20 12:02:26 -0700356 void draw(const RenderArea& renderArea, const Region& clip) const;
357 void draw(const RenderArea& renderArea, bool useIdentityTransform) const;
358 void draw(const RenderArea& renderArea) const;
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700359
360 /*
361 * doTransaction - process the transaction. This is a good place to figure
362 * out which attributes of the surface have changed.
363 */
364 uint32_t doTransaction(uint32_t transactionFlags);
365
366 /*
367 * setVisibleRegion - called to set the new visible region. This gives
368 * a chance to update the new visible region or record the fact it changed.
369 */
370 void setVisibleRegion(const Region& visibleRegion);
371
372 /*
373 * setCoveredRegion - called when the covered region changes. The covered
374 * region corresponds to any area of the surface that is covered
375 * (transparently or not) by another surface.
376 */
377 void setCoveredRegion(const Region& coveredRegion);
378
379 /*
380 * setVisibleNonTransparentRegion - called when the visible and
381 * non-transparent region changes.
382 */
383 void setVisibleNonTransparentRegion(const Region&
384 visibleNonTransparentRegion);
385
386 /*
387 * latchBuffer - called each time the screen is redrawn and returns whether
388 * the visible regions need to be recomputed (this is a fairly heavy
389 * operation, so this should be set only if needed). Typically this is used
390 * to figure out if the content or size of a surface has changed.
391 */
David Sodman0c69cad2017-08-21 12:12:51 -0700392 virtual Region latchBuffer(bool& recomputeVisibleRegions, nsecs_t latchTime) = 0;
393 virtual bool isBufferLatched() const = 0;
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700394
David Sodman0c69cad2017-08-21 12:12:51 -0700395 bool isPotentialCursor() const { return mPotentialCursor; }
Mathias Agopian13127d82013-03-05 17:47:11 -0800396 /*
Chia-I Wuc6657022017-08-15 11:18:17 -0700397 * called with the state lock from a binder thread when the layer is
398 * removed from the current list to the pending removal list
399 */
400 void onRemovedFromCurrentState();
401
402 /*
403 * called with the state lock from the main thread when the layer is
404 * removed from the pending removal list
Mathias Agopian13127d82013-03-05 17:47:11 -0800405 */
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700406 void onRemoved();
Mathias Agopian13127d82013-03-05 17:47:11 -0800407
408
Andy McFaddenbf974ab2012-12-04 16:51:15 -0800409 // Updates the transform hint in our SurfaceFlingerConsumer to match
Mathias Agopian84300952012-11-21 16:02:13 -0800410 // the current orientation of the display device.
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700411 void updateTransformHint(const sp<const DisplayDevice>& hw) const;
Andy McFadden69052052012-09-14 16:10:11 -0700412
Mathias Agopian13127d82013-03-05 17:47:11 -0800413 /*
414 * returns the rectangle that crops the content of the layer and scales it
415 * to the layer's size.
416 */
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700417 Rect getContentCrop() const;
Mathias Agopian13127d82013-03-05 17:47:11 -0800418
Eric Penner51c59cd2014-07-28 19:51:58 -0700419 /*
420 * Returns if a frame is queued.
421 */
Pablo Ceballos06312182015-10-07 16:32:12 -0700422 bool hasQueuedFrame() const { return mQueuedFrames > 0 ||
Pablo Ceballosff95aab2016-01-13 17:09:58 -0800423 mSidebandStreamChanged || mAutoRefresh; }
Eric Penner51c59cd2014-07-28 19:51:58 -0700424
Kalle Raitaa099a242017-01-11 11:17:29 -0800425 int32_t getQueuedFrameCount() const { return mQueuedFrames; }
426
Fabien Sanglard9d96de42016-10-11 00:15:18 +0000427#ifdef USE_HWC2
Dan Stoza9e56aa02015-11-02 13:00:03 -0800428 // -----------------------------------------------------------------------
429
Steven Thomasb02664d2017-07-26 18:48:28 -0700430 bool createHwcLayer(HWComposer* hwc, int32_t hwcId);
431 void destroyHwcLayer(int32_t hwcId);
432 void destroyAllHwcLayers();
433
Dan Stoza9e56aa02015-11-02 13:00:03 -0800434 bool hasHwcLayer(int32_t hwcId) {
Steven Thomasb02664d2017-07-26 18:48:28 -0700435 return mHwcLayers.count(hwcId) > 0;
Dan Stoza9e56aa02015-11-02 13:00:03 -0800436 }
437
Steven Thomasb02664d2017-07-26 18:48:28 -0700438 HWC2::Layer* getHwcLayer(int32_t hwcId) {
Dan Stoza9e56aa02015-11-02 13:00:03 -0800439 if (mHwcLayers.count(hwcId) == 0) {
440 return nullptr;
441 }
442 return mHwcLayers[hwcId].layer;
443 }
444
Fabien Sanglard9d96de42016-10-11 00:15:18 +0000445#endif
Mathias Agopian13127d82013-03-05 17:47:11 -0800446 // -----------------------------------------------------------------------
447
chaviwa76b2712017-09-20 12:02:26 -0700448 void clearWithOpenGL(const RenderArea& renderArea) const;
Mathias Agopian13127d82013-03-05 17:47:11 -0800449 void setFiltering(bool filtering);
450 bool getFiltering() const;
451
452 // only for debugging
453 inline const sp<GraphicBuffer>& getActiveBuffer() const { return mActiveBuffer; }
454
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700455 inline const State& getDrawingState() const { return mDrawingState; }
456 inline const State& getCurrentState() const { return mCurrentState; }
457 inline State& getCurrentState() { return mCurrentState; }
Mathias Agopian13127d82013-03-05 17:47:11 -0800458
Kalle Raitaa099a242017-01-11 11:17:29 -0800459 LayerDebugInfo getLayerDebugInfo() const;
Mathias Agopian13127d82013-03-05 17:47:11 -0800460
461 /* always call base class first */
Fabien Sanglard9d96de42016-10-11 00:15:18 +0000462#ifdef USE_HWC2
Dan Stozae22aec72016-08-01 13:20:59 -0700463 static void miniDumpHeader(String8& result);
464 void miniDump(String8& result, int32_t hwcId) const;
Fabien Sanglard9d96de42016-10-11 00:15:18 +0000465#endif
Svetoslavd85084b2014-03-20 10:28:31 -0700466 void dumpFrameStats(String8& result) const;
Brian Andersond6927fb2016-07-23 23:37:30 -0700467 void dumpFrameEvents(String8& result);
Svetoslavd85084b2014-03-20 10:28:31 -0700468 void clearFrameStats();
Jamie Gennis6547ff42013-07-16 20:12:42 -0700469 void logFrameStats();
Svetoslavd85084b2014-03-20 10:28:31 -0700470 void getFrameStats(FrameStats* outStats) const;
Mathias Agopian1b5e1022010-04-20 17:55:49 -0700471
Dan Stozae77c7662016-05-13 11:37:28 -0700472 std::vector<OccupancyTracker::Segment> getOccupancyHistory(bool forceFlush);
473
Brian Anderson5ea5e592016-12-01 16:54:33 -0800474 void onDisconnect();
Brian Anderson3890c392016-07-25 12:48:08 -0700475 void addAndGetFrameTimestamps(const NewFrameEventsEntry* newEntry,
476 FrameEventHistoryDelta* outDelta);
Pablo Ceballosce796e72016-02-04 19:10:51 -0800477
Robert Carr367c5682016-06-20 11:55:28 -0700478 bool getTransformToDisplayInverse() const;
479
Robert Carr1f0a16a2016-10-24 16:27:39 -0700480 Transform getTransform() const;
481
Robert Carr6452f122017-03-21 10:41:29 -0700482 // Returns the Alpha of the Surface, accounting for the Alpha
483 // of parent Surfaces in the hierarchy (alpha's will be multiplied
484 // down the hierarchy).
chaviw13fdc492017-06-27 12:40:18 -0700485 half getAlpha() const;
486 half4 getColor() const;
Robert Carr6452f122017-03-21 10:41:29 -0700487
Dan Stoza412903f2017-04-27 13:42:17 -0700488 void traverseInReverseZOrder(LayerVector::StateSet stateSet,
489 const LayerVector::Visitor& visitor);
490 void traverseInZOrder(LayerVector::StateSet stateSet, const LayerVector::Visitor& visitor);
Robert Carr1f0a16a2016-10-24 16:27:39 -0700491
chaviwa76b2712017-09-20 12:02:26 -0700492 void traverseChildrenInZOrder(LayerVector::StateSet stateSet,
493 const LayerVector::Visitor& visitor);
494
Chia-I Wu98f1c102017-05-30 14:54:08 -0700495 size_t getChildrenCount() const;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700496 void addChild(const sp<Layer>& layer);
497 // Returns index if removed, or negative value otherwise
498 // for symmetry with Vector::remove
499 ssize_t removeChild(const sp<Layer>& layer);
Chia-I Wue41dbe62017-06-13 14:10:56 -0700500 sp<Layer> getParent() const { return mCurrentParent.promote(); }
Robert Carr1f0a16a2016-10-24 16:27:39 -0700501 bool hasParent() const { return getParent() != nullptr; }
Robert Carr1f0a16a2016-10-24 16:27:39 -0700502 Rect computeScreenBounds(bool reduceTransparentRegion = true) const;
503 bool setChildLayer(const sp<Layer>& childLayer, int32_t z);
504
505 // Copy the current list of children to the drawing state. Called by
506 // SurfaceFlinger to complete a transaction.
507 void commitChildList();
Robert Carr1f0a16a2016-10-24 16:27:39 -0700508 int32_t getZ() const;
Mathias Agopian13127d82013-03-05 17:47:11 -0800509protected:
510 // constant
511 sp<SurfaceFlinger> mFlinger;
Mathias Agopian13127d82013-03-05 17:47:11 -0800512 /*
513 * Trivial class, used to ensure that mFlinger->onLayerDestroyed(mLayer)
514 * is called.
515 */
516 class LayerCleaner {
517 sp<SurfaceFlinger> mFlinger;
518 wp<Layer> mLayer;
519 protected:
Irvel468051e2016-06-13 16:44:44 -0700520 ~LayerCleaner() {
521 // destroy client resources
522 mFlinger->onLayerDestroyed(mLayer);
523 }
Mathias Agopian13127d82013-03-05 17:47:11 -0800524 public:
Irvel468051e2016-06-13 16:44:44 -0700525 LayerCleaner(const sp<SurfaceFlinger>& flinger,
526 const sp<Layer>& layer)
527 : mFlinger(flinger), mLayer(layer) {
528 }
Mathias Agopian13127d82013-03-05 17:47:11 -0800529 };
530
Mathias Agopian2a9fc492013-03-01 13:42:57 -0800531
Irvel468051e2016-06-13 16:44:44 -0700532 virtual void onFirstRef();
533
534
535
Irvel468051e2016-06-13 16:44:44 -0700536 friend class SurfaceInterceptor;
Pablo Ceballos05289c22016-04-14 15:49:55 -0700537 void commitTransaction(const State& stateToCommit);
Mathias Agopian1eae0ee2013-06-05 16:59:15 -0700538
Mathias Agopian3330b202009-10-05 17:07:12 -0700539 uint32_t getEffectiveUsage(uint32_t usage) const;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700540
Dan Stoza5a423ea2017-02-16 14:10:39 -0800541 FloatRect computeCrop(const sp<const DisplayDevice>& hw) const;
David Sodman0c69cad2017-08-21 12:12:51 -0700542 // Compute the initial crop as specified by parent layers and the
543 // SurfaceControl for this layer. Does not include buffer crop from the
544 // IGraphicBufferProducer client, as that should not affect child clipping.
545 // Returns in screen space.
Robert Carr1f0a16a2016-10-24 16:27:39 -0700546 Rect computeInitialCrop(const sp<const DisplayDevice>& hw) const;
Mathias Agopian0aa758d2009-04-22 15:23:34 -0700547
Mathias Agopian13127d82013-03-05 17:47:11 -0800548 // drawing
chaviwa76b2712017-09-20 12:02:26 -0700549 void clearWithOpenGL(const RenderArea& renderArea,
Mathias Agopian3f844832013-08-07 21:24:32 -0700550 float r, float g, float b, float alpha) const;
Dan Stozac5da2712016-07-20 15:38:12 -0700551
Robert Carr1f0a16a2016-10-24 16:27:39 -0700552 void setParent(const sp<Layer>& layer);
553
Dan Stoza412903f2017-04-27 13:42:17 -0700554 LayerVector makeTraversalList(LayerVector::StateSet stateSet);
Robert Carrdb66e622017-04-10 16:55:57 -0700555 void addZOrderRelative(const wp<Layer>& relative);
556 void removeZOrderRelative(const wp<Layer>& relative);
557
David Sodman0c69cad2017-08-21 12:12:51 -0700558protected:
Dan Stoza7dde5992015-05-22 09:51:44 -0700559 class SyncPoint
560 {
561 public:
Chih-Hung Hsieh342b7602016-09-01 11:34:16 -0700562 explicit SyncPoint(uint64_t frameNumber) : mFrameNumber(frameNumber),
Dan Stoza7dde5992015-05-22 09:51:44 -0700563 mFrameIsAvailable(false), mTransactionIsApplied(false) {}
564
565 uint64_t getFrameNumber() const {
566 return mFrameNumber;
567 }
568
569 bool frameIsAvailable() const {
570 return mFrameIsAvailable;
571 }
572
573 void setFrameAvailable() {
574 mFrameIsAvailable = true;
575 }
576
577 bool transactionIsApplied() const {
578 return mTransactionIsApplied;
579 }
580
581 void setTransactionApplied() {
582 mTransactionIsApplied = true;
583 }
584
585 private:
586 const uint64_t mFrameNumber;
587 std::atomic<bool> mFrameIsAvailable;
588 std::atomic<bool> mTransactionIsApplied;
589 };
590
Dan Stozacac35382016-01-27 12:21:06 -0800591 // SyncPoints which will be signaled when the correct frame is at the head
592 // of the queue and dropped after the frame has been latched. Protected by
593 // mLocalSyncPointMutex.
594 Mutex mLocalSyncPointMutex;
Dan Stoza7dde5992015-05-22 09:51:44 -0700595 std::list<std::shared_ptr<SyncPoint>> mLocalSyncPoints;
596
Dan Stozacac35382016-01-27 12:21:06 -0800597 // SyncPoints which will be signaled and then dropped when the transaction
598 // is applied
Dan Stoza7dde5992015-05-22 09:51:44 -0700599 std::list<std::shared_ptr<SyncPoint>> mRemoteSyncPoints;
600
Dan Stozacac35382016-01-27 12:21:06 -0800601 // Returns false if the relevant frame has already been latched
602 bool addSyncPoint(const std::shared_ptr<SyncPoint>& point);
Dan Stoza7dde5992015-05-22 09:51:44 -0700603
604 void pushPendingState();
Pablo Ceballos05289c22016-04-14 15:49:55 -0700605 void popPendingState(State* stateToCommit);
606 bool applyPendingStates(State* stateToCommit);
Robert Carrc3574f72016-03-24 12:19:32 -0700607
Robert Carr1f0a16a2016-10-24 16:27:39 -0700608 void clearSyncPoints();
609
Robert Carrc3574f72016-03-24 12:19:32 -0700610 // Returns mCurrentScaling mode (originating from the
611 // Client) or mOverrideScalingMode mode (originating from
612 // the Surface Controller) if set.
David Sodman0c69cad2017-08-21 12:12:51 -0700613 virtual uint32_t getEffectiveScalingMode() const = 0;
Dan Stoza7dde5992015-05-22 09:51:44 -0700614public:
Irvel468051e2016-06-13 16:44:44 -0700615 /*
616 * The layer handle is just a BBinder object passed to the client
617 * (remote process) -- we don't keep any reference on our side such that
618 * the dtor is called when the remote side let go of its reference.
619 *
620 * LayerCleaner ensures that mFlinger->onLayerDestroyed() is called for
621 * this layer when the handle is destroyed.
622 */
623 class Handle : public BBinder, public LayerCleaner {
624 public:
625 Handle(const sp<SurfaceFlinger>& flinger, const sp<Layer>& layer)
626 : LayerCleaner(flinger, layer), owner(layer) {}
627
628 wp<Layer> owner;
629 };
630
631 sp<IBinder> getHandle();
Irvel468051e2016-06-13 16:44:44 -0700632 const String8& getName() const;
David Sodman0c69cad2017-08-21 12:12:51 -0700633 virtual void notifyAvailableFrames() = 0;
634 virtual PixelFormat getPixelFormat() const = 0;
chaviw13fdc492017-06-27 12:40:18 -0700635 bool getPremultipledAlpha() const;
David Sodman0c69cad2017-08-21 12:12:51 -0700636protected:
Igor Murashkina4a31492012-10-29 13:36:11 -0700637
Mathias Agopianb7e930d2010-06-01 15:12:58 -0700638 // -----------------------------------------------------------------------
639
Mathias Agopiana67932f2011-04-20 14:20:59 -0700640 // constants
Andy McFaddenbf974ab2012-12-04 16:51:15 -0800641 sp<SurfaceFlingerConsumer> mSurfaceFlingerConsumer;
Mathias Agopian13127d82013-03-05 17:47:11 -0800642 bool mPremultipliedAlpha;
643 String8 mName;
David Sodman0c69cad2017-08-21 12:12:51 -0700644 String8 mTransactionName; // A cached version of "TX - " + mName for systraces
Mathias Agopian13127d82013-03-05 17:47:11 -0800645
Chia-I Wuab0c3192017-08-01 11:29:00 -0700646 bool mPrimaryDisplayOnly = false;
647
Mathias Agopian13127d82013-03-05 17:47:11 -0800648 // these are protected by an external lock
649 State mCurrentState;
650 State mDrawingState;
651 volatile int32_t mTransactionFlags;
Mathias Agopiand606de62010-05-10 20:06:11 -0700652
Dan Stoza7dde5992015-05-22 09:51:44 -0700653 // Accessed from main thread and binder threads
654 Mutex mPendingStateMutex;
655 Vector<State> mPendingStates;
656
Mathias Agopianb7e930d2010-06-01 15:12:58 -0700657 // thread-safe
Mathias Agopiana67932f2011-04-20 14:20:59 -0700658 volatile int32_t mQueuedFrames;
David Sodman0c69cad2017-08-21 12:12:51 -0700659 volatile int32_t mSidebandStreamChanged; // used like an atomic boolean
Brian Andersond6927fb2016-07-23 23:37:30 -0700660
661 // Timestamp history for UIAutomation. Thread safe.
Jamie Gennis4b0eba92013-02-05 13:30:24 -0800662 FrameTracker mFrameTracker;
Mathias Agopiana67932f2011-04-20 14:20:59 -0700663
Brian Andersond6927fb2016-07-23 23:37:30 -0700664 // Timestamp history for the consumer to query.
665 // Accessed by both consumer and producer on main and binder threads.
666 Mutex mFrameEventHistoryMutex;
Brian Anderson3890c392016-07-25 12:48:08 -0700667 ConsumerFrameEventHistory mFrameEventHistory;
Brian Anderson3d4039d2016-09-23 16:31:30 -0700668 FenceTimeline mAcquireTimeline;
669 FenceTimeline mReleaseTimeline;
Brian Andersond6927fb2016-07-23 23:37:30 -0700670
Mathias Agopiana67932f2011-04-20 14:20:59 -0700671 // main thread
Mathias Agopiana9347642017-02-13 16:42:28 -0800672 int mActiveBufferSlot;
Mathias Agopiana67932f2011-04-20 14:20:59 -0700673 sp<GraphicBuffer> mActiveBuffer;
Jesse Hall399184a2014-03-03 15:42:54 -0800674 sp<NativeHandle> mSidebandStream;
Mathias Agopiana67932f2011-04-20 14:20:59 -0700675 Rect mCurrentCrop;
676 uint32_t mCurrentTransform;
Robert Carrc3574f72016-03-24 12:19:32 -0700677 // We encode unset as -1.
678 int32_t mOverrideScalingMode;
Mathias Agopiana67932f2011-04-20 14:20:59 -0700679 bool mCurrentOpacity;
Dan Stozacac35382016-01-27 12:21:06 -0800680 std::atomic<uint64_t> mCurrentFrameNumber;
Jamie Gennise8696a42012-01-15 18:54:57 -0800681 bool mFrameLatencyNeeded;
Mathias Agopian13127d82013-03-05 17:47:11 -0800682 // Whether filtering is forced on or not
683 bool mFiltering;
684 // Whether filtering is needed b/c of the drawingstate
685 bool mNeedsFiltering;
Mathias Agopian5cdc8992013-08-13 20:51:23 -0700686 // The mesh used to draw the layer in GLES composition mode
687 mutable Mesh mMesh;
David Sodman0c69cad2017-08-21 12:12:51 -0700688
Mathias Agopiand606de62010-05-10 20:06:11 -0700689
Fabien Sanglard9d96de42016-10-11 00:15:18 +0000690#ifdef USE_HWC2
Dan Stoza9e56aa02015-11-02 13:00:03 -0800691 // HWC items, accessed from the main thread
692 struct HWCInfo {
693 HWCInfo()
Steven Thomasb02664d2017-07-26 18:48:28 -0700694 : hwc(nullptr),
695 layer(nullptr),
Dan Stoza9e56aa02015-11-02 13:00:03 -0800696 forceClientComposition(false),
697 compositionType(HWC2::Composition::Invalid),
698 clearClientTarget(false) {}
699
Steven Thomasb02664d2017-07-26 18:48:28 -0700700 HWComposer* hwc;
701 HWC2::Layer* layer;
Dan Stoza9e56aa02015-11-02 13:00:03 -0800702 bool forceClientComposition;
703 HWC2::Composition compositionType;
704 bool clearClientTarget;
Dan Stozae22aec72016-08-01 13:20:59 -0700705 Rect displayFrame;
Dan Stoza5a423ea2017-02-16 14:10:39 -0800706 FloatRect sourceCrop;
Chia-I Wuaaff73f2017-02-13 12:28:24 -0800707 HWComposerBufferCache bufferCache;
Dan Stoza9e56aa02015-11-02 13:00:03 -0800708 };
Fabien Sanglardf0c53d62017-03-03 18:58:50 -0800709
710 // A layer can be attached to multiple displays when operating in mirror mode
711 // (a.k.a: when several displays are attached with equal layerStack). In this
Fabien Sanglard4afbf412017-03-08 14:50:11 -0800712 // case we need to keep track. In non-mirror mode, a layer will have only one
Fabien Sanglardf0c53d62017-03-03 18:58:50 -0800713 // HWCInfo. This map key is a display layerStack.
Dan Stoza9e56aa02015-11-02 13:00:03 -0800714 std::unordered_map<int32_t, HWCInfo> mHwcLayers;
Fabien Sanglard9d96de42016-10-11 00:15:18 +0000715#else
716 bool mIsGlesComposition;
717#endif
Dan Stoza9e56aa02015-11-02 13:00:03 -0800718
Mathias Agopianb7e930d2010-06-01 15:12:58 -0700719 // page-flip thread (currently main thread)
Glenn Kasten16f04532011-01-19 15:27:27 -0800720 bool mProtectedByApp; // application requires protected path to external sink
Mathias Agopian13127d82013-03-05 17:47:11 -0800721
722 // protected by mLock
723 mutable Mutex mLock;
David Sodman0c69cad2017-08-21 12:12:51 -0700724
Mathias Agopian13127d82013-03-05 17:47:11 -0800725 const wp<Client> mClientRef;
Riley Andrews03414a12014-07-01 14:22:59 -0700726
727 // This layer can be a cursor on some displays.
728 bool mPotentialCursor;
Dan Stoza6b9454d2014-11-07 16:00:59 -0800729
730 // Local copy of the queued contents of the incoming BufferQueue
731 mutable Mutex mQueueItemLock;
Dan Stozaa4650a52015-05-12 12:56:16 -0700732 Condition mQueueItemCondition;
Dan Stoza6b9454d2014-11-07 16:00:59 -0800733 Vector<BufferItem> mQueueItems;
Dan Stozacac35382016-01-27 12:21:06 -0800734 std::atomic<uint64_t> mLastFrameNumberReceived;
Pablo Ceballosff95aab2016-01-13 17:09:58 -0800735 bool mAutoRefresh;
Robert Carr7bf247e2017-05-18 14:02:49 -0700736 bool mFreezeGeometryUpdates;
Robert Carr1f0a16a2016-10-24 16:27:39 -0700737
738 // Child list about to be committed/used for editing.
739 LayerVector mCurrentChildren;
740 // Child list used for rendering.
741 LayerVector mDrawingChildren;
742
Chia-I Wue41dbe62017-06-13 14:10:56 -0700743 wp<Layer> mCurrentParent;
744 wp<Layer> mDrawingParent;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800745};
746
747// ---------------------------------------------------------------------------
748
749}; // namespace android
750
751#endif // ANDROID_LAYER_H