Surface.h revision 88612912ac8406f2be0eeff97892274f98509017
1edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/* 2e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian * Copyright (C) 2010 The Android Open Source Project 3edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * 4edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 5edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * you may not use this file except in compliance with the License. 6edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * You may obtain a copy of the License at 7edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * 8edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 9edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * 10edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 11edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 12edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * See the License for the specific language governing permissions and 14edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * limitations under the License. 15edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project */ 16edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 1790ac799241f077a7b7e6c1875fd933864c8dd2a7Mathias Agopian#ifndef ANDROID_GUI_SURFACE_H 1890ac799241f077a7b7e6c1875fd933864c8dd2a7Mathias Agopian#define ANDROID_GUI_SURFACE_H 19edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 20e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian#include <gui/IGraphicBufferProducer.h> 21e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian#include <gui/BufferQueue.h> 22e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 23e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian#include <ui/ANativeObjectBase.h> 24e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian#include <ui/Region.h> 25edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 2688612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala#include <binder/Parcelable.h> 2788612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala 28edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <utils/RefBase.h> 29edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <utils/threads.h> 30e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian#include <utils/KeyedVector.h> 31edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 32e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopianstruct ANativeWindow_Buffer; 339cce325fae8adcf7560a28eef394489f09bad74dMathias Agopian 34edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectnamespace android { 35edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 360273adbf0bc202eda2ca579ae0773464ea9c701fAndy McFadden/* 37e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian * An implementation of ANativeWindow that feeds graphics buffers into a 38e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian * BufferQueue. 390273adbf0bc202eda2ca579ae0773464ea9c701fAndy McFadden * 40e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian * This is typically used by programs that want to render frames through 41e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian * some means (maybe OpenGL, a software renderer, or a hardware decoder) 42e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian * and have the frames they create forwarded to SurfaceFlinger for 43e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian * compositing. For example, a video decoder could render a frame and call 44e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian * eglSwapBuffers(), which invokes ANativeWindow callbacks defined by 45e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian * Surface. Surface then forwards the buffers through Binder IPC 46e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian * to the BufferQueue's producer interface, providing the new frame to a 47e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian * consumer such as GLConsumer. 480273adbf0bc202eda2ca579ae0773464ea9c701fAndy McFadden */ 49e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopianclass Surface 50e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian : public ANativeObjectBase<ANativeWindow, Surface, RefBase> 51076b1cc3a9b90aa5b381a1ed268ca0b548444c9bMathias Agopian{ 52edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectpublic: 53edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 54cf0b8c85fb0106751256dba7821f86b5ad03126cMathias Agopian /* 55cf0b8c85fb0106751256dba7821f86b5ad03126cMathias Agopian * creates a Surface from the given IGraphicBufferProducer (which concrete 56cf0b8c85fb0106751256dba7821f86b5ad03126cMathias Agopian * implementation is a BufferQueue). 57cf0b8c85fb0106751256dba7821f86b5ad03126cMathias Agopian * 58cf0b8c85fb0106751256dba7821f86b5ad03126cMathias Agopian * Surface is mainly state-less while it's disconnected, it can be 59cf0b8c85fb0106751256dba7821f86b5ad03126cMathias Agopian * viewed as a glorified IGraphicBufferProducer holder. It's therefore 60cf0b8c85fb0106751256dba7821f86b5ad03126cMathias Agopian * safe to create other Surfaces from the same IGraphicBufferProducer. 61cf0b8c85fb0106751256dba7821f86b5ad03126cMathias Agopian * 62cf0b8c85fb0106751256dba7821f86b5ad03126cMathias Agopian * However, once a Surface is connected, it'll prevent other Surfaces 63cf0b8c85fb0106751256dba7821f86b5ad03126cMathias Agopian * referring to the same IGraphicBufferProducer to become connected and 64cf0b8c85fb0106751256dba7821f86b5ad03126cMathias Agopian * therefore prevent them to be used as actual producers of buffers. 65595264f1af12e25dce57d7c5b1d52ed86ac0d0c9Mathias Agopian * 66595264f1af12e25dce57d7c5b1d52ed86ac0d0c9Mathias Agopian * the controlledByApp flag indicates that this Surface (producer) is 67595264f1af12e25dce57d7c5b1d52ed86ac0d0c9Mathias Agopian * controlled by the application. This flag is used at connect time. 68cf0b8c85fb0106751256dba7821f86b5ad03126cMathias Agopian */ 69595264f1af12e25dce57d7c5b1d52ed86ac0d0c9Mathias Agopian Surface(const sp<IGraphicBufferProducer>& bufferProducer, bool controlledByApp = false); 70bd050ab2af1421d527d1a80ce59dd8d9940a838cTed Bonkenburg 71cf0b8c85fb0106751256dba7821f86b5ad03126cMathias Agopian /* getIGraphicBufferProducer() returns the IGraphicBufferProducer this 72cf0b8c85fb0106751256dba7821f86b5ad03126cMathias Agopian * Surface was created with. Usually it's an error to use the 73cf0b8c85fb0106751256dba7821f86b5ad03126cMathias Agopian * IGraphicBufferProducer while the Surface is connected. 74cf0b8c85fb0106751256dba7821f86b5ad03126cMathias Agopian */ 75e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian sp<IGraphicBufferProducer> getIGraphicBufferProducer() const; 76bd050ab2af1421d527d1a80ce59dd8d9940a838cTed Bonkenburg 77cf0b8c85fb0106751256dba7821f86b5ad03126cMathias Agopian /* convenience function to check that the given surface is non NULL as 78cf0b8c85fb0106751256dba7821f86b5ad03126cMathias Agopian * well as its IGraphicBufferProducer */ 79c4905eb49d20667381f3cda7c6f6894234404bd3Mathias Agopian static bool isValid(const sp<Surface>& surface) { 80f25c5086cf46eb029d887f34f25a09220e44958cMathias Agopian return surface != NULL && surface->getIGraphicBufferProducer() != NULL; 81f25c5086cf46eb029d887f34f25a09220e44958cMathias Agopian } 82f25c5086cf46eb029d887f34f25a09220e44958cMathias Agopian 83399184a4cd728ea1421fb0bc1722274a29e38f4aJesse Hall /* Attaches a sideband buffer stream to the Surface's IGraphicBufferProducer. 84399184a4cd728ea1421fb0bc1722274a29e38f4aJesse Hall * 85399184a4cd728ea1421fb0bc1722274a29e38f4aJesse Hall * A sideband stream is a device-specific mechanism for passing buffers 86399184a4cd728ea1421fb0bc1722274a29e38f4aJesse Hall * from the producer to the consumer without using dequeueBuffer/ 87399184a4cd728ea1421fb0bc1722274a29e38f4aJesse Hall * queueBuffer. If a sideband stream is present, the consumer can choose 88399184a4cd728ea1421fb0bc1722274a29e38f4aJesse Hall * whether to acquire buffers from the sideband stream or from the queued 89399184a4cd728ea1421fb0bc1722274a29e38f4aJesse Hall * buffers. 90399184a4cd728ea1421fb0bc1722274a29e38f4aJesse Hall * 91399184a4cd728ea1421fb0bc1722274a29e38f4aJesse Hall * Passing NULL or a different stream handle will detach the previous 92399184a4cd728ea1421fb0bc1722274a29e38f4aJesse Hall * handle if any. 93399184a4cd728ea1421fb0bc1722274a29e38f4aJesse Hall */ 94399184a4cd728ea1421fb0bc1722274a29e38f4aJesse Hall void setSidebandStream(const sp<NativeHandle>& stream); 95399184a4cd728ea1421fb0bc1722274a29e38f4aJesse Hall 9629a3e90879fd96404c971e7187cd0e05927bbce0Dan Stoza /* Allocates buffers based on the current dimensions/format. 9729a3e90879fd96404c971e7187cd0e05927bbce0Dan Stoza * 9829a3e90879fd96404c971e7187cd0e05927bbce0Dan Stoza * This function will allocate up to the maximum number of buffers 9929a3e90879fd96404c971e7187cd0e05927bbce0Dan Stoza * permitted by the current BufferQueue configuration. It will use the 10029a3e90879fd96404c971e7187cd0e05927bbce0Dan Stoza * default format and dimensions. This is most useful to avoid an allocation 10129a3e90879fd96404c971e7187cd0e05927bbce0Dan Stoza * delay during dequeueBuffer. If there are already the maximum number of 10229a3e90879fd96404c971e7187cd0e05927bbce0Dan Stoza * buffers allocated, this function has no effect. 10329a3e90879fd96404c971e7187cd0e05927bbce0Dan Stoza */ 10429a3e90879fd96404c971e7187cd0e05927bbce0Dan Stoza void allocateBuffers(); 10529a3e90879fd96404c971e7187cd0e05927bbce0Dan Stoza 106812ed0644f8f8f71ca403f4e5793f0dbc1fcf9b2Dan Stoza /* Sets the generation number on the IGraphicBufferProducer and updates the 107812ed0644f8f8f71ca403f4e5793f0dbc1fcf9b2Dan Stoza * generation number on any buffers attached to the Surface after this call. 108812ed0644f8f8f71ca403f4e5793f0dbc1fcf9b2Dan Stoza * See IGBP::setGenerationNumber for more information. */ 109812ed0644f8f8f71ca403f4e5793f0dbc1fcf9b2Dan Stoza status_t setGenerationNumber(uint32_t generationNumber); 110812ed0644f8f8f71ca403f4e5793f0dbc1fcf9b2Dan Stoza 111c6f30bdee1f634eb90d68cb76efe935b6535a1e8Dan Stoza // See IGraphicBufferProducer::getConsumerName 112c6f30bdee1f634eb90d68cb76efe935b6535a1e8Dan Stoza String8 getConsumerName() const; 113c6f30bdee1f634eb90d68cb76efe935b6535a1e8Dan Stoza 1147dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza // See IGraphicBufferProducer::getNextFrameNumber 1157dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza uint64_t getNextFrameNumber() const; 1167dde599bf1a0dbef7390d91c2689d506371cdbd7Dan Stoza 117c2e7788721489c5a2ef681fd0bfa591d2ce41175Robert Carr /* Set the scaling mode to be used with a Surface. 118c2e7788721489c5a2ef681fd0bfa591d2ce41175Robert Carr * See NATIVE_WINDOW_SET_SCALING_MODE and its parameters 119c2e7788721489c5a2ef681fd0bfa591d2ce41175Robert Carr * in <system/window.h>. */ 120c2e7788721489c5a2ef681fd0bfa591d2ce41175Robert Carr int setScalingMode(int mode); 121c2e7788721489c5a2ef681fd0bfa591d2ce41175Robert Carr 122127fc63e8a15366b4395f1363e8e18eb058d1709Dan Stoza // See IGraphicBufferProducer::setDequeueTimeout 123127fc63e8a15366b4395f1363e8e18eb058d1709Dan Stoza status_t setDequeueTimeout(nsecs_t timeout); 124127fc63e8a15366b4395f1363e8e18eb058d1709Dan Stoza 125e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopianprotected: 126e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian virtual ~Surface(); 127edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 128b296533607232357597b255679db29470ab5925dMathias Agopianprivate: 129b296533607232357597b255679db29470ab5925dMathias Agopian // can't be copied 130e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian Surface& operator = (const Surface& rhs); 131b296533607232357597b255679db29470ab5925dMathias Agopian Surface(const Surface& rhs); 132e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 133e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // ANativeWindow hooks 134e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian static int hook_cancelBuffer(ANativeWindow* window, 135e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian ANativeWindowBuffer* buffer, int fenceFd); 136e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian static int hook_dequeueBuffer(ANativeWindow* window, 137e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian ANativeWindowBuffer** buffer, int* fenceFd); 138e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian static int hook_perform(ANativeWindow* window, int operation, ...); 139e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian static int hook_query(const ANativeWindow* window, int what, int* value); 140e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian static int hook_queueBuffer(ANativeWindow* window, 141e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian ANativeWindowBuffer* buffer, int fenceFd); 142e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian static int hook_setSwapInterval(ANativeWindow* window, int interval); 143e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 144e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian static int hook_cancelBuffer_DEPRECATED(ANativeWindow* window, 145e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian ANativeWindowBuffer* buffer); 146e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian static int hook_dequeueBuffer_DEPRECATED(ANativeWindow* window, 147e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian ANativeWindowBuffer** buffer); 148e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian static int hook_lockBuffer_DEPRECATED(ANativeWindow* window, 149e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian ANativeWindowBuffer* buffer); 150e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian static int hook_queueBuffer_DEPRECATED(ANativeWindow* window, 151e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian ANativeWindowBuffer* buffer); 152e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 153e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian int dispatchConnect(va_list args); 154e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian int dispatchDisconnect(va_list args); 155e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian int dispatchSetBufferCount(va_list args); 156e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian int dispatchSetBuffersGeometry(va_list args); 157e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian int dispatchSetBuffersDimensions(va_list args); 158e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian int dispatchSetBuffersUserDimensions(va_list args); 159e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian int dispatchSetBuffersFormat(va_list args); 160e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian int dispatchSetScalingMode(va_list args); 161e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian int dispatchSetBuffersTransform(va_list args); 1621681d95989271f3a9ac0dbb93d10e4a29f2b4444Ruben Brunk int dispatchSetBuffersStickyTransform(va_list args); 163e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian int dispatchSetBuffersTimestamp(va_list args); 164e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian int dispatchSetCrop(va_list args); 165e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian int dispatchSetPostTransformCrop(va_list args); 166e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian int dispatchSetUsage(va_list args); 167e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian int dispatchLock(va_list args); 168e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian int dispatchUnlockAndPost(va_list args); 1697cb0d39016ff8061fe9fc2967870c145a6ffa2acRachad int dispatchSetSidebandStream(va_list args); 17082c6bcc9705eabcaf5b9e45bc81867b0e2d61a02Eino-Ville Talvala int dispatchSetBuffersDataSpace(va_list args); 1715065a55291b67f584d7b0be3fa3cfc4e29a3cd1cDan Stoza int dispatchSetSurfaceDamage(va_list args); 172ccdfd60d79a8b7f1ed6401d0f2e8e29166a10584Pablo Ceballos int dispatchSetSingleBufferMode(va_list args); 173ff95aabbcc6e8606acbd7933c90eeb9b8b382a21Pablo Ceballos int dispatchSetAutoRefresh(va_list args); 174e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 175e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopianprotected: 176e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian virtual int dequeueBuffer(ANativeWindowBuffer** buffer, int* fenceFd); 177e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian virtual int cancelBuffer(ANativeWindowBuffer* buffer, int fenceFd); 178e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian virtual int queueBuffer(ANativeWindowBuffer* buffer, int fenceFd); 179e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian virtual int perform(int operation, va_list args); 180e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian virtual int query(int what, int* value) const; 181e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian virtual int setSwapInterval(int interval); 182e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 183e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian virtual int lockBuffer_DEPRECATED(ANativeWindowBuffer* buffer); 184e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 185e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian virtual int connect(int api); 186e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian virtual int disconnect(int api); 187e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian virtual int setBufferCount(int bufferCount); 1883be1c6b60a188dc10025e2ce156c11fac050625dDan Stoza virtual int setBuffersDimensions(uint32_t width, uint32_t height); 1893be1c6b60a188dc10025e2ce156c11fac050625dDan Stoza virtual int setBuffersUserDimensions(uint32_t width, uint32_t height); 1903be1c6b60a188dc10025e2ce156c11fac050625dDan Stoza virtual int setBuffersFormat(PixelFormat format); 1913be1c6b60a188dc10025e2ce156c11fac050625dDan Stoza virtual int setBuffersTransform(uint32_t transform); 1923be1c6b60a188dc10025e2ce156c11fac050625dDan Stoza virtual int setBuffersStickyTransform(uint32_t transform); 193e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian virtual int setBuffersTimestamp(int64_t timestamp); 19482c6bcc9705eabcaf5b9e45bc81867b0e2d61a02Eino-Ville Talvala virtual int setBuffersDataSpace(android_dataspace dataSpace); 195e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian virtual int setCrop(Rect const* rect); 196e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian virtual int setUsage(uint32_t reqUsage); 1975065a55291b67f584d7b0be3fa3cfc4e29a3cd1cDan Stoza virtual void setSurfaceDamage(android_native_rect_t* rects, size_t numRects); 198076b1cc3a9b90aa5b381a1ed268ca0b548444c9bMathias Agopian 199e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopianpublic: 20019e3e06e3c65a7c001a6fe0971744ba5ff536515Pablo Ceballos virtual int setMaxDequeuedBufferCount(int maxDequeuedBuffers); 20119e3e06e3c65a7c001a6fe0971744ba5ff536515Pablo Ceballos virtual int setAsyncMode(bool async); 202ccdfd60d79a8b7f1ed6401d0f2e8e29166a10584Pablo Ceballos virtual int setSingleBufferMode(bool singleBufferMode); 203ff95aabbcc6e8606acbd7933c90eeb9b8b382a21Pablo Ceballos virtual int setAutoRefresh(bool autoRefresh); 204e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian virtual int lock(ANativeWindow_Buffer* outBuffer, ARect* inOutDirtyBounds); 205e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian virtual int unlockAndPost(); 206b296533607232357597b255679db29470ab5925dMathias Agopian 207231832eb27107fb561467f5f4a9be2c577c61ea8Dan Stoza virtual int connect(int api, const sp<IProducerListener>& listener); 208d9c4971da2f2c4f980a748006bd40469c3332a13Dan Stoza virtual int detachNextBuffer(sp<GraphicBuffer>* outBuffer, 209231832eb27107fb561467f5f4a9be2c577c61ea8Dan Stoza sp<Fence>* outFence); 210231832eb27107fb561467f5f4a9be2c577c61ea8Dan Stoza virtual int attachBuffer(ANativeWindowBuffer*); 211231832eb27107fb561467f5f4a9be2c577c61ea8Dan Stoza 212e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopianprotected: 213e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian enum { NUM_BUFFER_SLOTS = BufferQueue::NUM_BUFFER_SLOTS }; 214e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian enum { DEFAULT_FORMAT = PIXEL_FORMAT_RGBA_8888 }; 215aca4e2287939b4ce3d9e9aced64c5c9641333503Jamie Gennis 216e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopianprivate: 217e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian void freeAllBuffers(); 218e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian int getSlotFromBufferLocked(android_native_buffer_t* buffer) const; 2198f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian 220e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian struct BufferSlot { 221e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian sp<GraphicBuffer> buffer; 222e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian Region dirtyRegion; 223e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian }; 224ba5972ffdc7179dd9a387f22032eb18666d97917Mathias Agopian 225e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // mSurfaceTexture is the interface to the surface texture server. All 226e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // operations on the surface texture client ultimately translate into 227e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // interactions with the server using this interface. 228e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // TODO: rename to mBufferProducer 229e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian sp<IGraphicBufferProducer> mGraphicBufferProducer; 230e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 231e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // mSlots stores the buffers that have been allocated for each buffer slot. 232e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // It is initialized to null pointers, and gets filled in with the result of 233e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // IGraphicBufferProducer::requestBuffer when the client dequeues a buffer from a 234e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // slot that has not yet been used. The buffer allocated to a slot will also 235e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // be replaced if the requested buffer usage or geometry differs from that 236e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // of the buffer allocated to a slot. 237e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian BufferSlot mSlots[NUM_BUFFER_SLOTS]; 238e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 239e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // mReqWidth is the buffer width that will be requested at the next dequeue 240e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // operation. It is initialized to 1. 241e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian uint32_t mReqWidth; 242e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 243e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // mReqHeight is the buffer height that will be requested at the next 244e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // dequeue operation. It is initialized to 1. 245e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian uint32_t mReqHeight; 246e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 247e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // mReqFormat is the buffer pixel format that will be requested at the next 248e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // deuque operation. It is initialized to PIXEL_FORMAT_RGBA_8888. 2493be1c6b60a188dc10025e2ce156c11fac050625dDan Stoza PixelFormat mReqFormat; 250e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 251e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // mReqUsage is the set of buffer usage flags that will be requested 252e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // at the next deuque operation. It is initialized to 0. 253e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian uint32_t mReqUsage; 254e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 255e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // mTimestamp is the timestamp that will be used for the next buffer queue 256e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // operation. It defaults to NATIVE_WINDOW_TIMESTAMP_AUTO, which means that 257e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // a timestamp is auto-generated when queueBuffer is called. 258e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian int64_t mTimestamp; 259e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 26082c6bcc9705eabcaf5b9e45bc81867b0e2d61a02Eino-Ville Talvala // mDataSpace is the buffer dataSpace that will be used for the next buffer 26182c6bcc9705eabcaf5b9e45bc81867b0e2d61a02Eino-Ville Talvala // queue operation. It defaults to HAL_DATASPACE_UNKNOWN, which 26282c6bcc9705eabcaf5b9e45bc81867b0e2d61a02Eino-Ville Talvala // means that the buffer contains some type of color data. 26382c6bcc9705eabcaf5b9e45bc81867b0e2d61a02Eino-Ville Talvala android_dataspace mDataSpace; 26482c6bcc9705eabcaf5b9e45bc81867b0e2d61a02Eino-Ville Talvala 265e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // mCrop is the crop rectangle that will be used for the next buffer 266e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // that gets queued. It is set by calling setCrop. 267e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian Rect mCrop; 268e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 269e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // mScalingMode is the scaling mode that will be used for the next 270e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // buffers that get queued. It is set by calling setScalingMode. 271e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian int mScalingMode; 272e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 273e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // mTransform is the transform identifier that will be used for the next 274e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // buffer that gets queued. It is set by calling setTransform. 275e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian uint32_t mTransform; 276e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 2771681d95989271f3a9ac0dbb93d10e4a29f2b4444Ruben Brunk // mStickyTransform is a transform that is applied on top of mTransform 2781681d95989271f3a9ac0dbb93d10e4a29f2b4444Ruben Brunk // in each buffer that is queued. This is typically used to force the 2791681d95989271f3a9ac0dbb93d10e4a29f2b4444Ruben Brunk // compositor to apply a transform, and will prevent the transform hint 2801681d95989271f3a9ac0dbb93d10e4a29f2b4444Ruben Brunk // from being set by the compositor. 2811681d95989271f3a9ac0dbb93d10e4a29f2b4444Ruben Brunk uint32_t mStickyTransform; 2821681d95989271f3a9ac0dbb93d10e4a29f2b4444Ruben Brunk 2833be1c6b60a188dc10025e2ce156c11fac050625dDan Stoza // mDefaultWidth is default width of the buffers, regardless of the 2843be1c6b60a188dc10025e2ce156c11fac050625dDan Stoza // native_window_set_buffers_dimensions call. 2853be1c6b60a188dc10025e2ce156c11fac050625dDan Stoza uint32_t mDefaultWidth; 286e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 2873be1c6b60a188dc10025e2ce156c11fac050625dDan Stoza // mDefaultHeight is default height of the buffers, regardless of the 2883be1c6b60a188dc10025e2ce156c11fac050625dDan Stoza // native_window_set_buffers_dimensions call. 2893be1c6b60a188dc10025e2ce156c11fac050625dDan Stoza uint32_t mDefaultHeight; 290e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 2913be1c6b60a188dc10025e2ce156c11fac050625dDan Stoza // mUserWidth, if non-zero, is an application-specified override 2923be1c6b60a188dc10025e2ce156c11fac050625dDan Stoza // of mDefaultWidth. This is lower priority than the width set by 2933be1c6b60a188dc10025e2ce156c11fac050625dDan Stoza // native_window_set_buffers_dimensions. 2943be1c6b60a188dc10025e2ce156c11fac050625dDan Stoza uint32_t mUserWidth; 295e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 2963be1c6b60a188dc10025e2ce156c11fac050625dDan Stoza // mUserHeight, if non-zero, is an application-specified override 2973be1c6b60a188dc10025e2ce156c11fac050625dDan Stoza // of mDefaultHeight. This is lower priority than the height set 2983be1c6b60a188dc10025e2ce156c11fac050625dDan Stoza // by native_window_set_buffers_dimensions. 2993be1c6b60a188dc10025e2ce156c11fac050625dDan Stoza uint32_t mUserHeight; 300e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 301e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // mTransformHint is the transform probably applied to buffers of this 302e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // window. this is only a hint, actual transform may differ. 303e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian uint32_t mTransformHint; 304e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 305595264f1af12e25dce57d7c5b1d52ed86ac0d0c9Mathias Agopian // mProducerControlledByApp whether this buffer producer is controlled 306595264f1af12e25dce57d7c5b1d52ed86ac0d0c9Mathias Agopian // by the application 307595264f1af12e25dce57d7c5b1d52ed86ac0d0c9Mathias Agopian bool mProducerControlledByApp; 308595264f1af12e25dce57d7c5b1d52ed86ac0d0c9Mathias Agopian 3097cdd786fa80cf03551291ae8feca7b77583be1c5Mathias Agopian // mSwapIntervalZero set if we should drop buffers at queue() time to 3107cdd786fa80cf03551291ae8feca7b77583be1c5Mathias Agopian // achieve an asynchronous swap interval 3117cdd786fa80cf03551291ae8feca7b77583be1c5Mathias Agopian bool mSwapIntervalZero; 3127cdd786fa80cf03551291ae8feca7b77583be1c5Mathias Agopian 313e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // mConsumerRunningBehind whether the consumer is running more than 314e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // one buffer behind the producer. 315e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian mutable bool mConsumerRunningBehind; 316e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 317e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // mMutex is the mutex used to prevent concurrent access to the member 318e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // variables of Surface objects. It must be locked whenever the 319e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // member variables are accessed. 320e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian mutable Mutex mMutex; 321e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 322e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian // must be used from the lock/unlock thread 323e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian sp<GraphicBuffer> mLockedBuffer; 324e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian sp<GraphicBuffer> mPostedBuffer; 325e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian bool mConnectedToCpu; 326e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian 327c62acbd12711ee6cff1ef94c146316dfe5169045Dan Stoza // When a CPU producer is attached, this reflects the region that the 328c62acbd12711ee6cff1ef94c146316dfe5169045Dan Stoza // producer wished to update as well as whether the Surface was able to copy 329c62acbd12711ee6cff1ef94c146316dfe5169045Dan Stoza // the previous buffer back to allow a partial update. 3305065a55291b67f584d7b0be3fa3cfc4e29a3cd1cDan Stoza // 331c62acbd12711ee6cff1ef94c146316dfe5169045Dan Stoza // When a non-CPU producer is attached, this reflects the surface damage 332c62acbd12711ee6cff1ef94c146316dfe5169045Dan Stoza // (the change since the previous frame) passed in by the producer. 333e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian Region mDirtyRegion; 334812ed0644f8f8f71ca403f4e5793f0dbc1fcf9b2Dan Stoza 335812ed0644f8f8f71ca403f4e5793f0dbc1fcf9b2Dan Stoza // Stores the current generation number. See setGenerationNumber and 336812ed0644f8f8f71ca403f4e5793f0dbc1fcf9b2Dan Stoza // IGraphicBufferProducer::setGenerationNumber for more information. 337812ed0644f8f8f71ca403f4e5793f0dbc1fcf9b2Dan Stoza uint32_t mGenerationNumber; 338ff95aabbcc6e8606acbd7933c90eeb9b8b382a21Pablo Ceballos 339ff95aabbcc6e8606acbd7933c90eeb9b8b382a21Pablo Ceballos // Caches the values that have been passed to the producer. 340ff95aabbcc6e8606acbd7933c90eeb9b8b382a21Pablo Ceballos bool mSingleBufferMode; 341ff95aabbcc6e8606acbd7933c90eeb9b8b382a21Pablo Ceballos bool mAutoRefresh; 342ff95aabbcc6e8606acbd7933c90eeb9b8b382a21Pablo Ceballos 343ff95aabbcc6e8606acbd7933c90eeb9b8b382a21Pablo Ceballos // If in single buffer mode and auto refresh is enabled, store the shared 344ff95aabbcc6e8606acbd7933c90eeb9b8b382a21Pablo Ceballos // buffer slot and return it for all calls to queue/dequeue without going 345ff95aabbcc6e8606acbd7933c90eeb9b8b382a21Pablo Ceballos // over Binder. 346ff95aabbcc6e8606acbd7933c90eeb9b8b382a21Pablo Ceballos int mSharedBufferSlot; 347ff95aabbcc6e8606acbd7933c90eeb9b8b382a21Pablo Ceballos 348ff95aabbcc6e8606acbd7933c90eeb9b8b382a21Pablo Ceballos // This is true if the shared buffer has already been queued/canceled. It's 349ff95aabbcc6e8606acbd7933c90eeb9b8b382a21Pablo Ceballos // used to prevent a mismatch between the number of queue/dequeue calls. 350ff95aabbcc6e8606acbd7933c90eeb9b8b382a21Pablo Ceballos bool mSharedBufferHasBeenQueued; 351edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project}; 352edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 35388612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvalanamespace view { 35488612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala 35588612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala/** 35688612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala * A simple holder for an IGraphicBufferProducer, to match the managed-side 35788612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala * android.view.Surface parcelable behavior. 35888612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala * 35988612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala * This implements android/view/Surface.aidl 36088612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala * 36188612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala * TODO: Convert IGraphicBufferProducer into AIDL so that it can be directly 36288612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala * used in managed Binder calls. 36388612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala */ 36488612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvalaclass Surface : public Parcelable { 36588612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala public: 36688612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala 36788612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala String16 name; 36888612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala sp<IGraphicBufferProducer> graphicBufferProducer; 36988612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala 37088612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala virtual status_t writeToParcel(Parcel* parcel) const override; 37188612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala virtual status_t readFromParcel(const Parcel* parcel) override; 37288612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala 37388612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala // nameAlreadyWritten set to true by Surface.java, because it splits 37488612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala // Parceling itself between managed and native code, so it only wants a part 37588612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala // of the full parceling to happen on its native side. 37688612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala status_t writeToParcel(Parcel* parcel, bool nameAlreadyWritten) const; 37788612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala 37888612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala // nameAlreadyRead set to true by Surface.java, because it splits 37988612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala // Parceling itself between managed and native code, so it only wants a part 38088612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala // of the full parceling to happen on its native side. 38188612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala status_t readFromParcel(const Parcel* parcel, bool nameAlreadyRead); 38288612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala 38388612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala private: 38488612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala 38588612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala static String16 readMaybeEmptyString16(const Parcel* parcel); 38688612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala}; 38788612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala 38888612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala} // namespace view 38988612912ac8406f2be0eeff97892274f98509017Eino-Ville Talvala 390edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project}; // namespace android 391edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 392e3c697fb929c856b59fa56a8e05a2a7eba187c3dMathias Agopian#endif // ANDROID_GUI_SURFACE_H 393