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