ISurfaceTexture.h revision efc7ab6dcea8c22ddd7c0259ef4ab4bbf1e93044
1/* 2 * Copyright (C) 2010 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17#ifndef ANDROID_GUI_ISURFACETEXTURE_H 18#define ANDROID_GUI_ISURFACETEXTURE_H 19 20#include <stdint.h> 21#include <sys/types.h> 22 23#include <utils/Errors.h> 24#include <utils/RefBase.h> 25 26#include <binder/IInterface.h> 27 28#include <ui/GraphicBuffer.h> 29#include <ui/Rect.h> 30 31namespace android { 32// ---------------------------------------------------------------------------- 33 34class SurfaceTextureClient; 35 36class ISurfaceTexture : public IInterface 37{ 38public: 39 DECLARE_META_INTERFACE(SurfaceTexture); 40 41protected: 42 friend class SurfaceTextureClient; 43 44 enum { 45 BUFFER_NEEDS_REALLOCATION = 0x1, 46 RELEASE_ALL_BUFFERS = 0x2, 47 }; 48 49 // requestBuffer requests a new buffer for the given index. The server (i.e. 50 // the ISurfaceTexture implementation) assigns the newly created buffer to 51 // the given slot index, and the client is expected to mirror the 52 // slot->buffer mapping so that it's not necessary to transfer a 53 // GraphicBuffer for every dequeue operation. 54 virtual status_t requestBuffer(int slot, sp<GraphicBuffer>* buf) = 0; 55 56 // setBufferCount sets the number of buffer slots available. Calling this 57 // will also cause all buffer slots to be emptied. The caller should empty 58 // its mirrored copy of the buffer slots when calling this method. 59 virtual status_t setBufferCount(int bufferCount) = 0; 60 61 // dequeueBuffer requests a new buffer slot for the client to use. Ownership 62 // of the slot is transfered to the client, meaning that the server will not 63 // use the contents of the buffer associated with that slot. The slot index 64 // returned may or may not contain a buffer. If the slot is empty the client 65 // should call requestBuffer to assign a new buffer to that slot. The client 66 // is expected to either call cancelBuffer on the dequeued slot or to fill 67 // in the contents of its associated buffer contents and call queueBuffer. 68 // If dequeueBuffer return BUFFER_NEEDS_REALLOCATION, the client is 69 // expected to call requestBuffer immediately. 70 virtual status_t dequeueBuffer(int *slot, uint32_t w, uint32_t h, 71 uint32_t format, uint32_t usage) = 0; 72 73 // queueBuffer indicates that the client has finished filling in the 74 // contents of the buffer associated with slot and transfers ownership of 75 // that slot back to the server. It is not valid to call queueBuffer on a 76 // slot that is not owned by the client or one for which a buffer associated 77 // via requestBuffer. In addition, a timestamp must be provided by the 78 // client for this buffer. The timestamp is measured in nanoseconds, and 79 // must be monotonically increasing. Its other properties (zero point, etc) 80 // are client-dependent, and should be documented by the client. 81 // 82 // outWidth, outHeight and outTransform are filled with the default width 83 // and height of the window and current transform applied to buffers, 84 // respectively. 85 86 // QueueBufferInput must be a POD structure 87 struct QueueBufferInput { 88 inline QueueBufferInput(int64_t timestamp, 89 const Rect& crop, int scalingMode, uint32_t transform, 90 const Rect& activeRect) 91 : timestamp(timestamp), crop(crop), scalingMode(scalingMode), 92 transform(transform), activeRect(activeRect) { } 93 inline void deflate(int64_t* outTimestamp, Rect* outCrop, 94 int* outScalingMode, uint32_t* outTransform, 95 Rect* outActiveRect) const { 96 *outTimestamp = timestamp; 97 *outCrop = crop; 98 *outScalingMode = scalingMode; 99 *outTransform = transform; 100 *outActiveRect = activeRect; 101 } 102 private: 103 int64_t timestamp; 104 Rect crop; 105 int scalingMode; 106 uint32_t transform; 107 Rect activeRect; 108 }; 109 110 // QueueBufferOutput must be a POD structure 111 struct QueueBufferOutput { 112 inline QueueBufferOutput() { } 113 inline void deflate(uint32_t* outWidth, 114 uint32_t* outHeight, 115 uint32_t* outTransformHint, 116 uint32_t* outNumPendingBuffers) const { 117 *outWidth = width; 118 *outHeight = height; 119 *outTransformHint = transformHint; 120 *outNumPendingBuffers = numPendingBuffers; 121 } 122 inline void inflate(uint32_t inWidth, uint32_t inHeight, 123 uint32_t inTransformHint, uint32_t inNumPendingBuffers) { 124 width = inWidth; 125 height = inHeight; 126 transformHint = inTransformHint; 127 numPendingBuffers = inNumPendingBuffers; 128 } 129 private: 130 uint32_t width; 131 uint32_t height; 132 uint32_t transformHint; 133 uint32_t numPendingBuffers; 134 }; 135 136 virtual status_t queueBuffer(int slot, 137 const QueueBufferInput& input, QueueBufferOutput* output) = 0; 138 139 // cancelBuffer indicates that the client does not wish to fill in the 140 // buffer associated with slot and transfers ownership of the slot back to 141 // the server. 142 virtual void cancelBuffer(int slot) = 0; 143 144 // query retrieves some information for this surface 145 // 'what' tokens allowed are that of android_natives.h 146 virtual int query(int what, int* value) = 0; 147 148 // setSynchronousMode set whether dequeueBuffer is synchronous or 149 // asynchronous. In synchronous mode, dequeueBuffer blocks until 150 // a buffer is available, the currently bound buffer can be dequeued and 151 // queued buffers will be retired in order. 152 // The default mode is asynchronous. 153 virtual status_t setSynchronousMode(bool enabled) = 0; 154 155 // connect attempts to connect a client API to the SurfaceTexture. This 156 // must be called before any other ISurfaceTexture methods are called except 157 // for getAllocator. 158 // 159 // This method will fail if the connect was previously called on the 160 // SurfaceTexture and no corresponding disconnect call was made. 161 // 162 // outWidth, outHeight and outTransform are filled with the default width 163 // and height of the window and current transform applied to buffers, 164 // respectively. 165 virtual status_t connect(int api, QueueBufferOutput* output) = 0; 166 167 // disconnect attempts to disconnect a client API from the SurfaceTexture. 168 // Calling this method will cause any subsequent calls to other 169 // ISurfaceTexture methods to fail except for getAllocator and connect. 170 // Successfully calling connect after this will allow the other methods to 171 // succeed again. 172 // 173 // This method will fail if the the SurfaceTexture is not currently 174 // connected to the specified client API. 175 virtual status_t disconnect(int api) = 0; 176}; 177 178// ---------------------------------------------------------------------------- 179 180class BnSurfaceTexture : public BnInterface<ISurfaceTexture> 181{ 182public: 183 virtual status_t onTransact( uint32_t code, 184 const Parcel& data, 185 Parcel* reply, 186 uint32_t flags = 0); 187}; 188 189// ---------------------------------------------------------------------------- 190}; // namespace android 191 192#endif // ANDROID_GUI_ISURFACETEXTURE_H 193