Layer.h revision a350ff98692b3a50cad5cc93f9f83221242ca86a 
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 <ui/GraphicBuffer.h>
24#include <ui/PixelFormat.h>
25#include <pixelflinger/pixelflinger.h>
26
27#include <EGL/egl.h>
28#include <EGL/eglext.h>
29#include <GLES/gl.h>
30#include <GLES/glext.h>
31
32#include "LayerBase.h"
33#include "Transform.h"
34#include "TextureManager.h"
35
36namespace android {
37
38// ---------------------------------------------------------------------------
39
40class FreezeLock;
41class Client;
42class GLExtensions;
43class UserClient;
44
45// ---------------------------------------------------------------------------
46
47class Layer : public LayerBaseClient
48{
49public:
50            Layer(SurfaceFlinger* flinger, DisplayID display,
51                    const sp<Client>& client);
52
53    virtual ~Layer();
54
55    virtual const char* getTypeId() const { return "Layer"; }
56
57    // the this layer's size and format
58    status_t setBuffers(uint32_t w, uint32_t h,
59            PixelFormat format, uint32_t flags=0);
60
61    // associate a UserClient to this Layer
62    status_t setToken(const sp<UserClient>& uc, SharedClient* sc, int32_t idx);
63    int32_t getToken() const;
64    sp<UserClient> getClient() const;
65
66    // Set this Layer's buffers size
67    void setBufferSize(uint32_t w, uint32_t h);
68    bool isFixedSize() const;
69
70    // LayerBase interface
71    virtual void setGeometry(hwc_layer_t* hwcl);
72    virtual void setPerFrameData(hwc_layer_t* hwcl);
73    virtual void onDraw(const Region& clip) const;
74    virtual uint32_t doTransaction(uint32_t transactionFlags);
75    virtual void lockPageFlip(bool& recomputeVisibleRegions);
76    virtual void unlockPageFlip(const Transform& planeTransform, Region& outDirtyRegion);
77    virtual void finishPageFlip();
78    virtual bool needsBlending() const      { return mNeedsBlending; }
79    virtual bool needsDithering() const     { return mNeedsDithering; }
80    virtual bool needsFiltering() const;
81    virtual bool isSecure() const           { return mSecure; }
82    virtual sp<Surface> createSurface() const;
83    virtual status_t ditch();
84    virtual void onRemoved();
85
86    // only for debugging
87    inline sp<GraphicBuffer> getBuffer(int i) const {
88        return mBufferManager.getBuffer(i); }
89    // only for debugging
90    inline const sp<FreezeLock>&  getFreezeLock() const {
91        return mFreezeLock; }
92
93protected:
94    virtual void dump(String8& result, char* scratch, size_t size) const;
95
96private:
97    void reloadTexture(const Region& dirty);
98    uint32_t getEffectiveUsage(uint32_t usage) const;
99    sp<GraphicBuffer> requestBuffer(int bufferIdx,
100            uint32_t w, uint32_t h, uint32_t format, uint32_t usage);
101    status_t setBufferCount(int bufferCount);
102
103    // -----------------------------------------------------------------------
104
105    class SurfaceLayer : public LayerBaseClient::Surface {
106    public:
107        SurfaceLayer(const sp<SurfaceFlinger>& flinger, const sp<Layer>& owner);
108        ~SurfaceLayer();
109    private:
110        virtual sp<GraphicBuffer> requestBuffer(int bufferIdx,
111                uint32_t w, uint32_t h, uint32_t format, uint32_t usage);
112        virtual status_t setBufferCount(int bufferCount);
113        sp<Layer> getOwner() const {
114            return static_cast<Layer*>(Surface::getOwner().get());
115        }
116    };
117    friend class SurfaceLayer;
118
119    // -----------------------------------------------------------------------
120
121    class ClientRef {
122        ClientRef(const ClientRef& rhs);
123        ClientRef& operator = (const ClientRef& rhs);
124        mutable Mutex mLock;
125        // binder thread, page-flip thread
126        sp<SharedBufferServer> mControlBlock;
127        wp<UserClient> mUserClient;
128        int32_t mToken;
129    public:
130        ClientRef();
131        ~ClientRef();
132        int32_t getToken() const;
133        sp<UserClient> getClient() const;
134        status_t setToken(const sp<UserClient>& uc,
135                const sp<SharedBufferServer>& sharedClient, int32_t token);
136        sp<UserClient> getUserClientUnsafe() const;
137        class Access {
138            Access(const Access& rhs);
139            Access& operator = (const Access& rhs);
140            sp<UserClient> mUserClientStrongRef;
141            sp<SharedBufferServer> mControlBlock;
142        public:
143            Access(const ClientRef& ref);
144            ~Access();
145            inline SharedBufferServer* get() const { return mControlBlock.get(); }
146        };
147        friend class Access;
148    };
149
150    // -----------------------------------------------------------------------
151
152    class BufferManager {
153        static const size_t NUM_BUFFERS = 2;
154        struct BufferData {
155            sp<GraphicBuffer>   buffer;
156            Image               texture;
157        };
158        // this lock protect mBufferData[].buffer but since there
159        // is very little contention, we have only one like for
160        // the whole array, we also use it to protect mNumBuffers.
161        mutable Mutex mLock;
162        BufferData          mBufferData[SharedBufferStack::NUM_BUFFER_MAX];
163        size_t              mNumBuffers;
164        Texture             mFailoverTexture;
165        TextureManager&     mTextureManager;
166        ssize_t             mActiveBuffer;
167        bool                mFailover;
168        static status_t destroyTexture(Image* tex, EGLDisplay dpy);
169
170    public:
171        static size_t getDefaultBufferCount() { return NUM_BUFFERS; }
172        BufferManager(TextureManager& tm);
173        ~BufferManager();
174
175        // detach/attach buffer from/to given index
176        sp<GraphicBuffer> detachBuffer(size_t index);
177        status_t attachBuffer(size_t index, const sp<GraphicBuffer>& buffer);
178        // resize the number of active buffers
179        status_t resize(size_t size);
180
181        // ----------------------------------------------
182        // must be called from GL thread
183
184        // set/get active buffer index
185        status_t setActiveBufferIndex(size_t index);
186        size_t getActiveBufferIndex() const;
187        // return the active buffer
188        sp<GraphicBuffer> getActiveBuffer() const;
189        // return the active texture (or fail-over)
190        Texture getActiveTexture() const;
191        // frees resources associated with all buffers
192        status_t destroy(EGLDisplay dpy);
193        // load bitmap data into the active buffer
194        status_t loadTexture(const Region& dirty, const GGLSurface& t);
195        // make active buffer an EGLImage if needed
196        status_t initEglImage(EGLDisplay dpy,
197                const sp<GraphicBuffer>& buffer);
198
199        // ----------------------------------------------
200        // only for debugging
201        sp<GraphicBuffer> getBuffer(size_t index) const;
202    };
203
204    // -----------------------------------------------------------------------
205
206    // thread-safe
207    ClientRef mUserClientRef;
208
209    // constants
210    sp<Surface> mSurface;
211    PixelFormat mFormat;
212    const GLExtensions& mGLExtensions;
213    bool mNeedsBlending;
214    bool mNeedsDithering;
215
216    // page-flip thread (currently main thread)
217    bool mSecure;
218    Region mPostedDirtyRegion;
219
220    // page-flip thread and transaction thread (currently main thread)
221    sp<FreezeLock>  mFreezeLock;
222
223    // see threading usage in declaration
224    TextureManager mTextureManager;
225    BufferManager mBufferManager;
226
227    // binder thread, transaction thread
228    mutable Mutex mLock;
229    uint32_t mWidth;
230    uint32_t mHeight;
231    uint32_t mReqWidth;
232    uint32_t mReqHeight;
233    uint32_t mReqFormat;
234    bool mFixedSize;
235};
236
237// ---------------------------------------------------------------------------
238
239}; // namespace android
240
241#endif // ANDROID_LAYER_H
242