SurfaceFlinger.h revision 99ed22412db547c59d3da08114d9d5a586442b30 
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_SURFACE_FLINGER_H
18#define ANDROID_SURFACE_FLINGER_H
19
20#include <stdint.h>
21#include <sys/types.h>
22
23#include <cutils/compiler.h>
24
25#include <utils/Atomic.h>
26#include <utils/Errors.h>
27#include <utils/KeyedVector.h>
28#include <utils/RefBase.h>
29#include <utils/SortedVector.h>
30#include <utils/threads.h>
31
32#include <binder/BinderService.h>
33#include <binder/IMemory.h>
34
35#include <ui/PixelFormat.h>
36#include <surfaceflinger/IGraphicBufferAlloc.h>
37#include <surfaceflinger/ISurfaceComposer.h>
38#include <surfaceflinger/ISurfaceComposerClient.h>
39
40#include "Barrier.h"
41#include "Layer.h"
42
43#include "MessageQueue.h"
44
45namespace android {
46
47// ---------------------------------------------------------------------------
48
49class Client;
50class DisplayHardware;
51class DisplayEventConnection;
52class EventThread;
53class Layer;
54class LayerDim;
55class LayerScreenshot;
56struct surface_flinger_cblk_t;
57
58// ---------------------------------------------------------------------------
59
60class Client : public BnSurfaceComposerClient
61{
62public:
63        Client(const sp<SurfaceFlinger>& flinger);
64        ~Client();
65
66    status_t initCheck() const;
67
68    // protected by SurfaceFlinger::mStateLock
69    size_t attachLayer(const sp<LayerBaseClient>& layer);
70    void detachLayer(const LayerBaseClient* layer);
71    sp<LayerBaseClient> getLayerUser(int32_t i) const;
72
73private:
74    // ISurfaceComposerClient interface
75    virtual sp<ISurface> createSurface(
76            surface_data_t* params, const String8& name,
77            DisplayID display, uint32_t w, uint32_t h,PixelFormat format,
78            uint32_t flags);
79    virtual status_t destroySurface(SurfaceID surfaceId);
80    virtual status_t onTransact(
81        uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags);
82
83    // constant
84    sp<SurfaceFlinger> mFlinger;
85
86    // protected by mLock
87    DefaultKeyedVector< size_t, wp<LayerBaseClient> > mLayers;
88    size_t mNameGenerator;
89
90    // thread-safe
91    mutable Mutex mLock;
92};
93
94class GraphicBufferAlloc : public BnGraphicBufferAlloc
95{
96public:
97    GraphicBufferAlloc();
98    virtual ~GraphicBufferAlloc();
99    virtual sp<GraphicBuffer> createGraphicBuffer(uint32_t w, uint32_t h,
100        PixelFormat format, uint32_t usage, status_t* error);
101};
102
103// ---------------------------------------------------------------------------
104
105class GraphicPlane
106{
107public:
108    static status_t orientationToTransfrom(int orientation, int w, int h,
109            Transform* tr);
110
111                                GraphicPlane();
112                                ~GraphicPlane();
113
114        bool                    initialized() const;
115
116        void                    setDisplayHardware(DisplayHardware *);
117        status_t                setOrientation(int orientation);
118        int                     getOrientation() const { return mOrientation; }
119        int                     getWidth() const;
120        int                     getHeight() const;
121
122        const DisplayHardware&  displayHardware() const;
123        DisplayHardware&        editDisplayHardware();
124        const Transform&        transform() const;
125        EGLDisplay              getEGLDisplay() const;
126
127private:
128                                GraphicPlane(const GraphicPlane&);
129        GraphicPlane            operator = (const GraphicPlane&);
130
131        DisplayHardware*        mHw;
132        Transform               mGlobalTransform;
133        Transform               mDisplayTransform;
134        int                     mOrientation;
135        float                   mDisplayWidth;
136        float                   mDisplayHeight;
137        int                     mWidth;
138        int                     mHeight;
139};
140
141// ---------------------------------------------------------------------------
142
143enum {
144    eTransactionNeeded      = 0x01,
145    eTraversalNeeded        = 0x02
146};
147
148class SurfaceFlinger :
149        public BinderService<SurfaceFlinger>,
150        public BnSurfaceComposer,
151        public IBinder::DeathRecipient,
152        protected Thread
153{
154public:
155    static char const* getServiceName() { return "SurfaceFlinger"; }
156
157                    SurfaceFlinger();
158    virtual         ~SurfaceFlinger();
159            void    init();
160
161    virtual status_t onTransact(
162        uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags);
163
164    virtual status_t dump(int fd, const Vector<String16>& args);
165
166    // ISurfaceComposer interface
167    virtual sp<ISurfaceComposerClient>  createConnection();
168    virtual sp<IGraphicBufferAlloc>     createGraphicBufferAlloc();
169    virtual sp<IMemoryHeap>             getCblk() const;
170    virtual void                        bootFinished();
171    virtual void                        setTransactionState(const Vector<ComposerState>& state,
172                                                            int orientation, uint32_t flags);
173    virtual int                         setOrientation(DisplayID dpy, int orientation, uint32_t flags);
174    virtual bool                        authenticateSurfaceTexture(const sp<ISurfaceTexture>& surface) const;
175    virtual sp<IDisplayEventConnection> createDisplayEventConnection();
176
177    virtual status_t captureScreen(DisplayID dpy,
178            sp<IMemoryHeap>* heap,
179            uint32_t* width, uint32_t* height,
180            PixelFormat* format, uint32_t reqWidth, uint32_t reqHeight,
181            uint32_t minLayerZ, uint32_t maxLayerZ);
182
183    virtual status_t                    turnElectronBeamOff(int32_t mode);
184    virtual status_t                    turnElectronBeamOn(int32_t mode);
185
186            void                        screenReleased(DisplayID dpy);
187            void                        screenAcquired(DisplayID dpy);
188
189            status_t renderScreenToTexture(DisplayID dpy,
190                    GLuint* textureName, GLfloat* uOut, GLfloat* vOut);
191            status_t renderScreenToTextureLocked(DisplayID dpy,
192                    GLuint* textureName, GLfloat* uOut, GLfloat* vOut);
193
194            status_t postMessageAsync(const sp<MessageBase>& msg,
195                    nsecs_t reltime=0, uint32_t flags = 0);
196
197            status_t postMessageSync(const sp<MessageBase>& msg,
198                    nsecs_t reltime=0, uint32_t flags = 0);
199
200    status_t removeLayer(const sp<LayerBase>& layer);
201    status_t addLayer(const sp<LayerBase>& layer);
202    status_t invalidateLayerVisibility(const sp<LayerBase>& layer);
203    void invalidateHwcGeometry();
204
205    sp<Layer> getLayer(const sp<ISurface>& sur) const;
206
207    GLuint getProtectedTexName() const { return mProtectedTexName; }
208
209
210    class MessageDestroyGLTexture : public MessageBase {
211        GLuint texture;
212    public:
213        MessageDestroyGLTexture(GLuint texture) : texture(texture) { }
214        virtual bool handler() {
215            glDeleteTextures(1, &texture);
216            return true;
217        }
218    };
219
220
221private:
222    // DeathRecipient interface
223    virtual void binderDied(const wp<IBinder>& who);
224
225private:
226    friend class Client;
227    friend class DisplayEventConnection;
228    friend class LayerBase;
229    friend class LayerBaseClient;
230    friend class Layer;
231
232    sp<ISurface> createSurface(
233            ISurfaceComposerClient::surface_data_t* params,
234            const String8& name,
235            const sp<Client>& client,
236            DisplayID display, uint32_t w, uint32_t h, PixelFormat format,
237            uint32_t flags);
238
239    sp<Layer> createNormalSurface(
240            const sp<Client>& client, DisplayID display,
241            uint32_t w, uint32_t h, uint32_t flags,
242            PixelFormat& format);
243
244    sp<LayerDim> createDimSurface(
245            const sp<Client>& client, DisplayID display,
246            uint32_t w, uint32_t h, uint32_t flags);
247
248    sp<LayerScreenshot> createScreenshotSurface(
249            const sp<Client>& client, DisplayID display,
250            uint32_t w, uint32_t h, uint32_t flags);
251
252    status_t removeSurface(const sp<Client>& client, SurfaceID sid);
253    status_t destroySurface(const wp<LayerBaseClient>& layer);
254    uint32_t setClientStateLocked(const sp<Client>& client, const layer_state_t& s);
255
256    class LayerVector : public SortedVector< sp<LayerBase> > {
257    public:
258        LayerVector() { }
259        LayerVector(const LayerVector& rhs) : SortedVector< sp<LayerBase> >(rhs) { }
260        virtual int do_compare(const void* lhs, const void* rhs) const {
261            const sp<LayerBase>& l(*reinterpret_cast<const sp<LayerBase>*>(lhs));
262            const sp<LayerBase>& r(*reinterpret_cast<const sp<LayerBase>*>(rhs));
263            // sort layers by Z order
264            uint32_t lz = l->currentState().z;
265            uint32_t rz = r->currentState().z;
266            // then by sequence, so we get a stable ordering
267            return (lz != rz) ? (lz - rz) : (l->sequence - r->sequence);
268        }
269    };
270
271    struct State {
272        State() {
273            orientation = ISurfaceComposer::eOrientationDefault;
274        }
275        LayerVector     layersSortedByZ;
276        uint8_t         orientation;
277        uint8_t         orientationFlags;
278    };
279
280    virtual bool        threadLoop();
281    virtual status_t    readyToRun();
282    virtual void        onFirstRef();
283
284public:     // hack to work around gcc 4.0.3 bug
285    const GraphicPlane&     graphicPlane(int dpy) const;
286          GraphicPlane&     graphicPlane(int dpy);
287          void              signalEvent();
288          void              repaintEverything();
289
290private:
291            void        waitForEvent();
292            void        handleConsoleEvents();
293            void        handleTransaction(uint32_t transactionFlags);
294            void        handleTransactionLocked(uint32_t transactionFlags);
295
296            void        computeVisibleRegions(
297                            const LayerVector& currentLayers,
298                            Region& dirtyRegion,
299                            Region& wormholeRegion);
300
301            void        handlePageFlip();
302            bool        lockPageFlip(const LayerVector& currentLayers);
303            void        unlockPageFlip(const LayerVector& currentLayers);
304            void        handleWorkList();
305            void        handleRepaint();
306            void        postFramebuffer();
307            void        setupHardwareComposer(Region& dirtyInOut);
308            void        composeSurfaces(const Region& dirty);
309
310
311            void        setInvalidateRegion(const Region& reg);
312            Region      getAndClearInvalidateRegion();
313
314            ssize_t     addClientLayer(const sp<Client>& client,
315                    const sp<LayerBaseClient>& lbc);
316            status_t    addLayer_l(const sp<LayerBase>& layer);
317            status_t    removeLayer_l(const sp<LayerBase>& layer);
318            status_t    purgatorizeLayer_l(const sp<LayerBase>& layer);
319
320            uint32_t    getTransactionFlags(uint32_t flags);
321            uint32_t    peekTransactionFlags(uint32_t flags);
322            uint32_t    setTransactionFlags(uint32_t flags);
323            void        commitTransaction();
324
325
326            status_t captureScreenImplLocked(DisplayID dpy,
327                    sp<IMemoryHeap>* heap,
328                    uint32_t* width, uint32_t* height, PixelFormat* format,
329                    uint32_t reqWidth, uint32_t reqHeight,
330                    uint32_t minLayerZ, uint32_t maxLayerZ);
331
332            status_t turnElectronBeamOffImplLocked(int32_t mode);
333            status_t turnElectronBeamOnImplLocked(int32_t mode);
334            status_t electronBeamOffAnimationImplLocked();
335            status_t electronBeamOnAnimationImplLocked();
336
337            void        debugFlashRegions();
338            void        debugShowFPS() const;
339            void        drawWormhole() const;
340
341
342    mutable     MessageQueue    mEventQueue;
343
344                // access must be protected by mStateLock
345    mutable     Mutex                   mStateLock;
346                State                   mCurrentState;
347    volatile    int32_t                 mTransactionFlags;
348                Condition               mTransactionCV;
349                SortedVector< sp<LayerBase> > mLayerPurgatory;
350                bool                    mTransationPending;
351                Vector< sp<LayerBase> > mLayersPendingRemoval;
352
353                // protected by mStateLock (but we could use another lock)
354                GraphicPlane                mGraphicPlanes[1];
355                bool                        mLayersRemoved;
356                DefaultKeyedVector< wp<IBinder>, wp<Layer> > mLayerMap;
357
358                // access must be protected by mInvalidateLock
359    mutable     Mutex                       mInvalidateLock;
360                Region                      mInvalidateRegion;
361
362                // constant members (no synchronization needed for access)
363                sp<IMemoryHeap>             mServerHeap;
364                surface_flinger_cblk_t*     mServerCblk;
365                GLuint                      mWormholeTexName;
366                GLuint                      mProtectedTexName;
367                nsecs_t                     mBootTime;
368                sp<EventThread>             mEventThread;
369
370                // Can only accessed from the main thread, these members
371                // don't need synchronization
372                State                       mDrawingState;
373                Region                      mDirtyRegion;
374                Region                      mDirtyRegionRemovedLayer;
375                Region                      mSwapRegion;
376                Region                      mWormholeRegion;
377                bool                        mVisibleRegionsDirty;
378                bool                        mHwWorkListDirty;
379                int32_t                     mElectronBeamAnimationMode;
380                Vector< sp<LayerBase> >     mVisibleLayersSortedByZ;
381
382
383                // don't use a lock for these, we don't care
384                int                         mDebugRegion;
385                int                         mDebugBackground;
386                int                         mDebugDDMS;
387                int                         mDebugDisableHWC;
388                int                         mDebugDisableTransformHint;
389                volatile nsecs_t            mDebugInSwapBuffers;
390                nsecs_t                     mLastSwapBufferTime;
391                volatile nsecs_t            mDebugInTransaction;
392                nsecs_t                     mLastTransactionTime;
393                bool                        mBootFinished;
394
395                // these are thread safe
396    mutable     Barrier                     mReadyToRunBarrier;
397
398
399                // protected by mDestroyedLayerLock;
400    mutable     Mutex                       mDestroyedLayerLock;
401                Vector<LayerBase const *>   mDestroyedLayers;
402
403                // atomic variables
404                enum {
405                    eConsoleReleased = 1,
406                    eConsoleAcquired = 2
407                };
408   volatile     int32_t                     mConsoleSignals;
409
410   // only written in the main thread, only read in other threads
411   volatile     int32_t                     mSecureFrameBuffer;
412};
413
414// ---------------------------------------------------------------------------
415}; // namespace android
416
417#endif // ANDROID_SURFACE_FLINGER_H
418