SurfaceFlinger.h revision 888c822c4cb6976aab9256c58bae9e17e3e55c5c 
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 <EGL/egl.h>
24#include <GLES/gl.h>
25
26#include <cutils/compiler.h>
27
28#include <utils/Atomic.h>
29#include <utils/Errors.h>
30#include <utils/KeyedVector.h>
31#include <utils/RefBase.h>
32#include <utils/SortedVector.h>
33#include <utils/threads.h>
34
35#include <binder/BinderService.h>
36#include <binder/IMemory.h>
37
38#include <ui/PixelFormat.h>
39
40#include <gui/IGraphicBufferAlloc.h>
41#include <gui/ISurfaceComposer.h>
42#include <gui/ISurfaceComposerClient.h>
43
44#include <hardware/hwcomposer_defs.h>
45
46#include <private/gui/LayerState.h>
47
48#include "Barrier.h"
49#include "MessageQueue.h"
50#include "DisplayDevice.h"
51
52#include "DisplayHardware/HWComposer.h"
53
54namespace android {
55
56// ---------------------------------------------------------------------------
57
58class Client;
59class DisplayEventConnection;
60class EventThread;
61class Layer;
62class LayerBase;
63class LayerBaseClient;
64class LayerDim;
65class LayerScreenshot;
66class SurfaceTextureClient;
67
68// ---------------------------------------------------------------------------
69
70class GraphicBufferAlloc : public BnGraphicBufferAlloc {
71public:
72    GraphicBufferAlloc();
73    virtual ~GraphicBufferAlloc();
74    virtual sp<GraphicBuffer> createGraphicBuffer(uint32_t w, uint32_t h,
75        PixelFormat format, uint32_t usage, status_t* error);
76};
77
78// ---------------------------------------------------------------------------
79
80enum {
81    eTransactionNeeded = 0x01, eTraversalNeeded = 0x02
82};
83
84class SurfaceFlinger : public BinderService<SurfaceFlinger>,
85                       public BnSurfaceComposer,
86                       private IBinder::DeathRecipient,
87                       private Thread,
88                       private HWComposer::EventHandler
89{
90public:
91    static char const* getServiceName() {
92        return "SurfaceFlinger";
93    }
94
95    SurfaceFlinger();
96
97    enum {
98        EVENT_VSYNC = HWC_EVENT_VSYNC
99    };
100
101    // post an asynchronous message to the main thread
102    status_t postMessageAsync(const sp<MessageBase>& msg, nsecs_t reltime = 0,
103        uint32_t flags = 0);
104
105    // post a synchronous message to the main thread
106    status_t postMessageSync(const sp<MessageBase>& msg, nsecs_t reltime = 0,
107        uint32_t flags = 0);
108
109    // force full composition on all displays
110    void repaintEverything();
111
112    // renders content on given display to a texture. thread-safe version.
113    status_t renderScreenToTexture(DisplayID dpy, GLuint* textureName,
114        GLfloat* uOut, GLfloat* vOut);
115
116    // renders content on given display to a texture, w/o acquiring main lock
117    status_t renderScreenToTextureLocked(DisplayID dpy, GLuint* textureName,
118        GLfloat* uOut, GLfloat* vOut);
119
120    // returns the default Display
121    const DisplayDevice& getDefaultDisplayDevice() const {
122        return getDisplayDevice(DisplayDevice::DISPLAY_ID_MAIN);
123    }
124
125    // utility function to delete a texture on the main thread
126    void deleteTextureAsync(GLuint texture);
127
128
129    // enable/disable h/w composer event
130    // TODO: this should be made accessible only to EventThread
131    void eventControl(int event, int enabled);
132
133    // called on the main thread by MessageQueue when an internal message
134    // is received
135    // TODO: this should be made accessible only to MessageQueue
136    void onMessageReceived(int32_t what);
137
138private:
139    friend class Client;
140    friend class DisplayEventConnection;
141    friend class LayerBase;
142    friend class LayerBaseClient;
143    friend class Layer;
144
145    // We're reference counted, never destroy SurfaceFlinger directly
146    virtual ~SurfaceFlinger();
147
148    /* ------------------------------------------------------------------------
149     * Internal data structures
150     */
151
152    class LayerVector : public SortedVector<sp<LayerBase> > {
153    public:
154        LayerVector();
155        LayerVector(const LayerVector& rhs);
156        virtual int do_compare(const void* lhs, const void* rhs) const;
157    };
158
159    struct DisplayDeviceState {
160        DisplayDeviceState();
161        int32_t id;
162        uint32_t layerStack;
163        Rect viewport;
164        Rect frame;
165        uint8_t orientation;
166        inline bool operator < (const DisplayDeviceState& rhs) const {
167            return id < rhs.id;
168        }
169    };
170
171    struct State {
172        LayerVector layersSortedByZ;
173        KeyedVector<int32_t, DisplayDeviceState> displays;
174    };
175
176    /* ------------------------------------------------------------------------
177     * IBinder interface
178     */
179    virtual status_t onTransact(uint32_t code, const Parcel& data,
180        Parcel* reply, uint32_t flags);
181    virtual status_t dump(int fd, const Vector<String16>& args);
182
183    /* ------------------------------------------------------------------------
184     * ISurfaceComposer interface
185     */
186    virtual sp<ISurfaceComposerClient> createConnection();
187    virtual sp<IGraphicBufferAlloc> createGraphicBufferAlloc();
188    virtual void setTransactionState(const Vector<ComposerState>& state,
189            const Vector<DisplayState>& displays, uint32_t flags);
190    virtual void bootFinished();
191    virtual bool authenticateSurfaceTexture(
192        const sp<ISurfaceTexture>& surface) const;
193    virtual sp<IDisplayEventConnection> createDisplayEventConnection();
194    virtual status_t captureScreen(DisplayID dpy, sp<IMemoryHeap>* heap,
195        uint32_t* width, uint32_t* height, PixelFormat* format,
196        uint32_t reqWidth, uint32_t reqHeight, uint32_t minLayerZ,
197        uint32_t maxLayerZ);
198    // called when screen needs to turn off
199    virtual void blank();
200    // called when screen is turning back on
201    virtual void unblank();
202    virtual status_t getDisplayInfo(DisplayID dpy, DisplayInfo* info);
203    virtual void connectDisplay(const sp<ISurfaceTexture> display);
204
205    /* ------------------------------------------------------------------------
206     * DeathRecipient interface
207     */
208    virtual void binderDied(const wp<IBinder>& who);
209
210    /* ------------------------------------------------------------------------
211     * Thread interface
212     */
213    virtual bool threadLoop();
214    virtual status_t readyToRun();
215    virtual void onFirstRef();
216
217    /* ------------------------------------------------------------------------
218     * HWComposer::EventHandler interface
219     */
220    virtual void onVSyncReceived(int dpy, nsecs_t timestamp);
221
222    /* ------------------------------------------------------------------------
223     * Message handling
224     */
225    void waitForEvent();
226    void signalTransaction();
227    void signalLayerUpdate();
228    void signalRefresh();
229
230    // called on the main thread in response to screenReleased()
231    void onScreenReleased();
232    // called on the main thread in response to screenAcquired()
233    void onScreenAcquired();
234
235    void handleMessageTransaction();
236    void handleMessageInvalidate();
237    void handleMessageRefresh();
238
239    void handleTransaction(uint32_t transactionFlags);
240    void handleTransactionLocked(uint32_t transactionFlags);
241
242    /* handlePageFilp: this is were we latch a new buffer
243     * if available and compute the dirty region.
244     */
245    void handlePageFlip();
246
247    void handleRefresh();
248    void handleRepaint(const DisplayDevice& hw, const Region& dirtyRegion);
249
250    /* ------------------------------------------------------------------------
251     * Transactions
252     */
253    uint32_t getTransactionFlags(uint32_t flags);
254    uint32_t peekTransactionFlags(uint32_t flags);
255    uint32_t setTransactionFlags(uint32_t flags);
256    void commitTransaction();
257    uint32_t setClientStateLocked(const sp<Client>& client,
258        const layer_state_t& s);
259
260    /* ------------------------------------------------------------------------
261     * Layer management
262     */
263    sp<ISurface> createLayer(ISurfaceComposerClient::surface_data_t* params,
264        const String8& name, const sp<Client>& client, DisplayID display,
265        uint32_t w, uint32_t h, PixelFormat format, uint32_t flags);
266
267    sp<Layer> createNormalLayer(const sp<Client>& client, DisplayID display,
268        uint32_t w, uint32_t h, uint32_t flags, PixelFormat& format);
269
270    sp<LayerDim> createDimLayer(const sp<Client>& client, DisplayID display,
271        uint32_t w, uint32_t h, uint32_t flags);
272
273    sp<LayerScreenshot> createScreenshotLayer(const sp<Client>& client,
274        DisplayID display, uint32_t w, uint32_t h, uint32_t flags);
275
276    // called in response to the window-manager calling
277    // ISurfaceComposerClient::destroySurface()
278    // The specified layer is first placed in a purgatory list
279    // until all references from the client are released.
280    status_t onLayerRemoved(const sp<Client>& client, SurfaceID sid);
281
282    // called when all clients have released all their references to
283    // this layer meaning it is entirely safe to destroy all
284    // resources associated to this layer.
285    status_t onLayerDestroyed(const wp<LayerBaseClient>& layer);
286
287    // remove a layer from SurfaceFlinger immediately
288    status_t removeLayer(const sp<LayerBase>& layer);
289
290    // add a layer to SurfaceFlinger
291    ssize_t addClientLayer(const sp<Client>& client,
292        const sp<LayerBaseClient>& lbc);
293
294    status_t removeLayer_l(const sp<LayerBase>& layer);
295    status_t purgatorizeLayer_l(const sp<LayerBase>& layer);
296
297    /* ------------------------------------------------------------------------
298     * Boot animation, on/off animations and screen capture
299     */
300
301    void startBootAnim();
302
303    status_t captureScreenImplLocked(DisplayID dpy, sp<IMemoryHeap>* heap,
304        uint32_t* width, uint32_t* height, PixelFormat* format,
305        uint32_t reqWidth, uint32_t reqHeight, uint32_t minLayerZ,
306        uint32_t maxLayerZ);
307
308    /* ------------------------------------------------------------------------
309     * EGL
310     */
311    static status_t selectConfigForPixelFormat(EGLDisplay dpy,
312        EGLint const* attrs, PixelFormat format, EGLConfig* outConfig);
313    static EGLConfig selectEGLConfig(EGLDisplay disp, EGLint visualId);
314    static EGLContext createGLContext(EGLDisplay disp, EGLConfig config);
315    void initializeGL(EGLDisplay display, EGLSurface surface);
316    uint32_t getMaxTextureSize() const;
317    uint32_t getMaxViewportDims() const;
318
319    /* ------------------------------------------------------------------------
320     * Display and layer stack management
321     */
322    const DisplayDevice& getDisplayDevice(DisplayID dpy) const {
323        return mDisplays.valueFor(dpy);
324    }
325    DisplayDevice& getDisplayDevice(DisplayID dpy) {
326        return mDisplays.editValueFor(dpy);
327    }
328
329    // mark a region of a layer stack dirty. this updates the dirty
330    // region of all screens presenting this layer stack.
331    void invalidateLayerStack(uint32_t layerStack, const Region& dirty);
332
333    /* ------------------------------------------------------------------------
334     * H/W composer
335     */
336
337    HWComposer& getHwComposer() const { return *mHwc; }
338
339    /* ------------------------------------------------------------------------
340     * Compositing
341     */
342    void invalidateHwcGeometry();
343    void computeVisibleRegions(const LayerVector& currentLayers,
344            uint32_t layerStack,
345            Region& dirtyRegion, Region& opaqueRegion);
346    void postFramebuffer();
347    void composeSurfaces(const DisplayDevice& hw, const Region& dirty);
348    void drawWormhole(const Region& region) const;
349    GLuint getProtectedTexName() const {
350        return mProtectedTexName;
351    }
352
353    /* ------------------------------------------------------------------------
354     * Debugging & dumpsys
355     */
356    void debugFlashRegions(const DisplayDevice& hw, const Region& dirtyReg);
357    void listLayersLocked(const Vector<String16>& args, size_t& index,
358        String8& result, char* buffer, size_t SIZE) const;
359    void dumpStatsLocked(const Vector<String16>& args, size_t& index,
360        String8& result, char* buffer, size_t SIZE) const;
361    void clearStatsLocked(const Vector<String16>& args, size_t& index,
362        String8& result, char* buffer, size_t SIZE) const;
363    void dumpAllLocked(String8& result, char* buffer, size_t SIZE) const;
364
365    /* ------------------------------------------------------------------------
366     * Attributes
367     */
368
369    // access must be protected by mStateLock
370    mutable Mutex mStateLock;
371    State mCurrentState;
372    volatile int32_t mTransactionFlags;
373    Condition mTransactionCV;
374    SortedVector<sp<LayerBase> > mLayerPurgatory;
375    bool mTransationPending;
376    Vector<sp<LayerBase> > mLayersPendingRemoval;
377
378    // protected by mStateLock (but we could use another lock)
379    bool mLayersRemoved;
380
381    // access must be protected by mInvalidateLock
382    volatile int32_t mRepaintEverything;
383
384    // constant members (no synchronization needed for access)
385    HWComposer* mHwc;
386    GLuint mProtectedTexName;
387    nsecs_t mBootTime;
388    sp<EventThread> mEventThread;
389    GLint mMaxViewportDims[2];
390    GLint mMaxTextureSize;
391    EGLContext mEGLContext;
392    EGLConfig mEGLConfig;
393    EGLDisplay mEGLDisplay;
394
395    // Can only accessed from the main thread, these members
396    // don't need synchronization
397    State mDrawingState;
398    bool mVisibleRegionsDirty;
399    bool mHwWorkListDirty;
400    DefaultKeyedVector<int32_t, DisplayDevice> mDisplays;
401
402    // don't use a lock for these, we don't care
403    int mDebugRegion;
404    int mDebugDDMS;
405    int mDebugDisableHWC;
406    int mDebugDisableTransformHint;
407    volatile nsecs_t mDebugInSwapBuffers;
408    nsecs_t mLastSwapBufferTime;
409    volatile nsecs_t mDebugInTransaction;
410    nsecs_t mLastTransactionTime;
411    bool mBootFinished;
412
413    // these are thread safe
414    mutable MessageQueue mEventQueue;
415    mutable Barrier mReadyToRunBarrier;
416
417    // protected by mDestroyedLayerLock;
418    mutable Mutex mDestroyedLayerLock;
419    Vector<LayerBase const *> mDestroyedLayers;
420
421    /* ------------------------------------------------------------------------
422     * Feature prototyping
423     */
424
425    EGLSurface getExternalDisplaySurface() const;
426    sp<SurfaceTextureClient> mExternalDisplayNativeWindow;
427    EGLSurface mExternalDisplaySurface;
428};
429
430// ---------------------------------------------------------------------------
431}; // namespace android
432
433#endif // ANDROID_SURFACE_FLINGER_H
434