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