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