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