1 /*
2 * Copyright (C) 2012 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 //#define LOG_NDEBUG 0
18 #define LOG_TAG "BufferItemConsumer"
19 //#define ATRACE_TAG ATRACE_TAG_GRAPHICS
20 #include <utils/Errors.h>
21 #include <utils/Log.h>
22
23 #include <inttypes.h>
24
25 #include <com_android_graphics_libgui_flags.h>
26 #include <gui/BufferItem.h>
27 #include <gui/BufferItemConsumer.h>
28 #include <gui/Surface.h>
29 #include <ui/BufferQueueDefs.h>
30 #include <ui/GraphicBuffer.h>
31
32 #define BI_LOGV(x, ...) ALOGV("[%s] " x, mName.c_str(), ##__VA_ARGS__)
33 // #define BI_LOGD(x, ...) ALOGD("[%s] " x, mName.c_str(), ##__VA_ARGS__)
34 // #define BI_LOGI(x, ...) ALOGI("[%s] " x, mName.c_str(), ##__VA_ARGS__)
35 // #define BI_LOGW(x, ...) ALOGW("[%s] " x, mName.c_str(), ##__VA_ARGS__)
36 #define BI_LOGE(x, ...) ALOGE("[%s] " x, mName.c_str(), ##__VA_ARGS__)
37
38 namespace android {
39
create(uint64_t consumerUsage,int bufferCount,bool controlledByApp,bool isConsumerSurfaceFlinger)40 std::tuple<sp<BufferItemConsumer>, sp<Surface>> BufferItemConsumer::create(
41 uint64_t consumerUsage, int bufferCount, bool controlledByApp,
42 bool isConsumerSurfaceFlinger) {
43 #if COM_ANDROID_GRAPHICS_LIBGUI_FLAGS(WB_CONSUMER_BASE_OWNS_BQ)
44 sp<BufferItemConsumer> bufferItemConsumer =
45 sp<BufferItemConsumer>::make(consumerUsage, bufferCount, controlledByApp,
46 isConsumerSurfaceFlinger);
47 return {bufferItemConsumer, bufferItemConsumer->getSurface()};
48 #else
49 sp<IGraphicBufferProducer> igbp;
50 sp<IGraphicBufferConsumer> igbc;
51 BufferQueue::createBufferQueue(&igbp, &igbc, isConsumerSurfaceFlinger);
52 sp<BufferItemConsumer> bufferItemConsumer =
53 sp<BufferItemConsumer>::make(igbc, consumerUsage, bufferCount, controlledByApp);
54 return {bufferItemConsumer, sp<Surface>::make(igbp, controlledByApp)};
55 #endif
56 }
57
create(const sp<IGraphicBufferConsumer> & consumer,uint64_t consumerUsage,int bufferCount,bool controlledByApp)58 sp<BufferItemConsumer> BufferItemConsumer::create(const sp<IGraphicBufferConsumer>& consumer,
59 uint64_t consumerUsage, int bufferCount,
60 bool controlledByApp) {
61 return sp<BufferItemConsumer>::make(consumer, consumerUsage, bufferCount, controlledByApp);
62 }
63
64 #if COM_ANDROID_GRAPHICS_LIBGUI_FLAGS(WB_CONSUMER_BASE_OWNS_BQ)
BufferItemConsumer(uint64_t consumerUsage,int bufferCount,bool controlledByApp,bool isConsumerSurfaceFlinger)65 BufferItemConsumer::BufferItemConsumer(uint64_t consumerUsage, int bufferCount,
66 bool controlledByApp, bool isConsumerSurfaceFlinger)
67 : ConsumerBase(controlledByApp, isConsumerSurfaceFlinger) {
68 initialize(consumerUsage, bufferCount);
69 }
70
BufferItemConsumer(const sp<IGraphicBufferProducer> & producer,const sp<IGraphicBufferConsumer> & consumer,uint64_t consumerUsage,int bufferCount,bool controlledByApp)71 BufferItemConsumer::BufferItemConsumer(const sp<IGraphicBufferProducer>& producer,
72 const sp<IGraphicBufferConsumer>& consumer,
73 uint64_t consumerUsage, int bufferCount,
74 bool controlledByApp)
75 : ConsumerBase(producer, consumer, controlledByApp) {
76 initialize(consumerUsage, bufferCount);
77 }
78 #endif // COM_ANDROID_GRAPHICS_LIBGUI_FLAGS(WB_CONSUMER_BASE_OWNS_BQ)
79
BufferItemConsumer(const sp<IGraphicBufferConsumer> & consumer,uint64_t consumerUsage,int bufferCount,bool controlledByApp)80 BufferItemConsumer::BufferItemConsumer(
81 const sp<IGraphicBufferConsumer>& consumer, uint64_t consumerUsage,
82 int bufferCount, bool controlledByApp) :
83 ConsumerBase(consumer, controlledByApp)
84 {
85 initialize(consumerUsage, bufferCount);
86 }
87
initialize(uint64_t consumerUsage,int bufferCount)88 void BufferItemConsumer::initialize(uint64_t consumerUsage, int bufferCount) {
89 status_t err = mConsumer->setConsumerUsageBits(consumerUsage);
90 LOG_ALWAYS_FATAL_IF(err != OK, "Failed to set consumer usage bits to %#" PRIx64, consumerUsage);
91 if (bufferCount != DEFAULT_MAX_BUFFERS) {
92 err = mConsumer->setMaxAcquiredBufferCount(bufferCount);
93 LOG_ALWAYS_FATAL_IF(err != OK, "Failed to set max acquired buffer count to %d",
94 bufferCount);
95 }
96 }
97
~BufferItemConsumer()98 BufferItemConsumer::~BufferItemConsumer() {}
99
setBufferFreedListener(const wp<BufferFreedListener> & listener)100 void BufferItemConsumer::setBufferFreedListener(
101 const wp<BufferFreedListener>& listener) {
102 Mutex::Autolock _l(mMutex);
103 mBufferFreedListener = listener;
104 }
105
acquireBuffer(BufferItem * item,nsecs_t presentWhen,bool waitForFence)106 status_t BufferItemConsumer::acquireBuffer(BufferItem *item,
107 nsecs_t presentWhen, bool waitForFence) {
108 status_t err;
109
110 if (!item) return BAD_VALUE;
111
112 Mutex::Autolock _l(mMutex);
113
114 err = acquireBufferLocked(item, presentWhen);
115 if (err != OK) {
116 if (err != NO_BUFFER_AVAILABLE) {
117 BI_LOGE("Error acquiring buffer: %s (%d)", strerror(err), err);
118 }
119 return err;
120 }
121
122 if (waitForFence) {
123 err = item->mFence->waitForever("BufferItemConsumer::acquireBuffer");
124 if (err != OK) {
125 BI_LOGE("Failed to wait for fence of acquired buffer: %s (%d)",
126 strerror(-err), err);
127 return err;
128 }
129 }
130
131 item->mGraphicBuffer = mSlots[item->mSlot].mGraphicBuffer;
132
133 return OK;
134 }
135
attachBuffer(const sp<GraphicBuffer> & buffer)136 status_t BufferItemConsumer::attachBuffer(const sp<GraphicBuffer>& buffer) {
137 if (!buffer) {
138 BI_LOGE("BufferItemConsumer::attachBuffer no input buffer specified.");
139 return BAD_VALUE;
140 }
141
142 Mutex::Autolock _l(mMutex);
143
144 int slot = INVALID_BUFFER_SLOT;
145 status_t status = mConsumer->attachBuffer(&slot, buffer);
146 if (status != OK) {
147 BI_LOGE("BufferItemConsumer::attachBuffer unable to attach buffer %d", status);
148 return status;
149 }
150
151 mSlots[slot] = {
152 .mGraphicBuffer = buffer,
153 .mFence = nullptr,
154 .mFrameNumber = 0,
155 };
156
157 return OK;
158 }
159
releaseBuffer(const BufferItem & item,const sp<Fence> & releaseFence)160 status_t BufferItemConsumer::releaseBuffer(const BufferItem &item,
161 const sp<Fence>& releaseFence) {
162 Mutex::Autolock _l(mMutex);
163 return releaseBufferSlotLocked(item.mSlot, item.mGraphicBuffer, releaseFence);
164 }
165
releaseBuffer(const sp<GraphicBuffer> & buffer,const sp<Fence> & releaseFence)166 status_t BufferItemConsumer::releaseBuffer(const sp<GraphicBuffer>& buffer,
167 const sp<Fence>& releaseFence) {
168 Mutex::Autolock _l(mMutex);
169
170 if (buffer == nullptr) {
171 return BAD_VALUE;
172 }
173
174 int slotIndex = getSlotForBufferLocked(buffer);
175 if (slotIndex == INVALID_BUFFER_SLOT) {
176 return BAD_VALUE;
177 }
178
179 return releaseBufferSlotLocked(slotIndex, buffer, releaseFence);
180 }
181
releaseBufferSlotLocked(int slotIndex,const sp<GraphicBuffer> & buffer,const sp<Fence> & releaseFence)182 status_t BufferItemConsumer::releaseBufferSlotLocked(int slotIndex, const sp<GraphicBuffer>& buffer,
183 const sp<Fence>& releaseFence) {
184 status_t err;
185
186 err = addReleaseFenceLocked(slotIndex, buffer, releaseFence);
187 if (err != OK) {
188 BI_LOGE("Failed to addReleaseFenceLocked");
189 }
190
191 err = releaseBufferLocked(slotIndex, buffer);
192 if (err != OK && err != IGraphicBufferConsumer::STALE_BUFFER_SLOT) {
193 BI_LOGE("Failed to release buffer: %s (%d)",
194 strerror(-err), err);
195 }
196 return err;
197 }
198
freeBufferLocked(int slotIndex)199 void BufferItemConsumer::freeBufferLocked(int slotIndex) {
200 sp<BufferFreedListener> listener = mBufferFreedListener.promote();
201 if (listener != nullptr && mSlots[slotIndex].mGraphicBuffer != nullptr) {
202 // Fire callback if we have a listener registered and the buffer being freed is valid.
203 BI_LOGV("actually calling onBufferFreed");
204 listener->onBufferFreed(mSlots[slotIndex].mGraphicBuffer);
205 }
206 ConsumerBase::freeBufferLocked(slotIndex);
207 }
208
209 } // namespace android
210