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