1 /* 2 * Copyright (C) 2010 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_GUI_SURFACE_H 18 #define ANDROID_GUI_SURFACE_H 19 20 #include <gui/IGraphicBufferProducer.h> 21 #include <gui/BufferQueueDefs.h> 22 23 #include <ui/ANativeObjectBase.h> 24 #include <ui/Region.h> 25 26 #include <utils/Condition.h> 27 #include <utils/Mutex.h> 28 #include <utils/RefBase.h> 29 30 #include <system/window.h> 31 32 namespace android { 33 34 class ISurfaceComposer; 35 36 /* 37 * An implementation of ANativeWindow that feeds graphics buffers into a 38 * BufferQueue. 39 * 40 * This is typically used by programs that want to render frames through 41 * some means (maybe OpenGL, a software renderer, or a hardware decoder) 42 * and have the frames they create forwarded to SurfaceFlinger for 43 * compositing. For example, a video decoder could render a frame and call 44 * eglSwapBuffers(), which invokes ANativeWindow callbacks defined by 45 * Surface. Surface then forwards the buffers through Binder IPC 46 * to the BufferQueue's producer interface, providing the new frame to a 47 * consumer such as GLConsumer. 48 */ 49 class Surface 50 : public ANativeObjectBase<ANativeWindow, Surface, RefBase> 51 { 52 public: 53 54 /* 55 * creates a Surface from the given IGraphicBufferProducer (which concrete 56 * implementation is a BufferQueue). 57 * 58 * Surface is mainly state-less while it's disconnected, it can be 59 * viewed as a glorified IGraphicBufferProducer holder. It's therefore 60 * safe to create other Surfaces from the same IGraphicBufferProducer. 61 * 62 * However, once a Surface is connected, it'll prevent other Surfaces 63 * referring to the same IGraphicBufferProducer to become connected and 64 * therefore prevent them to be used as actual producers of buffers. 65 * 66 * the controlledByApp flag indicates that this Surface (producer) is 67 * controlled by the application. This flag is used at connect time. 68 */ 69 explicit Surface(const sp<IGraphicBufferProducer>& bufferProducer, 70 bool controlledByApp = false); 71 72 /* getIGraphicBufferProducer() returns the IGraphicBufferProducer this 73 * Surface was created with. Usually it's an error to use the 74 * IGraphicBufferProducer while the Surface is connected. 75 */ 76 sp<IGraphicBufferProducer> getIGraphicBufferProducer() const; 77 78 /* convenience function to check that the given surface is non NULL as 79 * well as its IGraphicBufferProducer */ 80 static bool isValid(const sp<Surface>& surface) { 81 return surface != NULL && surface->getIGraphicBufferProducer() != NULL; 82 } 83 84 /* Attaches a sideband buffer stream to the Surface's IGraphicBufferProducer. 85 * 86 * A sideband stream is a device-specific mechanism for passing buffers 87 * from the producer to the consumer without using dequeueBuffer/ 88 * queueBuffer. If a sideband stream is present, the consumer can choose 89 * whether to acquire buffers from the sideband stream or from the queued 90 * buffers. 91 * 92 * Passing NULL or a different stream handle will detach the previous 93 * handle if any. 94 */ 95 void setSidebandStream(const sp<NativeHandle>& stream); 96 97 /* Allocates buffers based on the current dimensions/format. 98 * 99 * This function will allocate up to the maximum number of buffers 100 * permitted by the current BufferQueue configuration. It will use the 101 * default format and dimensions. This is most useful to avoid an allocation 102 * delay during dequeueBuffer. If there are already the maximum number of 103 * buffers allocated, this function has no effect. 104 */ 105 void allocateBuffers(); 106 107 /* Sets the generation number on the IGraphicBufferProducer and updates the 108 * generation number on any buffers attached to the Surface after this call. 109 * See IGBP::setGenerationNumber for more information. */ 110 status_t setGenerationNumber(uint32_t generationNumber); 111 112 // See IGraphicBufferProducer::getConsumerName 113 String8 getConsumerName() const; 114 115 // See IGraphicBufferProducer::getNextFrameNumber 116 uint64_t getNextFrameNumber() const; 117 118 /* Set the scaling mode to be used with a Surface. 119 * See NATIVE_WINDOW_SET_SCALING_MODE and its parameters 120 * in <system/window.h>. */ 121 int setScalingMode(int mode); 122 123 // See IGraphicBufferProducer::setDequeueTimeout 124 status_t setDequeueTimeout(nsecs_t timeout); 125 126 /* 127 * Wait for frame number to increase past lastFrame for at most 128 * timeoutNs. Useful for one thread to wait for another unknown 129 * thread to queue a buffer. 130 */ 131 bool waitForNextFrame(uint64_t lastFrame, nsecs_t timeout); 132 133 // See IGraphicBufferProducer::getLastQueuedBuffer 134 // See GLConsumer::getTransformMatrix for outTransformMatrix format 135 status_t getLastQueuedBuffer(sp<GraphicBuffer>* outBuffer, 136 sp<Fence>* outFence, float outTransformMatrix[16]); 137 138 status_t getDisplayRefreshCycleDuration(nsecs_t* outRefreshDuration); 139 140 /* Enables or disables frame timestamp tracking. It is disabled by default 141 * to avoid overhead during queue and dequeue for applications that don't 142 * need the feature. If disabled, calls to getFrameTimestamps will fail. 143 */ 144 void enableFrameTimestamps(bool enable); 145 146 status_t getCompositorTiming( 147 nsecs_t* compositeDeadline, nsecs_t* compositeInterval, 148 nsecs_t* compositeToPresentLatency); 149 150 // See IGraphicBufferProducer::getFrameTimestamps 151 status_t getFrameTimestamps(uint64_t frameNumber, 152 nsecs_t* outRequestedPresentTime, nsecs_t* outAcquireTime, 153 nsecs_t* outLatchTime, nsecs_t* outFirstRefreshStartTime, 154 nsecs_t* outLastRefreshStartTime, nsecs_t* outGlCompositionDoneTime, 155 nsecs_t* outDisplayPresentTime, nsecs_t* outDequeueReadyTime, 156 nsecs_t* outReleaseTime); 157 158 status_t getWideColorSupport(bool* supported); 159 status_t getHdrSupport(bool* supported); 160 161 status_t getUniqueId(uint64_t* outId) const; 162 status_t getConsumerUsage(uint64_t* outUsage) const; 163 164 // Returns the CLOCK_MONOTONIC start time of the last dequeueBuffer call 165 nsecs_t getLastDequeueStartTime() const; 166 167 protected: 168 virtual ~Surface(); 169 170 // Virtual for testing. 171 virtual sp<ISurfaceComposer> composerService() const; 172 virtual nsecs_t now() const; 173 174 private: 175 // can't be copied 176 Surface& operator = (const Surface& rhs); 177 Surface(const Surface& rhs); 178 179 // ANativeWindow hooks 180 static int hook_cancelBuffer(ANativeWindow* window, 181 ANativeWindowBuffer* buffer, int fenceFd); 182 static int hook_dequeueBuffer(ANativeWindow* window, 183 ANativeWindowBuffer** buffer, int* fenceFd); 184 static int hook_perform(ANativeWindow* window, int operation, ...); 185 static int hook_query(const ANativeWindow* window, int what, int* value); 186 static int hook_queueBuffer(ANativeWindow* window, 187 ANativeWindowBuffer* buffer, int fenceFd); 188 static int hook_setSwapInterval(ANativeWindow* window, int interval); 189 190 static int hook_cancelBuffer_DEPRECATED(ANativeWindow* window, 191 ANativeWindowBuffer* buffer); 192 static int hook_dequeueBuffer_DEPRECATED(ANativeWindow* window, 193 ANativeWindowBuffer** buffer); 194 static int hook_lockBuffer_DEPRECATED(ANativeWindow* window, 195 ANativeWindowBuffer* buffer); 196 static int hook_queueBuffer_DEPRECATED(ANativeWindow* window, 197 ANativeWindowBuffer* buffer); 198 199 int dispatchConnect(va_list args); 200 int dispatchDisconnect(va_list args); 201 int dispatchSetBufferCount(va_list args); 202 int dispatchSetBuffersGeometry(va_list args); 203 int dispatchSetBuffersDimensions(va_list args); 204 int dispatchSetBuffersUserDimensions(va_list args); 205 int dispatchSetBuffersFormat(va_list args); 206 int dispatchSetScalingMode(va_list args); 207 int dispatchSetBuffersTransform(va_list args); 208 int dispatchSetBuffersStickyTransform(va_list args); 209 int dispatchSetBuffersTimestamp(va_list args); 210 int dispatchSetCrop(va_list args); 211 int dispatchSetUsage(va_list args); 212 int dispatchSetUsage64(va_list args); 213 int dispatchLock(va_list args); 214 int dispatchUnlockAndPost(va_list args); 215 int dispatchSetSidebandStream(va_list args); 216 int dispatchSetBuffersDataSpace(va_list args); 217 int dispatchSetSurfaceDamage(va_list args); 218 int dispatchSetSharedBufferMode(va_list args); 219 int dispatchSetAutoRefresh(va_list args); 220 int dispatchGetDisplayRefreshCycleDuration(va_list args); 221 int dispatchGetNextFrameId(va_list args); 222 int dispatchEnableFrameTimestamps(va_list args); 223 int dispatchGetCompositorTiming(va_list args); 224 int dispatchGetFrameTimestamps(va_list args); 225 int dispatchGetWideColorSupport(va_list args); 226 int dispatchGetHdrSupport(va_list args); 227 int dispatchGetConsumerUsage64(va_list args); 228 229 protected: 230 virtual int dequeueBuffer(ANativeWindowBuffer** buffer, int* fenceFd); 231 virtual int cancelBuffer(ANativeWindowBuffer* buffer, int fenceFd); 232 virtual int queueBuffer(ANativeWindowBuffer* buffer, int fenceFd); 233 virtual int perform(int operation, va_list args); 234 virtual int setSwapInterval(int interval); 235 236 virtual int lockBuffer_DEPRECATED(ANativeWindowBuffer* buffer); 237 238 virtual int connect(int api); 239 virtual int setBufferCount(int bufferCount); 240 virtual int setBuffersUserDimensions(uint32_t width, uint32_t height); 241 virtual int setBuffersFormat(PixelFormat format); 242 virtual int setBuffersTransform(uint32_t transform); 243 virtual int setBuffersStickyTransform(uint32_t transform); 244 virtual int setBuffersTimestamp(int64_t timestamp); 245 virtual int setBuffersDataSpace(android_dataspace dataSpace); 246 virtual int setCrop(Rect const* rect); 247 virtual int setUsage(uint64_t reqUsage); 248 virtual void setSurfaceDamage(android_native_rect_t* rects, size_t numRects); 249 250 public: 251 virtual int disconnect(int api, 252 IGraphicBufferProducer::DisconnectMode mode = 253 IGraphicBufferProducer::DisconnectMode::Api); 254 255 virtual int setMaxDequeuedBufferCount(int maxDequeuedBuffers); 256 virtual int setAsyncMode(bool async); 257 virtual int setSharedBufferMode(bool sharedBufferMode); 258 virtual int setAutoRefresh(bool autoRefresh); 259 virtual int setBuffersDimensions(uint32_t width, uint32_t height); 260 virtual int lock(ANativeWindow_Buffer* outBuffer, ARect* inOutDirtyBounds); 261 virtual int unlockAndPost(); 262 virtual int query(int what, int* value) const; 263 264 virtual int connect(int api, const sp<IProducerListener>& listener); 265 266 // When reportBufferRemoval is true, clients must call getAndFlushRemovedBuffers to fetch 267 // GraphicBuffers removed from this surface after a dequeueBuffer, detachNextBuffer or 268 // attachBuffer call. This allows clients with their own buffer caches to free up buffers no 269 // longer in use by this surface. 270 virtual int connect( 271 int api, const sp<IProducerListener>& listener, 272 bool reportBufferRemoval); 273 virtual int detachNextBuffer(sp<GraphicBuffer>* outBuffer, 274 sp<Fence>* outFence); 275 virtual int attachBuffer(ANativeWindowBuffer*); 276 277 // When client connects to Surface with reportBufferRemoval set to true, any buffers removed 278 // from this Surface will be collected and returned here. Once this method returns, these 279 // buffers will no longer be referenced by this Surface unless they are attached to this 280 // Surface later. The list of removed buffers will only be stored until the next dequeueBuffer, 281 // detachNextBuffer, or attachBuffer call. 282 status_t getAndFlushRemovedBuffers(std::vector<sp<GraphicBuffer>>* out); 283 284 protected: 285 enum { NUM_BUFFER_SLOTS = BufferQueueDefs::NUM_BUFFER_SLOTS }; 286 enum { DEFAULT_FORMAT = PIXEL_FORMAT_RGBA_8888 }; 287 288 void querySupportedTimestampsLocked() const; 289 290 void freeAllBuffers(); 291 int getSlotFromBufferLocked(android_native_buffer_t* buffer) const; 292 293 struct BufferSlot { 294 sp<GraphicBuffer> buffer; 295 Region dirtyRegion; 296 }; 297 298 // mSurfaceTexture is the interface to the surface texture server. All 299 // operations on the surface texture client ultimately translate into 300 // interactions with the server using this interface. 301 // TODO: rename to mBufferProducer 302 sp<IGraphicBufferProducer> mGraphicBufferProducer; 303 304 // mSlots stores the buffers that have been allocated for each buffer slot. 305 // It is initialized to null pointers, and gets filled in with the result of 306 // IGraphicBufferProducer::requestBuffer when the client dequeues a buffer from a 307 // slot that has not yet been used. The buffer allocated to a slot will also 308 // be replaced if the requested buffer usage or geometry differs from that 309 // of the buffer allocated to a slot. 310 BufferSlot mSlots[NUM_BUFFER_SLOTS]; 311 312 // mReqWidth is the buffer width that will be requested at the next dequeue 313 // operation. It is initialized to 1. 314 uint32_t mReqWidth; 315 316 // mReqHeight is the buffer height that will be requested at the next 317 // dequeue operation. It is initialized to 1. 318 uint32_t mReqHeight; 319 320 // mReqFormat is the buffer pixel format that will be requested at the next 321 // deuque operation. It is initialized to PIXEL_FORMAT_RGBA_8888. 322 PixelFormat mReqFormat; 323 324 // mReqUsage is the set of buffer usage flags that will be requested 325 // at the next deuque operation. It is initialized to 0. 326 uint64_t mReqUsage; 327 328 // mTimestamp is the timestamp that will be used for the next buffer queue 329 // operation. It defaults to NATIVE_WINDOW_TIMESTAMP_AUTO, which means that 330 // a timestamp is auto-generated when queueBuffer is called. 331 int64_t mTimestamp; 332 333 // mDataSpace is the buffer dataSpace that will be used for the next buffer 334 // queue operation. It defaults to HAL_DATASPACE_UNKNOWN, which 335 // means that the buffer contains some type of color data. 336 android_dataspace mDataSpace; 337 338 // mCrop is the crop rectangle that will be used for the next buffer 339 // that gets queued. It is set by calling setCrop. 340 Rect mCrop; 341 342 // mScalingMode is the scaling mode that will be used for the next 343 // buffers that get queued. It is set by calling setScalingMode. 344 int mScalingMode; 345 346 // mTransform is the transform identifier that will be used for the next 347 // buffer that gets queued. It is set by calling setTransform. 348 uint32_t mTransform; 349 350 // mStickyTransform is a transform that is applied on top of mTransform 351 // in each buffer that is queued. This is typically used to force the 352 // compositor to apply a transform, and will prevent the transform hint 353 // from being set by the compositor. 354 uint32_t mStickyTransform; 355 356 // mDefaultWidth is default width of the buffers, regardless of the 357 // native_window_set_buffers_dimensions call. 358 uint32_t mDefaultWidth; 359 360 // mDefaultHeight is default height of the buffers, regardless of the 361 // native_window_set_buffers_dimensions call. 362 uint32_t mDefaultHeight; 363 364 // mUserWidth, if non-zero, is an application-specified override 365 // of mDefaultWidth. This is lower priority than the width set by 366 // native_window_set_buffers_dimensions. 367 uint32_t mUserWidth; 368 369 // mUserHeight, if non-zero, is an application-specified override 370 // of mDefaultHeight. This is lower priority than the height set 371 // by native_window_set_buffers_dimensions. 372 uint32_t mUserHeight; 373 374 // mTransformHint is the transform probably applied to buffers of this 375 // window. this is only a hint, actual transform may differ. 376 uint32_t mTransformHint; 377 378 // mProducerControlledByApp whether this buffer producer is controlled 379 // by the application 380 bool mProducerControlledByApp; 381 382 // mSwapIntervalZero set if we should drop buffers at queue() time to 383 // achieve an asynchronous swap interval 384 bool mSwapIntervalZero; 385 386 // mConsumerRunningBehind whether the consumer is running more than 387 // one buffer behind the producer. 388 mutable bool mConsumerRunningBehind; 389 390 // mMutex is the mutex used to prevent concurrent access to the member 391 // variables of Surface objects. It must be locked whenever the 392 // member variables are accessed. 393 mutable Mutex mMutex; 394 395 // must be used from the lock/unlock thread 396 sp<GraphicBuffer> mLockedBuffer; 397 sp<GraphicBuffer> mPostedBuffer; 398 bool mConnectedToCpu; 399 400 // When a CPU producer is attached, this reflects the region that the 401 // producer wished to update as well as whether the Surface was able to copy 402 // the previous buffer back to allow a partial update. 403 // 404 // When a non-CPU producer is attached, this reflects the surface damage 405 // (the change since the previous frame) passed in by the producer. 406 Region mDirtyRegion; 407 408 // mBufferAge tracks the age of the contents of the most recently dequeued 409 // buffer as the number of frames that have elapsed since it was last queued 410 uint64_t mBufferAge; 411 412 // Stores the current generation number. See setGenerationNumber and 413 // IGraphicBufferProducer::setGenerationNumber for more information. 414 uint32_t mGenerationNumber; 415 416 // Caches the values that have been passed to the producer. 417 bool mSharedBufferMode; 418 bool mAutoRefresh; 419 420 // If in shared buffer mode and auto refresh is enabled, store the shared 421 // buffer slot and return it for all calls to queue/dequeue without going 422 // over Binder. 423 int mSharedBufferSlot; 424 425 // This is true if the shared buffer has already been queued/canceled. It's 426 // used to prevent a mismatch between the number of queue/dequeue calls. 427 bool mSharedBufferHasBeenQueued; 428 429 // These are used to satisfy the NATIVE_WINDOW_LAST_*_DURATION queries 430 nsecs_t mLastDequeueDuration = 0; 431 nsecs_t mLastQueueDuration = 0; 432 433 // Stores the time right before we call IGBP::dequeueBuffer 434 nsecs_t mLastDequeueStartTime = 0; 435 436 Condition mQueueBufferCondition; 437 438 uint64_t mNextFrameNumber = 1; 439 uint64_t mLastFrameNumber = 0; 440 441 // Mutable because ANativeWindow::query needs this class const. 442 mutable bool mQueriedSupportedTimestamps; 443 mutable bool mFrameTimestampsSupportsPresent; 444 445 // A cached copy of the FrameEventHistory maintained by the consumer. 446 bool mEnableFrameTimestamps = false; 447 std::unique_ptr<ProducerFrameEventHistory> mFrameEventHistory; 448 449 bool mReportRemovedBuffers = false; 450 std::vector<sp<GraphicBuffer>> mRemovedBuffers; 451 }; 452 453 } // namespace android 454 455 #endif // ANDROID_GUI_SURFACE_H 456
