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