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