Layer.h revision a3ed032256c475ce13c52b0261da6a5e2ffa77be 
1/*
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
23#include <EGL/egl.h>
24#include <EGL/eglext.h>
25
26#include <utils/RefBase.h>
27#include <utils/String8.h>
28#include <utils/Timers.h>
29
30#include <ui/FrameStats.h>
31#include <ui/GraphicBuffer.h>
32#include <ui/PixelFormat.h>
33#include <ui/Region.h>
34
35#include <gui/ISurfaceComposerClient.h>
36
37#include <private/gui/LayerState.h>
38
39#include <list>
40
41#include "FrameTracker.h"
42#include "Client.h"
43#include "LayerVector.h"
44#include "MonitoredProducer.h"
45#include "SurfaceFlinger.h"
46#include "SurfaceFlingerConsumer.h"
47#include "Transform.h"
48
49#include "DisplayHardware/HWComposer.h"
50#include "DisplayHardware/HWComposerBufferCache.h"
51#include "RenderEngine/Mesh.h"
52#include "RenderEngine/Texture.h"
53
54namespace android {
55
56// ---------------------------------------------------------------------------
57
58class Client;
59class Colorizer;
60class DisplayDevice;
61class GraphicBuffer;
62class SurfaceFlinger;
63
64// ---------------------------------------------------------------------------
65
66/*
67 * A new BufferQueue and a new SurfaceFlingerConsumer are created when the
68 * Layer is first referenced.
69 *
70 * This also implements onFrameAvailable(), which notifies SurfaceFlinger
71 * that new data has arrived.
72 */
73class Layer : public SurfaceFlingerConsumer::ContentsChangedListener {
74    static int32_t sSequence;
75
76public:
77    mutable bool contentDirty;
78    // regions below are in window-manager space
79    Region visibleRegion;
80    Region coveredRegion;
81    Region visibleNonTransparentRegion;
82    Region surfaceDamageRegion;
83
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.
87    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;
97        Transform transform;
98
99        inline bool operator ==(const Geometry& rhs) const {
100            return (w == rhs.w && h == rhs.h) &&
101                    (transform.tx() == rhs.transform.tx()) &&
102                    (transform.ty() == rhs.transform.ty());
103        }
104        inline bool operator !=(const Geometry& rhs) const {
105            return !operator ==(rhs);
106        }
107    };
108
109    struct State {
110        Geometry active;
111        Geometry requested;
112        int32_t z;
113
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.
119        uint32_t layerStack;
120
121#ifdef USE_HWC2
122        float alpha;
123#else
124        uint8_t alpha;
125#endif
126        uint8_t flags;
127        uint8_t mask;
128        uint8_t reserved[2];
129        int32_t sequence; // changes when visible regions can change
130        bool modified;
131
132        // Crop is expressed in layer space coordinate.
133        Rect crop;
134        Rect requestedCrop;
135
136        // finalCrop is expressed in display space coordinate.
137        Rect finalCrop;
138        Rect requestedFinalCrop;
139
140        // If set, defers this state update until the identified Layer
141        // receives a frame with the given frameNumber
142        wp<Layer> barrierLayer;
143        uint64_t frameNumber;
144
145        // the transparentRegion hint is a bit special, it's latched only
146        // when we receive a buffer -- this is because it's "content"
147        // dependent.
148        Region activeTransparentRegion;
149        Region requestedTransparentRegion;
150        android_dataspace dataSpace;
151
152        uint32_t appId;
153        uint32_t type;
154
155        // If non-null, a Surface this Surface's Z-order is interpreted relative to.
156        wp<Layer> zOrderRelativeOf;
157
158        // A list of surfaces whose Z-order is interpreted relative to ours.
159        SortedVector<wp<Layer>> zOrderRelatives;
160    };
161
162    // -----------------------------------------------------------------------
163
164    Layer(SurfaceFlinger* flinger, const sp<Client>& client,
165            const String8& name, uint32_t w, uint32_t h, uint32_t flags);
166
167    virtual ~Layer();
168
169    // the this layer's size and format
170    status_t setBuffers(uint32_t w, uint32_t h, PixelFormat format, uint32_t flags);
171
172    // modify current state
173
174    // These members of state (position, crop, and finalCrop)
175    // may be updated immediately or have the update delayed
176    // until a pending surface resize completes (if applicable).
177    bool setPosition(float x, float y, bool immediate);
178    bool setCrop(const Rect& crop, bool immediate);
179    bool setFinalCrop(const Rect& crop, bool immediate);
180
181    bool setLayer(int32_t z);
182    bool setRelativeLayer(const sp<IBinder>& relativeToHandle, int32_t relativeZ);
183
184    bool setSize(uint32_t w, uint32_t h);
185#ifdef USE_HWC2
186    bool setAlpha(float alpha);
187#else
188    bool setAlpha(uint8_t alpha);
189#endif
190    bool setMatrix(const layer_state_t::matrix22_t& matrix);
191    bool setTransparentRegionHint(const Region& transparent);
192    bool setFlags(uint8_t flags, uint8_t mask);
193    bool setLayerStack(uint32_t layerStack);
194    bool setDataSpace(android_dataspace dataSpace);
195    uint32_t getLayerStack() const;
196    void deferTransactionUntil(const sp<IBinder>& barrierHandle, uint64_t frameNumber);
197    void deferTransactionUntil(const sp<Layer>& barrierLayer, uint64_t frameNumber);
198    bool setOverrideScalingMode(int32_t overrideScalingMode);
199    void setInfo(uint32_t type, uint32_t appId);
200    bool reparentChildren(const sp<IBinder>& layer);
201    bool detachChildren();
202
203    // If we have received a new buffer this frame, we will pass its surface
204    // damage down to hardware composer. Otherwise, we must send a region with
205    // one empty rect.
206    void useSurfaceDamage();
207    void useEmptyDamage();
208
209    uint32_t getTransactionFlags(uint32_t flags);
210    uint32_t setTransactionFlags(uint32_t flags);
211
212    void computeGeometry(const sp<const DisplayDevice>& hw, Mesh& mesh,
213            bool useIdentityTransform) const;
214    Rect computeBounds(const Region& activeTransparentRegion) const;
215    Rect computeBounds() const;
216
217    int32_t getSequence() const { return sequence; }
218
219    // -----------------------------------------------------------------------
220    // Virtuals
221
222    virtual const char* getTypeId() const { return "Layer"; }
223
224    /*
225     * isOpaque - true if this surface is opaque
226     *
227     * This takes into account the buffer format (i.e. whether or not the
228     * pixel format includes an alpha channel) and the "opaque" flag set
229     * on the layer.  It does not examine the current plane alpha value.
230     */
231    virtual bool isOpaque(const Layer::State& s) const;
232
233    /*
234     * isSecure - true if this surface is secure, that is if it prevents
235     * screenshots or VNC servers.
236     */
237    virtual bool isSecure() const;
238
239    /*
240     * isProtected - true if the layer may contain protected content in the
241     * GRALLOC_USAGE_PROTECTED sense.
242     */
243    virtual bool isProtected() const;
244
245    /*
246     * isVisible - true if this layer is visible, false otherwise
247     */
248    virtual bool isVisible() const;
249
250    /*
251     * isHiddenByPolicy - true if this layer has been forced invisible.
252     * just because this is false, doesn't mean isVisible() is true.
253     * For example if this layer has no active buffer, it may not be hidden by
254     * policy, but it still can not be visible.
255     */
256    virtual bool isHiddenByPolicy() const;
257
258    /*
259     * isFixedSize - true if content has a fixed size
260     */
261    virtual bool isFixedSize() const;
262
263protected:
264    /*
265     * onDraw - draws the surface.
266     */
267    virtual void onDraw(const sp<const DisplayDevice>& hw, const Region& clip,
268            bool useIdentityTransform) const;
269
270public:
271    // -----------------------------------------------------------------------
272
273#ifdef USE_HWC2
274    void setGeometry(const sp<const DisplayDevice>& displayDevice, uint32_t z);
275    void forceClientComposition(int32_t hwcId);
276    void setPerFrameData(const sp<const DisplayDevice>& displayDevice);
277
278    android_dataspace getDataSpace() const;
279
280    // callIntoHwc exists so we can update our local state and call
281    // acceptDisplayChanges without unnecessarily updating the device's state
282    void setCompositionType(int32_t hwcId, HWC2::Composition type,
283            bool callIntoHwc = true);
284    HWC2::Composition getCompositionType(int32_t hwcId) const;
285
286    void setClearClientTarget(int32_t hwcId, bool clear);
287    bool getClearClientTarget(int32_t hwcId) const;
288
289    void updateCursorPosition(const sp<const DisplayDevice>& hw);
290#else
291    void setGeometry(const sp<const DisplayDevice>& hw,
292            HWComposer::HWCLayerInterface& layer);
293    void setPerFrameData(const sp<const DisplayDevice>& hw,
294            HWComposer::HWCLayerInterface& layer);
295    void setAcquireFence(const sp<const DisplayDevice>& hw,
296            HWComposer::HWCLayerInterface& layer);
297
298    Rect getPosition(const sp<const DisplayDevice>& hw);
299#endif
300
301    /*
302     * called after page-flip
303     */
304#ifdef USE_HWC2
305    void onLayerDisplayed(const sp<Fence>& releaseFence);
306#else
307    void onLayerDisplayed(const sp<const DisplayDevice>& hw,
308            HWComposer::HWCLayerInterface* layer);
309#endif
310
311    bool shouldPresentNow(const DispSync& dispSync) const;
312
313    /*
314     * called before composition.
315     * returns true if the layer has pending updates.
316     */
317    bool onPreComposition(nsecs_t refreshStartTime);
318
319    /*
320     * called after composition.
321     * returns true if the layer latched a new buffer this frame.
322     */
323    bool onPostComposition(const std::shared_ptr<FenceTime>& glDoneFence,
324            const std::shared_ptr<FenceTime>& presentFence,
325            const CompositorTiming& compositorTiming);
326
327#ifdef USE_HWC2
328    // If a buffer was replaced this frame, release the former buffer
329    void releasePendingBuffer(nsecs_t dequeueReadyTime);
330#endif
331
332    /*
333     * draw - performs some global clipping optimizations
334     * and calls onDraw().
335     */
336    void draw(const sp<const DisplayDevice>& hw, const Region& clip) const;
337    void draw(const sp<const DisplayDevice>& hw, bool useIdentityTransform) const;
338    void draw(const sp<const DisplayDevice>& hw) const;
339
340    /*
341     * doTransaction - process the transaction. This is a good place to figure
342     * out which attributes of the surface have changed.
343     */
344    uint32_t doTransaction(uint32_t transactionFlags);
345
346    /*
347     * setVisibleRegion - called to set the new visible region. This gives
348     * a chance to update the new visible region or record the fact it changed.
349     */
350    void setVisibleRegion(const Region& visibleRegion);
351
352    /*
353     * setCoveredRegion - called when the covered region changes. The covered
354     * region corresponds to any area of the surface that is covered
355     * (transparently or not) by another surface.
356     */
357    void setCoveredRegion(const Region& coveredRegion);
358
359    /*
360     * setVisibleNonTransparentRegion - called when the visible and
361     * non-transparent region changes.
362     */
363    void setVisibleNonTransparentRegion(const Region&
364            visibleNonTransparentRegion);
365
366    /*
367     * latchBuffer - called each time the screen is redrawn and returns whether
368     * the visible regions need to be recomputed (this is a fairly heavy
369     * operation, so this should be set only if needed). Typically this is used
370     * to figure out if the content or size of a surface has changed.
371     */
372    Region latchBuffer(bool& recomputeVisibleRegions, nsecs_t latchTime);
373
374    bool isPotentialCursor() const { return mPotentialCursor;}
375
376    /*
377     * called with the state lock when the surface is removed from the
378     * current list
379     */
380    void onRemoved();
381
382
383    // Updates the transform hint in our SurfaceFlingerConsumer to match
384    // the current orientation of the display device.
385    void updateTransformHint(const sp<const DisplayDevice>& hw) const;
386
387    /*
388     * returns the rectangle that crops the content of the layer and scales it
389     * to the layer's size.
390     */
391    Rect getContentCrop() const;
392
393    /*
394     * Returns if a frame is queued.
395     */
396    bool hasQueuedFrame() const { return mQueuedFrames > 0 ||
397            mSidebandStreamChanged || mAutoRefresh; }
398
399#ifdef USE_HWC2
400    // -----------------------------------------------------------------------
401
402    bool hasHwcLayer(int32_t hwcId) {
403        if (mHwcLayers.count(hwcId) == 0) {
404            return false;
405        }
406        if (mHwcLayers[hwcId].layer->isAbandoned()) {
407            ALOGI("Erasing abandoned layer %s on %d", mName.string(), hwcId);
408            mHwcLayers.erase(hwcId);
409            return false;
410        }
411        return true;
412    }
413
414    std::shared_ptr<HWC2::Layer> getHwcLayer(int32_t hwcId) {
415        if (mHwcLayers.count(hwcId) == 0) {
416            return nullptr;
417        }
418        return mHwcLayers[hwcId].layer;
419    }
420
421    void setHwcLayer(int32_t hwcId, std::shared_ptr<HWC2::Layer>&& layer) {
422        if (layer) {
423            mHwcLayers[hwcId].layer = layer;
424        } else {
425            mHwcLayers.erase(hwcId);
426        }
427    }
428
429    void clearHwcLayers() {
430        mHwcLayers.clear();
431    }
432
433#endif
434    // -----------------------------------------------------------------------
435
436    void clearWithOpenGL(const sp<const DisplayDevice>& hw) const;
437    void setFiltering(bool filtering);
438    bool getFiltering() const;
439
440    // only for debugging
441    inline const sp<GraphicBuffer>& getActiveBuffer() const { return mActiveBuffer; }
442
443    inline  const State&    getDrawingState() const { return mDrawingState; }
444    inline  const State&    getCurrentState() const { return mCurrentState; }
445    inline  State&          getCurrentState()       { return mCurrentState; }
446
447
448    /* always call base class first */
449    void dump(String8& result, Colorizer& colorizer) const;
450#ifdef USE_HWC2
451    static void miniDumpHeader(String8& result);
452    void miniDump(String8& result, int32_t hwcId) const;
453#endif
454    void dumpFrameStats(String8& result) const;
455    void dumpFrameEvents(String8& result);
456    void clearFrameStats();
457    void logFrameStats();
458    void getFrameStats(FrameStats* outStats) const;
459
460    std::vector<OccupancyTracker::Segment> getOccupancyHistory(bool forceFlush);
461
462    void onDisconnect();
463    void addAndGetFrameTimestamps(const NewFrameEventsEntry* newEntry,
464            FrameEventHistoryDelta* outDelta);
465
466    bool getTransformToDisplayInverse() const;
467
468    Transform getTransform() const;
469
470    // Returns the Alpha of the Surface, accounting for the Alpha
471    // of parent Surfaces in the hierarchy (alpha's will be multiplied
472    // down the hierarchy).
473#ifdef USE_HWC2
474    float getAlpha() const;
475#else
476    uint8_t getAlpha() const;
477#endif
478
479    void traverseInReverseZOrder(LayerVector::StateSet stateSet,
480                                 const LayerVector::Visitor& visitor);
481    void traverseInZOrder(LayerVector::StateSet stateSet, const LayerVector::Visitor& visitor);
482
483    void addChild(const sp<Layer>& layer);
484    // Returns index if removed, or negative value otherwise
485    // for symmetry with Vector::remove
486    ssize_t removeChild(const sp<Layer>& layer);
487    sp<Layer> getParent() const { return mParent.promote(); }
488    bool hasParent() const { return getParent() != nullptr; }
489
490    Rect computeScreenBounds(bool reduceTransparentRegion = true) const;
491    bool setChildLayer(const sp<Layer>& childLayer, int32_t z);
492
493    // Copy the current list of children to the drawing state. Called by
494    // SurfaceFlinger to complete a transaction.
495    void commitChildList();
496
497    int32_t getZ() const;
498protected:
499    // constant
500    sp<SurfaceFlinger> mFlinger;
501    /*
502     * Trivial class, used to ensure that mFlinger->onLayerDestroyed(mLayer)
503     * is called.
504     */
505    class LayerCleaner {
506        sp<SurfaceFlinger> mFlinger;
507        wp<Layer> mLayer;
508    protected:
509        ~LayerCleaner() {
510            // destroy client resources
511            mFlinger->onLayerDestroyed(mLayer);
512        }
513    public:
514        LayerCleaner(const sp<SurfaceFlinger>& flinger,
515                const sp<Layer>& layer)
516            : mFlinger(flinger), mLayer(layer) {
517        }
518    };
519
520
521    virtual void onFirstRef();
522
523
524
525private:
526    friend class SurfaceInterceptor;
527    // Interface implementation for SurfaceFlingerConsumer::ContentsChangedListener
528    virtual void onFrameAvailable(const BufferItem& item) override;
529    virtual void onFrameReplaced(const BufferItem& item) override;
530    virtual void onSidebandStreamChanged() override;
531
532    void commitTransaction(const State& stateToCommit);
533
534    // needsLinearFiltering - true if this surface's state requires filtering
535    bool needsFiltering(const sp<const DisplayDevice>& hw) const;
536
537    uint32_t getEffectiveUsage(uint32_t usage) const;
538
539    FloatRect computeCrop(const sp<const DisplayDevice>& hw) const;
540    // Compute the initial crop as specified by parent layers and the SurfaceControl
541    // for this layer. Does not include buffer crop from the IGraphicBufferProducer
542    // client, as that should not affect child clipping. Returns in screen space.
543    Rect computeInitialCrop(const sp<const DisplayDevice>& hw) const;
544    bool isCropped() const;
545    static bool getOpacityForFormat(uint32_t format);
546
547    // drawing
548    void clearWithOpenGL(const sp<const DisplayDevice>& hw,
549            float r, float g, float b, float alpha) const;
550    void drawWithOpenGL(const sp<const DisplayDevice>& hw,
551            bool useIdentityTransform) const;
552
553    // Temporary - Used only for LEGACY camera mode.
554    uint32_t getProducerStickyTransform() const;
555
556    // Loads the corresponding system property once per process
557    static bool latchUnsignaledBuffers();
558
559    void setParent(const sp<Layer>& layer);
560
561    LayerVector makeTraversalList(LayerVector::StateSet stateSet);
562    void addZOrderRelative(const wp<Layer>& relative);
563    void removeZOrderRelative(const wp<Layer>& relative);
564
565    // -----------------------------------------------------------------------
566
567    class SyncPoint
568    {
569    public:
570        explicit SyncPoint(uint64_t frameNumber) : mFrameNumber(frameNumber),
571                mFrameIsAvailable(false), mTransactionIsApplied(false) {}
572
573        uint64_t getFrameNumber() const {
574            return mFrameNumber;
575        }
576
577        bool frameIsAvailable() const {
578            return mFrameIsAvailable;
579        }
580
581        void setFrameAvailable() {
582            mFrameIsAvailable = true;
583        }
584
585        bool transactionIsApplied() const {
586            return mTransactionIsApplied;
587        }
588
589        void setTransactionApplied() {
590            mTransactionIsApplied = true;
591        }
592
593    private:
594        const uint64_t mFrameNumber;
595        std::atomic<bool> mFrameIsAvailable;
596        std::atomic<bool> mTransactionIsApplied;
597    };
598
599    // SyncPoints which will be signaled when the correct frame is at the head
600    // of the queue and dropped after the frame has been latched. Protected by
601    // mLocalSyncPointMutex.
602    Mutex mLocalSyncPointMutex;
603    std::list<std::shared_ptr<SyncPoint>> mLocalSyncPoints;
604
605    // SyncPoints which will be signaled and then dropped when the transaction
606    // is applied
607    std::list<std::shared_ptr<SyncPoint>> mRemoteSyncPoints;
608
609    uint64_t getHeadFrameNumber() const;
610    bool headFenceHasSignaled() const;
611
612    // Returns false if the relevant frame has already been latched
613    bool addSyncPoint(const std::shared_ptr<SyncPoint>& point);
614
615    void pushPendingState();
616    void popPendingState(State* stateToCommit);
617    bool applyPendingStates(State* stateToCommit);
618
619    void clearSyncPoints();
620
621    // Returns mCurrentScaling mode (originating from the
622    // Client) or mOverrideScalingMode mode (originating from
623    // the Surface Controller) if set.
624    uint32_t getEffectiveScalingMode() const;
625public:
626    /*
627     * The layer handle is just a BBinder object passed to the client
628     * (remote process) -- we don't keep any reference on our side such that
629     * the dtor is called when the remote side let go of its reference.
630     *
631     * LayerCleaner ensures that mFlinger->onLayerDestroyed() is called for
632     * this layer when the handle is destroyed.
633     */
634    class Handle : public BBinder, public LayerCleaner {
635        public:
636            Handle(const sp<SurfaceFlinger>& flinger, const sp<Layer>& layer)
637                : LayerCleaner(flinger, layer), owner(layer) {}
638
639            wp<Layer> owner;
640    };
641
642    sp<IBinder> getHandle();
643    sp<IGraphicBufferProducer> getProducer() const;
644    const String8& getName() const;
645    void notifyAvailableFrames();
646private:
647
648    // -----------------------------------------------------------------------
649
650    // Check all of the local sync points to ensure that all transactions
651    // which need to have been applied prior to the frame which is about to
652    // be latched have signaled
653    bool allTransactionsSignaled();
654
655    // constants
656    sp<SurfaceFlingerConsumer> mSurfaceFlingerConsumer;
657    sp<IGraphicBufferProducer> mProducer;
658    uint32_t mTextureName;      // from GLES
659    bool mPremultipliedAlpha;
660    String8 mName;
661    PixelFormat mFormat;
662
663    // these are protected by an external lock
664    State mCurrentState;
665    State mDrawingState;
666    volatile int32_t mTransactionFlags;
667
668    // Accessed from main thread and binder threads
669    Mutex mPendingStateMutex;
670    Vector<State> mPendingStates;
671
672    // thread-safe
673    volatile int32_t mQueuedFrames;
674    volatile int32_t mSidebandStreamChanged; // used like an atomic boolean
675
676    // Timestamp history for UIAutomation. Thread safe.
677    FrameTracker mFrameTracker;
678
679    // Timestamp history for the consumer to query.
680    // Accessed by both consumer and producer on main and binder threads.
681    Mutex mFrameEventHistoryMutex;
682    ConsumerFrameEventHistory mFrameEventHistory;
683    FenceTimeline mAcquireTimeline;
684    FenceTimeline mReleaseTimeline;
685
686    // main thread
687    int mActiveBufferSlot;
688    sp<GraphicBuffer> mActiveBuffer;
689    sp<NativeHandle> mSidebandStream;
690    Rect mCurrentCrop;
691    uint32_t mCurrentTransform;
692    uint32_t mCurrentScalingMode;
693    // We encode unset as -1.
694    int32_t mOverrideScalingMode;
695    bool mCurrentOpacity;
696    bool mBufferLatched = false;  // TODO: Use mActiveBuffer?
697    std::atomic<uint64_t> mCurrentFrameNumber;
698    uint64_t mPreviousFrameNumber; // Only accessed on the main thread.
699    bool mRefreshPending;
700    bool mFrameLatencyNeeded;
701    // Whether filtering is forced on or not
702    bool mFiltering;
703    // Whether filtering is needed b/c of the drawingstate
704    bool mNeedsFiltering;
705    // The mesh used to draw the layer in GLES composition mode
706    mutable Mesh mMesh;
707    // The texture used to draw the layer in GLES composition mode
708    mutable Texture mTexture;
709
710#ifdef USE_HWC2
711    // HWC items, accessed from the main thread
712    struct HWCInfo {
713        HWCInfo()
714          : layer(),
715            forceClientComposition(false),
716            compositionType(HWC2::Composition::Invalid),
717            clearClientTarget(false) {}
718
719        std::shared_ptr<HWC2::Layer> layer;
720        bool forceClientComposition;
721        HWC2::Composition compositionType;
722        bool clearClientTarget;
723        Rect displayFrame;
724        FloatRect sourceCrop;
725        HWComposerBufferCache bufferCache;
726    };
727
728    // A layer can be attached to multiple displays when operating in mirror mode
729    // (a.k.a: when several displays are attached with equal layerStack). In this
730    // case we need to keep track. In non-mirror mode, a layer will have only one
731    // HWCInfo. This map key is a display layerStack.
732    std::unordered_map<int32_t, HWCInfo> mHwcLayers;
733#else
734    bool mIsGlesComposition;
735#endif
736
737    // page-flip thread (currently main thread)
738    bool mProtectedByApp; // application requires protected path to external sink
739
740    // protected by mLock
741    mutable Mutex mLock;
742    // Set to true once we've returned this surface's handle
743    mutable bool mHasSurface;
744    const wp<Client> mClientRef;
745
746    // This layer can be a cursor on some displays.
747    bool mPotentialCursor;
748
749    // Local copy of the queued contents of the incoming BufferQueue
750    mutable Mutex mQueueItemLock;
751    Condition mQueueItemCondition;
752    Vector<BufferItem> mQueueItems;
753    std::atomic<uint64_t> mLastFrameNumberReceived;
754    bool mUpdateTexImageFailed; // This is only accessed on the main thread.
755
756    bool mAutoRefresh;
757    bool mFreezePositionUpdates;
758
759    // Child list about to be committed/used for editing.
760    LayerVector mCurrentChildren;
761    // Child list used for rendering.
762    LayerVector mDrawingChildren;
763
764    wp<Layer> mParent;
765};
766
767// ---------------------------------------------------------------------------
768
769}; // namespace android
770
771#endif // ANDROID_LAYER_H
772