SurfaceTexture.h revision 74bed55fff0132be319bcd1703970516ae28b3a9
18ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis/* 28ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * Copyright (C) 2010 The Android Open Source Project 38ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * 48ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * Licensed under the Apache License, Version 2.0 (the "License"); 58ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * you may not use this file except in compliance with the License. 68ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * You may obtain a copy of the License at 78ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * 88ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * http://www.apache.org/licenses/LICENSE-2.0 98ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * 108ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * Unless required by applicable law or agreed to in writing, software 118ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * distributed under the License is distributed on an "AS IS" BASIS, 128ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 138ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * See the License for the specific language governing permissions and 148ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * limitations under the License. 158ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis */ 168ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 178ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#ifndef ANDROID_GUI_SURFACETEXTURE_H 188ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#define ANDROID_GUI_SURFACETEXTURE_H 198ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 208ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#include <EGL/egl.h> 218ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#include <EGL/eglext.h> 228ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#include <GLES2/gl2.h> 23fb1b5a2f333800574b0da435d1200cf9b13d723fJamie Gennis#include <GLES2/gl2ext.h> 248ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 258ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#include <gui/ISurfaceTexture.h> 266b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#include <gui/BufferQueue.h> 278ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 288ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#include <ui/GraphicBuffer.h> 298ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 30fa28c35c21d1bf8b38f541758c291bc17a2d7270Jamie Gennis#include <utils/String8.h> 319a78c90cd46b2a3bd637b056873149d3b94384b4Jamie Gennis#include <utils/Vector.h> 32fa28c35c21d1bf8b38f541758c291bc17a2d7270Jamie Gennis#include <utils/threads.h> 338ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 348ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#define ANDROID_GRAPHICS_SURFACETEXTURE_JNI_ID "mSurfaceTexture" 358ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 368ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennisnamespace android { 378ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis// ---------------------------------------------------------------------------- 388ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 396b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4068c7794183a7dbfe3b20d4ce832f8eb79c2c619aMathias Agopianclass String8; 419a78c90cd46b2a3bd637b056873149d3b94384b4Jamie Gennis 42fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennisclass SurfaceTexture : public virtual RefBase, 43fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis protected BufferQueue::ConsumerListener { 448ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennispublic: 45fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis struct FrameAvailableListener : public virtual RefBase { 46fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // onFrameAvailable() is called each time an additional frame becomes 47fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // available for consumption. This means that frames that are queued 48fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // while in asynchronous mode only trigger the callback if no previous 49fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // frames are pending. Frames queued while in synchronous mode always 50fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // trigger the callback. 51fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // 52fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // This is called without any lock held and can be called concurrently 53fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // by multiple threads. 54fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis virtual void onFrameAvailable() = 0; 55fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis }; 56c4d4aeab52435c177ded6abdd578fec8191f0f5dJamie Gennis 5786edf4f6470ee0f108bf40d3c1d23bf0a78c9c38Jamie Gennis // SurfaceTexture constructs a new SurfaceTexture object. tex indicates the 5874bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // name of the OpenGL ES texture to which images are to be streamed. 5986edf4f6470ee0f108bf40d3c1d23bf0a78c9c38Jamie Gennis // allowSynchronousMode specifies whether or not synchronous mode can be 6086edf4f6470ee0f108bf40d3c1d23bf0a78c9c38Jamie Gennis // enabled. texTarget specifies the OpenGL ES texture target to which the 6186edf4f6470ee0f108bf40d3c1d23bf0a78c9c38Jamie Gennis // texture will be bound in updateTexImage. useFenceSync specifies whether 6286edf4f6470ee0f108bf40d3c1d23bf0a78c9c38Jamie Gennis // fences should be used to synchronize access to buffers if that behavior 63b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // is enabled at compile-time. A custom bufferQueue can be specified 64b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // if behavior for queue/dequeue/connect etc needs to be customized. 65b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // Otherwise a default BufferQueue will be created and used. 6674bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // 6774bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // For legacy reasons, the SurfaceTexture is created in a state where it is 6874bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // considered attached to an OpenGL ES context for the purposes of the 6974bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // attachToContext and detachFromContext methods. However, despite being 7074bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // considered "attached" to a context, the specific OpenGL ES context 7174bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // doesn't get latched until the first call to updateTexImage. After that 7274bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // point, all calls to updateTexImage must be made with the same OpenGL ES 7374bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // context current. 7474bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // 7574bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // A SurfaceTexture may be detached from one OpenGL ES context and then 7674bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // attached to a different context using the detachFromContext and 7774bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // attachToContext methods, respectively. The intention of these methods is 7874bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // purely to allow a SurfaceTexture to be transferred from one consumer 7974bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // context to another. If such a transfer is not needed there is no 8074bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // requirement that either of these methods be called. 81fb1b5a2f333800574b0da435d1200cf9b13d723fJamie Gennis SurfaceTexture(GLuint tex, bool allowSynchronousMode = true, 82b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam GLenum texTarget = GL_TEXTURE_EXTERNAL_OES, bool useFenceSync = true, 83b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam const sp<BufferQueue> &bufferQueue = 0); 848ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 858ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis virtual ~SurfaceTexture(); 868ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 878ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // updateTexImage sets the image contents of the target texture to that of 888ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // the most recently queued buffer. 898ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // 908ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // This call may only be made while the OpenGL ES context to which the 918ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // target texture belongs is bound to the calling thread. 928ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis status_t updateTexImage(); 938ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 948072711307aa98ee5ee6f7369860ae38c3e19656Mathias Agopian // setBufferCountServer set the buffer count. If the client has requested 958072711307aa98ee5ee6f7369860ae38c3e19656Mathias Agopian // a buffer count using setBufferCount, the server-buffer count will 968072711307aa98ee5ee6f7369860ae38c3e19656Mathias Agopian // take effect once the client sets the count back to zero. 978072711307aa98ee5ee6f7369860ae38c3e19656Mathias Agopian status_t setBufferCountServer(int bufferCount); 988072711307aa98ee5ee6f7369860ae38c3e19656Mathias Agopian 99f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // getTransformMatrix retrieves the 4x4 texture coordinate transform matrix 100f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // associated with the texture image set by the most recent call to 101f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // updateTexImage. 102f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // 103f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // This transform matrix maps 2D homogeneous texture coordinates of the form 104f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // (s, t, 0, 1) with s and t in the inclusive range [0, 1] to the texture 105f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // coordinate that should be used to sample that location from the texture. 106f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // Sampling the texture outside of the range of this transform is undefined. 107f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // 108f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // This transform is necessary to compensate for transforms that the stream 109f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // content producer may implicitly apply to the content. By forcing users of 110f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // a SurfaceTexture to apply this transform we avoid performing an extra 111f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // copy of the data that would be needed to hide the transform from the 112f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // user. 113f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // 114f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // The matrix is stored in column-major order so that it may be passed 115f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // directly to OpenGL ES via the glLoadMatrixf or glUniformMatrix4fv 116f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // functions. 117f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis void getTransformMatrix(float mtx[16]); 118f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis 1191d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala // getTimestamp retrieves the timestamp associated with the texture image 1201d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala // set by the most recent call to updateTexImage. 1211d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala // 1221d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala // The timestamp is in nanoseconds, and is monotonically increasing. Its 1231d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala // other semantics (zero point, etc) are source-dependent and should be 1241d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala // documented by the source. 1251d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala int64_t getTimestamp(); 1261d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala 127c4d4aeab52435c177ded6abdd578fec8191f0f5dJamie Gennis // setFrameAvailableListener sets the listener object that will be notified 128c4d4aeab52435c177ded6abdd578fec8191f0f5dJamie Gennis // when a new frame becomes available. 129292a31a4c2ae2f6faf134e8e4a726583017dad06Pannag Sanketi void setFrameAvailableListener(const sp<FrameAvailableListener>& listener); 130c4d4aeab52435c177ded6abdd578fec8191f0f5dJamie Gennis 1311b20cde313b5ef8acdace742328df867956d24cbJamie Gennis // getAllocator retrieves the binder object that must be referenced as long 1321b20cde313b5ef8acdace742328df867956d24cbJamie Gennis // as the GraphicBuffers dequeued from this SurfaceTexture are referenced. 1331b20cde313b5ef8acdace742328df867956d24cbJamie Gennis // Holding this binder reference prevents SurfaceFlinger from freeing the 1341b20cde313b5ef8acdace742328df867956d24cbJamie Gennis // buffers before the client is done with them. 1351b20cde313b5ef8acdace742328df867956d24cbJamie Gennis sp<IBinder> getAllocator(); 1361b20cde313b5ef8acdace742328df867956d24cbJamie Gennis 137a5c75c01620179ce00812354778a29a80d76e71fMathias Agopian // setDefaultBufferSize is used to set the size of buffers returned by 138a5c75c01620179ce00812354778a29a80d76e71fMathias Agopian // requestBuffers when a with and height of zero is requested. 139a5c75c01620179ce00812354778a29a80d76e71fMathias Agopian // A call to setDefaultBufferSize() may trigger requestBuffers() to 140a5c75c01620179ce00812354778a29a80d76e71fMathias Agopian // be called from the client. 141194c76c0477189700fda068e19b953b1d9af201aMathias Agopian // The width and height parameters must be no greater than the minimum of 142194c76c0477189700fda068e19b953b1d9af201aMathias Agopian // GL_MAX_VIEWPORT_DIMS and GL_MAX_TEXTURE_SIZE (see: glGetIntegerv). 143194c76c0477189700fda068e19b953b1d9af201aMathias Agopian // An error due to invalid dimensions might not be reported until 144194c76c0477189700fda068e19b953b1d9af201aMathias Agopian // updateTexImage() is called. 145194c76c0477189700fda068e19b953b1d9af201aMathias Agopian status_t setDefaultBufferSize(uint32_t width, uint32_t height); 146a5c75c01620179ce00812354778a29a80d76e71fMathias Agopian 1477a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian // getCurrentBuffer returns the buffer associated with the current image. 1487a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian sp<GraphicBuffer> getCurrentBuffer() const; 1497a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian 1507a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian // getCurrentTextureTarget returns the texture target of the current 1517a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian // texture as returned by updateTexImage(). 1527a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian GLenum getCurrentTextureTarget() const; 1537a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian 1547a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian // getCurrentCrop returns the cropping rectangle of the current buffer 1557a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian Rect getCurrentCrop() const; 1567a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian 1577a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian // getCurrentTransform returns the transform of the current buffer 1587a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian uint32_t getCurrentTransform() const; 1597a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian 1607734ebfe47f42f980c1b44c1f284a91d8ad1d6c7Mathias Agopian // getCurrentScalingMode returns the scaling mode of the current buffer 1617734ebfe47f42f980c1b44c1f284a91d8ad1d6c7Mathias Agopian uint32_t getCurrentScalingMode() const; 1627734ebfe47f42f980c1b44c1f284a91d8ad1d6c7Mathias Agopian 16359769469e4b9b2d8b12c020eb44b030b3927a50bJamie Gennis // isSynchronousMode returns whether the SurfaceTexture is currently in 16459769469e4b9b2d8b12c020eb44b030b3927a50bJamie Gennis // synchronous mode. 16559769469e4b9b2d8b12c020eb44b030b3927a50bJamie Gennis bool isSynchronousMode() const; 16659769469e4b9b2d8b12c020eb44b030b3927a50bJamie Gennis 1677b305fffc39d0fe0926e7fd2d7f6a524fbce62b7Jamie Gennis // abandon frees all the buffers and puts the SurfaceTexture into the 1687b305fffc39d0fe0926e7fd2d7f6a524fbce62b7Jamie Gennis // 'abandoned' state. Once put in this state the SurfaceTexture can never 1697b305fffc39d0fe0926e7fd2d7f6a524fbce62b7Jamie Gennis // leave it. When in the 'abandoned' state, all methods of the 1707b305fffc39d0fe0926e7fd2d7f6a524fbce62b7Jamie Gennis // ISurfaceTexture interface will fail with the NO_INIT error. 1717b305fffc39d0fe0926e7fd2d7f6a524fbce62b7Jamie Gennis // 1727b305fffc39d0fe0926e7fd2d7f6a524fbce62b7Jamie Gennis // Note that while calling this method causes all the buffers to be freed 1737b305fffc39d0fe0926e7fd2d7f6a524fbce62b7Jamie Gennis // from the perspective of the the SurfaceTexture, if there are additional 1747b305fffc39d0fe0926e7fd2d7f6a524fbce62b7Jamie Gennis // references on the buffers (e.g. if a buffer is referenced by a client or 1757b305fffc39d0fe0926e7fd2d7f6a524fbce62b7Jamie Gennis // by OpenGL ES as a texture) then those buffer will remain allocated. 1767b305fffc39d0fe0926e7fd2d7f6a524fbce62b7Jamie Gennis void abandon(); 1777b305fffc39d0fe0926e7fd2d7f6a524fbce62b7Jamie Gennis 178fa28c35c21d1bf8b38f541758c291bc17a2d7270Jamie Gennis // set the name of the SurfaceTexture that will be used to identify it in 179fa28c35c21d1bf8b38f541758c291bc17a2d7270Jamie Gennis // log messages. 180fa28c35c21d1bf8b38f541758c291bc17a2d7270Jamie Gennis void setName(const String8& name); 181fa28c35c21d1bf8b38f541758c291bc17a2d7270Jamie Gennis 182b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // These functions call the corresponding BufferQueue implementation 183b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // so the refactoring can proceed smoothly 184b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam status_t setDefaultBufferFormat(uint32_t defaultFormat); 185b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam status_t setConsumerUsageBits(uint32_t usage); 186b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam status_t setTransformHint(uint32_t hint); 187b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam virtual status_t setSynchronousMode(bool enabled); 188b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam virtual status_t setBufferCount(int bufferCount); 189b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam virtual status_t connect(int api, 190b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam uint32_t* outWidth, uint32_t* outHeight, uint32_t* outTransform); 191b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam 19274bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // getBufferQueue returns the BufferQueue object to which this 19374bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // SurfaceTexture is connected. 194b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam sp<BufferQueue> getBufferQueue() const; 195b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam 19674bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // detachFromContext detaches the SurfaceTexture from the calling thread's 19774bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // current OpenGL ES context. This context must be the same as the context 19874bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // that was current for previous calls to updateTexImage. 19974bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // 20074bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // Detaching a SurfaceTexture from an OpenGL ES context will result in the 20174bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // deletion of the OpenGL ES texture object into which the images were being 20274bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // streamed. After a SurfaceTexture has been detached from the OpenGL ES 20374bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // context calls to updateTexImage will fail returning INVALID_OPERATION 20474bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // until the SurfaceTexture is attached to a new OpenGL ES context using the 20574bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // attachToContext method. 20674bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis status_t detachFromContext(); 20774bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis 20874bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // attachToContext attaches a SurfaceTexture that is currently in the 20974bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // 'detached' state to the current OpenGL ES context. A SurfaceTexture is 21074bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // in the 'detached' state iff detachFromContext has successfully been 21174bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // called and no calls to attachToContext have succeeded since the last 21274bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // detachFromContext call. Calls to attachToContext made on a 21374bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // SurfaceTexture that is not in the 'detached' state will result in an 21474bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // INVALID_OPERATION error. 21574bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // 21674bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // The tex argument specifies the OpenGL ES texture object name in the 21774bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // new context into which the image contents will be streamed. A successful 21874bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // call to attachToContext will result in this texture object being bound to 21974bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // the texture target and populated with the image contents that were 22074bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // current at the time of the last call to detachFromContext. 22174bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis status_t attachToContext(GLuint tex); 22274bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis 22368c7794183a7dbfe3b20d4ce832f8eb79c2c619aMathias Agopian // dump our state in a String 224eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam virtual void dump(String8& result) const; 225eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam virtual void dump(String8& result, const char* prefix, char* buffer, size_t SIZE) const; 22668c7794183a7dbfe3b20d4ce832f8eb79c2c619aMathias Agopian 2277a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopianprotected: 2288ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 229fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // Implementation of the BufferQueue::ConsumerListener interface. These 230fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // calls are used to notify the SurfaceTexture of asynchronous events in the 231fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // BufferQueue. 232fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis virtual void onFrameAvailable(); 233fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis virtual void onBuffersReleased(); 234fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 2357a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian static bool isExternalFormat(uint32_t format); 2367a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian 2377a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopianprivate: 2388ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 2398ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // createImage creates a new EGLImage from a GraphicBuffer. 2408ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis EGLImageKHR createImage(EGLDisplay dpy, 2418ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis const sp<GraphicBuffer>& graphicBuffer); 2428ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 243fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // freeBufferLocked frees up the given buffer slot. If the slot has been 244fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // initialized this will release the reference to the GraphicBuffer in that 245fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // slot and destroy the EGLImage in that slot. Otherwise it has no effect. 246fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // 247fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // This method must be called with mMutex locked. 248fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis void freeBufferLocked(int slotIndex); 249fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 250736aa9573bb7b78f9c315f396c104491b3639426Jamie Gennis // computeCurrentTransformMatrix computes the transform matrix for the 251736aa9573bb7b78f9c315f396c104491b3639426Jamie Gennis // current texture. It uses mCurrentTransform and the current GraphicBuffer 252736aa9573bb7b78f9c315f396c104491b3639426Jamie Gennis // to compute this matrix and stores it in mCurrentTransformMatrix. 253736aa9573bb7b78f9c315f396c104491b3639426Jamie Gennis void computeCurrentTransformMatrix(); 254736aa9573bb7b78f9c315f396c104491b3639426Jamie Gennis 25574bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // syncForReleaseLocked performs the synchronization needed to release the 25674bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // current slot from an OpenGL ES context. If needed it will set the 25774bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // current slot's fence to guard against a producer accessing the buffer 25874bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // before the outstanding accesses have completed. 25974bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis status_t syncForReleaseLocked(EGLDisplay dpy); 26074bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis 2619a78c90cd46b2a3bd637b056873149d3b94384b4Jamie Gennis // mCurrentTextureBuf is the graphic buffer of the current texture. It's 2629a78c90cd46b2a3bd637b056873149d3b94384b4Jamie Gennis // possible that this buffer is not associated with any buffer slot, so we 26329c870271e8d3f8c40c356283650ba54fe71a16bJamie Gennis // must track it separately in order to support the getCurrentBuffer method. 2649a78c90cd46b2a3bd637b056873149d3b94384b4Jamie Gennis sp<GraphicBuffer> mCurrentTextureBuf; 2659a78c90cd46b2a3bd637b056873149d3b94384b4Jamie Gennis 266f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // mCurrentCrop is the crop rectangle that applies to the current texture. 2677734ebfe47f42f980c1b44c1f284a91d8ad1d6c7Mathias Agopian // It gets set each time updateTexImage is called. 268f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis Rect mCurrentCrop; 269f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis 270f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // mCurrentTransform is the transform identifier for the current texture. It 2717734ebfe47f42f980c1b44c1f284a91d8ad1d6c7Mathias Agopian // gets set each time updateTexImage is called. 272f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis uint32_t mCurrentTransform; 273f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis 2747734ebfe47f42f980c1b44c1f284a91d8ad1d6c7Mathias Agopian // mCurrentScalingMode is the scaling mode for the current texture. It gets 2757734ebfe47f42f980c1b44c1f284a91d8ad1d6c7Mathias Agopian // set to each time updateTexImage is called. 2767734ebfe47f42f980c1b44c1f284a91d8ad1d6c7Mathias Agopian uint32_t mCurrentScalingMode; 2777734ebfe47f42f980c1b44c1f284a91d8ad1d6c7Mathias Agopian 278736aa9573bb7b78f9c315f396c104491b3639426Jamie Gennis // mCurrentTransformMatrix is the transform matrix for the current texture. 279736aa9573bb7b78f9c315f396c104491b3639426Jamie Gennis // It gets computed by computeTransformMatrix each time updateTexImage is 280736aa9573bb7b78f9c315f396c104491b3639426Jamie Gennis // called. 281736aa9573bb7b78f9c315f396c104491b3639426Jamie Gennis float mCurrentTransformMatrix[16]; 282736aa9573bb7b78f9c315f396c104491b3639426Jamie Gennis 2831d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala // mCurrentTimestamp is the timestamp for the current texture. It 2847734ebfe47f42f980c1b44c1f284a91d8ad1d6c7Mathias Agopian // gets set each time updateTexImage is called. 2851d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala int64_t mCurrentTimestamp; 2861d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala 2878ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // mTexName is the name of the OpenGL texture to which streamed images will 288292a31a4c2ae2f6faf134e8e4a726583017dad06Pannag Sanketi // be bound when updateTexImage is called. It is set at construction time 28974bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // and can be changed with a call to attachToContext. 29074bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis GLuint mTexName; 2918ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 29286edf4f6470ee0f108bf40d3c1d23bf0a78c9c38Jamie Gennis // mUseFenceSync indicates whether creation of the EGL_KHR_fence_sync 29386edf4f6470ee0f108bf40d3c1d23bf0a78c9c38Jamie Gennis // extension should be used to prevent buffers from being dequeued before 29486edf4f6470ee0f108bf40d3c1d23bf0a78c9c38Jamie Gennis // it's safe for them to be written. It gets set at construction time and 29586edf4f6470ee0f108bf40d3c1d23bf0a78c9c38Jamie Gennis // never changes. 29686edf4f6470ee0f108bf40d3c1d23bf0a78c9c38Jamie Gennis const bool mUseFenceSync; 29786edf4f6470ee0f108bf40d3c1d23bf0a78c9c38Jamie Gennis 298fb1b5a2f333800574b0da435d1200cf9b13d723fJamie Gennis // mTexTarget is the GL texture target with which the GL texture object is 299fb1b5a2f333800574b0da435d1200cf9b13d723fJamie Gennis // associated. It is set in the constructor and never changed. It is 300fb1b5a2f333800574b0da435d1200cf9b13d723fJamie Gennis // almost always GL_TEXTURE_EXTERNAL_OES except for one use case in Android 301fb1b5a2f333800574b0da435d1200cf9b13d723fJamie Gennis // Browser. In that case it is set to GL_TEXTURE_2D to allow 302fb1b5a2f333800574b0da435d1200cf9b13d723fJamie Gennis // glCopyTexSubImage to read from the texture. This is a hack to work 303fb1b5a2f333800574b0da435d1200cf9b13d723fJamie Gennis // around a GL driver limitation on the number of FBO attachments, which the 304fb1b5a2f333800574b0da435d1200cf9b13d723fJamie Gennis // browser's tile cache exceeds. 305fb1b5a2f333800574b0da435d1200cf9b13d723fJamie Gennis const GLenum mTexTarget; 306a929748ddb67cbece3337c7fda7877fdeb973aa4Sunita Nadampalli 307fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // EGLSlot contains the information and object references that 308fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // SurfaceTexture maintains about a BufferQueue buffer slot. 309eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam struct EGLSlot { 310eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam EGLSlot() 311eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam : mEglImage(EGL_NO_IMAGE_KHR), 312eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam mFence(EGL_NO_SYNC_KHR) { 313eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam } 314eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 315eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam sp<GraphicBuffer> mGraphicBuffer; 316eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 317eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // mEglImage is the EGLImage created from mGraphicBuffer. 318eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam EGLImageKHR mEglImage; 319eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 320eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // mFence is the EGL sync object that must signal before the buffer 321eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // associated with this buffer slot may be dequeued. It is initialized 322eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // to EGL_NO_SYNC_KHR when the buffer is created and (optionally, based 323eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // on a compile-time option) set to a new sync object in updateTexImage. 324eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam EGLSyncKHR mFence; 325eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam }; 326eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 327ce561372186c7549a8a5fe996ac5965cda087007Jamie Gennis // mEglDisplay is the EGLDisplay with which this SurfaceTexture is currently 328ce561372186c7549a8a5fe996ac5965cda087007Jamie Gennis // associated. It is intialized to EGL_NO_DISPLAY and gets set to the 32974bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // current display when updateTexImage is called for the first time and when 33074bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // attachToContext is called. 331ce561372186c7549a8a5fe996ac5965cda087007Jamie Gennis EGLDisplay mEglDisplay; 332ce561372186c7549a8a5fe996ac5965cda087007Jamie Gennis 333ce561372186c7549a8a5fe996ac5965cda087007Jamie Gennis // mEglContext is the OpenGL ES context with which this SurfaceTexture is 334ce561372186c7549a8a5fe996ac5965cda087007Jamie Gennis // currently associated. It is initialized to EGL_NO_CONTEXT and gets set 335ce561372186c7549a8a5fe996ac5965cda087007Jamie Gennis // to the current GL context when updateTexImage is called for the first 33674bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // time and when attachToContext is called. 337ce561372186c7549a8a5fe996ac5965cda087007Jamie Gennis EGLContext mEglContext; 338ce561372186c7549a8a5fe996ac5965cda087007Jamie Gennis 339fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // mEGLSlots stores the buffers that have been allocated by the BufferQueue 340fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // for each buffer slot. It is initialized to null pointers, and gets 341fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // filled in with the result of BufferQueue::acquire when the 342fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // client dequeues a buffer from a 343fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // slot that has not yet been used. The buffer allocated to a slot will also 344fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // be replaced if the requested buffer usage or geometry differs from that 345fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // of the buffer allocated to a slot. 346b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam EGLSlot mEGLSlots[BufferQueue::NUM_BUFFER_SLOTS]; 347eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 348eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // mAbandoned indicates that the BufferQueue will no longer be used to 349eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // consume images buffers pushed to it using the ISurfaceTexture interface. 350eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // It is initialized to false, and set to true in the abandon method. A 351eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // BufferQueue that has been abandoned will return the NO_INIT error from 352eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // all ISurfaceTexture methods capable of returning an error. 353eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam bool mAbandoned; 354eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 355eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // mName is a string used to identify the SurfaceTexture in log messages. 356eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // It can be set by the setName method. 357eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam String8 mName; 358eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 359fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // mFrameAvailableListener is the listener object that will be called when a 360fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // new frame becomes available. If it is not NULL it will be called from 361fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // queueBuffer. 362fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis sp<FrameAvailableListener> mFrameAvailableListener; 363eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 364eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // mCurrentTexture is the buffer slot index of the buffer that is currently 365eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // bound to the OpenGL texture. It is initialized to INVALID_BUFFER_SLOT, 366eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // indicating that no buffer slot is currently bound to the texture. Note, 367eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // however, that a value of INVALID_BUFFER_SLOT does not necessarily mean 368eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // that no buffer is bound to the texture. A call to setBufferCount will 369eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // reset mCurrentTexture to INVALID_BUFFER_SLOT. 370eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam int mCurrentTexture; 371eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 372b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // The SurfaceTexture has-a BufferQueue and is responsible for creating this object 373b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // if none is supplied 374b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam sp<BufferQueue> mBufferQueue; 375b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam 37674bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // mAttached indicates whether the SurfaceTexture is currently attached to 37774bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // an OpenGL ES context. For legacy reasons, this is initialized to true, 37874bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // indicating that the SurfaceTexture is considered to be attached to 37974bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // whatever context is current at the time of the first updateTexImage call. 38074bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // It is set to false by detachFromContext, and then set to true again by 38174bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // attachToContext. 38274bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis bool mAttached; 38374bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis 384fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // mMutex is the mutex used to prevent concurrent access to the member 385fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // variables of SurfaceTexture objects. It must be locked whenever the 386fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // member variables are accessed. 387fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis mutable Mutex mMutex; 3888ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis}; 3898ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 3908ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis// ---------------------------------------------------------------------------- 3918ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis}; // namespace android 3928ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 3938ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#endif // ANDROID_GUI_SURFACETEXTURE_H 394