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