Layer.h revision 0cc69188196037c06127c0bc56c516069dbaa558
1edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/*
2edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Copyright (C) 2007 The Android Open Source Project
3edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project *
4edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License");
5edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * you may not use this file except in compliance with the License.
6edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * You may obtain a copy of the License at
7edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project *
8edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project *      http://www.apache.org/licenses/LICENSE-2.0
9edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project *
10edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Unless required by applicable law or agreed to in writing, software
11edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS,
12edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * See the License for the specific language governing permissions and
14edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * limitations under the License.
15edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project */
16edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project
17edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#ifndef ANDROID_LAYER_H
18edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#define ANDROID_LAYER_H
19edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project
20edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <stdint.h>
21edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <sys/types.h>
22edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project
2313127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian#include <utils/RefBase.h>
2413127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian#include <utils/String8.h>
2590ac799241f077a7b7e6c1875fd933864c8dd2a7Mathias Agopian#include <utils/Timers.h>
2690ac799241f077a7b7e6c1875fd933864c8dd2a7Mathias Agopian
27d85084b2b65828442eafaff9b811e9b6c9ca9fadSvetoslav#include <ui/FrameStats.h>
283330b203039dea366d4981db1408a460134b2d2cMathias Agopian#include <ui/GraphicBuffer.h>
29edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <ui/PixelFormat.h>
3013127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian#include <ui/Region.h>
31edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project
3290ac799241f077a7b7e6c1875fd933864c8dd2a7Mathias Agopian#include <gui/ISurfaceComposerClient.h>
334cdc58f6840d15b4952149d2b345ec1f97d505bcRobert Carr#include <gui/LayerState.h>
340cc69188196037c06127c0bc56c516069dbaa558David Sodman#include <gui/BufferQueue.h>
35076b1cc3a9b90aa5b381a1ed268ca0b548444c9bMathias Agopian
367dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza#include <list>
377dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza
3813127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian#include "Client.h"
3941fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman#include "FrameTracker.h"
401f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr#include "LayerVector.h"
41b9b088375d33a87b201cdbe18be71802e2607717Dan Stoza#include "MonitoredProducer.h"
4213127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian#include "SurfaceFlinger.h"
43edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include "Transform.h"
44edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project
4541fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman#include <layerproto/LayerProtoHeader.h>
4613127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian#include "DisplayHardware/HWComposer.h"
47aaff73f92a2fcadda8c765eb9b02f2849418a873Chia-I Wu#include "DisplayHardware/HWComposerBufferCache.h"
4841fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman#include "RenderArea.h"
493f84483382be2d528918cc1a6fbc6a7d68e0b181Mathias Agopian#include "RenderEngine/Mesh.h"
5049457ac092071a8f964f7f69156093657ccdc3d0Mathias Agopian#include "RenderEngine/Texture.h"
5113127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
5213fdc49516d17f41e64e62e73c313b0928bf13ccchaviw#include <math/vec4.h>
5313fdc49516d17f41e64e62e73c313b0928bf13ccchaviw
541d04428c3cff3503212ec3e76775ca5ba20abc18chaviwusing namespace android::surfaceflinger;
551d04428c3cff3503212ec3e76775ca5ba20abc18chaviw
56edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectnamespace android {
57edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project
58edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// ---------------------------------------------------------------------------
59edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project
60edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass Client;
613e25fd8609b100a75721be82d1d499f0ae9083cbMathias Agopianclass Colorizer;
6213127d8921356dff794250e04208c3ed60b3a3dfMathias Agopianclass DisplayDevice;
6313127d8921356dff794250e04208c3ed60b3a3dfMathias Agopianclass GraphicBuffer;
6413127d8921356dff794250e04208c3ed60b3a3dfMathias Agopianclass SurfaceFlinger;
65a099a24c93bfa599fc5c36a647e946c26f68514fKalle Raitaclass LayerDebugInfo;
669eeae69005ef9a774bde19195b9c06eba7e463c2David Sodmanclass LayerBE;
67edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project
68edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// ---------------------------------------------------------------------------
69edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project
700cc69188196037c06127c0bc56c516069dbaa558David Sodmanstruct CompositionInfo {
710cc69188196037c06127c0bc56c516069dbaa558David Sodman    HWC2::Composition compositionType;
720cc69188196037c06127c0bc56c516069dbaa558David Sodman    sp<GraphicBuffer> mBuffer = nullptr;
730cc69188196037c06127c0bc56c516069dbaa558David Sodman    int mBufferSlot = BufferQueue::INVALID_BUFFER_SLOT;
740cc69188196037c06127c0bc56c516069dbaa558David Sodman    struct {
750cc69188196037c06127c0bc56c516069dbaa558David Sodman        HWComposer* hwc;
760cc69188196037c06127c0bc56c516069dbaa558David Sodman        sp<Fence> fence;
770cc69188196037c06127c0bc56c516069dbaa558David Sodman        HWC2::BlendMode blendMode;
780cc69188196037c06127c0bc56c516069dbaa558David Sodman        Rect displayFrame;
790cc69188196037c06127c0bc56c516069dbaa558David Sodman        float alpha;
800cc69188196037c06127c0bc56c516069dbaa558David Sodman        FloatRect sourceCrop;
810cc69188196037c06127c0bc56c516069dbaa558David Sodman        HWC2::Transform transform;
820cc69188196037c06127c0bc56c516069dbaa558David Sodman        int z;
830cc69188196037c06127c0bc56c516069dbaa558David Sodman        int type;
840cc69188196037c06127c0bc56c516069dbaa558David Sodman        int appId;
850cc69188196037c06127c0bc56c516069dbaa558David Sodman        Region visibleRegion;
860cc69188196037c06127c0bc56c516069dbaa558David Sodman        Region surfaceDamage;
870cc69188196037c06127c0bc56c516069dbaa558David Sodman        sp<NativeHandle> sidebandStream;
880cc69188196037c06127c0bc56c516069dbaa558David Sodman        android_dataspace dataspace;
890cc69188196037c06127c0bc56c516069dbaa558David Sodman        hwc_color_t color;
900cc69188196037c06127c0bc56c516069dbaa558David Sodman    } hwc;
910cc69188196037c06127c0bc56c516069dbaa558David Sodman    struct {
920cc69188196037c06127c0bc56c516069dbaa558David Sodman        RenderEngine* renderEngine;
930cc69188196037c06127c0bc56c516069dbaa558David Sodman        Mesh* mesh;
940cc69188196037c06127c0bc56c516069dbaa558David Sodman    } renderEngine;
950cc69188196037c06127c0bc56c516069dbaa558David Sodman};
960cc69188196037c06127c0bc56c516069dbaa558David Sodman
979eeae69005ef9a774bde19195b9c06eba7e463c2David Sodmanclass LayerBE {
989eeae69005ef9a774bde19195b9c06eba7e463c2David Sodmanpublic:
999eeae69005ef9a774bde19195b9c06eba7e463c2David Sodman    LayerBE();
1009eeae69005ef9a774bde19195b9c06eba7e463c2David Sodman
1019eeae69005ef9a774bde19195b9c06eba7e463c2David Sodman    // The mesh used to draw the layer in GLES composition mode
1029eeae69005ef9a774bde19195b9c06eba7e463c2David Sodman    Mesh mMesh;
1039eeae69005ef9a774bde19195b9c06eba7e463c2David Sodman
1046f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman    // HWC items, accessed from the main thread
1056f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman    struct HWCInfo {
1066f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman        HWCInfo()
1076f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman              : hwc(nullptr),
1086f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman                layer(nullptr),
1096f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman                forceClientComposition(false),
1106f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman                compositionType(HWC2::Composition::Invalid),
1116f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman                clearClientTarget(false) {}
1126f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman
1136f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman        HWComposer* hwc;
1146f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman        HWC2::Layer* layer;
1156f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman        bool forceClientComposition;
1166f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman        HWC2::Composition compositionType;
1176f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman        bool clearClientTarget;
1186f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman        Rect displayFrame;
1196f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman        FloatRect sourceCrop;
1206f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman        HWComposerBufferCache bufferCache;
1216f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman    };
1226f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman
1236f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman    // A layer can be attached to multiple displays when operating in mirror mode
1246f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman    // (a.k.a: when several displays are attached with equal layerStack). In this
1256f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman    // case we need to keep track. In non-mirror mode, a layer will have only one
1266f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman    // HWCInfo. This map key is a display layerStack.
1276f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman    std::unordered_map<int32_t, HWCInfo> mHwcLayers;
1280cc69188196037c06127c0bc56c516069dbaa558David Sodman
1290cc69188196037c06127c0bc56c516069dbaa558David Sodman    CompositionInfo compositionInfo;
1309eeae69005ef9a774bde19195b9c06eba7e463c2David Sodman};
1319eeae69005ef9a774bde19195b9c06eba7e463c2David Sodman
13241fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodmanclass Layer : public virtual RefBase {
13313127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    static int32_t sSequence;
13413127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
135d606de6bb6877dc4ab93ec0be0c6bda4a8ee1ce8Mathias Agopianpublic:
1369eeae69005ef9a774bde19195b9c06eba7e463c2David Sodman    LayerBE& getBE() { return mBE; }
1379eeae69005ef9a774bde19195b9c06eba7e463c2David Sodman    LayerBE& getBE() const { return mBE; }
13813127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    mutable bool contentDirty;
13913127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    // regions below are in window-manager space
14013127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    Region visibleRegion;
14113127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    Region coveredRegion;
14213127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    Region visibleNonTransparentRegion;
143ee44edd0acccbf5eaa918d75737c3b65ee04fff7Dan Stoza    Region surfaceDamageRegion;
1444df87bd1f6f68126e5e9081fc1365ae500e375dbAndy McFadden
1454df87bd1f6f68126e5e9081fc1365ae500e375dbAndy McFadden    // Layer serial number.  This gives layers an explicit ordering, so we
1464df87bd1f6f68126e5e9081fc1365ae500e375dbAndy McFadden    // have a stable sort order when their layer stack and Z-order are
1474df87bd1f6f68126e5e9081fc1365ae500e375dbAndy McFadden    // the same.
14813127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    int32_t sequence;
14913127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
15013127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    enum { // flags for doTransaction()
15113127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian        eDontUpdateGeometryState = 0x00000001,
15213127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian        eVisibleRegion = 0x00000002,
15313127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    };
15413127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
15513127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    struct Geometry {
15613127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian        uint32_t w;
15713127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian        uint32_t h;
1583dcabfab7ef80df5884b269fec17350a26da6f51Robert Carr        Transform transform;
1593dcabfab7ef80df5884b269fec17350a26da6f51Robert Carr
16041fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman        inline bool operator==(const Geometry& rhs) const {
16141fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman            return (w == rhs.w && h == rhs.h) && (transform.tx() == rhs.transform.tx()) &&
16299e27f0bc236e38d88ff4f9912ede514a729b8ebRobert Carr                    (transform.ty() == rhs.transform.ty());
16313127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian        }
16441fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman        inline bool operator!=(const Geometry& rhs) const { return !operator==(rhs); }
16513127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    };
16613127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
16713127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    struct State {
16813127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian        Geometry active;
16913127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian        Geometry requested;
170ae0608381b2b4699218febd6d45ad9d307544d55Robert Carr        int32_t z;
171f0c53d6e864abc284b267e866817b3d006944a60Fabien Sanglard
172f0c53d6e864abc284b267e866817b3d006944a60Fabien Sanglard        // The identifier of the layer stack this layer belongs to. A layer can
173f0c53d6e864abc284b267e866817b3d006944a60Fabien Sanglard        // only be associated to a single layer stack. A layer stack is a
174f0c53d6e864abc284b267e866817b3d006944a60Fabien Sanglard        // z-ordered group of layers which can be associated to one or more
175f0c53d6e864abc284b267e866817b3d006944a60Fabien Sanglard        // displays. Using the same layer stack on different displays is a way
176f0c53d6e864abc284b267e866817b3d006944a60Fabien Sanglard        // to achieve mirroring.
17713127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian        uint32_t layerStack;
178f0c53d6e864abc284b267e866817b3d006944a60Fabien Sanglard
17913127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian        uint8_t flags;
1807dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza        uint8_t mask;
18113127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian        uint8_t reserved[2];
18213127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian        int32_t sequence; // changes when visible regions can change
1837dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza        bool modified;
1847dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza
1854ed383cec76494a529abbd167109759d9e40cdd9Fabien Sanglard        // Crop is expressed in layer space coordinate.
186b5d3d2657bad1f012377dfacd354d3100a65768aRobert Carr        Rect crop;
18799e27f0bc236e38d88ff4f9912ede514a729b8ebRobert Carr        Rect requestedCrop;
18899e27f0bc236e38d88ff4f9912ede514a729b8ebRobert Carr
1894ed383cec76494a529abbd167109759d9e40cdd9Fabien Sanglard        // finalCrop is expressed in display space coordinate.
190b5d3d2657bad1f012377dfacd354d3100a65768aRobert Carr        Rect finalCrop;
1918d5227b8416b099c884429312daf2d60496fa484Robert Carr        Rect requestedFinalCrop;
192b5d3d2657bad1f012377dfacd354d3100a65768aRobert Carr
1930d48072f6047140119ff194c1194ce402fca2c0bRobert Carr        // If set, defers this state update until the identified Layer
1947dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza        // receives a frame with the given frameNumber
1950d48072f6047140119ff194c1194ce402fca2c0bRobert Carr        wp<Layer> barrierLayer;
1967dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza        uint64_t frameNumber;
1977dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza
1982ca79399b933935eb1b6c0ec1f746f8c4475369cMathias Agopian        // the transparentRegion hint is a bit special, it's latched only
1992ca79399b933935eb1b6c0ec1f746f8c4475369cMathias Agopian        // when we receive a buffer -- this is because it's "content"
2002ca79399b933935eb1b6c0ec1f746f8c4475369cMathias Agopian        // dependent.
2012ca79399b933935eb1b6c0ec1f746f8c4475369cMathias Agopian        Region activeTransparentRegion;
2022ca79399b933935eb1b6c0ec1f746f8c4475369cMathias Agopian        Region requestedTransparentRegion;
203bb09b436fa119ad8b97f1bf5c04cc5aa10b5f1f0Courtney Goeltzenleuchter        android_dataspace dataSpace;
2042f5f8a51f5994cf14837030d4b3b252a9d1b950bDaniel Nicoara
2052f5f8a51f5994cf14837030d4b3b252a9d1b950bDaniel Nicoara        uint32_t appId;
2062f5f8a51f5994cf14837030d4b3b252a9d1b950bDaniel Nicoara        uint32_t type;
207db66e627ad8904491e384c64f82fc77a939b9705Robert Carr
208db66e627ad8904491e384c64f82fc77a939b9705Robert Carr        // If non-null, a Surface this Surface's Z-order is interpreted relative to.
209db66e627ad8904491e384c64f82fc77a939b9705Robert Carr        wp<Layer> zOrderRelativeOf;
210db66e627ad8904491e384c64f82fc77a939b9705Robert Carr
211db66e627ad8904491e384c64f82fc77a939b9705Robert Carr        // A list of surfaces whose Z-order is interpreted relative to ours.
212db66e627ad8904491e384c64f82fc77a939b9705Robert Carr        SortedVector<wp<Layer>> zOrderRelatives;
21313fdc49516d17f41e64e62e73c313b0928bf13ccchaviw
21413fdc49516d17f41e64e62e73c313b0928bf13ccchaviw        half4 color;
21513127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    };
21613127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
21741fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman    Layer(SurfaceFlinger* flinger, const sp<Client>& client, const String8& name, uint32_t w,
21841fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman          uint32_t h, uint32_t flags);
219b7e930db175c192464cebdeb49eb56cf6dd60114Mathias Agopian    virtual ~Layer();
220edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project
221ab0c319824632c463ea624cee6f0bc3c8cd8a779Chia-I Wu    void setPrimaryDisplayOnly() { mPrimaryDisplayOnly = true; }
222ab0c319824632c463ea624cee6f0bc3c8cd8a779Chia-I Wu
2237bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // ------------------------------------------------------------------------
2247bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // Geometry setting functions.
2257bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    //
2267bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // The following group of functions are used to specify the layers
2277bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // bounds, and the mapping of the texture on to those bounds. According
2287bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // to various settings changes to them may apply immediately, or be delayed until
2297bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // a pending resize is completed by the producer submitting a buffer. For example
2307bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // if we were to change the buffer size, and update the matrix ahead of the
2317bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // new buffer arriving, then we would be stretching the buffer to a different
2327bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // aspect before and after the buffer arriving, which probably isn't what we wanted.
2337bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    //
2347bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // The first set of geometry functions are controlled by the scaling mode, described
2357bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // in window.h. The scaling mode may be set by the client, as it submits buffers.
2367bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // This value may be overriden through SurfaceControl, with setOverrideScalingMode.
2377bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    //
2387bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // Put simply, if our scaling mode is SCALING_MODE_FREEZE, then
2397bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // matrix updates will not be applied while a resize is pending
2407bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // and the size and transform will remain in their previous state
2417bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // until a new buffer is submitted. If the scaling mode is another value
2427bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // then the old-buffer will immediately be scaled to the pending size
2437bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // and the new matrix will be immediately applied following this scaling
2447bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // transformation.
2457bf247e2db180da661b18084d50e0b389686fc0cRobert Carr
2467bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // Set the default buffer size for the assosciated Producer, in pixels. This is
2477bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // also the rendered size of the layer prior to any transformations. Parent
2487bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // or local matrix transformations will not affect the size of the buffer,
2497bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // but may affect it's on-screen size or clipping.
2507bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    bool setSize(uint32_t w, uint32_t h);
2517bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // Set a 2x2 transformation matrix on the layer. This transform
2527bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // will be applied after parent transforms, but before any final
2537bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // producer specified transform.
2547bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    bool setMatrix(const layer_state_t::matrix22_t& matrix);
2557bf247e2db180da661b18084d50e0b389686fc0cRobert Carr
2567bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // This second set of geometry attributes are controlled by
2577bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // setGeometryAppliesWithResize, and their default mode is to be
2587bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // immediate. If setGeometryAppliesWithResize is specified
2597bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // while a resize is pending, then update of these attributes will
2607bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // be delayed until the resize completes.
2618d5227b8416b099c884429312daf2d60496fa484Robert Carr
2627bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // setPosition operates in parent buffer space (pre parent-transform) or display
2637bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // space for top-level layers.
26482364e3cea0bf88fa8147766433329b3dd5148b8Robert Carr    bool setPosition(float x, float y, bool immediate);
2657bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // Buffer space
2668d5227b8416b099c884429312daf2d60496fa484Robert Carr    bool setCrop(const Rect& crop, bool immediate);
2677bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // Parent buffer space/display space
2688d5227b8416b099c884429312daf2d60496fa484Robert Carr    bool setFinalCrop(const Rect& crop, bool immediate);
2698d5227b8416b099c884429312daf2d60496fa484Robert Carr
2707bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // TODO(b/38182121): Could we eliminate the various latching modes by
2717bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // using the layer hierarchy?
2727bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    // -----------------------------------------------------------------------
273ae0608381b2b4699218febd6d45ad9d307544d55Robert Carr    bool setLayer(int32_t z);
274db66e627ad8904491e384c64f82fc77a939b9705Robert Carr    bool setRelativeLayer(const sp<IBinder>& relativeToHandle, int32_t relativeZ);
275db66e627ad8904491e384c64f82fc77a939b9705Robert Carr
2769e56aa0fdb5f7121b9b975c6c16db103ea4d2fe9Dan Stoza    bool setAlpha(float alpha);
27713fdc49516d17f41e64e62e73c313b0928bf13ccchaviw    bool setColor(const half3& color);
27813127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    bool setTransparentRegionHint(const Region& transparent);
27913127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    bool setFlags(uint8_t flags, uint8_t mask);
28013127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    bool setLayerStack(uint32_t layerStack);
281bb09b436fa119ad8b97f1bf5c04cc5aa10b5f1f0Courtney Goeltzenleuchter    bool setDataSpace(android_dataspace dataSpace);
282532b26380fd6d32dc5d7605bd766a2c4f00d0a80Courtney Goeltzenleuchter    android_dataspace getDataSpace() const;
2831f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr    uint32_t getLayerStack() const;
2840d48072f6047140119ff194c1194ce402fca2c0bRobert Carr    void deferTransactionUntil(const sp<IBinder>& barrierHandle, uint64_t frameNumber);
2850d48072f6047140119ff194c1194ce402fca2c0bRobert Carr    void deferTransactionUntil(const sp<Layer>& barrierLayer, uint64_t frameNumber);
286c3574f7b0141c69fdca25ccafb80ff334462f9a3Robert Carr    bool setOverrideScalingMode(int32_t overrideScalingMode);
2872f5f8a51f5994cf14837030d4b3b252a9d1b950bDaniel Nicoara    void setInfo(uint32_t type, uint32_t appId);
2881db73f66624e7d151710483dd58e03eed672f064Robert Carr    bool reparentChildren(const sp<IBinder>& layer);
289f1961f713de2b3f54c8ce7653964b969e1a02bc8chaviw    bool reparent(const sp<IBinder>& newParentHandle);
2909524cb3b37a91b5741790c77ff24fd825b02bca7Robert Carr    bool detachChildren();
29113127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
292ee44edd0acccbf5eaa918d75737c3b65ee04fff7Dan Stoza    // If we have received a new buffer this frame, we will pass its surface
293ee44edd0acccbf5eaa918d75737c3b65ee04fff7Dan Stoza    // damage down to hardware composer. Otherwise, we must send a region with
294ee44edd0acccbf5eaa918d75737c3b65ee04fff7Dan Stoza    // one empty rect.
295eb085e0c579f310e2670204b14b742b68c70bc9eDavid Sodman    virtual void useSurfaceDamage() = 0;
296eb085e0c579f310e2670204b14b742b68c70bc9eDavid Sodman    virtual void useEmptyDamage() = 0;
297ee44edd0acccbf5eaa918d75737c3b65ee04fff7Dan Stoza
29813127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    uint32_t getTransactionFlags(uint32_t flags);
29913127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    uint32_t setTransactionFlags(uint32_t flags);
30013127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
301ab0c319824632c463ea624cee6f0bc3c8cd8a779Chia-I Wu    bool belongsToDisplay(uint32_t layerStack, bool isPrimaryDisplay) const {
302ab0c319824632c463ea624cee6f0bc3c8cd8a779Chia-I Wu        return getLayerStack() == layerStack && (!mPrimaryDisplayOnly || isPrimaryDisplay);
303ab0c319824632c463ea624cee6f0bc3c8cd8a779Chia-I Wu    }
304ab0c319824632c463ea624cee6f0bc3c8cd8a779Chia-I Wu
305a76b271f0e14325fa0ebb98e1cac0a15adfea1cbchaviw    void computeGeometry(const RenderArea& renderArea, Mesh& mesh, bool useIdentityTransform) const;
3066c925ede620f4080227bb1fe8a41e4b4502348f8Michael Lentine    Rect computeBounds(const Region& activeTransparentRegion) const;
30713127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    Rect computeBounds() const;
30813127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
30940845df1285b387bcbf8f43ac72228eee2606d80Pablo Ceballos    int32_t getSequence() const { return sequence; }
31040845df1285b387bcbf8f43ac72228eee2606d80Pablo Ceballos
3114d9b822e2c18142e55fe2611aa6cd7dc7d4a62c6Mathias Agopian    // -----------------------------------------------------------------------
3121eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian    // Virtuals
3130c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman    virtual const char* getTypeId() const = 0;
31413127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
3151eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian    /*
3161eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian     * isOpaque - true if this surface is opaque
3174125a4ffaf374ca9c0773f256998557d3325343eAndy McFadden     *
3184125a4ffaf374ca9c0773f256998557d3325343eAndy McFadden     * This takes into account the buffer format (i.e. whether or not the
3194125a4ffaf374ca9c0773f256998557d3325343eAndy McFadden     * pixel format includes an alpha channel) and the "opaque" flag set
3204125a4ffaf374ca9c0773f256998557d3325343eAndy McFadden     * on the layer.  It does not examine the current plane alpha value.
3211eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian     */
3220c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman    virtual bool isOpaque(const Layer::State& s) const = 0;
3231eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian
3241eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian    /*
3251eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian     * isSecure - true if this surface is secure, that is if it prevents
3261eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian     * screenshots or VNC servers.
3271eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian     */
3280c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman    bool isSecure() const;
3291eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian
3301eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian    /*
3311eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian     * isVisible - true if this layer is visible, false otherwise
3321eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian     */
3330c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman    virtual bool isVisible() const = 0;
3341eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian
3351eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian    /*
3361f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr     * isHiddenByPolicy - true if this layer has been forced invisible.
3371f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr     * just because this is false, doesn't mean isVisible() is true.
3381f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr     * For example if this layer has no active buffer, it may not be hidden by
3391f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr     * policy, but it still can not be visible.
3401f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr     */
3410c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman    bool isHiddenByPolicy() const;
3421f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr
3431f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr    /*
3441eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian     * isFixedSize - true if content has a fixed size
3451eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian     */
3460c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman    virtual bool isFixedSize() const = 0;
3471eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian
3488b3871addb9bbd5776f4ed59e67af2baa9c583fdchaviw    bool isPendingRemoval() const { return mPendingRemoval; }
3498b3871addb9bbd5776f4ed59e67af2baa9c583fdchaviw
35041fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman    void writeToProto(LayerProto* layerInfo,
35141fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman                      LayerVector::StateSet stateSet = LayerVector::StateSet::Drawing);
3521d04428c3cff3503212ec3e76775ca5ba20abc18chaviw
3531eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopianprotected:
3541eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian    /*
3551eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian     * onDraw - draws the surface.
3561eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian     */
357a76b271f0e14325fa0ebb98e1cac0a15adfea1cbchaviw    virtual void onDraw(const RenderArea& renderArea, const Region& clip,
3580c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman                        bool useIdentityTransform) const = 0;
3591eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian
3601eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopianpublic:
361eb085e0c579f310e2670204b14b742b68c70bc9eDavid Sodman    virtual void setDefaultBufferSize(uint32_t w, uint32_t h) = 0;
362eb085e0c579f310e2670204b14b742b68c70bc9eDavid Sodman
363ae0608381b2b4699218febd6d45ad9d307544d55Robert Carr    void setGeometry(const sp<const DisplayDevice>& displayDevice, uint32_t z);
3649e56aa0fdb5f7121b9b975c6c16db103ea4d2fe9Dan Stoza    void forceClientComposition(int32_t hwcId);
365c9232edd34618360d099272fb0537cae2f715860chaviw    bool getForceClientComposition(int32_t hwcId);
366eb085e0c579f310e2670204b14b742b68c70bc9eDavid Sodman    virtual void setPerFrameData(const sp<const DisplayDevice>& displayDevice) = 0;
3670cc69188196037c06127c0bc56c516069dbaa558David Sodman    void setUpFrameBuffer(const sp<const DisplayDevice>& displayDevice);
3689e56aa0fdb5f7121b9b975c6c16db103ea4d2fe9Dan Stoza
3699e56aa0fdb5f7121b9b975c6c16db103ea4d2fe9Dan Stoza    // callIntoHwc exists so we can update our local state and call
3709e56aa0fdb5f7121b9b975c6c16db103ea4d2fe9Dan Stoza    // acceptDisplayChanges without unnecessarily updating the device's state
3710c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman    void setCompositionType(int32_t hwcId, HWC2::Composition type, bool callIntoHwc = true);
3729e56aa0fdb5f7121b9b975c6c16db103ea4d2fe9Dan Stoza    HWC2::Composition getCompositionType(int32_t hwcId) const;
3739e56aa0fdb5f7121b9b975c6c16db103ea4d2fe9Dan Stoza    void setClearClientTarget(int32_t hwcId, bool clear);
3749e56aa0fdb5f7121b9b975c6c16db103ea4d2fe9Dan Stoza    bool getClearClientTarget(int32_t hwcId) const;
3759e56aa0fdb5f7121b9b975c6c16db103ea4d2fe9Dan Stoza    void updateCursorPosition(const sp<const DisplayDevice>& hw);
37603414a1cfe6c1222fd7723949bd622f9cba145aaRiley Andrews
37713127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    /*
37813127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * called after page-flip
37913127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     */
380eb085e0c579f310e2670204b14b742b68c70bc9eDavid Sodman    virtual void onLayerDisplayed(const sp<Fence>& releaseFence);
38113127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
382eb085e0c579f310e2670204b14b742b68c70bc9eDavid Sodman    virtual void abandon() = 0;
383eb085e0c579f310e2670204b14b742b68c70bc9eDavid Sodman
384eb085e0c579f310e2670204b14b742b68c70bc9eDavid Sodman    virtual bool shouldPresentNow(const DispSync& dispSync) const = 0;
385eb085e0c579f310e2670204b14b742b68c70bc9eDavid Sodman    virtual void setTransformHint(uint32_t orientation) const = 0;
3866b9454d1fee0347711af1746642aa7820b1ea04dDan Stoza
38713127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    /*
38813127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * called before composition.
38913127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * returns true if the layer has pending updates.
39013127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     */
3910c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman    virtual bool onPreComposition(nsecs_t refreshStartTime) = 0;
39213127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
39313127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    /*
394e77c7669bee30b7c0099172cf0c38cef92412040Dan Stoza     * called after composition.
395e77c7669bee30b7c0099172cf0c38cef92412040Dan Stoza     * returns true if the layer latched a new buffer this frame.
39613127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     */
397eb085e0c579f310e2670204b14b742b68c70bc9eDavid Sodman    virtual bool onPostComposition(const std::shared_ptr<FenceTime>& glDoneFence,
398eb085e0c579f310e2670204b14b742b68c70bc9eDavid Sodman                                   const std::shared_ptr<FenceTime>& presentFence,
399eb085e0c579f310e2670204b14b742b68c70bc9eDavid Sodman                                   const CompositorTiming& compositorTiming) = 0;
4004fec873a98f7b4380720cd1ad006f74c8cdc73daMathias Agopian
4019e56aa0fdb5f7121b9b975c6c16db103ea4d2fe9Dan Stoza    // If a buffer was replaced this frame, release the former buffer
4020c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman    virtual void releasePendingBuffer(nsecs_t dequeueReadyTime) = 0;
4039e56aa0fdb5f7121b9b975c6c16db103ea4d2fe9Dan Stoza
40413127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    /*
40513127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * draw - performs some global clipping optimizations
40613127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * and calls onDraw().
40713127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     */
408a76b271f0e14325fa0ebb98e1cac0a15adfea1cbchaviw    void draw(const RenderArea& renderArea, const Region& clip) const;
409a76b271f0e14325fa0ebb98e1cac0a15adfea1cbchaviw    void draw(const RenderArea& renderArea, bool useIdentityTransform) const;
410a76b271f0e14325fa0ebb98e1cac0a15adfea1cbchaviw    void draw(const RenderArea& renderArea) const;
41113127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
41213127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    /*
41313127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * doTransaction - process the transaction. This is a good place to figure
41413127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * out which attributes of the surface have changed.
41513127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     */
4161eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian    uint32_t doTransaction(uint32_t transactionFlags);
41713127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
41813127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    /*
41913127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * setVisibleRegion - called to set the new visible region. This gives
42013127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * a chance to update the new visible region or record the fact it changed.
42113127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     */
4221eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian    void setVisibleRegion(const Region& visibleRegion);
42313127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
42413127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    /*
42513127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * setCoveredRegion - called when the covered region changes. The covered
42613127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * region corresponds to any area of the surface that is covered
42713127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * (transparently or not) by another surface.
42813127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     */
4291eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian    void setCoveredRegion(const Region& coveredRegion);
43013127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
43113127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    /*
43213127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * setVisibleNonTransparentRegion - called when the visible and
43313127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * non-transparent region changes.
43413127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     */
43541fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman    void setVisibleNonTransparentRegion(const Region& visibleNonTransparentRegion);
43613127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
43713127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    /*
43813127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * latchBuffer - called each time the screen is redrawn and returns whether
43913127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * the visible regions need to be recomputed (this is a fairly heavy
44013127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * operation, so this should be set only if needed). Typically this is used
44113127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * to figure out if the content or size of a surface has changed.
44213127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     */
4430c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman    virtual Region latchBuffer(bool& recomputeVisibleRegions, nsecs_t latchTime) = 0;
4440c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman    virtual bool isBufferLatched() const = 0;
44503414a1cfe6c1222fd7723949bd622f9cba145aaRiley Andrews
4460c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman    bool isPotentialCursor() const { return mPotentialCursor; }
44713127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    /*
448c665702cea06c5c42360b7f66fed1693127e6680Chia-I Wu     * called with the state lock from a binder thread when the layer is
449c665702cea06c5c42360b7f66fed1693127e6680Chia-I Wu     * removed from the current list to the pending removal list
450c665702cea06c5c42360b7f66fed1693127e6680Chia-I Wu     */
451c665702cea06c5c42360b7f66fed1693127e6680Chia-I Wu    void onRemovedFromCurrentState();
452c665702cea06c5c42360b7f66fed1693127e6680Chia-I Wu
453c665702cea06c5c42360b7f66fed1693127e6680Chia-I Wu    /*
454c665702cea06c5c42360b7f66fed1693127e6680Chia-I Wu     * called with the state lock from the main thread when the layer is
455c665702cea06c5c42360b7f66fed1693127e6680Chia-I Wu     * removed from the pending removal list
45613127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     */
4571eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian    void onRemoved();
458582270d69db94286a248bd829f1ae6f910d45124Jamie Gennis
459bf974abe92f7495529916fe0f483f3b56e7c30e3Andy McFadden    // Updates the transform hint in our SurfaceFlingerConsumer to match
4608430095879d2fa6878e68f8f12da4e704815ac09Mathias Agopian    // the current orientation of the display device.
4611eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian    void updateTransformHint(const sp<const DisplayDevice>& hw) const;
4626905205c8d130b6ea3a813c1b9283492ed183367Andy McFadden
46313127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    /*
46413127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * returns the rectangle that crops the content of the layer and scales it
46513127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * to the layer's size.
46613127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     */
4671eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian    Rect getContentCrop() const;
46813127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
46951c59cd1e73be3787eb75bebd87fc41739c65adbEric Penner    /*
47051c59cd1e73be3787eb75bebd87fc41739c65adbEric Penner     * Returns if a frame is queued.
47151c59cd1e73be3787eb75bebd87fc41739c65adbEric Penner     */
47241fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman    bool hasQueuedFrame() const {
47341fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman        return mQueuedFrames > 0 || mSidebandStreamChanged || mAutoRefresh;
47441fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman    }
47551c59cd1e73be3787eb75bebd87fc41739c65adbEric Penner
476a099a24c93bfa599fc5c36a647e946c26f68514fKalle Raita    int32_t getQueuedFrameCount() const { return mQueuedFrames; }
477a099a24c93bfa599fc5c36a647e946c26f68514fKalle Raita
4789e56aa0fdb5f7121b9b975c6c16db103ea4d2fe9Dan Stoza    // -----------------------------------------------------------------------
4799e56aa0fdb5f7121b9b975c6c16db103ea4d2fe9Dan Stoza
480b02664ddc146893e6bbe7939ee2b948d54e7166aSteven Thomas    bool createHwcLayer(HWComposer* hwc, int32_t hwcId);
48183806897c6366d841971a38f4a007bb83a7afb64Chia-I Wu    bool destroyHwcLayer(int32_t hwcId);
482b02664ddc146893e6bbe7939ee2b948d54e7166aSteven Thomas    void destroyAllHwcLayers();
483b02664ddc146893e6bbe7939ee2b948d54e7166aSteven Thomas
4846f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman    bool hasHwcLayer(int32_t hwcId) {
4856f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman        return getBE().mHwcLayers.count(hwcId) > 0;
4866f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman    }
4879e56aa0fdb5f7121b9b975c6c16db103ea4d2fe9Dan Stoza
488b02664ddc146893e6bbe7939ee2b948d54e7166aSteven Thomas    HWC2::Layer* getHwcLayer(int32_t hwcId) {
4896f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman        if (getBE().mHwcLayers.count(hwcId) == 0) {
4909e56aa0fdb5f7121b9b975c6c16db103ea4d2fe9Dan Stoza            return nullptr;
4919e56aa0fdb5f7121b9b975c6c16db103ea4d2fe9Dan Stoza        }
4926f65f3e7caab86a76419e7c1d1c787634a0852d8David Sodman        return getBE().mHwcLayers[hwcId].layer;
4939e56aa0fdb5f7121b9b975c6c16db103ea4d2fe9Dan Stoza    }
4949e56aa0fdb5f7121b9b975c6c16db103ea4d2fe9Dan Stoza
49513127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    // -----------------------------------------------------------------------
49613127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
497a76b271f0e14325fa0ebb98e1cac0a15adfea1cbchaviw    void clearWithOpenGL(const RenderArea& renderArea) const;
49813127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    void setFiltering(bool filtering);
49913127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    bool getFiltering() const;
50013127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
50113127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
50241fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman    inline const State& getDrawingState() const { return mDrawingState; }
50341fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman    inline const State& getCurrentState() const { return mCurrentState; }
50441fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman    inline State& getCurrentState() { return mCurrentState; }
50513127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
506a099a24c93bfa599fc5c36a647e946c26f68514fKalle Raita    LayerDebugInfo getLayerDebugInfo() const;
50713127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
50813127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    /* always call base class first */
509e22aec741f1530cde86c38989bcc2f87626b93b0Dan Stoza    static void miniDumpHeader(String8& result);
510e22aec741f1530cde86c38989bcc2f87626b93b0Dan Stoza    void miniDump(String8& result, int32_t hwcId) const;
511d85084b2b65828442eafaff9b811e9b6c9ca9fadSvetoslav    void dumpFrameStats(String8& result) const;
512d6927fb1143398370c0885844bfb58923ef740b7Brian Anderson    void dumpFrameEvents(String8& result);
513d85084b2b65828442eafaff9b811e9b6c9ca9fadSvetoslav    void clearFrameStats();
5146547ff4327aa320fbc9635668d3fc66db7dd78f6Jamie Gennis    void logFrameStats();
515d85084b2b65828442eafaff9b811e9b6c9ca9fadSvetoslav    void getFrameStats(FrameStats* outStats) const;
5161b5e1021b8c9b87113b70d94dfb7b50f8c5b01b8Mathias Agopian
517eb085e0c579f310e2670204b14b742b68c70bc9eDavid Sodman    virtual std::vector<OccupancyTracker::Segment> getOccupancyHistory(bool forceFlush) = 0;
518e77c7669bee30b7c0099172cf0c38cef92412040Dan Stoza
5195ea5e5905170f32d5cf45ad35c552d64743892c3Brian Anderson    void onDisconnect();
5203890c3995c4a52439844faeb80b5503d42b977d8Brian Anderson    void addAndGetFrameTimestamps(const NewFrameEventsEntry* newEntry,
52141fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman                                  FrameEventHistoryDelta* outDelta);
522ce796e78a57018f186b062199c75d94545318acaPablo Ceballos
523eb085e0c579f310e2670204b14b742b68c70bc9eDavid Sodman    virtual bool getTransformToDisplayInverse() const = 0;
524367c5684f4d417e5176bec12d67f4e2e42738fe0Robert Carr
5251f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr    Transform getTransform() const;
5261f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr
5276452f12c95e855a96ab8f690f28914cd37de762bRobert Carr    // Returns the Alpha of the Surface, accounting for the Alpha
5286452f12c95e855a96ab8f690f28914cd37de762bRobert Carr    // of parent Surfaces in the hierarchy (alpha's will be multiplied
5296452f12c95e855a96ab8f690f28914cd37de762bRobert Carr    // down the hierarchy).
53013fdc49516d17f41e64e62e73c313b0928bf13ccchaviw    half getAlpha() const;
53113fdc49516d17f41e64e62e73c313b0928bf13ccchaviw    half4 getColor() const;
5326452f12c95e855a96ab8f690f28914cd37de762bRobert Carr
533412903fce3a93f411c85c54375a1851bfb370400Dan Stoza    void traverseInReverseZOrder(LayerVector::StateSet stateSet,
534412903fce3a93f411c85c54375a1851bfb370400Dan Stoza                                 const LayerVector::Visitor& visitor);
535412903fce3a93f411c85c54375a1851bfb370400Dan Stoza    void traverseInZOrder(LayerVector::StateSet stateSet, const LayerVector::Visitor& visitor);
5361f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr
537a76b271f0e14325fa0ebb98e1cac0a15adfea1cbchaviw    void traverseChildrenInZOrder(LayerVector::StateSet stateSet,
538a76b271f0e14325fa0ebb98e1cac0a15adfea1cbchaviw                                  const LayerVector::Visitor& visitor);
539a76b271f0e14325fa0ebb98e1cac0a15adfea1cbchaviw
54098f1c108b016dda77c808f3d099e7a45bdd70768Chia-I Wu    size_t getChildrenCount() const;
5411f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr    void addChild(const sp<Layer>& layer);
5421f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr    // Returns index if removed, or negative value otherwise
5431f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr    // for symmetry with Vector::remove
5441f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr    ssize_t removeChild(const sp<Layer>& layer);
545e41dbe6ab1d412efd67fdc8344be8da8b19426d2Chia-I Wu    sp<Layer> getParent() const { return mCurrentParent.promote(); }
5461f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr    bool hasParent() const { return getParent() != nullptr; }
5471f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr    Rect computeScreenBounds(bool reduceTransparentRegion = true) const;
5481f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr    bool setChildLayer(const sp<Layer>& childLayer, int32_t z);
549503c7046237f2797a5cf8584064223359d0e6d10Robert Carr    bool setChildRelativeLayer(const sp<Layer>& childLayer,
550503c7046237f2797a5cf8584064223359d0e6d10Robert Carr            const sp<IBinder>& relativeToHandle, int32_t relativeZ);
5511f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr
5521f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr    // Copy the current list of children to the drawing state. Called by
5531f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr    // SurfaceFlinger to complete a transaction.
5541f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr    void commitChildList();
5551f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr    int32_t getZ() const;
55641fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman
55713127d8921356dff794250e04208c3ed60b3a3dfMathias Agopianprotected:
55813127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    // constant
55913127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    sp<SurfaceFlinger> mFlinger;
56013127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    /*
56113127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * Trivial class, used to ensure that mFlinger->onLayerDestroyed(mLayer)
56213127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     * is called.
56313127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian     */
56413127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    class LayerCleaner {
56513127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian        sp<SurfaceFlinger> mFlinger;
56613127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian        wp<Layer> mLayer;
56741fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman
56813127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    protected:
569468051e20be19130572231266db306396a56402bIrvel        ~LayerCleaner() {
570468051e20be19130572231266db306396a56402bIrvel            // destroy client resources
571468051e20be19130572231266db306396a56402bIrvel            mFlinger->onLayerDestroyed(mLayer);
572468051e20be19130572231266db306396a56402bIrvel        }
57341fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman
57413127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    public:
57541fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman        LayerCleaner(const sp<SurfaceFlinger>& flinger, const sp<Layer>& layer)
57641fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman              : mFlinger(flinger), mLayer(layer) {}
57713127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    };
57813127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
579468051e20be19130572231266db306396a56402bIrvel    virtual void onFirstRef();
580468051e20be19130572231266db306396a56402bIrvel
581468051e20be19130572231266db306396a56402bIrvel    friend class SurfaceInterceptor;
582eb085e0c579f310e2670204b14b742b68c70bc9eDavid Sodman
58305289c2b78d21308a95ea6ef8f1d8f24359147cdPablo Ceballos    void commitTransaction(const State& stateToCommit);
5841eae0ee49402c39f1b08cc8fec129023f86494b7Mathias Agopian
5853330b203039dea366d4981db1408a460134b2d2cMathias Agopian    uint32_t getEffectiveUsage(uint32_t usage) const;
5861f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr
5875a423eaa86f4c990afcef8c55e3949d0872068b4Dan Stoza    FloatRect computeCrop(const sp<const DisplayDevice>& hw) const;
5880c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman    // Compute the initial crop as specified by parent layers and the
5890c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman    // SurfaceControl for this layer. Does not include buffer crop from the
5900c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman    // IGraphicBufferProducer client, as that should not affect child clipping.
5910c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman    // Returns in screen space.
5921f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr    Rect computeInitialCrop(const sp<const DisplayDevice>& hw) const;
593b7e930db175c192464cebdeb49eb56cf6dd60114Mathias Agopian
59413127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    // drawing
59541fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman    void clearWithOpenGL(const RenderArea& renderArea, float r, float g, float b,
59641fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman                         float alpha) const;
597c5da271eec001da9e11a2786f2618a45257439c3Dan Stoza
5981f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr    void setParent(const sp<Layer>& layer);
5991f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr
60029abff83bb6e148961c2319add7bd72eb76af3d4Robert Carr    LayerVector makeTraversalList(LayerVector::StateSet stateSet, bool* outSkipRelativeZUsers);
601db66e627ad8904491e384c64f82fc77a939b9705Robert Carr    void addZOrderRelative(const wp<Layer>& relative);
602db66e627ad8904491e384c64f82fc77a939b9705Robert Carr    void removeZOrderRelative(const wp<Layer>& relative);
603db66e627ad8904491e384c64f82fc77a939b9705Robert Carr
60441fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman    class SyncPoint {
6057dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza    public:
60641fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman        explicit SyncPoint(uint64_t frameNumber)
60741fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman              : mFrameNumber(frameNumber), mFrameIsAvailable(false), mTransactionIsApplied(false) {}
6087dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza
60941fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman        uint64_t getFrameNumber() const { return mFrameNumber; }
6107dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza
61141fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman        bool frameIsAvailable() const { return mFrameIsAvailable; }
6127dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza
61341fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman        void setFrameAvailable() { mFrameIsAvailable = true; }
6147dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza
61541fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman        bool transactionIsApplied() const { return mTransactionIsApplied; }
6167dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza
61741fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman        void setTransactionApplied() { mTransactionIsApplied = true; }
6187dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza
6197dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza    private:
6207dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza        const uint64_t mFrameNumber;
6217dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza        std::atomic<bool> mFrameIsAvailable;
6227dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza        std::atomic<bool> mTransactionIsApplied;
6237dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza    };
6247dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza
625cac353808ec1048333d7fd2f3d596fb4db567aa3Dan Stoza    // SyncPoints which will be signaled when the correct frame is at the head
626cac353808ec1048333d7fd2f3d596fb4db567aa3Dan Stoza    // of the queue and dropped after the frame has been latched. Protected by
627cac353808ec1048333d7fd2f3d596fb4db567aa3Dan Stoza    // mLocalSyncPointMutex.
628cac353808ec1048333d7fd2f3d596fb4db567aa3Dan Stoza    Mutex mLocalSyncPointMutex;
6297dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza    std::list<std::shared_ptr<SyncPoint>> mLocalSyncPoints;
6307dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza
631cac353808ec1048333d7fd2f3d596fb4db567aa3Dan Stoza    // SyncPoints which will be signaled and then dropped when the transaction
632cac353808ec1048333d7fd2f3d596fb4db567aa3Dan Stoza    // is applied
6337dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza    std::list<std::shared_ptr<SyncPoint>> mRemoteSyncPoints;
6347dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza
635cac353808ec1048333d7fd2f3d596fb4db567aa3Dan Stoza    // Returns false if the relevant frame has already been latched
636cac353808ec1048333d7fd2f3d596fb4db567aa3Dan Stoza    bool addSyncPoint(const std::shared_ptr<SyncPoint>& point);
6377dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza
6387dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza    void pushPendingState();
63905289c2b78d21308a95ea6ef8f1d8f24359147cdPablo Ceballos    void popPendingState(State* stateToCommit);
64005289c2b78d21308a95ea6ef8f1d8f24359147cdPablo Ceballos    bool applyPendingStates(State* stateToCommit);
641c3574f7b0141c69fdca25ccafb80ff334462f9a3Robert Carr
6421f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr    void clearSyncPoints();
6431f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr
644c3574f7b0141c69fdca25ccafb80ff334462f9a3Robert Carr    // Returns mCurrentScaling mode (originating from the
645c3574f7b0141c69fdca25ccafb80ff334462f9a3Robert Carr    // Client) or mOverrideScalingMode mode (originating from
646c3574f7b0141c69fdca25ccafb80ff334462f9a3Robert Carr    // the Surface Controller) if set.
6470c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman    virtual uint32_t getEffectiveScalingMode() const = 0;
64841fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman
6497dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stozapublic:
650468051e20be19130572231266db306396a56402bIrvel    /*
651468051e20be19130572231266db306396a56402bIrvel     * The layer handle is just a BBinder object passed to the client
652468051e20be19130572231266db306396a56402bIrvel     * (remote process) -- we don't keep any reference on our side such that
653468051e20be19130572231266db306396a56402bIrvel     * the dtor is called when the remote side let go of its reference.
654468051e20be19130572231266db306396a56402bIrvel     *
655468051e20be19130572231266db306396a56402bIrvel     * LayerCleaner ensures that mFlinger->onLayerDestroyed() is called for
656468051e20be19130572231266db306396a56402bIrvel     * this layer when the handle is destroyed.
657468051e20be19130572231266db306396a56402bIrvel     */
658468051e20be19130572231266db306396a56402bIrvel    class Handle : public BBinder, public LayerCleaner {
65941fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman    public:
66041fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman        Handle(const sp<SurfaceFlinger>& flinger, const sp<Layer>& layer)
66141fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman              : LayerCleaner(flinger, layer), owner(layer) {}
662468051e20be19130572231266db306396a56402bIrvel
66341fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman        wp<Layer> owner;
664468051e20be19130572231266db306396a56402bIrvel    };
665468051e20be19130572231266db306396a56402bIrvel
666468051e20be19130572231266db306396a56402bIrvel    sp<IBinder> getHandle();
667468051e20be19130572231266db306396a56402bIrvel    const String8& getName() const;
6680c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman    virtual void notifyAvailableFrames() = 0;
6690c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman    virtual PixelFormat getPixelFormat() const = 0;
67013fdc49516d17f41e64e62e73c313b0928bf13ccchaviw    bool getPremultipledAlpha() const;
671a4a3149a36bc69a06e4824aeae909ab910661070Igor Murashkin
67241fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodmanprotected:
673b7e930db175c192464cebdeb49eb56cf6dd60114Mathias Agopian    // -----------------------------------------------------------------------
67429abff83bb6e148961c2319add7bd72eb76af3d4Robert Carr    bool usingRelativeZ(LayerVector::StateSet stateSet);
675b7e930db175c192464cebdeb49eb56cf6dd60114Mathias Agopian
67613127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    bool mPremultipliedAlpha;
67713127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    String8 mName;
67841fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman    String8 mTransactionName; // A cached version of "TX - " + mName for systraces
67913127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
680ab0c319824632c463ea624cee6f0bc3c8cd8a779Chia-I Wu    bool mPrimaryDisplayOnly = false;
681ab0c319824632c463ea624cee6f0bc3c8cd8a779Chia-I Wu
68213127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    // these are protected by an external lock
68313127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    State mCurrentState;
68413127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    State mDrawingState;
68513127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    volatile int32_t mTransactionFlags;
686b7e930db175c192464cebdeb49eb56cf6dd60114Mathias Agopian
6877dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza    // Accessed from main thread and binder threads
6887dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza    Mutex mPendingStateMutex;
6897dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza    Vector<State> mPendingStates;
6907dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza
691b7e930db175c192464cebdeb49eb56cf6dd60114Mathias Agopian    // thread-safe
692a67932fe6864ac346e7f78b86df11cf6c5344137Mathias Agopian    volatile int32_t mQueuedFrames;
69341fdfc920e2a479add53a1936c3ae76cdbea41dbDavid Sodman    volatile int32_t mSidebandStreamChanged; // used like an atomic boolean
694d6927fb1143398370c0885844bfb58923ef740b7Brian Anderson
695d6927fb1143398370c0885844bfb58923ef740b7Brian Anderson    // Timestamp history for UIAutomation. Thread safe.
6964b0eba949cc026ffb2c75313042d8a7bcb3fcf86Jamie Gennis    FrameTracker mFrameTracker;
697a67932fe6864ac346e7f78b86df11cf6c5344137Mathias Agopian
698d6927fb1143398370c0885844bfb58923ef740b7Brian Anderson    // Timestamp history for the consumer to query.
699d6927fb1143398370c0885844bfb58923ef740b7Brian Anderson    // Accessed by both consumer and producer on main and binder threads.
700d6927fb1143398370c0885844bfb58923ef740b7Brian Anderson    Mutex mFrameEventHistoryMutex;
7013890c3995c4a52439844faeb80b5503d42b977d8Brian Anderson    ConsumerFrameEventHistory mFrameEventHistory;
7023d4039d7a291cd9b6f2dd4b46fcdb576f2db3356Brian Anderson    FenceTimeline mAcquireTimeline;
7033d4039d7a291cd9b6f2dd4b46fcdb576f2db3356Brian Anderson    FenceTimeline mReleaseTimeline;
704d6927fb1143398370c0885844bfb58923ef740b7Brian Anderson
705a67932fe6864ac346e7f78b86df11cf6c5344137Mathias Agopian    // main thread
706a9347647eca3101c014be902b713772de3977d87Mathias Agopian    int mActiveBufferSlot;
707a67932fe6864ac346e7f78b86df11cf6c5344137Mathias Agopian    sp<GraphicBuffer> mActiveBuffer;
708399184a4cd728ea1421fb0bc1722274a29e38f4aJesse Hall    sp<NativeHandle> mSidebandStream;
709a67932fe6864ac346e7f78b86df11cf6c5344137Mathias Agopian    Rect mCurrentCrop;
710a67932fe6864ac346e7f78b86df11cf6c5344137Mathias Agopian    uint32_t mCurrentTransform;
711c3574f7b0141c69fdca25ccafb80ff334462f9a3Robert Carr    // We encode unset as -1.
712c3574f7b0141c69fdca25ccafb80ff334462f9a3Robert Carr    int32_t mOverrideScalingMode;
713a67932fe6864ac346e7f78b86df11cf6c5344137Mathias Agopian    bool mCurrentOpacity;
714cac353808ec1048333d7fd2f3d596fb4db567aa3Dan Stoza    std::atomic<uint64_t> mCurrentFrameNumber;
715e8696a40e09b24b634214684d18526187b316a2fJamie Gennis    bool mFrameLatencyNeeded;
71613127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    // Whether filtering is forced on or not
71713127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    bool mFiltering;
71813127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    // Whether filtering is needed b/c of the drawingstate
71913127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    bool mNeedsFiltering;
7200c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman
7218b3871addb9bbd5776f4ed59e67af2baa9c583fdchaviw    bool mPendingRemoval = false;
7228b3871addb9bbd5776f4ed59e67af2baa9c583fdchaviw
723b7e930db175c192464cebdeb49eb56cf6dd60114Mathias Agopian    // page-flip thread (currently main thread)
72416f0453fee84c6aad59fe0d1c7d36f061d46cffcGlenn Kasten    bool mProtectedByApp; // application requires protected path to external sink
72513127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian
72613127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    // protected by mLock
72713127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    mutable Mutex mLock;
7280c69cad13dda09f1df1dbf23810b1c5b7f28ba08David Sodman
72913127d8921356dff794250e04208c3ed60b3a3dfMathias Agopian    const wp<Client> mClientRef;
73003414a1cfe6c1222fd7723949bd622f9cba145aaRiley Andrews
73103414a1cfe6c1222fd7723949bd622f9cba145aaRiley Andrews    // This layer can be a cursor on some displays.
73203414a1cfe6c1222fd7723949bd622f9cba145aaRiley Andrews    bool mPotentialCursor;
7336b9454d1fee0347711af1746642aa7820b1ea04dDan Stoza
7346b9454d1fee0347711af1746642aa7820b1ea04dDan Stoza    // Local copy of the queued contents of the incoming BufferQueue
7356b9454d1fee0347711af1746642aa7820b1ea04dDan Stoza    mutable Mutex mQueueItemLock;
736a4650a50a0b35e9e4342d6600b6eb24fd94bb8e5Dan Stoza    Condition mQueueItemCondition;
7376b9454d1fee0347711af1746642aa7820b1ea04dDan Stoza    Vector<BufferItem> mQueueItems;
738cac353808ec1048333d7fd2f3d596fb4db567aa3Dan Stoza    std::atomic<uint64_t> mLastFrameNumberReceived;
739ff95aabbcc6e8606acbd7933c90eeb9b8b382a21Pablo Ceballos    bool mAutoRefresh;
7407bf247e2db180da661b18084d50e0b389686fc0cRobert Carr    bool mFreezeGeometryUpdates;
7411f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr
7421f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr    // Child list about to be committed/used for editing.
7431f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr    LayerVector mCurrentChildren;
7441f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr    // Child list used for rendering.
7451f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr    LayerVector mDrawingChildren;
7461f0a16a5d7cd00ba7fda82e7d315afa1fd1303b9Robert Carr
747e41dbe6ab1d412efd67fdc8344be8da8b19426d2Chia-I Wu    wp<Layer> mCurrentParent;
748e41dbe6ab1d412efd67fdc8344be8da8b19426d2Chia-I Wu    wp<Layer> mDrawingParent;
7499eeae69005ef9a774bde19195b9c06eba7e463c2David Sodman
7509eeae69005ef9a774bde19195b9c06eba7e463c2David Sodman    mutable LayerBE mBE;
751edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project};
752edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project
753edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// ---------------------------------------------------------------------------
754edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project
755edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project}; // namespace android
756edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project
757edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#endif // ANDROID_LAYER_H
758