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