Surface.h revision 7cdd786fa80cf03551291ae8feca7b77583be1c5
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/GLConsumer.h> 22#include <gui/BufferQueue.h> 23 24#include <ui/ANativeObjectBase.h> 25#include <ui/Region.h> 26 27#include <utils/RefBase.h> 28#include <utils/threads.h> 29#include <utils/KeyedVector.h> 30 31struct ANativeWindow_Buffer; 32 33namespace android { 34 35/* 36 * An implementation of ANativeWindow that feeds graphics buffers into a 37 * BufferQueue. 38 * 39 * This is typically used by programs that want to render frames through 40 * some means (maybe OpenGL, a software renderer, or a hardware decoder) 41 * and have the frames they create forwarded to SurfaceFlinger for 42 * compositing. For example, a video decoder could render a frame and call 43 * eglSwapBuffers(), which invokes ANativeWindow callbacks defined by 44 * Surface. Surface then forwards the buffers through Binder IPC 45 * to the BufferQueue's producer interface, providing the new frame to a 46 * consumer such as GLConsumer. 47 */ 48class Surface 49 : public ANativeObjectBase<ANativeWindow, Surface, RefBase> 50{ 51public: 52 53 /* 54 * creates a Surface from the given IGraphicBufferProducer (which concrete 55 * implementation is a BufferQueue). 56 * 57 * Surface is mainly state-less while it's disconnected, it can be 58 * viewed as a glorified IGraphicBufferProducer holder. It's therefore 59 * safe to create other Surfaces from the same IGraphicBufferProducer. 60 * 61 * However, once a Surface is connected, it'll prevent other Surfaces 62 * referring to the same IGraphicBufferProducer to become connected and 63 * therefore prevent them to be used as actual producers of buffers. 64 * 65 * the controlledByApp flag indicates that this Surface (producer) is 66 * controlled by the application. This flag is used at connect time. 67 */ 68 Surface(const sp<IGraphicBufferProducer>& bufferProducer, bool controlledByApp = false); 69 70 /* getIGraphicBufferProducer() returns the IGraphicBufferProducer this 71 * Surface was created with. Usually it's an error to use the 72 * IGraphicBufferProducer while the Surface is connected. 73 */ 74 sp<IGraphicBufferProducer> getIGraphicBufferProducer() const; 75 76 /* convenience function to check that the given surface is non NULL as 77 * well as its IGraphicBufferProducer */ 78 static bool isValid(const sp<Surface>& surface) { 79 return surface != NULL && surface->getIGraphicBufferProducer() != NULL; 80 } 81 82protected: 83 virtual ~Surface(); 84 85private: 86 // can't be copied 87 Surface& operator = (const Surface& rhs); 88 Surface(const Surface& rhs); 89 90 // ANativeWindow hooks 91 static int hook_cancelBuffer(ANativeWindow* window, 92 ANativeWindowBuffer* buffer, int fenceFd); 93 static int hook_dequeueBuffer(ANativeWindow* window, 94 ANativeWindowBuffer** buffer, int* fenceFd); 95 static int hook_perform(ANativeWindow* window, int operation, ...); 96 static int hook_query(const ANativeWindow* window, int what, int* value); 97 static int hook_queueBuffer(ANativeWindow* window, 98 ANativeWindowBuffer* buffer, int fenceFd); 99 static int hook_setSwapInterval(ANativeWindow* window, int interval); 100 101 static int hook_cancelBuffer_DEPRECATED(ANativeWindow* window, 102 ANativeWindowBuffer* buffer); 103 static int hook_dequeueBuffer_DEPRECATED(ANativeWindow* window, 104 ANativeWindowBuffer** buffer); 105 static int hook_lockBuffer_DEPRECATED(ANativeWindow* window, 106 ANativeWindowBuffer* buffer); 107 static int hook_queueBuffer_DEPRECATED(ANativeWindow* window, 108 ANativeWindowBuffer* buffer); 109 110 int dispatchConnect(va_list args); 111 int dispatchDisconnect(va_list args); 112 int dispatchSetBufferCount(va_list args); 113 int dispatchSetBuffersGeometry(va_list args); 114 int dispatchSetBuffersDimensions(va_list args); 115 int dispatchSetBuffersUserDimensions(va_list args); 116 int dispatchSetBuffersFormat(va_list args); 117 int dispatchSetScalingMode(va_list args); 118 int dispatchSetBuffersTransform(va_list args); 119 int dispatchSetBuffersTimestamp(va_list args); 120 int dispatchSetCrop(va_list args); 121 int dispatchSetPostTransformCrop(va_list args); 122 int dispatchSetUsage(va_list args); 123 int dispatchLock(va_list args); 124 int dispatchUnlockAndPost(va_list args); 125 126protected: 127 virtual int dequeueBuffer(ANativeWindowBuffer** buffer, int* fenceFd); 128 virtual int cancelBuffer(ANativeWindowBuffer* buffer, int fenceFd); 129 virtual int queueBuffer(ANativeWindowBuffer* buffer, int fenceFd); 130 virtual int perform(int operation, va_list args); 131 virtual int query(int what, int* value) const; 132 virtual int setSwapInterval(int interval); 133 134 virtual int lockBuffer_DEPRECATED(ANativeWindowBuffer* buffer); 135 136 virtual int connect(int api); 137 virtual int disconnect(int api); 138 virtual int setBufferCount(int bufferCount); 139 virtual int setBuffersDimensions(int w, int h); 140 virtual int setBuffersUserDimensions(int w, int h); 141 virtual int setBuffersFormat(int format); 142 virtual int setScalingMode(int mode); 143 virtual int setBuffersTransform(int transform); 144 virtual int setBuffersTimestamp(int64_t timestamp); 145 virtual int setCrop(Rect const* rect); 146 virtual int setUsage(uint32_t reqUsage); 147 148public: 149 virtual int lock(ANativeWindow_Buffer* outBuffer, ARect* inOutDirtyBounds); 150 virtual int unlockAndPost(); 151 152protected: 153 enum { NUM_BUFFER_SLOTS = BufferQueue::NUM_BUFFER_SLOTS }; 154 enum { DEFAULT_FORMAT = PIXEL_FORMAT_RGBA_8888 }; 155 156private: 157 void freeAllBuffers(); 158 int getSlotFromBufferLocked(android_native_buffer_t* buffer) const; 159 160 struct BufferSlot { 161 sp<GraphicBuffer> buffer; 162 Region dirtyRegion; 163 }; 164 165 // mSurfaceTexture is the interface to the surface texture server. All 166 // operations on the surface texture client ultimately translate into 167 // interactions with the server using this interface. 168 // TODO: rename to mBufferProducer 169 sp<IGraphicBufferProducer> mGraphicBufferProducer; 170 171 // mSlots stores the buffers that have been allocated for each buffer slot. 172 // It is initialized to null pointers, and gets filled in with the result of 173 // IGraphicBufferProducer::requestBuffer when the client dequeues a buffer from a 174 // slot that has not yet been used. The buffer allocated to a slot will also 175 // be replaced if the requested buffer usage or geometry differs from that 176 // of the buffer allocated to a slot. 177 BufferSlot mSlots[NUM_BUFFER_SLOTS]; 178 179 // mReqWidth is the buffer width that will be requested at the next dequeue 180 // operation. It is initialized to 1. 181 uint32_t mReqWidth; 182 183 // mReqHeight is the buffer height that will be requested at the next 184 // dequeue operation. It is initialized to 1. 185 uint32_t mReqHeight; 186 187 // mReqFormat is the buffer pixel format that will be requested at the next 188 // deuque operation. It is initialized to PIXEL_FORMAT_RGBA_8888. 189 uint32_t mReqFormat; 190 191 // mReqUsage is the set of buffer usage flags that will be requested 192 // at the next deuque operation. It is initialized to 0. 193 uint32_t mReqUsage; 194 195 // mTimestamp is the timestamp that will be used for the next buffer queue 196 // operation. It defaults to NATIVE_WINDOW_TIMESTAMP_AUTO, which means that 197 // a timestamp is auto-generated when queueBuffer is called. 198 int64_t mTimestamp; 199 200 // mCrop is the crop rectangle that will be used for the next buffer 201 // that gets queued. It is set by calling setCrop. 202 Rect mCrop; 203 204 // mScalingMode is the scaling mode that will be used for the next 205 // buffers that get queued. It is set by calling setScalingMode. 206 int mScalingMode; 207 208 // mTransform is the transform identifier that will be used for the next 209 // buffer that gets queued. It is set by calling setTransform. 210 uint32_t mTransform; 211 212 // mDefaultWidth is default width of the buffers, regardless of the 213 // native_window_set_buffers_dimensions call. 214 uint32_t mDefaultWidth; 215 216 // mDefaultHeight is default height of the buffers, regardless of the 217 // native_window_set_buffers_dimensions call. 218 uint32_t mDefaultHeight; 219 220 // mUserWidth, if non-zero, is an application-specified override 221 // of mDefaultWidth. This is lower priority than the width set by 222 // native_window_set_buffers_dimensions. 223 uint32_t mUserWidth; 224 225 // mUserHeight, if non-zero, is an application-specified override 226 // of mDefaultHeight. This is lower priority than the height set 227 // by native_window_set_buffers_dimensions. 228 uint32_t mUserHeight; 229 230 // mTransformHint is the transform probably applied to buffers of this 231 // window. this is only a hint, actual transform may differ. 232 uint32_t mTransformHint; 233 234 // mProducerControlledByApp whether this buffer producer is controlled 235 // by the application 236 bool mProducerControlledByApp; 237 238 // mSwapIntervalZero set if we should drop buffers at queue() time to 239 // achieve an asynchronous swap interval 240 bool mSwapIntervalZero; 241 242 // mConsumerRunningBehind whether the consumer is running more than 243 // one buffer behind the producer. 244 mutable bool mConsumerRunningBehind; 245 246 // mMutex is the mutex used to prevent concurrent access to the member 247 // variables of Surface objects. It must be locked whenever the 248 // member variables are accessed. 249 mutable Mutex mMutex; 250 251 // must be used from the lock/unlock thread 252 sp<GraphicBuffer> mLockedBuffer; 253 sp<GraphicBuffer> mPostedBuffer; 254 bool mConnectedToCpu; 255 256 // must be accessed from lock/unlock thread only 257 Region mDirtyRegion; 258}; 259 260}; // namespace android 261 262#endif // ANDROID_GUI_SURFACE_H 263