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