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