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