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