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