blob: ea46245ea41602c7c7d6a3f63cc1d91059e8b8be [file] [log] [blame]
Chia-I Wuf1405182017-11-27 11:29:21 -08001/*
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_BUFFERLAYERCONSUMER_H
18#define ANDROID_BUFFERLAYERCONSUMER_H
19
Chia-I Wuf1405182017-11-27 11:29:21 -080020#include <gui/BufferQueueDefs.h>
21#include <gui/ConsumerBase.h>
Courtney Goeltzenleuchter9bad0d72017-12-19 12:34:34 -070022#include <gui/HdrMetadata.h>
Chia-I Wuf1405182017-11-27 11:29:21 -080023
24#include <ui/FenceTime.h>
25#include <ui/GraphicBuffer.h>
Peiyong Lin34beb7a2018-03-28 11:57:12 -070026#include <ui/GraphicTypes.h>
Chia-I Wu67dcc692017-11-27 14:51:06 -080027#include <ui/Region.h>
Chia-I Wuf1405182017-11-27 11:29:21 -080028
29#include <utils/String8.h>
30#include <utils/Vector.h>
31#include <utils/threads.h>
32
33namespace android {
34// ----------------------------------------------------------------------------
35
Chia-I Wuda5c7302017-11-27 14:51:06 -080036class DispSync;
Chia-I Wuc75c44d2017-11-27 14:32:57 -080037class Layer;
Chia-I Wuf1405182017-11-27 11:29:21 -080038class String8;
39
Peiyong Lin833074a2018-08-28 11:53:54 -070040namespace renderengine {
Lloyd Pique144e1162017-12-20 16:44:52 -080041class RenderEngine;
42class Image;
Peiyong Lin833074a2018-08-28 11:53:54 -070043} // namespace renderengine
Lloyd Pique144e1162017-12-20 16:44:52 -080044
Chia-I Wuf1405182017-11-27 11:29:21 -080045/*
46 * BufferLayerConsumer consumes buffers of graphics data from a BufferQueue,
Chia-I Wu221b5922017-12-14 13:59:16 -080047 * and makes them available to RenderEngine as a texture.
Chia-I Wuf1405182017-11-27 11:29:21 -080048 *
Chia-I Wu221b5922017-12-14 13:59:16 -080049 * A typical usage pattern is to call updateTexImage() when a new frame is
50 * desired. If a new frame is available, the frame is latched. If not, the
51 * previous contents are retained. The texture is attached and updated after
52 * bindTextureImage() is called.
Chia-I Wuf1405182017-11-27 11:29:21 -080053 *
Chia-I Wu221b5922017-12-14 13:59:16 -080054 * All calls to updateTexImage must be made with RenderEngine being current.
55 * The texture is attached to the TEXTURE_EXTERNAL texture target.
Chia-I Wuf1405182017-11-27 11:29:21 -080056 */
57class BufferLayerConsumer : public ConsumerBase {
58public:
Chia-I Wuda5c7302017-11-27 14:51:06 -080059 static const status_t BUFFER_REJECTED = UNKNOWN_ERROR + 8;
60
61 class BufferRejecter {
62 friend class BufferLayerConsumer;
63 virtual bool reject(const sp<GraphicBuffer>& buf, const BufferItem& item) = 0;
64
65 protected:
66 virtual ~BufferRejecter() {}
67 };
68
Chia-I Wufd257f82017-11-27 14:51:06 -080069 struct ContentsChangedListener : public FrameAvailableListener {
70 virtual void onSidebandStreamChanged() = 0;
71 };
Chia-I Wuf1405182017-11-27 11:29:21 -080072
Chia-I Wu221b5922017-12-14 13:59:16 -080073 // BufferLayerConsumer constructs a new BufferLayerConsumer object. The
74 // tex parameter indicates the name of the RenderEngine texture to which
75 // images are to be streamed.
Peiyong Lin833074a2018-08-28 11:53:54 -070076 BufferLayerConsumer(const sp<IGraphicBufferConsumer>& bq, renderengine::RenderEngine& engine,
Lloyd Pique144e1162017-12-20 16:44:52 -080077 uint32_t tex, Layer* layer);
Chia-I Wuf1405182017-11-27 11:29:21 -080078
Chia-I Wufd257f82017-11-27 14:51:06 -080079 // Sets the contents changed listener. This should be used instead of
80 // ConsumerBase::setFrameAvailableListener().
81 void setContentsChangedListener(const wp<ContentsChangedListener>& listener);
82
Chia-I Wuf1405182017-11-27 11:29:21 -080083 // updateTexImage acquires the most recently queued buffer, and sets the
84 // image contents of the target texture to it.
85 //
Chia-I Wu221b5922017-12-14 13:59:16 -080086 // This call may only be made while RenderEngine is current.
Chia-I Wuf1405182017-11-27 11:29:21 -080087 //
Chia-I Wu221b5922017-12-14 13:59:16 -080088 // This calls doFenceWait to ensure proper synchronization unless native
89 // fence is supported.
Chia-I Wuda5c7302017-11-27 14:51:06 -080090 //
Chia-I Wu221b5922017-12-14 13:59:16 -080091 // Unlike the GLConsumer version, this version takes a functor that may be
92 // used to reject the newly acquired buffer. It also does not bind the
93 // RenderEngine texture until bindTextureImage is called.
Ana Krulec010d2192018-10-08 06:29:54 -070094 status_t updateTexImage(BufferRejecter* rejecter, nsecs_t expectedPresentTime,
95 bool* autoRefresh, bool* queuedBuffer, uint64_t maxFrameNumber,
Alec Mouri86770e52018-09-24 22:40:58 +000096 const sp<Fence>& releaseFence);
Chia-I Wuf1405182017-11-27 11:29:21 -080097
Chia-I Wu0cb75ac2017-11-27 15:56:04 -080098 // See BufferLayerConsumer::bindTextureImageLocked().
99 status_t bindTextureImage();
100
Chia-I Wuf1405182017-11-27 11:29:21 -0800101 // setReleaseFence stores a fence that will signal when the current buffer
102 // is no longer being read. This fence will be returned to the producer
103 // when the current buffer is released by updateTexImage(). Multiple
104 // fences can be set for a given buffer; they will be merged into a single
105 // union fence.
Chia-I Wuda5c7302017-11-27 14:51:06 -0800106 void setReleaseFence(const sp<Fence>& fence);
107
108 bool releasePendingBuffer();
Chia-I Wuf1405182017-11-27 11:29:21 -0800109
Chia-I Wu0cb75ac2017-11-27 15:56:04 -0800110 sp<Fence> getPrevFinalReleaseFence() const;
111
Chia-I Wu221b5922017-12-14 13:59:16 -0800112 // See GLConsumer::getTransformMatrix.
Chia-I Wuf1405182017-11-27 11:29:21 -0800113 void getTransformMatrix(float mtx[16]);
114
Chia-I Wuf1405182017-11-27 11:29:21 -0800115 // getTimestamp retrieves the timestamp associated with the texture image
116 // set by the most recent call to updateTexImage.
117 //
118 // The timestamp is in nanoseconds, and is monotonically increasing. Its
119 // other semantics (zero point, etc) are source-dependent and should be
120 // documented by the source.
121 int64_t getTimestamp();
122
123 // getDataSpace retrieves the DataSpace associated with the texture image
124 // set by the most recent call to updateTexImage.
Peiyong Lin34beb7a2018-03-28 11:57:12 -0700125 ui::Dataspace getCurrentDataSpace();
Chia-I Wuf1405182017-11-27 11:29:21 -0800126
Courtney Goeltzenleuchter9bad0d72017-12-19 12:34:34 -0700127 // getCurrentHdrMetadata retrieves the HDR metadata associated with the
128 // texture image set by the most recent call to updateTexImage.
129 const HdrMetadata& getCurrentHdrMetadata() const;
130
Chia-I Wuf1405182017-11-27 11:29:21 -0800131 // getFrameNumber retrieves the frame number associated with the texture
132 // image set by the most recent call to updateTexImage.
133 //
134 // The frame number is an incrementing counter set to 0 at the creation of
135 // the BufferQueue associated with this consumer.
136 uint64_t getFrameNumber();
137
Chia-I Wu67dcc692017-11-27 14:51:06 -0800138 bool getTransformToDisplayInverse() const;
139
140 // must be called from SF main thread
141 const Region& getSurfaceDamage() const;
142
Chia-I Wu5c6e4632018-01-11 08:54:38 -0800143 // getCurrentApi retrieves the API which queues the current buffer.
144 int getCurrentApi() const;
145
Chia-I Wu221b5922017-12-14 13:59:16 -0800146 // See GLConsumer::setDefaultBufferSize.
Chia-I Wuf1405182017-11-27 11:29:21 -0800147 status_t setDefaultBufferSize(uint32_t width, uint32_t height);
148
149 // setFilteringEnabled sets whether the transform matrix should be computed
150 // for use with bilinear filtering.
151 void setFilteringEnabled(bool enabled);
152
153 // getCurrentBuffer returns the buffer associated with the current image.
154 // When outSlot is not nullptr, the current buffer slot index is also
Alec Mouri79108df2019-02-04 19:33:44 +0000155 // returned.
156 sp<GraphicBuffer> getCurrentBuffer(int* outSlot = nullptr) const;
Chia-I Wuf1405182017-11-27 11:29:21 -0800157
Chia-I Wuf1405182017-11-27 11:29:21 -0800158 // getCurrentCrop returns the cropping rectangle of the current buffer.
159 Rect getCurrentCrop() const;
160
161 // getCurrentTransform returns the transform of the current buffer.
162 uint32_t getCurrentTransform() const;
163
164 // getCurrentScalingMode returns the scaling mode of the current buffer.
165 uint32_t getCurrentScalingMode() const;
166
167 // getCurrentFence returns the fence indicating when the current buffer is
168 // ready to be read from.
169 sp<Fence> getCurrentFence() const;
170
171 // getCurrentFence returns the FenceTime indicating when the current
172 // buffer is ready to be read from.
173 std::shared_ptr<FenceTime> getCurrentFenceTime() const;
174
175 // setConsumerUsageBits overrides the ConsumerBase method to OR
176 // DEFAULT_USAGE_FLAGS to usage.
177 status_t setConsumerUsageBits(uint64_t usage);
178
Chia-I Wuf1405182017-11-27 11:29:21 -0800179protected:
180 // abandonLocked overrides the ConsumerBase method to clear
181 // mCurrentTextureImage in addition to the ConsumerBase behavior.
182 virtual void abandonLocked();
183
184 // dumpLocked overrides the ConsumerBase method to dump BufferLayerConsumer-
185 // specific info in addition to the ConsumerBase behavior.
186 virtual void dumpLocked(String8& result, const char* prefix) const;
187
Alec Mouri39801c02018-10-10 10:44:47 -0700188 // See ConsumerBase::acquireBufferLocked
Chia-I Wuf1405182017-11-27 11:29:21 -0800189 virtual status_t acquireBufferLocked(BufferItem* item, nsecs_t presentWhen,
190 uint64_t maxFrameNumber = 0) override;
191
Chia-I Wu6748db42017-12-01 10:53:53 -0800192 bool canUseImageCrop(const Rect& crop) const;
193
Chia-I Wuf1405182017-11-27 11:29:21 -0800194 struct PendingRelease {
Chia-I Wu6aff69b2017-11-27 14:08:48 -0800195 PendingRelease() : isPending(false), currentTexture(-1), graphicBuffer() {}
Chia-I Wuf1405182017-11-27 11:29:21 -0800196
197 bool isPending;
198 int currentTexture;
199 sp<GraphicBuffer> graphicBuffer;
Chia-I Wuf1405182017-11-27 11:29:21 -0800200 };
201
202 // This releases the buffer in the slot referenced by mCurrentTexture,
203 // then updates state to refer to the BufferItem, which must be a
204 // newly-acquired buffer. If pendingRelease is not null, the parameters
205 // which would have been passed to releaseBufferLocked upon the successful
206 // completion of the method will instead be returned to the caller, so that
207 // it may call releaseBufferLocked itself later.
208 status_t updateAndReleaseLocked(const BufferItem& item,
Alec Mouri86770e52018-09-24 22:40:58 +0000209 PendingRelease* pendingRelease = nullptr,
210 const sp<Fence>& releaseFence = Fence::NO_FENCE);
Chia-I Wuf1405182017-11-27 11:29:21 -0800211
Alec Mouri39801c02018-10-10 10:44:47 -0700212 // Binds mTexName and the current buffer to TEXTURE_EXTERNAL target.
213 // If the bind succeeds, this calls doFenceWait.
Chia-I Wuf1405182017-11-27 11:29:21 -0800214 status_t bindTextureImageLocked();
215
Chia-I Wuf1405182017-11-27 11:29:21 -0800216private:
Chia-I Wuf1405182017-11-27 11:29:21 -0800217 // freeBufferLocked frees up the given buffer slot. If the slot has been
Chia-I Wu221b5922017-12-14 13:59:16 -0800218 // initialized this will release the reference to the GraphicBuffer in
Alec Mouri39801c02018-10-10 10:44:47 -0700219 // that slot. Otherwise it has no effect.
Chia-I Wuf1405182017-11-27 11:29:21 -0800220 //
221 // This method must be called with mMutex locked.
222 virtual void freeBufferLocked(int slotIndex);
223
Chia-I Wuc75c44d2017-11-27 14:32:57 -0800224 // IConsumerListener interface
225 void onDisconnect() override;
Chia-I Wufd257f82017-11-27 14:51:06 -0800226 void onSidebandStreamChanged() override;
Chia-I Wuc75c44d2017-11-27 14:32:57 -0800227 void addAndGetFrameTimestamps(const NewFrameEventsEntry* newTimestamps,
228 FrameEventHistoryDelta* outDelta) override;
229
Chia-I Wuf1405182017-11-27 11:29:21 -0800230 // computeCurrentTransformMatrixLocked computes the transform matrix for the
231 // current texture. It uses mCurrentTransform and the current GraphicBuffer
232 // to compute this matrix and stores it in mCurrentTransformMatrix.
Peiyong Lin566a3b42018-01-09 18:22:43 -0800233 // mCurrentTextureImage must not be nullptr.
Chia-I Wuf1405182017-11-27 11:29:21 -0800234 void computeCurrentTransformMatrixLocked();
235
Chia-I Wu3498e3c2017-12-01 10:19:38 -0800236 // doFenceWaitLocked inserts a wait command into the RenderEngine command
237 // stream to ensure that it is safe for future RenderEngine commands to
Chia-I Wuf1405182017-11-27 11:29:21 -0800238 // access the current texture buffer.
Chia-I Wu3498e3c2017-12-01 10:19:38 -0800239 status_t doFenceWaitLocked() const;
Chia-I Wuf1405182017-11-27 11:29:21 -0800240
241 // syncForReleaseLocked performs the synchronization needed to release the
Chia-I Wu3498e3c2017-12-01 10:19:38 -0800242 // current slot from RenderEngine. If needed it will set the current
243 // slot's fence to guard against a producer accessing the buffer before
244 // the outstanding accesses have completed.
Alec Mouri86770e52018-09-24 22:40:58 +0000245 status_t syncForReleaseLocked(const sp<Fence>& releaseFence);
Chia-I Wuf1405182017-11-27 11:29:21 -0800246
Chia-I Wuf1405182017-11-27 11:29:21 -0800247 // The default consumer usage flags that BufferLayerConsumer always sets on its
248 // BufferQueue instance; these will be OR:d with any additional flags passed
249 // from the BufferLayerConsumer user. In particular, BufferLayerConsumer will always
250 // consume buffers as hardware textures.
251 static const uint64_t DEFAULT_USAGE_FLAGS = GraphicBuffer::USAGE_HW_TEXTURE;
252
Alec Mouri39801c02018-10-10 10:44:47 -0700253 // mCurrentTextureImage is the buffer containing the current texture. It's
Chia-I Wuf1405182017-11-27 11:29:21 -0800254 // possible that this buffer is not associated with any buffer slot, so we
255 // must track it separately in order to support the getCurrentBuffer method.
Alec Mouri39801c02018-10-10 10:44:47 -0700256 sp<GraphicBuffer> mCurrentTextureBuffer;
Chia-I Wuf1405182017-11-27 11:29:21 -0800257
258 // mCurrentCrop is the crop rectangle that applies to the current texture.
259 // It gets set each time updateTexImage is called.
260 Rect mCurrentCrop;
261
262 // mCurrentTransform is the transform identifier for the current texture. It
263 // gets set each time updateTexImage is called.
264 uint32_t mCurrentTransform;
265
266 // mCurrentScalingMode is the scaling mode for the current texture. It gets
267 // set each time updateTexImage is called.
268 uint32_t mCurrentScalingMode;
269
270 // mCurrentFence is the fence received from BufferQueue in updateTexImage.
271 sp<Fence> mCurrentFence;
272
273 // The FenceTime wrapper around mCurrentFence.
274 std::shared_ptr<FenceTime> mCurrentFenceTime{FenceTime::NO_FENCE};
275
276 // mCurrentTransformMatrix is the transform matrix for the current texture.
277 // It gets computed by computeTransformMatrix each time updateTexImage is
278 // called.
279 float mCurrentTransformMatrix[16];
280
281 // mCurrentTimestamp is the timestamp for the current texture. It
282 // gets set each time updateTexImage is called.
283 int64_t mCurrentTimestamp;
284
285 // mCurrentDataSpace is the dataspace for the current texture. It
286 // gets set each time updateTexImage is called.
Peiyong Lin34beb7a2018-03-28 11:57:12 -0700287 ui::Dataspace mCurrentDataSpace;
Chia-I Wuf1405182017-11-27 11:29:21 -0800288
Courtney Goeltzenleuchter9bad0d72017-12-19 12:34:34 -0700289 // mCurrentHdrMetadata is the HDR metadata for the current texture. It
290 // gets set each time updateTexImage is called.
291 HdrMetadata mCurrentHdrMetadata;
292
Chia-I Wuf1405182017-11-27 11:29:21 -0800293 // mCurrentFrameNumber is the frame counter for the current texture.
294 // It gets set each time updateTexImage is called.
295 uint64_t mCurrentFrameNumber;
296
Chia-I Wu67dcc692017-11-27 14:51:06 -0800297 // Indicates this buffer must be transformed by the inverse transform of the screen
298 // it is displayed onto. This is applied after BufferLayerConsumer::mCurrentTransform.
299 // This must be set/read from SurfaceFlinger's main thread.
300 bool mCurrentTransformToDisplayInverse;
301
302 // The portion of this surface that has changed since the previous frame
303 Region mCurrentSurfaceDamage;
304
Chia-I Wu5c6e4632018-01-11 08:54:38 -0800305 int mCurrentApi;
306
Chia-I Wuf1405182017-11-27 11:29:21 -0800307 uint32_t mDefaultWidth, mDefaultHeight;
308
309 // mFilteringEnabled indicates whether the transform matrix is computed for
310 // use with bilinear filtering. It defaults to true and is changed by
311 // setFilteringEnabled().
312 bool mFilteringEnabled;
313
Peiyong Lin833074a2018-08-28 11:53:54 -0700314 renderengine::RenderEngine& mRE;
Chia-I Wu9f2db772017-11-30 21:06:50 -0800315
Chia-I Wu221b5922017-12-14 13:59:16 -0800316 // mTexName is the name of the RenderEngine texture to which streamed
317 // images will be bound when bindTexImage is called. It is set at
318 // construction time.
Chia-I Wuc91077c2017-11-27 13:32:04 -0800319 const uint32_t mTexName;
Chia-I Wuf1405182017-11-27 11:29:21 -0800320
Chia-I Wuc75c44d2017-11-27 14:32:57 -0800321 // The layer for this BufferLayerConsumer
322 const wp<Layer> mLayer;
323
Chia-I Wufd257f82017-11-27 14:51:06 -0800324 wp<ContentsChangedListener> mContentsChangedListener;
325
Chia-I Wuf1405182017-11-27 11:29:21 -0800326 // mCurrentTexture is the buffer slot index of the buffer that is currently
Chia-I Wu221b5922017-12-14 13:59:16 -0800327 // bound to the RenderEngine texture. It is initialized to INVALID_BUFFER_SLOT,
Chia-I Wuf1405182017-11-27 11:29:21 -0800328 // indicating that no buffer slot is currently bound to the texture. Note,
329 // however, that a value of INVALID_BUFFER_SLOT does not necessarily mean
330 // that no buffer is bound to the texture. A call to setBufferCount will
331 // reset mCurrentTexture to INVALID_BUFFER_SLOT.
332 int mCurrentTexture;
Chia-I Wuda5c7302017-11-27 14:51:06 -0800333
Alec Mouri39801c02018-10-10 10:44:47 -0700334 // Cached image used for rendering the current texture through GPU
335 // composition, which contains the cached image after freeBufferLocked is
336 // called on the current buffer. Whenever latchBuffer is called, this is
337 // expected to be cleared. Then, if bindTexImage is called before the next
338 // buffer is acquired, then this image is bound.
339 std::unique_ptr<renderengine::Image> mCurrentTextureImageFreed;
340
341 // Cached images used for rendering the current texture through GPU
342 // composition.
343 std::unique_ptr<renderengine::Image> mImages[BufferQueueDefs::NUM_BUFFER_SLOTS];
344
Chia-I Wuda5c7302017-11-27 14:51:06 -0800345 // A release that is pending on the receipt of a new release fence from
346 // presentDisplay
347 PendingRelease mPendingRelease;
Chia-I Wuf1405182017-11-27 11:29:21 -0800348};
349
350// ----------------------------------------------------------------------------
351}; // namespace android
352
353#endif // ANDROID_BUFFERLAYERCONSUMER_H