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