ISurfaceTexture.h revision 1b20cde313b5ef8acdace742328df867956d24cb 
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 ISurfaceTexture : public IInterface
35{
36public:
37    DECLARE_META_INTERFACE(SurfaceTexture);
38
39    // requestBuffer requests a new buffer for the given index. The server (i.e.
40    // the ISurfaceTexture implementation) assigns the newly created buffer to
41    // the given slot index, and the client is expected to mirror the
42    // slot->buffer mapping so that it's not necessary to transfer a
43    // GraphicBuffer for every dequeue operation.
44    virtual sp<GraphicBuffer> requestBuffer(int slot, uint32_t w, uint32_t h,
45            uint32_t format, uint32_t usage) = 0;
46
47    // setBufferCount sets the number of buffer slots available. Calling this
48    // will also cause all buffer slots to be emptied. The caller should empty
49    // its mirrored copy of the buffer slots when calling this method.
50    virtual status_t setBufferCount(int bufferCount) = 0;
51
52    // dequeueBuffer requests a new buffer slot for the client to use. Ownership
53    // of the slot is transfered to the client, meaning that the server will not
54    // use the contents of the buffer associated with that slot. The slot index
55    // returned may or may not contain a buffer. If the slot is empty the client
56    // should call requestBuffer to assign a new buffer to that slot. The client
57    // is expected to either call cancelBuffer on the dequeued slot or to fill
58    // in the contents of its associated buffer contents and call queueBuffer.
59    virtual status_t dequeueBuffer(int *slot) = 0;
60
61    // queueBuffer indicates that the client has finished filling in the
62    // contents of the buffer associated with slot and transfers ownership of
63    // that slot back to the server. It is not valid to call queueBuffer on a
64    // slot that is not owned by the client or one for which a buffer associated
65    // via requestBuffer.
66    virtual status_t queueBuffer(int slot) = 0;
67
68    // cancelBuffer indicates that the client does not wish to fill in the
69    // buffer associated with slot and transfers ownership of the slot back to
70    // the server.
71    virtual void cancelBuffer(int slot) = 0;
72
73    virtual status_t setCrop(const Rect& reg) = 0;
74    virtual status_t setTransform(uint32_t transform) = 0;
75
76    // getAllocator retrieves the binder object that must be referenced as long
77    // as the GraphicBuffers dequeued from this ISurfaceTexture are referenced.
78    // Holding this binder reference prevents SurfaceFlinger from freeing the
79    // buffers before the client is done with them.
80    virtual sp<IBinder> getAllocator() = 0;
81};
82
83// ----------------------------------------------------------------------------
84
85class BnSurfaceTexture : public BnInterface<ISurfaceTexture>
86{
87public:
88    virtual status_t    onTransact( uint32_t code,
89                                    const Parcel& data,
90                                    Parcel* reply,
91                                    uint32_t flags = 0);
92};
93
94// ----------------------------------------------------------------------------
95}; // namespace android
96
97#endif // ANDROID_GUI_ISURFACETEXTURE_H
98