SurfaceTextureClient.h revision b0e76f456afaada43ddb0968bb37145219f90cd3
18ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis/* 28ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * Copyright (C) 2010 The Android Open Source Project 38ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * 48ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * Licensed under the Apache License, Version 2.0 (the "License"); 58ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * you may not use this file except in compliance with the License. 68ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * You may obtain a copy of the License at 78ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * 88ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * http://www.apache.org/licenses/LICENSE-2.0 98ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * 108ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * Unless required by applicable law or agreed to in writing, software 118ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * distributed under the License is distributed on an "AS IS" BASIS, 128ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 138ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * See the License for the specific language governing permissions and 148ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis * limitations under the License. 158ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis */ 168ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 178ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#ifndef ANDROID_GUI_SURFACETEXTURECLIENT_H 188ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#define ANDROID_GUI_SURFACETEXTURECLIENT_H 198ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 208ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#include <gui/ISurfaceTexture.h> 218ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#include <gui/SurfaceTexture.h> 22b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam#include <gui/BufferQueue.h> 238ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 245f2165f9455d4893b581b73a67c5431f4344b47eMathias Agopian#include <ui/ANativeObjectBase.h> 258f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian#include <ui/Region.h> 268ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 278ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#include <utils/RefBase.h> 288ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#include <utils/threads.h> 298ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 30b0e76f456afaada43ddb0968bb37145219f90cd3Mathias Agopianstruct ANativeWindow_Buffer; 31b0e76f456afaada43ddb0968bb37145219f90cd3Mathias Agopian 328ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennisnamespace android { 338ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 347a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopianclass Surface; 357a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian 368ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennisclass SurfaceTextureClient 375f2165f9455d4893b581b73a67c5431f4344b47eMathias Agopian : public ANativeObjectBase<ANativeWindow, SurfaceTextureClient, RefBase> 388ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis{ 398ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennispublic: 40b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam 418ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis SurfaceTextureClient(const sp<ISurfaceTexture>& surfaceTexture); 428ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 43b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // SurfaceTextureClient is overloaded to assist in refactoring ST and BQ. 44b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // SurfaceTexture is no longer an ISurfaceTexture, so client code 45b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // calling the original constructor will fail. Thus this convenience method 46b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam // passes in the surfaceTexture's bufferQueue to the init method. 47b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam SurfaceTextureClient(const sp<SurfaceTexture>& surfaceTexture); 48b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam 49bae774eb20bebd409441b93386b51bccda75f546Jamie Gennis sp<ISurfaceTexture> getISurfaceTexture() const; 50bae774eb20bebd409441b93386b51bccda75f546Jamie Gennis 518f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopianprotected: 528f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian SurfaceTextureClient(); 53a36bcd53ac075054bb39ef506687f4daaf9bac6bMathias Agopian virtual ~SurfaceTextureClient(); 548f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian void setISurfaceTexture(const sp<ISurfaceTexture>& surfaceTexture); 558ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 568f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopianprivate: 578ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // can't be copied 588ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis SurfaceTextureClient& operator = (const SurfaceTextureClient& rhs); 598ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis SurfaceTextureClient(const SurfaceTextureClient& rhs); 608f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian void init(); 618ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 628ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // ANativeWindow hooks 638f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian static int hook_cancelBuffer(ANativeWindow* window, ANativeWindowBuffer* buffer); 648f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian static int hook_dequeueBuffer(ANativeWindow* window, ANativeWindowBuffer** buffer); 658f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian static int hook_lockBuffer(ANativeWindow* window, ANativeWindowBuffer* buffer); 668f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian static int hook_perform(ANativeWindow* window, int operation, ...); 678f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian static int hook_query(const ANativeWindow* window, int what, int* value); 688f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian static int hook_queueBuffer(ANativeWindow* window, ANativeWindowBuffer* buffer); 698f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian static int hook_setSwapInterval(ANativeWindow* window, int interval); 708ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 718ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis int dispatchConnect(va_list args); 728ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis int dispatchDisconnect(va_list args); 738ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis int dispatchSetBufferCount(va_list args); 748ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis int dispatchSetBuffersGeometry(va_list args); 75bee205fd58a27c10a0895de5339e76025d429d2bJamie Gennis int dispatchSetBuffersDimensions(va_list args); 76bee205fd58a27c10a0895de5339e76025d429d2bJamie Gennis int dispatchSetBuffersFormat(va_list args); 777734ebfe47f42f980c1b44c1f284a91d8ad1d6c7Mathias Agopian int dispatchSetScalingMode(va_list args); 788ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis int dispatchSetBuffersTransform(va_list args); 791d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala int dispatchSetBuffersTimestamp(va_list args); 809d4d6c101d90d4a1d1ca9413cf3eb89d1f1898d6Jamie Gennis int dispatchSetCrop(va_list args); 819d4d6c101d90d4a1d1ca9413cf3eb89d1f1898d6Jamie Gennis int dispatchSetUsage(va_list args); 828f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian int dispatchLock(va_list args); 838f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian int dispatchUnlockAndPost(va_list args); 848f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian 858f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopianprotected: 868f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian virtual int cancelBuffer(ANativeWindowBuffer* buffer); 878f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian virtual int dequeueBuffer(ANativeWindowBuffer** buffer); 888f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian virtual int lockBuffer(ANativeWindowBuffer* buffer); 898f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian virtual int perform(int operation, va_list args); 908f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian virtual int query(int what, int* value) const; 918f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian virtual int queueBuffer(ANativeWindowBuffer* buffer); 928f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian virtual int setSwapInterval(int interval); 938f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian 948f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian virtual int connect(int api); 958f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian virtual int disconnect(int api); 968f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian virtual int setBufferCount(int bufferCount); 978f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian virtual int setBuffersDimensions(int w, int h); 988f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian virtual int setBuffersFormat(int format); 997734ebfe47f42f980c1b44c1f284a91d8ad1d6c7Mathias Agopian virtual int setScalingMode(int mode); 1008f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian virtual int setBuffersTransform(int transform); 1018f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian virtual int setBuffersTimestamp(int64_t timestamp); 1028f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian virtual int setCrop(Rect const* rect); 1038f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian virtual int setUsage(uint32_t reqUsage); 1048f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian virtual int lock(ANativeWindow_Buffer* outBuffer, ARect* inOutDirtyBounds); 1058f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian virtual int unlockAndPost(); 1067a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian 107b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam enum { MIN_UNDEQUEUED_BUFFERS = BufferQueue::MIN_UNDEQUEUED_BUFFERS }; 108b267579ba8dfe3f47d2a481c5a3c2254e3d565a1Daniel Lam enum { NUM_BUFFER_SLOTS = BufferQueue::NUM_BUFFER_SLOTS }; 1098ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis enum { DEFAULT_FORMAT = PIXEL_FORMAT_RGBA_8888 }; 1108ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 1118f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopianprivate: 1128f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian void freeAllBuffers(); 1138f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian int getSlotFromBufferLocked(android_native_buffer_t* buffer) const; 1148f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian 1158ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // mSurfaceTexture is the interface to the surface texture server. All 1168ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // operations on the surface texture client ultimately translate into 1178ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // interactions with the server using this interface. 1188ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis sp<ISurfaceTexture> mSurfaceTexture; 1198ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 1208ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // mSlots stores the buffers that have been allocated for each buffer slot. 1218ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // It is initialized to null pointers, and gets filled in with the result of 1228ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // ISurfaceTexture::requestBuffer when the client dequeues a buffer from a 1238ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // slot that has not yet been used. The buffer allocated to a slot will also 1248ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // be replaced if the requested buffer usage or geometry differs from that 1258ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // of the buffer allocated to a slot. 1268ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis sp<GraphicBuffer> mSlots[NUM_BUFFER_SLOTS]; 1278ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 1288ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // mReqWidth is the buffer width that will be requested at the next dequeue 1298ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // operation. It is initialized to 1. 1308ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis uint32_t mReqWidth; 1318ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 1328ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // mReqHeight is the buffer height that will be requested at the next deuque 1338ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // operation. It is initialized to 1. 1348ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis uint32_t mReqHeight; 1358ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 1368ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // mReqFormat is the buffer pixel format that will be requested at the next 1378ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // deuque operation. It is initialized to PIXEL_FORMAT_RGBA_8888. 1388ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis uint32_t mReqFormat; 1398ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 1408ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // mReqUsage is the set of buffer usage flags that will be requested 1418ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // at the next deuque operation. It is initialized to 0. 1428ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis uint32_t mReqUsage; 1438ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 1441d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala // mTimestamp is the timestamp that will be used for the next buffer queue 1451d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala // operation. It defaults to NATIVE_WINDOW_TIMESTAMP_AUTO, which means that 1461d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala // a timestamp is auto-generated when queueBuffer is called. 1471d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala int64_t mTimestamp; 1481d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala 14997c602c5af5f3ffd69009bf496d86347b71a2b4cMathias Agopian // mDefaultWidth is default width of the window, regardless of the 1503fbce7c56082e4e0d23f1c1c89983d3841853ed7Mathias Agopian // native_window_set_buffers_dimensions call 15197c602c5af5f3ffd69009bf496d86347b71a2b4cMathias Agopian uint32_t mDefaultWidth; 15297c602c5af5f3ffd69009bf496d86347b71a2b4cMathias Agopian 15397c602c5af5f3ffd69009bf496d86347b71a2b4cMathias Agopian // mDefaultHeight is default width of the window, regardless of the 1543fbce7c56082e4e0d23f1c1c89983d3841853ed7Mathias Agopian // native_window_set_buffers_dimensions call 15597c602c5af5f3ffd69009bf496d86347b71a2b4cMathias Agopian uint32_t mDefaultHeight; 15697c602c5af5f3ffd69009bf496d86347b71a2b4cMathias Agopian 15797c602c5af5f3ffd69009bf496d86347b71a2b4cMathias Agopian // mTransformHint is the transform probably applied to buffers of this 15897c602c5af5f3ffd69009bf496d86347b71a2b4cMathias Agopian // window. this is only a hint, actual transform may differ. 15997c602c5af5f3ffd69009bf496d86347b71a2b4cMathias Agopian uint32_t mTransformHint; 16097c602c5af5f3ffd69009bf496d86347b71a2b4cMathias Agopian 1618ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // mMutex is the mutex used to prevent concurrent access to the member 1628ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // variables of SurfaceTexture objects. It must be locked whenever the 1638ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // member variables are accessed. 1647a042bf324fe3f3d5d4085fda21fe50dc0c362b4Mathias Agopian mutable Mutex mMutex; 1658f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian 1668f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian // must be used from the lock/unlock thread 1678f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian sp<GraphicBuffer> mLockedBuffer; 1688f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian sp<GraphicBuffer> mPostedBuffer; 1698f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian mutable Region mOldDirtyRegion; 1708f9dbf9e13b927de2524116c30544f7dfbbbf56cMathias Agopian bool mConnectedToCpu; 1718ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis}; 1728ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 1738ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis}; // namespace android 1748ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 1758ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#endif // ANDROID_GUI_SURFACETEXTURECLIENT_H 176