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 "CpuConsumer"
19 //#define ATRACE_TAG ATRACE_TAG_GRAPHICS
20
21 #include <com_android_graphics_libgui_flags.h>
22 #include <gui/BufferItem.h>
23 #include <gui/BufferQueue.h>
24 #include <gui/CpuConsumer.h>
25 #include <gui/IGraphicBufferConsumer.h>
26 #include <gui/IGraphicBufferProducer.h>
27 #include <gui/Surface.h>
28 #include <utils/Log.h>
29
30 #define CC_LOGV(x, ...) ALOGV("[%s] " x, mName.c_str(), ##__VA_ARGS__)
31 // #define CC_LOGD(x, ...) ALOGD("[%s] " x, mName.c_str(), ##__VA_ARGS__)
32 // #define CC_LOGI(x, ...) ALOGI("[%s] " x, mName.c_str(), ##__VA_ARGS__)
33 #define CC_LOGW(x, ...) ALOGW("[%s] " x, mName.c_str(), ##__VA_ARGS__)
34 #define CC_LOGE(x, ...) ALOGE("[%s] " x, mName.c_str(), ##__VA_ARGS__)
35
36 namespace android {
37
create(size_t maxLockedBuffers,bool controlledByApp,bool isConsumerSurfaceFlinger)38 std::tuple<sp<CpuConsumer>, sp<Surface>> CpuConsumer::create(size_t maxLockedBuffers,
39 bool controlledByApp,
40 bool isConsumerSurfaceFlinger) {
41 #if COM_ANDROID_GRAPHICS_LIBGUI_FLAGS(WB_CONSUMER_BASE_OWNS_BQ)
42 sp<CpuConsumer> consumer =
43 sp<CpuConsumer>::make(maxLockedBuffers, controlledByApp, isConsumerSurfaceFlinger);
44 return {consumer, consumer->getSurface()};
45 #else
46 sp<IGraphicBufferProducer> igbp;
47 sp<IGraphicBufferConsumer> igbc;
48 BufferQueue::createBufferQueue(&igbp, &igbc, isConsumerSurfaceFlinger);
49
50 return {sp<CpuConsumer>::make(igbc, maxLockedBuffers, controlledByApp),
51 sp<Surface>::make(igbp, controlledByApp)};
52 #endif
53 }
54
create(const sp<IGraphicBufferConsumer> & bq,size_t maxLockedBuffers,bool controlledByApp)55 sp<CpuConsumer> CpuConsumer::create(const sp<IGraphicBufferConsumer>& bq, size_t maxLockedBuffers,
56 bool controlledByApp) {
57 return sp<CpuConsumer>::make(bq, maxLockedBuffers, controlledByApp);
58 }
59
60 #if COM_ANDROID_GRAPHICS_LIBGUI_FLAGS(WB_CONSUMER_BASE_OWNS_BQ)
CpuConsumer(size_t maxLockedBuffers,bool controlledByApp,bool isConsumerSurfaceFlinger)61 CpuConsumer::CpuConsumer(size_t maxLockedBuffers, bool controlledByApp,
62 bool isConsumerSurfaceFlinger)
63 : ConsumerBase(controlledByApp, isConsumerSurfaceFlinger),
64 mMaxLockedBuffers(maxLockedBuffers),
65 mCurrentLockedBuffers(0) {
66 // Create tracking entries for locked buffers
67 mAcquiredBuffers.insertAt(0, maxLockedBuffers);
68
69 mConsumer->setConsumerUsageBits(GRALLOC_USAGE_SW_READ_OFTEN);
70 mConsumer->setMaxAcquiredBufferCount(static_cast<int32_t>(maxLockedBuffers));
71 }
72 #endif // COM_ANDROID_GRAPHICS_LIBGUI_FLAGS(WB_CONSUMER_BASE_OWNS_BQ)
73
CpuConsumer(const sp<IGraphicBufferConsumer> & bq,size_t maxLockedBuffers,bool controlledByApp)74 CpuConsumer::CpuConsumer(const sp<IGraphicBufferConsumer>& bq, size_t maxLockedBuffers,
75 bool controlledByApp)
76 : ConsumerBase(bq, controlledByApp),
77 mMaxLockedBuffers(maxLockedBuffers),
78 mCurrentLockedBuffers(0) {
79 // Create tracking entries for locked buffers
80 mAcquiredBuffers.insertAt(0, maxLockedBuffers);
81
82 mConsumer->setConsumerUsageBits(GRALLOC_USAGE_SW_READ_OFTEN);
83 mConsumer->setMaxAcquiredBufferCount(static_cast<int32_t>(maxLockedBuffers));
84 }
85
findAcquiredBufferLocked(uintptr_t id) const86 size_t CpuConsumer::findAcquiredBufferLocked(uintptr_t id) const {
87 for (size_t i = 0; i < mMaxLockedBuffers; i++) {
88 const auto& ab = mAcquiredBuffers[i];
89 // note that this finds AcquiredBuffer::kUnusedId as well
90 if (ab.mLockedBufferId == id) {
91 return i;
92 }
93 }
94 return mMaxLockedBuffers; // an invalid index
95 }
96
getLockedBufferId(const CpuConsumer::LockedBuffer & buffer)97 static uintptr_t getLockedBufferId(const CpuConsumer::LockedBuffer& buffer) {
98 return reinterpret_cast<uintptr_t>(buffer.data);
99 }
100
isPossiblyYUV(PixelFormat format)101 static bool isPossiblyYUV(PixelFormat format) {
102 switch (static_cast<int>(format)) {
103 case HAL_PIXEL_FORMAT_RGBA_8888:
104 case HAL_PIXEL_FORMAT_RGBX_8888:
105 case HAL_PIXEL_FORMAT_RGBA_FP16:
106 case HAL_PIXEL_FORMAT_RGBA_1010102:
107 case HAL_PIXEL_FORMAT_RGB_888:
108 case HAL_PIXEL_FORMAT_RGB_565:
109 case HAL_PIXEL_FORMAT_BGRA_8888:
110 case HAL_PIXEL_FORMAT_Y8:
111 case HAL_PIXEL_FORMAT_Y16:
112 case HAL_PIXEL_FORMAT_RAW16:
113 case HAL_PIXEL_FORMAT_RAW12:
114 case HAL_PIXEL_FORMAT_RAW10:
115 case HAL_PIXEL_FORMAT_RAW_OPAQUE:
116 case HAL_PIXEL_FORMAT_BLOB:
117 case HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED:
118 return false;
119
120 case HAL_PIXEL_FORMAT_YV12:
121 case HAL_PIXEL_FORMAT_YCbCr_420_888:
122 case HAL_PIXEL_FORMAT_YCbCr_422_SP:
123 case HAL_PIXEL_FORMAT_YCrCb_420_SP:
124 case HAL_PIXEL_FORMAT_YCbCr_422_I:
125 default:
126 return true;
127 }
128 }
129
lockBufferItem(const BufferItem & item,LockedBuffer * outBuffer) const130 status_t CpuConsumer::lockBufferItem(const BufferItem& item, LockedBuffer* outBuffer) const {
131 android_ycbcr ycbcr = android_ycbcr();
132
133 PixelFormat format = item.mGraphicBuffer->getPixelFormat();
134 PixelFormat flexFormat = format;
135 if (isPossiblyYUV(format)) {
136 int fenceFd = item.mFence.get() ? item.mFence->dup() : -1;
137 status_t err = item.mGraphicBuffer->lockAsyncYCbCr(GraphicBuffer::USAGE_SW_READ_OFTEN,
138 item.mCrop, &ycbcr, fenceFd);
139 if (err == OK) {
140 flexFormat = HAL_PIXEL_FORMAT_YCbCr_420_888;
141 if (format != HAL_PIXEL_FORMAT_YCbCr_420_888) {
142 CC_LOGV("locking buffer of format %#x as flex YUV", format);
143 }
144 } else if (format == HAL_PIXEL_FORMAT_YCbCr_420_888) {
145 CC_LOGE("Unable to lock YCbCr buffer for CPU reading: %s (%d)", strerror(-err), err);
146 return err;
147 }
148 }
149
150 if (ycbcr.y != nullptr) {
151 outBuffer->data = reinterpret_cast<uint8_t*>(ycbcr.y);
152 outBuffer->stride = static_cast<uint32_t>(ycbcr.ystride);
153 outBuffer->dataCb = reinterpret_cast<uint8_t*>(ycbcr.cb);
154 outBuffer->dataCr = reinterpret_cast<uint8_t*>(ycbcr.cr);
155 outBuffer->chromaStride = static_cast<uint32_t>(ycbcr.cstride);
156 outBuffer->chromaStep = static_cast<uint32_t>(ycbcr.chroma_step);
157 } else {
158 // not flexible YUV; try lockAsync
159 void* bufferPointer = nullptr;
160 int fenceFd = item.mFence.get() ? item.mFence->dup() : -1;
161 status_t err = item.mGraphicBuffer->lockAsync(GraphicBuffer::USAGE_SW_READ_OFTEN,
162 item.mCrop, &bufferPointer, fenceFd);
163 if (err != OK) {
164 CC_LOGE("Unable to lock buffer for CPU reading: %s (%d)", strerror(-err), err);
165 return err;
166 }
167
168 outBuffer->data = reinterpret_cast<uint8_t*>(bufferPointer);
169 outBuffer->stride = item.mGraphicBuffer->getStride();
170 outBuffer->dataCb = nullptr;
171 outBuffer->dataCr = nullptr;
172 outBuffer->chromaStride = 0;
173 outBuffer->chromaStep = 0;
174 }
175
176 outBuffer->width = item.mGraphicBuffer->getWidth();
177 outBuffer->height = item.mGraphicBuffer->getHeight();
178 outBuffer->format = format;
179 outBuffer->flexFormat = flexFormat;
180
181 outBuffer->crop = item.mCrop;
182 outBuffer->transform = item.mTransform;
183 outBuffer->scalingMode = item.mScalingMode;
184 outBuffer->timestamp = item.mTimestamp;
185 outBuffer->dataSpace = item.mDataSpace;
186 outBuffer->frameNumber = item.mFrameNumber;
187
188 return OK;
189 }
190
lockNextBuffer(LockedBuffer * nativeBuffer)191 status_t CpuConsumer::lockNextBuffer(LockedBuffer *nativeBuffer) {
192 status_t err;
193
194 if (!nativeBuffer) return BAD_VALUE;
195
196 Mutex::Autolock _l(mMutex);
197
198 if (mCurrentLockedBuffers == mMaxLockedBuffers) {
199 CC_LOGW("Max buffers have been locked (%zd), cannot lock anymore.",
200 mMaxLockedBuffers);
201 return NOT_ENOUGH_DATA;
202 }
203
204 BufferItem b;
205 err = acquireBufferLocked(&b, 0);
206 if (err != OK) {
207 if (err == BufferQueue::NO_BUFFER_AVAILABLE) {
208 return BAD_VALUE;
209 } else {
210 CC_LOGE("Error acquiring buffer: %s (%d)", strerror(err), err);
211 return err;
212 }
213 }
214
215 if (b.mGraphicBuffer == nullptr) {
216 b.mGraphicBuffer = mSlots[b.mSlot].mGraphicBuffer;
217 }
218
219 err = lockBufferItem(b, nativeBuffer);
220 if (err != OK) {
221 return err;
222 }
223
224 // find an unused AcquiredBuffer
225 size_t lockedIdx = findAcquiredBufferLocked(AcquiredBuffer::kUnusedId);
226 ALOG_ASSERT(lockedIdx < mMaxLockedBuffers);
227 AcquiredBuffer& ab = mAcquiredBuffers.editItemAt(lockedIdx);
228
229 ab.mSlot = b.mSlot;
230 ab.mGraphicBuffer = b.mGraphicBuffer;
231 ab.mLockedBufferId = getLockedBufferId(*nativeBuffer);
232
233 mCurrentLockedBuffers++;
234
235 return OK;
236 }
237
unlockBuffer(const LockedBuffer & nativeBuffer)238 status_t CpuConsumer::unlockBuffer(const LockedBuffer &nativeBuffer) {
239 Mutex::Autolock _l(mMutex);
240
241 uintptr_t id = getLockedBufferId(nativeBuffer);
242 size_t lockedIdx =
243 (id != AcquiredBuffer::kUnusedId) ? findAcquiredBufferLocked(id) : mMaxLockedBuffers;
244 if (lockedIdx == mMaxLockedBuffers) {
245 CC_LOGE("%s: Can't find buffer to free", __FUNCTION__);
246 return BAD_VALUE;
247 }
248
249 AcquiredBuffer& ab = mAcquiredBuffers.editItemAt(lockedIdx);
250
251 int fenceFd = -1;
252 status_t err = ab.mGraphicBuffer->unlockAsync(&fenceFd);
253 if (err != OK) {
254 CC_LOGE("%s: Unable to unlock graphic buffer %zd", __FUNCTION__,
255 lockedIdx);
256 return err;
257 }
258
259 sp<Fence> fence(fenceFd >= 0 ? sp<Fence>::make(fenceFd) : Fence::NO_FENCE);
260 addReleaseFenceLocked(ab.mSlot, ab.mGraphicBuffer, fence);
261 releaseBufferLocked(ab.mSlot, ab.mGraphicBuffer);
262
263 ab.reset();
264
265 mCurrentLockedBuffers--;
266
267 return OK;
268 }
269
270 } // namespace android
271