Layer.h revision 4df87bd1f6f68126e5e9081fc1365ae500e375db 
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 "FrameTracker.h"
40#include "Client.h"
41#include "MonitoredProducer.h"
42#include "SurfaceFlinger.h"
43#include "SurfaceFlingerConsumer.h"
44#include "Transform.h"
45
46#include "DisplayHardware/HWComposer.h"
47#include "DisplayHardware/FloatRect.h"
48#include "RenderEngine/Mesh.h"
49#include "RenderEngine/Texture.h"
50
51namespace android {
52
53// ---------------------------------------------------------------------------
54
55class Client;
56class Colorizer;
57class DisplayDevice;
58class GraphicBuffer;
59class SurfaceFlinger;
60
61// ---------------------------------------------------------------------------
62
63/*
64 * A new BufferQueue and a new SurfaceFlingerConsumer are created when the
65 * Layer is first referenced.
66 *
67 * This also implements onFrameAvailable(), which notifies SurfaceFlinger
68 * that new data has arrived.
69 */
70class Layer : public SurfaceFlingerConsumer::ContentsChangedListener {
71    static int32_t sSequence;
72
73public:
74    mutable bool contentDirty;
75    // regions below are in window-manager space
76    Region visibleRegion;
77    Region coveredRegion;
78    Region visibleNonTransparentRegion;
79
80    // Layer serial number.  This gives layers an explicit ordering, so we
81    // have a stable sort order when their layer stack and Z-order are
82    // the same.
83    int32_t sequence;
84
85    enum { // flags for doTransaction()
86        eDontUpdateGeometryState = 0x00000001,
87        eVisibleRegion = 0x00000002,
88    };
89
90    struct Geometry {
91        uint32_t w;
92        uint32_t h;
93        Rect crop;
94        inline bool operator ==(const Geometry& rhs) const {
95            return (w == rhs.w && h == rhs.h && crop == rhs.crop);
96        }
97        inline bool operator !=(const Geometry& rhs) const {
98            return !operator ==(rhs);
99        }
100    };
101
102    struct State {
103        Geometry active;
104        Geometry requested;
105        uint32_t z;
106        uint32_t layerStack;
107        uint8_t alpha;
108        uint8_t flags;
109        uint8_t reserved[2];
110        int32_t sequence; // changes when visible regions can change
111        Transform transform;
112        // the transparentRegion hint is a bit special, it's latched only
113        // when we receive a buffer -- this is because it's "content"
114        // dependent.
115        Region activeTransparentRegion;
116        Region requestedTransparentRegion;
117    };
118
119    // -----------------------------------------------------------------------
120
121    Layer(SurfaceFlinger* flinger, const sp<Client>& client,
122            const String8& name, uint32_t w, uint32_t h, uint32_t flags);
123
124    virtual ~Layer();
125
126    // the this layer's size and format
127    status_t setBuffers(uint32_t w, uint32_t h, PixelFormat format, uint32_t flags);
128
129    // modify current state
130    bool setPosition(float x, float y);
131    bool setLayer(uint32_t z);
132    bool setSize(uint32_t w, uint32_t h);
133    bool setAlpha(uint8_t alpha);
134    bool setMatrix(const layer_state_t::matrix22_t& matrix);
135    bool setTransparentRegionHint(const Region& transparent);
136    bool setFlags(uint8_t flags, uint8_t mask);
137    bool setCrop(const Rect& crop);
138    bool setLayerStack(uint32_t layerStack);
139
140    uint32_t getTransactionFlags(uint32_t flags);
141    uint32_t setTransactionFlags(uint32_t flags);
142
143    void computeGeometry(const sp<const DisplayDevice>& hw, Mesh& mesh,
144            bool useIdentityTransform) const;
145    Rect computeBounds() const;
146
147    sp<IBinder> getHandle();
148    sp<IGraphicBufferProducer> getProducer() const;
149    const String8& getName() const;
150
151    // -----------------------------------------------------------------------
152    // Virtuals
153
154    virtual const char* getTypeId() const { return "Layer"; }
155
156    /*
157     * isOpaque - true if this surface is opaque
158     *
159     * This takes into account the buffer format (i.e. whether or not the
160     * pixel format includes an alpha channel) and the "opaque" flag set
161     * on the layer.  It does not examine the current plane alpha value.
162     */
163    virtual bool isOpaque(const Layer::State& s) const;
164
165    /*
166     * isSecure - true if this surface is secure, that is if it prevents
167     * screenshots or VNC servers.
168     */
169    virtual bool isSecure() const           { return mSecure; }
170
171    /*
172     * isProtected - true if the layer may contain protected content in the
173     * GRALLOC_USAGE_PROTECTED sense.
174     */
175    virtual bool isProtected() const;
176
177    /*
178     * isVisible - true if this layer is visible, false otherwise
179     */
180    virtual bool isVisible() const;
181
182    /*
183     * isFixedSize - true if content has a fixed size
184     */
185    virtual bool isFixedSize() const;
186
187protected:
188    /*
189     * onDraw - draws the surface.
190     */
191    virtual void onDraw(const sp<const DisplayDevice>& hw, const Region& clip,
192            bool useIdentityTransform) const;
193
194public:
195    // -----------------------------------------------------------------------
196
197    void setGeometry(const sp<const DisplayDevice>& hw,
198            HWComposer::HWCLayerInterface& layer);
199    void setPerFrameData(const sp<const DisplayDevice>& hw,
200            HWComposer::HWCLayerInterface& layer);
201    void setAcquireFence(const sp<const DisplayDevice>& hw,
202            HWComposer::HWCLayerInterface& layer);
203
204    /*
205     * called after page-flip
206     */
207    void onLayerDisplayed(const sp<const DisplayDevice>& hw,
208            HWComposer::HWCLayerInterface* layer);
209
210    /*
211     * called before composition.
212     * returns true if the layer has pending updates.
213     */
214    bool onPreComposition();
215
216    /*
217     *  called after composition.
218     */
219    void onPostComposition();
220
221    /*
222     * draw - performs some global clipping optimizations
223     * and calls onDraw().
224     */
225    void draw(const sp<const DisplayDevice>& hw, const Region& clip) const;
226    void draw(const sp<const DisplayDevice>& hw, bool useIdentityTransform) const;
227    void draw(const sp<const DisplayDevice>& hw) const;
228
229    /*
230     * doTransaction - process the transaction. This is a good place to figure
231     * out which attributes of the surface have changed.
232     */
233    uint32_t doTransaction(uint32_t transactionFlags);
234
235    /*
236     * setVisibleRegion - called to set the new visible region. This gives
237     * a chance to update the new visible region or record the fact it changed.
238     */
239    void setVisibleRegion(const Region& visibleRegion);
240
241    /*
242     * setCoveredRegion - called when the covered region changes. The covered
243     * region corresponds to any area of the surface that is covered
244     * (transparently or not) by another surface.
245     */
246    void setCoveredRegion(const Region& coveredRegion);
247
248    /*
249     * setVisibleNonTransparentRegion - called when the visible and
250     * non-transparent region changes.
251     */
252    void setVisibleNonTransparentRegion(const Region&
253            visibleNonTransparentRegion);
254
255    /*
256     * latchBuffer - called each time the screen is redrawn and returns whether
257     * the visible regions need to be recomputed (this is a fairly heavy
258     * operation, so this should be set only if needed). Typically this is used
259     * to figure out if the content or size of a surface has changed.
260     */
261    Region latchBuffer(bool& recomputeVisibleRegions);
262
263    /*
264     * called with the state lock when the surface is removed from the
265     * current list
266     */
267    void onRemoved();
268
269
270    // Updates the transform hint in our SurfaceFlingerConsumer to match
271    // the current orientation of the display device.
272    void updateTransformHint(const sp<const DisplayDevice>& hw) const;
273
274    /*
275     * returns the rectangle that crops the content of the layer and scales it
276     * to the layer's size.
277     */
278    Rect getContentCrop() const;
279
280    // -----------------------------------------------------------------------
281
282    void clearWithOpenGL(const sp<const DisplayDevice>& hw, const Region& clip) const;
283    void setFiltering(bool filtering);
284    bool getFiltering() const;
285
286    // only for debugging
287    inline const sp<GraphicBuffer>& getActiveBuffer() const { return mActiveBuffer; }
288
289    inline  const State&    getDrawingState() const { return mDrawingState; }
290    inline  const State&    getCurrentState() const { return mCurrentState; }
291    inline  State&          getCurrentState()       { return mCurrentState; }
292
293
294    /* always call base class first */
295    void dump(String8& result, Colorizer& colorizer) const;
296    void dumpFrameStats(String8& result) const;
297    void clearFrameStats();
298    void logFrameStats();
299    void getFrameStats(FrameStats* outStats) const;
300
301protected:
302    // constant
303    sp<SurfaceFlinger> mFlinger;
304
305    virtual void onFirstRef();
306
307    /*
308     * Trivial class, used to ensure that mFlinger->onLayerDestroyed(mLayer)
309     * is called.
310     */
311    class LayerCleaner {
312        sp<SurfaceFlinger> mFlinger;
313        wp<Layer> mLayer;
314    protected:
315        ~LayerCleaner();
316    public:
317        LayerCleaner(const sp<SurfaceFlinger>& flinger, const sp<Layer>& layer);
318    };
319
320
321private:
322    // Interface implementation for SurfaceFlingerConsumer::ContentsChangedListener
323    virtual void onFrameAvailable();
324    virtual void onSidebandStreamChanged();
325
326    void commitTransaction();
327
328    // needsLinearFiltering - true if this surface's state requires filtering
329    bool needsFiltering(const sp<const DisplayDevice>& hw) const;
330
331    uint32_t getEffectiveUsage(uint32_t usage) const;
332    FloatRect computeCrop(const sp<const DisplayDevice>& hw) const;
333    bool isCropped() const;
334    static bool getOpacityForFormat(uint32_t format);
335
336    // drawing
337    void clearWithOpenGL(const sp<const DisplayDevice>& hw, const Region& clip,
338            float r, float g, float b, float alpha) const;
339    void drawWithOpenGL(const sp<const DisplayDevice>& hw, const Region& clip,
340            bool useIdentityTransform) const;
341
342
343    // -----------------------------------------------------------------------
344
345    // constants
346    sp<SurfaceFlingerConsumer> mSurfaceFlingerConsumer;
347    sp<IGraphicBufferProducer> mProducer;
348    uint32_t mTextureName;      // from GLES
349    bool mPremultipliedAlpha;
350    String8 mName;
351    mutable bool mDebug;
352    PixelFormat mFormat;
353
354    // these are protected by an external lock
355    State mCurrentState;
356    State mDrawingState;
357    volatile int32_t mTransactionFlags;
358
359    // thread-safe
360    volatile int32_t mQueuedFrames;
361    volatile int32_t mSidebandStreamChanged; // used like an atomic boolean
362    FrameTracker mFrameTracker;
363
364    // main thread
365    sp<GraphicBuffer> mActiveBuffer;
366    sp<NativeHandle> mSidebandStream;
367    Rect mCurrentCrop;
368    uint32_t mCurrentTransform;
369    uint32_t mCurrentScalingMode;
370    bool mCurrentOpacity;
371    bool mRefreshPending;
372    bool mFrameLatencyNeeded;
373    // Whether filtering is forced on or not
374    bool mFiltering;
375    // Whether filtering is needed b/c of the drawingstate
376    bool mNeedsFiltering;
377    // The mesh used to draw the layer in GLES composition mode
378    mutable Mesh mMesh;
379    // The texture used to draw the layer in GLES composition mode
380    mutable Texture mTexture;
381
382    // page-flip thread (currently main thread)
383    bool mSecure; // no screenshots
384    bool mProtectedByApp; // application requires protected path to external sink
385
386    // protected by mLock
387    mutable Mutex mLock;
388    // Set to true once we've returned this surface's handle
389    mutable bool mHasSurface;
390    const wp<Client> mClientRef;
391};
392
393// ---------------------------------------------------------------------------
394
395}; // namespace android
396
397#endif // ANDROID_LAYER_H
398