blob: bf80481c44b8693d7da9d7eb8783a79441a78342 [file] [log] [blame]
Mathias Agopian89ed4c82017-02-09 18:48:34 -08001/*
2 * Copyright (C) 2017 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_TAG "AHardwareBuffer"
18
Jesse Hall1ee859f2017-04-17 08:52:32 -070019#include <vndk/hardware_buffer.h>
Mathias Agopian89ed4c82017-02-09 18:48:34 -080020
21#include <errno.h>
22#include <sys/socket.h>
23#include <memory>
24
25#include <cutils/native_handle.h>
26#include <log/log.h>
27#include <utils/StrongPointer.h>
28#include <ui/GraphicBuffer.h>
29#include <system/graphics.h>
Mathias Agopian89ed4c82017-02-09 18:48:34 -080030
31#include <private/android/AHardwareBufferHelpers.h>
Craig Donnere6ecb922017-12-27 14:59:29 -080032#include <android/hardware/graphics/common/1.1/types.h>
Mathias Agopian89ed4c82017-02-09 18:48:34 -080033
34
Craig Donner1b1d3002017-04-12 18:38:07 -070035static constexpr int kFdBufferSize = 128 * sizeof(int); // 128 ints
Mathias Agopian89ed4c82017-02-09 18:48:34 -080036
37using namespace android;
38
39// ----------------------------------------------------------------------------
40// Public functions
41// ----------------------------------------------------------------------------
42
43int AHardwareBuffer_allocate(const AHardwareBuffer_Desc* desc, AHardwareBuffer** outBuffer) {
Krzysztof Kosińskia5c54bc2018-11-16 18:24:33 -080044 if (!outBuffer || !desc) return BAD_VALUE;
45 if (!AHardwareBuffer_isValidDescription(desc, /*log=*/true)) return BAD_VALUE;
Mathias Agopian89ed4c82017-02-09 18:48:34 -080046
Mathias Agopian3a11413a2017-06-08 19:44:17 -070047 int format = AHardwareBuffer_convertToPixelFormat(desc->format);
Krzysztof Kosińskia5c54bc2018-11-16 18:24:33 -080048 uint64_t usage = AHardwareBuffer_convertToGrallocUsageBits(desc->usage);
Mathias Agopian89ed4c82017-02-09 18:48:34 -080049 sp<GraphicBuffer> gbuffer(new GraphicBuffer(
Chris Forbesd4106302017-04-20 12:43:04 -070050 desc->width, desc->height, format, desc->layers, usage,
Mathias Agopian89ed4c82017-02-09 18:48:34 -080051 std::string("AHardwareBuffer pid [") + std::to_string(getpid()) + "]"));
52
53 status_t err = gbuffer->initCheck();
54 if (err != 0 || gbuffer->handle == 0) {
55 if (err == NO_MEMORY) {
56 GraphicBuffer::dumpAllocationsToSystemLog();
57 }
Mathias Agopian0556d792017-03-22 15:49:32 -070058 ALOGE("GraphicBuffer(w=%u, h=%u, lc=%u) failed (%s), handle=%p",
Mathias Agopian89ed4c82017-02-09 18:48:34 -080059 desc->width, desc->height, desc->layers, strerror(-err), gbuffer->handle);
60 return err;
61 }
62
63 *outBuffer = AHardwareBuffer_from_GraphicBuffer(gbuffer.get());
64
65 // Ensure the buffer doesn't get destroyed when the sp<> goes away.
66 AHardwareBuffer_acquire(*outBuffer);
67 return NO_ERROR;
68}
69
70void AHardwareBuffer_acquire(AHardwareBuffer* buffer) {
Mathias Agopian000879a2017-03-20 18:07:26 -070071 // incStrong/decStrong token must be the same, doesn't matter what it is
Mathias Agopian89ed4c82017-02-09 18:48:34 -080072 AHardwareBuffer_to_GraphicBuffer(buffer)->incStrong((void*)AHardwareBuffer_acquire);
73}
74
75void AHardwareBuffer_release(AHardwareBuffer* buffer) {
Mathias Agopian000879a2017-03-20 18:07:26 -070076 // incStrong/decStrong token must be the same, doesn't matter what it is
77 AHardwareBuffer_to_GraphicBuffer(buffer)->decStrong((void*)AHardwareBuffer_acquire);
Mathias Agopian89ed4c82017-02-09 18:48:34 -080078}
79
80void AHardwareBuffer_describe(const AHardwareBuffer* buffer,
81 AHardwareBuffer_Desc* outDesc) {
82 if (!buffer || !outDesc) return;
83
84 const GraphicBuffer* gbuffer = AHardwareBuffer_to_GraphicBuffer(buffer);
85
86 outDesc->width = gbuffer->getWidth();
87 outDesc->height = gbuffer->getHeight();
88 outDesc->layers = gbuffer->getLayerCount();
Mathias Agopian07b920e2017-04-25 17:38:08 -070089 outDesc->format = AHardwareBuffer_convertFromPixelFormat(uint32_t(gbuffer->getPixelFormat()));
Mathias Agopian2c38b562017-04-20 16:35:39 -070090 outDesc->usage = AHardwareBuffer_convertFromGrallocUsageBits(gbuffer->getUsage());
Mathias Agopian07b920e2017-04-25 17:38:08 -070091 outDesc->stride = gbuffer->getStride();
92 outDesc->rfu0 = 0;
93 outDesc->rfu1 = 0;
Mathias Agopian89ed4c82017-02-09 18:48:34 -080094}
95
Valerie Haud2f4daf2019-02-15 13:49:00 -080096int AHardwareBuffer_lockAndGetInfo(AHardwareBuffer* buffer, uint64_t usage,
97 int32_t fence, const ARect* rect, void** outVirtualAddress,
98 int32_t* outBytesPerPixel, int32_t* outBytesPerStride) {
99 if (!buffer) return BAD_VALUE;
100
101 if (usage & ~(AHARDWAREBUFFER_USAGE_CPU_READ_MASK |
102 AHARDWAREBUFFER_USAGE_CPU_WRITE_MASK)) {
103 ALOGE("Invalid usage flags passed to AHardwareBuffer_lock; only "
104 "AHARDWAREBUFFER_USAGE_CPU_* flags are allowed");
105 return BAD_VALUE;
106 }
107
108 usage = AHardwareBuffer_convertToGrallocUsageBits(usage);
109 GraphicBuffer* gbuffer = AHardwareBuffer_to_GraphicBuffer(buffer);
110
111 //Mapper implementations before 3.0 will not return bytes per pixel or
112 //bytes per stride information.
113 if (gbuffer->getBufferMapperVersion() == GraphicBufferMapper::Version::GRALLOC_2) {
114 ALOGE("Mapper versions before 3.0 cannot retrieve bytes per pixel and bytes per stride info");
115 return INVALID_OPERATION;
116 }
117
118 if (gbuffer->getLayerCount() > 1) {
119 ALOGE("Buffer with multiple layers passed to AHardwareBuffer_lock; "
120 "only buffers with one layer are allowed");
121 return INVALID_OPERATION;
122 }
123
124 Rect bounds;
125 if (!rect) {
126 bounds.set(Rect(gbuffer->getWidth(), gbuffer->getHeight()));
127 } else {
128 bounds.set(Rect(rect->left, rect->top, rect->right, rect->bottom));
129 }
130 int result = gbuffer->lockAsync(usage, usage, bounds, outVirtualAddress, fence, outBytesPerPixel, outBytesPerStride);
131
132 // if hardware returns -1 for bytes per pixel or bytes per stride, we fail
133 // and unlock the buffer
134 if (*outBytesPerPixel == -1 || *outBytesPerStride == -1) {
135 gbuffer->unlock();
136 return INVALID_OPERATION;
137 }
138
139 return result;
140}
141
Mathias Agopian2c38b562017-04-20 16:35:39 -0700142int AHardwareBuffer_lock(AHardwareBuffer* buffer, uint64_t usage,
Valerie Haud2f4daf2019-02-15 13:49:00 -0800143 int32_t fence, const ARect* rect, void** outVirtualAddress) {
144 int32_t bytesPerPixel;
145 int32_t bytesPerStride;
146
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800147 if (!buffer) return BAD_VALUE;
148
Mathias Agopian2c38b562017-04-20 16:35:39 -0700149 if (usage & ~(AHARDWAREBUFFER_USAGE_CPU_READ_MASK |
150 AHARDWAREBUFFER_USAGE_CPU_WRITE_MASK)) {
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800151 ALOGE("Invalid usage flags passed to AHardwareBuffer_lock; only "
Krzysztof Kosińskia5c54bc2018-11-16 18:24:33 -0800152 "AHARDWAREBUFFER_USAGE_CPU_* flags are allowed");
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800153 return BAD_VALUE;
154 }
155
Mathias Agopian2c38b562017-04-20 16:35:39 -0700156 usage = AHardwareBuffer_convertToGrallocUsageBits(usage);
Krzysztof Kosińskia5c54bc2018-11-16 18:24:33 -0800157 GraphicBuffer* gbuffer = AHardwareBuffer_to_GraphicBuffer(buffer);
158
159 if (gbuffer->getLayerCount() > 1) {
160 ALOGE("Buffer with multiple layers passed to AHardwareBuffer_lock; "
161 "only buffers with one layer are allowed");
162 return INVALID_OPERATION;
163 }
164
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800165 Rect bounds;
166 if (!rect) {
Krzysztof Kosińskia5c54bc2018-11-16 18:24:33 -0800167 bounds.set(Rect(gbuffer->getWidth(), gbuffer->getHeight()));
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800168 } else {
169 bounds.set(Rect(rect->left, rect->top, rect->right, rect->bottom));
170 }
Valerie Haud2f4daf2019-02-15 13:49:00 -0800171 return gbuffer->lockAsync(usage, usage, bounds, outVirtualAddress, fence, &bytesPerPixel, &bytesPerStride);
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800172}
173
renn4e9e48d2018-10-11 14:43:13 -0700174int AHardwareBuffer_lockPlanes(AHardwareBuffer* buffer, uint64_t usage,
175 int32_t fence, const ARect* rect, AHardwareBuffer_Planes* outPlanes) {
176 if (!buffer || !outPlanes) return BAD_VALUE;
177
178 if (usage & ~(AHARDWAREBUFFER_USAGE_CPU_READ_MASK |
179 AHARDWAREBUFFER_USAGE_CPU_WRITE_MASK)) {
180 ALOGE("Invalid usage flags passed to AHardwareBuffer_lock; only "
181 " AHARDWAREBUFFER_USAGE_CPU_* flags are allowed");
182 return BAD_VALUE;
183 }
184
185 usage = AHardwareBuffer_convertToGrallocUsageBits(usage);
186 GraphicBuffer* gBuffer = AHardwareBuffer_to_GraphicBuffer(buffer);
187 Rect bounds;
188 if (!rect) {
189 bounds.set(Rect(gBuffer->getWidth(), gBuffer->getHeight()));
190 } else {
191 bounds.set(Rect(rect->left, rect->top, rect->right, rect->bottom));
192 }
193 int format = AHardwareBuffer_convertFromPixelFormat(uint32_t(gBuffer->getPixelFormat()));
194 memset(outPlanes->planes, 0, sizeof(outPlanes->planes));
195 if (AHardwareBuffer_formatIsYuv(format)) {
196 android_ycbcr yuvData;
197 int result = gBuffer->lockAsyncYCbCr(usage, bounds, &yuvData, fence);
198 if (result == 0) {
199 outPlanes->planeCount = 3;
200 outPlanes->planes[0].data = yuvData.y;
201 outPlanes->planes[0].pixelStride = 1;
202 outPlanes->planes[0].rowStride = yuvData.ystride;
203 outPlanes->planes[1].data = yuvData.cb;
204 outPlanes->planes[1].pixelStride = yuvData.chroma_step;
205 outPlanes->planes[1].rowStride = yuvData.cstride;
206 outPlanes->planes[2].data = yuvData.cr;
207 outPlanes->planes[2].pixelStride = yuvData.chroma_step;
208 outPlanes->planes[2].rowStride = yuvData.cstride;
209 } else {
210 outPlanes->planeCount = 0;
211 }
212 return result;
213 } else {
214 const uint32_t pixelStride = AHardwareBuffer_bytesPerPixel(format);
215 outPlanes->planeCount = 1;
216 outPlanes->planes[0].pixelStride = pixelStride;
217 outPlanes->planes[0].rowStride = gBuffer->getStride() * pixelStride;
218 return gBuffer->lockAsync(usage, usage, bounds, &outPlanes->planes[0].data, fence);
219 }
220}
221
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800222int AHardwareBuffer_unlock(AHardwareBuffer* buffer, int32_t* fence) {
223 if (!buffer) return BAD_VALUE;
224
225 GraphicBuffer* gBuffer = AHardwareBuffer_to_GraphicBuffer(buffer);
Jiwen 'Steve' Caiae6955f2017-06-02 15:23:26 -0700226 if (fence == nullptr)
227 return gBuffer->unlock();
228 else
229 return gBuffer->unlockAsync(fence);
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800230}
231
Mathias Agopian000879a2017-03-20 18:07:26 -0700232int AHardwareBuffer_sendHandleToUnixSocket(const AHardwareBuffer* buffer, int socketFd) {
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800233 if (!buffer) return BAD_VALUE;
234 const GraphicBuffer* gBuffer = AHardwareBuffer_to_GraphicBuffer(buffer);
235
236 size_t flattenedSize = gBuffer->getFlattenedSize();
237 size_t fdCount = gBuffer->getFdCount();
238
239 std::unique_ptr<uint8_t[]> data(new uint8_t[flattenedSize]);
240 std::unique_ptr<int[]> fds(new int[fdCount]);
241
242 // Make copies of needed items since flatten modifies them, and we don't
243 // want to send anything if there's an error during flatten.
244 size_t flattenedSizeCopy = flattenedSize;
245 size_t fdCountCopy = fdCount;
246 void* dataStart = data.get();
247 int* fdsStart = fds.get();
248 status_t err = gBuffer->flatten(dataStart, flattenedSizeCopy, fdsStart,
249 fdCountCopy);
250 if (err != NO_ERROR) {
251 return err;
252 }
253
254 struct iovec iov[1];
255 iov[0].iov_base = data.get();
256 iov[0].iov_len = flattenedSize;
257
Craig Donner1b1d3002017-04-12 18:38:07 -0700258 char buf[CMSG_SPACE(kFdBufferSize)];
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800259 struct msghdr msg = {
260 .msg_control = buf,
261 .msg_controllen = sizeof(buf),
262 .msg_iov = &iov[0],
263 .msg_iovlen = 1,
264 };
265
266 struct cmsghdr* cmsg = CMSG_FIRSTHDR(&msg);
267 cmsg->cmsg_level = SOL_SOCKET;
268 cmsg->cmsg_type = SCM_RIGHTS;
269 cmsg->cmsg_len = CMSG_LEN(sizeof(int) * fdCount);
270 int* fdData = reinterpret_cast<int*>(CMSG_DATA(cmsg));
271 memcpy(fdData, fds.get(), sizeof(int) * fdCount);
272 msg.msg_controllen = cmsg->cmsg_len;
273
Jesse Hall81d31972017-05-15 14:14:01 -0700274 int result;
275 do {
276 result = sendmsg(socketFd, &msg, 0);
277 } while (result == -1 && errno == EINTR);
278 if (result == -1) {
279 result = errno;
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800280 ALOGE("Error writing AHardwareBuffer to socket: error %#x (%s)",
Jesse Hall81d31972017-05-15 14:14:01 -0700281 result, strerror(result));
282 return -result;
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800283 }
Jesse Hall81d31972017-05-15 14:14:01 -0700284
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800285 return NO_ERROR;
286}
287
Mathias Agopian000879a2017-03-20 18:07:26 -0700288int AHardwareBuffer_recvHandleFromUnixSocket(int socketFd, AHardwareBuffer** outBuffer) {
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800289 if (!outBuffer) return BAD_VALUE;
290
Craig Donner1b1d3002017-04-12 18:38:07 -0700291 static constexpr int kMessageBufferSize = 4096 * sizeof(int);
292
293 std::unique_ptr<char[]> dataBuf(new char[kMessageBufferSize]);
294 char fdBuf[CMSG_SPACE(kFdBufferSize)];
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800295 struct iovec iov[1];
Craig Donner1b1d3002017-04-12 18:38:07 -0700296 iov[0].iov_base = dataBuf.get();
297 iov[0].iov_len = kMessageBufferSize;
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800298
299 struct msghdr msg = {
300 .msg_control = fdBuf,
301 .msg_controllen = sizeof(fdBuf),
302 .msg_iov = &iov[0],
303 .msg_iovlen = 1,
304 };
305
Jesse Hall81d31972017-05-15 14:14:01 -0700306 int result;
307 do {
308 result = recvmsg(socketFd, &msg, 0);
309 } while (result == -1 && errno == EINTR);
310 if (result == -1) {
311 result = errno;
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800312 ALOGE("Error reading AHardwareBuffer from socket: error %#x (%s)",
Jesse Hall81d31972017-05-15 14:14:01 -0700313 result, strerror(result));
314 return -result;
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800315 }
316
317 if (msg.msg_iovlen != 1) {
318 ALOGE("Error reading AHardwareBuffer from socket: bad data length");
319 return INVALID_OPERATION;
320 }
321
322 if (msg.msg_controllen % sizeof(int) != 0) {
323 ALOGE("Error reading AHardwareBuffer from socket: bad fd length");
324 return INVALID_OPERATION;
325 }
326
327 size_t dataLen = msg.msg_iov[0].iov_len;
328 const void* data = static_cast<const void*>(msg.msg_iov[0].iov_base);
329 if (!data) {
330 ALOGE("Error reading AHardwareBuffer from socket: no buffer data");
331 return INVALID_OPERATION;
332 }
333
334 struct cmsghdr* cmsg = CMSG_FIRSTHDR(&msg);
335 if (!cmsg) {
336 ALOGE("Error reading AHardwareBuffer from socket: no fd header");
337 return INVALID_OPERATION;
338 }
339
340 size_t fdCount = msg.msg_controllen >> 2;
341 const int* fdData = reinterpret_cast<const int*>(CMSG_DATA(cmsg));
342 if (!fdData) {
343 ALOGE("Error reading AHardwareBuffer from socket: no fd data");
344 return INVALID_OPERATION;
345 }
346
347 GraphicBuffer* gBuffer = new GraphicBuffer();
348 status_t err = gBuffer->unflatten(data, dataLen, fdData, fdCount);
349 if (err != NO_ERROR) {
350 return err;
351 }
352 *outBuffer = AHardwareBuffer_from_GraphicBuffer(gBuffer);
353 // Ensure the buffer has a positive ref-count.
354 AHardwareBuffer_acquire(*outBuffer);
355
356 return NO_ERROR;
357}
358
Krzysztof Kosińskia5c54bc2018-11-16 18:24:33 -0800359int AHardwareBuffer_isSupported(const AHardwareBuffer_Desc* desc) {
360 if (!desc) return 0;
361 if (!AHardwareBuffer_isValidDescription(desc, /*log=*/false)) return 0;
362
Valerie Haua2414f02019-02-07 13:42:43 -0800363 bool supported = false;
364 GraphicBuffer* gBuffer = new GraphicBuffer();
365 status_t err = gBuffer->isSupported(desc->width, desc->height, desc->format, desc->layers,
366 desc->usage, &supported);
367
368 if (err == NO_ERROR) {
369 return supported;
370 }
371
372 // function isSupported is not implemented on device or an error occurred during HAL
373 // query. Make a trial allocation.
Krzysztof Kosińskia5c54bc2018-11-16 18:24:33 -0800374 AHardwareBuffer_Desc trialDesc = *desc;
375 trialDesc.width = 4;
376 trialDesc.height = desc->format == AHARDWAREBUFFER_FORMAT_BLOB ? 1 : 4;
Krzysztof Kosińskic4b9ce02019-01-02 16:27:05 -0800377 if (desc->usage & AHARDWAREBUFFER_USAGE_GPU_CUBE_MAP) {
378 trialDesc.layers = desc->layers == 6 ? 6 : 12;
379 } else {
380 trialDesc.layers = desc->layers == 1 ? 1 : 2;
381 }
Krzysztof Kosińskia5c54bc2018-11-16 18:24:33 -0800382 AHardwareBuffer* trialBuffer = nullptr;
383 int result = AHardwareBuffer_allocate(&trialDesc, &trialBuffer);
384 if (result == NO_ERROR) {
385 AHardwareBuffer_release(trialBuffer);
386 return 1;
387 }
388 return 0;
389}
390
Jesse Hall1ee859f2017-04-17 08:52:32 -0700391
392// ----------------------------------------------------------------------------
393// VNDK functions
394// ----------------------------------------------------------------------------
395
396const native_handle_t* AHardwareBuffer_getNativeHandle(
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800397 const AHardwareBuffer* buffer) {
398 if (!buffer) return nullptr;
399 const GraphicBuffer* gbuffer = AHardwareBuffer_to_GraphicBuffer(buffer);
400 return gbuffer->handle;
401}
402
Jesse Hallfbe58352018-04-14 11:20:59 -0700403int AHardwareBuffer_createFromHandle(const AHardwareBuffer_Desc* desc,
404 const native_handle_t* handle, int32_t method,
405 AHardwareBuffer** outBuffer) {
406 static_assert(static_cast<int32_t>(AHARDWAREBUFFER_CREATE_FROM_HANDLE_METHOD_REGISTER) ==
407 static_cast<int32_t>(GraphicBuffer::TAKE_UNREGISTERED_HANDLE));
408 static_assert(static_cast<int32_t>(AHARDWAREBUFFER_CREATE_FROM_HANDLE_METHOD_CLONE) ==
409 static_cast<int32_t>(GraphicBuffer::CLONE_HANDLE));
410
411 if (!desc || !handle || !outBuffer) return BAD_VALUE;
412 if (!(method == AHARDWAREBUFFER_CREATE_FROM_HANDLE_METHOD_REGISTER ||
413 method == AHARDWAREBUFFER_CREATE_FROM_HANDLE_METHOD_CLONE))
414 return BAD_VALUE;
415 if (desc->rfu0 != 0 || desc->rfu1 != 0) return BAD_VALUE;
416 if (desc->format == AHARDWAREBUFFER_FORMAT_BLOB && desc->height != 1) return BAD_VALUE;
417
418 const int format = AHardwareBuffer_convertToPixelFormat(desc->format);
419 const uint64_t usage = AHardwareBuffer_convertToGrallocUsageBits(desc->usage);
420 const auto wrapMethod = static_cast<GraphicBuffer::HandleWrapMethod>(method);
421 sp<GraphicBuffer> gbuffer(new GraphicBuffer(handle, wrapMethod, desc->width, desc->height,
422 format, desc->layers, usage, desc->stride));
423 status_t err = gbuffer->initCheck();
424 if (err != 0 || gbuffer->handle == 0) return err;
425
426 *outBuffer = AHardwareBuffer_from_GraphicBuffer(gbuffer.get());
427 // Ensure the buffer doesn't get destroyed when the sp<> goes away.
428 AHardwareBuffer_acquire(*outBuffer);
429
430 return NO_ERROR;
431}
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800432
433// ----------------------------------------------------------------------------
434// Helpers implementation
435// ----------------------------------------------------------------------------
436
437namespace android {
438
Krzysztof Kosińskia5c54bc2018-11-16 18:24:33 -0800439bool AHardwareBuffer_isValidDescription(const AHardwareBuffer_Desc* desc, bool log) {
440 if (desc->width == 0 || desc->height == 0 || desc->layers == 0) {
441 ALOGE_IF(log, "Width, height and layers must all be nonzero");
442 return false;
443 }
Craig Donnera5a719e2017-02-24 16:02:08 -0800444
Krzysztof Kosińskia5c54bc2018-11-16 18:24:33 -0800445 if (!AHardwareBuffer_isValidPixelFormat(desc->format)) {
446 ALOGE_IF(log, "Invalid AHardwareBuffer pixel format %u (%#x))",
447 desc->format, desc->format);
448 return false;
449 }
450
451 if (desc->rfu0 != 0 || desc->rfu1 != 0) {
452 ALOGE_IF(log, "AHardwareBuffer_Desc::rfu fields must be 0");
453 return false;
454 }
455
456 if (desc->format == AHARDWAREBUFFER_FORMAT_BLOB) {
457 if (desc->height != 1 || desc->layers != 1) {
458 ALOGE_IF(log, "Height and layers must be 1 for AHARDWAREBUFFER_FORMAT_BLOB");
459 return false;
460 }
461 const uint64_t blobInvalidGpuMask =
462 AHARDWAREBUFFER_USAGE_GPU_SAMPLED_IMAGE |
463 AHARDWAREBUFFER_USAGE_GPU_FRAMEBUFFER |
464 AHARDWAREBUFFER_USAGE_GPU_MIPMAP_COMPLETE |
465 AHARDWAREBUFFER_USAGE_GPU_CUBE_MAP;
466 if (desc->usage & blobInvalidGpuMask) {
467 ALOGE_IF(log, "Invalid GPU usage flag for AHARDWAREBUFFER_FORMAT_BLOB; "
468 "only AHARDWAREBUFFER_USAGE_GPU_DATA_BUFFER is allowed");
469 return false;
470 }
471 if (desc->usage & AHARDWAREBUFFER_USAGE_VIDEO_ENCODE) {
472 ALOGE_IF(log, "AHARDWAREBUFFER_FORMAT_BLOB cannot be encoded as video");
473 return false;
474 }
renn4e9e48d2018-10-11 14:43:13 -0700475 } else if (AHardwareBuffer_formatIsYuv(desc->format)) {
476 if (desc->layers != 1) {
477 ALOGE_IF(log, "Layers must be 1 for YUV formats.");
478 return false;
479 }
480 const uint64_t yuvInvalidGpuMask =
481 AHARDWAREBUFFER_USAGE_GPU_MIPMAP_COMPLETE |
482 AHARDWAREBUFFER_USAGE_GPU_CUBE_MAP;
483 if (desc->usage & yuvInvalidGpuMask) {
484 ALOGE_IF(log, "Invalid usage flags specified for YUV format; "
485 "mip-mapping and cube-mapping are not allowed.");
486 return false;
487 }
Krzysztof Kosińskia5c54bc2018-11-16 18:24:33 -0800488 } else {
489 if (desc->usage & AHARDWAREBUFFER_USAGE_SENSOR_DIRECT_DATA) {
490 ALOGE_IF(log, "AHARDWAREBUFFER_USAGE_SENSOR_DIRECT_DATA requires AHARDWAREBUFFER_FORMAT_BLOB");
491 return false;
492 }
493 if (desc->usage & AHARDWAREBUFFER_USAGE_GPU_DATA_BUFFER) {
494 ALOGE_IF(log, "AHARDWAREBUFFER_USAGE_GPU_DATA_BUFFER requires AHARDWAREBUFFER_FORMAT_BLOB");
495 return false;
496 }
497 }
498
499 if ((desc->usage & (AHARDWAREBUFFER_USAGE_CPU_READ_MASK | AHARDWAREBUFFER_USAGE_CPU_WRITE_MASK)) &&
500 (desc->usage & AHARDWAREBUFFER_USAGE_PROTECTED_CONTENT)) {
501 ALOGE_IF(log, "AHARDWAREBUFFER_USAGE_PROTECTED_CONTENT requires AHARDWAREBUFFER_USAGE_CPU_READ_NEVER "
502 "and AHARDWAREBUFFER_USAGE_CPU_WRITE_NEVER");
503 return false;
504 }
505
506 if (desc->usage & AHARDWAREBUFFER_USAGE_GPU_CUBE_MAP) {
507 if (desc->width != desc->height) {
508 ALOGE_IF(log, "Cube maps must be square");
509 return false;
510 }
511 if (desc->layers % 6 != 0) {
512 ALOGE_IF(log, "Cube map layers must be a multiple of 6");
513 return false;
514 }
515 }
516 return true;
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800517}
518
Mathias Agopian3a11413a2017-06-08 19:44:17 -0700519bool AHardwareBuffer_isValidPixelFormat(uint32_t format) {
520 static_assert(HAL_PIXEL_FORMAT_RGBA_8888 == AHARDWAREBUFFER_FORMAT_R8G8B8A8_UNORM,
521 "HAL and AHardwareBuffer pixel format don't match");
522 static_assert(HAL_PIXEL_FORMAT_RGBX_8888 == AHARDWAREBUFFER_FORMAT_R8G8B8X8_UNORM,
523 "HAL and AHardwareBuffer pixel format don't match");
524 static_assert(HAL_PIXEL_FORMAT_RGB_565 == AHARDWAREBUFFER_FORMAT_R5G6B5_UNORM,
525 "HAL and AHardwareBuffer pixel format don't match");
526 static_assert(HAL_PIXEL_FORMAT_RGB_888 == AHARDWAREBUFFER_FORMAT_R8G8B8_UNORM,
527 "HAL and AHardwareBuffer pixel format don't match");
528 static_assert(HAL_PIXEL_FORMAT_RGBA_FP16 == AHARDWAREBUFFER_FORMAT_R16G16B16A16_FLOAT,
529 "HAL and AHardwareBuffer pixel format don't match");
530 static_assert(HAL_PIXEL_FORMAT_RGBA_1010102 == AHARDWAREBUFFER_FORMAT_R10G10B10A2_UNORM,
531 "HAL and AHardwareBuffer pixel format don't match");
532 static_assert(HAL_PIXEL_FORMAT_BLOB == AHARDWAREBUFFER_FORMAT_BLOB,
533 "HAL and AHardwareBuffer pixel format don't match");
Craig Donnere6ecb922017-12-27 14:59:29 -0800534 static_assert(HAL_PIXEL_FORMAT_DEPTH_16 == AHARDWAREBUFFER_FORMAT_D16_UNORM,
535 "HAL and AHardwareBuffer pixel format don't match");
536 static_assert(HAL_PIXEL_FORMAT_DEPTH_24 == AHARDWAREBUFFER_FORMAT_D24_UNORM,
537 "HAL and AHardwareBuffer pixel format don't match");
538 static_assert(HAL_PIXEL_FORMAT_DEPTH_24_STENCIL_8 == AHARDWAREBUFFER_FORMAT_D24_UNORM_S8_UINT,
539 "HAL and AHardwareBuffer pixel format don't match");
540 static_assert(HAL_PIXEL_FORMAT_DEPTH_32F == AHARDWAREBUFFER_FORMAT_D32_FLOAT,
541 "HAL and AHardwareBuffer pixel format don't match");
542 static_assert(HAL_PIXEL_FORMAT_DEPTH_32F_STENCIL_8 == AHARDWAREBUFFER_FORMAT_D32_FLOAT_S8_UINT,
543 "HAL and AHardwareBuffer pixel format don't match");
544 static_assert(HAL_PIXEL_FORMAT_STENCIL_8 == AHARDWAREBUFFER_FORMAT_S8_UINT,
545 "HAL and AHardwareBuffer pixel format don't match");
Mathias Agopian3a11413a2017-06-08 19:44:17 -0700546 static_assert(HAL_PIXEL_FORMAT_BGRA_8888 == AHARDWAREBUFFER_FORMAT_B8G8R8A8_UNORM,
547 "HAL and AHardwareBuffer pixel format don't match");
548 static_assert(HAL_PIXEL_FORMAT_YV12 == AHARDWAREBUFFER_FORMAT_YV12,
549 "HAL and AHardwareBuffer pixel format don't match");
550 static_assert(HAL_PIXEL_FORMAT_Y8 == AHARDWAREBUFFER_FORMAT_Y8,
551 "HAL and AHardwareBuffer pixel format don't match");
552 static_assert(HAL_PIXEL_FORMAT_Y16 == AHARDWAREBUFFER_FORMAT_Y16,
553 "HAL and AHardwareBuffer pixel format don't match");
554 static_assert(HAL_PIXEL_FORMAT_RAW16 == AHARDWAREBUFFER_FORMAT_RAW16,
555 "HAL and AHardwareBuffer pixel format don't match");
556 static_assert(HAL_PIXEL_FORMAT_RAW10 == AHARDWAREBUFFER_FORMAT_RAW10,
557 "HAL and AHardwareBuffer pixel format don't match");
558 static_assert(HAL_PIXEL_FORMAT_RAW12 == AHARDWAREBUFFER_FORMAT_RAW12,
559 "HAL and AHardwareBuffer pixel format don't match");
560 static_assert(HAL_PIXEL_FORMAT_RAW_OPAQUE == AHARDWAREBUFFER_FORMAT_RAW_OPAQUE,
561 "HAL and AHardwareBuffer pixel format don't match");
562 static_assert(HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED == AHARDWAREBUFFER_FORMAT_IMPLEMENTATION_DEFINED,
563 "HAL and AHardwareBuffer pixel format don't match");
564 static_assert(HAL_PIXEL_FORMAT_YCBCR_420_888 == AHARDWAREBUFFER_FORMAT_Y8Cb8Cr8_420,
565 "HAL and AHardwareBuffer pixel format don't match");
Mathias Agopian3a11413a2017-06-08 19:44:17 -0700566 static_assert(HAL_PIXEL_FORMAT_YCBCR_422_SP == AHARDWAREBUFFER_FORMAT_YCbCr_422_SP,
567 "HAL and AHardwareBuffer pixel format don't match");
568 static_assert(HAL_PIXEL_FORMAT_YCRCB_420_SP == AHARDWAREBUFFER_FORMAT_YCrCb_420_SP,
569 "HAL and AHardwareBuffer pixel format don't match");
570 static_assert(HAL_PIXEL_FORMAT_YCBCR_422_I == AHARDWAREBUFFER_FORMAT_YCbCr_422_I,
571 "HAL and AHardwareBuffer pixel format don't match");
572
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800573 switch (format) {
Mathias Agopian3a11413a2017-06-08 19:44:17 -0700574 case AHARDWAREBUFFER_FORMAT_R8G8B8A8_UNORM:
575 case AHARDWAREBUFFER_FORMAT_R8G8B8X8_UNORM:
576 case AHARDWAREBUFFER_FORMAT_R5G6B5_UNORM:
577 case AHARDWAREBUFFER_FORMAT_R8G8B8_UNORM:
578 case AHARDWAREBUFFER_FORMAT_R16G16B16A16_FLOAT:
579 case AHARDWAREBUFFER_FORMAT_R10G10B10A2_UNORM:
580 case AHARDWAREBUFFER_FORMAT_BLOB:
Craig Donnere6ecb922017-12-27 14:59:29 -0800581 case AHARDWAREBUFFER_FORMAT_D16_UNORM:
582 case AHARDWAREBUFFER_FORMAT_D24_UNORM:
583 case AHARDWAREBUFFER_FORMAT_D24_UNORM_S8_UINT:
584 case AHARDWAREBUFFER_FORMAT_D32_FLOAT:
585 case AHARDWAREBUFFER_FORMAT_D32_FLOAT_S8_UINT:
586 case AHARDWAREBUFFER_FORMAT_S8_UINT:
renn4e9e48d2018-10-11 14:43:13 -0700587 case AHARDWAREBUFFER_FORMAT_Y8Cb8Cr8_420:
Mathias Agopian3a11413a2017-06-08 19:44:17 -0700588 // VNDK formats only -- unfortunately we can't differentiate from where we're called
589 case AHARDWAREBUFFER_FORMAT_B8G8R8A8_UNORM:
590 case AHARDWAREBUFFER_FORMAT_YV12:
591 case AHARDWAREBUFFER_FORMAT_Y8:
592 case AHARDWAREBUFFER_FORMAT_Y16:
593 case AHARDWAREBUFFER_FORMAT_RAW16:
594 case AHARDWAREBUFFER_FORMAT_RAW10:
595 case AHARDWAREBUFFER_FORMAT_RAW12:
596 case AHARDWAREBUFFER_FORMAT_RAW_OPAQUE:
597 case AHARDWAREBUFFER_FORMAT_IMPLEMENTATION_DEFINED:
Mathias Agopian3a11413a2017-06-08 19:44:17 -0700598 case AHARDWAREBUFFER_FORMAT_YCbCr_422_SP:
599 case AHARDWAREBUFFER_FORMAT_YCrCb_420_SP:
600 case AHARDWAREBUFFER_FORMAT_YCbCr_422_I:
601 return true;
602
603 default:
604 return false;
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800605 }
606}
607
renn4e9e48d2018-10-11 14:43:13 -0700608bool AHardwareBuffer_formatIsYuv(uint32_t format) {
609 switch (format) {
610 case AHARDWAREBUFFER_FORMAT_Y8Cb8Cr8_420:
611 case AHARDWAREBUFFER_FORMAT_YV12:
612 case AHARDWAREBUFFER_FORMAT_Y8:
613 case AHARDWAREBUFFER_FORMAT_Y16:
614 case AHARDWAREBUFFER_FORMAT_YCbCr_422_SP:
615 case AHARDWAREBUFFER_FORMAT_YCrCb_420_SP:
616 case AHARDWAREBUFFER_FORMAT_YCbCr_422_I:
617 return true;
618 default:
619 return false;
620 }
621}
622
623uint32_t AHardwareBuffer_bytesPerPixel(uint32_t format) {
624 switch (format) {
625 case AHARDWAREBUFFER_FORMAT_R5G6B5_UNORM:
626 case AHARDWAREBUFFER_FORMAT_D16_UNORM:
627 return 2;
628 case AHARDWAREBUFFER_FORMAT_R8G8B8_UNORM:
629 case AHARDWAREBUFFER_FORMAT_D24_UNORM:
630 return 3;
631 case AHARDWAREBUFFER_FORMAT_R8G8B8A8_UNORM:
632 case AHARDWAREBUFFER_FORMAT_R8G8B8X8_UNORM:
633 case AHARDWAREBUFFER_FORMAT_D32_FLOAT:
634 case AHARDWAREBUFFER_FORMAT_R10G10B10A2_UNORM:
635 case AHARDWAREBUFFER_FORMAT_D24_UNORM_S8_UINT:
636 return 4;
637 default:
638 return 0;
639 }
640}
641
Mathias Agopian3a11413a2017-06-08 19:44:17 -0700642uint32_t AHardwareBuffer_convertFromPixelFormat(uint32_t hal_format) {
643 return hal_format;
644}
645
646uint32_t AHardwareBuffer_convertToPixelFormat(uint32_t ahardwarebuffer_format) {
647 return ahardwarebuffer_format;
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800648}
649
Mathias Agopian2c38b562017-04-20 16:35:39 -0700650uint64_t AHardwareBuffer_convertToGrallocUsageBits(uint64_t usage) {
Craig Donnere6ecb922017-12-27 14:59:29 -0800651 using android::hardware::graphics::common::V1_1::BufferUsage;
Mathias Agopian2c38b562017-04-20 16:35:39 -0700652 static_assert(AHARDWAREBUFFER_USAGE_CPU_READ_NEVER == (uint64_t)BufferUsage::CPU_READ_NEVER,
653 "gralloc and AHardwareBuffer flags don't match");
654 static_assert(AHARDWAREBUFFER_USAGE_CPU_READ_RARELY == (uint64_t)BufferUsage::CPU_READ_RARELY,
655 "gralloc and AHardwareBuffer flags don't match");
656 static_assert(AHARDWAREBUFFER_USAGE_CPU_READ_OFTEN == (uint64_t)BufferUsage::CPU_READ_OFTEN,
657 "gralloc and AHardwareBuffer flags don't match");
658 static_assert(AHARDWAREBUFFER_USAGE_CPU_WRITE_NEVER == (uint64_t)BufferUsage::CPU_WRITE_NEVER,
659 "gralloc and AHardwareBuffer flags don't match");
660 static_assert(AHARDWAREBUFFER_USAGE_CPU_WRITE_RARELY == (uint64_t)BufferUsage::CPU_WRITE_RARELY,
661 "gralloc and AHardwareBuffer flags don't match");
662 static_assert(AHARDWAREBUFFER_USAGE_CPU_WRITE_OFTEN == (uint64_t)BufferUsage::CPU_WRITE_OFTEN,
663 "gralloc and AHardwareBuffer flags don't match");
664 static_assert(AHARDWAREBUFFER_USAGE_GPU_SAMPLED_IMAGE == (uint64_t)BufferUsage::GPU_TEXTURE,
665 "gralloc and AHardwareBuffer flags don't match");
Krzysztof Kosińskia5c54bc2018-11-16 18:24:33 -0800666 static_assert(AHARDWAREBUFFER_USAGE_GPU_FRAMEBUFFER == (uint64_t)BufferUsage::GPU_RENDER_TARGET,
Mathias Agopian2c38b562017-04-20 16:35:39 -0700667 "gralloc and AHardwareBuffer flags don't match");
668 static_assert(AHARDWAREBUFFER_USAGE_PROTECTED_CONTENT == (uint64_t)BufferUsage::PROTECTED,
669 "gralloc and AHardwareBuffer flags don't match");
670 static_assert(AHARDWAREBUFFER_USAGE_VIDEO_ENCODE == (uint64_t)BufferUsage::VIDEO_ENCODER,
671 "gralloc and AHardwareBuffer flags don't match");
672 static_assert(AHARDWAREBUFFER_USAGE_GPU_DATA_BUFFER == (uint64_t)BufferUsage::GPU_DATA_BUFFER,
673 "gralloc and AHardwareBuffer flags don't match");
674 static_assert(AHARDWAREBUFFER_USAGE_SENSOR_DIRECT_DATA == (uint64_t)BufferUsage::SENSOR_DIRECT_DATA,
675 "gralloc and AHardwareBuffer flags don't match");
Craig Donnere6ecb922017-12-27 14:59:29 -0800676 static_assert(AHARDWAREBUFFER_USAGE_GPU_CUBE_MAP == (uint64_t)BufferUsage::GPU_CUBE_MAP,
677 "gralloc and AHardwareBuffer flags don't match");
678 static_assert(AHARDWAREBUFFER_USAGE_GPU_MIPMAP_COMPLETE == (uint64_t)BufferUsage::GPU_MIPMAP_COMPLETE,
679 "gralloc and AHardwareBuffer flags don't match");
Mathias Agopian2c38b562017-04-20 16:35:39 -0700680 return usage;
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800681}
682
Mathias Agopian2c38b562017-04-20 16:35:39 -0700683uint64_t AHardwareBuffer_convertFromGrallocUsageBits(uint64_t usage) {
684 return usage;
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800685}
686
687const GraphicBuffer* AHardwareBuffer_to_GraphicBuffer(const AHardwareBuffer* buffer) {
Pawin Vongmasae672cd02019-02-14 16:01:29 -0800688 return GraphicBuffer::fromAHardwareBuffer(buffer);
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800689}
690
691GraphicBuffer* AHardwareBuffer_to_GraphicBuffer(AHardwareBuffer* buffer) {
Pawin Vongmasae672cd02019-02-14 16:01:29 -0800692 return GraphicBuffer::fromAHardwareBuffer(buffer);
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800693}
694
Mathias Agopian61963402017-02-24 16:38:15 -0800695const ANativeWindowBuffer* AHardwareBuffer_to_ANativeWindowBuffer(const AHardwareBuffer* buffer) {
696 return AHardwareBuffer_to_GraphicBuffer(buffer)->getNativeBuffer();
697}
698
699ANativeWindowBuffer* AHardwareBuffer_to_ANativeWindowBuffer(AHardwareBuffer* buffer) {
700 return AHardwareBuffer_to_GraphicBuffer(buffer)->getNativeBuffer();
701}
702
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800703AHardwareBuffer* AHardwareBuffer_from_GraphicBuffer(GraphicBuffer* buffer) {
Pawin Vongmasae672cd02019-02-14 16:01:29 -0800704 return buffer->toAHardwareBuffer();
Mathias Agopian89ed4c82017-02-09 18:48:34 -0800705}
706
707} // namespace android