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