Surface.h revision 5065a55291b67f584d7b0be3fa3cfc4e29a3cd1c
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 104protected: 105 virtual ~Surface(); 106 107private: 108 // can't be copied 109 Surface& operator = (const Surface& rhs); 110 Surface(const Surface& rhs); 111 112 // ANativeWindow hooks 113 static int hook_cancelBuffer(ANativeWindow* window, 114 ANativeWindowBuffer* buffer, int fenceFd); 115 static int hook_dequeueBuffer(ANativeWindow* window, 116 ANativeWindowBuffer** buffer, int* fenceFd); 117 static int hook_perform(ANativeWindow* window, int operation, ...); 118 static int hook_query(const ANativeWindow* window, int what, int* value); 119 static int hook_queueBuffer(ANativeWindow* window, 120 ANativeWindowBuffer* buffer, int fenceFd); 121 static int hook_setSwapInterval(ANativeWindow* window, int interval); 122 123 static int hook_cancelBuffer_DEPRECATED(ANativeWindow* window, 124 ANativeWindowBuffer* buffer); 125 static int hook_dequeueBuffer_DEPRECATED(ANativeWindow* window, 126 ANativeWindowBuffer** buffer); 127 static int hook_lockBuffer_DEPRECATED(ANativeWindow* window, 128 ANativeWindowBuffer* buffer); 129 static int hook_queueBuffer_DEPRECATED(ANativeWindow* window, 130 ANativeWindowBuffer* buffer); 131 132 int dispatchConnect(va_list args); 133 int dispatchDisconnect(va_list args); 134 int dispatchSetBufferCount(va_list args); 135 int dispatchSetBuffersGeometry(va_list args); 136 int dispatchSetBuffersDimensions(va_list args); 137 int dispatchSetBuffersUserDimensions(va_list args); 138 int dispatchSetBuffersFormat(va_list args); 139 int dispatchSetScalingMode(va_list args); 140 int dispatchSetBuffersTransform(va_list args); 141 int dispatchSetBuffersStickyTransform(va_list args); 142 int dispatchSetBuffersTimestamp(va_list args); 143 int dispatchSetCrop(va_list args); 144 int dispatchSetPostTransformCrop(va_list args); 145 int dispatchSetUsage(va_list args); 146 int dispatchLock(va_list args); 147 int dispatchUnlockAndPost(va_list args); 148 int dispatchSetSidebandStream(va_list args); 149 int dispatchSetBuffersDataSpace(va_list args); 150 int dispatchSetSurfaceDamage(va_list args); 151 152protected: 153 virtual int dequeueBuffer(ANativeWindowBuffer** buffer, int* fenceFd); 154 virtual int cancelBuffer(ANativeWindowBuffer* buffer, int fenceFd); 155 virtual int queueBuffer(ANativeWindowBuffer* buffer, int fenceFd); 156 virtual int perform(int operation, va_list args); 157 virtual int query(int what, int* value) const; 158 virtual int setSwapInterval(int interval); 159 160 virtual int lockBuffer_DEPRECATED(ANativeWindowBuffer* buffer); 161 162 virtual int connect(int api); 163 virtual int disconnect(int api); 164 virtual int setBufferCount(int bufferCount); 165 virtual int setBuffersDimensions(uint32_t width, uint32_t height); 166 virtual int setBuffersUserDimensions(uint32_t width, uint32_t height); 167 virtual int setBuffersFormat(PixelFormat format); 168 virtual int setScalingMode(int mode); 169 virtual int setBuffersTransform(uint32_t transform); 170 virtual int setBuffersStickyTransform(uint32_t transform); 171 virtual int setBuffersTimestamp(int64_t timestamp); 172 virtual int setBuffersDataSpace(android_dataspace dataSpace); 173 virtual int setCrop(Rect const* rect); 174 virtual int setUsage(uint32_t reqUsage); 175 virtual void setSurfaceDamage(android_native_rect_t* rects, size_t numRects); 176 177public: 178 virtual int lock(ANativeWindow_Buffer* outBuffer, ARect* inOutDirtyBounds); 179 virtual int unlockAndPost(); 180 181 virtual int connect(int api, const sp<IProducerListener>& listener); 182 virtual int detachNextBuffer(ANativeWindowBuffer** outBuffer, 183 sp<Fence>* outFence); 184 virtual int attachBuffer(ANativeWindowBuffer*); 185 186protected: 187 enum { NUM_BUFFER_SLOTS = BufferQueue::NUM_BUFFER_SLOTS }; 188 enum { DEFAULT_FORMAT = PIXEL_FORMAT_RGBA_8888 }; 189 190private: 191 void freeAllBuffers(); 192 int getSlotFromBufferLocked(android_native_buffer_t* buffer) const; 193 194 struct BufferSlot { 195 sp<GraphicBuffer> buffer; 196 Region dirtyRegion; 197 }; 198 199 // mSurfaceTexture is the interface to the surface texture server. All 200 // operations on the surface texture client ultimately translate into 201 // interactions with the server using this interface. 202 // TODO: rename to mBufferProducer 203 sp<IGraphicBufferProducer> mGraphicBufferProducer; 204 205 // mSlots stores the buffers that have been allocated for each buffer slot. 206 // It is initialized to null pointers, and gets filled in with the result of 207 // IGraphicBufferProducer::requestBuffer when the client dequeues a buffer from a 208 // slot that has not yet been used. The buffer allocated to a slot will also 209 // be replaced if the requested buffer usage or geometry differs from that 210 // of the buffer allocated to a slot. 211 BufferSlot mSlots[NUM_BUFFER_SLOTS]; 212 213 // mReqWidth is the buffer width that will be requested at the next dequeue 214 // operation. It is initialized to 1. 215 uint32_t mReqWidth; 216 217 // mReqHeight is the buffer height that will be requested at the next 218 // dequeue operation. It is initialized to 1. 219 uint32_t mReqHeight; 220 221 // mReqFormat is the buffer pixel format that will be requested at the next 222 // deuque operation. It is initialized to PIXEL_FORMAT_RGBA_8888. 223 PixelFormat mReqFormat; 224 225 // mReqUsage is the set of buffer usage flags that will be requested 226 // at the next deuque operation. It is initialized to 0. 227 uint32_t mReqUsage; 228 229 // mTimestamp is the timestamp that will be used for the next buffer queue 230 // operation. It defaults to NATIVE_WINDOW_TIMESTAMP_AUTO, which means that 231 // a timestamp is auto-generated when queueBuffer is called. 232 int64_t mTimestamp; 233 234 // mDataSpace is the buffer dataSpace that will be used for the next buffer 235 // queue operation. It defaults to HAL_DATASPACE_UNKNOWN, which 236 // means that the buffer contains some type of color data. 237 android_dataspace mDataSpace; 238 239 // mCrop is the crop rectangle that will be used for the next buffer 240 // that gets queued. It is set by calling setCrop. 241 Rect mCrop; 242 243 // mScalingMode is the scaling mode that will be used for the next 244 // buffers that get queued. It is set by calling setScalingMode. 245 int mScalingMode; 246 247 // mTransform is the transform identifier that will be used for the next 248 // buffer that gets queued. It is set by calling setTransform. 249 uint32_t mTransform; 250 251 // mStickyTransform is a transform that is applied on top of mTransform 252 // in each buffer that is queued. This is typically used to force the 253 // compositor to apply a transform, and will prevent the transform hint 254 // from being set by the compositor. 255 uint32_t mStickyTransform; 256 257 // mDefaultWidth is default width of the buffers, regardless of the 258 // native_window_set_buffers_dimensions call. 259 uint32_t mDefaultWidth; 260 261 // mDefaultHeight is default height of the buffers, regardless of the 262 // native_window_set_buffers_dimensions call. 263 uint32_t mDefaultHeight; 264 265 // mUserWidth, if non-zero, is an application-specified override 266 // of mDefaultWidth. This is lower priority than the width set by 267 // native_window_set_buffers_dimensions. 268 uint32_t mUserWidth; 269 270 // mUserHeight, if non-zero, is an application-specified override 271 // of mDefaultHeight. This is lower priority than the height set 272 // by native_window_set_buffers_dimensions. 273 uint32_t mUserHeight; 274 275 // mTransformHint is the transform probably applied to buffers of this 276 // window. this is only a hint, actual transform may differ. 277 uint32_t mTransformHint; 278 279 // mProducerControlledByApp whether this buffer producer is controlled 280 // by the application 281 bool mProducerControlledByApp; 282 283 // mSwapIntervalZero set if we should drop buffers at queue() time to 284 // achieve an asynchronous swap interval 285 bool mSwapIntervalZero; 286 287 // mConsumerRunningBehind whether the consumer is running more than 288 // one buffer behind the producer. 289 mutable bool mConsumerRunningBehind; 290 291 // mMutex is the mutex used to prevent concurrent access to the member 292 // variables of Surface objects. It must be locked whenever the 293 // member variables are accessed. 294 mutable Mutex mMutex; 295 296 // must be used from the lock/unlock thread 297 sp<GraphicBuffer> mLockedBuffer; 298 sp<GraphicBuffer> mPostedBuffer; 299 bool mConnectedToCpu; 300 301 // In the lock/unlock context, this reflects the region that the producer 302 // wished to update and whether the Surface was able to copy the previous 303 // buffer back to allow a partial update. 304 // 305 // In the dequeue/queue context, this reflects the surface damage (the 306 // damage since the last frame) passed in by the producer. 307 Region mDirtyRegion; 308}; 309 310}; // namespace android 311 312#endif // ANDROID_GUI_SURFACE_H 313