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