BufferQueue.h revision e41b318bc4708e1dee9364e73215ff0d51fb76a1
16b091c53000c843211c218ce40287a7edca9bc63Daniel Lam/* 26b091c53000c843211c218ce40287a7edca9bc63Daniel Lam * Copyright (C) 2012 The Android Open Source Project 36b091c53000c843211c218ce40287a7edca9bc63Daniel Lam * 46b091c53000c843211c218ce40287a7edca9bc63Daniel Lam * Licensed under the Apache License, Version 2.0 (the "License"); 56b091c53000c843211c218ce40287a7edca9bc63Daniel Lam * you may not use this file except in compliance with the License. 66b091c53000c843211c218ce40287a7edca9bc63Daniel Lam * You may obtain a copy of the License at 76b091c53000c843211c218ce40287a7edca9bc63Daniel Lam * 86b091c53000c843211c218ce40287a7edca9bc63Daniel Lam * http://www.apache.org/licenses/LICENSE-2.0 96b091c53000c843211c218ce40287a7edca9bc63Daniel Lam * 106b091c53000c843211c218ce40287a7edca9bc63Daniel Lam * Unless required by applicable law or agreed to in writing, software 116b091c53000c843211c218ce40287a7edca9bc63Daniel Lam * distributed under the License is distributed on an "AS IS" BASIS, 126b091c53000c843211c218ce40287a7edca9bc63Daniel Lam * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 136b091c53000c843211c218ce40287a7edca9bc63Daniel Lam * See the License for the specific language governing permissions and 146b091c53000c843211c218ce40287a7edca9bc63Daniel Lam * limitations under the License. 156b091c53000c843211c218ce40287a7edca9bc63Daniel Lam */ 166b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 176b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#ifndef ANDROID_GUI_BUFFERQUEUE_H 186b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#define ANDROID_GUI_BUFFERQUEUE_H 196b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 206b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#include <EGL/egl.h> 21f71c4ae136f7749b9dfdaa2dd64d771868eeeb2dDaniel Lam#include <EGL/eglext.h> 226b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2390ac799241f077a7b7e6c1875fd933864c8dd2a7Mathias Agopian#include <gui/IGraphicBufferAlloc.h> 246b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#include <gui/ISurfaceTexture.h> 256b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 266b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#include <ui/GraphicBuffer.h> 276b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 286b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#include <utils/String8.h> 296b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#include <utils/Vector.h> 306b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#include <utils/threads.h> 316b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 326b091c53000c843211c218ce40287a7edca9bc63Daniel Lamnamespace android { 336b091c53000c843211c218ce40287a7edca9bc63Daniel Lam// ---------------------------------------------------------------------------- 346b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 356b091c53000c843211c218ce40287a7edca9bc63Daniel Lamclass BufferQueue : public BnSurfaceTexture { 366b091c53000c843211c218ce40287a7edca9bc63Daniel Lampublic: 376b091c53000c843211c218ce40287a7edca9bc63Daniel Lam enum { MIN_UNDEQUEUED_BUFFERS = 2 }; 386b091c53000c843211c218ce40287a7edca9bc63Daniel Lam enum { NUM_BUFFER_SLOTS = 32 }; 396b091c53000c843211c218ce40287a7edca9bc63Daniel Lam enum { NO_CONNECTED_API = 0 }; 40eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam enum { INVALID_BUFFER_SLOT = -1 }; 41fbcda930dd8b2823cfeb160fd0131f5897b7522fDaniel Lam enum { STALE_BUFFER_SLOT = 1, NO_BUFFER_AVAILABLE }; 426b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 43fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // ConsumerListener is the interface through which the BufferQueue notifies 44fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // the consumer of events that the consumer may wish to react to. Because 45fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // the consumer will generally have a mutex that is locked during calls from 46fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // teh consumer to the BufferQueue, these calls from the BufferQueue to the 47fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // consumer *MUST* be called only when the BufferQueue mutex is NOT locked. 48fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis struct ConsumerListener : public virtual RefBase { 49fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // onFrameAvailable is called from queueBuffer each time an additional 50fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // frame becomes available for consumption. This means that frames that 51fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // are queued while in asynchronous mode only trigger the callback if no 52fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // previous frames are pending. Frames queued while in synchronous mode 53fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // always trigger the callback. 546b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // 556b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // This is called without any lock held and can be called concurrently 566b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // by multiple threads. 576b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual void onFrameAvailable() = 0; 58fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 59fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // onBuffersReleased is called to notify the buffer consumer that the 60fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // BufferQueue has released its references to one or more GraphicBuffers 61fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // contained in its slots. The buffer consumer should then call 62fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // BufferQueue::getReleasedBuffers to retrieve the list of buffers 63fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // 64fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // This is called without any lock held and can be called concurrently 65fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // by multiple threads. 66fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis virtual void onBuffersReleased() = 0; 67fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis }; 68fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 69fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // ProxyConsumerListener is a ConsumerListener implementation that keeps a weak 70fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // reference to the actual consumer object. It forwards all calls to that 71fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // consumer object so long as it exists. 72fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // 73fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // This class exists to avoid having a circular reference between the 74fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // BufferQueue object and the consumer object. The reason this can't be a weak 75fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // reference in the BufferQueue class is because we're planning to expose the 76fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // consumer side of a BufferQueue as a binder interface, which doesn't support 77fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // weak references. 78fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis class ProxyConsumerListener : public BufferQueue::ConsumerListener { 79fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis public: 80fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 81fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis ProxyConsumerListener(const wp<BufferQueue::ConsumerListener>& consumerListener); 82fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis virtual ~ProxyConsumerListener(); 83fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis virtual void onFrameAvailable(); 84fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis virtual void onBuffersReleased(); 85fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 86fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis private: 87fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 88fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // mConsumerListener is a weak reference to the ConsumerListener. This is 89fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // the raison d'etre of ProxyConsumerListener. 90fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis wp<BufferQueue::ConsumerListener> mConsumerListener; 916b091c53000c843211c218ce40287a7edca9bc63Daniel Lam }; 926b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 93fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 946b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue manages a pool of gralloc memory slots to be used 956b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // by producers and consumers. 966b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // allowSynchronousMode specifies whether or not synchronous mode can be 976b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // enabled. 98abe61bfda4938abd932465e27c29ba9e41aea606Daniel Lam // bufferCount sets the minimum number of undequeued buffers for this queue 99abe61bfda4938abd932465e27c29ba9e41aea606Daniel Lam BufferQueue( bool allowSynchronousMode = true, int bufferCount = MIN_UNDEQUEUED_BUFFERS); 1006b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual ~BufferQueue(); 1016b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 102b856052c00dfef70d0957482c72c2979ffc4733aDaniel Lam virtual int query(int what, int* value); 103b856052c00dfef70d0957482c72c2979ffc4733aDaniel Lam 1046b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // setBufferCount updates the number of available buffer slots. After 1056b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // calling this all buffer slots are both unallocated and owned by the 1066b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue object (i.e. they are not owned by the client). 1076b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t setBufferCount(int bufferCount); 1086b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1096b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t requestBuffer(int slot, sp<GraphicBuffer>* buf); 1106b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1116b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // dequeueBuffer gets the next buffer slot index for the client to use. If a 1126b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // buffer slot is available then that slot index is written to the location 1136b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // pointed to by the buf argument and a status of OK is returned. If no 1146b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // slot is available then a status of -EBUSY is returned and buf is 1156b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // unmodified. 1166b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // The width and height parameters must be no greater than the minimum of 1176b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // GL_MAX_VIEWPORT_DIMS and GL_MAX_TEXTURE_SIZE (see: glGetIntegerv). 1186b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // An error due to invalid dimensions might not be reported until 1196b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // updateTexImage() is called. 1206b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t dequeueBuffer(int *buf, uint32_t width, uint32_t height, 1216b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t format, uint32_t usage); 1226b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1236b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // queueBuffer returns a filled buffer to the BufferQueue. In addition, a 1246b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // timestamp must be provided for the buffer. The timestamp is in 1256b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // nanoseconds, and must be monotonically increasing. Its other semantics 1266b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // (zero point, etc) are client-dependent and should be documented by the 1276b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // client. 128f0bc2f1d8d37977bd3aef3d3326a70e9e69d4246Mathias Agopian virtual status_t queueBuffer(int buf, 129f0bc2f1d8d37977bd3aef3d3326a70e9e69d4246Mathias Agopian const QueueBufferInput& input, QueueBufferOutput* output); 130f0bc2f1d8d37977bd3aef3d3326a70e9e69d4246Mathias Agopian 1316b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual void cancelBuffer(int buf); 1326b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1336b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // setSynchronousMode set whether dequeueBuffer is synchronous or 1346b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // asynchronous. In synchronous mode, dequeueBuffer blocks until 1356b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // a buffer is available, the currently bound buffer can be dequeued and 1366b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // queued buffers will be retired in order. 1376b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // The default mode is asynchronous. 1386b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t setSynchronousMode(bool enabled); 1396b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1406b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // connect attempts to connect a producer client API to the BufferQueue. 1416b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // This must be called before any other ISurfaceTexture methods are called 1426b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // except for getAllocator. 1436b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // 1446b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // This method will fail if the connect was previously called on the 1456b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue and no corresponding disconnect call was made. 14624202f5676c32edeef6544cf36e06b9fc970dbdeMathias Agopian virtual status_t connect(int api, QueueBufferOutput* output); 1476b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1486b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // disconnect attempts to disconnect a producer client API from the 1496b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue. Calling this method will cause any subsequent calls to other 1506b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // ISurfaceTexture methods to fail except for getAllocator and connect. 1516b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // Successfully calling connect after this will allow the other methods to 1526b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // succeed again. 1536b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // 1546b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // This method will fail if the the BufferQueue is not currently 1556b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // connected to the specified client API. 1566b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t disconnect(int api); 1576b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 158eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // dump our state in a String 159eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam virtual void dump(String8& result) const; 160eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam virtual void dump(String8& result, const char* prefix, char* buffer, size_t SIZE) const; 161eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 162eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // public facing structure for BufferSlot 163eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam struct BufferItem { 164eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 165eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam BufferItem() 166eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam : 167eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam mTransform(0), 168eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam mScalingMode(NATIVE_WINDOW_SCALING_MODE_FREEZE), 169eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam mTimestamp(0), 170eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam mFrameNumber(0), 171eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam mBuf(INVALID_BUFFER_SLOT) { 172eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam mCrop.makeInvalid(); 173eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam } 174eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // mGraphicBuffer points to the buffer allocated for this slot or is NULL 175eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // if no buffer has been allocated. 176eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam sp<GraphicBuffer> mGraphicBuffer; 177eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 178851ef8f1bfbb164d61b1528a529a464f0a60dbafMathias Agopian // mCrop is the current crop rectangle for this buffer slot. 179eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam Rect mCrop; 180eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 181851ef8f1bfbb164d61b1528a529a464f0a60dbafMathias Agopian // mTransform is the current transform flags for this buffer slot. 182eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam uint32_t mTransform; 183eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 184851ef8f1bfbb164d61b1528a529a464f0a60dbafMathias Agopian // mScalingMode is the current scaling mode for this buffer slot. 185eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam uint32_t mScalingMode; 186eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 187eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // mTimestamp is the current timestamp for this buffer slot. This gets 188eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // to set by queueBuffer each time this slot is queued. 189eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam int64_t mTimestamp; 1906b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 191eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // mFrameNumber is the number of the queued frame for this slot. 192eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam uint64_t mFrameNumber; 193eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 194efc7ab6dcea8c22ddd7c0259ef4ab4bbf1e93044Jamie Gennis // mBuf is the slot index of this buffer 195eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam int mBuf; 196eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam }; 197eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 198eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // The following public functions is the consumer facing interface 199eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 200fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // acquireBuffer attempts to acquire ownership of the next pending buffer in 201fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // the BufferQueue. If no buffer is pending then it returns -EINVAL. If a 202fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // buffer is successfully acquired, the information about the buffer is 203fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // returned in BufferItem. If the buffer returned had previously been 204fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // acquired then the BufferItem::mGraphicBuffer field of buffer is set to 205fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // NULL and it is assumed that the consumer still holds a reference to the 206fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // buffer. 207fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis status_t acquireBuffer(BufferItem *buffer); 208eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 209eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // releaseBuffer releases a buffer slot from the consumer back to the 210eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // BufferQueue pending a fence sync. 211fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // 212e41b318bc4708e1dee9364e73215ff0d51fb76a1Eino-Ville Talvala // If releaseBuffer returns STALE_BUFFER_SLOT, then the consumer must free 213e41b318bc4708e1dee9364e73215ff0d51fb76a1Eino-Ville Talvala // any references to the just-released buffer that it might have, as if it 214e41b318bc4708e1dee9364e73215ff0d51fb76a1Eino-Ville Talvala // had received a onBuffersReleased() call with a mask set for the released 215e41b318bc4708e1dee9364e73215ff0d51fb76a1Eino-Ville Talvala // buffer. 216e41b318bc4708e1dee9364e73215ff0d51fb76a1Eino-Ville Talvala // 217fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // Note that the dependencies on EGL will be removed once we switch to using 218fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // the Android HW Sync HAL. 219eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam status_t releaseBuffer(int buf, EGLDisplay display, EGLSyncKHR fence); 220eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 221fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // consumerConnect connects a consumer to the BufferQueue. Only one 222fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // consumer may be connected, and when that consumer disconnects the 223fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // BufferQueue is placed into the "abandoned" state, causing most 224fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // interactions with the BufferQueue by the producer to fail. 225fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis status_t consumerConnect(const sp<ConsumerListener>& consumer); 226fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 227eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // consumerDisconnect disconnects a consumer from the BufferQueue. All 228fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // buffers will be freed and the BufferQueue is placed in the "abandoned" 229fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // state, causing most interactions with the BufferQueue by the producer to 230fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // fail. 231eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam status_t consumerDisconnect(); 232eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 233fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // getReleasedBuffers sets the value pointed to by slotMask to a bit mask 234fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // indicating which buffer slots the have been released by the BufferQueue 235fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // but have not yet been released by the consumer. 236fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis status_t getReleasedBuffers(uint32_t* slotMask); 237fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 238eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // setDefaultBufferSize is used to set the size of buffers returned by 239eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // requestBuffers when a with and height of zero is requested. 240eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam status_t setDefaultBufferSize(uint32_t w, uint32_t h); 241eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 242eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // setBufferCountServer set the buffer count. If the client has requested 243eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // a buffer count using setBufferCount, the server-buffer count will 244eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // take effect once the client sets the count back to zero. 245eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam status_t setBufferCountServer(int bufferCount); 246eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 247eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // isSynchronousMode returns whether the SurfaceTexture is currently in 248eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // synchronous mode. 249eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam bool isSynchronousMode() const; 250eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 251eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // setConsumerName sets the name used in logging 252eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam void setConsumerName(const String8& name); 253eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 254b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // setDefaultBufferFormat allows the BufferQueue to create 255b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // GraphicBuffers of a defaultFormat if no format is specified 256b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // in dequeueBuffer 257b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam status_t setDefaultBufferFormat(uint32_t defaultFormat); 258b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam 259b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // setConsumerUsageBits will turn on additional usage bits for dequeueBuffer 260b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam status_t setConsumerUsageBits(uint32_t usage); 261b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam 262b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // setTransformHint bakes in rotation to buffers so overlays can be used 263b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam status_t setTransformHint(uint32_t hint); 264eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 265eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lamprivate: 2666b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // freeBufferLocked frees the resources (both GraphicBuffer and EGLImage) 2676b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // for the given slot. 2686b091c53000c843211c218ce40287a7edca9bc63Daniel Lam void freeBufferLocked(int index); 2696b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2706b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // freeAllBuffersLocked frees the resources (both GraphicBuffer and 2716b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // EGLImage) for all slots. 2726b091c53000c843211c218ce40287a7edca9bc63Daniel Lam void freeAllBuffersLocked(); 2736b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2746b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // freeAllBuffersExceptHeadLocked frees the resources (both GraphicBuffer 2756b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // and EGLImage) for all slots except the head of mQueue 2766b091c53000c843211c218ce40287a7edca9bc63Daniel Lam void freeAllBuffersExceptHeadLocked(); 2776b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2786b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // drainQueueLocked drains the buffer queue if we're in synchronous mode 2796b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // returns immediately otherwise. It returns NO_INIT if the BufferQueue 2806b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // became abandoned or disconnected during this call. 2816b091c53000c843211c218ce40287a7edca9bc63Daniel Lam status_t drainQueueLocked(); 2826b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2836b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // drainQueueAndFreeBuffersLocked drains the buffer queue if we're in 2846b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // synchronous mode and free all buffers. In asynchronous mode, all buffers 2856b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // are freed except the current buffer. 2866b091c53000c843211c218ce40287a7edca9bc63Daniel Lam status_t drainQueueAndFreeBuffersLocked(); 2876b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2886b091c53000c843211c218ce40287a7edca9bc63Daniel Lam status_t setBufferCountServerLocked(int bufferCount); 2896b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2906b091c53000c843211c218ce40287a7edca9bc63Daniel Lam struct BufferSlot { 2916b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2926b091c53000c843211c218ce40287a7edca9bc63Daniel Lam BufferSlot() 293eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam : mEglDisplay(EGL_NO_DISPLAY), 2946b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mBufferState(BufferSlot::FREE), 2956b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mRequestBufferCalled(false), 2966b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mTransform(0), 2976b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mScalingMode(NATIVE_WINDOW_SCALING_MODE_FREEZE), 2986b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mTimestamp(0), 2996b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mFrameNumber(0), 300eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam mFence(EGL_NO_SYNC_KHR), 3019abe1ebc9575dc5a19bf1dfce6e9b02e03374457Daniel Lam mAcquireCalled(false), 3029abe1ebc9575dc5a19bf1dfce6e9b02e03374457Daniel Lam mNeedsCleanupOnRelease(false) { 3036b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mCrop.makeInvalid(); 3046b091c53000c843211c218ce40287a7edca9bc63Daniel Lam } 3056b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3066b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mGraphicBuffer points to the buffer allocated for this slot or is NULL 3076b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // if no buffer has been allocated. 3086b091c53000c843211c218ce40287a7edca9bc63Daniel Lam sp<GraphicBuffer> mGraphicBuffer; 3096b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3106b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mEglDisplay is the EGLDisplay used to create mEglImage. 3116b091c53000c843211c218ce40287a7edca9bc63Daniel Lam EGLDisplay mEglDisplay; 3126b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3136b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferState represents the different states in which a buffer slot 3146b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // can be. 3156b091c53000c843211c218ce40287a7edca9bc63Daniel Lam enum BufferState { 3166b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // FREE indicates that the buffer is not currently being used and 3176b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // will not be used in the future until it gets dequeued and 3186b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // subsequently queued by the client. 319eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // aka "owned by BufferQueue, ready to be dequeued" 3206b091c53000c843211c218ce40287a7edca9bc63Daniel Lam FREE = 0, 3216b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3226b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // DEQUEUED indicates that the buffer has been dequeued by the 3236b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // client, but has not yet been queued or canceled. The buffer is 3246b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // considered 'owned' by the client, and the server should not use 3256b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // it for anything. 3266b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // 3276b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // Note that when in synchronous-mode (mSynchronousMode == true), 3286b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // the buffer that's currently attached to the texture may be 3296b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // dequeued by the client. That means that the current buffer can 3306b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // be in either the DEQUEUED or QUEUED state. In asynchronous mode, 3316b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // however, the current buffer is always in the QUEUED state. 332eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // aka "owned by producer, ready to be queued" 3336b091c53000c843211c218ce40287a7edca9bc63Daniel Lam DEQUEUED = 1, 3346b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3356b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // QUEUED indicates that the buffer has been queued by the client, 3366b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // and has not since been made available for the client to dequeue. 3376b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // Attaching the buffer to the texture does NOT transition the 3386b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // buffer away from the QUEUED state. However, in Synchronous mode 3396b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // the current buffer may be dequeued by the client under some 3406b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // circumstances. See the note about the current buffer in the 3416b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // documentation for DEQUEUED. 342eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // aka "owned by BufferQueue, ready to be acquired" 3436b091c53000c843211c218ce40287a7edca9bc63Daniel Lam QUEUED = 2, 344eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 345eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // aka "owned by consumer, ready to be released" 346eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam ACQUIRED = 3 3476b091c53000c843211c218ce40287a7edca9bc63Daniel Lam }; 3486b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3496b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mBufferState is the current state of this buffer slot. 3506b091c53000c843211c218ce40287a7edca9bc63Daniel Lam BufferState mBufferState; 3516b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3526b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mRequestBufferCalled is used for validating that the client did 3536b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // call requestBuffer() when told to do so. Technically this is not 3546b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // needed but useful for debugging and catching client bugs. 3556b091c53000c843211c218ce40287a7edca9bc63Daniel Lam bool mRequestBufferCalled; 3566b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 357851ef8f1bfbb164d61b1528a529a464f0a60dbafMathias Agopian // mCrop is the current crop rectangle for this buffer slot. 3586b091c53000c843211c218ce40287a7edca9bc63Daniel Lam Rect mCrop; 3596b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 360851ef8f1bfbb164d61b1528a529a464f0a60dbafMathias Agopian // mTransform is the current transform flags for this buffer slot. 3616b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t mTransform; 3626b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 363851ef8f1bfbb164d61b1528a529a464f0a60dbafMathias Agopian // mScalingMode is the current scaling mode for this buffer slot. 3646b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t mScalingMode; 3656b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3666b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mTimestamp is the current timestamp for this buffer slot. This gets 3676b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // to set by queueBuffer each time this slot is queued. 3686b091c53000c843211c218ce40287a7edca9bc63Daniel Lam int64_t mTimestamp; 3696b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3706b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mFrameNumber is the number of the queued frame for this slot. 3716b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint64_t mFrameNumber; 3726b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3736b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mFence is the EGL sync object that must signal before the buffer 3746b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // associated with this buffer slot may be dequeued. It is initialized 3756b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // to EGL_NO_SYNC_KHR when the buffer is created and (optionally, based 3766b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // on a compile-time option) set to a new sync object in updateTexImage. 3776b091c53000c843211c218ce40287a7edca9bc63Daniel Lam EGLSyncKHR mFence; 378eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 379eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // Indicates whether this buffer has been seen by a consumer yet 380eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam bool mAcquireCalled; 3819abe1ebc9575dc5a19bf1dfce6e9b02e03374457Daniel Lam 3829abe1ebc9575dc5a19bf1dfce6e9b02e03374457Daniel Lam // Indicates whether this buffer needs to be cleaned up by consumer 3839abe1ebc9575dc5a19bf1dfce6e9b02e03374457Daniel Lam bool mNeedsCleanupOnRelease; 3846b091c53000c843211c218ce40287a7edca9bc63Daniel Lam }; 3856b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3866b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mSlots is the array of buffer slots that must be mirrored on the client 3876b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // side. This allows buffer ownership to be transferred between the client 3886b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // and server without sending a GraphicBuffer over binder. The entire array 3896b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // is initialized to NULL at construction time, and buffers are allocated 3906b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // for a slot when requestBuffer is called with that slot's index. 3916b091c53000c843211c218ce40287a7edca9bc63Daniel Lam BufferSlot mSlots[NUM_BUFFER_SLOTS]; 3926b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3936b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mDefaultWidth holds the default width of allocated buffers. It is used 3946b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // in requestBuffers() if a width and height of zero is specified. 3956b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t mDefaultWidth; 3966b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3976b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mDefaultHeight holds the default height of allocated buffers. It is used 3986b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // in requestBuffers() if a width and height of zero is specified. 3996b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t mDefaultHeight; 4006b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4016b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mPixelFormat holds the pixel format of allocated buffers. It is used 4026b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // in requestBuffers() if a format of zero is specified. 4036b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t mPixelFormat; 4046b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 405abe61bfda4938abd932465e27c29ba9e41aea606Daniel Lam // mMinUndequeuedBuffers is a constraint on the number of buffers 406abe61bfda4938abd932465e27c29ba9e41aea606Daniel Lam // not dequeued at any time 407abe61bfda4938abd932465e27c29ba9e41aea606Daniel Lam int mMinUndequeuedBuffers; 408abe61bfda4938abd932465e27c29ba9e41aea606Daniel Lam 409abe61bfda4938abd932465e27c29ba9e41aea606Daniel Lam // mMinAsyncBufferSlots is a constraint on the minimum mBufferCount 410abe61bfda4938abd932465e27c29ba9e41aea606Daniel Lam // when this BufferQueue is in asynchronous mode 411abe61bfda4938abd932465e27c29ba9e41aea606Daniel Lam int mMinAsyncBufferSlots; 412abe61bfda4938abd932465e27c29ba9e41aea606Daniel Lam 413abe61bfda4938abd932465e27c29ba9e41aea606Daniel Lam // mMinSyncBufferSlots is a constraint on the minimum mBufferCount 414abe61bfda4938abd932465e27c29ba9e41aea606Daniel Lam // when this BufferQueue is in synchronous mode 415abe61bfda4938abd932465e27c29ba9e41aea606Daniel Lam int mMinSyncBufferSlots; 416abe61bfda4938abd932465e27c29ba9e41aea606Daniel Lam 4176b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mBufferCount is the number of buffer slots that the client and server 4186b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // must maintain. It defaults to MIN_ASYNC_BUFFER_SLOTS and can be changed 4196b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // by calling setBufferCount or setBufferCountServer 4206b091c53000c843211c218ce40287a7edca9bc63Daniel Lam int mBufferCount; 4216b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4226b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mClientBufferCount is the number of buffer slots requested by the client. 4236b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // The default is zero, which means the client doesn't care how many buffers 4246b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // there is. 4256b091c53000c843211c218ce40287a7edca9bc63Daniel Lam int mClientBufferCount; 4266b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4276b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mServerBufferCount buffer count requested by the server-side 4286b091c53000c843211c218ce40287a7edca9bc63Daniel Lam int mServerBufferCount; 4296b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4306b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mGraphicBufferAlloc is the connection to SurfaceFlinger that is used to 4316b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // allocate new GraphicBuffer objects. 4326b091c53000c843211c218ce40287a7edca9bc63Daniel Lam sp<IGraphicBufferAlloc> mGraphicBufferAlloc; 4336b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 434fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // mConsumerListener is used to notify the connected consumer of 435fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // asynchronous events that it may wish to react to. It is initially set 436fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // to NULL and is written by consumerConnect and consumerDisconnect. 437fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis sp<ConsumerListener> mConsumerListener; 4386b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4396b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mSynchronousMode whether we're in synchronous mode or not 4406b091c53000c843211c218ce40287a7edca9bc63Daniel Lam bool mSynchronousMode; 4416b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4426b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mAllowSynchronousMode whether we allow synchronous mode or not 4436b091c53000c843211c218ce40287a7edca9bc63Daniel Lam const bool mAllowSynchronousMode; 4446b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4456b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mConnectedApi indicates the API that is currently connected to this 4466b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue. It defaults to NO_CONNECTED_API (= 0), and gets updated 4476b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // by the connect and disconnect methods. 4486b091c53000c843211c218ce40287a7edca9bc63Daniel Lam int mConnectedApi; 4496b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4506b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mDequeueCondition condition used for dequeueBuffer in synchronous mode 4516b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mutable Condition mDequeueCondition; 4526b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4536b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mQueue is a FIFO of queued buffers used in synchronous mode 4546b091c53000c843211c218ce40287a7edca9bc63Daniel Lam typedef Vector<int> Fifo; 4556b091c53000c843211c218ce40287a7edca9bc63Daniel Lam Fifo mQueue; 4566b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4576b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mAbandoned indicates that the BufferQueue will no longer be used to 4586b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // consume images buffers pushed to it using the ISurfaceTexture interface. 4596b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // It is initialized to false, and set to true in the abandon method. A 4606b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue that has been abandoned will return the NO_INIT error from 4616b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // all ISurfaceTexture methods capable of returning an error. 4626b091c53000c843211c218ce40287a7edca9bc63Daniel Lam bool mAbandoned; 4636b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4646b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mName is a string used to identify the BufferQueue in log messages. 4656b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // It is set by the setName method. 466eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam String8 mConsumerName; 4676b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4686b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mMutex is the mutex used to prevent concurrent access to the member 4696b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // variables of BufferQueue objects. It must be locked whenever the 4706b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // member variables are accessed. 4716b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mutable Mutex mMutex; 4726b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4736b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mFrameCounter is the free running counter, incremented for every buffer queued 4746b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // with the surface Texture. 4756b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint64_t mFrameCounter; 476eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 477b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // mBufferHasBeenQueued is true once a buffer has been queued. It is reset 478b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // by changing the buffer count. 479eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam bool mBufferHasBeenQueued; 480b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam 481b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // mDefaultBufferFormat can be set so it will override 482b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // the buffer format when it isn't specified in dequeueBuffer 483b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam uint32_t mDefaultBufferFormat; 484b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam 485b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // mConsumerUsageBits contains flags the consumer wants for GraphicBuffers 486b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam uint32_t mConsumerUsageBits; 487b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam 488b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // mTransformHint is used to optimize for screen rotations 489b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam uint32_t mTransformHint; 4906b091c53000c843211c218ce40287a7edca9bc63Daniel Lam}; 4916b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4926b091c53000c843211c218ce40287a7edca9bc63Daniel Lam// ---------------------------------------------------------------------------- 4936b091c53000c843211c218ce40287a7edca9bc63Daniel Lam}; // namespace android 4946b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4956b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#endif // ANDROID_GUI_BUFFERQUEUE_H 496