Surface.h revision f25c5086cf46eb029d887f34f25a09220e44958c 
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_SURFACE_H
18#define ANDROID_GUI_SURFACE_H
19
20#include <gui/IGraphicBufferProducer.h>
21#include <gui/GLConsumer.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
35/*
36 * An implementation of ANativeWindow that feeds graphics buffers into a
37 * BufferQueue.
38 *
39 * This is typically used by programs that want to render frames through
40 * some means (maybe OpenGL, a software renderer, or a hardware decoder)
41 * and have the frames they create forwarded to SurfaceFlinger for
42 * compositing.  For example, a video decoder could render a frame and call
43 * eglSwapBuffers(), which invokes ANativeWindow callbacks defined by
44 * Surface.  Surface then forwards the buffers through Binder IPC
45 * to the BufferQueue's producer interface, providing the new frame to a
46 * consumer such as GLConsumer.
47 */
48class Surface
49    : public ANativeObjectBase<ANativeWindow, Surface, RefBase>
50{
51public:
52
53    Surface(const sp<IGraphicBufferProducer>& bufferProducer);
54
55    sp<IGraphicBufferProducer> getIGraphicBufferProducer() const;
56
57    static status_t writeToParcel(const sp<Surface>& surface, Parcel* parcel);
58    static sp<Surface> readFromParcel(const Parcel& data);
59
60    bool isValid(const sp<Surface>& surface) const {
61        return surface != NULL && surface->getIGraphicBufferProducer() != NULL;
62    }
63
64    // FIXME: temporary for source compatibility...
65    sp<IGraphicBufferProducer> getISurfaceTexture() const {
66        return getIGraphicBufferProducer();
67    }
68
69protected:
70    Surface();
71    virtual ~Surface();
72    void setIGraphicBufferProducer(const sp<IGraphicBufferProducer>& bufferProducer);
73
74private:
75    // can't be copied
76    Surface& operator = (const Surface& rhs);
77    Surface(const Surface& rhs);
78    void init();
79
80    // ANativeWindow hooks
81    static int hook_cancelBuffer(ANativeWindow* window,
82            ANativeWindowBuffer* buffer, int fenceFd);
83    static int hook_dequeueBuffer(ANativeWindow* window,
84            ANativeWindowBuffer** buffer, int* fenceFd);
85    static int hook_perform(ANativeWindow* window, int operation, ...);
86    static int hook_query(const ANativeWindow* window, int what, int* value);
87    static int hook_queueBuffer(ANativeWindow* window,
88            ANativeWindowBuffer* buffer, int fenceFd);
89    static int hook_setSwapInterval(ANativeWindow* window, int interval);
90
91    static int hook_cancelBuffer_DEPRECATED(ANativeWindow* window,
92            ANativeWindowBuffer* buffer);
93    static int hook_dequeueBuffer_DEPRECATED(ANativeWindow* window,
94            ANativeWindowBuffer** buffer);
95    static int hook_lockBuffer_DEPRECATED(ANativeWindow* window,
96            ANativeWindowBuffer* buffer);
97    static int hook_queueBuffer_DEPRECATED(ANativeWindow* window,
98            ANativeWindowBuffer* buffer);
99
100    int dispatchConnect(va_list args);
101    int dispatchDisconnect(va_list args);
102    int dispatchSetBufferCount(va_list args);
103    int dispatchSetBuffersGeometry(va_list args);
104    int dispatchSetBuffersDimensions(va_list args);
105    int dispatchSetBuffersUserDimensions(va_list args);
106    int dispatchSetBuffersFormat(va_list args);
107    int dispatchSetScalingMode(va_list args);
108    int dispatchSetBuffersTransform(va_list args);
109    int dispatchSetBuffersTimestamp(va_list args);
110    int dispatchSetCrop(va_list args);
111    int dispatchSetPostTransformCrop(va_list args);
112    int dispatchSetUsage(va_list args);
113    int dispatchLock(va_list args);
114    int dispatchUnlockAndPost(va_list args);
115
116protected:
117    virtual int dequeueBuffer(ANativeWindowBuffer** buffer, int* fenceFd);
118    virtual int cancelBuffer(ANativeWindowBuffer* buffer, int fenceFd);
119    virtual int queueBuffer(ANativeWindowBuffer* buffer, int fenceFd);
120    virtual int perform(int operation, va_list args);
121    virtual int query(int what, int* value) const;
122    virtual int setSwapInterval(int interval);
123
124    virtual int lockBuffer_DEPRECATED(ANativeWindowBuffer* buffer);
125
126    virtual int connect(int api);
127    virtual int disconnect(int api);
128    virtual int setBufferCount(int bufferCount);
129    virtual int setBuffersDimensions(int w, int h);
130    virtual int setBuffersUserDimensions(int w, int h);
131    virtual int setBuffersFormat(int format);
132    virtual int setScalingMode(int mode);
133    virtual int setBuffersTransform(int transform);
134    virtual int setBuffersTimestamp(int64_t timestamp);
135    virtual int setCrop(Rect const* rect);
136    virtual int setUsage(uint32_t reqUsage);
137
138public:
139    virtual int lock(ANativeWindow_Buffer* outBuffer, ARect* inOutDirtyBounds);
140    virtual int unlockAndPost();
141
142protected:
143    enum { NUM_BUFFER_SLOTS = BufferQueue::NUM_BUFFER_SLOTS };
144    enum { DEFAULT_FORMAT = PIXEL_FORMAT_RGBA_8888 };
145
146private:
147    void freeAllBuffers();
148    int getSlotFromBufferLocked(android_native_buffer_t* buffer) const;
149
150    struct BufferSlot {
151        sp<GraphicBuffer> buffer;
152        Region dirtyRegion;
153    };
154
155    // mSurfaceTexture is the interface to the surface texture server. All
156    // operations on the surface texture client ultimately translate into
157    // interactions with the server using this interface.
158    // TODO: rename to mBufferProducer
159    sp<IGraphicBufferProducer> mGraphicBufferProducer;
160
161    // mSlots stores the buffers that have been allocated for each buffer slot.
162    // It is initialized to null pointers, and gets filled in with the result of
163    // IGraphicBufferProducer::requestBuffer when the client dequeues a buffer from a
164    // slot that has not yet been used. The buffer allocated to a slot will also
165    // be replaced if the requested buffer usage or geometry differs from that
166    // of the buffer allocated to a slot.
167    BufferSlot mSlots[NUM_BUFFER_SLOTS];
168
169    // mReqWidth is the buffer width that will be requested at the next dequeue
170    // operation. It is initialized to 1.
171    uint32_t mReqWidth;
172
173    // mReqHeight is the buffer height that will be requested at the next
174    // dequeue operation. It is initialized to 1.
175    uint32_t mReqHeight;
176
177    // mReqFormat is the buffer pixel format that will be requested at the next
178    // deuque operation. It is initialized to PIXEL_FORMAT_RGBA_8888.
179    uint32_t mReqFormat;
180
181    // mReqUsage is the set of buffer usage flags that will be requested
182    // at the next deuque operation. It is initialized to 0.
183    uint32_t mReqUsage;
184
185    // mTimestamp is the timestamp that will be used for the next buffer queue
186    // operation. It defaults to NATIVE_WINDOW_TIMESTAMP_AUTO, which means that
187    // a timestamp is auto-generated when queueBuffer is called.
188    int64_t mTimestamp;
189
190    // mCrop is the crop rectangle that will be used for the next buffer
191    // that gets queued. It is set by calling setCrop.
192    Rect mCrop;
193
194    // mScalingMode is the scaling mode that will be used for the next
195    // buffers that get queued. It is set by calling setScalingMode.
196    int mScalingMode;
197
198    // mTransform is the transform identifier that will be used for the next
199    // buffer that gets queued. It is set by calling setTransform.
200    uint32_t mTransform;
201
202     // mDefaultWidth is default width of the buffers, regardless of the
203     // native_window_set_buffers_dimensions call.
204     uint32_t mDefaultWidth;
205
206     // mDefaultHeight is default height of the buffers, regardless of the
207     // native_window_set_buffers_dimensions call.
208     uint32_t mDefaultHeight;
209
210     // mUserWidth, if non-zero, is an application-specified override
211     // of mDefaultWidth.  This is lower priority than the width set by
212     // native_window_set_buffers_dimensions.
213     uint32_t mUserWidth;
214
215     // mUserHeight, if non-zero, is an application-specified override
216     // of mDefaultHeight.  This is lower priority than the height set
217     // by native_window_set_buffers_dimensions.
218     uint32_t mUserHeight;
219
220    // mTransformHint is the transform probably applied to buffers of this
221    // window. this is only a hint, actual transform may differ.
222    uint32_t mTransformHint;
223
224    // mConsumerRunningBehind whether the consumer is running more than
225    // one buffer behind the producer.
226    mutable bool mConsumerRunningBehind;
227
228    // mMutex is the mutex used to prevent concurrent access to the member
229    // variables of Surface objects. It must be locked whenever the
230    // member variables are accessed.
231    mutable Mutex mMutex;
232
233    // must be used from the lock/unlock thread
234    sp<GraphicBuffer>           mLockedBuffer;
235    sp<GraphicBuffer>           mPostedBuffer;
236    bool                        mConnectedToCpu;
237
238    // must be accessed from lock/unlock thread only
239    Region mDirtyRegion;
240};
241
242}; // namespace android
243
244#endif  // ANDROID_GUI_SURFACE_H
245