Surface.h revision 399184a4cd728ea1421fb0bc1722274a29e38f4a 
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/BufferQueue.h>
22
23#include <ui/ANativeObjectBase.h>
24#include <ui/Region.h>
25
26#include <utils/RefBase.h>
27#include <utils/threads.h>
28#include <utils/KeyedVector.h>
29
30struct ANativeWindow_Buffer;
31
32namespace android {
33
34/*
35 * An implementation of ANativeWindow that feeds graphics buffers into a
36 * BufferQueue.
37 *
38 * This is typically used by programs that want to render frames through
39 * some means (maybe OpenGL, a software renderer, or a hardware decoder)
40 * and have the frames they create forwarded to SurfaceFlinger for
41 * compositing.  For example, a video decoder could render a frame and call
42 * eglSwapBuffers(), which invokes ANativeWindow callbacks defined by
43 * Surface.  Surface then forwards the buffers through Binder IPC
44 * to the BufferQueue's producer interface, providing the new frame to a
45 * consumer such as GLConsumer.
46 */
47class Surface
48    : public ANativeObjectBase<ANativeWindow, Surface, RefBase>
49{
50public:
51
52    /*
53     * creates a Surface from the given IGraphicBufferProducer (which concrete
54     * implementation is a BufferQueue).
55     *
56     * Surface is mainly state-less while it's disconnected, it can be
57     * viewed as a glorified IGraphicBufferProducer holder. It's therefore
58     * safe to create other Surfaces from the same IGraphicBufferProducer.
59     *
60     * However, once a Surface is connected, it'll prevent other Surfaces
61     * referring to the same IGraphicBufferProducer to become connected and
62     * therefore prevent them to be used as actual producers of buffers.
63     *
64     * the controlledByApp flag indicates that this Surface (producer) is
65     * controlled by the application. This flag is used at connect time.
66     */
67    Surface(const sp<IGraphicBufferProducer>& bufferProducer, bool controlledByApp = false);
68
69    /* getIGraphicBufferProducer() returns the IGraphicBufferProducer this
70     * Surface was created with. Usually it's an error to use the
71     * IGraphicBufferProducer while the Surface is connected.
72     */
73    sp<IGraphicBufferProducer> getIGraphicBufferProducer() const;
74
75    /* convenience function to check that the given surface is non NULL as
76     * well as its IGraphicBufferProducer */
77    static bool isValid(const sp<Surface>& surface) {
78        return surface != NULL && surface->getIGraphicBufferProducer() != NULL;
79    }
80
81    /* Attaches a sideband buffer stream to the Surface's IGraphicBufferProducer.
82     *
83     * A sideband stream is a device-specific mechanism for passing buffers
84     * from the producer to the consumer without using dequeueBuffer/
85     * queueBuffer. If a sideband stream is present, the consumer can choose
86     * whether to acquire buffers from the sideband stream or from the queued
87     * buffers.
88     *
89     * Passing NULL or a different stream handle will detach the previous
90     * handle if any.
91     */
92    void setSidebandStream(const sp<NativeHandle>& stream);
93
94protected:
95    virtual ~Surface();
96
97private:
98    // can't be copied
99    Surface& operator = (const Surface& rhs);
100    Surface(const Surface& rhs);
101
102    // ANativeWindow hooks
103    static int hook_cancelBuffer(ANativeWindow* window,
104            ANativeWindowBuffer* buffer, int fenceFd);
105    static int hook_dequeueBuffer(ANativeWindow* window,
106            ANativeWindowBuffer** buffer, int* fenceFd);
107    static int hook_perform(ANativeWindow* window, int operation, ...);
108    static int hook_query(const ANativeWindow* window, int what, int* value);
109    static int hook_queueBuffer(ANativeWindow* window,
110            ANativeWindowBuffer* buffer, int fenceFd);
111    static int hook_setSwapInterval(ANativeWindow* window, int interval);
112
113    static int hook_cancelBuffer_DEPRECATED(ANativeWindow* window,
114            ANativeWindowBuffer* buffer);
115    static int hook_dequeueBuffer_DEPRECATED(ANativeWindow* window,
116            ANativeWindowBuffer** buffer);
117    static int hook_lockBuffer_DEPRECATED(ANativeWindow* window,
118            ANativeWindowBuffer* buffer);
119    static int hook_queueBuffer_DEPRECATED(ANativeWindow* window,
120            ANativeWindowBuffer* buffer);
121
122    int dispatchConnect(va_list args);
123    int dispatchDisconnect(va_list args);
124    int dispatchSetBufferCount(va_list args);
125    int dispatchSetBuffersGeometry(va_list args);
126    int dispatchSetBuffersDimensions(va_list args);
127    int dispatchSetBuffersUserDimensions(va_list args);
128    int dispatchSetBuffersFormat(va_list args);
129    int dispatchSetScalingMode(va_list args);
130    int dispatchSetBuffersTransform(va_list args);
131    int dispatchSetBuffersTimestamp(va_list args);
132    int dispatchSetCrop(va_list args);
133    int dispatchSetPostTransformCrop(va_list args);
134    int dispatchSetUsage(va_list args);
135    int dispatchLock(va_list args);
136    int dispatchUnlockAndPost(va_list args);
137
138protected:
139    virtual int dequeueBuffer(ANativeWindowBuffer** buffer, int* fenceFd);
140    virtual int cancelBuffer(ANativeWindowBuffer* buffer, int fenceFd);
141    virtual int queueBuffer(ANativeWindowBuffer* buffer, int fenceFd);
142    virtual int perform(int operation, va_list args);
143    virtual int query(int what, int* value) const;
144    virtual int setSwapInterval(int interval);
145
146    virtual int lockBuffer_DEPRECATED(ANativeWindowBuffer* buffer);
147
148    virtual int connect(int api);
149    virtual int disconnect(int api);
150    virtual int setBufferCount(int bufferCount);
151    virtual int setBuffersDimensions(int w, int h);
152    virtual int setBuffersUserDimensions(int w, int h);
153    virtual int setBuffersFormat(int format);
154    virtual int setScalingMode(int mode);
155    virtual int setBuffersTransform(int transform);
156    virtual int setBuffersTimestamp(int64_t timestamp);
157    virtual int setCrop(Rect const* rect);
158    virtual int setUsage(uint32_t reqUsage);
159
160public:
161    virtual int lock(ANativeWindow_Buffer* outBuffer, ARect* inOutDirtyBounds);
162    virtual int unlockAndPost();
163
164protected:
165    enum { NUM_BUFFER_SLOTS = BufferQueue::NUM_BUFFER_SLOTS };
166    enum { DEFAULT_FORMAT = PIXEL_FORMAT_RGBA_8888 };
167
168private:
169    void freeAllBuffers();
170    int getSlotFromBufferLocked(android_native_buffer_t* buffer) const;
171
172    struct BufferSlot {
173        sp<GraphicBuffer> buffer;
174        Region dirtyRegion;
175    };
176
177    // mSurfaceTexture is the interface to the surface texture server. All
178    // operations on the surface texture client ultimately translate into
179    // interactions with the server using this interface.
180    // TODO: rename to mBufferProducer
181    sp<IGraphicBufferProducer> mGraphicBufferProducer;
182
183    // mSlots stores the buffers that have been allocated for each buffer slot.
184    // It is initialized to null pointers, and gets filled in with the result of
185    // IGraphicBufferProducer::requestBuffer when the client dequeues a buffer from a
186    // slot that has not yet been used. The buffer allocated to a slot will also
187    // be replaced if the requested buffer usage or geometry differs from that
188    // of the buffer allocated to a slot.
189    BufferSlot mSlots[NUM_BUFFER_SLOTS];
190
191    // mReqWidth is the buffer width that will be requested at the next dequeue
192    // operation. It is initialized to 1.
193    uint32_t mReqWidth;
194
195    // mReqHeight is the buffer height that will be requested at the next
196    // dequeue operation. It is initialized to 1.
197    uint32_t mReqHeight;
198
199    // mReqFormat is the buffer pixel format that will be requested at the next
200    // deuque operation. It is initialized to PIXEL_FORMAT_RGBA_8888.
201    uint32_t mReqFormat;
202
203    // mReqUsage is the set of buffer usage flags that will be requested
204    // at the next deuque operation. It is initialized to 0.
205    uint32_t mReqUsage;
206
207    // mTimestamp is the timestamp that will be used for the next buffer queue
208    // operation. It defaults to NATIVE_WINDOW_TIMESTAMP_AUTO, which means that
209    // a timestamp is auto-generated when queueBuffer is called.
210    int64_t mTimestamp;
211
212    // mCrop is the crop rectangle that will be used for the next buffer
213    // that gets queued. It is set by calling setCrop.
214    Rect mCrop;
215
216    // mScalingMode is the scaling mode that will be used for the next
217    // buffers that get queued. It is set by calling setScalingMode.
218    int mScalingMode;
219
220    // mTransform is the transform identifier that will be used for the next
221    // buffer that gets queued. It is set by calling setTransform.
222    uint32_t mTransform;
223
224     // mDefaultWidth is default width of the buffers, regardless of the
225     // native_window_set_buffers_dimensions call.
226     uint32_t mDefaultWidth;
227
228     // mDefaultHeight is default height of the buffers, regardless of the
229     // native_window_set_buffers_dimensions call.
230     uint32_t mDefaultHeight;
231
232     // mUserWidth, if non-zero, is an application-specified override
233     // of mDefaultWidth.  This is lower priority than the width set by
234     // native_window_set_buffers_dimensions.
235     uint32_t mUserWidth;
236
237     // mUserHeight, if non-zero, is an application-specified override
238     // of mDefaultHeight.  This is lower priority than the height set
239     // by native_window_set_buffers_dimensions.
240     uint32_t mUserHeight;
241
242    // mTransformHint is the transform probably applied to buffers of this
243    // window. this is only a hint, actual transform may differ.
244    uint32_t mTransformHint;
245
246    // mProducerControlledByApp whether this buffer producer is controlled
247    // by the application
248    bool mProducerControlledByApp;
249
250    // mSwapIntervalZero set if we should drop buffers at queue() time to
251    // achieve an asynchronous swap interval
252    bool mSwapIntervalZero;
253
254    // mConsumerRunningBehind whether the consumer is running more than
255    // one buffer behind the producer.
256    mutable bool mConsumerRunningBehind;
257
258    // mMutex is the mutex used to prevent concurrent access to the member
259    // variables of Surface objects. It must be locked whenever the
260    // member variables are accessed.
261    mutable Mutex mMutex;
262
263    // must be used from the lock/unlock thread
264    sp<GraphicBuffer>           mLockedBuffer;
265    sp<GraphicBuffer>           mPostedBuffer;
266    bool                        mConnectedToCpu;
267
268    // must be accessed from lock/unlock thread only
269    Region mDirtyRegion;
270};
271
272}; // namespace android
273
274#endif  // ANDROID_GUI_SURFACE_H
275