SurfaceFlinger.h revision 52bbb1ae239c8a4d05543a23fa8c08467d09c3b2
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 51#include "DisplayHardware/HWComposer.h" 52 53namespace android { 54 55// --------------------------------------------------------------------------- 56 57class Client; 58class DisplayEventConnection; 59class DisplayHardware; 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 DisplayHardware& getDefaultDisplayHardware() const { 122 return getDisplayHardware(0); 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 State { 160 State(); 161 LayerVector layersSortedByZ; 162 uint8_t orientation; 163 uint8_t orientationFlags; 164 }; 165 166 /* ------------------------------------------------------------------------ 167 * IBinder interface 168 */ 169 virtual status_t onTransact(uint32_t code, const Parcel& data, 170 Parcel* reply, uint32_t flags); 171 virtual status_t dump(int fd, const Vector<String16>& args); 172 173 /* ------------------------------------------------------------------------ 174 * ISurfaceComposer interface 175 */ 176 virtual sp<ISurfaceComposerClient> createConnection(); 177 virtual sp<IGraphicBufferAlloc> createGraphicBufferAlloc(); 178 virtual void bootFinished(); 179 virtual void setTransactionState(const Vector<ComposerState>& state, 180 const Vector<DisplayState>& displays, uint32_t flags); 181 virtual bool authenticateSurfaceTexture( 182 const sp<ISurfaceTexture>& surface) const; 183 virtual sp<IDisplayEventConnection> createDisplayEventConnection(); 184 virtual status_t captureScreen(DisplayID dpy, sp<IMemoryHeap>* heap, 185 uint32_t* width, uint32_t* height, PixelFormat* format, 186 uint32_t reqWidth, uint32_t reqHeight, uint32_t minLayerZ, 187 uint32_t maxLayerZ); 188 virtual status_t turnElectronBeamOff(int32_t mode); 189 virtual status_t turnElectronBeamOn(int32_t mode); 190 // called when screen needs to turn off 191 virtual void blank(); 192 // called when screen is turning back on 193 virtual void unblank(); 194 virtual status_t getDisplayInfo(DisplayID dpy, DisplayInfo* info); 195 virtual void connectDisplay(const sp<ISurfaceTexture> display); 196 197 /* ------------------------------------------------------------------------ 198 * DeathRecipient interface 199 */ 200 virtual void binderDied(const wp<IBinder>& who); 201 202 /* ------------------------------------------------------------------------ 203 * Thread interface 204 */ 205 virtual bool threadLoop(); 206 virtual status_t readyToRun(); 207 virtual void onFirstRef(); 208 209 /* ------------------------------------------------------------------------ 210 * HWComposer::EventHandler interface 211 */ 212 virtual void onVSyncReceived(int dpy, nsecs_t timestamp); 213 214 /* ------------------------------------------------------------------------ 215 * Message handling 216 */ 217 void waitForEvent(); 218 void signalTransaction(); 219 void signalLayerUpdate(); 220 void signalRefresh(); 221 222 // called on the main thread in response to screenReleased() 223 void onScreenReleased(); 224 // called on the main thread in response to screenAcquired() 225 void onScreenAcquired(); 226 227 void handleMessageTransaction(); 228 void handleMessageInvalidate(); 229 void handleMessageRefresh(); 230 231 void handleTransaction(uint32_t transactionFlags); 232 void handleTransactionLocked(uint32_t transactionFlags); 233 234 /* handlePageFilp: this is were we latch a new buffer 235 * if available and compute the dirty region. 236 */ 237 void handlePageFlip(); 238 239 void handleRefresh(); 240 void handleRepaint(const DisplayHardware& hw, const Region& dirtyRegion); 241 242 /* ------------------------------------------------------------------------ 243 * Transactions 244 */ 245 uint32_t getTransactionFlags(uint32_t flags); 246 uint32_t peekTransactionFlags(uint32_t flags); 247 uint32_t setTransactionFlags(uint32_t flags); 248 void commitTransaction(); 249 uint32_t setClientStateLocked(const sp<Client>& client, 250 const layer_state_t& s); 251 252 /* ------------------------------------------------------------------------ 253 * Layer management 254 */ 255 sp<ISurface> createLayer(ISurfaceComposerClient::surface_data_t* params, 256 const String8& name, const sp<Client>& client, DisplayID display, 257 uint32_t w, uint32_t h, PixelFormat format, uint32_t flags); 258 259 sp<Layer> createNormalLayer(const sp<Client>& client, DisplayID display, 260 uint32_t w, uint32_t h, uint32_t flags, PixelFormat& format); 261 262 sp<LayerDim> createDimLayer(const sp<Client>& client, DisplayID display, 263 uint32_t w, uint32_t h, uint32_t flags); 264 265 sp<LayerScreenshot> createScreenshotLayer(const sp<Client>& client, 266 DisplayID display, uint32_t w, uint32_t h, uint32_t flags); 267 268 // called in response to the window-manager calling 269 // ISurfaceComposerClient::destroySurface() 270 // The specified layer is first placed in a purgatory list 271 // until all references from the client are released. 272 status_t onLayerRemoved(const sp<Client>& client, SurfaceID sid); 273 274 // called when all clients have released all their references to 275 // this layer meaning it is entirely safe to destroy all 276 // resources associated to this layer. 277 status_t onLayerDestroyed(const wp<LayerBaseClient>& layer); 278 279 // remove a layer from SurfaceFlinger immediately 280 status_t removeLayer(const sp<LayerBase>& layer); 281 282 // add a layer to SurfaceFlinger 283 ssize_t addClientLayer(const sp<Client>& client, 284 const sp<LayerBaseClient>& lbc); 285 286 status_t removeLayer_l(const sp<LayerBase>& layer); 287 status_t purgatorizeLayer_l(const sp<LayerBase>& layer); 288 289 /* ------------------------------------------------------------------------ 290 * Boot animation, on/off animations and screen capture 291 */ 292 293 void startBootAnim(); 294 295 status_t captureScreenImplLocked(DisplayID dpy, sp<IMemoryHeap>* heap, 296 uint32_t* width, uint32_t* height, PixelFormat* format, 297 uint32_t reqWidth, uint32_t reqHeight, uint32_t minLayerZ, 298 uint32_t maxLayerZ); 299 300 status_t turnElectronBeamOffImplLocked(int32_t mode); 301 status_t turnElectronBeamOnImplLocked(int32_t mode); 302 status_t electronBeamOffAnimationImplLocked(); 303 status_t electronBeamOnAnimationImplLocked(); 304 305 /* ------------------------------------------------------------------------ 306 * EGL 307 */ 308 static status_t selectConfigForPixelFormat(EGLDisplay dpy, 309 EGLint const* attrs, PixelFormat format, EGLConfig* outConfig); 310 static EGLConfig selectEGLConfig(EGLDisplay disp, EGLint visualId); 311 static EGLContext createGLContext(EGLDisplay disp, EGLConfig config); 312 void initializeGL(EGLDisplay display, EGLSurface surface); 313 uint32_t getMaxTextureSize() const; 314 uint32_t getMaxViewportDims() const; 315 316 /* ------------------------------------------------------------------------ 317 * Display and layer stack management 318 */ 319 const DisplayHardware& getDisplayHardware(DisplayID dpy) const { 320 return *mDisplayHardwares[dpy]; 321 } 322 323 // mark a region of a layer stack dirty. this updates the dirty 324 // region of all screens presenting this layer stack. 325 void invalidateLayerStack(uint32_t layerStack, const Region& dirty); 326 327 /* ------------------------------------------------------------------------ 328 * H/W composer 329 */ 330 331 HWComposer& getHwComposer() const { return *mHwc; } 332 333 /* ------------------------------------------------------------------------ 334 * Compositing 335 */ 336 void invalidateHwcGeometry(); 337 void computeVisibleRegions(const LayerVector& currentLayers, 338 uint32_t layerStack, 339 Region& dirtyRegion, Region& opaqueRegion); 340 void postFramebuffer(); 341 void composeSurfaces(const DisplayHardware& hw, const Region& dirty); 342 void drawWormhole(const Region& region) const; 343 GLuint getProtectedTexName() const { 344 return mProtectedTexName; 345 } 346 347 /* ------------------------------------------------------------------------ 348 * Debugging & dumpsys 349 */ 350 void debugFlashRegions(const DisplayHardware& hw, const Region& dirtyReg); 351 void listLayersLocked(const Vector<String16>& args, size_t& index, 352 String8& result, char* buffer, size_t SIZE) const; 353 void dumpStatsLocked(const Vector<String16>& args, size_t& index, 354 String8& result, char* buffer, size_t SIZE) const; 355 void clearStatsLocked(const Vector<String16>& args, size_t& index, 356 String8& result, char* buffer, size_t SIZE) const; 357 void dumpAllLocked(String8& result, char* buffer, size_t SIZE) const; 358 359 /* ------------------------------------------------------------------------ 360 * Attributes 361 */ 362 363 // access must be protected by mStateLock 364 mutable Mutex mStateLock; 365 State mCurrentState; 366 volatile int32_t mTransactionFlags; 367 Condition mTransactionCV; 368 SortedVector<sp<LayerBase> > mLayerPurgatory; 369 bool mTransationPending; 370 Vector<sp<LayerBase> > mLayersPendingRemoval; 371 372 // protected by mStateLock (but we could use another lock) 373 DisplayHardware* mDisplayHardwares[1]; 374 bool mLayersRemoved; 375 376 // access must be protected by mInvalidateLock 377 volatile int32_t mRepaintEverything; 378 379 // constant members (no synchronization needed for access) 380 HWComposer* mHwc; 381 GLuint mProtectedTexName; 382 nsecs_t mBootTime; 383 sp<EventThread> mEventThread; 384 GLint mMaxViewportDims[2]; 385 GLint mMaxTextureSize; 386 EGLContext mEGLContext; 387 EGLConfig mEGLConfig; 388 EGLDisplay mEGLDisplay; 389 390 // Can only accessed from the main thread, these members 391 // don't need synchronization 392 State mDrawingState; 393 bool mVisibleRegionsDirty; 394 bool mHwWorkListDirty; 395 int32_t mElectronBeamAnimationMode; 396 397 // don't use a lock for these, we don't care 398 int mDebugRegion; 399 int mDebugDDMS; 400 int mDebugDisableHWC; 401 int mDebugDisableTransformHint; 402 volatile nsecs_t mDebugInSwapBuffers; 403 nsecs_t mLastSwapBufferTime; 404 volatile nsecs_t mDebugInTransaction; 405 nsecs_t mLastTransactionTime; 406 bool mBootFinished; 407 408 // these are thread safe 409 mutable MessageQueue mEventQueue; 410 mutable Barrier mReadyToRunBarrier; 411 412 // protected by mDestroyedLayerLock; 413 mutable Mutex mDestroyedLayerLock; 414 Vector<LayerBase const *> mDestroyedLayers; 415 416 /* ------------------------------------------------------------------------ 417 * Feature prototyping 418 */ 419 420 EGLSurface getExternalDisplaySurface() const; 421 sp<SurfaceTextureClient> mExternalDisplayNativeWindow; 422 EGLSurface mExternalDisplaySurface; 423}; 424 425// --------------------------------------------------------------------------- 426}; // namespace android 427 428#endif // ANDROID_SURFACE_FLINGER_H 429