SurfaceTexture.h revision 8e19c2e97e11505ee2ecf336275fd956f2ccfa22
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_SURFACETEXTURE_H 18#define ANDROID_GUI_SURFACETEXTURE_H 19 20#include <EGL/egl.h> 21#include <EGL/eglext.h> 22#include <GLES2/gl2.h> 23 24#include <gui/ISurfaceTexture.h> 25 26#include <ui/GraphicBuffer.h> 27 28#include <utils/threads.h> 29#include <utils/Vector.h> 30 31#define ANDROID_GRAPHICS_SURFACETEXTURE_JNI_ID "mSurfaceTexture" 32 33namespace android { 34// ---------------------------------------------------------------------------- 35 36class IGraphicBufferAlloc; 37class String8; 38 39class SurfaceTexture : public BnSurfaceTexture { 40public: 41 enum { MIN_UNDEQUEUED_BUFFERS = 2 }; 42 enum { 43 MIN_ASYNC_BUFFER_SLOTS = MIN_UNDEQUEUED_BUFFERS + 1, 44 MIN_SYNC_BUFFER_SLOTS = MIN_UNDEQUEUED_BUFFERS 45 }; 46 enum { NUM_BUFFER_SLOTS = 32 }; 47 enum { NO_CONNECTED_API = 0 }; 48 49 struct FrameAvailableListener : public virtual RefBase { 50 // onFrameAvailable() is called from queueBuffer() each time an 51 // additional frame becomes available for consumption. This means that 52 // frames that are queued while in asynchronous mode only trigger the 53 // callback if no previous frames are pending. Frames queued while in 54 // synchronous mode always trigger the callback. 55 // 56 // This is called without any lock held and can be called concurrently 57 // by multiple threads. 58 virtual void onFrameAvailable() = 0; 59 }; 60 61 // tex indicates the name OpenGL texture to which images are to be streamed. 62 // This texture name cannot be changed once the SurfaceTexture is created. 63 SurfaceTexture(GLuint tex, bool allowSynchronousMode = true); 64 65 virtual ~SurfaceTexture(); 66 67 // setBufferCount updates the number of available buffer slots. After 68 // calling this all buffer slots are both unallocated and owned by the 69 // SurfaceTexture object (i.e. they are not owned by the client). 70 virtual status_t setBufferCount(int bufferCount); 71 72 virtual status_t requestBuffer(int slot, sp<GraphicBuffer>* buf); 73 74 // dequeueBuffer gets the next buffer slot index for the client to use. If a 75 // buffer slot is available then that slot index is written to the location 76 // pointed to by the buf argument and a status of OK is returned. If no 77 // slot is available then a status of -EBUSY is returned and buf is 78 // unmodified. 79 virtual status_t dequeueBuffer(int *buf, uint32_t w, uint32_t h, 80 uint32_t format, uint32_t usage); 81 82 // queueBuffer returns a filled buffer to the SurfaceTexture. In addition, a 83 // timestamp must be provided for the buffer. The timestamp is in 84 // nanoseconds, and must be monotonically increasing. Its other semantics 85 // (zero point, etc) are client-dependent and should be documented by the 86 // client. 87 virtual status_t queueBuffer(int buf, int64_t timestamp, 88 uint32_t* outWidth, uint32_t* outHeight, uint32_t* outTransform); 89 virtual void cancelBuffer(int buf); 90 virtual status_t setCrop(const Rect& reg); 91 virtual status_t setTransform(uint32_t transform); 92 virtual status_t setScalingMode(int mode); 93 94 virtual int query(int what, int* value); 95 96 // setSynchronousMode set whether dequeueBuffer is synchronous or 97 // asynchronous. In synchronous mode, dequeueBuffer blocks until 98 // a buffer is available, the currently bound buffer can be dequeued and 99 // queued buffers will be retired in order. 100 // The default mode is asynchronous. 101 virtual status_t setSynchronousMode(bool enabled); 102 103 // connect attempts to connect a client API to the SurfaceTexture. This 104 // must be called before any other ISurfaceTexture methods are called except 105 // for getAllocator. 106 // 107 // This method will fail if the connect was previously called on the 108 // SurfaceTexture and no corresponding disconnect call was made. 109 virtual status_t connect(int api, 110 uint32_t* outWidth, uint32_t* outHeight, uint32_t* outTransform); 111 112 // disconnect attempts to disconnect a client API from the SurfaceTexture. 113 // Calling this method will cause any subsequent calls to other 114 // ISurfaceTexture methods to fail except for getAllocator and connect. 115 // Successfully calling connect after this will allow the other methods to 116 // succeed again. 117 // 118 // This method will fail if the the SurfaceTexture is not currently 119 // connected to the specified client API. 120 virtual status_t disconnect(int api); 121 122 // updateTexImage sets the image contents of the target texture to that of 123 // the most recently queued buffer. 124 // 125 // This call may only be made while the OpenGL ES context to which the 126 // target texture belongs is bound to the calling thread. 127 status_t updateTexImage(); 128 129 // setBufferCountServer set the buffer count. If the client has requested 130 // a buffer count using setBufferCount, the server-buffer count will 131 // take effect once the client sets the count back to zero. 132 status_t setBufferCountServer(int bufferCount); 133 134 // getTransformMatrix retrieves the 4x4 texture coordinate transform matrix 135 // associated with the texture image set by the most recent call to 136 // updateTexImage. 137 // 138 // This transform matrix maps 2D homogeneous texture coordinates of the form 139 // (s, t, 0, 1) with s and t in the inclusive range [0, 1] to the texture 140 // coordinate that should be used to sample that location from the texture. 141 // Sampling the texture outside of the range of this transform is undefined. 142 // 143 // This transform is necessary to compensate for transforms that the stream 144 // content producer may implicitly apply to the content. By forcing users of 145 // a SurfaceTexture to apply this transform we avoid performing an extra 146 // copy of the data that would be needed to hide the transform from the 147 // user. 148 // 149 // The matrix is stored in column-major order so that it may be passed 150 // directly to OpenGL ES via the glLoadMatrixf or glUniformMatrix4fv 151 // functions. 152 void getTransformMatrix(float mtx[16]); 153 154 // getTimestamp retrieves the timestamp associated with the texture image 155 // set by the most recent call to updateTexImage. 156 // 157 // The timestamp is in nanoseconds, and is monotonically increasing. Its 158 // other semantics (zero point, etc) are source-dependent and should be 159 // documented by the source. 160 int64_t getTimestamp(); 161 162 // setFrameAvailableListener sets the listener object that will be notified 163 // when a new frame becomes available. 164 void setFrameAvailableListener(const sp<FrameAvailableListener>& listener); 165 166 // getAllocator retrieves the binder object that must be referenced as long 167 // as the GraphicBuffers dequeued from this SurfaceTexture are referenced. 168 // Holding this binder reference prevents SurfaceFlinger from freeing the 169 // buffers before the client is done with them. 170 sp<IBinder> getAllocator(); 171 172 // setDefaultBufferSize is used to set the size of buffers returned by 173 // requestBuffers when a with and height of zero is requested. 174 // A call to setDefaultBufferSize() may trigger requestBuffers() to 175 // be called from the client. 176 status_t setDefaultBufferSize(uint32_t w, uint32_t h); 177 178 // getCurrentBuffer returns the buffer associated with the current image. 179 sp<GraphicBuffer> getCurrentBuffer() const; 180 181 // getCurrentTextureTarget returns the texture target of the current 182 // texture as returned by updateTexImage(). 183 GLenum getCurrentTextureTarget() const; 184 185 // getCurrentCrop returns the cropping rectangle of the current buffer 186 Rect getCurrentCrop() const; 187 188 // getCurrentTransform returns the transform of the current buffer 189 uint32_t getCurrentTransform() const; 190 191 // getCurrentScalingMode returns the scaling mode of the current buffer 192 uint32_t getCurrentScalingMode() const; 193 194 // abandon frees all the buffers and puts the SurfaceTexture into the 195 // 'abandoned' state. Once put in this state the SurfaceTexture can never 196 // leave it. When in the 'abandoned' state, all methods of the 197 // ISurfaceTexture interface will fail with the NO_INIT error. 198 // 199 // Note that while calling this method causes all the buffers to be freed 200 // from the perspective of the the SurfaceTexture, if there are additional 201 // references on the buffers (e.g. if a buffer is referenced by a client or 202 // by OpenGL ES as a texture) then those buffer will remain allocated. 203 void abandon(); 204 205 // dump our state in a String 206 void dump(String8& result) const; 207 void dump(String8& result, const char* prefix, char* buffer, size_t SIZE) const; 208 209protected: 210 211 // freeBufferLocked frees the resources (both GraphicBuffer and EGLImage) 212 // for the given slot. 213 void freeBufferLocked(int index); 214 215 // freeAllBuffersLocked frees the resources (both GraphicBuffer and 216 // EGLImage) for all slots. 217 void freeAllBuffersLocked(); 218 219 // freeAllBuffersExceptHeadLocked frees the resources (both GraphicBuffer 220 // and EGLImage) for all slots except the head of mQueue 221 void freeAllBuffersExceptHeadLocked(); 222 223 // drainQueueLocked drains the buffer queue if we're in synchronous mode 224 // returns immediately otherwise. return NO_INIT if SurfaceTexture 225 // became abandoned or disconnected during this call. 226 status_t drainQueueLocked(); 227 228 // drainQueueAndFreeBuffersLocked drains the buffer queue if we're in 229 // synchronous mode and free all buffers. In asynchronous mode, all buffers 230 // are freed except the current buffer. 231 status_t drainQueueAndFreeBuffersLocked(); 232 233 static bool isExternalFormat(uint32_t format); 234 235private: 236 237 // createImage creates a new EGLImage from a GraphicBuffer. 238 EGLImageKHR createImage(EGLDisplay dpy, 239 const sp<GraphicBuffer>& graphicBuffer); 240 241 status_t setBufferCountServerLocked(int bufferCount); 242 243 // computeCurrentTransformMatrix computes the transform matrix for the 244 // current texture. It uses mCurrentTransform and the current GraphicBuffer 245 // to compute this matrix and stores it in mCurrentTransformMatrix. 246 void computeCurrentTransformMatrix(); 247 248 enum { INVALID_BUFFER_SLOT = -1 }; 249 250 struct BufferSlot { 251 252 BufferSlot() 253 : mEglImage(EGL_NO_IMAGE_KHR), 254 mEglDisplay(EGL_NO_DISPLAY), 255 mBufferState(BufferSlot::FREE), 256 mRequestBufferCalled(false), 257 mTransform(0), 258 mScalingMode(NATIVE_WINDOW_SCALING_MODE_FREEZE), 259 mTimestamp(0) { 260 mCrop.makeInvalid(); 261 } 262 263 // mGraphicBuffer points to the buffer allocated for this slot or is NULL 264 // if no buffer has been allocated. 265 sp<GraphicBuffer> mGraphicBuffer; 266 267 // mEglImage is the EGLImage created from mGraphicBuffer. 268 EGLImageKHR mEglImage; 269 270 // mEglDisplay is the EGLDisplay used to create mEglImage. 271 EGLDisplay mEglDisplay; 272 273 // BufferState represents the different states in which a buffer slot 274 // can be. 275 enum BufferState { 276 // FREE indicates that the buffer is not currently being used and 277 // will not be used in the future until it gets dequeued and 278 // subseqently queued by the client. 279 FREE = 0, 280 281 // DEQUEUED indicates that the buffer has been dequeued by the 282 // client, but has not yet been queued or canceled. The buffer is 283 // considered 'owned' by the client, and the server should not use 284 // it for anything. 285 // 286 // Note that when in synchronous-mode (mSynchronousMode == true), 287 // the buffer that's currently attached to the texture may be 288 // dequeued by the client. That means that the current buffer can 289 // be in either the DEQUEUED or QUEUED state. In asynchronous mode, 290 // however, the current buffer is always in the QUEUED state. 291 DEQUEUED = 1, 292 293 // QUEUED indicates that the buffer has been queued by the client, 294 // and has not since been made available for the client to dequeue. 295 // Attaching the buffer to the texture does NOT transition the 296 // buffer away from the QUEUED state. However, in Synchronous mode 297 // the current buffer may be dequeued by the client under some 298 // circumstances. See the note about the current buffer in the 299 // documentation for DEQUEUED. 300 QUEUED = 2, 301 }; 302 303 // mBufferState is the current state of this buffer slot. 304 BufferState mBufferState; 305 306 // mRequestBufferCalled is used for validating that the client did 307 // call requestBuffer() when told to do so. Technically this is not 308 // needed but useful for debugging and catching client bugs. 309 bool mRequestBufferCalled; 310 311 // mCrop is the current crop rectangle for this buffer slot. This gets 312 // set to mNextCrop each time queueBuffer gets called for this buffer. 313 Rect mCrop; 314 315 // mTransform is the current transform flags for this buffer slot. This 316 // gets set to mNextTransform each time queueBuffer gets called for this 317 // slot. 318 uint32_t mTransform; 319 320 // mScalingMode is the current scaling mode for this buffer slot. This 321 // gets set to mNextScalingMode each time queueBuffer gets called for 322 // this slot. 323 uint32_t mScalingMode; 324 325 // mTimestamp is the current timestamp for this buffer slot. This gets 326 // to set by queueBuffer each time this slot is queued. 327 int64_t mTimestamp; 328 }; 329 330 // mSlots is the array of buffer slots that must be mirrored on the client 331 // side. This allows buffer ownership to be transferred between the client 332 // and server without sending a GraphicBuffer over binder. The entire array 333 // is initialized to NULL at construction time, and buffers are allocated 334 // for a slot when requestBuffer is called with that slot's index. 335 BufferSlot mSlots[NUM_BUFFER_SLOTS]; 336 337 // mDefaultWidth holds the default width of allocated buffers. It is used 338 // in requestBuffers() if a width and height of zero is specified. 339 uint32_t mDefaultWidth; 340 341 // mDefaultHeight holds the default height of allocated buffers. It is used 342 // in requestBuffers() if a width and height of zero is specified. 343 uint32_t mDefaultHeight; 344 345 // mPixelFormat holds the pixel format of allocated buffers. It is used 346 // in requestBuffers() if a format of zero is specified. 347 uint32_t mPixelFormat; 348 349 // mBufferCount is the number of buffer slots that the client and server 350 // must maintain. It defaults to MIN_ASYNC_BUFFER_SLOTS and can be changed 351 // by calling setBufferCount or setBufferCountServer 352 int mBufferCount; 353 354 // mClientBufferCount is the number of buffer slots requested by the client. 355 // The default is zero, which means the client doesn't care how many buffers 356 // there is. 357 int mClientBufferCount; 358 359 // mServerBufferCount buffer count requested by the server-side 360 int mServerBufferCount; 361 362 // mCurrentTexture is the buffer slot index of the buffer that is currently 363 // bound to the OpenGL texture. It is initialized to INVALID_BUFFER_SLOT, 364 // indicating that no buffer slot is currently bound to the texture. Note, 365 // however, that a value of INVALID_BUFFER_SLOT does not necessarily mean 366 // that no buffer is bound to the texture. A call to setBufferCount will 367 // reset mCurrentTexture to INVALID_BUFFER_SLOT. 368 int mCurrentTexture; 369 370 // mCurrentTextureBuf is the graphic buffer of the current texture. It's 371 // possible that this buffer is not associated with any buffer slot, so we 372 // must track it separately in order to support the getCurrentBuffer method. 373 sp<GraphicBuffer> mCurrentTextureBuf; 374 375 // mCurrentCrop is the crop rectangle that applies to the current texture. 376 // It gets set each time updateTexImage is called. 377 Rect mCurrentCrop; 378 379 // mCurrentTransform is the transform identifier for the current texture. It 380 // gets set each time updateTexImage is called. 381 uint32_t mCurrentTransform; 382 383 // mCurrentScalingMode is the scaling mode for the current texture. It gets 384 // set to each time updateTexImage is called. 385 uint32_t mCurrentScalingMode; 386 387 // mCurrentTransformMatrix is the transform matrix for the current texture. 388 // It gets computed by computeTransformMatrix each time updateTexImage is 389 // called. 390 float mCurrentTransformMatrix[16]; 391 392 // mCurrentTimestamp is the timestamp for the current texture. It 393 // gets set each time updateTexImage is called. 394 int64_t mCurrentTimestamp; 395 396 // mNextCrop is the crop rectangle that will be used for the next buffer 397 // that gets queued. It is set by calling setCrop. 398 Rect mNextCrop; 399 400 // mNextTransform is the transform identifier that will be used for the next 401 // buffer that gets queued. It is set by calling setTransform. 402 uint32_t mNextTransform; 403 404 // mNextScalingMode is the scaling mode that will be used for the next 405 // buffers that get queued. It is set by calling setScalingMode. 406 int mNextScalingMode; 407 408 // mTexName is the name of the OpenGL texture to which streamed images will 409 // be bound when updateTexImage is called. It is set at construction time 410 // changed with a call to setTexName. 411 const GLuint mTexName; 412 413 // mGraphicBufferAlloc is the connection to SurfaceFlinger that is used to 414 // allocate new GraphicBuffer objects. 415 sp<IGraphicBufferAlloc> mGraphicBufferAlloc; 416 417 // mFrameAvailableListener is the listener object that will be called when a 418 // new frame becomes available. If it is not NULL it will be called from 419 // queueBuffer. 420 sp<FrameAvailableListener> mFrameAvailableListener; 421 422 // mSynchronousMode whether we're in synchronous mode or not 423 bool mSynchronousMode; 424 425 // mAllowSynchronousMode whether we allow synchronous mode or not 426 const bool mAllowSynchronousMode; 427 428 // mConnectedApi indicates the API that is currently connected to this 429 // SurfaceTexture. It defaults to NO_CONNECTED_API (= 0), and gets updated 430 // by the connect and disconnect methods. 431 int mConnectedApi; 432 433 // mDequeueCondition condition used for dequeueBuffer in synchronous mode 434 mutable Condition mDequeueCondition; 435 436 // mQueue is a FIFO of queued buffers used in synchronous mode 437 typedef Vector<int> Fifo; 438 Fifo mQueue; 439 440 // mAbandoned indicates that the SurfaceTexture will no longer be used to 441 // consume images buffers pushed to it using the ISurfaceTexture interface. 442 // It is initialized to false, and set to true in the abandon method. A 443 // SurfaceTexture that has been abandoned will return the NO_INIT error from 444 // all ISurfaceTexture methods capable of returning an error. 445 bool mAbandoned; 446 447 // mMutex is the mutex used to prevent concurrent access to the member 448 // variables of SurfaceTexture objects. It must be locked whenever the 449 // member variables are accessed. 450 mutable Mutex mMutex; 451 452}; 453 454// ---------------------------------------------------------------------------- 455}; // namespace android 456 457#endif // ANDROID_GUI_SURFACETEXTURE_H 458