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 172adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden#ifndef ANDROID_GUI_CONSUMER_H 182adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden#define ANDROID_GUI_CONSUMER_H 198ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 208ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#include <EGL/egl.h> 218ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#include <EGL/eglext.h> 228ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 232adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden#include <gui/IGraphicBufferProducer.h> 246b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#include <gui/BufferQueue.h> 259fea3421ffddf6480f57f55a25936a886043d909Jamie Gennis#include <gui/ConsumerBase.h> 268ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 278ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#include <ui/GraphicBuffer.h> 288ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 29fa28c35c21d1bf8b38f541758c291bc17a2d7270Jamie Gennis#include <utils/String8.h> 309a78c90cd46b2a3bd637b056873149d3b94384b4Jamie Gennis#include <utils/Vector.h> 31fa28c35c21d1bf8b38f541758c291bc17a2d7270Jamie Gennis#include <utils/threads.h> 328ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 338ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennisnamespace android { 348ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis// ---------------------------------------------------------------------------- 358ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 366b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3768c7794183a7dbfe3b20d4ce832f8eb79c2c619aMathias Agopianclass String8; 389a78c90cd46b2a3bd637b056873149d3b94384b4Jamie Gennis 390273adbf0bc202eda2ca579ae0773464ea9c701fAndy McFadden/* 402adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden * GLConsumer consumes buffers of graphics data from a BufferQueue, 410273adbf0bc202eda2ca579ae0773464ea9c701fAndy McFadden * and makes them available to OpenGL as a texture. 420273adbf0bc202eda2ca579ae0773464ea9c701fAndy McFadden * 432adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden * A typical usage pattern is to set up the GLConsumer with the 440273adbf0bc202eda2ca579ae0773464ea9c701fAndy McFadden * desired options, and call updateTexImage() when a new frame is desired. 450273adbf0bc202eda2ca579ae0773464ea9c701fAndy McFadden * If a new frame is available, the texture will be updated. If not, 460273adbf0bc202eda2ca579ae0773464ea9c701fAndy McFadden * the previous contents are retained. 470273adbf0bc202eda2ca579ae0773464ea9c701fAndy McFadden * 480273adbf0bc202eda2ca579ae0773464ea9c701fAndy McFadden * By default, the texture is attached to the GL_TEXTURE_EXTERNAL_OES 490273adbf0bc202eda2ca579ae0773464ea9c701fAndy McFadden * texture target, in the EGL context of the first thread that calls 500273adbf0bc202eda2ca579ae0773464ea9c701fAndy McFadden * updateTexImage(). 510273adbf0bc202eda2ca579ae0773464ea9c701fAndy McFadden * 522adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden * This class was previously called SurfaceTexture. 530273adbf0bc202eda2ca579ae0773464ea9c701fAndy McFadden */ 542adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFaddenclass GLConsumer : public ConsumerBase { 558ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennispublic: 56e49ba8e2ed8e17156eb00c8fc8e2285df62bc018Dan Stoza enum { TEXTURE_EXTERNAL = 0x8D65 }; // GL_TEXTURE_EXTERNAL_OES 579fea3421ffddf6480f57f55a25936a886043d909Jamie Gennis typedef ConsumerBase::FrameAvailableListener FrameAvailableListener; 58c4d4aeab52435c177ded6abdd578fec8191f0f5dJamie Gennis 59ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza // GLConsumer constructs a new GLConsumer object. If the constructor with 60ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza // the tex parameter is used, tex indicates the name of the OpenGL ES 61ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza // texture to which images are to be streamed. texTarget specifies the 62ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza // OpenGL ES texture target to which the texture will be bound in 63ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza // updateTexImage. useFenceSync specifies whether fences should be used to 64ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza // synchronize access to buffers if that behavior is enabled at 65ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza // compile-time. 6674bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // 672adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden // A GLConsumer may be detached from one OpenGL ES context and then 6874bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // attached to a different context using the detachFromContext and 6974bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // attachToContext methods, respectively. The intention of these methods is 702adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden // purely to allow a GLConsumer to be transferred from one consumer 7174bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // context to another. If such a transfer is not needed there is no 7274bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // requirement that either of these methods be called. 73ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza // 74ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza // If the constructor with the tex parameter is used, the GLConsumer is 75ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza // created in a state where it is considered attached to an OpenGL ES 76ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza // context for the purposes of the attachToContext and detachFromContext 77ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza // methods. However, despite being considered "attached" to a context, the 78ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza // specific OpenGL ES context doesn't get latched until the first call to 79ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza // updateTexImage. After that point, all calls to updateTexImage must be 80ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza // made with the same OpenGL ES context current. 81ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza // 82ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza // If the constructor without the tex parameter is used, the GLConsumer is 83ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza // created in a detached state, and attachToContext must be called before 84ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza // calls to updateTexImage. 85db89edc94bd2a78226b407f9f7261e202e7fa325Mathias Agopian GLConsumer(const sp<IGraphicBufferConsumer>& bq, 86e49ba8e2ed8e17156eb00c8fc8e2285df62bc018Dan Stoza uint32_t tex, uint32_t texureTarget, bool useFenceSync, 87e49ba8e2ed8e17156eb00c8fc8e2285df62bc018Dan Stoza bool isControlledByApp); 888ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 89ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza GLConsumer(const sp<IGraphicBufferConsumer>& bq, uint32_t texureTarget, 90ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza bool useFenceSync, bool isControlledByApp); 91ab57491de3a89a2d454d3060d36adef71741a7aeDan Stoza 92bf974abe92f7495529916fe0f483f3b56e7c30e3Andy McFadden // updateTexImage acquires the most recently queued buffer, and sets the 93bf974abe92f7495529916fe0f483f3b56e7c30e3Andy McFadden // image contents of the target texture to it. 948ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // 958ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // This call may only be made while the OpenGL ES context to which the 968ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // target texture belongs is bound to the calling thread. 9761e04b92bdeafc6fca89052d14dab1bd0c384a71Jamie Gennis // 98bf974abe92f7495529916fe0f483f3b56e7c30e3Andy McFadden // This calls doGLFenceWait to ensure proper synchronization. 998ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis status_t updateTexImage(); 1008ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 101ad678e18b66f495efa78dc3b9ab99b579945c9e2Mathias Agopian // releaseTexImage releases the texture acquired in updateTexImage(). 102ad678e18b66f495efa78dc3b9ab99b579945c9e2Mathias Agopian // This is intended to be used in single buffer mode. 103ad678e18b66f495efa78dc3b9ab99b579945c9e2Mathias Agopian // 104ad678e18b66f495efa78dc3b9ab99b579945c9e2Mathias Agopian // This call may only be made while the OpenGL ES context to which the 105ad678e18b66f495efa78dc3b9ab99b579945c9e2Mathias Agopian // target texture belongs is bound to the calling thread. 106ad678e18b66f495efa78dc3b9ab99b579945c9e2Mathias Agopian status_t releaseTexImage(); 107ad678e18b66f495efa78dc3b9ab99b579945c9e2Mathias Agopian 10813f01cbdbd34779a234bc674df79e23672fd5c0bJesse Hall // setReleaseFence stores a fence that will signal when the current buffer 10913f01cbdbd34779a234bc674df79e23672fd5c0bJesse Hall // is no longer being read. This fence will be returned to the producer 11013f01cbdbd34779a234bc674df79e23672fd5c0bJesse Hall // when the current buffer is released by updateTexImage(). Multiple 11113f01cbdbd34779a234bc674df79e23672fd5c0bJesse Hall // fences can be set for a given buffer; they will be merged into a single 11213f01cbdbd34779a234bc674df79e23672fd5c0bJesse Hall // union fence. 11313f01cbdbd34779a234bc674df79e23672fd5c0bJesse Hall void setReleaseFence(const sp<Fence>& fence); 114ef19414bd8b77a26f5751f3845be79025a8263feJesse Hall 11531a353da225af5329735451c761b430d82dfda1bJamie Gennis // setDefaultMaxBufferCount sets the default limit on the maximum number 11631a353da225af5329735451c761b430d82dfda1bJamie Gennis // of buffers that will be allocated at one time. The image producer may 11731a353da225af5329735451c761b430d82dfda1bJamie Gennis // override the limit. 11831a353da225af5329735451c761b430d82dfda1bJamie Gennis status_t setDefaultMaxBufferCount(int bufferCount); 1198072711307aa98ee5ee6f7369860ae38c3e19656Mathias Agopian 120f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // getTransformMatrix retrieves the 4x4 texture coordinate transform matrix 121f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // associated with the texture image set by the most recent call to 122f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // updateTexImage. 123f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // 124f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // This transform matrix maps 2D homogeneous texture coordinates of the form 125f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // (s, t, 0, 1) with s and t in the inclusive range [0, 1] to the texture 126f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // coordinate that should be used to sample that location from the texture. 127f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // Sampling the texture outside of the range of this transform is undefined. 128f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // 129f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // This transform is necessary to compensate for transforms that the stream 130f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // content producer may implicitly apply to the content. By forcing users of 1312adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden // a GLConsumer to apply this transform we avoid performing an extra 132f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // copy of the data that would be needed to hide the transform from the 133f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // user. 134f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // 135f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // The matrix is stored in column-major order so that it may be passed 136f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // directly to OpenGL ES via the glLoadMatrixf or glUniformMatrix4fv 137f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // functions. 138f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis void getTransformMatrix(float mtx[16]); 139f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis 1401d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala // getTimestamp retrieves the timestamp associated with the texture image 1411d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala // set by the most recent call to updateTexImage. 1421d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala // 1431d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala // The timestamp is in nanoseconds, and is monotonically increasing. Its 1441d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala // other semantics (zero point, etc) are source-dependent and should be 1451d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala // documented by the source. 1461d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala int64_t getTimestamp(); 1471d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala 148d171da973de3c6b30263011334fdcd916739144fEino-Ville Talvala // getFrameNumber retrieves the frame number associated with the texture 149d171da973de3c6b30263011334fdcd916739144fEino-Ville Talvala // image set by the most recent call to updateTexImage. 150d171da973de3c6b30263011334fdcd916739144fEino-Ville Talvala // 151d171da973de3c6b30263011334fdcd916739144fEino-Ville Talvala // The frame number is an incrementing counter set to 0 at the creation of 152d171da973de3c6b30263011334fdcd916739144fEino-Ville Talvala // the BufferQueue associated with this consumer. 153d171da973de3c6b30263011334fdcd916739144fEino-Ville Talvala int64_t getFrameNumber(); 154d171da973de3c6b30263011334fdcd916739144fEino-Ville Talvala 155a5c75c01620179ce00812354778a29a80d76e71fMathias Agopian // setDefaultBufferSize is used to set the size of buffers returned by 156a5c75c01620179ce00812354778a29a80d76e71fMathias Agopian // requestBuffers when a with and height of zero is requested. 157a5c75c01620179ce00812354778a29a80d76e71fMathias Agopian // A call to setDefaultBufferSize() may trigger requestBuffers() to 158a5c75c01620179ce00812354778a29a80d76e71fMathias Agopian // be called from the client. 159194c76c0477189700fda068e19b953b1d9af201aMathias Agopian // The width and height parameters must be no greater than the minimum of 160194c76c0477189700fda068e19b953b1d9af201aMathias Agopian // GL_MAX_VIEWPORT_DIMS and GL_MAX_TEXTURE_SIZE (see: glGetIntegerv). 161194c76c0477189700fda068e19b953b1d9af201aMathias Agopian // An error due to invalid dimensions might not be reported until 162194c76c0477189700fda068e19b953b1d9af201aMathias Agopian // updateTexImage() is called. 163194c76c0477189700fda068e19b953b1d9af201aMathias Agopian status_t setDefaultBufferSize(uint32_t width, uint32_t height); 164a5c75c01620179ce00812354778a29a80d76e71fMathias Agopian 1655c1139fea3cc0fd9847a6594d853a458152b2fbcJamie Gennis // setFilteringEnabled sets whether the transform matrix should be computed 1665c1139fea3cc0fd9847a6594d853a458152b2fbcJamie Gennis // for use with bilinear filtering. 1675c1139fea3cc0fd9847a6594d853a458152b2fbcJamie Gennis void setFilteringEnabled(bool enabled); 1685c1139fea3cc0fd9847a6594d853a458152b2fbcJamie Gennis 1697a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian // getCurrentBuffer returns the buffer associated with the current image. 1707a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian sp<GraphicBuffer> getCurrentBuffer() const; 1717a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian 1727a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian // getCurrentTextureTarget returns the texture target of the current 1737a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian // texture as returned by updateTexImage(). 1743f84483382be2d528918cc1a6fbc6a7d68e0b181Mathias Agopian uint32_t getCurrentTextureTarget() const; 1757a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian 176efc7ab6dcea8c22ddd7c0259ef4ab4bbf1e93044Jamie Gennis // getCurrentCrop returns the cropping rectangle of the current buffer. 1777a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian Rect getCurrentCrop() const; 1787a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian 179efc7ab6dcea8c22ddd7c0259ef4ab4bbf1e93044Jamie Gennis // getCurrentTransform returns the transform of the current buffer. 1807a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian uint32_t getCurrentTransform() const; 1817a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian 182efc7ab6dcea8c22ddd7c0259ef4ab4bbf1e93044Jamie Gennis // getCurrentScalingMode returns the scaling mode of the current buffer. 1837734ebfe47f42f980c1b44c1f284a91d8ad1d6c7Mathias Agopian uint32_t getCurrentScalingMode() const; 1847734ebfe47f42f980c1b44c1f284a91d8ad1d6c7Mathias Agopian 185dc5b485f74edf2d2f31c62054eb6c180421a3adeJesse Hall // getCurrentFence returns the fence indicating when the current buffer is 186dc5b485f74edf2d2f31c62054eb6c180421a3adeJesse Hall // ready to be read from. 187dc5b485f74edf2d2f31c62054eb6c180421a3adeJesse Hall sp<Fence> getCurrentFence() const; 188dc5b485f74edf2d2f31c62054eb6c180421a3adeJesse Hall 18961e04b92bdeafc6fca89052d14dab1bd0c384a71Jamie Gennis // doGLFenceWait inserts a wait command into the OpenGL ES command stream 19061e04b92bdeafc6fca89052d14dab1bd0c384a71Jamie Gennis // to ensure that it is safe for future OpenGL ES commands to access the 191bf974abe92f7495529916fe0f483f3b56e7c30e3Andy McFadden // current texture buffer. 19261e04b92bdeafc6fca89052d14dab1bd0c384a71Jamie Gennis status_t doGLFenceWait() const; 19361e04b92bdeafc6fca89052d14dab1bd0c384a71Jamie Gennis 1942adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden // set the name of the GLConsumer that will be used to identify it in 195fa28c35c21d1bf8b38f541758c291bc17a2d7270Jamie Gennis // log messages. 196fa28c35c21d1bf8b38f541758c291bc17a2d7270Jamie Gennis void setName(const String8& name); 197fa28c35c21d1bf8b38f541758c291bc17a2d7270Jamie Gennis 198b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // These functions call the corresponding BufferQueue implementation 199b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // so the refactoring can proceed smoothly 200b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam status_t setDefaultBufferFormat(uint32_t defaultFormat); 201b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam status_t setConsumerUsageBits(uint32_t usage); 202b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam status_t setTransformHint(uint32_t hint); 203b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam 2042adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden // detachFromContext detaches the GLConsumer from the calling thread's 20574bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // current OpenGL ES context. This context must be the same as the context 20674bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // that was current for previous calls to updateTexImage. 20774bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // 2082adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden // Detaching a GLConsumer from an OpenGL ES context will result in the 20974bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // deletion of the OpenGL ES texture object into which the images were being 2102adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden // streamed. After a GLConsumer has been detached from the OpenGL ES 21174bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // context calls to updateTexImage will fail returning INVALID_OPERATION 2122adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden // until the GLConsumer is attached to a new OpenGL ES context using the 21374bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // attachToContext method. 21474bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis status_t detachFromContext(); 21574bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis 2162adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden // attachToContext attaches a GLConsumer that is currently in the 2172adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden // 'detached' state to the current OpenGL ES context. A GLConsumer is 21874bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // in the 'detached' state iff detachFromContext has successfully been 21974bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // called and no calls to attachToContext have succeeded since the last 22074bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // detachFromContext call. Calls to attachToContext made on a 2212adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden // GLConsumer that is not in the 'detached' state will result in an 22274bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // INVALID_OPERATION error. 22374bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // 22474bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // The tex argument specifies the OpenGL ES texture object name in the 22574bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // new context into which the image contents will be streamed. A successful 22674bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // call to attachToContext will result in this texture object being bound to 22774bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // the texture target and populated with the image contents that were 22874bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // current at the time of the last call to detachFromContext. 2293f84483382be2d528918cc1a6fbc6a7d68e0b181Mathias Agopian status_t attachToContext(uint32_t tex); 23074bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis 231ce7a6c0fc9d75b80da030d1790321e84475f956aJamie Gennisprotected: 232ed059a8d754770c3cf28b78dba30f7a6ba475dbeJamie Gennis 2339fea3421ffddf6480f57f55a25936a886043d909Jamie Gennis // abandonLocked overrides the ConsumerBase method to clear 2345c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // mCurrentTextureImage in addition to the ConsumerBase behavior. 2359fea3421ffddf6480f57f55a25936a886043d909Jamie Gennis virtual void abandonLocked(); 2369fea3421ffddf6480f57f55a25936a886043d909Jamie Gennis 2372adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden // dumpLocked overrides the ConsumerBase method to dump GLConsumer- 2389fea3421ffddf6480f57f55a25936a886043d909Jamie Gennis // specific info in addition to the ConsumerBase behavior. 23974d211ae26a0257c6075a823812e40b55aa1e653Mathias Agopian virtual void dumpLocked(String8& result, const char* prefix) const; 2409fea3421ffddf6480f57f55a25936a886043d909Jamie Gennis 2419fea3421ffddf6480f57f55a25936a886043d909Jamie Gennis // acquireBufferLocked overrides the ConsumerBase method to update the 2429fea3421ffddf6480f57f55a25936a886043d909Jamie Gennis // mEglSlots array in addition to the ConsumerBase behavior. 2431585c4d9fbbba3ba70ae625923b85cd02cb8a0fdAndy McFadden virtual status_t acquireBufferLocked(BufferQueue::BufferItem *item, 2441585c4d9fbbba3ba70ae625923b85cd02cb8a0fdAndy McFadden nsecs_t presentWhen); 2459fea3421ffddf6480f57f55a25936a886043d909Jamie Gennis 2469fea3421ffddf6480f57f55a25936a886043d909Jamie Gennis // releaseBufferLocked overrides the ConsumerBase method to update the 2479fea3421ffddf6480f57f55a25936a886043d909Jamie Gennis // mEglSlots array in addition to the ConsumerBase. 248c5d7b7d323bba8772a9005f7d300ad983a04733aLajos Molnar virtual status_t releaseBufferLocked(int slot, 249c5d7b7d323bba8772a9005f7d300ad983a04733aLajos Molnar const sp<GraphicBuffer> graphicBuffer, 250c5d7b7d323bba8772a9005f7d300ad983a04733aLajos Molnar EGLDisplay display, EGLSyncKHR eglFence); 251fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 252c5d7b7d323bba8772a9005f7d300ad983a04733aLajos Molnar status_t releaseBufferLocked(int slot, 253c5d7b7d323bba8772a9005f7d300ad983a04733aLajos Molnar const sp<GraphicBuffer> graphicBuffer, EGLSyncKHR eglFence) { 254c5d7b7d323bba8772a9005f7d300ad983a04733aLajos Molnar return releaseBufferLocked(slot, graphicBuffer, mEglDisplay, eglFence); 255bf974abe92f7495529916fe0f483f3b56e7c30e3Andy McFadden } 256bf974abe92f7495529916fe0f483f3b56e7c30e3Andy McFadden 2577a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian static bool isExternalFormat(uint32_t format); 2587a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian 259bf974abe92f7495529916fe0f483f3b56e7c30e3Andy McFadden // This releases the buffer in the slot referenced by mCurrentTexture, 260bf974abe92f7495529916fe0f483f3b56e7c30e3Andy McFadden // then updates state to refer to the BufferItem, which must be a 261bf974abe92f7495529916fe0f483f3b56e7c30e3Andy McFadden // newly-acquired buffer. 262ad678e18b66f495efa78dc3b9ab99b579945c9e2Mathias Agopian status_t updateAndReleaseLocked(const BufferQueue::BufferItem& item); 263bf974abe92f7495529916fe0f483f3b56e7c30e3Andy McFadden 264bf974abe92f7495529916fe0f483f3b56e7c30e3Andy McFadden // Binds mTexName and the current buffer to mTexTarget. Uses 2655c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // mCurrentTexture if it's set, mCurrentTextureImage if not. If the 26697eba8904c2f221c42a9473407223a4c3a213f75Andy McFadden // bind succeeds, this calls doGLFenceWait. 26797eba8904c2f221c42a9473407223a4c3a213f75Andy McFadden status_t bindTextureImageLocked(); 268bf974abe92f7495529916fe0f483f3b56e7c30e3Andy McFadden 269bf974abe92f7495529916fe0f483f3b56e7c30e3Andy McFadden // Gets the current EGLDisplay and EGLContext values, and compares them 270bf974abe92f7495529916fe0f483f3b56e7c30e3Andy McFadden // to mEglDisplay and mEglContext. If the fields have been previously 271bf974abe92f7495529916fe0f483f3b56e7c30e3Andy McFadden // set, the values must match; if not, the fields are set to the current 272bf974abe92f7495529916fe0f483f3b56e7c30e3Andy McFadden // values. 27345155969dc747d09d267cd1f22baf0eaf886a801Mathias Agopian // The contextCheck argument is used to ensure that a GL context is 27445155969dc747d09d267cd1f22baf0eaf886a801Mathias Agopian // properly set; when set to false, the check is not performed. 27545155969dc747d09d267cd1f22baf0eaf886a801Mathias Agopian status_t checkAndUpdateEglStateLocked(bool contextCheck = false); 2768ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 277bf974abe92f7495529916fe0f483f3b56e7c30e3Andy McFaddenprivate: 2785c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // EglImage is a utility class for tracking and creating EGLImageKHRs. There 2795c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // is primarily just one image per slot, but there is also special cases: 2805c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // - For releaseTexImage, we use a debug image (mReleasedTexImage) 2815c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // - After freeBuffer, we must still keep the current image/buffer 2825c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // Reference counting EGLImages lets us handle all these cases easily while 2835c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // also only creating new EGLImages from buffers when required. 2845c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner class EglImage : public LightRefBase<EglImage> { 2855c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner public: 2865c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner EglImage(sp<GraphicBuffer> graphicBuffer); 2875c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner 2885c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // createIfNeeded creates an EGLImage if required (we haven't created 2895c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // one yet, or the EGLDisplay or crop-rect has changed). 2902d14a0ed4f5861bfa67e9db138ffdc70d2d5e6e4Eric Penner status_t createIfNeeded(EGLDisplay display, 2912d14a0ed4f5861bfa67e9db138ffdc70d2d5e6e4Eric Penner const Rect& cropRect, 2922d14a0ed4f5861bfa67e9db138ffdc70d2d5e6e4Eric Penner bool forceCreate = false); 2935c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner 2945c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // This calls glEGLImageTargetTexture2DOES to bind the image to the 2955c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // texture in the specified texture target. 2965c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner void bindToTextureTarget(uint32_t texTarget); 2975c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner 2985c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner const sp<GraphicBuffer>& graphicBuffer() { return mGraphicBuffer; } 2995c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner const native_handle* graphicBufferHandle() { 3005c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner return mGraphicBuffer == NULL ? NULL : mGraphicBuffer->handle; 3015c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner } 3025c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner 3035c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner private: 3045c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // Only allow instantiation using ref counting. 3055c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner friend class LightRefBase<EglImage>; 3065c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner virtual ~EglImage(); 3075c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner 3085c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // createImage creates a new EGLImage from a GraphicBuffer. 3095c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner EGLImageKHR createImage(EGLDisplay dpy, 3105c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner const sp<GraphicBuffer>& graphicBuffer, const Rect& crop); 3115c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner 3125c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // Disallow copying 3135c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner EglImage(const EglImage& rhs); 3145c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner void operator = (const EglImage& rhs); 3155c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner 3165c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // mGraphicBuffer is the buffer that was used to create this image. 3175c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner sp<GraphicBuffer> mGraphicBuffer; 3185c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner 3195c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // mEglImage is the EGLImage created from mGraphicBuffer. 3205c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner EGLImageKHR mEglImage; 3215c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner 3225c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // mEGLDisplay is the EGLDisplay that was used to create mEglImage. 3235c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner EGLDisplay mEglDisplay; 3248ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 3255c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // mCropRect is the crop rectangle passed to EGL when mEglImage 3265c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // was created. 3275c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner Rect mCropRect; 3285c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner }; 3295c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner 3305c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // freeBufferLocked frees up the given buffer slot. If the slot has been 331fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // initialized this will release the reference to the GraphicBuffer in that 332fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // slot and destroy the EGLImage in that slot. Otherwise it has no effect. 333fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // 334fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // This method must be called with mMutex locked. 3359fea3421ffddf6480f57f55a25936a886043d909Jamie Gennis virtual void freeBufferLocked(int slotIndex); 336fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 337e96e9e1093b5700e9f403a6e2479da7dc36d3b71Mathias Agopian // computeCurrentTransformMatrixLocked computes the transform matrix for the 338736aa9573bb7b78f9c315f396c104491b3639426Jamie Gennis // current texture. It uses mCurrentTransform and the current GraphicBuffer 339736aa9573bb7b78f9c315f396c104491b3639426Jamie Gennis // to compute this matrix and stores it in mCurrentTransformMatrix. 3405c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // mCurrentTextureImage must not be NULL. 341e96e9e1093b5700e9f403a6e2479da7dc36d3b71Mathias Agopian void computeCurrentTransformMatrixLocked(); 342736aa9573bb7b78f9c315f396c104491b3639426Jamie Gennis 34397eba8904c2f221c42a9473407223a4c3a213f75Andy McFadden // doGLFenceWaitLocked inserts a wait command into the OpenGL ES command 34497eba8904c2f221c42a9473407223a4c3a213f75Andy McFadden // stream to ensure that it is safe for future OpenGL ES commands to 34597eba8904c2f221c42a9473407223a4c3a213f75Andy McFadden // access the current texture buffer. 34697eba8904c2f221c42a9473407223a4c3a213f75Andy McFadden status_t doGLFenceWaitLocked() const; 34797eba8904c2f221c42a9473407223a4c3a213f75Andy McFadden 34874bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // syncForReleaseLocked performs the synchronization needed to release the 34974bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // current slot from an OpenGL ES context. If needed it will set the 35074bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // current slot's fence to guard against a producer accessing the buffer 35174bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // before the outstanding accesses have completed. 35274bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis status_t syncForReleaseLocked(EGLDisplay dpy); 35374bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis 3549870c9b66cc73ee31aabba23aa06deaf673ee5efMathias Agopian // returns a graphic buffer used when the texture image has been released 3559870c9b66cc73ee31aabba23aa06deaf673ee5efMathias Agopian static sp<GraphicBuffer> getDebugTexImageBuffer(); 3569870c9b66cc73ee31aabba23aa06deaf673ee5efMathias Agopian 3572adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden // The default consumer usage flags that GLConsumer always sets on its 35885b217668d6840c8e6a109adfb99461313676f8dEino-Ville Talvala // BufferQueue instance; these will be OR:d with any additional flags passed 3592adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden // from the GLConsumer user. In particular, GLConsumer will always 36085b217668d6840c8e6a109adfb99461313676f8dEino-Ville Talvala // consume buffers as hardware textures. 36185b217668d6840c8e6a109adfb99461313676f8dEino-Ville Talvala static const uint32_t DEFAULT_USAGE_FLAGS = GraphicBuffer::USAGE_HW_TEXTURE; 36285b217668d6840c8e6a109adfb99461313676f8dEino-Ville Talvala 3635c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner // mCurrentTextureImage is the EglImage/buffer of the current texture. It's 3649a78c90cd46b2a3bd637b056873149d3b94384b4Jamie Gennis // possible that this buffer is not associated with any buffer slot, so we 36529c870271e8d3f8c40c356283650ba54fe71a16bJamie Gennis // must track it separately in order to support the getCurrentBuffer method. 3665c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner sp<EglImage> mCurrentTextureImage; 3679a78c90cd46b2a3bd637b056873149d3b94384b4Jamie Gennis 368f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // mCurrentCrop is the crop rectangle that applies to the current texture. 3697734ebfe47f42f980c1b44c1f284a91d8ad1d6c7Mathias Agopian // It gets set each time updateTexImage is called. 370f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis Rect mCurrentCrop; 371f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis 372f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis // mCurrentTransform is the transform identifier for the current texture. It 3737734ebfe47f42f980c1b44c1f284a91d8ad1d6c7Mathias Agopian // gets set each time updateTexImage is called. 374f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis uint32_t mCurrentTransform; 375f238e28500ca756fbd9e323f728ce7c8dda59475Jamie Gennis 3767734ebfe47f42f980c1b44c1f284a91d8ad1d6c7Mathias Agopian // mCurrentScalingMode is the scaling mode for the current texture. It gets 377e692ab9a6be63193c5b52a6562d85d06c40463b8Mathias Agopian // set each time updateTexImage is called. 3787734ebfe47f42f980c1b44c1f284a91d8ad1d6c7Mathias Agopian uint32_t mCurrentScalingMode; 3797734ebfe47f42f980c1b44c1f284a91d8ad1d6c7Mathias Agopian 380dc5b485f74edf2d2f31c62054eb6c180421a3adeJesse Hall // mCurrentFence is the fence received from BufferQueue in updateTexImage. 381dc5b485f74edf2d2f31c62054eb6c180421a3adeJesse Hall sp<Fence> mCurrentFence; 382dc5b485f74edf2d2f31c62054eb6c180421a3adeJesse Hall 383736aa9573bb7b78f9c315f396c104491b3639426Jamie Gennis // mCurrentTransformMatrix is the transform matrix for the current texture. 384736aa9573bb7b78f9c315f396c104491b3639426Jamie Gennis // It gets computed by computeTransformMatrix each time updateTexImage is 385736aa9573bb7b78f9c315f396c104491b3639426Jamie Gennis // called. 386736aa9573bb7b78f9c315f396c104491b3639426Jamie Gennis float mCurrentTransformMatrix[16]; 387736aa9573bb7b78f9c315f396c104491b3639426Jamie Gennis 3881d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala // mCurrentTimestamp is the timestamp for the current texture. It 3897734ebfe47f42f980c1b44c1f284a91d8ad1d6c7Mathias Agopian // gets set each time updateTexImage is called. 3901d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala int64_t mCurrentTimestamp; 3911d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala 392d171da973de3c6b30263011334fdcd916739144fEino-Ville Talvala // mCurrentFrameNumber is the frame counter for the current texture. 393d171da973de3c6b30263011334fdcd916739144fEino-Ville Talvala // It gets set each time updateTexImage is called. 394d171da973de3c6b30263011334fdcd916739144fEino-Ville Talvala int64_t mCurrentFrameNumber; 395d171da973de3c6b30263011334fdcd916739144fEino-Ville Talvala 396016c8cbce4dde21f2703b9865f52d16b8d5d5ae2Daniel Lam uint32_t mDefaultWidth, mDefaultHeight; 397016c8cbce4dde21f2703b9865f52d16b8d5d5ae2Daniel Lam 3985c1139fea3cc0fd9847a6594d853a458152b2fbcJamie Gennis // mFilteringEnabled indicates whether the transform matrix is computed for 3995c1139fea3cc0fd9847a6594d853a458152b2fbcJamie Gennis // use with bilinear filtering. It defaults to true and is changed by 4005c1139fea3cc0fd9847a6594d853a458152b2fbcJamie Gennis // setFilteringEnabled(). 4015c1139fea3cc0fd9847a6594d853a458152b2fbcJamie Gennis bool mFilteringEnabled; 4025c1139fea3cc0fd9847a6594d853a458152b2fbcJamie Gennis 4038ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // mTexName is the name of the OpenGL texture to which streamed images will 404292a31a4c2ae2f6faf134e8e4a726583017dad06Pannag Sanketi // be bound when updateTexImage is called. It is set at construction time 40574bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // and can be changed with a call to attachToContext. 4063f84483382be2d528918cc1a6fbc6a7d68e0b181Mathias Agopian uint32_t mTexName; 4078ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 40886edf4f6470ee0f108bf40d3c1d23bf0a78c9c38Jamie Gennis // mUseFenceSync indicates whether creation of the EGL_KHR_fence_sync 40986edf4f6470ee0f108bf40d3c1d23bf0a78c9c38Jamie Gennis // extension should be used to prevent buffers from being dequeued before 41086edf4f6470ee0f108bf40d3c1d23bf0a78c9c38Jamie Gennis // it's safe for them to be written. It gets set at construction time and 41186edf4f6470ee0f108bf40d3c1d23bf0a78c9c38Jamie Gennis // never changes. 41286edf4f6470ee0f108bf40d3c1d23bf0a78c9c38Jamie Gennis const bool mUseFenceSync; 41386edf4f6470ee0f108bf40d3c1d23bf0a78c9c38Jamie Gennis 414fb1b5a2f333800574b0da435d1200cf9b13d723fJamie Gennis // mTexTarget is the GL texture target with which the GL texture object is 415fb1b5a2f333800574b0da435d1200cf9b13d723fJamie Gennis // associated. It is set in the constructor and never changed. It is 416fb1b5a2f333800574b0da435d1200cf9b13d723fJamie Gennis // almost always GL_TEXTURE_EXTERNAL_OES except for one use case in Android 417fb1b5a2f333800574b0da435d1200cf9b13d723fJamie Gennis // Browser. In that case it is set to GL_TEXTURE_2D to allow 418fb1b5a2f333800574b0da435d1200cf9b13d723fJamie Gennis // glCopyTexSubImage to read from the texture. This is a hack to work 419fb1b5a2f333800574b0da435d1200cf9b13d723fJamie Gennis // around a GL driver limitation on the number of FBO attachments, which the 420fb1b5a2f333800574b0da435d1200cf9b13d723fJamie Gennis // browser's tile cache exceeds. 4213f84483382be2d528918cc1a6fbc6a7d68e0b181Mathias Agopian const uint32_t mTexTarget; 422a929748ddb67cbece3337c7fda7877fdeb973aa4Sunita Nadampalli 423fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // EGLSlot contains the information and object references that 4242adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden // GLConsumer maintains about a BufferQueue buffer slot. 425bf974abe92f7495529916fe0f483f3b56e7c30e3Andy McFadden struct EglSlot { 4265c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner EglSlot() : mEglFence(EGL_NO_SYNC_KHR) {} 427eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 428eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // mEglImage is the EGLImage created from mGraphicBuffer. 4295c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner sp<EglImage> mEglImage; 430dbe9245e2e362b12e184cd33b9a27b0901f81244Jamie Gennis 431eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // mFence is the EGL sync object that must signal before the buffer 432eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // associated with this buffer slot may be dequeued. It is initialized 433eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // to EGL_NO_SYNC_KHR when the buffer is created and (optionally, based 434eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // on a compile-time option) set to a new sync object in updateTexImage. 4359fea3421ffddf6480f57f55a25936a886043d909Jamie Gennis EGLSyncKHR mEglFence; 436eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam }; 437eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 4382adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden // mEglDisplay is the EGLDisplay with which this GLConsumer is currently 439ce561372186c7549a8a5fe996ac5965cda087007Jamie Gennis // associated. It is intialized to EGL_NO_DISPLAY and gets set to the 44074bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // current display when updateTexImage is called for the first time and when 44174bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // attachToContext is called. 442ce561372186c7549a8a5fe996ac5965cda087007Jamie Gennis EGLDisplay mEglDisplay; 443ce561372186c7549a8a5fe996ac5965cda087007Jamie Gennis 4442adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden // mEglContext is the OpenGL ES context with which this GLConsumer is 445ce561372186c7549a8a5fe996ac5965cda087007Jamie Gennis // currently associated. It is initialized to EGL_NO_CONTEXT and gets set 446ce561372186c7549a8a5fe996ac5965cda087007Jamie Gennis // to the current GL context when updateTexImage is called for the first 44774bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // time and when attachToContext is called. 448ce561372186c7549a8a5fe996ac5965cda087007Jamie Gennis EGLContext mEglContext; 449ce561372186c7549a8a5fe996ac5965cda087007Jamie Gennis 450fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // mEGLSlots stores the buffers that have been allocated by the BufferQueue 451fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // for each buffer slot. It is initialized to null pointers, and gets 452fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // filled in with the result of BufferQueue::acquire when the 453fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // client dequeues a buffer from a 454fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // slot that has not yet been used. The buffer allocated to a slot will also 455fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // be replaced if the requested buffer usage or geometry differs from that 456fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // of the buffer allocated to a slot. 457bf974abe92f7495529916fe0f483f3b56e7c30e3Andy McFadden EglSlot mEglSlots[BufferQueue::NUM_BUFFER_SLOTS]; 458eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 459eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // mCurrentTexture is the buffer slot index of the buffer that is currently 460eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // bound to the OpenGL texture. It is initialized to INVALID_BUFFER_SLOT, 461eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // indicating that no buffer slot is currently bound to the texture. Note, 462eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // however, that a value of INVALID_BUFFER_SLOT does not necessarily mean 463eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // that no buffer is bound to the texture. A call to setBufferCount will 464eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // reset mCurrentTexture to INVALID_BUFFER_SLOT. 465eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam int mCurrentTexture; 466eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 4679fea3421ffddf6480f57f55a25936a886043d909Jamie Gennis // mAttached indicates whether the ConsumerBase is currently attached to 46874bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // an OpenGL ES context. For legacy reasons, this is initialized to true, 4699fea3421ffddf6480f57f55a25936a886043d909Jamie Gennis // indicating that the ConsumerBase is considered to be attached to 47074bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // whatever context is current at the time of the first updateTexImage call. 47174bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // It is set to false by detachFromContext, and then set to true again by 47274bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis // attachToContext. 47374bed55fff0132be319bcd1703970516ae28b3a9Jamie Gennis bool mAttached; 474ad678e18b66f495efa78dc3b9ab99b579945c9e2Mathias Agopian 4759870c9b66cc73ee31aabba23aa06deaf673ee5efMathias Agopian // protects static initialization 4769870c9b66cc73ee31aabba23aa06deaf673ee5efMathias Agopian static Mutex sStaticInitLock; 4779870c9b66cc73ee31aabba23aa06deaf673ee5efMathias Agopian 478ad678e18b66f495efa78dc3b9ab99b579945c9e2Mathias Agopian // mReleasedTexImageBuffer is a dummy buffer used when in single buffer 479ad678e18b66f495efa78dc3b9ab99b579945c9e2Mathias Agopian // mode and releaseTexImage() has been called 4809870c9b66cc73ee31aabba23aa06deaf673ee5efMathias Agopian static sp<GraphicBuffer> sReleasedTexImageBuffer; 4815c3d243fcca6d0678bcbb0461bbbe0b63f35212cEric Penner sp<EglImage> mReleasedTexImage; 4828ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis}; 4838ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 4848ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis// ---------------------------------------------------------------------------- 4858ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis}; // namespace android 4868ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 4872adaf04fab35cf47c824d74d901b54094e01ccd3Andy McFadden#endif // ANDROID_GUI_CONSUMER_H 488