BufferQueue.h revision 72f096fb1ad0a0deadbfac5f88627461905d38e8
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 9572f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis // BufferQueue manages a pool of gralloc memory slots to be used by 9672f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis // producers and consumers. allowSynchronousMode specifies whether or not 9772f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis // synchronous mode can be enabled by the producer. allocator is used to 9872f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis // allocate all the needed gralloc buffers. 993e87601170141229d661df93e2f59e1ced73474bMathias Agopian BufferQueue(bool allowSynchronousMode = true, 1003e87601170141229d661df93e2f59e1ced73474bMathias Agopian const sp<IGraphicBufferAlloc>& allocator = NULL); 1016b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual ~BufferQueue(); 1026b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 103b856052c00dfef70d0957482c72c2979ffc4733aDaniel Lam virtual int query(int what, int* value); 104b856052c00dfef70d0957482c72c2979ffc4733aDaniel Lam 1056b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // setBufferCount updates the number of available buffer slots. After 1066b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // calling this all buffer slots are both unallocated and owned by the 1076b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue object (i.e. they are not owned by the client). 1086b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t setBufferCount(int bufferCount); 1096b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1106b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t requestBuffer(int slot, sp<GraphicBuffer>* buf); 1116b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1126b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // dequeueBuffer gets the next buffer slot index for the client to use. If a 1136b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // buffer slot is available then that slot index is written to the location 1146b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // pointed to by the buf argument and a status of OK is returned. If no 1156b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // slot is available then a status of -EBUSY is returned and buf is 1166b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // unmodified. 117f78575400977f644cf0b12beb2fa5fc278b6ed4cJesse Hall // 118f78575400977f644cf0b12beb2fa5fc278b6ed4cJesse Hall // The fence parameter will be updated to hold the fence associated with 119f78575400977f644cf0b12beb2fa5fc278b6ed4cJesse Hall // the buffer. The contents of the buffer must not be overwritten until the 120f78575400977f644cf0b12beb2fa5fc278b6ed4cJesse Hall // fence signals. If the fence is NULL, the buffer may be written 121f78575400977f644cf0b12beb2fa5fc278b6ed4cJesse Hall // immediately. 122f78575400977f644cf0b12beb2fa5fc278b6ed4cJesse Hall // 1236b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // The width and height parameters must be no greater than the minimum of 1246b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // GL_MAX_VIEWPORT_DIMS and GL_MAX_TEXTURE_SIZE (see: glGetIntegerv). 1256b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // An error due to invalid dimensions might not be reported until 1266b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // updateTexImage() is called. 127f78575400977f644cf0b12beb2fa5fc278b6ed4cJesse Hall virtual status_t dequeueBuffer(int *buf, sp<Fence>& fence, 128f78575400977f644cf0b12beb2fa5fc278b6ed4cJesse Hall uint32_t width, uint32_t height, uint32_t format, uint32_t usage); 1296b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1306b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // queueBuffer returns a filled buffer to the BufferQueue. In addition, a 1316b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // timestamp must be provided for the buffer. The timestamp is in 1326b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // nanoseconds, and must be monotonically increasing. Its other semantics 1336b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // (zero point, etc) are client-dependent and should be documented by the 1346b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // client. 135f0bc2f1d8d37977bd3aef3d3326a70e9e69d4246Mathias Agopian virtual status_t queueBuffer(int buf, 136f0bc2f1d8d37977bd3aef3d3326a70e9e69d4246Mathias Agopian const QueueBufferInput& input, QueueBufferOutput* output); 137f0bc2f1d8d37977bd3aef3d3326a70e9e69d4246Mathias Agopian 138c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall virtual void cancelBuffer(int buf, sp<Fence> fence); 1396b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1406b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // setSynchronousMode set whether dequeueBuffer is synchronous or 1416b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // asynchronous. In synchronous mode, dequeueBuffer blocks until 1426b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // a buffer is available, the currently bound buffer can be dequeued and 1436b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // queued buffers will be retired in order. 1446b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // The default mode is asynchronous. 1456b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t setSynchronousMode(bool enabled); 1466b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1476b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // connect attempts to connect a producer client API to the BufferQueue. 1486b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // This must be called before any other ISurfaceTexture methods are called 1496b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // except for getAllocator. 1506b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // 1516b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // This method will fail if the connect was previously called on the 1526b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue and no corresponding disconnect call was made. 15324202f5676c32edeef6544cf36e06b9fc970dbdeMathias Agopian virtual status_t connect(int api, QueueBufferOutput* output); 1546b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1556b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // disconnect attempts to disconnect a producer client API from the 1566b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue. Calling this method will cause any subsequent calls to other 1576b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // ISurfaceTexture methods to fail except for getAllocator and connect. 1586b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // Successfully calling connect after this will allow the other methods to 1596b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // succeed again. 1606b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // 1616b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // This method will fail if the the BufferQueue is not currently 1626b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // connected to the specified client API. 1636b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t disconnect(int api); 1646b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 165eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // dump our state in a String 166eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam virtual void dump(String8& result) const; 167eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam virtual void dump(String8& result, const char* prefix, char* buffer, size_t SIZE) const; 168eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 169eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // public facing structure for BufferSlot 170eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam struct BufferItem { 171eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 172eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam BufferItem() 173eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam : 174eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam mTransform(0), 175eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam mScalingMode(NATIVE_WINDOW_SCALING_MODE_FREEZE), 176eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam mTimestamp(0), 177eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam mFrameNumber(0), 178eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam mBuf(INVALID_BUFFER_SLOT) { 179eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam mCrop.makeInvalid(); 180eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam } 181eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // mGraphicBuffer points to the buffer allocated for this slot or is NULL 182eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // if no buffer has been allocated. 183eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam sp<GraphicBuffer> mGraphicBuffer; 184eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 185851ef8f1bfbb164d61b1528a529a464f0a60dbafMathias Agopian // mCrop is the current crop rectangle for this buffer slot. 186eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam Rect mCrop; 187eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 188851ef8f1bfbb164d61b1528a529a464f0a60dbafMathias Agopian // mTransform is the current transform flags for this buffer slot. 189eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam uint32_t mTransform; 190eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 191851ef8f1bfbb164d61b1528a529a464f0a60dbafMathias Agopian // mScalingMode is the current scaling mode for this buffer slot. 192eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam uint32_t mScalingMode; 193eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 194eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // mTimestamp is the current timestamp for this buffer slot. This gets 195eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // to set by queueBuffer each time this slot is queued. 196eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam int64_t mTimestamp; 1976b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 198eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // mFrameNumber is the number of the queued frame for this slot. 199eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam uint64_t mFrameNumber; 200eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 201efc7ab6dcea8c22ddd7c0259ef4ab4bbf1e93044Jamie Gennis // mBuf is the slot index of this buffer 202eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam int mBuf; 203b42b1ac1587aebda5e2f334d95b620271fafba4eJesse Hall 204b42b1ac1587aebda5e2f334d95b620271fafba4eJesse Hall // mFence is a fence that will signal when the buffer is idle. 205b42b1ac1587aebda5e2f334d95b620271fafba4eJesse Hall sp<Fence> mFence; 206eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam }; 207eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 208eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // The following public functions is the consumer facing interface 209eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 210fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // acquireBuffer attempts to acquire ownership of the next pending buffer in 211fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // the BufferQueue. If no buffer is pending then it returns -EINVAL. If a 212fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // buffer is successfully acquired, the information about the buffer is 213fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // returned in BufferItem. If the buffer returned had previously been 214fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // acquired then the BufferItem::mGraphicBuffer field of buffer is set to 215fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // NULL and it is assumed that the consumer still holds a reference to the 216fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // buffer. 217fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis status_t acquireBuffer(BufferItem *buffer); 218eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 219eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // releaseBuffer releases a buffer slot from the consumer back to the 220eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // BufferQueue pending a fence sync. 221fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // 222e41b318bc4708e1dee9364e73215ff0d51fb76a1Eino-Ville Talvala // If releaseBuffer returns STALE_BUFFER_SLOT, then the consumer must free 223e41b318bc4708e1dee9364e73215ff0d51fb76a1Eino-Ville Talvala // any references to the just-released buffer that it might have, as if it 224e41b318bc4708e1dee9364e73215ff0d51fb76a1Eino-Ville Talvala // had received a onBuffersReleased() call with a mask set for the released 225e41b318bc4708e1dee9364e73215ff0d51fb76a1Eino-Ville Talvala // buffer. 226e41b318bc4708e1dee9364e73215ff0d51fb76a1Eino-Ville Talvala // 227fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // Note that the dependencies on EGL will be removed once we switch to using 228fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // the Android HW Sync HAL. 229ef19414bd8b77a26f5751f3845be79025a8263feJesse Hall status_t releaseBuffer(int buf, EGLDisplay display, EGLSyncKHR fence, 230f78575400977f644cf0b12beb2fa5fc278b6ed4cJesse Hall const sp<Fence>& releaseFence); 231eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 232fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // consumerConnect connects a consumer to the BufferQueue. Only one 233fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // consumer may be connected, and when that consumer disconnects the 234fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // BufferQueue is placed into the "abandoned" state, causing most 235fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // interactions with the BufferQueue by the producer to fail. 236fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis status_t consumerConnect(const sp<ConsumerListener>& consumer); 237fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 238eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // consumerDisconnect disconnects a consumer from the BufferQueue. All 239fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // buffers will be freed and the BufferQueue is placed in the "abandoned" 240fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // state, causing most interactions with the BufferQueue by the producer to 241fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // fail. 242eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam status_t consumerDisconnect(); 243eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 244fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // getReleasedBuffers sets the value pointed to by slotMask to a bit mask 245fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // indicating which buffer slots the have been released by the BufferQueue 246fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // but have not yet been released by the consumer. 247fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis status_t getReleasedBuffers(uint32_t* slotMask); 248fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis 249eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // setDefaultBufferSize is used to set the size of buffers returned by 250eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // requestBuffers when a with and height of zero is requested. 251eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam status_t setDefaultBufferSize(uint32_t w, uint32_t h); 252eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 25331a353da225af5329735451c761b430d82dfda1bJamie Gennis // setDefaultBufferCount set the buffer count. If the client has requested 254eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // a buffer count using setBufferCount, the server-buffer count will 255eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // take effect once the client sets the count back to zero. 25631a353da225af5329735451c761b430d82dfda1bJamie Gennis status_t setDefaultMaxBufferCount(int bufferCount); 257eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 25872f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis // setMaxAcquiredBufferCount sets the maximum number of buffers that can 25972f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis // be acquired by the consumer at one time. This call will fail if a 26072f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis // producer is connected to the BufferQueue. 26172f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis status_t setMaxAcquiredBufferCount(int maxAcquiredBuffers); 26272f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis 263eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // isSynchronousMode returns whether the SurfaceTexture is currently in 264eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // synchronous mode. 265eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam bool isSynchronousMode() const; 266eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 267eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // setConsumerName sets the name used in logging 268eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam void setConsumerName(const String8& name); 269eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 270b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // setDefaultBufferFormat allows the BufferQueue to create 271b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // GraphicBuffers of a defaultFormat if no format is specified 272b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // in dequeueBuffer 273b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam status_t setDefaultBufferFormat(uint32_t defaultFormat); 274b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam 275b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // setConsumerUsageBits will turn on additional usage bits for dequeueBuffer 276b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam status_t setConsumerUsageBits(uint32_t usage); 277b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam 278b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // setTransformHint bakes in rotation to buffers so overlays can be used 279b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam status_t setTransformHint(uint32_t hint); 280eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 281eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lamprivate: 2826b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // freeBufferLocked frees the resources (both GraphicBuffer and EGLImage) 2836b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // for the given slot. 2846b091c53000c843211c218ce40287a7edca9bc63Daniel Lam void freeBufferLocked(int index); 2856b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2866b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // freeAllBuffersLocked frees the resources (both GraphicBuffer and 2876b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // EGLImage) for all slots. 2886b091c53000c843211c218ce40287a7edca9bc63Daniel Lam void freeAllBuffersLocked(); 2896b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2906b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // freeAllBuffersExceptHeadLocked frees the resources (both GraphicBuffer 2916b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // and EGLImage) for all slots except the head of mQueue 2926b091c53000c843211c218ce40287a7edca9bc63Daniel Lam void freeAllBuffersExceptHeadLocked(); 2936b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2946b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // drainQueueLocked drains the buffer queue if we're in synchronous mode 2956b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // returns immediately otherwise. It returns NO_INIT if the BufferQueue 2966b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // became abandoned or disconnected during this call. 2976b091c53000c843211c218ce40287a7edca9bc63Daniel Lam status_t drainQueueLocked(); 2986b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2996b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // drainQueueAndFreeBuffersLocked drains the buffer queue if we're in 3006b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // synchronous mode and free all buffers. In asynchronous mode, all buffers 3016b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // are freed except the current buffer. 3026b091c53000c843211c218ce40287a7edca9bc63Daniel Lam status_t drainQueueAndFreeBuffersLocked(); 3036b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 30431a353da225af5329735451c761b430d82dfda1bJamie Gennis // setDefaultMaxBufferCountLocked sets the maximum number of buffer slots 30531a353da225af5329735451c761b430d82dfda1bJamie Gennis // that will be used if the producer does not override the buffer slot 30631a353da225af5329735451c761b430d82dfda1bJamie Gennis // count. 30731a353da225af5329735451c761b430d82dfda1bJamie Gennis status_t setDefaultMaxBufferCountLocked(int count); 30831a353da225af5329735451c761b430d82dfda1bJamie Gennis 30931a353da225af5329735451c761b430d82dfda1bJamie Gennis // getMinBufferCountLocked returns the minimum number of buffers allowed 31031a353da225af5329735451c761b430d82dfda1bJamie Gennis // given the current BufferQueue state. 31131a353da225af5329735451c761b430d82dfda1bJamie Gennis int getMinMaxBufferCountLocked() const; 3126b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 31372f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis // getMinUndequeuedBufferCountLocked returns the minimum number of buffers 31472f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis // that must remain in a state other than DEQUEUED. 31572f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis int getMinUndequeuedBufferCountLocked() const; 31672f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis 317e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis // getMaxBufferCountLocked returns the maximum number of buffers that can 318e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis // be allocated at once. This value depends upon the following member 319e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis // variables: 320e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis // 321e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis // mSynchronousMode 32272f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis // mMaxAcquiredBufferCount 323e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis // mDefaultMaxBufferCount 324e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis // mOverrideMaxBufferCount 325e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis // 326e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis // Any time one of these member variables is changed while a producer is 327e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis // connected, mDequeueCondition must be broadcast. 328e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis int getMaxBufferCountLocked() const; 329e191e6c34829aec406a9cfe3e95211f884a311ffJamie Gennis 3306b091c53000c843211c218ce40287a7edca9bc63Daniel Lam struct BufferSlot { 3316b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3326b091c53000c843211c218ce40287a7edca9bc63Daniel Lam BufferSlot() 333eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam : mEglDisplay(EGL_NO_DISPLAY), 3346b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mBufferState(BufferSlot::FREE), 3356b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mRequestBufferCalled(false), 3366b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mTransform(0), 3376b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mScalingMode(NATIVE_WINDOW_SCALING_MODE_FREEZE), 3386b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mTimestamp(0), 3396b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mFrameNumber(0), 340c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall mEglFence(EGL_NO_SYNC_KHR), 3419abe1ebc9575dc5a19bf1dfce6e9b02e03374457Daniel Lam mAcquireCalled(false), 3429abe1ebc9575dc5a19bf1dfce6e9b02e03374457Daniel Lam mNeedsCleanupOnRelease(false) { 3436b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mCrop.makeInvalid(); 3446b091c53000c843211c218ce40287a7edca9bc63Daniel Lam } 3456b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3466b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mGraphicBuffer points to the buffer allocated for this slot or is NULL 3476b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // if no buffer has been allocated. 3486b091c53000c843211c218ce40287a7edca9bc63Daniel Lam sp<GraphicBuffer> mGraphicBuffer; 3496b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3506b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mEglDisplay is the EGLDisplay used to create mEglImage. 3516b091c53000c843211c218ce40287a7edca9bc63Daniel Lam EGLDisplay mEglDisplay; 3526b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3536b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferState represents the different states in which a buffer slot 3546b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // can be. 3556b091c53000c843211c218ce40287a7edca9bc63Daniel Lam enum BufferState { 3566b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // FREE indicates that the buffer is not currently being used and 3576b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // will not be used in the future until it gets dequeued and 3586b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // subsequently queued by the client. 359eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // aka "owned by BufferQueue, ready to be dequeued" 3606b091c53000c843211c218ce40287a7edca9bc63Daniel Lam FREE = 0, 3616b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3626b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // DEQUEUED indicates that the buffer has been dequeued by the 3636b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // client, but has not yet been queued or canceled. The buffer is 3646b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // considered 'owned' by the client, and the server should not use 3656b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // it for anything. 3666b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // 3676b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // Note that when in synchronous-mode (mSynchronousMode == true), 3686b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // the buffer that's currently attached to the texture may be 3696b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // dequeued by the client. That means that the current buffer can 3706b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // be in either the DEQUEUED or QUEUED state. In asynchronous mode, 3716b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // however, the current buffer is always in the QUEUED state. 372eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // aka "owned by producer, ready to be queued" 3736b091c53000c843211c218ce40287a7edca9bc63Daniel Lam DEQUEUED = 1, 3746b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3756b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // QUEUED indicates that the buffer has been queued by the client, 3766b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // and has not since been made available for the client to dequeue. 3776b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // Attaching the buffer to the texture does NOT transition the 3786b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // buffer away from the QUEUED state. However, in Synchronous mode 3796b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // the current buffer may be dequeued by the client under some 3806b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // circumstances. See the note about the current buffer in the 3816b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // documentation for DEQUEUED. 382eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // aka "owned by BufferQueue, ready to be acquired" 3836b091c53000c843211c218ce40287a7edca9bc63Daniel Lam QUEUED = 2, 384eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 385eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // aka "owned by consumer, ready to be released" 386eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam ACQUIRED = 3 3876b091c53000c843211c218ce40287a7edca9bc63Daniel Lam }; 3886b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3896b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mBufferState is the current state of this buffer slot. 3906b091c53000c843211c218ce40287a7edca9bc63Daniel Lam BufferState mBufferState; 3916b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3926b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mRequestBufferCalled is used for validating that the client did 3936b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // call requestBuffer() when told to do so. Technically this is not 3946b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // needed but useful for debugging and catching client bugs. 3956b091c53000c843211c218ce40287a7edca9bc63Daniel Lam bool mRequestBufferCalled; 3966b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 397851ef8f1bfbb164d61b1528a529a464f0a60dbafMathias Agopian // mCrop is the current crop rectangle for this buffer slot. 3986b091c53000c843211c218ce40287a7edca9bc63Daniel Lam Rect mCrop; 3996b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 400851ef8f1bfbb164d61b1528a529a464f0a60dbafMathias Agopian // mTransform is the current transform flags for this buffer slot. 4016b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t mTransform; 4026b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 403851ef8f1bfbb164d61b1528a529a464f0a60dbafMathias Agopian // mScalingMode is the current scaling mode for this buffer slot. 4046b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t mScalingMode; 4056b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4066b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mTimestamp is the current timestamp for this buffer slot. This gets 4076b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // to set by queueBuffer each time this slot is queued. 4086b091c53000c843211c218ce40287a7edca9bc63Daniel Lam int64_t mTimestamp; 4096b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4106b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mFrameNumber is the number of the queued frame for this slot. 4116b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint64_t mFrameNumber; 4126b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 413c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall // mEglFence is the EGL sync object that must signal before the buffer 4146b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // associated with this buffer slot may be dequeued. It is initialized 4156b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // to EGL_NO_SYNC_KHR when the buffer is created and (optionally, based 4166b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // on a compile-time option) set to a new sync object in updateTexImage. 417c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall EGLSyncKHR mEglFence; 418c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall 419c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall // mFence is a fence which will signal when work initiated by the 420c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall // previous owner of the buffer is finished. When the buffer is FREE, 421c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall // the fence indicates when the consumer has finished reading 422c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall // from the buffer, or when the producer has finished writing if it 423c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall // called cancelBuffer after queueing some writes. When the buffer is 424c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall // QUEUED, it indicates when the producer has finished filling the 425c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall // buffer. When the buffer is DEQUEUED or ACQUIRED, the fence has been 426c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall // passed to the consumer or producer along with ownership of the 427c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall // buffer, and mFence is empty. 428c777b0b3b9b0ea5d8e378fccde6935765e28e329Jesse Hall sp<Fence> mFence; 429ef19414bd8b77a26f5751f3845be79025a8263feJesse Hall 430eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam // Indicates whether this buffer has been seen by a consumer yet 431eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam bool mAcquireCalled; 4329abe1ebc9575dc5a19bf1dfce6e9b02e03374457Daniel Lam 4339abe1ebc9575dc5a19bf1dfce6e9b02e03374457Daniel Lam // Indicates whether this buffer needs to be cleaned up by consumer 4349abe1ebc9575dc5a19bf1dfce6e9b02e03374457Daniel Lam bool mNeedsCleanupOnRelease; 4356b091c53000c843211c218ce40287a7edca9bc63Daniel Lam }; 4366b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4376b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mSlots is the array of buffer slots that must be mirrored on the client 4386b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // side. This allows buffer ownership to be transferred between the client 4396b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // and server without sending a GraphicBuffer over binder. The entire array 4406b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // is initialized to NULL at construction time, and buffers are allocated 4416b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // for a slot when requestBuffer is called with that slot's index. 4426b091c53000c843211c218ce40287a7edca9bc63Daniel Lam BufferSlot mSlots[NUM_BUFFER_SLOTS]; 4436b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4446b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mDefaultWidth holds the default width of allocated buffers. It is used 4456b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // in requestBuffers() if a width and height of zero is specified. 4466b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t mDefaultWidth; 4476b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4486b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mDefaultHeight holds the default height of allocated buffers. It is used 4496b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // in requestBuffers() if a width and height of zero is specified. 4506b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t mDefaultHeight; 4516b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 45272f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis // mMaxAcquiredBufferCount is the number of buffers that the consumer may 45372f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis // acquire at one time. It defaults to 1 and can be changed by the 45472f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis // consumer via the setMaxAcquiredBufferCount method, but this may only be 45572f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis // done when no producer is connected to the BufferQueue. 45672f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis // 45772f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis // This value is used to derive the value returned for the 45872f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis // MIN_UNDEQUEUED_BUFFERS query by the producer. 45972f096fb1ad0a0deadbfac5f88627461905d38e8Jamie Gennis int mMaxAcquiredBufferCount; 460abe61bfda4938abd932465e27c29ba9e41aea606Daniel Lam 46131a353da225af5329735451c761b430d82dfda1bJamie Gennis // mDefaultMaxBufferCount is the default limit on the number of buffers 46231a353da225af5329735451c761b430d82dfda1bJamie Gennis // that will be allocated at one time. This default limit is set by the 46331a353da225af5329735451c761b430d82dfda1bJamie Gennis // consumer. The limit (as opposed to the default limit) may be 46431a353da225af5329735451c761b430d82dfda1bJamie Gennis // overridden by the producer. 46531a353da225af5329735451c761b430d82dfda1bJamie Gennis int mDefaultMaxBufferCount; 46631a353da225af5329735451c761b430d82dfda1bJamie Gennis 46731a353da225af5329735451c761b430d82dfda1bJamie Gennis // mOverrideMaxBufferCount is the limit on the number of buffers that will 46831a353da225af5329735451c761b430d82dfda1bJamie Gennis // be allocated at one time. This value is set by the image producer by 46931a353da225af5329735451c761b430d82dfda1bJamie Gennis // calling setBufferCount. The default is zero, which means the producer 47031a353da225af5329735451c761b430d82dfda1bJamie Gennis // doesn't care about the number of buffers in the pool. In that case 47131a353da225af5329735451c761b430d82dfda1bJamie Gennis // mDefaultMaxBufferCount is used as the limit. 47231a353da225af5329735451c761b430d82dfda1bJamie Gennis int mOverrideMaxBufferCount; 4736b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4746b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mGraphicBufferAlloc is the connection to SurfaceFlinger that is used to 4756b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // allocate new GraphicBuffer objects. 4766b091c53000c843211c218ce40287a7edca9bc63Daniel Lam sp<IGraphicBufferAlloc> mGraphicBufferAlloc; 4776b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 478fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // mConsumerListener is used to notify the connected consumer of 479fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // asynchronous events that it may wish to react to. It is initially set 480fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis // to NULL and is written by consumerConnect and consumerDisconnect. 481fa5b40ebb8923133df12dc70591bfe35b3f1c9b3Jamie Gennis sp<ConsumerListener> mConsumerListener; 4826b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4836b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mSynchronousMode whether we're in synchronous mode or not 4846b091c53000c843211c218ce40287a7edca9bc63Daniel Lam bool mSynchronousMode; 4856b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4866b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mAllowSynchronousMode whether we allow synchronous mode or not 4876b091c53000c843211c218ce40287a7edca9bc63Daniel Lam const bool mAllowSynchronousMode; 4886b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4896b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mConnectedApi indicates the API that is currently connected to this 4906b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue. It defaults to NO_CONNECTED_API (= 0), and gets updated 4916b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // by the connect and disconnect methods. 4926b091c53000c843211c218ce40287a7edca9bc63Daniel Lam int mConnectedApi; 4936b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4946b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mDequeueCondition condition used for dequeueBuffer in synchronous mode 4956b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mutable Condition mDequeueCondition; 4966b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 4976b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mQueue is a FIFO of queued buffers used in synchronous mode 4986b091c53000c843211c218ce40287a7edca9bc63Daniel Lam typedef Vector<int> Fifo; 4996b091c53000c843211c218ce40287a7edca9bc63Daniel Lam Fifo mQueue; 5006b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 5016b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mAbandoned indicates that the BufferQueue will no longer be used to 5026b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // consume images buffers pushed to it using the ISurfaceTexture interface. 5036b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // It is initialized to false, and set to true in the abandon method. A 5046b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue that has been abandoned will return the NO_INIT error from 5056b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // all ISurfaceTexture methods capable of returning an error. 5066b091c53000c843211c218ce40287a7edca9bc63Daniel Lam bool mAbandoned; 5076b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 5086b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mName is a string used to identify the BufferQueue in log messages. 5096b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // It is set by the setName method. 510eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam String8 mConsumerName; 5116b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 5126b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mMutex is the mutex used to prevent concurrent access to the member 5136b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // variables of BufferQueue objects. It must be locked whenever the 5146b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // member variables are accessed. 5156b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mutable Mutex mMutex; 5166b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 5176b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mFrameCounter is the free running counter, incremented for every buffer queued 5186b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // with the surface Texture. 5196b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint64_t mFrameCounter; 520eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam 521b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // mBufferHasBeenQueued is true once a buffer has been queued. It is reset 522b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // by changing the buffer count. 523eae59d2ea77ef57aab203fb185a880ce37ac38d6Daniel Lam bool mBufferHasBeenQueued; 524b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam 525b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // mDefaultBufferFormat can be set so it will override 526b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // the buffer format when it isn't specified in dequeueBuffer 527b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam uint32_t mDefaultBufferFormat; 528b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam 529b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // mConsumerUsageBits contains flags the consumer wants for GraphicBuffers 530b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam uint32_t mConsumerUsageBits; 531b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam 532b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // mTransformHint is used to optimize for screen rotations 533b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam uint32_t mTransformHint; 5346b091c53000c843211c218ce40287a7edca9bc63Daniel Lam}; 5356b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 5366b091c53000c843211c218ce40287a7edca9bc63Daniel Lam// ---------------------------------------------------------------------------- 5376b091c53000c843211c218ce40287a7edca9bc63Daniel Lam}; // namespace android 5386b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 5396b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#endif // ANDROID_GUI_BUFFERQUEUE_H 540