Surface.h revision 9f02435fd44c0651c85e9bd4dc7307bc6b1a85fa
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 30struct ANativeWindow_Buffer; 31 32namespace android { 33 34class 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 */ 49class Surface 50 : public ANativeObjectBase<ANativeWindow, Surface, RefBase> 51{ 52public: 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* outDisplayRetireTime, 156 nsecs_t* outDequeueReadyTime, nsecs_t* outReleaseTime); 157 158 status_t getUniqueId(uint64_t* outId) const; 159 160protected: 161 virtual ~Surface(); 162 163 // Virtual for testing. 164 virtual sp<ISurfaceComposer> composerService() const; 165 virtual nsecs_t now() const; 166 167private: 168 // can't be copied 169 Surface& operator = (const Surface& rhs); 170 Surface(const Surface& rhs); 171 172 // ANativeWindow hooks 173 static int hook_cancelBuffer(ANativeWindow* window, 174 ANativeWindowBuffer* buffer, int fenceFd); 175 static int hook_dequeueBuffer(ANativeWindow* window, 176 ANativeWindowBuffer** buffer, int* fenceFd); 177 static int hook_perform(ANativeWindow* window, int operation, ...); 178 static int hook_query(const ANativeWindow* window, int what, int* value); 179 static int hook_queueBuffer(ANativeWindow* window, 180 ANativeWindowBuffer* buffer, int fenceFd); 181 static int hook_setSwapInterval(ANativeWindow* window, int interval); 182 183 static int hook_cancelBuffer_DEPRECATED(ANativeWindow* window, 184 ANativeWindowBuffer* buffer); 185 static int hook_dequeueBuffer_DEPRECATED(ANativeWindow* window, 186 ANativeWindowBuffer** buffer); 187 static int hook_lockBuffer_DEPRECATED(ANativeWindow* window, 188 ANativeWindowBuffer* buffer); 189 static int hook_queueBuffer_DEPRECATED(ANativeWindow* window, 190 ANativeWindowBuffer* buffer); 191 192 int dispatchConnect(va_list args); 193 int dispatchDisconnect(va_list args); 194 int dispatchSetBufferCount(va_list args); 195 int dispatchSetBuffersGeometry(va_list args); 196 int dispatchSetBuffersDimensions(va_list args); 197 int dispatchSetBuffersUserDimensions(va_list args); 198 int dispatchSetBuffersFormat(va_list args); 199 int dispatchSetScalingMode(va_list args); 200 int dispatchSetBuffersTransform(va_list args); 201 int dispatchSetBuffersStickyTransform(va_list args); 202 int dispatchSetBuffersTimestamp(va_list args); 203 int dispatchSetCrop(va_list args); 204 int dispatchSetPostTransformCrop(va_list args); 205 int dispatchSetUsage(va_list args); 206 int dispatchLock(va_list args); 207 int dispatchUnlockAndPost(va_list args); 208 int dispatchSetSidebandStream(va_list args); 209 int dispatchSetBuffersDataSpace(va_list args); 210 int dispatchSetSurfaceDamage(va_list args); 211 int dispatchSetSharedBufferMode(va_list args); 212 int dispatchSetAutoRefresh(va_list args); 213 int dispatchGetDisplayRefreshCycleDuration(va_list args); 214 int dispatchGetNextFrameId(va_list args); 215 int dispatchEnableFrameTimestamps(va_list args); 216 int dispatchGetCompositorTiming(va_list args); 217 int dispatchGetFrameTimestamps(va_list args); 218 219protected: 220 virtual int dequeueBuffer(ANativeWindowBuffer** buffer, int* fenceFd); 221 virtual int cancelBuffer(ANativeWindowBuffer* buffer, int fenceFd); 222 virtual int queueBuffer(ANativeWindowBuffer* buffer, int fenceFd); 223 virtual int perform(int operation, va_list args); 224 virtual int setSwapInterval(int interval); 225 226 virtual int lockBuffer_DEPRECATED(ANativeWindowBuffer* buffer); 227 228 virtual int connect(int api); 229 virtual int setBufferCount(int bufferCount); 230 virtual int setBuffersUserDimensions(uint32_t width, uint32_t height); 231 virtual int setBuffersFormat(PixelFormat format); 232 virtual int setBuffersTransform(uint32_t transform); 233 virtual int setBuffersStickyTransform(uint32_t transform); 234 virtual int setBuffersTimestamp(int64_t timestamp); 235 virtual int setBuffersDataSpace(android_dataspace dataSpace); 236 virtual int setCrop(Rect const* rect); 237 virtual int setUsage(uint32_t reqUsage); 238 virtual void setSurfaceDamage(android_native_rect_t* rects, size_t numRects); 239 240public: 241 virtual int disconnect(int api, 242 IGraphicBufferProducer::DisconnectMode mode = 243 IGraphicBufferProducer::DisconnectMode::Api); 244 245 virtual int setMaxDequeuedBufferCount(int maxDequeuedBuffers); 246 virtual int setAsyncMode(bool async); 247 virtual int setSharedBufferMode(bool sharedBufferMode); 248 virtual int setAutoRefresh(bool autoRefresh); 249 virtual int setBuffersDimensions(uint32_t width, uint32_t height); 250 virtual int lock(ANativeWindow_Buffer* outBuffer, ARect* inOutDirtyBounds); 251 virtual int unlockAndPost(); 252 virtual int query(int what, int* value) const; 253 254 virtual int connect(int api, const sp<IProducerListener>& listener); 255 virtual int detachNextBuffer(sp<GraphicBuffer>* outBuffer, 256 sp<Fence>* outFence); 257 virtual int attachBuffer(ANativeWindowBuffer*); 258 259protected: 260 enum { NUM_BUFFER_SLOTS = BufferQueueDefs::NUM_BUFFER_SLOTS }; 261 enum { DEFAULT_FORMAT = PIXEL_FORMAT_RGBA_8888 }; 262 263 void querySupportedTimestampsLocked() const; 264 265 void freeAllBuffers(); 266 int getSlotFromBufferLocked(android_native_buffer_t* buffer) const; 267 268 struct BufferSlot { 269 sp<GraphicBuffer> buffer; 270 Region dirtyRegion; 271 }; 272 273 // mSurfaceTexture is the interface to the surface texture server. All 274 // operations on the surface texture client ultimately translate into 275 // interactions with the server using this interface. 276 // TODO: rename to mBufferProducer 277 sp<IGraphicBufferProducer> mGraphicBufferProducer; 278 279 // mSlots stores the buffers that have been allocated for each buffer slot. 280 // It is initialized to null pointers, and gets filled in with the result of 281 // IGraphicBufferProducer::requestBuffer when the client dequeues a buffer from a 282 // slot that has not yet been used. The buffer allocated to a slot will also 283 // be replaced if the requested buffer usage or geometry differs from that 284 // of the buffer allocated to a slot. 285 BufferSlot mSlots[NUM_BUFFER_SLOTS]; 286 287 // mReqWidth is the buffer width that will be requested at the next dequeue 288 // operation. It is initialized to 1. 289 uint32_t mReqWidth; 290 291 // mReqHeight is the buffer height that will be requested at the next 292 // dequeue operation. It is initialized to 1. 293 uint32_t mReqHeight; 294 295 // mReqFormat is the buffer pixel format that will be requested at the next 296 // deuque operation. It is initialized to PIXEL_FORMAT_RGBA_8888. 297 PixelFormat mReqFormat; 298 299 // mReqUsage is the set of buffer usage flags that will be requested 300 // at the next deuque operation. It is initialized to 0. 301 uint32_t mReqUsage; 302 303 // mTimestamp is the timestamp that will be used for the next buffer queue 304 // operation. It defaults to NATIVE_WINDOW_TIMESTAMP_AUTO, which means that 305 // a timestamp is auto-generated when queueBuffer is called. 306 int64_t mTimestamp; 307 308 // mDataSpace is the buffer dataSpace that will be used for the next buffer 309 // queue operation. It defaults to HAL_DATASPACE_UNKNOWN, which 310 // means that the buffer contains some type of color data. 311 android_dataspace mDataSpace; 312 313 // mCrop is the crop rectangle that will be used for the next buffer 314 // that gets queued. It is set by calling setCrop. 315 Rect mCrop; 316 317 // mScalingMode is the scaling mode that will be used for the next 318 // buffers that get queued. It is set by calling setScalingMode. 319 int mScalingMode; 320 321 // mTransform is the transform identifier that will be used for the next 322 // buffer that gets queued. It is set by calling setTransform. 323 uint32_t mTransform; 324 325 // mStickyTransform is a transform that is applied on top of mTransform 326 // in each buffer that is queued. This is typically used to force the 327 // compositor to apply a transform, and will prevent the transform hint 328 // from being set by the compositor. 329 uint32_t mStickyTransform; 330 331 // mDefaultWidth is default width of the buffers, regardless of the 332 // native_window_set_buffers_dimensions call. 333 uint32_t mDefaultWidth; 334 335 // mDefaultHeight is default height of the buffers, regardless of the 336 // native_window_set_buffers_dimensions call. 337 uint32_t mDefaultHeight; 338 339 // mUserWidth, if non-zero, is an application-specified override 340 // of mDefaultWidth. This is lower priority than the width set by 341 // native_window_set_buffers_dimensions. 342 uint32_t mUserWidth; 343 344 // mUserHeight, if non-zero, is an application-specified override 345 // of mDefaultHeight. This is lower priority than the height set 346 // by native_window_set_buffers_dimensions. 347 uint32_t mUserHeight; 348 349 // mTransformHint is the transform probably applied to buffers of this 350 // window. this is only a hint, actual transform may differ. 351 uint32_t mTransformHint; 352 353 // mProducerControlledByApp whether this buffer producer is controlled 354 // by the application 355 bool mProducerControlledByApp; 356 357 // mSwapIntervalZero set if we should drop buffers at queue() time to 358 // achieve an asynchronous swap interval 359 bool mSwapIntervalZero; 360 361 // mConsumerRunningBehind whether the consumer is running more than 362 // one buffer behind the producer. 363 mutable bool mConsumerRunningBehind; 364 365 // mMutex is the mutex used to prevent concurrent access to the member 366 // variables of Surface objects. It must be locked whenever the 367 // member variables are accessed. 368 mutable Mutex mMutex; 369 370 // must be used from the lock/unlock thread 371 sp<GraphicBuffer> mLockedBuffer; 372 sp<GraphicBuffer> mPostedBuffer; 373 bool mConnectedToCpu; 374 375 // When a CPU producer is attached, this reflects the region that the 376 // producer wished to update as well as whether the Surface was able to copy 377 // the previous buffer back to allow a partial update. 378 // 379 // When a non-CPU producer is attached, this reflects the surface damage 380 // (the change since the previous frame) passed in by the producer. 381 Region mDirtyRegion; 382 383 // Stores the current generation number. See setGenerationNumber and 384 // IGraphicBufferProducer::setGenerationNumber for more information. 385 uint32_t mGenerationNumber; 386 387 // Caches the values that have been passed to the producer. 388 bool mSharedBufferMode; 389 bool mAutoRefresh; 390 391 // If in shared buffer mode and auto refresh is enabled, store the shared 392 // buffer slot and return it for all calls to queue/dequeue without going 393 // over Binder. 394 int mSharedBufferSlot; 395 396 // This is true if the shared buffer has already been queued/canceled. It's 397 // used to prevent a mismatch between the number of queue/dequeue calls. 398 bool mSharedBufferHasBeenQueued; 399 400 // These are used to satisfy the NATIVE_WINDOW_LAST_*_DURATION queries 401 nsecs_t mLastDequeueDuration = 0; 402 nsecs_t mLastQueueDuration = 0; 403 404 Condition mQueueBufferCondition; 405 406 uint64_t mNextFrameNumber = 1; 407 uint64_t mLastFrameNumber = 0; 408 409 // Mutable because ANativeWindow::query needs this class const. 410 mutable bool mQueriedSupportedTimestamps; 411 mutable bool mFrameTimestampsSupportsPresent; 412 mutable bool mFrameTimestampsSupportsRetire; 413 414 // A cached copy of the FrameEventHistory maintained by the consumer. 415 bool mEnableFrameTimestamps = false; 416 std::unique_ptr<ProducerFrameEventHistory> mFrameEventHistory; 417}; 418 419} // namespace android 420 421#endif // ANDROID_GUI_SURFACE_H 422