2 * Copyright (C) 2010 The Android Open Source Project
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #ifndef ANDROID_GUI_SURFACE_H
18 #define ANDROID_GUI_SURFACE_H
20 #include <gui/IGraphicBufferProducer.h>
21 #include <gui/BufferQueueDefs.h>
23 #include <ui/ANativeObjectBase.h>
24 #include <ui/Region.h>
26 #include <utils/Condition.h>
27 #include <utils/Mutex.h>
28 #include <utils/RefBase.h>
30 #include <system/window.h>
34 class ISurfaceComposer;
37 * An implementation of ANativeWindow that feeds graphics buffers into a
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.
50 : public ANativeObjectBase<ANativeWindow, Surface, RefBase>
55 * creates a Surface from the given IGraphicBufferProducer (which concrete
56 * implementation is a BufferQueue).
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.
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.
66 * the controlledByApp flag indicates that this Surface (producer) is
67 * controlled by the application. This flag is used at connect time.
69 explicit Surface(const sp<IGraphicBufferProducer>& bufferProducer,
70 bool controlledByApp = false);
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.
76 sp<IGraphicBufferProducer> getIGraphicBufferProducer() const;
78 /* convenience function to check that the given surface is non NULL as
79 * well as its IGraphicBufferProducer */
80 static bool isValid(const sp<Surface>& surface) {
81 return surface != NULL && surface->getIGraphicBufferProducer() != NULL;
84 /* Attaches a sideband buffer stream to the Surface's IGraphicBufferProducer.
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
92 * Passing NULL or a different stream handle will detach the previous
95 void setSidebandStream(const sp<NativeHandle>& stream);
97 /* Allocates buffers based on the current dimensions/format.
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.
105 void allocateBuffers();
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);
112 // See IGraphicBufferProducer::getConsumerName
113 String8 getConsumerName() const;
115 // See IGraphicBufferProducer::getNextFrameNumber
116 uint64_t getNextFrameNumber() const;
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);
123 // See IGraphicBufferProducer::setDequeueTimeout
124 status_t setDequeueTimeout(nsecs_t timeout);
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.
131 bool waitForNextFrame(uint64_t lastFrame, nsecs_t timeout);
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]);
138 status_t getDisplayRefreshCycleDuration(nsecs_t* outRefreshDuration);
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.
144 void enableFrameTimestamps(bool enable);
146 status_t getCompositorTiming(
147 nsecs_t* compositeDeadline, nsecs_t* compositeInterval,
148 nsecs_t* compositeToPresentLatency);
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);
158 status_t getWideColorSupport(bool* supported);
159 status_t getHdrSupport(bool* supported);
161 status_t getUniqueId(uint64_t* outId) const;
166 // Virtual for testing.
167 virtual sp<ISurfaceComposer> composerService() const;
168 virtual nsecs_t now() const;
172 Surface& operator = (const Surface& rhs);
173 Surface(const Surface& rhs);
175 // ANativeWindow hooks
176 static int hook_cancelBuffer(ANativeWindow* window,
177 ANativeWindowBuffer* buffer, int fenceFd);
178 static int hook_dequeueBuffer(ANativeWindow* window,
179 ANativeWindowBuffer** buffer, int* fenceFd);
180 static int hook_perform(ANativeWindow* window, int operation, ...);
181 static int hook_query(const ANativeWindow* window, int what, int* value);
182 static int hook_queueBuffer(ANativeWindow* window,
183 ANativeWindowBuffer* buffer, int fenceFd);
184 static int hook_setSwapInterval(ANativeWindow* window, int interval);
186 static int hook_cancelBuffer_DEPRECATED(ANativeWindow* window,
187 ANativeWindowBuffer* buffer);
188 static int hook_dequeueBuffer_DEPRECATED(ANativeWindow* window,
189 ANativeWindowBuffer** buffer);
190 static int hook_lockBuffer_DEPRECATED(ANativeWindow* window,
191 ANativeWindowBuffer* buffer);
192 static int hook_queueBuffer_DEPRECATED(ANativeWindow* window,
193 ANativeWindowBuffer* buffer);
195 int dispatchConnect(va_list args);
196 int dispatchDisconnect(va_list args);
197 int dispatchSetBufferCount(va_list args);
198 int dispatchSetBuffersGeometry(va_list args);
199 int dispatchSetBuffersDimensions(va_list args);
200 int dispatchSetBuffersUserDimensions(va_list args);
201 int dispatchSetBuffersFormat(va_list args);
202 int dispatchSetScalingMode(va_list args);
203 int dispatchSetBuffersTransform(va_list args);
204 int dispatchSetBuffersStickyTransform(va_list args);
205 int dispatchSetBuffersTimestamp(va_list args);
206 int dispatchSetCrop(va_list args);
207 int dispatchSetPostTransformCrop(va_list args);
208 int dispatchSetUsage(va_list args);
209 int dispatchLock(va_list args);
210 int dispatchUnlockAndPost(va_list args);
211 int dispatchSetSidebandStream(va_list args);
212 int dispatchSetBuffersDataSpace(va_list args);
213 int dispatchSetSurfaceDamage(va_list args);
214 int dispatchSetSharedBufferMode(va_list args);
215 int dispatchSetAutoRefresh(va_list args);
216 int dispatchGetDisplayRefreshCycleDuration(va_list args);
217 int dispatchGetNextFrameId(va_list args);
218 int dispatchEnableFrameTimestamps(va_list args);
219 int dispatchGetCompositorTiming(va_list args);
220 int dispatchGetFrameTimestamps(va_list args);
221 int dispatchGetWideColorSupport(va_list args);
222 int dispatchGetHdrSupport(va_list args);
225 virtual int dequeueBuffer(ANativeWindowBuffer** buffer, int* fenceFd);
226 virtual int cancelBuffer(ANativeWindowBuffer* buffer, int fenceFd);
227 virtual int queueBuffer(ANativeWindowBuffer* buffer, int fenceFd);
228 virtual int perform(int operation, va_list args);
229 virtual int setSwapInterval(int interval);
231 virtual int lockBuffer_DEPRECATED(ANativeWindowBuffer* buffer);
233 virtual int connect(int api);
234 virtual int setBufferCount(int bufferCount);
235 virtual int setBuffersUserDimensions(uint32_t width, uint32_t height);
236 virtual int setBuffersFormat(PixelFormat format);
237 virtual int setBuffersTransform(uint32_t transform);
238 virtual int setBuffersStickyTransform(uint32_t transform);
239 virtual int setBuffersTimestamp(int64_t timestamp);
240 virtual int setBuffersDataSpace(android_dataspace dataSpace);
241 virtual int setCrop(Rect const* rect);
242 virtual int setUsage(uint32_t reqUsage);
243 virtual void setSurfaceDamage(android_native_rect_t* rects, size_t numRects);
246 virtual int disconnect(int api,
247 IGraphicBufferProducer::DisconnectMode mode =
248 IGraphicBufferProducer::DisconnectMode::Api);
250 virtual int setMaxDequeuedBufferCount(int maxDequeuedBuffers);
251 virtual int setAsyncMode(bool async);
252 virtual int setSharedBufferMode(bool sharedBufferMode);
253 virtual int setAutoRefresh(bool autoRefresh);
254 virtual int setBuffersDimensions(uint32_t width, uint32_t height);
255 virtual int lock(ANativeWindow_Buffer* outBuffer, ARect* inOutDirtyBounds);
256 virtual int unlockAndPost();
257 virtual int query(int what, int* value) const;
259 virtual int connect(int api, const sp<IProducerListener>& listener);
261 // When reportBufferRemoval is true, clients must call getAndFlushRemovedBuffers to fetch
262 // GraphicBuffers removed from this surface after a dequeueBuffer, detachNextBuffer or
263 // attachBuffer call. This allows clients with their own buffer caches to free up buffers no
264 // longer in use by this surface.
266 int api, const sp<IProducerListener>& listener,
267 bool reportBufferRemoval);
268 virtual int detachNextBuffer(sp<GraphicBuffer>* outBuffer,
269 sp<Fence>* outFence);
270 virtual int attachBuffer(ANativeWindowBuffer*);
272 // When client connects to Surface with reportBufferRemoval set to true, any buffers removed
273 // from this Surface will be collected and returned here. Once this method returns, these
274 // buffers will no longer be referenced by this Surface unless they are attached to this
275 // Surface later. The list of removed buffers will only be stored until the next dequeueBuffer,
276 // detachNextBuffer, or attachBuffer call.
277 status_t getAndFlushRemovedBuffers(std::vector<sp<GraphicBuffer>>* out);
280 enum { NUM_BUFFER_SLOTS = BufferQueueDefs::NUM_BUFFER_SLOTS };
281 enum { DEFAULT_FORMAT = PIXEL_FORMAT_RGBA_8888 };
283 void querySupportedTimestampsLocked() const;
285 void freeAllBuffers();
286 int getSlotFromBufferLocked(android_native_buffer_t* buffer) const;
289 sp<GraphicBuffer> buffer;
293 // mSurfaceTexture is the interface to the surface texture server. All
294 // operations on the surface texture client ultimately translate into
295 // interactions with the server using this interface.
296 // TODO: rename to mBufferProducer
297 sp<IGraphicBufferProducer> mGraphicBufferProducer;
299 // mSlots stores the buffers that have been allocated for each buffer slot.
300 // It is initialized to null pointers, and gets filled in with the result of
301 // IGraphicBufferProducer::requestBuffer when the client dequeues a buffer from a
302 // slot that has not yet been used. The buffer allocated to a slot will also
303 // be replaced if the requested buffer usage or geometry differs from that
304 // of the buffer allocated to a slot.
305 BufferSlot mSlots[NUM_BUFFER_SLOTS];
307 // mReqWidth is the buffer width that will be requested at the next dequeue
308 // operation. It is initialized to 1.
311 // mReqHeight is the buffer height that will be requested at the next
312 // dequeue operation. It is initialized to 1.
315 // mReqFormat is the buffer pixel format that will be requested at the next
316 // deuque operation. It is initialized to PIXEL_FORMAT_RGBA_8888.
317 PixelFormat mReqFormat;
319 // mReqUsage is the set of buffer usage flags that will be requested
320 // at the next deuque operation. It is initialized to 0.
323 // mTimestamp is the timestamp that will be used for the next buffer queue
324 // operation. It defaults to NATIVE_WINDOW_TIMESTAMP_AUTO, which means that
325 // a timestamp is auto-generated when queueBuffer is called.
328 // mDataSpace is the buffer dataSpace that will be used for the next buffer
329 // queue operation. It defaults to HAL_DATASPACE_UNKNOWN, which
330 // means that the buffer contains some type of color data.
331 android_dataspace mDataSpace;
333 // mCrop is the crop rectangle that will be used for the next buffer
334 // that gets queued. It is set by calling setCrop.
337 // mScalingMode is the scaling mode that will be used for the next
338 // buffers that get queued. It is set by calling setScalingMode.
341 // mTransform is the transform identifier that will be used for the next
342 // buffer that gets queued. It is set by calling setTransform.
345 // mStickyTransform is a transform that is applied on top of mTransform
346 // in each buffer that is queued. This is typically used to force the
347 // compositor to apply a transform, and will prevent the transform hint
348 // from being set by the compositor.
349 uint32_t mStickyTransform;
351 // mDefaultWidth is default width of the buffers, regardless of the
352 // native_window_set_buffers_dimensions call.
353 uint32_t mDefaultWidth;
355 // mDefaultHeight is default height of the buffers, regardless of the
356 // native_window_set_buffers_dimensions call.
357 uint32_t mDefaultHeight;
359 // mUserWidth, if non-zero, is an application-specified override
360 // of mDefaultWidth. This is lower priority than the width set by
361 // native_window_set_buffers_dimensions.
364 // mUserHeight, if non-zero, is an application-specified override
365 // of mDefaultHeight. This is lower priority than the height set
366 // by native_window_set_buffers_dimensions.
367 uint32_t mUserHeight;
369 // mTransformHint is the transform probably applied to buffers of this
370 // window. this is only a hint, actual transform may differ.
371 uint32_t mTransformHint;
373 // mProducerControlledByApp whether this buffer producer is controlled
374 // by the application
375 bool mProducerControlledByApp;
377 // mSwapIntervalZero set if we should drop buffers at queue() time to
378 // achieve an asynchronous swap interval
379 bool mSwapIntervalZero;
381 // mConsumerRunningBehind whether the consumer is running more than
382 // one buffer behind the producer.
383 mutable bool mConsumerRunningBehind;
385 // mMutex is the mutex used to prevent concurrent access to the member
386 // variables of Surface objects. It must be locked whenever the
387 // member variables are accessed.
388 mutable Mutex mMutex;
390 // must be used from the lock/unlock thread
391 sp<GraphicBuffer> mLockedBuffer;
392 sp<GraphicBuffer> mPostedBuffer;
393 bool mConnectedToCpu;
395 // When a CPU producer is attached, this reflects the region that the
396 // producer wished to update as well as whether the Surface was able to copy
397 // the previous buffer back to allow a partial update.
399 // When a non-CPU producer is attached, this reflects the surface damage
400 // (the change since the previous frame) passed in by the producer.
403 // Stores the current generation number. See setGenerationNumber and
404 // IGraphicBufferProducer::setGenerationNumber for more information.
405 uint32_t mGenerationNumber;
407 // Caches the values that have been passed to the producer.
408 bool mSharedBufferMode;
411 // If in shared buffer mode and auto refresh is enabled, store the shared
412 // buffer slot and return it for all calls to queue/dequeue without going
414 int mSharedBufferSlot;
416 // This is true if the shared buffer has already been queued/canceled. It's
417 // used to prevent a mismatch between the number of queue/dequeue calls.
418 bool mSharedBufferHasBeenQueued;
420 // These are used to satisfy the NATIVE_WINDOW_LAST_*_DURATION queries
421 nsecs_t mLastDequeueDuration = 0;
422 nsecs_t mLastQueueDuration = 0;
424 Condition mQueueBufferCondition;
426 uint64_t mNextFrameNumber = 1;
427 uint64_t mLastFrameNumber = 0;
429 // Mutable because ANativeWindow::query needs this class const.
430 mutable bool mQueriedSupportedTimestamps;
431 mutable bool mFrameTimestampsSupportsPresent;
433 // A cached copy of the FrameEventHistory maintained by the consumer.
434 bool mEnableFrameTimestamps = false;
435 std::unique_ptr<ProducerFrameEventHistory> mFrameEventHistory;
437 bool mReportRemovedBuffers = false;
438 std::vector<sp<GraphicBuffer>> mRemovedBuffers;
441 } // namespace android
443 #endif // ANDROID_GUI_SURFACE_H