BufferQueue.h revision e191e6c34829aec406a9cfe3e95211f884a311ff
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 26ef19414bd8b77a26f5751f3845be79025a8263feJesse Hall#include <ui/Fence.h> 276b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#include <ui/GraphicBuffer.h> 286b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 296b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#include <utils/String8.h> 306b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#include <utils/Vector.h> 316b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#include <utils/threads.h> 326b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 336b091c53000c843211c218ce40287a7edca9bc63Daniel Lamnamespace android { 346b091c53000c843211c218ce40287a7edca9bc63Daniel Lam// ---------------------------------------------------------------------------- 356b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 366b091c53000c843211c218ce40287a7edca9bc63Daniel Lamclass BufferQueue : public BnSurfaceTexture { 376b091c53000c843211c218ce40287a7edca9bc63Daniel Lampublic: 386b091c53000c843211c218ce40287a7edca9bc63Daniel Lam enum { MIN_UNDEQUEUED_BUFFERS = 2 }; 396b091c53000c843211c218ce40287a7edca9bc63Daniel Lam enum { NUM_BUFFER_SLOTS = 32 }; 406b091c53000c843211c218ce40287a7edca9bc63Daniel Lam enum { NO_CONNECTED_API = 0 }; 41eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam enum { INVALID_BUFFER_SLOT = -1 }; 42fbcda930dd8b2823cfeb160fd0131f5897b7522fDaniel Lam enum { STALE_BUFFER_SLOT = 1, NO_BUFFER_AVAILABLE }; 436b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 44fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // ConsumerListener is the interface through which the BufferQueue notifies 45fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // the consumer of events that the consumer may wish to react to. Because 46fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // the consumer will generally have a mutex that is locked during calls from 47fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // teh consumer to the BufferQueue, these calls from the BufferQueue to the 48fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // consumer *MUST* be called only when the BufferQueue mutex is NOT locked. 49fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis struct ConsumerListener : public virtual RefBase { 50fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // onFrameAvailable is called from queueBuffer each time an additional 51fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // frame becomes available for consumption. This means that frames that 52fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // are queued while in asynchronous mode only trigger the callback if no 53fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // previous frames are pending. Frames queued while in synchronous mode 54fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // always trigger the callback. 556b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // 566b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // This is called without any lock held and can be called concurrently 576b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // by multiple threads. 586b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual void onFrameAvailable() = 0; 59fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 60fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // onBuffersReleased is called to notify the buffer consumer that the 61fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // BufferQueue has released its references to one or more GraphicBuffers 62fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // contained in its slots. The buffer consumer should then call 63fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // BufferQueue::getReleasedBuffers to retrieve the list of buffers 64fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // 65fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // This is called without any lock held and can be called concurrently 66fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // by multiple threads. 67fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis virtual void onBuffersReleased() = 0; 68fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis }; 69fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 70fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // ProxyConsumerListener is a ConsumerListener implementation that keeps a weak 71fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // reference to the actual consumer object. It forwards all calls to that 72fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // consumer object so long as it exists. 73fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // 74fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // This class exists to avoid having a circular reference between the 75fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // BufferQueue object and the consumer object. The reason this can't be a weak 76fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // reference in the BufferQueue class is because we're planning to expose the 77fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // consumer side of a BufferQueue as a binder interface, which doesn't support 78fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // weak references. 79fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis class ProxyConsumerListener : public BufferQueue::ConsumerListener { 80fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis public: 81fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 82fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis ProxyConsumerListener(const wp<BufferQueue::ConsumerListener>& consumerListener); 83fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis virtual ~ProxyConsumerListener(); 84fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis virtual void onFrameAvailable(); 85fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis virtual void onBuffersReleased(); 86fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 87fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis private: 88fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 89fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // mConsumerListener is a weak reference to the ConsumerListener. This is 90fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // the raison d'etre of ProxyConsumerListener. 91fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis wp<BufferQueue::ConsumerListener> mConsumerListener; 926b091c53000c843211c218ce40287a7edca9bc63Daniel Lam }; 936b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 94fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 956b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue manages a pool of gralloc memory slots to be used 966b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // by producers and consumers. 976b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // allowSynchronousMode specifies whether or not synchronous mode can be 986b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // enabled. 99abe61bfda4938abd932465e27c29ba9e41aea606Daniel Lam // bufferCount sets the minimum number of undequeued buffers for this queue 1003e87601170141229d661df93e2f59e1ced73474bMathias Agopian BufferQueue(bool allowSynchronousMode = true, 1013e87601170141229d661df93e2f59e1ced73474bMathias Agopian int bufferCount = MIN_UNDEQUEUED_BUFFERS, 1023e87601170141229d661df93e2f59e1ced73474bMathias Agopian const sp<IGraphicBufferAlloc>& allocator = NULL); 1036b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual ~BufferQueue(); 1046b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 105b856052c00dfef70d0957482c72c2979ffc4733aDaniel Lam virtual int query(int what, int* value); 106b856052c00dfef70d0957482c72c2979ffc4733aDaniel Lam 1076b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // setBufferCount updates the number of available buffer slots. After 1086b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // calling this all buffer slots are both unallocated and owned by the 1096b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue object (i.e. they are not owned by the client). 1106b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t setBufferCount(int bufferCount); 1116b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1126b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t requestBuffer(int slot, sp<GraphicBuffer>* buf); 1136b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1146b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // dequeueBuffer gets the next buffer slot index for the client to use. If a 1156b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // buffer slot is available then that slot index is written to the location 1166b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // pointed to by the buf argument and a status of OK is returned. If no 1176b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // slot is available then a status of -EBUSY is returned and buf is 1186b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // unmodified. 119f78575400977f644cf0b12beb2fa5fc278b6ed4cJesse Hall // 120f78575400977f644cf0b12beb2fa5fc278b6ed4cJesse Hall // The fence parameter will be updated to hold the fence associated with 121f78575400977f644cf0b12beb2fa5fc278b6ed4cJesse Hall // the buffer. The contents of the buffer must not be overwritten until the 122f78575400977f644cf0b12beb2fa5fc278b6ed4cJesse Hall // fence signals. If the fence is NULL, the buffer may be written 123f78575400977f644cf0b12beb2fa5fc278b6ed4cJesse Hall // immediately. 124f78575400977f644cf0b12beb2fa5fc278b6ed4cJesse Hall // 1256b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // The width and height parameters must be no greater than the minimum of 1266b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // GL_MAX_VIEWPORT_DIMS and GL_MAX_TEXTURE_SIZE (see: glGetIntegerv). 1276b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // An error due to invalid dimensions might not be reported until 1286b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // updateTexImage() is called. 129f78575400977f644cf0b12beb2fa5fc278b6ed4cJesse Hall virtual status_t dequeueBuffer(int *buf, sp<Fence>& fence, 130f78575400977f644cf0b12beb2fa5fc278b6ed4cJesse Hall uint32_t width, uint32_t height, uint32_t format, uint32_t usage); 1316b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1326b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // queueBuffer returns a filled buffer to the BufferQueue. In addition, a 1336b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // timestamp must be provided for the buffer. The timestamp is in 1346b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // nanoseconds, and must be monotonically increasing. Its other semantics 1356b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // (zero point, etc) are client-dependent and should be documented by the 1366b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // client. 137f0bc2f1d8d37977bd3aef3d3326a70e9e69d4246Mathias Agopian virtual status_t queueBuffer(int buf, 138f0bc2f1d8d37977bd3aef3d3326a70e9e69d4246Mathias Agopian const QueueBufferInput& input, QueueBufferOutput* output); 139f0bc2f1d8d37977bd3aef3d3326a70e9e69d4246Mathias Agopian 140c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall virtual void cancelBuffer(int buf, sp<Fence> fence); 1416b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1426b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // setSynchronousMode set whether dequeueBuffer is synchronous or 1436b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // asynchronous. In synchronous mode, dequeueBuffer blocks until 1446b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // a buffer is available, the currently bound buffer can be dequeued and 1456b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // queued buffers will be retired in order. 1466b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // The default mode is asynchronous. 1476b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t setSynchronousMode(bool enabled); 1486b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1496b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // connect attempts to connect a producer client API to the BufferQueue. 1506b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // This must be called before any other ISurfaceTexture methods are called 1516b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // except for getAllocator. 1526b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // 1536b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // This method will fail if the connect was previously called on the 1546b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue and no corresponding disconnect call was made. 15524202f5676c32edeef6544cf36e06b9fc970dbdeMathias Agopian virtual status_t connect(int api, QueueBufferOutput* output); 1566b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1576b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // disconnect attempts to disconnect a producer client API from the 1586b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue. Calling this method will cause any subsequent calls to other 1596b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // ISurfaceTexture methods to fail except for getAllocator and connect. 1606b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // Successfully calling connect after this will allow the other methods to 1616b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // succeed again. 1626b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // 1636b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // This method will fail if the the BufferQueue is not currently 1646b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // connected to the specified client API. 1656b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t disconnect(int api); 1666b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 167eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // dump our state in a String 168eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam virtual void dump(String8& result) const; 169eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam virtual void dump(String8& result, const char* prefix, char* buffer, size_t SIZE) const; 170eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 171eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // public facing structure for BufferSlot 172eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam struct BufferItem { 173eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 174eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam BufferItem() 175eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam : 176eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam mTransform(0), 177eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam mScalingMode(NATIVE_WINDOW_SCALING_MODE_FREEZE), 178eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam mTimestamp(0), 179eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam mFrameNumber(0), 180eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam mBuf(INVALID_BUFFER_SLOT) { 181eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam mCrop.makeInvalid(); 182eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam } 183eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // mGraphicBuffer points to the buffer allocated for this slot or is NULL 184eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // if no buffer has been allocated. 185eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam sp<GraphicBuffer> mGraphicBuffer; 186eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 187851ef8f1bfbb164d61b1528a529a464f0a60dbafMathias Agopian // mCrop is the current crop rectangle for this buffer slot. 188eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam Rect mCrop; 189eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 190851ef8f1bfbb164d61b1528a529a464f0a60dbafMathias Agopian // mTransform is the current transform flags for this buffer slot. 191eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam uint32_t mTransform; 192eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 193851ef8f1bfbb164d61b1528a529a464f0a60dbafMathias Agopian // mScalingMode is the current scaling mode for this buffer slot. 194eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam uint32_t mScalingMode; 195eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 196eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // mTimestamp is the current timestamp for this buffer slot. This gets 197eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // to set by queueBuffer each time this slot is queued. 198eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam int64_t mTimestamp; 1996b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 200eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // mFrameNumber is the number of the queued frame for this slot. 201eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam uint64_t mFrameNumber; 202eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 203efc7ab6dcea8c22ddd7c0259ef4ab4bbf1e93044Jamie Gennis // mBuf is the slot index of this buffer 204eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam int mBuf; 205b42b1ac1587aebda5e2f334d95b620271fafba4eJesse Hall 206b42b1ac1587aebda5e2f334d95b620271fafba4eJesse Hall // mFence is a fence that will signal when the buffer is idle. 207b42b1ac1587aebda5e2f334d95b620271fafba4eJesse Hall sp<Fence> mFence; 208eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam }; 209eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 210eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // The following public functions is the consumer facing interface 211eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 212fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // acquireBuffer attempts to acquire ownership of the next pending buffer in 213fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // the BufferQueue. If no buffer is pending then it returns -EINVAL. If a 214fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // buffer is successfully acquired, the information about the buffer is 215fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // returned in BufferItem. If the buffer returned had previously been 216fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // acquired then the BufferItem::mGraphicBuffer field of buffer is set to 217fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // NULL and it is assumed that the consumer still holds a reference to the 218fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // buffer. 219fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis status_t acquireBuffer(BufferItem *buffer); 220eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 221eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // releaseBuffer releases a buffer slot from the consumer back to the 222eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // BufferQueue pending a fence sync. 223fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // 224e41b318bc4708e1dee9364e73215ff0d51fb76a1Eino-Ville Talvala // If releaseBuffer returns STALE_BUFFER_SLOT, then the consumer must free 225e41b318bc4708e1dee9364e73215ff0d51fb76a1Eino-Ville Talvala // any references to the just-released buffer that it might have, as if it 226e41b318bc4708e1dee9364e73215ff0d51fb76a1Eino-Ville Talvala // had received a onBuffersReleased() call with a mask set for the released 227e41b318bc4708e1dee9364e73215ff0d51fb76a1Eino-Ville Talvala // buffer. 228e41b318bc4708e1dee9364e73215ff0d51fb76a1Eino-Ville Talvala // 229fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // Note that the dependencies on EGL will be removed once we switch to using 230fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // the Android HW Sync HAL. 231ef19414bd8b77a26f5751f3845be79025a8263feJesse Hall status_t releaseBuffer(int buf, EGLDisplay display, EGLSyncKHR fence, 232f78575400977f644cf0b12beb2fa5fc278b6ed4cJesse Hall const sp<Fence>& releaseFence); 233eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 234fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // consumerConnect connects a consumer to the BufferQueue. Only one 235fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // consumer may be connected, and when that consumer disconnects the 236fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // BufferQueue is placed into the "abandoned" state, causing most 237fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // interactions with the BufferQueue by the producer to fail. 238fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis status_t consumerConnect(const sp<ConsumerListener>& consumer); 239fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 240eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // consumerDisconnect disconnects a consumer from the BufferQueue. All 241fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // buffers will be freed and the BufferQueue is placed in the "abandoned" 242fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // state, causing most interactions with the BufferQueue by the producer to 243fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // fail. 244eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam status_t consumerDisconnect(); 245eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 246fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // getReleasedBuffers sets the value pointed to by slotMask to a bit mask 247fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // indicating which buffer slots the have been released by the BufferQueue 248fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // but have not yet been released by the consumer. 249fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis status_t getReleasedBuffers(uint32_t* slotMask); 250fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 251eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // setDefaultBufferSize is used to set the size of buffers returned by 252eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // requestBuffers when a with and height of zero is requested. 253eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam status_t setDefaultBufferSize(uint32_t w, uint32_t h); 254eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 25531a353da225af5329735451c761b430d82dfda1bJamie Gennis // setDefaultBufferCount set the buffer count. If the client has requested 256eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // a buffer count using setBufferCount, the server-buffer count will 257eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // take effect once the client sets the count back to zero. 25831a353da225af5329735451c761b430d82dfda1bJamie Gennis status_t setDefaultMaxBufferCount(int bufferCount); 259eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 260eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // isSynchronousMode returns whether the SurfaceTexture is currently in 261eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // synchronous mode. 262eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam bool isSynchronousMode() const; 263eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 264eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // setConsumerName sets the name used in logging 265eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam void setConsumerName(const String8& name); 266eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 267b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // setDefaultBufferFormat allows the BufferQueue to create 268b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // GraphicBuffers of a defaultFormat if no format is specified 269b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // in dequeueBuffer 270b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam status_t setDefaultBufferFormat(uint32_t defaultFormat); 271b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam 272b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // setConsumerUsageBits will turn on additional usage bits for dequeueBuffer 273b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam status_t setConsumerUsageBits(uint32_t usage); 274b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam 275b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // setTransformHint bakes in rotation to buffers so overlays can be used 276b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam status_t setTransformHint(uint32_t hint); 277eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 278eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lamprivate: 2796b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // freeBufferLocked frees the resources (both GraphicBuffer and EGLImage) 2806b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // for the given slot. 2816b091c53000c843211c218ce40287a7edca9bc63Daniel Lam void freeBufferLocked(int index); 2826b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2836b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // freeAllBuffersLocked frees the resources (both GraphicBuffer and 2846b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // EGLImage) for all slots. 2856b091c53000c843211c218ce40287a7edca9bc63Daniel Lam void freeAllBuffersLocked(); 2866b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2876b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // freeAllBuffersExceptHeadLocked frees the resources (both GraphicBuffer 2886b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // and EGLImage) for all slots except the head of mQueue 2896b091c53000c843211c218ce40287a7edca9bc63Daniel Lam void freeAllBuffersExceptHeadLocked(); 2906b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2916b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // drainQueueLocked drains the buffer queue if we're in synchronous mode 2926b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // returns immediately otherwise. It returns NO_INIT if the BufferQueue 2936b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // became abandoned or disconnected during this call. 2946b091c53000c843211c218ce40287a7edca9bc63Daniel Lam status_t drainQueueLocked(); 2956b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2966b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // drainQueueAndFreeBuffersLocked drains the buffer queue if we're in 2976b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // synchronous mode and free all buffers. In asynchronous mode, all buffers 2986b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // are freed except the current buffer. 2996b091c53000c843211c218ce40287a7edca9bc63Daniel Lam status_t drainQueueAndFreeBuffersLocked(); 3006b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 30131a353da225af5329735451c761b430d82dfda1bJamie Gennis // setDefaultMaxBufferCountLocked sets the maximum number of buffer slots 30231a353da225af5329735451c761b430d82dfda1bJamie Gennis // that will be used if the producer does not override the buffer slot 30331a353da225af5329735451c761b430d82dfda1bJamie Gennis // count. 30431a353da225af5329735451c761b430d82dfda1bJamie Gennis status_t setDefaultMaxBufferCountLocked(int count); 30531a353da225af5329735451c761b430d82dfda1bJamie Gennis 30631a353da225af5329735451c761b430d82dfda1bJamie Gennis // getMinBufferCountLocked returns the minimum number of buffers allowed 30731a353da225af5329735451c761b430d82dfda1bJamie Gennis // given the current BufferQueue state. 30831a353da225af5329735451c761b430d82dfda1bJamie Gennis int getMinMaxBufferCountLocked() const; 3096b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 310e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis // getMaxBufferCountLocked returns the maximum number of buffers that can 311e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis // be allocated at once. This value depends upon the following member 312e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis // variables: 313e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis // 314e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis // mSynchronousMode 315e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis // mMinUndequeuedBuffers 316e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis // mDefaultMaxBufferCount 317e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis // mOverrideMaxBufferCount 318e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis // 319e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis // Any time one of these member variables is changed while a producer is 320e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis // connected, mDequeueCondition must be broadcast. 321e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis int getMaxBufferCountLocked() const; 322e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis 3236b091c53000c843211c218ce40287a7edca9bc63Daniel Lam struct BufferSlot { 3246b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3256b091c53000c843211c218ce40287a7edca9bc63Daniel Lam BufferSlot() 326eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam : mEglDisplay(EGL_NO_DISPLAY), 3276b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mBufferState(BufferSlot::FREE), 3286b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mRequestBufferCalled(false), 3296b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mTransform(0), 3306b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mScalingMode(NATIVE_WINDOW_SCALING_MODE_FREEZE), 3316b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mTimestamp(0), 3326b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mFrameNumber(0), 333c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall mEglFence(EGL_NO_SYNC_KHR), 3349abe1ebc9575dc5a19bf1dfce6e9b02e03374457Daniel Lam mAcquireCalled(false), 3359abe1ebc9575dc5a19bf1dfce6e9b02e03374457Daniel Lam mNeedsCleanupOnRelease(false) { 3366b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mCrop.makeInvalid(); 3376b091c53000c843211c218ce40287a7edca9bc63Daniel Lam } 3386b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3396b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mGraphicBuffer points to the buffer allocated for this slot or is NULL 3406b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // if no buffer has been allocated. 3416b091c53000c843211c218ce40287a7edca9bc63Daniel Lam sp<GraphicBuffer> mGraphicBuffer; 3426b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3436b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mEglDisplay is the EGLDisplay used to create mEglImage. 3446b091c53000c843211c218ce40287a7edca9bc63Daniel Lam EGLDisplay mEglDisplay; 3456b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3466b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferState represents the different states in which a buffer slot 3476b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // can be. 3486b091c53000c843211c218ce40287a7edca9bc63Daniel Lam enum BufferState { 3496b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // FREE indicates that the buffer is not currently being used and 3506b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // will not be used in the future until it gets dequeued and 3516b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // subsequently queued by the client. 352eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // aka "owned by BufferQueue, ready to be dequeued" 3536b091c53000c843211c218ce40287a7edca9bc63Daniel Lam FREE = 0, 3546b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3556b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // DEQUEUED indicates that the buffer has been dequeued by the 3566b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // client, but has not yet been queued or canceled. The buffer is 3576b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // considered 'owned' by the client, and the server should not use 3586b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // it for anything. 3596b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // 3606b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // Note that when in synchronous-mode (mSynchronousMode == true), 3616b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // the buffer that's currently attached to the texture may be 3626b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // dequeued by the client. That means that the current buffer can 3636b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // be in either the DEQUEUED or QUEUED state. In asynchronous mode, 3646b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // however, the current buffer is always in the QUEUED state. 365eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // aka "owned by producer, ready to be queued" 3666b091c53000c843211c218ce40287a7edca9bc63Daniel Lam DEQUEUED = 1, 3676b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3686b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // QUEUED indicates that the buffer has been queued by the client, 3696b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // and has not since been made available for the client to dequeue. 3706b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // Attaching the buffer to the texture does NOT transition the 3716b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // buffer away from the QUEUED state. However, in Synchronous mode 3726b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // the current buffer may be dequeued by the client under some 3736b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // circumstances. See the note about the current buffer in the 3746b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // documentation for DEQUEUED. 375eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // aka "owned by BufferQueue, ready to be acquired" 3766b091c53000c843211c218ce40287a7edca9bc63Daniel Lam QUEUED = 2, 377eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 378eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // aka "owned by consumer, ready to be released" 379eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam ACQUIRED = 3 3806b091c53000c843211c218ce40287a7edca9bc63Daniel Lam }; 3816b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3826b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mBufferState is the current state of this buffer slot. 3836b091c53000c843211c218ce40287a7edca9bc63Daniel Lam BufferState mBufferState; 3846b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3856b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mRequestBufferCalled is used for validating that the client did 3866b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // call requestBuffer() when told to do so. Technically this is not 3876b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // needed but useful for debugging and catching client bugs. 3886b091c53000c843211c218ce40287a7edca9bc63Daniel Lam bool mRequestBufferCalled; 3896b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 390851ef8f1bfbb164d61b1528a529a464f0a60dbafMathias Agopian // mCrop is the current crop rectangle for this buffer slot. 3916b091c53000c843211c218ce40287a7edca9bc63Daniel Lam Rect mCrop; 3926b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 393851ef8f1bfbb164d61b1528a529a464f0a60dbafMathias Agopian // mTransform is the current transform flags for this buffer slot. 3946b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t mTransform; 3956b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 396851ef8f1bfbb164d61b1528a529a464f0a60dbafMathias Agopian // mScalingMode is the current scaling mode for this buffer slot. 3976b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t mScalingMode; 3986b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3996b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mTimestamp is the current timestamp for this buffer slot. This gets 4006b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // to set by queueBuffer each time this slot is queued. 4016b091c53000c843211c218ce40287a7edca9bc63Daniel Lam int64_t mTimestamp; 4026b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4036b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mFrameNumber is the number of the queued frame for this slot. 4046b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint64_t mFrameNumber; 4056b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 406c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall // mEglFence is the EGL sync object that must signal before the buffer 4076b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // associated with this buffer slot may be dequeued. It is initialized 4086b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // to EGL_NO_SYNC_KHR when the buffer is created and (optionally, based 4096b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // on a compile-time option) set to a new sync object in updateTexImage. 410c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall EGLSyncKHR mEglFence; 411c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall 412c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall // mFence is a fence which will signal when work initiated by the 413c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall // previous owner of the buffer is finished. When the buffer is FREE, 414c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall // the fence indicates when the consumer has finished reading 415c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall // from the buffer, or when the producer has finished writing if it 416c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall // called cancelBuffer after queueing some writes. When the buffer is 417c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall // QUEUED, it indicates when the producer has finished filling the 418c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall // buffer. When the buffer is DEQUEUED or ACQUIRED, the fence has been 419c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall // passed to the consumer or producer along with ownership of the 420c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall // buffer, and mFence is empty. 421c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall sp<Fence> mFence; 422ef19414bd8b77a26f5751f3845be79025a8263feJesse Hall 423eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // Indicates whether this buffer has been seen by a consumer yet 424eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam bool mAcquireCalled; 4259abe1ebc9575dc5a19bf1dfce6e9b02e03374457Daniel Lam 4269abe1ebc9575dc5a19bf1dfce6e9b02e03374457Daniel Lam // Indicates whether this buffer needs to be cleaned up by consumer 4279abe1ebc9575dc5a19bf1dfce6e9b02e03374457Daniel Lam bool mNeedsCleanupOnRelease; 4286b091c53000c843211c218ce40287a7edca9bc63Daniel Lam }; 4296b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4306b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mSlots is the array of buffer slots that must be mirrored on the client 4316b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // side. This allows buffer ownership to be transferred between the client 4326b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // and server without sending a GraphicBuffer over binder. The entire array 4336b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // is initialized to NULL at construction time, and buffers are allocated 4346b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // for a slot when requestBuffer is called with that slot's index. 4356b091c53000c843211c218ce40287a7edca9bc63Daniel Lam BufferSlot mSlots[NUM_BUFFER_SLOTS]; 4366b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4376b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mDefaultWidth holds the default width of allocated buffers. It is used 4386b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // in requestBuffers() if a width and height of zero is specified. 4396b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t mDefaultWidth; 4406b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4416b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mDefaultHeight holds the default height of allocated buffers. It is used 4426b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // in requestBuffers() if a width and height of zero is specified. 4436b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t mDefaultHeight; 4446b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 445abe61bfda4938abd932465e27c29ba9e41aea606Daniel Lam // mMinUndequeuedBuffers is a constraint on the number of buffers 446abe61bfda4938abd932465e27c29ba9e41aea606Daniel Lam // not dequeued at any time 447abe61bfda4938abd932465e27c29ba9e41aea606Daniel Lam int mMinUndequeuedBuffers; 448abe61bfda4938abd932465e27c29ba9e41aea606Daniel Lam 44931a353da225af5329735451c761b430d82dfda1bJamie Gennis // mDefaultMaxBufferCount is the default limit on the number of buffers 45031a353da225af5329735451c761b430d82dfda1bJamie Gennis // that will be allocated at one time. This default limit is set by the 45131a353da225af5329735451c761b430d82dfda1bJamie Gennis // consumer. The limit (as opposed to the default limit) may be 45231a353da225af5329735451c761b430d82dfda1bJamie Gennis // overridden by the producer. 45331a353da225af5329735451c761b430d82dfda1bJamie Gennis int mDefaultMaxBufferCount; 45431a353da225af5329735451c761b430d82dfda1bJamie Gennis 45531a353da225af5329735451c761b430d82dfda1bJamie Gennis // mOverrideMaxBufferCount is the limit on the number of buffers that will 45631a353da225af5329735451c761b430d82dfda1bJamie Gennis // be allocated at one time. This value is set by the image producer by 45731a353da225af5329735451c761b430d82dfda1bJamie Gennis // calling setBufferCount. The default is zero, which means the producer 45831a353da225af5329735451c761b430d82dfda1bJamie Gennis // doesn't care about the number of buffers in the pool. In that case 45931a353da225af5329735451c761b430d82dfda1bJamie Gennis // mDefaultMaxBufferCount is used as the limit. 46031a353da225af5329735451c761b430d82dfda1bJamie Gennis int mOverrideMaxBufferCount; 4616b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4626b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mGraphicBufferAlloc is the connection to SurfaceFlinger that is used to 4636b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // allocate new GraphicBuffer objects. 4646b091c53000c843211c218ce40287a7edca9bc63Daniel Lam sp<IGraphicBufferAlloc> mGraphicBufferAlloc; 4656b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 466fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // mConsumerListener is used to notify the connected consumer of 467fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // asynchronous events that it may wish to react to. It is initially set 468fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // to NULL and is written by consumerConnect and consumerDisconnect. 469fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis sp<ConsumerListener> mConsumerListener; 4706b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4716b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mSynchronousMode whether we're in synchronous mode or not 4726b091c53000c843211c218ce40287a7edca9bc63Daniel Lam bool mSynchronousMode; 4736b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4746b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mAllowSynchronousMode whether we allow synchronous mode or not 4756b091c53000c843211c218ce40287a7edca9bc63Daniel Lam const bool mAllowSynchronousMode; 4766b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4776b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mConnectedApi indicates the API that is currently connected to this 4786b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue. It defaults to NO_CONNECTED_API (= 0), and gets updated 4796b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // by the connect and disconnect methods. 4806b091c53000c843211c218ce40287a7edca9bc63Daniel Lam int mConnectedApi; 4816b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4826b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mDequeueCondition condition used for dequeueBuffer in synchronous mode 4836b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mutable Condition mDequeueCondition; 4846b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4856b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mQueue is a FIFO of queued buffers used in synchronous mode 4866b091c53000c843211c218ce40287a7edca9bc63Daniel Lam typedef Vector<int> Fifo; 4876b091c53000c843211c218ce40287a7edca9bc63Daniel Lam Fifo mQueue; 4886b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4896b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mAbandoned indicates that the BufferQueue will no longer be used to 4906b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // consume images buffers pushed to it using the ISurfaceTexture interface. 4916b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // It is initialized to false, and set to true in the abandon method. A 4926b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue that has been abandoned will return the NO_INIT error from 4936b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // all ISurfaceTexture methods capable of returning an error. 4946b091c53000c843211c218ce40287a7edca9bc63Daniel Lam bool mAbandoned; 4956b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4966b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mName is a string used to identify the BufferQueue in log messages. 4976b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // It is set by the setName method. 498eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam String8 mConsumerName; 4996b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 5006b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mMutex is the mutex used to prevent concurrent access to the member 5016b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // variables of BufferQueue objects. It must be locked whenever the 5026b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // member variables are accessed. 5036b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mutable Mutex mMutex; 5046b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 5056b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mFrameCounter is the free running counter, incremented for every buffer queued 5066b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // with the surface Texture. 5076b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint64_t mFrameCounter; 508eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 509b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // mBufferHasBeenQueued is true once a buffer has been queued. It is reset 510b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // by changing the buffer count. 511eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam bool mBufferHasBeenQueued; 512b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam 513b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // mDefaultBufferFormat can be set so it will override 514b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // the buffer format when it isn't specified in dequeueBuffer 515b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam uint32_t mDefaultBufferFormat; 516b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam 517b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // mConsumerUsageBits contains flags the consumer wants for GraphicBuffers 518b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam uint32_t mConsumerUsageBits; 519b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam 520b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // mTransformHint is used to optimize for screen rotations 521b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam uint32_t mTransformHint; 5226b091c53000c843211c218ce40287a7edca9bc63Daniel Lam}; 5236b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 5246b091c53000c843211c218ce40287a7edca9bc63Daniel Lam// ---------------------------------------------------------------------------- 5256b091c53000c843211c218ce40287a7edca9bc63Daniel Lam}; // namespace android 5266b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 5276b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#endif // ANDROID_GUI_BUFFERQUEUE_H 528