Surface.h revision 069b365163470d2736eb6f591c354d208b5da23b
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/BufferQueue.h> 22 23#include <ui/ANativeObjectBase.h> 24#include <ui/Region.h> 25 26#include <binder/Parcelable.h> 27 28#include <utils/RefBase.h> 29#include <utils/threads.h> 30#include <utils/KeyedVector.h> 31 32struct ANativeWindow_Buffer; 33 34namespace android { 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, bool controlledByApp = false); 70 71 /* getIGraphicBufferProducer() returns the IGraphicBufferProducer this 72 * Surface was created with. Usually it's an error to use the 73 * IGraphicBufferProducer while the Surface is connected. 74 */ 75 sp<IGraphicBufferProducer> getIGraphicBufferProducer() const; 76 77 /* convenience function to check that the given surface is non NULL as 78 * well as its IGraphicBufferProducer */ 79 static bool isValid(const sp<Surface>& surface) { 80 return surface != NULL && surface->getIGraphicBufferProducer() != NULL; 81 } 82 83 /* Attaches a sideband buffer stream to the Surface's IGraphicBufferProducer. 84 * 85 * A sideband stream is a device-specific mechanism for passing buffers 86 * from the producer to the consumer without using dequeueBuffer/ 87 * queueBuffer. If a sideband stream is present, the consumer can choose 88 * whether to acquire buffers from the sideband stream or from the queued 89 * buffers. 90 * 91 * Passing NULL or a different stream handle will detach the previous 92 * handle if any. 93 */ 94 void setSidebandStream(const sp<NativeHandle>& stream); 95 96 /* Allocates buffers based on the current dimensions/format. 97 * 98 * This function will allocate up to the maximum number of buffers 99 * permitted by the current BufferQueue configuration. It will use the 100 * default format and dimensions. This is most useful to avoid an allocation 101 * delay during dequeueBuffer. If there are already the maximum number of 102 * buffers allocated, this function has no effect. 103 */ 104 void allocateBuffers(); 105 106 /* Sets the generation number on the IGraphicBufferProducer and updates the 107 * generation number on any buffers attached to the Surface after this call. 108 * See IGBP::setGenerationNumber for more information. */ 109 status_t setGenerationNumber(uint32_t generationNumber); 110 111 // See IGraphicBufferProducer::getConsumerName 112 String8 getConsumerName() const; 113 114 // See IGraphicBufferProducer::getNextFrameNumber 115 uint64_t getNextFrameNumber() const; 116 117 /* Set the scaling mode to be used with a Surface. 118 * See NATIVE_WINDOW_SET_SCALING_MODE and its parameters 119 * in <system/window.h>. */ 120 int setScalingMode(int mode); 121 122 // See IGraphicBufferProducer::setDequeueTimeout 123 status_t setDequeueTimeout(nsecs_t timeout); 124 125 /* 126 * Wait for frame number to increase past lastFrame for at most 127 * timeoutNs. Useful for one thread to wait for another unknown 128 * thread to queue a buffer. 129 */ 130 bool waitForNextFrame(uint64_t lastFrame, nsecs_t timeout); 131 132 // See IGraphicBufferProducer::getLastQueuedBuffer 133 // See GLConsumer::getTransformMatrix for outTransformMatrix format 134 status_t getLastQueuedBuffer(sp<GraphicBuffer>* outBuffer, 135 sp<Fence>* outFence, float outTransformMatrix[16]); 136 137 // See IGraphicBufferProducer::getFrameTimestamps 138 status_t getFrameTimestamps(uint64_t frameNumber, 139 nsecs_t* outRequestedPresentTime, nsecs_t* outAcquireTime, 140 nsecs_t* outRefreshStartTime, nsecs_t* outGlCompositionDoneTime, 141 nsecs_t* outDisplayPresentTime, nsecs_t* outDisplayRetireTime, 142 nsecs_t* outReleaseTime); 143 144 status_t getUniqueId(uint64_t* outId) const; 145 146protected: 147 virtual ~Surface(); 148 149private: 150 // can't be copied 151 Surface& operator = (const Surface& rhs); 152 Surface(const Surface& rhs); 153 154 // ANativeWindow hooks 155 static int hook_cancelBuffer(ANativeWindow* window, 156 ANativeWindowBuffer* buffer, int fenceFd); 157 static int hook_dequeueBuffer(ANativeWindow* window, 158 ANativeWindowBuffer** buffer, int* fenceFd); 159 static int hook_perform(ANativeWindow* window, int operation, ...); 160 static int hook_query(const ANativeWindow* window, int what, int* value); 161 static int hook_queueBuffer(ANativeWindow* window, 162 ANativeWindowBuffer* buffer, int fenceFd); 163 static int hook_setSwapInterval(ANativeWindow* window, int interval); 164 165 static int hook_cancelBuffer_DEPRECATED(ANativeWindow* window, 166 ANativeWindowBuffer* buffer); 167 static int hook_dequeueBuffer_DEPRECATED(ANativeWindow* window, 168 ANativeWindowBuffer** buffer); 169 static int hook_lockBuffer_DEPRECATED(ANativeWindow* window, 170 ANativeWindowBuffer* buffer); 171 static int hook_queueBuffer_DEPRECATED(ANativeWindow* window, 172 ANativeWindowBuffer* buffer); 173 174 int dispatchConnect(va_list args); 175 int dispatchDisconnect(va_list args); 176 int dispatchSetBufferCount(va_list args); 177 int dispatchSetBuffersGeometry(va_list args); 178 int dispatchSetBuffersDimensions(va_list args); 179 int dispatchSetBuffersUserDimensions(va_list args); 180 int dispatchSetBuffersFormat(va_list args); 181 int dispatchSetScalingMode(va_list args); 182 int dispatchSetBuffersTransform(va_list args); 183 int dispatchSetBuffersStickyTransform(va_list args); 184 int dispatchSetBuffersTimestamp(va_list args); 185 int dispatchSetCrop(va_list args); 186 int dispatchSetPostTransformCrop(va_list args); 187 int dispatchSetUsage(va_list args); 188 int dispatchLock(va_list args); 189 int dispatchUnlockAndPost(va_list args); 190 int dispatchSetSidebandStream(va_list args); 191 int dispatchSetBuffersDataSpace(va_list args); 192 int dispatchSetSurfaceDamage(va_list args); 193 int dispatchSetSharedBufferMode(va_list args); 194 int dispatchSetAutoRefresh(va_list args); 195 int dispatchGetFrameTimestamps(va_list args); 196 197protected: 198 virtual int dequeueBuffer(ANativeWindowBuffer** buffer, int* fenceFd); 199 virtual int cancelBuffer(ANativeWindowBuffer* buffer, int fenceFd); 200 virtual int queueBuffer(ANativeWindowBuffer* buffer, int fenceFd); 201 virtual int perform(int operation, va_list args); 202 virtual int setSwapInterval(int interval); 203 204 virtual int lockBuffer_DEPRECATED(ANativeWindowBuffer* buffer); 205 206 virtual int connect(int api); 207 virtual int setBufferCount(int bufferCount); 208 virtual int setBuffersUserDimensions(uint32_t width, uint32_t height); 209 virtual int setBuffersFormat(PixelFormat format); 210 virtual int setBuffersTransform(uint32_t transform); 211 virtual int setBuffersStickyTransform(uint32_t transform); 212 virtual int setBuffersTimestamp(int64_t timestamp); 213 virtual int setBuffersDataSpace(android_dataspace dataSpace); 214 virtual int setCrop(Rect const* rect); 215 virtual int setUsage(uint32_t reqUsage); 216 virtual void setSurfaceDamage(android_native_rect_t* rects, size_t numRects); 217 218public: 219 virtual int disconnect(int api, 220 IGraphicBufferProducer::DisconnectMode mode = 221 IGraphicBufferProducer::DisconnectMode::Api); 222 223 virtual int setMaxDequeuedBufferCount(int maxDequeuedBuffers); 224 virtual int setAsyncMode(bool async); 225 virtual int setSharedBufferMode(bool sharedBufferMode); 226 virtual int setAutoRefresh(bool autoRefresh); 227 virtual int setBuffersDimensions(uint32_t width, uint32_t height); 228 virtual int lock(ANativeWindow_Buffer* outBuffer, ARect* inOutDirtyBounds); 229 virtual int unlockAndPost(); 230 virtual int query(int what, int* value) const; 231 232 virtual int connect(int api, const sp<IProducerListener>& listener); 233 virtual int detachNextBuffer(sp<GraphicBuffer>* outBuffer, 234 sp<Fence>* outFence); 235 virtual int attachBuffer(ANativeWindowBuffer*); 236 237protected: 238 enum { NUM_BUFFER_SLOTS = BufferQueue::NUM_BUFFER_SLOTS }; 239 enum { DEFAULT_FORMAT = PIXEL_FORMAT_RGBA_8888 }; 240 241private: 242 void querySupportedTimestampsLocked() const; 243 244 void freeAllBuffers(); 245 int getSlotFromBufferLocked(android_native_buffer_t* buffer) const; 246 247 struct BufferSlot { 248 sp<GraphicBuffer> buffer; 249 Region dirtyRegion; 250 }; 251 252 // mSurfaceTexture is the interface to the surface texture server. All 253 // operations on the surface texture client ultimately translate into 254 // interactions with the server using this interface. 255 // TODO: rename to mBufferProducer 256 sp<IGraphicBufferProducer> mGraphicBufferProducer; 257 258 // mSlots stores the buffers that have been allocated for each buffer slot. 259 // It is initialized to null pointers, and gets filled in with the result of 260 // IGraphicBufferProducer::requestBuffer when the client dequeues a buffer from a 261 // slot that has not yet been used. The buffer allocated to a slot will also 262 // be replaced if the requested buffer usage or geometry differs from that 263 // of the buffer allocated to a slot. 264 BufferSlot mSlots[NUM_BUFFER_SLOTS]; 265 266 // mReqWidth is the buffer width that will be requested at the next dequeue 267 // operation. It is initialized to 1. 268 uint32_t mReqWidth; 269 270 // mReqHeight is the buffer height that will be requested at the next 271 // dequeue operation. It is initialized to 1. 272 uint32_t mReqHeight; 273 274 // mReqFormat is the buffer pixel format that will be requested at the next 275 // deuque operation. It is initialized to PIXEL_FORMAT_RGBA_8888. 276 PixelFormat mReqFormat; 277 278 // mReqUsage is the set of buffer usage flags that will be requested 279 // at the next deuque operation. It is initialized to 0. 280 uint32_t mReqUsage; 281 282 // mTimestamp is the timestamp that will be used for the next buffer queue 283 // operation. It defaults to NATIVE_WINDOW_TIMESTAMP_AUTO, which means that 284 // a timestamp is auto-generated when queueBuffer is called. 285 int64_t mTimestamp; 286 287 // mDataSpace is the buffer dataSpace that will be used for the next buffer 288 // queue operation. It defaults to HAL_DATASPACE_UNKNOWN, which 289 // means that the buffer contains some type of color data. 290 android_dataspace mDataSpace; 291 292 // mCrop is the crop rectangle that will be used for the next buffer 293 // that gets queued. It is set by calling setCrop. 294 Rect mCrop; 295 296 // mScalingMode is the scaling mode that will be used for the next 297 // buffers that get queued. It is set by calling setScalingMode. 298 int mScalingMode; 299 300 // mTransform is the transform identifier that will be used for the next 301 // buffer that gets queued. It is set by calling setTransform. 302 uint32_t mTransform; 303 304 // mStickyTransform is a transform that is applied on top of mTransform 305 // in each buffer that is queued. This is typically used to force the 306 // compositor to apply a transform, and will prevent the transform hint 307 // from being set by the compositor. 308 uint32_t mStickyTransform; 309 310 // mDefaultWidth is default width of the buffers, regardless of the 311 // native_window_set_buffers_dimensions call. 312 uint32_t mDefaultWidth; 313 314 // mDefaultHeight is default height of the buffers, regardless of the 315 // native_window_set_buffers_dimensions call. 316 uint32_t mDefaultHeight; 317 318 // mUserWidth, if non-zero, is an application-specified override 319 // of mDefaultWidth. This is lower priority than the width set by 320 // native_window_set_buffers_dimensions. 321 uint32_t mUserWidth; 322 323 // mUserHeight, if non-zero, is an application-specified override 324 // of mDefaultHeight. This is lower priority than the height set 325 // by native_window_set_buffers_dimensions. 326 uint32_t mUserHeight; 327 328 // mTransformHint is the transform probably applied to buffers of this 329 // window. this is only a hint, actual transform may differ. 330 uint32_t mTransformHint; 331 332 // mProducerControlledByApp whether this buffer producer is controlled 333 // by the application 334 bool mProducerControlledByApp; 335 336 // mSwapIntervalZero set if we should drop buffers at queue() time to 337 // achieve an asynchronous swap interval 338 bool mSwapIntervalZero; 339 340 // mConsumerRunningBehind whether the consumer is running more than 341 // one buffer behind the producer. 342 mutable bool mConsumerRunningBehind; 343 344 // mMutex is the mutex used to prevent concurrent access to the member 345 // variables of Surface objects. It must be locked whenever the 346 // member variables are accessed. 347 mutable Mutex mMutex; 348 349 // must be used from the lock/unlock thread 350 sp<GraphicBuffer> mLockedBuffer; 351 sp<GraphicBuffer> mPostedBuffer; 352 bool mConnectedToCpu; 353 354 // When a CPU producer is attached, this reflects the region that the 355 // producer wished to update as well as whether the Surface was able to copy 356 // the previous buffer back to allow a partial update. 357 // 358 // When a non-CPU producer is attached, this reflects the surface damage 359 // (the change since the previous frame) passed in by the producer. 360 Region mDirtyRegion; 361 362 // Stores the current generation number. See setGenerationNumber and 363 // IGraphicBufferProducer::setGenerationNumber for more information. 364 uint32_t mGenerationNumber; 365 366 // Caches the values that have been passed to the producer. 367 bool mSharedBufferMode; 368 bool mAutoRefresh; 369 370 // If in shared buffer mode and auto refresh is enabled, store the shared 371 // buffer slot and return it for all calls to queue/dequeue without going 372 // over Binder. 373 int mSharedBufferSlot; 374 375 // This is true if the shared buffer has already been queued/canceled. It's 376 // used to prevent a mismatch between the number of queue/dequeue calls. 377 bool mSharedBufferHasBeenQueued; 378 379 // These are used to satisfy the NATIVE_WINDOW_LAST_*_DURATION queries 380 nsecs_t mLastDequeueDuration = 0; 381 nsecs_t mLastQueueDuration = 0; 382 383 Condition mQueueBufferCondition; 384 385 uint64_t mNextFrameNumber; 386 387 // Mutable because ANativeWindow::query needs this class const. 388 mutable bool mQueriedSupportedTimestamps; 389 mutable bool mFrameTimestampsSupportsPresent; 390 mutable bool mFrameTimestampsSupportsRetire; 391}; 392 393namespace view { 394 395/** 396 * A simple holder for an IGraphicBufferProducer, to match the managed-side 397 * android.view.Surface parcelable behavior. 398 * 399 * This implements android/view/Surface.aidl 400 * 401 * TODO: Convert IGraphicBufferProducer into AIDL so that it can be directly 402 * used in managed Binder calls. 403 */ 404class Surface : public Parcelable { 405 public: 406 407 String16 name; 408 sp<IGraphicBufferProducer> graphicBufferProducer; 409 410 virtual status_t writeToParcel(Parcel* parcel) const override; 411 virtual status_t readFromParcel(const Parcel* parcel) override; 412 413 // nameAlreadyWritten set to true by Surface.java, because it splits 414 // Parceling itself between managed and native code, so it only wants a part 415 // of the full parceling to happen on its native side. 416 status_t writeToParcel(Parcel* parcel, bool nameAlreadyWritten) const; 417 418 // nameAlreadyRead set to true by Surface.java, because it splits 419 // Parceling itself between managed and native code, so it only wants a part 420 // of the full parceling to happen on its native side. 421 status_t readFromParcel(const Parcel* parcel, bool nameAlreadyRead); 422 423 private: 424 425 static String16 readMaybeEmptyString16(const Parcel* parcel); 426}; 427 428} // namespace view 429 430}; // namespace android 431 432#endif // ANDROID_GUI_SURFACE_H 433