Surface.h revision a2ca9bf0a9789e9e5e37961ebfb356347f59309e 
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
94    /* Allocates buffers based on the current dimensions/format.
95     *
96     * This function will allocate up to the maximum number of buffers
97     * permitted by the current BufferQueue configuration. It will use the
98     * default format and dimensions. This is most useful to avoid an allocation
99     * delay during dequeueBuffer. If there are already the maximum number of
100     * buffers allocated, this function has no effect.
101     */
102    void allocateBuffers();
103
104    /* Sets the generation number on the IGraphicBufferProducer and updates the
105     * generation number on any buffers attached to the Surface after this call.
106     * See IGBP::setGenerationNumber for more information. */
107    status_t setGenerationNumber(uint32_t generationNumber);
108
109protected:
110    virtual ~Surface();
111
112private:
113    // can't be copied
114    Surface& operator = (const Surface& rhs);
115    Surface(const Surface& rhs);
116
117    // ANativeWindow hooks
118    static int hook_cancelBuffer(ANativeWindow* window,
119            ANativeWindowBuffer* buffer, int fenceFd);
120    static int hook_dequeueBuffer(ANativeWindow* window,
121            ANativeWindowBuffer** buffer, int* fenceFd);
122    static int hook_perform(ANativeWindow* window, int operation, ...);
123    static int hook_query(const ANativeWindow* window, int what, int* value);
124    static int hook_queueBuffer(ANativeWindow* window,
125            ANativeWindowBuffer* buffer, int fenceFd);
126    static int hook_setSwapInterval(ANativeWindow* window, int interval);
127
128    static int hook_cancelBuffer_DEPRECATED(ANativeWindow* window,
129            ANativeWindowBuffer* buffer);
130    static int hook_dequeueBuffer_DEPRECATED(ANativeWindow* window,
131            ANativeWindowBuffer** buffer);
132    static int hook_lockBuffer_DEPRECATED(ANativeWindow* window,
133            ANativeWindowBuffer* buffer);
134    static int hook_queueBuffer_DEPRECATED(ANativeWindow* window,
135            ANativeWindowBuffer* buffer);
136
137    int dispatchConnect(va_list args);
138    int dispatchDisconnect(va_list args);
139    int dispatchSetBufferCount(va_list args);
140    int dispatchSetBuffersGeometry(va_list args);
141    int dispatchSetBuffersDimensions(va_list args);
142    int dispatchSetBuffersUserDimensions(va_list args);
143    int dispatchSetBuffersFormat(va_list args);
144    int dispatchSetScalingMode(va_list args);
145    int dispatchSetBuffersTransform(va_list args);
146    int dispatchSetBuffersStickyTransform(va_list args);
147    int dispatchSetBuffersTimestamp(va_list args);
148    int dispatchSetCrop(va_list args);
149    int dispatchSetPostTransformCrop(va_list args);
150    int dispatchSetUsage(va_list args);
151    int dispatchLock(va_list args);
152    int dispatchUnlockAndPost(va_list args);
153    int dispatchSetSidebandStream(va_list args);
154    int dispatchSetBuffersDataSpace(va_list args);
155    int dispatchSetSurfaceDamage(va_list args);
156
157protected:
158    virtual int dequeueBuffer(ANativeWindowBuffer** buffer, int* fenceFd);
159    virtual int cancelBuffer(ANativeWindowBuffer* buffer, int fenceFd);
160    virtual int queueBuffer(ANativeWindowBuffer* buffer, int fenceFd);
161    virtual int perform(int operation, va_list args);
162    virtual int query(int what, int* value) const;
163    virtual int setSwapInterval(int interval);
164
165    virtual int lockBuffer_DEPRECATED(ANativeWindowBuffer* buffer);
166
167    virtual int connect(int api);
168    virtual int disconnect(int api);
169    virtual int setBufferCount(int bufferCount);
170    virtual int setBuffersDimensions(uint32_t width, uint32_t height);
171    virtual int setBuffersUserDimensions(uint32_t width, uint32_t height);
172    virtual int setBuffersFormat(PixelFormat format);
173    virtual int setScalingMode(int mode);
174    virtual int setBuffersTransform(uint32_t transform);
175    virtual int setBuffersStickyTransform(uint32_t transform);
176    virtual int setBuffersTimestamp(int64_t timestamp);
177    virtual int setBuffersDataSpace(android_dataspace dataSpace);
178    virtual int setCrop(Rect const* rect);
179    virtual int setUsage(uint32_t reqUsage);
180    virtual void setSurfaceDamage(android_native_rect_t* rects, size_t numRects);
181
182public:
183    virtual int lock(ANativeWindow_Buffer* outBuffer, ARect* inOutDirtyBounds);
184    virtual int unlockAndPost();
185
186    virtual int connect(int api, const sp<IProducerListener>& listener);
187    virtual int detachNextBuffer(sp<GraphicBuffer>* outBuffer,
188            sp<Fence>* outFence);
189    virtual int attachBuffer(ANativeWindowBuffer*);
190
191protected:
192    enum { NUM_BUFFER_SLOTS = BufferQueue::NUM_BUFFER_SLOTS };
193    enum { DEFAULT_FORMAT = PIXEL_FORMAT_RGBA_8888 };
194
195private:
196    void freeAllBuffers();
197    int getSlotFromBufferLocked(android_native_buffer_t* buffer) const;
198
199    struct BufferSlot {
200        sp<GraphicBuffer> buffer;
201        Region dirtyRegion;
202    };
203
204    // mSurfaceTexture is the interface to the surface texture server. All
205    // operations on the surface texture client ultimately translate into
206    // interactions with the server using this interface.
207    // TODO: rename to mBufferProducer
208    sp<IGraphicBufferProducer> mGraphicBufferProducer;
209
210    // mSlots stores the buffers that have been allocated for each buffer slot.
211    // It is initialized to null pointers, and gets filled in with the result of
212    // IGraphicBufferProducer::requestBuffer when the client dequeues a buffer from a
213    // slot that has not yet been used. The buffer allocated to a slot will also
214    // be replaced if the requested buffer usage or geometry differs from that
215    // of the buffer allocated to a slot.
216    BufferSlot mSlots[NUM_BUFFER_SLOTS];
217
218    // mReqWidth is the buffer width that will be requested at the next dequeue
219    // operation. It is initialized to 1.
220    uint32_t mReqWidth;
221
222    // mReqHeight is the buffer height that will be requested at the next
223    // dequeue operation. It is initialized to 1.
224    uint32_t mReqHeight;
225
226    // mReqFormat is the buffer pixel format that will be requested at the next
227    // deuque operation. It is initialized to PIXEL_FORMAT_RGBA_8888.
228    PixelFormat mReqFormat;
229
230    // mReqUsage is the set of buffer usage flags that will be requested
231    // at the next deuque operation. It is initialized to 0.
232    uint32_t mReqUsage;
233
234    // mTimestamp is the timestamp that will be used for the next buffer queue
235    // operation. It defaults to NATIVE_WINDOW_TIMESTAMP_AUTO, which means that
236    // a timestamp is auto-generated when queueBuffer is called.
237    int64_t mTimestamp;
238
239    // mDataSpace is the buffer dataSpace that will be used for the next buffer
240    // queue operation. It defaults to HAL_DATASPACE_UNKNOWN, which
241    // means that the buffer contains some type of color data.
242    android_dataspace mDataSpace;
243
244    // mCrop is the crop rectangle that will be used for the next buffer
245    // that gets queued. It is set by calling setCrop.
246    Rect mCrop;
247
248    // mScalingMode is the scaling mode that will be used for the next
249    // buffers that get queued. It is set by calling setScalingMode.
250    int mScalingMode;
251
252    // mTransform is the transform identifier that will be used for the next
253    // buffer that gets queued. It is set by calling setTransform.
254    uint32_t mTransform;
255
256    // mStickyTransform is a transform that is applied on top of mTransform
257    // in each buffer that is queued.  This is typically used to force the
258    // compositor to apply a transform, and will prevent the transform hint
259    // from being set by the compositor.
260    uint32_t mStickyTransform;
261
262    // mDefaultWidth is default width of the buffers, regardless of the
263    // native_window_set_buffers_dimensions call.
264    uint32_t mDefaultWidth;
265
266    // mDefaultHeight is default height of the buffers, regardless of the
267    // native_window_set_buffers_dimensions call.
268    uint32_t mDefaultHeight;
269
270    // mUserWidth, if non-zero, is an application-specified override
271    // of mDefaultWidth.  This is lower priority than the width set by
272    // native_window_set_buffers_dimensions.
273    uint32_t mUserWidth;
274
275    // mUserHeight, if non-zero, is an application-specified override
276    // of mDefaultHeight.  This is lower priority than the height set
277    // by native_window_set_buffers_dimensions.
278    uint32_t mUserHeight;
279
280    // mTransformHint is the transform probably applied to buffers of this
281    // window. this is only a hint, actual transform may differ.
282    uint32_t mTransformHint;
283
284    // mProducerControlledByApp whether this buffer producer is controlled
285    // by the application
286    bool mProducerControlledByApp;
287
288    // mSwapIntervalZero set if we should drop buffers at queue() time to
289    // achieve an asynchronous swap interval
290    bool mSwapIntervalZero;
291
292    // mConsumerRunningBehind whether the consumer is running more than
293    // one buffer behind the producer.
294    mutable bool mConsumerRunningBehind;
295
296    // mMutex is the mutex used to prevent concurrent access to the member
297    // variables of Surface objects. It must be locked whenever the
298    // member variables are accessed.
299    mutable Mutex mMutex;
300
301    // must be used from the lock/unlock thread
302    sp<GraphicBuffer>           mLockedBuffer;
303    sp<GraphicBuffer>           mPostedBuffer;
304    bool                        mConnectedToCpu;
305
306    // When a CPU producer is attached, this reflects the region that the
307    // producer wished to update as well as whether the Surface was able to copy
308    // the previous buffer back to allow a partial update.
309    //
310    // When a non-CPU producer is attached, this reflects the surface damage
311    // (the change since the previous frame) passed in by the producer.
312    Region mDirtyRegion;
313
314    // Stores the current generation number. See setGenerationNumber and
315    // IGraphicBufferProducer::setGenerationNumber for more information.
316    uint32_t mGenerationNumber;
317};
318
319}; // namespace android
320
321#endif  // ANDROID_GUI_SURFACE_H
322