BufferQueue.h revision b856052c00dfef70d0957482c72c2979ffc4733a
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> 216b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 226b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#include <gui/ISurfaceTexture.h> 236b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 246b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#include <surfaceflinger/IGraphicBufferAlloc.h> 256b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#include <ui/GraphicBuffer.h> 266b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 276b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#include <utils/String8.h> 286b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#include <utils/Vector.h> 296b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#include <utils/threads.h> 306b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 316b091c53000c843211c218ce40287a7edca9bc63Daniel Lamnamespace android { 326b091c53000c843211c218ce40287a7edca9bc63Daniel Lam// ---------------------------------------------------------------------------- 336b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 346b091c53000c843211c218ce40287a7edca9bc63Daniel Lamclass BufferQueue : public BnSurfaceTexture { 356b091c53000c843211c218ce40287a7edca9bc63Daniel Lampublic: 366b091c53000c843211c218ce40287a7edca9bc63Daniel Lam enum { MIN_UNDEQUEUED_BUFFERS = 2 }; 376b091c53000c843211c218ce40287a7edca9bc63Daniel Lam enum { 386b091c53000c843211c218ce40287a7edca9bc63Daniel Lam MIN_ASYNC_BUFFER_SLOTS = MIN_UNDEQUEUED_BUFFERS + 1, 396b091c53000c843211c218ce40287a7edca9bc63Daniel Lam MIN_SYNC_BUFFER_SLOTS = MIN_UNDEQUEUED_BUFFERS 406b091c53000c843211c218ce40287a7edca9bc63Daniel Lam }; 416b091c53000c843211c218ce40287a7edca9bc63Daniel Lam enum { NUM_BUFFER_SLOTS = 32 }; 426b091c53000c843211c218ce40287a7edca9bc63Daniel Lam enum { NO_CONNECTED_API = 0 }; 436b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 446b091c53000c843211c218ce40287a7edca9bc63Daniel Lam struct FrameAvailableListener : public virtual RefBase { 456b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // onFrameAvailable() is called from queueBuffer() each time an 466b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // additional frame becomes available for consumption. This means that 476b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // frames that are queued while in asynchronous mode only trigger the 486b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // callback if no previous frames are pending. Frames queued while in 496b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // synchronous mode always trigger the callback. 506b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // 516b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // This is called without any lock held and can be called concurrently 526b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // by multiple threads. 536b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual void onFrameAvailable() = 0; 546b091c53000c843211c218ce40287a7edca9bc63Daniel Lam }; 556b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 566b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue manages a pool of gralloc memory slots to be used 576b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // by producers and consumers. 586b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // allowSynchronousMode specifies whether or not synchronous mode can be 596b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // enabled. 606b091c53000c843211c218ce40287a7edca9bc63Daniel Lam BufferQueue(bool allowSynchronousMode = true); 616b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual ~BufferQueue(); 626b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 63b856052c00dfef70d0957482c72c2979ffc4733aDaniel Lam virtual int query(int what, int* value); 64b856052c00dfef70d0957482c72c2979ffc4733aDaniel Lam 656b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // setBufferCount updates the number of available buffer slots. After 666b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // calling this all buffer slots are both unallocated and owned by the 676b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue object (i.e. they are not owned by the client). 686b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t setBufferCount(int bufferCount); 696b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 706b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t requestBuffer(int slot, sp<GraphicBuffer>* buf); 716b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 726b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // dequeueBuffer gets the next buffer slot index for the client to use. If a 736b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // buffer slot is available then that slot index is written to the location 746b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // pointed to by the buf argument and a status of OK is returned. If no 756b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // slot is available then a status of -EBUSY is returned and buf is 766b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // unmodified. 776b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // The width and height parameters must be no greater than the minimum of 786b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // GL_MAX_VIEWPORT_DIMS and GL_MAX_TEXTURE_SIZE (see: glGetIntegerv). 796b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // An error due to invalid dimensions might not be reported until 806b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // updateTexImage() is called. 816b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t dequeueBuffer(int *buf, uint32_t width, uint32_t height, 826b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t format, uint32_t usage); 836b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 846b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // queueBuffer returns a filled buffer to the BufferQueue. In addition, a 856b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // timestamp must be provided for the buffer. The timestamp is in 866b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // nanoseconds, and must be monotonically increasing. Its other semantics 876b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // (zero point, etc) are client-dependent and should be documented by the 886b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // client. 896b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t queueBuffer(int buf, int64_t timestamp, 906b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t* outWidth, uint32_t* outHeight, uint32_t* outTransform); 916b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual void cancelBuffer(int buf); 926b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t setCrop(const Rect& reg); 936b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t setTransform(uint32_t transform); 946b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t setScalingMode(int mode); 956b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 966b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // setSynchronousMode set whether dequeueBuffer is synchronous or 976b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // asynchronous. In synchronous mode, dequeueBuffer blocks until 986b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // a buffer is available, the currently bound buffer can be dequeued and 996b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // queued buffers will be retired in order. 1006b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // The default mode is asynchronous. 1016b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t setSynchronousMode(bool enabled); 1026b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1036b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // connect attempts to connect a producer client API to the BufferQueue. 1046b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // This must be called before any other ISurfaceTexture methods are called 1056b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // except for getAllocator. 1066b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // 1076b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // This method will fail if the connect was previously called on the 1086b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue and no corresponding disconnect call was made. 1096b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t connect(int api, 1106b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t* outWidth, uint32_t* outHeight, uint32_t* outTransform); 1116b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1126b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // disconnect attempts to disconnect a producer client API from the 1136b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue. Calling this method will cause any subsequent calls to other 1146b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // ISurfaceTexture methods to fail except for getAllocator and connect. 1156b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // Successfully calling connect after this will allow the other methods to 1166b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // succeed again. 1176b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // 1186b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // This method will fail if the the BufferQueue is not currently 1196b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // connected to the specified client API. 1206b091c53000c843211c218ce40287a7edca9bc63Daniel Lam virtual status_t disconnect(int api); 1216b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1226b091c53000c843211c218ce40287a7edca9bc63Daniel Lamprotected: 1236b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1246b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // freeBufferLocked frees the resources (both GraphicBuffer and EGLImage) 1256b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // for the given slot. 1266b091c53000c843211c218ce40287a7edca9bc63Daniel Lam void freeBufferLocked(int index); 1276b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1286b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // freeAllBuffersLocked frees the resources (both GraphicBuffer and 1296b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // EGLImage) for all slots. 1306b091c53000c843211c218ce40287a7edca9bc63Daniel Lam void freeAllBuffersLocked(); 1316b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1326b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // freeAllBuffersExceptHeadLocked frees the resources (both GraphicBuffer 1336b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // and EGLImage) for all slots except the head of mQueue 1346b091c53000c843211c218ce40287a7edca9bc63Daniel Lam void freeAllBuffersExceptHeadLocked(); 1356b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1366b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // drainQueueLocked drains the buffer queue if we're in synchronous mode 1376b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // returns immediately otherwise. It returns NO_INIT if the BufferQueue 1386b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // became abandoned or disconnected during this call. 1396b091c53000c843211c218ce40287a7edca9bc63Daniel Lam status_t drainQueueLocked(); 1406b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1416b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // drainQueueAndFreeBuffersLocked drains the buffer queue if we're in 1426b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // synchronous mode and free all buffers. In asynchronous mode, all buffers 1436b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // are freed except the current buffer. 1446b091c53000c843211c218ce40287a7edca9bc63Daniel Lam status_t drainQueueAndFreeBuffersLocked(); 1456b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1466b091c53000c843211c218ce40287a7edca9bc63Daniel Lam status_t setBufferCountServerLocked(int bufferCount); 1476b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1486b091c53000c843211c218ce40287a7edca9bc63Daniel Lam enum { INVALID_BUFFER_SLOT = -1 }; 1496b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1506b091c53000c843211c218ce40287a7edca9bc63Daniel Lam struct BufferSlot { 1516b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1526b091c53000c843211c218ce40287a7edca9bc63Daniel Lam BufferSlot() 1536b091c53000c843211c218ce40287a7edca9bc63Daniel Lam : mEglImage(EGL_NO_IMAGE_KHR), 1546b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mEglDisplay(EGL_NO_DISPLAY), 1556b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mBufferState(BufferSlot::FREE), 1566b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mRequestBufferCalled(false), 1576b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mTransform(0), 1586b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mScalingMode(NATIVE_WINDOW_SCALING_MODE_FREEZE), 1596b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mTimestamp(0), 1606b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mFrameNumber(0), 1616b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mFence(EGL_NO_SYNC_KHR) { 1626b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mCrop.makeInvalid(); 1636b091c53000c843211c218ce40287a7edca9bc63Daniel Lam } 1646b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1656b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mGraphicBuffer points to the buffer allocated for this slot or is NULL 1666b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // if no buffer has been allocated. 1676b091c53000c843211c218ce40287a7edca9bc63Daniel Lam sp<GraphicBuffer> mGraphicBuffer; 1686b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1696b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mEglImage is the EGLImage created from mGraphicBuffer. 1706b091c53000c843211c218ce40287a7edca9bc63Daniel Lam EGLImageKHR mEglImage; 1716b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1726b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mEglDisplay is the EGLDisplay used to create mEglImage. 1736b091c53000c843211c218ce40287a7edca9bc63Daniel Lam EGLDisplay mEglDisplay; 1746b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1756b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferState represents the different states in which a buffer slot 1766b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // can be. 1776b091c53000c843211c218ce40287a7edca9bc63Daniel Lam enum BufferState { 1786b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // FREE indicates that the buffer is not currently being used and 1796b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // will not be used in the future until it gets dequeued and 1806b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // subsequently queued by the client. 1816b091c53000c843211c218ce40287a7edca9bc63Daniel Lam FREE = 0, 1826b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1836b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // DEQUEUED indicates that the buffer has been dequeued by the 1846b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // client, but has not yet been queued or canceled. The buffer is 1856b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // considered 'owned' by the client, and the server should not use 1866b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // it for anything. 1876b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // 1886b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // Note that when in synchronous-mode (mSynchronousMode == true), 1896b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // the buffer that's currently attached to the texture may be 1906b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // dequeued by the client. That means that the current buffer can 1916b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // be in either the DEQUEUED or QUEUED state. In asynchronous mode, 1926b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // however, the current buffer is always in the QUEUED state. 1936b091c53000c843211c218ce40287a7edca9bc63Daniel Lam DEQUEUED = 1, 1946b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 1956b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // QUEUED indicates that the buffer has been queued by the client, 1966b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // and has not since been made available for the client to dequeue. 1976b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // Attaching the buffer to the texture does NOT transition the 1986b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // buffer away from the QUEUED state. However, in Synchronous mode 1996b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // the current buffer may be dequeued by the client under some 2006b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // circumstances. See the note about the current buffer in the 2016b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // documentation for DEQUEUED. 2026b091c53000c843211c218ce40287a7edca9bc63Daniel Lam QUEUED = 2, 2036b091c53000c843211c218ce40287a7edca9bc63Daniel Lam }; 2046b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2056b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mBufferState is the current state of this buffer slot. 2066b091c53000c843211c218ce40287a7edca9bc63Daniel Lam BufferState mBufferState; 2076b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2086b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mRequestBufferCalled is used for validating that the client did 2096b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // call requestBuffer() when told to do so. Technically this is not 2106b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // needed but useful for debugging and catching client bugs. 2116b091c53000c843211c218ce40287a7edca9bc63Daniel Lam bool mRequestBufferCalled; 2126b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2136b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mCrop is the current crop rectangle for this buffer slot. This gets 2146b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // set to mNextCrop each time queueBuffer gets called for this buffer. 2156b091c53000c843211c218ce40287a7edca9bc63Daniel Lam Rect mCrop; 2166b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2176b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mTransform is the current transform flags for this buffer slot. This 2186b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // gets set to mNextTransform each time queueBuffer gets called for this 2196b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // slot. 2206b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t mTransform; 2216b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2226b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mScalingMode is the current scaling mode for this buffer slot. This 2236b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // gets set to mNextScalingMode each time queueBuffer gets called for 2246b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // this slot. 2256b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t mScalingMode; 2266b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2276b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mTimestamp is the current timestamp for this buffer slot. This gets 2286b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // to set by queueBuffer each time this slot is queued. 2296b091c53000c843211c218ce40287a7edca9bc63Daniel Lam int64_t mTimestamp; 2306b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2316b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mFrameNumber is the number of the queued frame for this slot. 2326b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint64_t mFrameNumber; 2336b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2346b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mFence is the EGL sync object that must signal before the buffer 2356b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // associated with this buffer slot may be dequeued. It is initialized 2366b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // to EGL_NO_SYNC_KHR when the buffer is created and (optionally, based 2376b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // on a compile-time option) set to a new sync object in updateTexImage. 2386b091c53000c843211c218ce40287a7edca9bc63Daniel Lam EGLSyncKHR mFence; 2396b091c53000c843211c218ce40287a7edca9bc63Daniel Lam }; 2406b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2416b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mSlots is the array of buffer slots that must be mirrored on the client 2426b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // side. This allows buffer ownership to be transferred between the client 2436b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // and server without sending a GraphicBuffer over binder. The entire array 2446b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // is initialized to NULL at construction time, and buffers are allocated 2456b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // for a slot when requestBuffer is called with that slot's index. 2466b091c53000c843211c218ce40287a7edca9bc63Daniel Lam BufferSlot mSlots[NUM_BUFFER_SLOTS]; 2476b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2486b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2496b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mDefaultWidth holds the default width of allocated buffers. It is used 2506b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // in requestBuffers() if a width and height of zero is specified. 2516b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t mDefaultWidth; 2526b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2536b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mDefaultHeight holds the default height of allocated buffers. It is used 2546b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // in requestBuffers() if a width and height of zero is specified. 2556b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t mDefaultHeight; 2566b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2576b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mPixelFormat holds the pixel format of allocated buffers. It is used 2586b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // in requestBuffers() if a format of zero is specified. 2596b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t mPixelFormat; 2606b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2616b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mBufferCount is the number of buffer slots that the client and server 2626b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // must maintain. It defaults to MIN_ASYNC_BUFFER_SLOTS and can be changed 2636b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // by calling setBufferCount or setBufferCountServer 2646b091c53000c843211c218ce40287a7edca9bc63Daniel Lam int mBufferCount; 2656b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2666b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mClientBufferCount is the number of buffer slots requested by the client. 2676b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // The default is zero, which means the client doesn't care how many buffers 2686b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // there is. 2696b091c53000c843211c218ce40287a7edca9bc63Daniel Lam int mClientBufferCount; 2706b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2716b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mServerBufferCount buffer count requested by the server-side 2726b091c53000c843211c218ce40287a7edca9bc63Daniel Lam int mServerBufferCount; 2736b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2746b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mCurrentTexture is the buffer slot index of the buffer that is currently 2756b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // bound to the OpenGL texture. It is initialized to INVALID_BUFFER_SLOT, 2766b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // indicating that no buffer slot is currently bound to the texture. Note, 2776b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // however, that a value of INVALID_BUFFER_SLOT does not necessarily mean 2786b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // that no buffer is bound to the texture. A call to setBufferCount will 2796b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // reset mCurrentTexture to INVALID_BUFFER_SLOT. 2806b091c53000c843211c218ce40287a7edca9bc63Daniel Lam int mCurrentTexture; 2816b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2826b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mNextCrop is the crop rectangle that will be used for the next buffer 2836b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // that gets queued. It is set by calling setCrop. 2846b091c53000c843211c218ce40287a7edca9bc63Daniel Lam Rect mNextCrop; 2856b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2866b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mNextTransform is the transform identifier that will be used for the next 2876b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // buffer that gets queued. It is set by calling setTransform. 2886b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint32_t mNextTransform; 2896b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2906b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mNextScalingMode is the scaling mode that will be used for the next 2916b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // buffers that get queued. It is set by calling setScalingMode. 2926b091c53000c843211c218ce40287a7edca9bc63Daniel Lam int mNextScalingMode; 2936b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2946b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mGraphicBufferAlloc is the connection to SurfaceFlinger that is used to 2956b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // allocate new GraphicBuffer objects. 2966b091c53000c843211c218ce40287a7edca9bc63Daniel Lam sp<IGraphicBufferAlloc> mGraphicBufferAlloc; 2976b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 2986b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mFrameAvailableListener is the listener object that will be called when a 2996b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // new frame becomes available. If it is not NULL it will be called from 3006b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // queueBuffer. 3016b091c53000c843211c218ce40287a7edca9bc63Daniel Lam sp<FrameAvailableListener> mFrameAvailableListener; 3026b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3036b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mSynchronousMode whether we're in synchronous mode or not 3046b091c53000c843211c218ce40287a7edca9bc63Daniel Lam bool mSynchronousMode; 3056b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3066b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mAllowSynchronousMode whether we allow synchronous mode or not 3076b091c53000c843211c218ce40287a7edca9bc63Daniel Lam const bool mAllowSynchronousMode; 3086b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3096b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mConnectedApi indicates the API that is currently connected to this 3106b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue. It defaults to NO_CONNECTED_API (= 0), and gets updated 3116b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // by the connect and disconnect methods. 3126b091c53000c843211c218ce40287a7edca9bc63Daniel Lam int mConnectedApi; 3136b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3146b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mDequeueCondition condition used for dequeueBuffer in synchronous mode 3156b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mutable Condition mDequeueCondition; 3166b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3176b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mQueue is a FIFO of queued buffers used in synchronous mode 3186b091c53000c843211c218ce40287a7edca9bc63Daniel Lam typedef Vector<int> Fifo; 3196b091c53000c843211c218ce40287a7edca9bc63Daniel Lam Fifo mQueue; 3206b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3216b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mAbandoned indicates that the BufferQueue will no longer be used to 3226b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // consume images buffers pushed to it using the ISurfaceTexture interface. 3236b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // It is initialized to false, and set to true in the abandon method. A 3246b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // BufferQueue that has been abandoned will return the NO_INIT error from 3256b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // all ISurfaceTexture methods capable of returning an error. 3266b091c53000c843211c218ce40287a7edca9bc63Daniel Lam bool mAbandoned; 3276b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3286b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mName is a string used to identify the BufferQueue in log messages. 3296b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // It is set by the setName method. 3306b091c53000c843211c218ce40287a7edca9bc63Daniel Lam String8 mName; 3316b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3326b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mMutex is the mutex used to prevent concurrent access to the member 3336b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // variables of BufferQueue objects. It must be locked whenever the 3346b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // member variables are accessed. 3356b091c53000c843211c218ce40287a7edca9bc63Daniel Lam mutable Mutex mMutex; 3366b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3376b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // mFrameCounter is the free running counter, incremented for every buffer queued 3386b091c53000c843211c218ce40287a7edca9bc63Daniel Lam // with the surface Texture. 3396b091c53000c843211c218ce40287a7edca9bc63Daniel Lam uint64_t mFrameCounter; 3406b091c53000c843211c218ce40287a7edca9bc63Daniel Lam}; 3416b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3426b091c53000c843211c218ce40287a7edca9bc63Daniel Lam// ---------------------------------------------------------------------------- 3436b091c53000c843211c218ce40287a7edca9bc63Daniel Lam}; // namespace android 3446b091c53000c843211c218ce40287a7edca9bc63Daniel Lam 3456b091c53000c843211c218ce40287a7edca9bc63Daniel Lam#endif // ANDROID_GUI_BUFFERQUEUE_H 346