Surface.h revision ff95aabbcc6e8606acbd7933c90eeb9b8b382a21
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 <utils/RefBase.h> 27#include <utils/threads.h> 28#include <utils/KeyedVector.h> 29 30struct ANativeWindow_Buffer; 31 32namespace android { 33 34/* 35 * An implementation of ANativeWindow that feeds graphics buffers into a 36 * BufferQueue. 37 * 38 * This is typically used by programs that want to render frames through 39 * some means (maybe OpenGL, a software renderer, or a hardware decoder) 40 * and have the frames they create forwarded to SurfaceFlinger for 41 * compositing. For example, a video decoder could render a frame and call 42 * eglSwapBuffers(), which invokes ANativeWindow callbacks defined by 43 * Surface. Surface then forwards the buffers through Binder IPC 44 * to the BufferQueue's producer interface, providing the new frame to a 45 * consumer such as GLConsumer. 46 */ 47class Surface 48 : public ANativeObjectBase<ANativeWindow, Surface, RefBase> 49{ 50public: 51 52 /* 53 * creates a Surface from the given IGraphicBufferProducer (which concrete 54 * implementation is a BufferQueue). 55 * 56 * Surface is mainly state-less while it's disconnected, it can be 57 * viewed as a glorified IGraphicBufferProducer holder. It's therefore 58 * safe to create other Surfaces from the same IGraphicBufferProducer. 59 * 60 * However, once a Surface is connected, it'll prevent other Surfaces 61 * referring to the same IGraphicBufferProducer to become connected and 62 * therefore prevent them to be used as actual producers of buffers. 63 * 64 * the controlledByApp flag indicates that this Surface (producer) is 65 * controlled by the application. This flag is used at connect time. 66 */ 67 Surface(const sp<IGraphicBufferProducer>& bufferProducer, bool controlledByApp = false); 68 69 /* getIGraphicBufferProducer() returns the IGraphicBufferProducer this 70 * Surface was created with. Usually it's an error to use the 71 * IGraphicBufferProducer while the Surface is connected. 72 */ 73 sp<IGraphicBufferProducer> getIGraphicBufferProducer() const; 74 75 /* convenience function to check that the given surface is non NULL as 76 * well as its IGraphicBufferProducer */ 77 static bool isValid(const sp<Surface>& surface) { 78 return surface != NULL && surface->getIGraphicBufferProducer() != NULL; 79 } 80 81 /* Attaches a sideband buffer stream to the Surface's IGraphicBufferProducer. 82 * 83 * A sideband stream is a device-specific mechanism for passing buffers 84 * from the producer to the consumer without using dequeueBuffer/ 85 * queueBuffer. If a sideband stream is present, the consumer can choose 86 * whether to acquire buffers from the sideband stream or from the queued 87 * buffers. 88 * 89 * Passing NULL or a different stream handle will detach the previous 90 * handle if any. 91 */ 92 void setSidebandStream(const sp<NativeHandle>& stream); 93 94 /* Allocates buffers based on the current dimensions/format. 95 * 96 * This function will allocate up to the maximum number of buffers 97 * permitted by the current BufferQueue configuration. It will use the 98 * default format and dimensions. This is most useful to avoid an allocation 99 * delay during dequeueBuffer. If there are already the maximum number of 100 * buffers allocated, this function has no effect. 101 */ 102 void allocateBuffers(); 103 104 /* Sets the generation number on the IGraphicBufferProducer and updates the 105 * generation number on any buffers attached to the Surface after this call. 106 * See IGBP::setGenerationNumber for more information. */ 107 status_t setGenerationNumber(uint32_t generationNumber); 108 109 // See IGraphicBufferProducer::getConsumerName 110 String8 getConsumerName() const; 111 112 // See IGraphicBufferProducer::getNextFrameNumber 113 uint64_t getNextFrameNumber() const; 114 115 /* Set the scaling mode to be used with a Surface. 116 * See NATIVE_WINDOW_SET_SCALING_MODE and its parameters 117 * in <system/window.h>. */ 118 int setScalingMode(int mode); 119 120 // See IGraphicBufferProducer::setDequeueTimeout 121 status_t setDequeueTimeout(nsecs_t timeout); 122 123protected: 124 virtual ~Surface(); 125 126private: 127 // can't be copied 128 Surface& operator = (const Surface& rhs); 129 Surface(const Surface& rhs); 130 131 // ANativeWindow hooks 132 static int hook_cancelBuffer(ANativeWindow* window, 133 ANativeWindowBuffer* buffer, int fenceFd); 134 static int hook_dequeueBuffer(ANativeWindow* window, 135 ANativeWindowBuffer** buffer, int* fenceFd); 136 static int hook_perform(ANativeWindow* window, int operation, ...); 137 static int hook_query(const ANativeWindow* window, int what, int* value); 138 static int hook_queueBuffer(ANativeWindow* window, 139 ANativeWindowBuffer* buffer, int fenceFd); 140 static int hook_setSwapInterval(ANativeWindow* window, int interval); 141 142 static int hook_cancelBuffer_DEPRECATED(ANativeWindow* window, 143 ANativeWindowBuffer* buffer); 144 static int hook_dequeueBuffer_DEPRECATED(ANativeWindow* window, 145 ANativeWindowBuffer** buffer); 146 static int hook_lockBuffer_DEPRECATED(ANativeWindow* window, 147 ANativeWindowBuffer* buffer); 148 static int hook_queueBuffer_DEPRECATED(ANativeWindow* window, 149 ANativeWindowBuffer* buffer); 150 151 int dispatchConnect(va_list args); 152 int dispatchDisconnect(va_list args); 153 int dispatchSetBufferCount(va_list args); 154 int dispatchSetBuffersGeometry(va_list args); 155 int dispatchSetBuffersDimensions(va_list args); 156 int dispatchSetBuffersUserDimensions(va_list args); 157 int dispatchSetBuffersFormat(va_list args); 158 int dispatchSetScalingMode(va_list args); 159 int dispatchSetBuffersTransform(va_list args); 160 int dispatchSetBuffersStickyTransform(va_list args); 161 int dispatchSetBuffersTimestamp(va_list args); 162 int dispatchSetCrop(va_list args); 163 int dispatchSetPostTransformCrop(va_list args); 164 int dispatchSetUsage(va_list args); 165 int dispatchLock(va_list args); 166 int dispatchUnlockAndPost(va_list args); 167 int dispatchSetSidebandStream(va_list args); 168 int dispatchSetBuffersDataSpace(va_list args); 169 int dispatchSetSurfaceDamage(va_list args); 170 int dispatchSetSingleBufferMode(va_list args); 171 int dispatchSetAutoRefresh(va_list args); 172 173protected: 174 virtual int dequeueBuffer(ANativeWindowBuffer** buffer, int* fenceFd); 175 virtual int cancelBuffer(ANativeWindowBuffer* buffer, int fenceFd); 176 virtual int queueBuffer(ANativeWindowBuffer* buffer, int fenceFd); 177 virtual int perform(int operation, va_list args); 178 virtual int query(int what, int* value) const; 179 virtual int setSwapInterval(int interval); 180 181 virtual int lockBuffer_DEPRECATED(ANativeWindowBuffer* buffer); 182 183 virtual int connect(int api); 184 virtual int disconnect(int api); 185 virtual int setBufferCount(int bufferCount); 186 virtual int setBuffersDimensions(uint32_t width, uint32_t height); 187 virtual int setBuffersUserDimensions(uint32_t width, uint32_t height); 188 virtual int setBuffersFormat(PixelFormat format); 189 virtual int setBuffersTransform(uint32_t transform); 190 virtual int setBuffersStickyTransform(uint32_t transform); 191 virtual int setBuffersTimestamp(int64_t timestamp); 192 virtual int setBuffersDataSpace(android_dataspace dataSpace); 193 virtual int setCrop(Rect const* rect); 194 virtual int setUsage(uint32_t reqUsage); 195 virtual void setSurfaceDamage(android_native_rect_t* rects, size_t numRects); 196 197public: 198 virtual int setMaxDequeuedBufferCount(int maxDequeuedBuffers); 199 virtual int setAsyncMode(bool async); 200 virtual int setSingleBufferMode(bool singleBufferMode); 201 virtual int setAutoRefresh(bool autoRefresh); 202 virtual int lock(ANativeWindow_Buffer* outBuffer, ARect* inOutDirtyBounds); 203 virtual int unlockAndPost(); 204 205 virtual int connect(int api, const sp<IProducerListener>& listener); 206 virtual int detachNextBuffer(sp<GraphicBuffer>* outBuffer, 207 sp<Fence>* outFence); 208 virtual int attachBuffer(ANativeWindowBuffer*); 209 210protected: 211 enum { NUM_BUFFER_SLOTS = BufferQueue::NUM_BUFFER_SLOTS }; 212 enum { DEFAULT_FORMAT = PIXEL_FORMAT_RGBA_8888 }; 213 214private: 215 void freeAllBuffers(); 216 int getSlotFromBufferLocked(android_native_buffer_t* buffer) const; 217 218 struct BufferSlot { 219 sp<GraphicBuffer> buffer; 220 Region dirtyRegion; 221 }; 222 223 // mSurfaceTexture is the interface to the surface texture server. All 224 // operations on the surface texture client ultimately translate into 225 // interactions with the server using this interface. 226 // TODO: rename to mBufferProducer 227 sp<IGraphicBufferProducer> mGraphicBufferProducer; 228 229 // mSlots stores the buffers that have been allocated for each buffer slot. 230 // It is initialized to null pointers, and gets filled in with the result of 231 // IGraphicBufferProducer::requestBuffer when the client dequeues a buffer from a 232 // slot that has not yet been used. The buffer allocated to a slot will also 233 // be replaced if the requested buffer usage or geometry differs from that 234 // of the buffer allocated to a slot. 235 BufferSlot mSlots[NUM_BUFFER_SLOTS]; 236 237 // mReqWidth is the buffer width that will be requested at the next dequeue 238 // operation. It is initialized to 1. 239 uint32_t mReqWidth; 240 241 // mReqHeight is the buffer height that will be requested at the next 242 // dequeue operation. It is initialized to 1. 243 uint32_t mReqHeight; 244 245 // mReqFormat is the buffer pixel format that will be requested at the next 246 // deuque operation. It is initialized to PIXEL_FORMAT_RGBA_8888. 247 PixelFormat mReqFormat; 248 249 // mReqUsage is the set of buffer usage flags that will be requested 250 // at the next deuque operation. It is initialized to 0. 251 uint32_t mReqUsage; 252 253 // mTimestamp is the timestamp that will be used for the next buffer queue 254 // operation. It defaults to NATIVE_WINDOW_TIMESTAMP_AUTO, which means that 255 // a timestamp is auto-generated when queueBuffer is called. 256 int64_t mTimestamp; 257 258 // mDataSpace is the buffer dataSpace that will be used for the next buffer 259 // queue operation. It defaults to HAL_DATASPACE_UNKNOWN, which 260 // means that the buffer contains some type of color data. 261 android_dataspace mDataSpace; 262 263 // mCrop is the crop rectangle that will be used for the next buffer 264 // that gets queued. It is set by calling setCrop. 265 Rect mCrop; 266 267 // mScalingMode is the scaling mode that will be used for the next 268 // buffers that get queued. It is set by calling setScalingMode. 269 int mScalingMode; 270 271 // mTransform is the transform identifier that will be used for the next 272 // buffer that gets queued. It is set by calling setTransform. 273 uint32_t mTransform; 274 275 // mStickyTransform is a transform that is applied on top of mTransform 276 // in each buffer that is queued. This is typically used to force the 277 // compositor to apply a transform, and will prevent the transform hint 278 // from being set by the compositor. 279 uint32_t mStickyTransform; 280 281 // mDefaultWidth is default width of the buffers, regardless of the 282 // native_window_set_buffers_dimensions call. 283 uint32_t mDefaultWidth; 284 285 // mDefaultHeight is default height of the buffers, regardless of the 286 // native_window_set_buffers_dimensions call. 287 uint32_t mDefaultHeight; 288 289 // mUserWidth, if non-zero, is an application-specified override 290 // of mDefaultWidth. This is lower priority than the width set by 291 // native_window_set_buffers_dimensions. 292 uint32_t mUserWidth; 293 294 // mUserHeight, if non-zero, is an application-specified override 295 // of mDefaultHeight. This is lower priority than the height set 296 // by native_window_set_buffers_dimensions. 297 uint32_t mUserHeight; 298 299 // mTransformHint is the transform probably applied to buffers of this 300 // window. this is only a hint, actual transform may differ. 301 uint32_t mTransformHint; 302 303 // mProducerControlledByApp whether this buffer producer is controlled 304 // by the application 305 bool mProducerControlledByApp; 306 307 // mSwapIntervalZero set if we should drop buffers at queue() time to 308 // achieve an asynchronous swap interval 309 bool mSwapIntervalZero; 310 311 // mConsumerRunningBehind whether the consumer is running more than 312 // one buffer behind the producer. 313 mutable bool mConsumerRunningBehind; 314 315 // mMutex is the mutex used to prevent concurrent access to the member 316 // variables of Surface objects. It must be locked whenever the 317 // member variables are accessed. 318 mutable Mutex mMutex; 319 320 // must be used from the lock/unlock thread 321 sp<GraphicBuffer> mLockedBuffer; 322 sp<GraphicBuffer> mPostedBuffer; 323 bool mConnectedToCpu; 324 325 // When a CPU producer is attached, this reflects the region that the 326 // producer wished to update as well as whether the Surface was able to copy 327 // the previous buffer back to allow a partial update. 328 // 329 // When a non-CPU producer is attached, this reflects the surface damage 330 // (the change since the previous frame) passed in by the producer. 331 Region mDirtyRegion; 332 333 // Stores the current generation number. See setGenerationNumber and 334 // IGraphicBufferProducer::setGenerationNumber for more information. 335 uint32_t mGenerationNumber; 336 337 // Caches the values that have been passed to the producer. 338 bool mSingleBufferMode; 339 bool mAutoRefresh; 340 341 // If in single buffer mode and auto refresh is enabled, store the shared 342 // buffer slot and return it for all calls to queue/dequeue without going 343 // over Binder. 344 int mSharedBufferSlot; 345 346 // This is true if the shared buffer has already been queued/canceled. It's 347 // used to prevent a mismatch between the number of queue/dequeue calls. 348 bool mSharedBufferHasBeenQueued; 349}; 350 351}; // namespace android 352 353#endif // ANDROID_GUI_SURFACE_H 354