SurfaceTextureClient.h revision 1c4414091cfb93206067fb64eba445653739d40f
1dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project/* 2dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * Copyright (C) 2010 The Android Open Source Project 3dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * 4dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 5dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * you may not use this file except in compliance with the License. 6dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * You may obtain a copy of the License at 7dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * 8dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 9dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * 10dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 11dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 12dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * See the License for the specific language governing permissions and 14dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project * limitations under the License. 15dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project */ 16dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 17dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project#ifndef ANDROID_GUI_SURFACETEXTURECLIENT_H 18dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project#define ANDROID_GUI_SURFACETEXTURECLIENT_H 19dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 20dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project#include <gui/ISurfaceTexture.h> 21dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project#include <gui/SurfaceTexture.h> 22dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 23dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project#include <ui/egl/android_natives.h> 24dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 25dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project#include <utils/RefBase.h> 26dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project#include <utils/threads.h> 27dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 28dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Projectnamespace android { 29dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 30dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Projectclass Surface; 31dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 32dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Projectclass SurfaceTextureClient 33dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project : public EGLNativeBase<ANativeWindow, SurfaceTextureClient, RefBase> 34dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project{ 35dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Projectpublic: 36dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project SurfaceTextureClient(const sp<ISurfaceTexture>& surfaceTexture); 37dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 38dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project sp<ISurfaceTexture> getISurfaceTexture() const; 39dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 40dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Projectprivate: 41dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project friend class Surface; 42dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 43dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project // can't be copied 44dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project SurfaceTextureClient& operator = (const SurfaceTextureClient& rhs); 45dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project SurfaceTextureClient(const SurfaceTextureClient& rhs); 46dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 47dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project // ANativeWindow hooks 48dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project static int cancelBuffer(ANativeWindow* window, ANativeWindowBuffer* buffer); 49dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project static int dequeueBuffer(ANativeWindow* window, ANativeWindowBuffer** buffer); 50dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project static int lockBuffer(ANativeWindow* window, ANativeWindowBuffer* buffer); 51dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project static int perform(ANativeWindow* window, int operation, ...); 52dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project static int query(const ANativeWindow* window, int what, int* value); 53dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project static int queueBuffer(ANativeWindow* window, ANativeWindowBuffer* buffer); 54dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project static int setSwapInterval(ANativeWindow* window, int interval); 55dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 56dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int cancelBuffer(ANativeWindowBuffer* buffer); 57dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int dequeueBuffer(ANativeWindowBuffer** buffer); 58dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int lockBuffer(ANativeWindowBuffer* buffer); 59dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int perform(int operation, va_list args); 60dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int query(int what, int* value) const; 61dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int queueBuffer(ANativeWindowBuffer* buffer); 62dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int setSwapInterval(int interval); 63dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 64dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int dispatchConnect(va_list args); 65dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int dispatchDisconnect(va_list args); 66dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int dispatchSetBufferCount(va_list args); 67dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int dispatchSetBuffersGeometry(va_list args); 68dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int dispatchSetBuffersTransform(va_list args); 69dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int dispatchSetBuffersTimestamp(va_list args); 70dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int dispatchSetCrop(va_list args); 71dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int dispatchSetUsage(va_list args); 72dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 73dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int connect(int api); 74dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int disconnect(int api); 75dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int setBufferCount(int bufferCount); 76dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int setBuffersGeometry(int w, int h, int format); 77dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int setBuffersTransform(int transform); 78dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int setBuffersTimestamp(int64_t timestamp); 79dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int setCrop(Rect const* rect); 80dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int setUsage(uint32_t reqUsage); 81dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 82dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project void freeAllBuffers(); 83dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int getSlotFromBufferLocked(android_native_buffer_t* buffer) const; 84dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 85dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project int getConnectedApi() const; 86dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 87dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project enum { MIN_UNDEQUEUED_BUFFERS = SurfaceTexture::MIN_UNDEQUEUED_BUFFERS }; 88dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project enum { NUM_BUFFER_SLOTS = SurfaceTexture::NUM_BUFFER_SLOTS }; 89dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project enum { DEFAULT_FORMAT = PIXEL_FORMAT_RGBA_8888 }; 90dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 91dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project // mSurfaceTexture is the interface to the surface texture server. All 92dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project // operations on the surface texture client ultimately translate into 93dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project // interactions with the server using this interface. 94dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project sp<ISurfaceTexture> mSurfaceTexture; 95dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project 96dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project // mAllocator is the binder object that is referenced to prevent the 97dd7bc3319deb2b77c5d07a51b7d6cd7e11b5beb0The Android Open Source Project // dequeued buffers from being freed prematurely. 98 sp<IBinder> mAllocator; 99 100 // mSlots stores the buffers that have been allocated for each buffer slot. 101 // It is initialized to null pointers, and gets filled in with the result of 102 // ISurfaceTexture::requestBuffer when the client dequeues a buffer from a 103 // slot that has not yet been used. The buffer allocated to a slot will also 104 // be replaced if the requested buffer usage or geometry differs from that 105 // of the buffer allocated to a slot. 106 sp<GraphicBuffer> mSlots[NUM_BUFFER_SLOTS]; 107 108 // mReqWidth is the buffer width that will be requested at the next dequeue 109 // operation. It is initialized to 1. 110 uint32_t mReqWidth; 111 112 // mReqHeight is the buffer height that will be requested at the next deuque 113 // operation. It is initialized to 1. 114 uint32_t mReqHeight; 115 116 // mReqFormat is the buffer pixel format that will be requested at the next 117 // deuque operation. It is initialized to PIXEL_FORMAT_RGBA_8888. 118 uint32_t mReqFormat; 119 120 // mReqUsage is the set of buffer usage flags that will be requested 121 // at the next deuque operation. It is initialized to 0. 122 uint32_t mReqUsage; 123 124 // mTimestamp is the timestamp that will be used for the next buffer queue 125 // operation. It defaults to NATIVE_WINDOW_TIMESTAMP_AUTO, which means that 126 // a timestamp is auto-generated when queueBuffer is called. 127 int64_t mTimestamp; 128 129 // mConnectedApi holds the currently connected API to this surface 130 int mConnectedApi; 131 132 // mQueryWidth is the width returned by query(). It is set to width 133 // of the last dequeued buffer or to mReqWidth if no buffer was dequeued. 134 uint32_t mQueryWidth; 135 136 // mQueryHeight is the height returned by query(). It is set to height 137 // of the last dequeued buffer or to mReqHeight if no buffer was dequeued. 138 uint32_t mQueryHeight; 139 140 // mQueryFormat is the format returned by query(). It is set to the last 141 // dequeued format or to mReqFormat if no buffer was dequeued. 142 uint32_t mQueryFormat; 143 144 // mMutex is the mutex used to prevent concurrent access to the member 145 // variables of SurfaceTexture objects. It must be locked whenever the 146 // member variables are accessed. 147 mutable Mutex mMutex; 148}; 149 150}; // namespace android 151 152#endif // ANDROID_GUI_SURFACETEXTURECLIENT_H 153