ISurfaceTexture.h revision eafabcdc1639fb96062d9e3c39b0ae27b0238ae1 
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 { BUFFER_NEEDS_REALLOCATION = 1 };
45
46    // requestBuffer requests a new buffer for the given index. The server (i.e.
47    // the ISurfaceTexture implementation) assigns the newly created buffer to
48    // the given slot index, and the client is expected to mirror the
49    // slot->buffer mapping so that it's not necessary to transfer a
50    // GraphicBuffer for every dequeue operation.
51    virtual sp<GraphicBuffer> requestBuffer(int slot) = 0;
52
53    // setBufferCount sets the number of buffer slots available. Calling this
54    // will also cause all buffer slots to be emptied. The caller should empty
55    // its mirrored copy of the buffer slots when calling this method.
56    virtual status_t setBufferCount(int bufferCount) = 0;
57
58    // dequeueBuffer requests a new buffer slot for the client to use. Ownership
59    // of the slot is transfered to the client, meaning that the server will not
60    // use the contents of the buffer associated with that slot. The slot index
61    // returned may or may not contain a buffer. If the slot is empty the client
62    // should call requestBuffer to assign a new buffer to that slot. The client
63    // is expected to either call cancelBuffer on the dequeued slot or to fill
64    // in the contents of its associated buffer contents and call queueBuffer.
65    // If dequeueBuffer return BUFFER_NEEDS_REALLOCATION, the client is
66    // expected to call requestBuffer immediately.
67    virtual status_t dequeueBuffer(int *slot, uint32_t w, uint32_t h,
68            uint32_t format, uint32_t usage) = 0;
69
70    // queueBuffer indicates that the client has finished filling in the
71    // contents of the buffer associated with slot and transfers ownership of
72    // that slot back to the server. It is not valid to call queueBuffer on a
73    // slot that is not owned by the client or one for which a buffer associated
74    // via requestBuffer. In addition, a timestamp must be provided by the
75    // client for this buffer. The timestamp is measured in nanoseconds, and
76    // must be monotonically increasing. Its other properties (zero point, etc)
77    // are client-dependent, and should be documented by the client.
78    virtual status_t queueBuffer(int slot, int64_t timestamp) = 0;
79
80    // cancelBuffer indicates that the client does not wish to fill in the
81    // buffer associated with slot and transfers ownership of the slot back to
82    // the server.
83    virtual void cancelBuffer(int slot) = 0;
84
85    virtual status_t setCrop(const Rect& reg) = 0;
86    virtual status_t setTransform(uint32_t transform) = 0;
87
88    // getAllocator retrieves the binder object that must be referenced as long
89    // as the GraphicBuffers dequeued from this ISurfaceTexture are referenced.
90    // Holding this binder reference prevents SurfaceFlinger from freeing the
91    // buffers before the client is done with them.
92    virtual sp<IBinder> getAllocator() = 0;
93
94    // query retrieves some information for this surface
95    // 'what' tokens allowed are that of android_natives.h
96    virtual int query(int what, int* value) = 0;
97};
98
99// ----------------------------------------------------------------------------
100
101class BnSurfaceTexture : public BnInterface<ISurfaceTexture>
102{
103public:
104    virtual status_t    onTransact( uint32_t code,
105                                    const Parcel& data,
106                                    Parcel* reply,
107                                    uint32_t flags = 0);
108};
109
110// ----------------------------------------------------------------------------
111}; // namespace android
112
113#endif // ANDROID_GUI_ISURFACETEXTURE_H
114