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