IGraphicBufferProducer.h revision fe0a87b54654a1392650e7f1862df473287d8332
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_ISURFACETEXTURE_H 188ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#define ANDROID_GUI_ISURFACETEXTURE_H 198ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 208ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#include <stdint.h> 218ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#include <sys/types.h> 228ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 238ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#include <utils/Errors.h> 248ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#include <utils/RefBase.h> 258ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 268ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#include <binder/IInterface.h> 278ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 288ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#include <ui/GraphicBuffer.h> 298ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#include <ui/Rect.h> 308ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 318ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennisnamespace android { 328ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis// ---------------------------------------------------------------------------- 338ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 34eafabcdc1639fb96062d9e3c39b0ae27b0238ae1Mathias Agopianclass SurfaceTextureClient; 35eafabcdc1639fb96062d9e3c39b0ae27b0238ae1Mathias Agopian 368ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennisclass ISurfaceTexture : public IInterface 378ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis{ 388ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennispublic: 398ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis DECLARE_META_INTERFACE(SurfaceTexture); 408ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 41eafabcdc1639fb96062d9e3c39b0ae27b0238ae1Mathias Agopianprotected: 42eafabcdc1639fb96062d9e3c39b0ae27b0238ae1Mathias Agopian friend class SurfaceTextureClient; 43eafabcdc1639fb96062d9e3c39b0ae27b0238ae1Mathias Agopian 448072711307aa98ee5ee6f7369860ae38c3e19656Mathias Agopian enum { 458072711307aa98ee5ee6f7369860ae38c3e19656Mathias Agopian BUFFER_NEEDS_REALLOCATION = 0x1, 468072711307aa98ee5ee6f7369860ae38c3e19656Mathias Agopian RELEASE_ALL_BUFFERS = 0x2, 478072711307aa98ee5ee6f7369860ae38c3e19656Mathias Agopian }; 48a5c75c01620179ce00812354778a29a80d76e71fMathias Agopian 498ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // requestBuffer requests a new buffer for the given index. The server (i.e. 508ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // the ISurfaceTexture implementation) assigns the newly created buffer to 518ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // the given slot index, and the client is expected to mirror the 528ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // slot->buffer mapping so that it's not necessary to transfer a 538ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // GraphicBuffer for every dequeue operation. 54c04f153353cdb0d291297d10452239f791d3fd2bMathias Agopian virtual sp<GraphicBuffer> requestBuffer(int slot) = 0; 558ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 568ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // setBufferCount sets the number of buffer slots available. Calling this 578ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // will also cause all buffer slots to be emptied. The caller should empty 588ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // its mirrored copy of the buffer slots when calling this method. 598ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis virtual status_t setBufferCount(int bufferCount) = 0; 608ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 618ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // dequeueBuffer requests a new buffer slot for the client to use. Ownership 628ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // of the slot is transfered to the client, meaning that the server will not 638ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // use the contents of the buffer associated with that slot. The slot index 648ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // returned may or may not contain a buffer. If the slot is empty the client 658ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // should call requestBuffer to assign a new buffer to that slot. The client 668ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // is expected to either call cancelBuffer on the dequeued slot or to fill 678ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // in the contents of its associated buffer contents and call queueBuffer. 68a5c75c01620179ce00812354778a29a80d76e71fMathias Agopian // If dequeueBuffer return BUFFER_NEEDS_REALLOCATION, the client is 69a5c75c01620179ce00812354778a29a80d76e71fMathias Agopian // expected to call requestBuffer immediately. 70c04f153353cdb0d291297d10452239f791d3fd2bMathias Agopian virtual status_t dequeueBuffer(int *slot, uint32_t w, uint32_t h, 71c04f153353cdb0d291297d10452239f791d3fd2bMathias Agopian uint32_t format, uint32_t usage) = 0; 728ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 738ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // queueBuffer indicates that the client has finished filling in the 748ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // contents of the buffer associated with slot and transfers ownership of 758ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // that slot back to the server. It is not valid to call queueBuffer on a 768ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // slot that is not owned by the client or one for which a buffer associated 771d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala // via requestBuffer. In addition, a timestamp must be provided by the 781d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala // client for this buffer. The timestamp is measured in nanoseconds, and 791d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala // must be monotonically increasing. Its other properties (zero point, etc) 801d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala // are client-dependent, and should be documented by the client. 811d01a12e7150be569557b64da9b8663c62c13594Eino-Ville Talvala virtual status_t queueBuffer(int slot, int64_t timestamp) = 0; 828ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 838ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // cancelBuffer indicates that the client does not wish to fill in the 848ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // buffer associated with slot and transfers ownership of the slot back to 858ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis // the server. 868ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis virtual void cancelBuffer(int slot) = 0; 878ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 888ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis virtual status_t setCrop(const Rect& reg) = 0; 898ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis virtual status_t setTransform(uint32_t transform) = 0; 901b20cde313b5ef8acdace742328df867956d24cbJamie Gennis 911b20cde313b5ef8acdace742328df867956d24cbJamie Gennis // getAllocator retrieves the binder object that must be referenced as long 921b20cde313b5ef8acdace742328df867956d24cbJamie Gennis // as the GraphicBuffers dequeued from this ISurfaceTexture are referenced. 931b20cde313b5ef8acdace742328df867956d24cbJamie Gennis // Holding this binder reference prevents SurfaceFlinger from freeing the 941b20cde313b5ef8acdace742328df867956d24cbJamie Gennis // buffers before the client is done with them. 951b20cde313b5ef8acdace742328df867956d24cbJamie Gennis virtual sp<IBinder> getAllocator() = 0; 96eafabcdc1639fb96062d9e3c39b0ae27b0238ae1Mathias Agopian 97eafabcdc1639fb96062d9e3c39b0ae27b0238ae1Mathias Agopian // query retrieves some information for this surface 98eafabcdc1639fb96062d9e3c39b0ae27b0238ae1Mathias Agopian // 'what' tokens allowed are that of android_natives.h 99eafabcdc1639fb96062d9e3c39b0ae27b0238ae1Mathias Agopian virtual int query(int what, int* value) = 0; 1008072711307aa98ee5ee6f7369860ae38c3e19656Mathias Agopian 1018072711307aa98ee5ee6f7369860ae38c3e19656Mathias Agopian // setSynchronousMode set whether dequeueBuffer is synchronous or 1028072711307aa98ee5ee6f7369860ae38c3e19656Mathias Agopian // asynchronous. In synchronous mode, dequeueBuffer blocks until 1038072711307aa98ee5ee6f7369860ae38c3e19656Mathias Agopian // a buffer is available, the currently bound buffer can be dequeued and 1048072711307aa98ee5ee6f7369860ae38c3e19656Mathias Agopian // queued buffers will be retired in order. 1058072711307aa98ee5ee6f7369860ae38c3e19656Mathias Agopian // The default mode is asynchronous. 1068072711307aa98ee5ee6f7369860ae38c3e19656Mathias Agopian virtual status_t setSynchronousMode(bool enabled) = 0; 107fe0a87b54654a1392650e7f1862df473287d8332Jamie Gennis 108fe0a87b54654a1392650e7f1862df473287d8332Jamie Gennis // connect attempts to connect a client API to the SurfaceTexture. This 109fe0a87b54654a1392650e7f1862df473287d8332Jamie Gennis // must be called before any other ISurfaceTexture methods are called except 110fe0a87b54654a1392650e7f1862df473287d8332Jamie Gennis // for getAllocator. 111fe0a87b54654a1392650e7f1862df473287d8332Jamie Gennis // 112fe0a87b54654a1392650e7f1862df473287d8332Jamie Gennis // This method will fail if the connect was previously called on the 113fe0a87b54654a1392650e7f1862df473287d8332Jamie Gennis // SurfaceTexture and no corresponding disconnect call was made. 114fe0a87b54654a1392650e7f1862df473287d8332Jamie Gennis virtual status_t connect(int api) = 0; 115fe0a87b54654a1392650e7f1862df473287d8332Jamie Gennis 116fe0a87b54654a1392650e7f1862df473287d8332Jamie Gennis // disconnect attempts to disconnect a client API from the SurfaceTexture. 117fe0a87b54654a1392650e7f1862df473287d8332Jamie Gennis // Calling this method will cause any subsequent calls to other 118fe0a87b54654a1392650e7f1862df473287d8332Jamie Gennis // ISurfaceTexture methods to fail except for getAllocator and connect. 119fe0a87b54654a1392650e7f1862df473287d8332Jamie Gennis // Successfully calling connect after this will allow the other methods to 120fe0a87b54654a1392650e7f1862df473287d8332Jamie Gennis // succeed again. 121fe0a87b54654a1392650e7f1862df473287d8332Jamie Gennis // 122fe0a87b54654a1392650e7f1862df473287d8332Jamie Gennis // This method will fail if the the SurfaceTexture is not currently 123fe0a87b54654a1392650e7f1862df473287d8332Jamie Gennis // connected to the specified client API. 124fe0a87b54654a1392650e7f1862df473287d8332Jamie Gennis virtual status_t disconnect(int api) = 0; 1258ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis}; 1268ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 1278ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis// ---------------------------------------------------------------------------- 1288ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 1298ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennisclass BnSurfaceTexture : public BnInterface<ISurfaceTexture> 1308ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis{ 1318ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennispublic: 1328ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis virtual status_t onTransact( uint32_t code, 1338ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis const Parcel& data, 1348ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis Parcel* reply, 1358ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis uint32_t flags = 0); 1368ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis}; 1378ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 1388ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis// ---------------------------------------------------------------------------- 1398ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis}; // namespace android 1408ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis 1418ba32fade11abb73f3fd47ea0953c9528eb5b91fJamie Gennis#endif // ANDROID_GUI_ISURFACETEXTURE_H 142