Layer.h revision 3fee6ca1d93c1d4b822d2dcd36c61f9722dd88b9 
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 "MonitoredProducer.h"
44#include "SurfaceFlinger.h"
45#include "SurfaceFlingerConsumer.h"
46#include "Transform.h"
47
48#include "DisplayHardware/HWComposer.h"
49#include "DisplayHardware/FloatRect.h"
50#include "RenderEngine/Mesh.h"
51#include "RenderEngine/Texture.h"
52
53namespace android {
54
55// ---------------------------------------------------------------------------
56
57class Client;
58class Colorizer;
59class DisplayDevice;
60class GraphicBuffer;
61class SurfaceFlinger;
62
63// ---------------------------------------------------------------------------
64
65/*
66 * A new BufferQueue and a new SurfaceFlingerConsumer are created when the
67 * Layer is first referenced.
68 *
69 * This also implements onFrameAvailable(), which notifies SurfaceFlinger
70 * that new data has arrived.
71 */
72class Layer : public SurfaceFlingerConsumer::ContentsChangedListener {
73    static int32_t sSequence;
74
75public:
76    mutable bool contentDirty;
77    // regions below are in window-manager space
78    Region visibleRegion;
79    Region coveredRegion;
80    Region visibleNonTransparentRegion;
81    Region surfaceDamageRegion;
82
83    // Layer serial number.  This gives layers an explicit ordering, so we
84    // have a stable sort order when their layer stack and Z-order are
85    // the same.
86    int32_t sequence;
87
88    enum { // flags for doTransaction()
89        eDontUpdateGeometryState = 0x00000001,
90        eVisibleRegion = 0x00000002,
91    };
92
93    struct Geometry {
94        uint32_t w;
95        uint32_t h;
96        Transform transform;
97
98        inline bool operator ==(const Geometry& rhs) const {
99          return (w == rhs.w && h == rhs.h);
100        }
101        inline bool operator !=(const Geometry& rhs) const {
102            return !operator ==(rhs);
103        }
104    };
105
106    struct State {
107        Geometry active;
108        Geometry requested;
109        uint32_t z;
110        uint32_t layerStack;
111#ifdef USE_HWC2
112        float alpha;
113#else
114        uint8_t alpha;
115#endif
116        uint8_t flags;
117        uint8_t mask;
118        uint8_t reserved[2];
119        int32_t sequence; // changes when visible regions can change
120        bool modified;
121
122        Rect crop;
123        Rect finalCrop;
124
125        // If set, defers this state update until the Layer identified by handle
126        // receives a frame with the given frameNumber
127        sp<IBinder> handle;
128        uint64_t frameNumber;
129
130        // the transparentRegion hint is a bit special, it's latched only
131        // when we receive a buffer -- this is because it's "content"
132        // dependent.
133        Region activeTransparentRegion;
134        Region requestedTransparentRegion;
135    };
136
137    // -----------------------------------------------------------------------
138
139    Layer(SurfaceFlinger* flinger, const sp<Client>& client,
140            const String8& name, uint32_t w, uint32_t h, uint32_t flags);
141
142    virtual ~Layer();
143
144    // the this layer's size and format
145    status_t setBuffers(uint32_t w, uint32_t h, PixelFormat format, uint32_t flags);
146
147    // modify current state
148    bool setPosition(float x, float y, bool immediate);
149    bool setLayer(uint32_t z);
150    bool setSize(uint32_t w, uint32_t h);
151#ifdef USE_HWC2
152    bool setAlpha(float alpha);
153#else
154    bool setAlpha(uint8_t alpha);
155#endif
156    bool setMatrix(const layer_state_t::matrix22_t& matrix);
157    bool setTransparentRegionHint(const Region& transparent);
158    bool setFlags(uint8_t flags, uint8_t mask);
159    bool setCrop(const Rect& crop);
160    bool setFinalCrop(const Rect& crop);
161    bool setLayerStack(uint32_t layerStack);
162    void deferTransactionUntil(const sp<IBinder>& handle, uint64_t frameNumber);
163    bool setOverrideScalingMode(int32_t overrideScalingMode);
164
165    // If we have received a new buffer this frame, we will pass its surface
166    // damage down to hardware composer. Otherwise, we must send a region with
167    // one empty rect.
168    void useSurfaceDamage();
169    void useEmptyDamage();
170
171    uint32_t getTransactionFlags(uint32_t flags);
172    uint32_t setTransactionFlags(uint32_t flags);
173
174    void computeGeometry(const sp<const DisplayDevice>& hw, Mesh& mesh,
175            bool useIdentityTransform) const;
176    Rect computeBounds(const Region& activeTransparentRegion) const;
177    Rect computeBounds() const;
178
179    class Handle;
180    sp<IBinder> getHandle();
181    sp<IGraphicBufferProducer> getProducer() const;
182    const String8& getName() const;
183
184    int32_t getSequence() const { return sequence; }
185
186    // -----------------------------------------------------------------------
187    // Virtuals
188
189    virtual const char* getTypeId() const { return "Layer"; }
190
191    /*
192     * isOpaque - true if this surface is opaque
193     *
194     * This takes into account the buffer format (i.e. whether or not the
195     * pixel format includes an alpha channel) and the "opaque" flag set
196     * on the layer.  It does not examine the current plane alpha value.
197     */
198    virtual bool isOpaque(const Layer::State& s) const;
199
200    /*
201     * isSecure - true if this surface is secure, that is if it prevents
202     * screenshots or VNC servers.
203     */
204    virtual bool isSecure() const;
205
206    /*
207     * isProtected - true if the layer may contain protected content in the
208     * GRALLOC_USAGE_PROTECTED sense.
209     */
210    virtual bool isProtected() const;
211
212    /*
213     * isVisible - true if this layer is visible, false otherwise
214     */
215    virtual bool isVisible() const;
216
217    /*
218     * isFixedSize - true if content has a fixed size
219     */
220    virtual bool isFixedSize() const;
221
222protected:
223    /*
224     * onDraw - draws the surface.
225     */
226    virtual void onDraw(const sp<const DisplayDevice>& hw, const Region& clip,
227            bool useIdentityTransform) const;
228
229public:
230    // -----------------------------------------------------------------------
231
232#ifdef USE_HWC2
233    void setGeometry(const sp<const DisplayDevice>& displayDevice);
234    void forceClientComposition(int32_t hwcId);
235    void setPerFrameData(const sp<const DisplayDevice>& displayDevice);
236
237    // callIntoHwc exists so we can update our local state and call
238    // acceptDisplayChanges without unnecessarily updating the device's state
239    void setCompositionType(int32_t hwcId, HWC2::Composition type,
240            bool callIntoHwc = true);
241    HWC2::Composition getCompositionType(int32_t hwcId) const;
242
243    void setClearClientTarget(int32_t hwcId, bool clear);
244    bool getClearClientTarget(int32_t hwcId) const;
245
246    void updateCursorPosition(const sp<const DisplayDevice>& hw);
247#else
248    void setGeometry(const sp<const DisplayDevice>& hw,
249            HWComposer::HWCLayerInterface& layer);
250    void setPerFrameData(const sp<const DisplayDevice>& hw,
251            HWComposer::HWCLayerInterface& layer);
252    void setAcquireFence(const sp<const DisplayDevice>& hw,
253            HWComposer::HWCLayerInterface& layer);
254
255    Rect getPosition(const sp<const DisplayDevice>& hw);
256#endif
257
258    /*
259     * called after page-flip
260     */
261#ifdef USE_HWC2
262    void onLayerDisplayed(const sp<Fence>& releaseFence);
263#else
264    void onLayerDisplayed(const sp<const DisplayDevice>& hw,
265            HWComposer::HWCLayerInterface* layer);
266#endif
267
268    bool shouldPresentNow(const DispSync& dispSync) const;
269
270    /*
271     * called before composition.
272     * returns true if the layer has pending updates.
273     */
274    bool onPreComposition();
275
276    /*
277     * called after composition.
278     * returns true if the layer latched a new buffer this frame.
279     */
280    bool onPostComposition();
281
282#ifdef USE_HWC2
283    // If a buffer was replaced this frame, release the former buffer
284    void releasePendingBuffer();
285#endif
286
287    /*
288     * draw - performs some global clipping optimizations
289     * and calls onDraw().
290     */
291    void draw(const sp<const DisplayDevice>& hw, const Region& clip) const;
292    void draw(const sp<const DisplayDevice>& hw, bool useIdentityTransform) const;
293    void draw(const sp<const DisplayDevice>& hw) const;
294
295    /*
296     * doTransaction - process the transaction. This is a good place to figure
297     * out which attributes of the surface have changed.
298     */
299    uint32_t doTransaction(uint32_t transactionFlags);
300
301    /*
302     * setVisibleRegion - called to set the new visible region. This gives
303     * a chance to update the new visible region or record the fact it changed.
304     */
305    void setVisibleRegion(const Region& visibleRegion);
306
307    /*
308     * setCoveredRegion - called when the covered region changes. The covered
309     * region corresponds to any area of the surface that is covered
310     * (transparently or not) by another surface.
311     */
312    void setCoveredRegion(const Region& coveredRegion);
313
314    /*
315     * setVisibleNonTransparentRegion - called when the visible and
316     * non-transparent region changes.
317     */
318    void setVisibleNonTransparentRegion(const Region&
319            visibleNonTransparentRegion);
320
321    /*
322     * latchBuffer - called each time the screen is redrawn and returns whether
323     * the visible regions need to be recomputed (this is a fairly heavy
324     * operation, so this should be set only if needed). Typically this is used
325     * to figure out if the content or size of a surface has changed.
326     */
327    Region latchBuffer(bool& recomputeVisibleRegions);
328
329    bool isPotentialCursor() const { return mPotentialCursor;}
330
331    /*
332     * called with the state lock when the surface is removed from the
333     * current list
334     */
335    void onRemoved();
336
337
338    // Updates the transform hint in our SurfaceFlingerConsumer to match
339    // the current orientation of the display device.
340    void updateTransformHint(const sp<const DisplayDevice>& hw) const;
341
342    /*
343     * returns the rectangle that crops the content of the layer and scales it
344     * to the layer's size.
345     */
346    Rect getContentCrop() const;
347
348    /*
349     * Returns if a frame is queued.
350     */
351    bool hasQueuedFrame() const { return mQueuedFrames > 0 ||
352            mSidebandStreamChanged || mAutoRefresh; }
353
354#ifdef USE_HWC2
355    // -----------------------------------------------------------------------
356
357    bool hasHwcLayer(int32_t hwcId) {
358        if (mHwcLayers.count(hwcId) == 0) {
359            return false;
360        }
361        if (mHwcLayers[hwcId].layer->isAbandoned()) {
362            ALOGI("Erasing abandoned layer %s on %d", mName.string(), hwcId);
363            mHwcLayers.erase(hwcId);
364            return false;
365        }
366        return true;
367    }
368
369    std::shared_ptr<HWC2::Layer> getHwcLayer(int32_t hwcId) {
370        if (mHwcLayers.count(hwcId) == 0) {
371            return nullptr;
372        }
373        return mHwcLayers[hwcId].layer;
374    }
375
376    void setHwcLayer(int32_t hwcId, std::shared_ptr<HWC2::Layer>&& layer) {
377        if (layer) {
378            mHwcLayers[hwcId].layer = layer;
379        } else {
380            mHwcLayers.erase(hwcId);
381        }
382    }
383
384#endif
385    // -----------------------------------------------------------------------
386
387    void clearWithOpenGL(const sp<const DisplayDevice>& hw, const Region& clip) const;
388    void setFiltering(bool filtering);
389    bool getFiltering() const;
390
391    // only for debugging
392    inline const sp<GraphicBuffer>& getActiveBuffer() const { return mActiveBuffer; }
393
394    inline  const State&    getDrawingState() const { return mDrawingState; }
395    inline  const State&    getCurrentState() const { return mCurrentState; }
396    inline  State&          getCurrentState()       { return mCurrentState; }
397
398
399    /* always call base class first */
400    void dump(String8& result, Colorizer& colorizer) const;
401    void dumpFrameStats(String8& result) const;
402    void clearFrameStats();
403    void logFrameStats();
404    void getFrameStats(FrameStats* outStats) const;
405
406    void getFenceData(String8* outName, uint64_t* outFrameNumber,
407            bool* outIsGlesComposition, nsecs_t* outPostedTime,
408            sp<Fence>* outAcquireFence, sp<Fence>* outPrevReleaseFence) const;
409
410    std::vector<OccupancyTracker::Segment> getOccupancyHistory(bool forceFlush);
411
412protected:
413    // constant
414    sp<SurfaceFlinger> mFlinger;
415
416    virtual void onFirstRef();
417
418    /*
419     * Trivial class, used to ensure that mFlinger->onLayerDestroyed(mLayer)
420     * is called.
421     */
422    class LayerCleaner {
423        sp<SurfaceFlinger> mFlinger;
424        wp<Layer> mLayer;
425    protected:
426        ~LayerCleaner();
427    public:
428        LayerCleaner(const sp<SurfaceFlinger>& flinger, const sp<Layer>& layer);
429    };
430
431
432private:
433    // Interface implementation for SurfaceFlingerConsumer::ContentsChangedListener
434    virtual void onFrameAvailable(const BufferItem& item) override;
435    virtual void onFrameReplaced(const BufferItem& item) override;
436    virtual void onSidebandStreamChanged() override;
437
438    void commitTransaction(const State& stateToCommit);
439
440    // needsLinearFiltering - true if this surface's state requires filtering
441    bool needsFiltering(const sp<const DisplayDevice>& hw) const;
442
443    uint32_t getEffectiveUsage(uint32_t usage) const;
444    FloatRect computeCrop(const sp<const DisplayDevice>& hw) const;
445    bool isCropped() const;
446    static bool getOpacityForFormat(uint32_t format);
447
448    // drawing
449    void clearWithOpenGL(const sp<const DisplayDevice>& hw, const Region& clip,
450            float r, float g, float b, float alpha) const;
451    void drawWithOpenGL(const sp<const DisplayDevice>& hw, const Region& clip,
452            bool useIdentityTransform) const;
453
454    // Temporary - Used only for LEGACY camera mode.
455    uint32_t getProducerStickyTransform() const;
456
457    // -----------------------------------------------------------------------
458
459    class SyncPoint
460    {
461    public:
462        SyncPoint(uint64_t frameNumber) : mFrameNumber(frameNumber),
463                mFrameIsAvailable(false), mTransactionIsApplied(false) {}
464
465        uint64_t getFrameNumber() const {
466            return mFrameNumber;
467        }
468
469        bool frameIsAvailable() const {
470            return mFrameIsAvailable;
471        }
472
473        void setFrameAvailable() {
474            mFrameIsAvailable = true;
475        }
476
477        bool transactionIsApplied() const {
478            return mTransactionIsApplied;
479        }
480
481        void setTransactionApplied() {
482            mTransactionIsApplied = true;
483        }
484
485    private:
486        const uint64_t mFrameNumber;
487        std::atomic<bool> mFrameIsAvailable;
488        std::atomic<bool> mTransactionIsApplied;
489    };
490
491    // SyncPoints which will be signaled when the correct frame is at the head
492    // of the queue and dropped after the frame has been latched. Protected by
493    // mLocalSyncPointMutex.
494    Mutex mLocalSyncPointMutex;
495    std::list<std::shared_ptr<SyncPoint>> mLocalSyncPoints;
496
497    // SyncPoints which will be signaled and then dropped when the transaction
498    // is applied
499    std::list<std::shared_ptr<SyncPoint>> mRemoteSyncPoints;
500
501    uint64_t getHeadFrameNumber() const;
502
503    // Returns false if the relevant frame has already been latched
504    bool addSyncPoint(const std::shared_ptr<SyncPoint>& point);
505
506    void pushPendingState();
507    void popPendingState(State* stateToCommit);
508    bool applyPendingStates(State* stateToCommit);
509
510    // Returns mCurrentScaling mode (originating from the
511    // Client) or mOverrideScalingMode mode (originating from
512    // the Surface Controller) if set.
513    uint32_t getEffectiveScalingMode() const;
514public:
515    void notifyAvailableFrames();
516private:
517
518    // -----------------------------------------------------------------------
519
520    // constants
521    sp<SurfaceFlingerConsumer> mSurfaceFlingerConsumer;
522    sp<IGraphicBufferProducer> mProducer;
523    uint32_t mTextureName;      // from GLES
524    bool mPremultipliedAlpha;
525    String8 mName;
526    PixelFormat mFormat;
527
528    // these are protected by an external lock
529    State mCurrentState;
530    State mDrawingState;
531    volatile int32_t mTransactionFlags;
532
533    // Accessed from main thread and binder threads
534    Mutex mPendingStateMutex;
535    Vector<State> mPendingStates;
536
537    // thread-safe
538    volatile int32_t mQueuedFrames;
539    volatile int32_t mSidebandStreamChanged; // used like an atomic boolean
540    FrameTracker mFrameTracker;
541
542    // main thread
543    sp<GraphicBuffer> mActiveBuffer;
544    sp<NativeHandle> mSidebandStream;
545    Rect mCurrentCrop;
546    uint32_t mCurrentTransform;
547    uint32_t mCurrentScalingMode;
548    // We encode unset as -1.
549    int32_t mOverrideScalingMode;
550    bool mCurrentOpacity;
551    std::atomic<uint64_t> mCurrentFrameNumber;
552    bool mRefreshPending;
553    bool mFrameLatencyNeeded;
554    // Whether filtering is forced on or not
555    bool mFiltering;
556    // Whether filtering is needed b/c of the drawingstate
557    bool mNeedsFiltering;
558    // The mesh used to draw the layer in GLES composition mode
559    mutable Mesh mMesh;
560    // The texture used to draw the layer in GLES composition mode
561    mutable Texture mTexture;
562
563#ifdef USE_HWC2
564    // HWC items, accessed from the main thread
565    struct HWCInfo {
566        HWCInfo()
567          : layer(),
568            forceClientComposition(false),
569            compositionType(HWC2::Composition::Invalid),
570            clearClientTarget(false) {}
571
572        std::shared_ptr<HWC2::Layer> layer;
573        bool forceClientComposition;
574        HWC2::Composition compositionType;
575        bool clearClientTarget;
576    };
577    std::unordered_map<int32_t, HWCInfo> mHwcLayers;
578#else
579    bool mIsGlesComposition;
580#endif
581
582    // page-flip thread (currently main thread)
583    bool mProtectedByApp; // application requires protected path to external sink
584
585    // protected by mLock
586    mutable Mutex mLock;
587    // Set to true once we've returned this surface's handle
588    mutable bool mHasSurface;
589    const wp<Client> mClientRef;
590
591    // This layer can be a cursor on some displays.
592    bool mPotentialCursor;
593
594    // Local copy of the queued contents of the incoming BufferQueue
595    mutable Mutex mQueueItemLock;
596    Condition mQueueItemCondition;
597    Vector<BufferItem> mQueueItems;
598    std::atomic<uint64_t> mLastFrameNumberReceived;
599    bool mUpdateTexImageFailed; // This is only modified from the main thread
600
601    bool mAutoRefresh;
602    bool mFreezePositionUpdates;
603};
604
605// ---------------------------------------------------------------------------
606
607}; // namespace android
608
609#endif // ANDROID_LAYER_H
610