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/BufferQueueDefs.h>
21#include <gui/HdrMetadata.h>
22#include <gui/IGraphicBufferProducer.h>
23
24#include <ui/ANativeObjectBase.h>
25#include <ui/GraphicTypes.h>
26#include <ui/Region.h>
27
28#include <utils/Condition.h>
29#include <utils/Mutex.h>
30#include <utils/RefBase.h>
31
32#include <system/window.h>
33
34namespace android {
35
36class ISurfaceComposer;
37
38/*
39 * An implementation of ANativeWindow that feeds graphics buffers into a
40 * BufferQueue.
41 *
42 * This is typically used by programs that want to render frames through
43 * some means (maybe OpenGL, a software renderer, or a hardware decoder)
44 * and have the frames they create forwarded to SurfaceFlinger for
45 * compositing.  For example, a video decoder could render a frame and call
46 * eglSwapBuffers(), which invokes ANativeWindow callbacks defined by
47 * Surface.  Surface then forwards the buffers through Binder IPC
48 * to the BufferQueue's producer interface, providing the new frame to a
49 * consumer such as GLConsumer.
50 */
51class Surface
52    : public ANativeObjectBase<ANativeWindow, Surface, RefBase>
53{
54public:
55
56    /*
57     * creates a Surface from the given IGraphicBufferProducer (which concrete
58     * implementation is a BufferQueue).
59     *
60     * Surface is mainly state-less while it's disconnected, it can be
61     * viewed as a glorified IGraphicBufferProducer holder. It's therefore
62     * safe to create other Surfaces from the same IGraphicBufferProducer.
63     *
64     * However, once a Surface is connected, it'll prevent other Surfaces
65     * referring to the same IGraphicBufferProducer to become connected and
66     * therefore prevent them to be used as actual producers of buffers.
67     *
68     * the controlledByApp flag indicates that this Surface (producer) is
69     * controlled by the application. This flag is used at connect time.
70     */
71    explicit Surface(const sp<IGraphicBufferProducer>& bufferProducer,
72            bool controlledByApp = false);
73
74    /* getIGraphicBufferProducer() returns the IGraphicBufferProducer this
75     * Surface was created with. Usually it's an error to use the
76     * IGraphicBufferProducer while the Surface is connected.
77     */
78    sp<IGraphicBufferProducer> getIGraphicBufferProducer() const;
79
80    /* convenience function to check that the given surface is non NULL as
81     * well as its IGraphicBufferProducer */
82    static bool isValid(const sp<Surface>& surface) {
83        return surface != NULL && surface->getIGraphicBufferProducer() != NULL;
84    }
85
86    /* Attaches a sideband buffer stream to the Surface's IGraphicBufferProducer.
87     *
88     * A sideband stream is a device-specific mechanism for passing buffers
89     * from the producer to the consumer without using dequeueBuffer/
90     * queueBuffer. If a sideband stream is present, the consumer can choose
91     * whether to acquire buffers from the sideband stream or from the queued
92     * buffers.
93     *
94     * Passing NULL or a different stream handle will detach the previous
95     * handle if any.
96     */
97    void setSidebandStream(const sp<NativeHandle>& stream);
98
99    /* Allocates buffers based on the current dimensions/format.
100     *
101     * This function will allocate up to the maximum number of buffers
102     * permitted by the current BufferQueue configuration. It will use the
103     * default format and dimensions. This is most useful to avoid an allocation
104     * delay during dequeueBuffer. If there are already the maximum number of
105     * buffers allocated, this function has no effect.
106     */
107    void allocateBuffers();
108
109    /* Sets the generation number on the IGraphicBufferProducer and updates the
110     * generation number on any buffers attached to the Surface after this call.
111     * See IGBP::setGenerationNumber for more information. */
112    status_t setGenerationNumber(uint32_t generationNumber);
113
114    // See IGraphicBufferProducer::getConsumerName
115    String8 getConsumerName() const;
116
117    // See IGraphicBufferProducer::getNextFrameNumber
118    uint64_t getNextFrameNumber() const;
119
120    /* Set the scaling mode to be used with a Surface.
121     * See NATIVE_WINDOW_SET_SCALING_MODE and its parameters
122     * in <system/window.h>. */
123    int setScalingMode(int mode);
124
125    // See IGraphicBufferProducer::setDequeueTimeout
126    status_t setDequeueTimeout(nsecs_t timeout);
127
128    /*
129     * Wait for frame number to increase past lastFrame for at most
130     * timeoutNs. Useful for one thread to wait for another unknown
131     * thread to queue a buffer.
132     */
133    bool waitForNextFrame(uint64_t lastFrame, nsecs_t timeout);
134
135    // See IGraphicBufferProducer::getLastQueuedBuffer
136    // See GLConsumer::getTransformMatrix for outTransformMatrix format
137    status_t getLastQueuedBuffer(sp<GraphicBuffer>* outBuffer,
138            sp<Fence>* outFence, float outTransformMatrix[16]);
139
140    status_t getDisplayRefreshCycleDuration(nsecs_t* outRefreshDuration);
141
142    /* Enables or disables frame timestamp tracking. It is disabled by default
143     * to avoid overhead during queue and dequeue for applications that don't
144     * need the feature. If disabled, calls to getFrameTimestamps will fail.
145     */
146    void enableFrameTimestamps(bool enable);
147
148    status_t getCompositorTiming(
149            nsecs_t* compositeDeadline, nsecs_t* compositeInterval,
150            nsecs_t* compositeToPresentLatency);
151
152    // See IGraphicBufferProducer::getFrameTimestamps
153    status_t getFrameTimestamps(uint64_t frameNumber,
154            nsecs_t* outRequestedPresentTime, nsecs_t* outAcquireTime,
155            nsecs_t* outLatchTime, nsecs_t* outFirstRefreshStartTime,
156            nsecs_t* outLastRefreshStartTime, nsecs_t* outGlCompositionDoneTime,
157            nsecs_t* outDisplayPresentTime, nsecs_t* outDequeueReadyTime,
158            nsecs_t* outReleaseTime);
159
160    status_t getWideColorSupport(bool* supported);
161    status_t getHdrSupport(bool* supported);
162
163    status_t getUniqueId(uint64_t* outId) const;
164    status_t getConsumerUsage(uint64_t* outUsage) const;
165
166    // Returns the CLOCK_MONOTONIC start time of the last dequeueBuffer call
167    nsecs_t getLastDequeueStartTime() const;
168
169protected:
170    virtual ~Surface();
171
172    // Virtual for testing.
173    virtual sp<ISurfaceComposer> composerService() const;
174    virtual nsecs_t now() const;
175
176private:
177    // can't be copied
178    Surface& operator = (const Surface& rhs);
179    Surface(const Surface& rhs);
180
181    // ANativeWindow hooks
182    static int hook_cancelBuffer(ANativeWindow* window,
183            ANativeWindowBuffer* buffer, int fenceFd);
184    static int hook_dequeueBuffer(ANativeWindow* window,
185            ANativeWindowBuffer** buffer, int* fenceFd);
186    static int hook_perform(ANativeWindow* window, int operation, ...);
187    static int hook_query(const ANativeWindow* window, int what, int* value);
188    static int hook_queueBuffer(ANativeWindow* window,
189            ANativeWindowBuffer* buffer, int fenceFd);
190    static int hook_setSwapInterval(ANativeWindow* window, int interval);
191
192    static int hook_cancelBuffer_DEPRECATED(ANativeWindow* window,
193            ANativeWindowBuffer* buffer);
194    static int hook_dequeueBuffer_DEPRECATED(ANativeWindow* window,
195            ANativeWindowBuffer** buffer);
196    static int hook_lockBuffer_DEPRECATED(ANativeWindow* window,
197            ANativeWindowBuffer* buffer);
198    static int hook_queueBuffer_DEPRECATED(ANativeWindow* window,
199            ANativeWindowBuffer* buffer);
200
201    int dispatchConnect(va_list args);
202    int dispatchDisconnect(va_list args);
203    int dispatchSetBufferCount(va_list args);
204    int dispatchSetBuffersGeometry(va_list args);
205    int dispatchSetBuffersDimensions(va_list args);
206    int dispatchSetBuffersUserDimensions(va_list args);
207    int dispatchSetBuffersFormat(va_list args);
208    int dispatchSetScalingMode(va_list args);
209    int dispatchSetBuffersTransform(va_list args);
210    int dispatchSetBuffersStickyTransform(va_list args);
211    int dispatchSetBuffersTimestamp(va_list args);
212    int dispatchSetCrop(va_list args);
213    int dispatchSetUsage(va_list args);
214    int dispatchSetUsage64(va_list args);
215    int dispatchLock(va_list args);
216    int dispatchUnlockAndPost(va_list args);
217    int dispatchSetSidebandStream(va_list args);
218    int dispatchSetBuffersDataSpace(va_list args);
219    int dispatchSetBuffersSmpte2086Metadata(va_list args);
220    int dispatchSetBuffersCta8613Metadata(va_list args);
221    int dispatchSetSurfaceDamage(va_list args);
222    int dispatchSetSharedBufferMode(va_list args);
223    int dispatchSetAutoRefresh(va_list args);
224    int dispatchGetDisplayRefreshCycleDuration(va_list args);
225    int dispatchGetNextFrameId(va_list args);
226    int dispatchEnableFrameTimestamps(va_list args);
227    int dispatchGetCompositorTiming(va_list args);
228    int dispatchGetFrameTimestamps(va_list args);
229    int dispatchGetWideColorSupport(va_list args);
230    int dispatchGetHdrSupport(va_list args);
231    int dispatchGetConsumerUsage64(va_list args);
232
233protected:
234    virtual int dequeueBuffer(ANativeWindowBuffer** buffer, int* fenceFd);
235    virtual int cancelBuffer(ANativeWindowBuffer* buffer, int fenceFd);
236    virtual int queueBuffer(ANativeWindowBuffer* buffer, int fenceFd);
237    virtual int perform(int operation, va_list args);
238    virtual int setSwapInterval(int interval);
239
240    virtual int lockBuffer_DEPRECATED(ANativeWindowBuffer* buffer);
241
242    virtual int connect(int api);
243    virtual int setBufferCount(int bufferCount);
244    virtual int setBuffersUserDimensions(uint32_t width, uint32_t height);
245    virtual int setBuffersFormat(PixelFormat format);
246    virtual int setBuffersTransform(uint32_t transform);
247    virtual int setBuffersStickyTransform(uint32_t transform);
248    virtual int setBuffersTimestamp(int64_t timestamp);
249    virtual int setBuffersDataSpace(ui::Dataspace dataSpace);
250    virtual int setBuffersSmpte2086Metadata(const android_smpte2086_metadata* metadata);
251    virtual int setBuffersCta8613Metadata(const android_cta861_3_metadata* metadata);
252    virtual int setCrop(Rect const* rect);
253    virtual int setUsage(uint64_t reqUsage);
254    virtual void setSurfaceDamage(android_native_rect_t* rects, size_t numRects);
255
256public:
257    virtual int disconnect(int api,
258            IGraphicBufferProducer::DisconnectMode mode =
259                    IGraphicBufferProducer::DisconnectMode::Api);
260
261    virtual int setMaxDequeuedBufferCount(int maxDequeuedBuffers);
262    virtual int setAsyncMode(bool async);
263    virtual int setSharedBufferMode(bool sharedBufferMode);
264    virtual int setAutoRefresh(bool autoRefresh);
265    virtual int setBuffersDimensions(uint32_t width, uint32_t height);
266    virtual int lock(ANativeWindow_Buffer* outBuffer, ARect* inOutDirtyBounds);
267    virtual int unlockAndPost();
268    virtual int query(int what, int* value) const;
269
270    virtual int connect(int api, const sp<IProducerListener>& listener);
271
272    // When reportBufferRemoval is true, clients must call getAndFlushRemovedBuffers to fetch
273    // GraphicBuffers removed from this surface after a dequeueBuffer, detachNextBuffer or
274    // attachBuffer call. This allows clients with their own buffer caches to free up buffers no
275    // longer in use by this surface.
276    virtual int connect(
277            int api, const sp<IProducerListener>& listener,
278            bool reportBufferRemoval);
279    virtual int detachNextBuffer(sp<GraphicBuffer>* outBuffer,
280            sp<Fence>* outFence);
281    virtual int attachBuffer(ANativeWindowBuffer*);
282
283    // When client connects to Surface with reportBufferRemoval set to true, any buffers removed
284    // from this Surface will be collected and returned here. Once this method returns, these
285    // buffers will no longer be referenced by this Surface unless they are attached to this
286    // Surface later. The list of removed buffers will only be stored until the next dequeueBuffer,
287    // detachNextBuffer, or attachBuffer call.
288    status_t getAndFlushRemovedBuffers(std::vector<sp<GraphicBuffer>>* out);
289
290    ui::Dataspace getBuffersDataSpace();
291
292    static status_t attachAndQueueBuffer(Surface* surface, sp<GraphicBuffer> buffer);
293
294protected:
295    enum { NUM_BUFFER_SLOTS = BufferQueueDefs::NUM_BUFFER_SLOTS };
296    enum { DEFAULT_FORMAT = PIXEL_FORMAT_RGBA_8888 };
297
298    void querySupportedTimestampsLocked() const;
299
300    void freeAllBuffers();
301    int getSlotFromBufferLocked(android_native_buffer_t* buffer) const;
302
303    struct BufferSlot {
304        sp<GraphicBuffer> buffer;
305        Region dirtyRegion;
306    };
307
308    // mSurfaceTexture is the interface to the surface texture server. All
309    // operations on the surface texture client ultimately translate into
310    // interactions with the server using this interface.
311    // TODO: rename to mBufferProducer
312    sp<IGraphicBufferProducer> mGraphicBufferProducer;
313
314    // mSlots stores the buffers that have been allocated for each buffer slot.
315    // It is initialized to null pointers, and gets filled in with the result of
316    // IGraphicBufferProducer::requestBuffer when the client dequeues a buffer from a
317    // slot that has not yet been used. The buffer allocated to a slot will also
318    // be replaced if the requested buffer usage or geometry differs from that
319    // of the buffer allocated to a slot.
320    BufferSlot mSlots[NUM_BUFFER_SLOTS];
321
322    // mReqWidth is the buffer width that will be requested at the next dequeue
323    // operation. It is initialized to 1.
324    uint32_t mReqWidth;
325
326    // mReqHeight is the buffer height that will be requested at the next
327    // dequeue operation. It is initialized to 1.
328    uint32_t mReqHeight;
329
330    // mReqFormat is the buffer pixel format that will be requested at the next
331    // deuque operation. It is initialized to PIXEL_FORMAT_RGBA_8888.
332    PixelFormat mReqFormat;
333
334    // mReqUsage is the set of buffer usage flags that will be requested
335    // at the next deuque operation. It is initialized to 0.
336    uint64_t mReqUsage;
337
338    // mTimestamp is the timestamp that will be used for the next buffer queue
339    // operation. It defaults to NATIVE_WINDOW_TIMESTAMP_AUTO, which means that
340    // a timestamp is auto-generated when queueBuffer is called.
341    int64_t mTimestamp;
342
343    // mDataSpace is the buffer dataSpace that will be used for the next buffer
344    // queue operation. It defaults to Dataspace::UNKNOWN, which
345    // means that the buffer contains some type of color data.
346    ui::Dataspace mDataSpace;
347
348    // mHdrMetadata is the HDR metadata that will be used for the next buffer
349    // queue operation.  There is no HDR metadata by default.
350    HdrMetadata mHdrMetadata;
351
352    // mCrop is the crop rectangle that will be used for the next buffer
353    // that gets queued. It is set by calling setCrop.
354    Rect mCrop;
355
356    // mScalingMode is the scaling mode that will be used for the next
357    // buffers that get queued. It is set by calling setScalingMode.
358    int mScalingMode;
359
360    // mTransform is the transform identifier that will be used for the next
361    // buffer that gets queued. It is set by calling setTransform.
362    uint32_t mTransform;
363
364    // mStickyTransform is a transform that is applied on top of mTransform
365    // in each buffer that is queued.  This is typically used to force the
366    // compositor to apply a transform, and will prevent the transform hint
367    // from being set by the compositor.
368    uint32_t mStickyTransform;
369
370    // mDefaultWidth is default width of the buffers, regardless of the
371    // native_window_set_buffers_dimensions call.
372    uint32_t mDefaultWidth;
373
374    // mDefaultHeight is default height of the buffers, regardless of the
375    // native_window_set_buffers_dimensions call.
376    uint32_t mDefaultHeight;
377
378    // mUserWidth, if non-zero, is an application-specified override
379    // of mDefaultWidth.  This is lower priority than the width set by
380    // native_window_set_buffers_dimensions.
381    uint32_t mUserWidth;
382
383    // mUserHeight, if non-zero, is an application-specified override
384    // of mDefaultHeight.  This is lower priority than the height set
385    // by native_window_set_buffers_dimensions.
386    uint32_t mUserHeight;
387
388    // mTransformHint is the transform probably applied to buffers of this
389    // window. this is only a hint, actual transform may differ.
390    uint32_t mTransformHint;
391
392    // mProducerControlledByApp whether this buffer producer is controlled
393    // by the application
394    bool mProducerControlledByApp;
395
396    // mSwapIntervalZero set if we should drop buffers at queue() time to
397    // achieve an asynchronous swap interval
398    bool mSwapIntervalZero;
399
400    // mConsumerRunningBehind whether the consumer is running more than
401    // one buffer behind the producer.
402    mutable bool mConsumerRunningBehind;
403
404    // mMutex is the mutex used to prevent concurrent access to the member
405    // variables of Surface objects. It must be locked whenever the
406    // member variables are accessed.
407    mutable Mutex mMutex;
408
409    // must be used from the lock/unlock thread
410    sp<GraphicBuffer>           mLockedBuffer;
411    sp<GraphicBuffer>           mPostedBuffer;
412    bool                        mConnectedToCpu;
413
414    // When a CPU producer is attached, this reflects the region that the
415    // producer wished to update as well as whether the Surface was able to copy
416    // the previous buffer back to allow a partial update.
417    //
418    // When a non-CPU producer is attached, this reflects the surface damage
419    // (the change since the previous frame) passed in by the producer.
420    Region mDirtyRegion;
421
422    // mBufferAge tracks the age of the contents of the most recently dequeued
423    // buffer as the number of frames that have elapsed since it was last queued
424    uint64_t mBufferAge;
425
426    // Stores the current generation number. See setGenerationNumber and
427    // IGraphicBufferProducer::setGenerationNumber for more information.
428    uint32_t mGenerationNumber;
429
430    // Caches the values that have been passed to the producer.
431    bool mSharedBufferMode;
432    bool mAutoRefresh;
433
434    // If in shared buffer mode and auto refresh is enabled, store the shared
435    // buffer slot and return it for all calls to queue/dequeue without going
436    // over Binder.
437    int mSharedBufferSlot;
438
439    // This is true if the shared buffer has already been queued/canceled. It's
440    // used to prevent a mismatch between the number of queue/dequeue calls.
441    bool mSharedBufferHasBeenQueued;
442
443    // These are used to satisfy the NATIVE_WINDOW_LAST_*_DURATION queries
444    nsecs_t mLastDequeueDuration = 0;
445    nsecs_t mLastQueueDuration = 0;
446
447    // Stores the time right before we call IGBP::dequeueBuffer
448    nsecs_t mLastDequeueStartTime = 0;
449
450    Condition mQueueBufferCondition;
451
452    uint64_t mNextFrameNumber = 1;
453    uint64_t mLastFrameNumber = 0;
454
455    // Mutable because ANativeWindow::query needs this class const.
456    mutable bool mQueriedSupportedTimestamps;
457    mutable bool mFrameTimestampsSupportsPresent;
458
459    // A cached copy of the FrameEventHistory maintained by the consumer.
460    bool mEnableFrameTimestamps = false;
461    std::unique_ptr<ProducerFrameEventHistory> mFrameEventHistory;
462
463    bool mReportRemovedBuffers = false;
464    std::vector<sp<GraphicBuffer>> mRemovedBuffers;
465};
466
467} // namespace android
468
469#endif  // ANDROID_GUI_SURFACE_H
470