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