Layer.h revision 1748719ea1b69cc7ad111d8c6149d692b9f056f8
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 <EGL/egl.h> 24#include <EGL/eglext.h> 25 26#include <utils/RefBase.h> 27#include <utils/String8.h> 28#include <utils/Timers.h> 29 30#include <ui/FrameStats.h> 31#include <ui/GraphicBuffer.h> 32#include <ui/PixelFormat.h> 33#include <ui/Region.h> 34 35#include <gui/ISurfaceComposerClient.h> 36 37#include <private/gui/LayerState.h> 38 39#include <list> 40 41#include "FrameTracker.h" 42#include "Client.h" 43#include "MonitoredProducer.h" 44#include "SurfaceFlinger.h" 45#include "SurfaceFlingerConsumer.h" 46#include "Transform.h" 47 48#include "DisplayHardware/HWComposer.h" 49#include "DisplayHardware/FloatRect.h" 50#include "RenderEngine/Mesh.h" 51#include "RenderEngine/Texture.h" 52 53namespace android { 54 55// --------------------------------------------------------------------------- 56 57class Client; 58class Colorizer; 59class DisplayDevice; 60class GraphicBuffer; 61class SurfaceFlinger; 62 63// --------------------------------------------------------------------------- 64 65/* 66 * A new BufferQueue and a new SurfaceFlingerConsumer are created when the 67 * Layer is first referenced. 68 * 69 * This also implements onFrameAvailable(), which notifies SurfaceFlinger 70 * that new data has arrived. 71 */ 72class Layer : public SurfaceFlingerConsumer::ContentsChangedListener { 73 static int32_t sSequence; 74 75public: 76 mutable bool contentDirty; 77 // regions below are in window-manager space 78 Region visibleRegion; 79 Region coveredRegion; 80 Region visibleNonTransparentRegion; 81 Region surfaceDamageRegion; 82 83 // Layer serial number. This gives layers an explicit ordering, so we 84 // have a stable sort order when their layer stack and Z-order are 85 // the same. 86 int32_t sequence; 87 88 enum { // flags for doTransaction() 89 eDontUpdateGeometryState = 0x00000001, 90 eVisibleRegion = 0x00000002, 91 }; 92 93 struct Geometry { 94 uint32_t w; 95 uint32_t h; 96 Transform transform; 97 98 inline bool operator ==(const Geometry& rhs) const { 99 return (w == rhs.w && h == rhs.h) && 100 (transform.tx() == rhs.transform.tx()) && 101 (transform.ty() == rhs.transform.ty()); 102 } 103 inline bool operator !=(const Geometry& rhs) const { 104 return !operator ==(rhs); 105 } 106 }; 107 108 struct State { 109 Geometry active; 110 Geometry requested; 111 uint32_t z; 112 uint32_t layerStack; 113#ifdef USE_HWC2 114 float alpha; 115#else 116 uint8_t alpha; 117#endif 118 uint8_t flags; 119 uint8_t mask; 120 uint8_t reserved[2]; 121 int32_t sequence; // changes when visible regions can change 122 bool modified; 123 124 Rect crop; 125 Rect requestedCrop; 126 127 Rect finalCrop; 128 129 // If set, defers this state update until the Layer identified by handle 130 // receives a frame with the given frameNumber 131 wp<IBinder> handle; 132 uint64_t frameNumber; 133 134 // the transparentRegion hint is a bit special, it's latched only 135 // when we receive a buffer -- this is because it's "content" 136 // dependent. 137 Region activeTransparentRegion; 138 Region requestedTransparentRegion; 139 }; 140 141 // ----------------------------------------------------------------------- 142 143 Layer(SurfaceFlinger* flinger, const sp<Client>& client, 144 const String8& name, uint32_t w, uint32_t h, uint32_t flags); 145 146 virtual ~Layer(); 147 148 // the this layer's size and format 149 status_t setBuffers(uint32_t w, uint32_t h, PixelFormat format, uint32_t flags); 150 151 // modify current state 152 bool setPosition(float x, float y, bool immediate); 153 bool setLayer(uint32_t z); 154 bool setSize(uint32_t w, uint32_t h); 155#ifdef USE_HWC2 156 bool setAlpha(float alpha); 157#else 158 bool setAlpha(uint8_t alpha); 159#endif 160 bool setMatrix(const layer_state_t::matrix22_t& matrix); 161 bool setTransparentRegionHint(const Region& transparent); 162 bool setFlags(uint8_t flags, uint8_t mask); 163 bool setCrop(const Rect& crop, bool immediate); 164 bool setFinalCrop(const Rect& crop); 165 bool setLayerStack(uint32_t layerStack); 166 void deferTransactionUntil(const sp<IBinder>& handle, uint64_t frameNumber); 167 bool setOverrideScalingMode(int32_t overrideScalingMode); 168 169 // If we have received a new buffer this frame, we will pass its surface 170 // damage down to hardware composer. Otherwise, we must send a region with 171 // one empty rect. 172 void useSurfaceDamage(); 173 void useEmptyDamage(); 174 175 uint32_t getTransactionFlags(uint32_t flags); 176 uint32_t setTransactionFlags(uint32_t flags); 177 178 void computeGeometry(const sp<const DisplayDevice>& hw, Mesh& mesh, 179 bool useIdentityTransform) const; 180 Rect computeBounds(const Region& activeTransparentRegion) const; 181 Rect computeBounds() const; 182 183 int32_t getSequence() const { return sequence; } 184 185 // ----------------------------------------------------------------------- 186 // Virtuals 187 188 virtual const char* getTypeId() const { return "Layer"; } 189 190 /* 191 * isOpaque - true if this surface is opaque 192 * 193 * This takes into account the buffer format (i.e. whether or not the 194 * pixel format includes an alpha channel) and the "opaque" flag set 195 * on the layer. It does not examine the current plane alpha value. 196 */ 197 virtual bool isOpaque(const Layer::State& s) const; 198 199 /* 200 * isSecure - true if this surface is secure, that is if it prevents 201 * screenshots or VNC servers. 202 */ 203 virtual bool isSecure() const; 204 205 /* 206 * isProtected - true if the layer may contain protected content in the 207 * GRALLOC_USAGE_PROTECTED sense. 208 */ 209 virtual bool isProtected() const; 210 211 /* 212 * isVisible - true if this layer is visible, false otherwise 213 */ 214 virtual bool isVisible() const; 215 216 /* 217 * isFixedSize - true if content has a fixed size 218 */ 219 virtual bool isFixedSize() const; 220 221protected: 222 /* 223 * onDraw - draws the surface. 224 */ 225 virtual void onDraw(const sp<const DisplayDevice>& hw, const Region& clip, 226 bool useIdentityTransform) const; 227 228public: 229 // ----------------------------------------------------------------------- 230 231#ifdef USE_HWC2 232 void setGeometry(const sp<const DisplayDevice>& displayDevice); 233 void forceClientComposition(int32_t hwcId); 234 void setPerFrameData(const sp<const DisplayDevice>& displayDevice); 235 236 // callIntoHwc exists so we can update our local state and call 237 // acceptDisplayChanges without unnecessarily updating the device's state 238 void setCompositionType(int32_t hwcId, HWC2::Composition type, 239 bool callIntoHwc = true); 240 HWC2::Composition getCompositionType(int32_t hwcId) const; 241 242 void setClearClientTarget(int32_t hwcId, bool clear); 243 bool getClearClientTarget(int32_t hwcId) const; 244 245 void updateCursorPosition(const sp<const DisplayDevice>& hw); 246#else 247 void setGeometry(const sp<const DisplayDevice>& hw, 248 HWComposer::HWCLayerInterface& layer); 249 void setPerFrameData(const sp<const DisplayDevice>& hw, 250 HWComposer::HWCLayerInterface& layer); 251 void setAcquireFence(const sp<const DisplayDevice>& hw, 252 HWComposer::HWCLayerInterface& layer); 253 254 Rect getPosition(const sp<const DisplayDevice>& hw); 255#endif 256 257 /* 258 * called after page-flip 259 */ 260#ifdef USE_HWC2 261 void onLayerDisplayed(const sp<Fence>& releaseFence); 262#else 263 void onLayerDisplayed(const sp<const DisplayDevice>& hw, 264 HWComposer::HWCLayerInterface* layer); 265#endif 266 267 bool shouldPresentNow(const DispSync& dispSync) const; 268 269 /* 270 * called before composition. 271 * returns true if the layer has pending updates. 272 */ 273 bool onPreComposition(nsecs_t refreshStartTime); 274 275 /* 276 * called after composition. 277 * returns true if the layer latched a new buffer this frame. 278 */ 279 bool onPostComposition(sp<Fence> glCompositionDoneFence); 280 281#ifdef USE_HWC2 282 // If a buffer was replaced this frame, release the former buffer 283 void releasePendingBuffer(); 284#endif 285 286 /* 287 * draw - performs some global clipping optimizations 288 * and calls onDraw(). 289 */ 290 void draw(const sp<const DisplayDevice>& hw, const Region& clip) const; 291 void draw(const sp<const DisplayDevice>& hw, bool useIdentityTransform) const; 292 void draw(const sp<const DisplayDevice>& hw) const; 293 294 /* 295 * doTransaction - process the transaction. This is a good place to figure 296 * out which attributes of the surface have changed. 297 */ 298 uint32_t doTransaction(uint32_t transactionFlags); 299 300 /* 301 * setVisibleRegion - called to set the new visible region. This gives 302 * a chance to update the new visible region or record the fact it changed. 303 */ 304 void setVisibleRegion(const Region& visibleRegion); 305 306 /* 307 * setCoveredRegion - called when the covered region changes. The covered 308 * region corresponds to any area of the surface that is covered 309 * (transparently or not) by another surface. 310 */ 311 void setCoveredRegion(const Region& coveredRegion); 312 313 /* 314 * setVisibleNonTransparentRegion - called when the visible and 315 * non-transparent region changes. 316 */ 317 void setVisibleNonTransparentRegion(const Region& 318 visibleNonTransparentRegion); 319 320 /* 321 * latchBuffer - called each time the screen is redrawn and returns whether 322 * the visible regions need to be recomputed (this is a fairly heavy 323 * operation, so this should be set only if needed). Typically this is used 324 * to figure out if the content or size of a surface has changed. 325 */ 326 Region latchBuffer(bool& recomputeVisibleRegions, nsecs_t latchTime); 327 328 bool isPotentialCursor() const { return mPotentialCursor;} 329 330 /* 331 * called with the state lock when the surface is removed from the 332 * current list 333 */ 334 void onRemoved(); 335 336 337 // Updates the transform hint in our SurfaceFlingerConsumer to match 338 // the current orientation of the display device. 339 void updateTransformHint(const sp<const DisplayDevice>& hw) const; 340 341 /* 342 * returns the rectangle that crops the content of the layer and scales it 343 * to the layer's size. 344 */ 345 Rect getContentCrop() const; 346 347 /* 348 * Returns if a frame is queued. 349 */ 350 bool hasQueuedFrame() const { return mQueuedFrames > 0 || 351 mSidebandStreamChanged || mAutoRefresh; } 352 353#ifdef USE_HWC2 354 // ----------------------------------------------------------------------- 355 356 bool hasHwcLayer(int32_t hwcId) { 357 if (mHwcLayers.count(hwcId) == 0) { 358 return false; 359 } 360 if (mHwcLayers[hwcId].layer->isAbandoned()) { 361 ALOGI("Erasing abandoned layer %s on %d", mName.string(), hwcId); 362 mHwcLayers.erase(hwcId); 363 return false; 364 } 365 return true; 366 } 367 368 std::shared_ptr<HWC2::Layer> getHwcLayer(int32_t hwcId) { 369 if (mHwcLayers.count(hwcId) == 0) { 370 return nullptr; 371 } 372 return mHwcLayers[hwcId].layer; 373 } 374 375 void setHwcLayer(int32_t hwcId, std::shared_ptr<HWC2::Layer>&& layer) { 376 if (layer) { 377 mHwcLayers[hwcId].layer = layer; 378 } else { 379 mHwcLayers.erase(hwcId); 380 } 381 } 382 383#endif 384 // ----------------------------------------------------------------------- 385 386 void clearWithOpenGL(const sp<const DisplayDevice>& hw) const; 387 void setFiltering(bool filtering); 388 bool getFiltering() const; 389 390 // only for debugging 391 inline const sp<GraphicBuffer>& getActiveBuffer() const { return mActiveBuffer; } 392 393 inline const State& getDrawingState() const { return mDrawingState; } 394 inline const State& getCurrentState() const { return mCurrentState; } 395 inline State& getCurrentState() { return mCurrentState; } 396 397 398 /* always call base class first */ 399 void dump(String8& result, Colorizer& colorizer) const; 400#ifdef USE_HWC2 401 static void miniDumpHeader(String8& result); 402 void miniDump(String8& result, int32_t hwcId) const; 403#endif 404 void dumpFrameStats(String8& result) const; 405 void dumpFrameEvents(String8& result); 406 void clearFrameStats(); 407 void logFrameStats(); 408 void getFrameStats(FrameStats* outStats) const; 409 410 std::vector<OccupancyTracker::Segment> getOccupancyHistory(bool forceFlush); 411 412 void addAndGetFrameTimestamps(const NewFrameEventsEntry* newEntry, 413 FrameEventHistoryDelta* outDelta); 414 415 bool getTransformToDisplayInverse() const; 416 417protected: 418 // constant 419 sp<SurfaceFlinger> mFlinger; 420 /* 421 * Trivial class, used to ensure that mFlinger->onLayerDestroyed(mLayer) 422 * is called. 423 */ 424 class LayerCleaner { 425 sp<SurfaceFlinger> mFlinger; 426 wp<Layer> mLayer; 427 protected: 428 ~LayerCleaner() { 429 // destroy client resources 430 mFlinger->onLayerDestroyed(mLayer); 431 } 432 public: 433 LayerCleaner(const sp<SurfaceFlinger>& flinger, 434 const sp<Layer>& layer) 435 : mFlinger(flinger), mLayer(layer) { 436 } 437 }; 438 439 440 virtual void onFirstRef(); 441 442 443 444private: 445 friend class SurfaceInterceptor; 446 // Interface implementation for SurfaceFlingerConsumer::ContentsChangedListener 447 virtual void onFrameAvailable(const BufferItem& item) override; 448 virtual void onFrameReplaced(const BufferItem& item) override; 449 virtual void onSidebandStreamChanged() override; 450 451 void commitTransaction(const State& stateToCommit); 452 453 // needsLinearFiltering - true if this surface's state requires filtering 454 bool needsFiltering(const sp<const DisplayDevice>& hw) const; 455 456 uint32_t getEffectiveUsage(uint32_t usage) const; 457 FloatRect computeCrop(const sp<const DisplayDevice>& hw) const; 458 bool isCropped() const; 459 static bool getOpacityForFormat(uint32_t format); 460 461 // drawing 462 void clearWithOpenGL(const sp<const DisplayDevice>& hw, 463 float r, float g, float b, float alpha) const; 464 void drawWithOpenGL(const sp<const DisplayDevice>& hw, const Region& clip, 465 bool useIdentityTransform) const; 466 467 // Temporary - Used only for LEGACY camera mode. 468 uint32_t getProducerStickyTransform() const; 469 470 // Loads the corresponding system property once per process 471 static bool latchUnsignaledBuffers(); 472 473 // ----------------------------------------------------------------------- 474 475 class SyncPoint 476 { 477 public: 478 explicit SyncPoint(uint64_t frameNumber) : mFrameNumber(frameNumber), 479 mFrameIsAvailable(false), mTransactionIsApplied(false) {} 480 481 uint64_t getFrameNumber() const { 482 return mFrameNumber; 483 } 484 485 bool frameIsAvailable() const { 486 return mFrameIsAvailable; 487 } 488 489 void setFrameAvailable() { 490 mFrameIsAvailable = true; 491 } 492 493 bool transactionIsApplied() const { 494 return mTransactionIsApplied; 495 } 496 497 void setTransactionApplied() { 498 mTransactionIsApplied = true; 499 } 500 501 private: 502 const uint64_t mFrameNumber; 503 std::atomic<bool> mFrameIsAvailable; 504 std::atomic<bool> mTransactionIsApplied; 505 }; 506 507 // SyncPoints which will be signaled when the correct frame is at the head 508 // of the queue and dropped after the frame has been latched. Protected by 509 // mLocalSyncPointMutex. 510 Mutex mLocalSyncPointMutex; 511 std::list<std::shared_ptr<SyncPoint>> mLocalSyncPoints; 512 513 // SyncPoints which will be signaled and then dropped when the transaction 514 // is applied 515 std::list<std::shared_ptr<SyncPoint>> mRemoteSyncPoints; 516 517 uint64_t getHeadFrameNumber() const; 518 bool headFenceHasSignaled() const; 519 520 // Returns false if the relevant frame has already been latched 521 bool addSyncPoint(const std::shared_ptr<SyncPoint>& point); 522 523 void pushPendingState(); 524 void popPendingState(State* stateToCommit); 525 bool applyPendingStates(State* stateToCommit); 526 527 // Returns mCurrentScaling mode (originating from the 528 // Client) or mOverrideScalingMode mode (originating from 529 // the Surface Controller) if set. 530 uint32_t getEffectiveScalingMode() const; 531public: 532 /* 533 * The layer handle is just a BBinder object passed to the client 534 * (remote process) -- we don't keep any reference on our side such that 535 * the dtor is called when the remote side let go of its reference. 536 * 537 * LayerCleaner ensures that mFlinger->onLayerDestroyed() is called for 538 * this layer when the handle is destroyed. 539 */ 540 class Handle : public BBinder, public LayerCleaner { 541 public: 542 Handle(const sp<SurfaceFlinger>& flinger, const sp<Layer>& layer) 543 : LayerCleaner(flinger, layer), owner(layer) {} 544 545 wp<Layer> owner; 546 }; 547 548 sp<IBinder> getHandle(); 549 sp<IGraphicBufferProducer> getProducer() const; 550 const String8& getName() const; 551 void notifyAvailableFrames(); 552private: 553 554 // ----------------------------------------------------------------------- 555 556 // Check all of the local sync points to ensure that all transactions 557 // which need to have been applied prior to the frame which is about to 558 // be latched have signaled 559 bool allTransactionsSignaled(); 560 561 // constants 562 sp<SurfaceFlingerConsumer> mSurfaceFlingerConsumer; 563 sp<IGraphicBufferProducer> mProducer; 564 uint32_t mTextureName; // from GLES 565 bool mPremultipliedAlpha; 566 String8 mName; 567 PixelFormat mFormat; 568 569 // these are protected by an external lock 570 State mCurrentState; 571 State mDrawingState; 572 volatile int32_t mTransactionFlags; 573 574 // Accessed from main thread and binder threads 575 Mutex mPendingStateMutex; 576 Vector<State> mPendingStates; 577 578 // thread-safe 579 volatile int32_t mQueuedFrames; 580 volatile int32_t mSidebandStreamChanged; // used like an atomic boolean 581 582 // Timestamp history for UIAutomation. Thread safe. 583 FrameTracker mFrameTracker; 584 585 // Timestamp history for the consumer to query. 586 // Accessed by both consumer and producer on main and binder threads. 587 Mutex mFrameEventHistoryMutex; 588 ConsumerFrameEventHistory mFrameEventHistory; 589 590 // main thread 591 sp<GraphicBuffer> mActiveBuffer; 592 sp<NativeHandle> mSidebandStream; 593 Rect mCurrentCrop; 594 uint32_t mCurrentTransform; 595 uint32_t mCurrentScalingMode; 596 // We encode unset as -1. 597 int32_t mOverrideScalingMode; 598 bool mCurrentOpacity; 599 bool mBufferLatched = false; // TODO: Use mActiveBuffer? 600 std::atomic<uint64_t> mCurrentFrameNumber; 601 uint64_t mPreviousFrameNumber; // Only accessed on the main thread. 602 bool mRefreshPending; 603 bool mFrameLatencyNeeded; 604 // Whether filtering is forced on or not 605 bool mFiltering; 606 // Whether filtering is needed b/c of the drawingstate 607 bool mNeedsFiltering; 608 // The mesh used to draw the layer in GLES composition mode 609 mutable Mesh mMesh; 610 // The texture used to draw the layer in GLES composition mode 611 mutable Texture mTexture; 612 613#ifdef USE_HWC2 614 // HWC items, accessed from the main thread 615 struct HWCInfo { 616 HWCInfo() 617 : layer(), 618 forceClientComposition(false), 619 compositionType(HWC2::Composition::Invalid), 620 clearClientTarget(false) {} 621 622 std::shared_ptr<HWC2::Layer> layer; 623 bool forceClientComposition; 624 HWC2::Composition compositionType; 625 bool clearClientTarget; 626 Rect displayFrame; 627 FloatRect sourceCrop; 628 }; 629 std::unordered_map<int32_t, HWCInfo> mHwcLayers; 630#else 631 bool mIsGlesComposition; 632#endif 633 634 // page-flip thread (currently main thread) 635 bool mProtectedByApp; // application requires protected path to external sink 636 637 // protected by mLock 638 mutable Mutex mLock; 639 // Set to true once we've returned this surface's handle 640 mutable bool mHasSurface; 641 const wp<Client> mClientRef; 642 643 // This layer can be a cursor on some displays. 644 bool mPotentialCursor; 645 646 // Local copy of the queued contents of the incoming BufferQueue 647 mutable Mutex mQueueItemLock; 648 Condition mQueueItemCondition; 649 Vector<BufferItem> mQueueItems; 650 std::atomic<uint64_t> mLastFrameNumberReceived; 651 bool mUpdateTexImageFailed; // This is only accessed on the main thread. 652 653 bool mAutoRefresh; 654 bool mFreezePositionUpdates; 655}; 656 657// --------------------------------------------------------------------------- 658 659}; // namespace android 660 661#endif // ANDROID_LAYER_H 662