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