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