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