SurfaceTextureClient.h revision 2488b20aec097accb20a853d9876bb0a5dc04636 
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_SURFACETEXTURECLIENT_H
18#define ANDROID_GUI_SURFACETEXTURECLIENT_H
19
20#include <gui/ISurfaceTexture.h>
21#include <gui/SurfaceTexture.h>
22#include <gui/BufferQueue.h>
23
24#include <ui/ANativeObjectBase.h>
25#include <ui/Region.h>
26
27#include <utils/RefBase.h>
28#include <utils/threads.h>
29#include <utils/KeyedVector.h>
30
31struct ANativeWindow_Buffer;
32
33namespace android {
34
35class Surface;
36
37class SurfaceTextureClient
38    : public ANativeObjectBase<ANativeWindow, SurfaceTextureClient, RefBase>
39{
40public:
41
42    SurfaceTextureClient(const sp<ISurfaceTexture>& surfaceTexture);
43
44    // SurfaceTextureClient is overloaded to assist in refactoring ST and BQ.
45    // SurfaceTexture is no longer an ISurfaceTexture, so client code
46    // calling the original constructor will fail. Thus this convenience method
47    // passes in the surfaceTexture's bufferQueue to the init method.
48    SurfaceTextureClient(const sp<SurfaceTexture>& surfaceTexture);
49
50    sp<ISurfaceTexture> getISurfaceTexture() const;
51
52protected:
53    SurfaceTextureClient();
54    virtual ~SurfaceTextureClient();
55    void setISurfaceTexture(const sp<ISurfaceTexture>& surfaceTexture);
56
57private:
58    // can't be copied
59    SurfaceTextureClient& operator = (const SurfaceTextureClient& rhs);
60    SurfaceTextureClient(const SurfaceTextureClient& rhs);
61    void init();
62
63    // ANativeWindow hooks
64    static int hook_cancelBuffer(ANativeWindow* window, ANativeWindowBuffer* buffer);
65    static int hook_dequeueBuffer(ANativeWindow* window, ANativeWindowBuffer** buffer);
66    static int hook_lockBuffer(ANativeWindow* window, ANativeWindowBuffer* buffer);
67    static int hook_perform(ANativeWindow* window, int operation, ...);
68    static int hook_query(const ANativeWindow* window, int what, int* value);
69    static int hook_queueBuffer(ANativeWindow* window, ANativeWindowBuffer* buffer);
70    static int hook_setSwapInterval(ANativeWindow* window, int interval);
71
72    int dispatchConnect(va_list args);
73    int dispatchDisconnect(va_list args);
74    int dispatchSetBufferCount(va_list args);
75    int dispatchSetBuffersGeometry(va_list args);
76    int dispatchSetBuffersDimensions(va_list args);
77    int dispatchSetBuffersUserDimensions(va_list args);
78    int dispatchSetBuffersFormat(va_list args);
79    int dispatchSetScalingMode(va_list args);
80    int dispatchSetBuffersTransform(va_list args);
81    int dispatchSetBuffersTimestamp(va_list args);
82    int dispatchSetCrop(va_list args);
83    int dispatchSetUsage(va_list args);
84    int dispatchLock(va_list args);
85    int dispatchUnlockAndPost(va_list args);
86
87protected:
88    virtual int cancelBuffer(ANativeWindowBuffer* buffer);
89    virtual int dequeueBuffer(ANativeWindowBuffer** buffer);
90    virtual int lockBuffer(ANativeWindowBuffer* buffer);
91    virtual int perform(int operation, va_list args);
92    virtual int query(int what, int* value) const;
93    virtual int queueBuffer(ANativeWindowBuffer* buffer);
94    virtual int setSwapInterval(int interval);
95
96    virtual int connect(int api);
97    virtual int disconnect(int api);
98    virtual int setBufferCount(int bufferCount);
99    virtual int setBuffersDimensions(int w, int h);
100    virtual int setBuffersUserDimensions(int w, int h);
101    virtual int setBuffersFormat(int format);
102    virtual int setScalingMode(int mode);
103    virtual int setBuffersTransform(int transform);
104    virtual int setBuffersTimestamp(int64_t timestamp);
105    virtual int setCrop(Rect const* rect);
106    virtual int setUsage(uint32_t reqUsage);
107    virtual int lock(ANativeWindow_Buffer* outBuffer, ARect* inOutDirtyBounds);
108    virtual int unlockAndPost();
109
110    enum { NUM_BUFFER_SLOTS = BufferQueue::NUM_BUFFER_SLOTS };
111    enum { DEFAULT_FORMAT = PIXEL_FORMAT_RGBA_8888 };
112
113private:
114    void freeAllBuffers();
115    int getSlotFromBufferLocked(android_native_buffer_t* buffer) const;
116
117    struct BufferSlot {
118        sp<GraphicBuffer> buffer;
119        Region dirtyRegion;
120    };
121
122    // mSurfaceTexture is the interface to the surface texture server. All
123    // operations on the surface texture client ultimately translate into
124    // interactions with the server using this interface.
125    sp<ISurfaceTexture> mSurfaceTexture;
126
127    // mSlots stores the buffers that have been allocated for each buffer slot.
128    // It is initialized to null pointers, and gets filled in with the result of
129    // ISurfaceTexture::requestBuffer when the client dequeues a buffer from a
130    // slot that has not yet been used. The buffer allocated to a slot will also
131    // be replaced if the requested buffer usage or geometry differs from that
132    // of the buffer allocated to a slot.
133    BufferSlot mSlots[NUM_BUFFER_SLOTS];
134
135    // mReqWidth is the buffer width that will be requested at the next dequeue
136    // operation. It is initialized to 1.
137    uint32_t mReqWidth;
138
139    // mReqHeight is the buffer height that will be requested at the next
140    // dequeue operation. It is initialized to 1.
141    uint32_t mReqHeight;
142
143    // mReqFormat is the buffer pixel format that will be requested at the next
144    // deuque operation. It is initialized to PIXEL_FORMAT_RGBA_8888.
145    uint32_t mReqFormat;
146
147    // mReqUsage is the set of buffer usage flags that will be requested
148    // at the next deuque operation. It is initialized to 0.
149    uint32_t mReqUsage;
150
151    // mTimestamp is the timestamp that will be used for the next buffer queue
152    // operation. It defaults to NATIVE_WINDOW_TIMESTAMP_AUTO, which means that
153    // a timestamp is auto-generated when queueBuffer is called.
154    int64_t mTimestamp;
155
156    // mCrop is the crop rectangle that will be used for the next buffer
157    // that gets queued. It is set by calling setCrop.
158    Rect mCrop;
159
160    // mScalingMode is the scaling mode that will be used for the next
161    // buffers that get queued. It is set by calling setScalingMode.
162    int mScalingMode;
163
164    // mTransform is the transform identifier that will be used for the next
165    // buffer that gets queued. It is set by calling setTransform.
166    uint32_t mTransform;
167
168     // mDefaultWidth is default width of the buffers, regardless of the
169     // native_window_set_buffers_dimensions call.
170     uint32_t mDefaultWidth;
171
172     // mDefaultHeight is default height of the buffers, regardless of the
173     // native_window_set_buffers_dimensions call.
174     uint32_t mDefaultHeight;
175
176     // mUserWidth, if non-zero, is an application-specified override
177     // of mDefaultWidth.  This is lower priority than the width set by
178     // native_window_set_buffers_dimensions.
179     uint32_t mUserWidth;
180
181     // mUserHeight, if non-zero, is an application-specified override
182     // of mDefaultHeight.  This is lower priority than the height set
183     // by native_window_set_buffers_dimensions.
184     uint32_t mUserHeight;
185
186    // mTransformHint is the transform probably applied to buffers of this
187    // window. this is only a hint, actual transform may differ.
188    uint32_t mTransformHint;
189
190    // mConsumerRunningBehind whether the consumer is running more than
191    // one buffer behind the producer.
192    mutable bool mConsumerRunningBehind;
193
194    // mMutex is the mutex used to prevent concurrent access to the member
195    // variables of SurfaceTexture objects. It must be locked whenever the
196    // member variables are accessed.
197    mutable Mutex mMutex;
198
199    // must be used from the lock/unlock thread
200    sp<GraphicBuffer>           mLockedBuffer;
201    sp<GraphicBuffer>           mPostedBuffer;
202    bool                        mConnectedToCpu;
203
204    // must be accessed from lock/unlock thread only
205    Region mDirtyRegion;
206};
207
208}; // namespace android
209
210#endif  // ANDROID_GUI_SURFACETEXTURECLIENT_H
211