Loading include/android/hardware_buffer.h 0 → 100644 +217 −0 Original line number Diff line number Diff line /* * Copyright 2017 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @file hardware_buffer.h */ #ifndef ANDROID_HARDWARE_BUFFER_H #define ANDROID_HARDWARE_BUFFER_H #include <inttypes.h> #include <sys/cdefs.h> #include <android/rect.h> __BEGIN_DECLS /** * Buffer pixel formats. */ enum { /** * Corresponding formats: * Vulkan: VK_FORMAT_R8G8B8A8_UNORM * OpenGL ES: GL_RGBA8 */ AHARDWAREBUFFER_FORMAT_R8G8B8A8_UNORM = 1, /** * Corresponding formats: * Vulkan: VK_FORMAT_R8G8B8A8_UNORM * OpenGL ES: GL_RGBA8 */ AHARDWAREBUFFER_FORMAT_R8G8B8X8_UNORM = 2, /** * Corresponding formats: * Vulkan: VK_FORMAT_R8G8B8_UNORM * OpenGL ES: GL_RGB8 */ AHARDWAREBUFFER_FORMAT_R8G8B8_UNORM = 3, /** * Corresponding formats: * Vulkan: VK_FORMAT_R5G6B5_UNORM_PACK16 * OpenGL ES: GL_RGB565 */ AHARDWAREBUFFER_FORMAT_R5G6B5_UNORM = 4, /** * Corresponding formats: * Vulkan: VK_FORMAT_R16G16B16A16_SFLOAT * OpenGL ES: GL_RGBA16F */ AHARDWAREBUFFER_FORMAT_R16G16B16A16_SFLOAT = 5, }; enum { /* The buffer will sometimes be read by the CPU */ AHARDWAREBUFFER_USAGE0_CPU_READ = 1ULL << 1, /* The buffer will often be read by the CPU*/ AHARDWAREBUFFER_USAGE0_CPU_READ_OFTEN = 1ULL << 2 | AHARDWAREBUFFER_USAGE0_CPU_READ, /* The buffer will sometimes be written to by the CPU */ AHARDWAREBUFFER_USAGE0_CPU_WRITE = 1ULL << 5, /* The buffer will often be written to by the CPU */ AHARDWAREBUFFER_USAGE0_CPU_WRITE_OFTEN = 1ULL << 6 | AHARDWAREBUFFER_USAGE0_CPU_WRITE, /* The buffer will be read from by the GPU */ AHARDWAREBUFFER_USAGE0_GPU_SAMPLED_IMAGE = 1ULL << 10, /* The buffer will be written to by the GPU */ AHARDWAREBUFFER_USAGE0_GPU_COLOR_OUTPUT = 1ULL << 11, /* The buffer will be read from and written to by the GPU */ AHARDWAREBUFFER_USAGE0_GPU_STORAGE_IMAGE = AHARDWAREBUFFER_USAGE0_GPU_SAMPLED_IMAGE | AHARDWAREBUFFER_USAGE0_GPU_COLOR_OUTPUT, /* The buffer will be used as a cubemap texture */ AHARDWAREBUFFER_USAGE0_GPU_CUBEMAP = 1ULL << 13, /* The buffer will be used as a shader storage or uniform buffer object*/ AHARDWAREBUFFER_USAGE0_GPU_DATA_BUFFER = 1ULL << 14, /* The buffer must not be used outside of a protected hardware path */ AHARDWAREBUFFER_USAGE0_PROTECTED_CONTENT = 1ULL << 18, /** The buffer will be used for sensor direct data */ AHARDWAREBUFFER_USAGE0_SENSOR_DIRECT_DATA = 1ULL << 29, /* The buffer will be read by a hardware video encoder */ AHARDWAREBUFFER_USAGE0_VIDEO_ENCODE = 1ULL << 21, }; typedef struct AHardwareBuffer_Desc { uint32_t width; uint32_t height; uint32_t layers; uint64_t usage0; // Combination of AHARDWAREBUFFER_USAGE0_* uint64_t usage1; // Initialize to zero, reserved for future use uint32_t format; // One of AHARDWAREBUFFER_FORMAT_* } AHardwareBuffer_Desc; typedef struct AHardwareBuffer AHardwareBuffer; /** * Allocates a buffer that backs an AHardwareBuffer using the passed * AHardwareBuffer_Desc. * * Returns NO_ERROR on success, or an error number of the allocation fails for * any reason. */ int AHardwareBuffer_allocate(const AHardwareBuffer_Desc* desc, AHardwareBuffer** outBuffer); /** * Acquire a reference on the given AHardwareBuffer object. This prevents the * object from being deleted until the last reference is removed. */ void AHardwareBuffer_acquire(AHardwareBuffer* buffer); /** * Remove a reference that was previously acquired with * AHardwareBuffer_acquire(). */ void AHardwareBuffer_release(AHardwareBuffer* buffer); /** * Return a description of the AHardwareBuffer in the passed * AHardwareBuffer_Desc struct. */ void AHardwareBuffer_describe(const AHardwareBuffer* buffer, AHardwareBuffer_Desc* outDesc); /* * Lock the AHardwareBuffer for reading or writing, depending on the usage flags * passed. This call may block if the hardware needs to finish rendering or if * CPU caches need to be synchronized, or possibly for other implementation- * specific reasons. If fence is not negative, then it specifies a fence file * descriptor that will be signaled when the buffer is locked, otherwise the * caller will block until the buffer is available. * * If rect is not NULL, the caller promises to modify only data in the area * specified by rect. If rect is NULL, the caller may modify the contents of the * entire buffer. * * The content of the buffer outside of the specified rect is NOT modified * by this call. * * The buffer usage may only specify AHARDWAREBUFFER_USAGE0_CPU_*. If set, then * outVirtualAddress is filled with the address of the buffer in virtual memory, * otherwise this function will fail. * * THREADING CONSIDERATIONS: * * It is legal for several different threads to lock a buffer for read access; * none of the threads are blocked. * * Locking a buffer simultaneously for write or read/write is undefined, but * will neither terminate the process nor block the caller; AHardwareBuffer_lock * may return an error or leave the buffer's content into an indeterminate * state. * * Returns NO_ERROR on success, BAD_VALUE if the buffer is NULL or if the usage0 * flags are not a combination of AHARDWAREBUFFER_USAGE0_CPU_*, or an error * number of the lock fails for any reason. */ int AHardwareBuffer_lock(AHardwareBuffer* buffer, uint64_t usage0, int32_t fence, const ARect* rect, void** outVirtualAddress); /* * Unlock the AHardwareBuffer; must be called after all changes to the buffer * are completed by the caller. If fence is not NULL then it will be set to a * file descriptor that is signaled when all pending work on the buffer is * completed. The caller is responsible for closing the fence when it is no * longer needed. * * Returns NO_ERROR on success, BAD_VALUE if the buffer is NULL, or an error * number of the lock fails for any reason. */ int AHardwareBuffer_unlock(AHardwareBuffer* buffer, int32_t* fence); /* * Send the AHardwareBuffer to an AF_UNIX socket. * * Returns NO_ERROR on success, BAD_VALUE if the buffer is NULL, or an error * number of the lock fails for any reason. */ int AHardwareBuffer_sendHandleToUnixSocket(const AHardwareBuffer* buffer, int socketFd); /* * Receive the AHardwareBuffer from an AF_UNIX socket. * * Returns NO_ERROR on success, BAD_VALUE if the buffer is NULL, or an error * number of the lock fails for any reason. */ int AHardwareBuffer_recvHandleFromUnixSocket(int socketFd, AHardwareBuffer** outBuffer); // ---------------------------------------------------------------------------- // Everything below here is part of the public NDK API, but is intended only // for use by device-specific graphics drivers. struct native_handle; const struct native_handle* AHardwareBuffer_getNativeHandle( const AHardwareBuffer* buffer); __END_DECLS #endif // ANDROID_HARDWARE_BUFFER_H include/android/hardware_buffer_jni.h 0 → 100644 +50 −0 Original line number Diff line number Diff line /* * Copyright (C) 2017 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @file hardware_buffer_jni.h */ #ifndef ANDROID_HARDWARE_BUFFER_JNI_H #define ANDROID_HARDWARE_BUFFER_JNI_H #include <sys/cdefs.h> #include <android/hardware_buffer.h> #include <jni.h> __BEGIN_DECLS /** * Return the AHardwareBuffer associated with a Java HardwareBuffer object, * for interacting with it through native code. This acquires a reference * on the AHardwareBuffer that is returned; be sure to use * AHardwareBuffer_release() when done with it so that it doesn't leak. */ AHardwareBuffer* AHardwareBuffer_fromHardwareBuffer(JNIEnv* env, jobject hardwareBufferObj); /** * Return a new Java HardwareBuffer object that wraps the passed native * AHardwareBuffer object. */ jobject AHardwareBuffer_toHardwareBuffer(JNIEnv* env, AHardwareBuffer* hardwareBuffer); __END_DECLS #endif // ANDROID_HARDWARE_BUFFER_JNI_H include/android/native_window.h +6 −4 Original line number Diff line number Diff line Loading @@ -28,6 +28,7 @@ #include <sys/cdefs.h> #include <android/hardware_buffer.h> #include <android/rect.h> #ifdef __cplusplus Loading @@ -35,17 +36,18 @@ extern "C" { #endif /** * Pixel formats that a window can use. * Legacy window pixel format names, kept for backwards compatibility. * New code and APIs should use AHARDWAREBUFFER_FORMAT_*. */ enum { // NOTE: these values must match the values from graphics/common/x.x/types.hal /** Red: 8 bits, Green: 8 bits, Blue: 8 bits, Alpha: 8 bits. **/ WINDOW_FORMAT_RGBA_8888 = 1, WINDOW_FORMAT_RGBA_8888 = AHARDWAREBUFFER_FORMAT_R8G8B8A8_UNORM, /** Red: 8 bits, Green: 8 bits, Blue: 8 bits, Unused: 8 bits. **/ WINDOW_FORMAT_RGBX_8888 = 2, WINDOW_FORMAT_RGBX_8888 = AHARDWAREBUFFER_FORMAT_R8G8B8X8_UNORM, /** Red: 5 bits, Green: 6 bits, Blue: 5 bits. **/ WINDOW_FORMAT_RGB_565 = 4, WINDOW_FORMAT_RGB_565 = AHARDWAREBUFFER_FORMAT_R5G6B5_UNORM, /** Red: 16 bits, Green: 16 bits, Blue: 16 bits, Alpha: 16 bits. **/ WINDOW_FORMAT_RGBA_FP16 = 0x16, }; Loading Loading
include/android/hardware_buffer.h 0 → 100644 +217 −0 Original line number Diff line number Diff line /* * Copyright 2017 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @file hardware_buffer.h */ #ifndef ANDROID_HARDWARE_BUFFER_H #define ANDROID_HARDWARE_BUFFER_H #include <inttypes.h> #include <sys/cdefs.h> #include <android/rect.h> __BEGIN_DECLS /** * Buffer pixel formats. */ enum { /** * Corresponding formats: * Vulkan: VK_FORMAT_R8G8B8A8_UNORM * OpenGL ES: GL_RGBA8 */ AHARDWAREBUFFER_FORMAT_R8G8B8A8_UNORM = 1, /** * Corresponding formats: * Vulkan: VK_FORMAT_R8G8B8A8_UNORM * OpenGL ES: GL_RGBA8 */ AHARDWAREBUFFER_FORMAT_R8G8B8X8_UNORM = 2, /** * Corresponding formats: * Vulkan: VK_FORMAT_R8G8B8_UNORM * OpenGL ES: GL_RGB8 */ AHARDWAREBUFFER_FORMAT_R8G8B8_UNORM = 3, /** * Corresponding formats: * Vulkan: VK_FORMAT_R5G6B5_UNORM_PACK16 * OpenGL ES: GL_RGB565 */ AHARDWAREBUFFER_FORMAT_R5G6B5_UNORM = 4, /** * Corresponding formats: * Vulkan: VK_FORMAT_R16G16B16A16_SFLOAT * OpenGL ES: GL_RGBA16F */ AHARDWAREBUFFER_FORMAT_R16G16B16A16_SFLOAT = 5, }; enum { /* The buffer will sometimes be read by the CPU */ AHARDWAREBUFFER_USAGE0_CPU_READ = 1ULL << 1, /* The buffer will often be read by the CPU*/ AHARDWAREBUFFER_USAGE0_CPU_READ_OFTEN = 1ULL << 2 | AHARDWAREBUFFER_USAGE0_CPU_READ, /* The buffer will sometimes be written to by the CPU */ AHARDWAREBUFFER_USAGE0_CPU_WRITE = 1ULL << 5, /* The buffer will often be written to by the CPU */ AHARDWAREBUFFER_USAGE0_CPU_WRITE_OFTEN = 1ULL << 6 | AHARDWAREBUFFER_USAGE0_CPU_WRITE, /* The buffer will be read from by the GPU */ AHARDWAREBUFFER_USAGE0_GPU_SAMPLED_IMAGE = 1ULL << 10, /* The buffer will be written to by the GPU */ AHARDWAREBUFFER_USAGE0_GPU_COLOR_OUTPUT = 1ULL << 11, /* The buffer will be read from and written to by the GPU */ AHARDWAREBUFFER_USAGE0_GPU_STORAGE_IMAGE = AHARDWAREBUFFER_USAGE0_GPU_SAMPLED_IMAGE | AHARDWAREBUFFER_USAGE0_GPU_COLOR_OUTPUT, /* The buffer will be used as a cubemap texture */ AHARDWAREBUFFER_USAGE0_GPU_CUBEMAP = 1ULL << 13, /* The buffer will be used as a shader storage or uniform buffer object*/ AHARDWAREBUFFER_USAGE0_GPU_DATA_BUFFER = 1ULL << 14, /* The buffer must not be used outside of a protected hardware path */ AHARDWAREBUFFER_USAGE0_PROTECTED_CONTENT = 1ULL << 18, /** The buffer will be used for sensor direct data */ AHARDWAREBUFFER_USAGE0_SENSOR_DIRECT_DATA = 1ULL << 29, /* The buffer will be read by a hardware video encoder */ AHARDWAREBUFFER_USAGE0_VIDEO_ENCODE = 1ULL << 21, }; typedef struct AHardwareBuffer_Desc { uint32_t width; uint32_t height; uint32_t layers; uint64_t usage0; // Combination of AHARDWAREBUFFER_USAGE0_* uint64_t usage1; // Initialize to zero, reserved for future use uint32_t format; // One of AHARDWAREBUFFER_FORMAT_* } AHardwareBuffer_Desc; typedef struct AHardwareBuffer AHardwareBuffer; /** * Allocates a buffer that backs an AHardwareBuffer using the passed * AHardwareBuffer_Desc. * * Returns NO_ERROR on success, or an error number of the allocation fails for * any reason. */ int AHardwareBuffer_allocate(const AHardwareBuffer_Desc* desc, AHardwareBuffer** outBuffer); /** * Acquire a reference on the given AHardwareBuffer object. This prevents the * object from being deleted until the last reference is removed. */ void AHardwareBuffer_acquire(AHardwareBuffer* buffer); /** * Remove a reference that was previously acquired with * AHardwareBuffer_acquire(). */ void AHardwareBuffer_release(AHardwareBuffer* buffer); /** * Return a description of the AHardwareBuffer in the passed * AHardwareBuffer_Desc struct. */ void AHardwareBuffer_describe(const AHardwareBuffer* buffer, AHardwareBuffer_Desc* outDesc); /* * Lock the AHardwareBuffer for reading or writing, depending on the usage flags * passed. This call may block if the hardware needs to finish rendering or if * CPU caches need to be synchronized, or possibly for other implementation- * specific reasons. If fence is not negative, then it specifies a fence file * descriptor that will be signaled when the buffer is locked, otherwise the * caller will block until the buffer is available. * * If rect is not NULL, the caller promises to modify only data in the area * specified by rect. If rect is NULL, the caller may modify the contents of the * entire buffer. * * The content of the buffer outside of the specified rect is NOT modified * by this call. * * The buffer usage may only specify AHARDWAREBUFFER_USAGE0_CPU_*. If set, then * outVirtualAddress is filled with the address of the buffer in virtual memory, * otherwise this function will fail. * * THREADING CONSIDERATIONS: * * It is legal for several different threads to lock a buffer for read access; * none of the threads are blocked. * * Locking a buffer simultaneously for write or read/write is undefined, but * will neither terminate the process nor block the caller; AHardwareBuffer_lock * may return an error or leave the buffer's content into an indeterminate * state. * * Returns NO_ERROR on success, BAD_VALUE if the buffer is NULL or if the usage0 * flags are not a combination of AHARDWAREBUFFER_USAGE0_CPU_*, or an error * number of the lock fails for any reason. */ int AHardwareBuffer_lock(AHardwareBuffer* buffer, uint64_t usage0, int32_t fence, const ARect* rect, void** outVirtualAddress); /* * Unlock the AHardwareBuffer; must be called after all changes to the buffer * are completed by the caller. If fence is not NULL then it will be set to a * file descriptor that is signaled when all pending work on the buffer is * completed. The caller is responsible for closing the fence when it is no * longer needed. * * Returns NO_ERROR on success, BAD_VALUE if the buffer is NULL, or an error * number of the lock fails for any reason. */ int AHardwareBuffer_unlock(AHardwareBuffer* buffer, int32_t* fence); /* * Send the AHardwareBuffer to an AF_UNIX socket. * * Returns NO_ERROR on success, BAD_VALUE if the buffer is NULL, or an error * number of the lock fails for any reason. */ int AHardwareBuffer_sendHandleToUnixSocket(const AHardwareBuffer* buffer, int socketFd); /* * Receive the AHardwareBuffer from an AF_UNIX socket. * * Returns NO_ERROR on success, BAD_VALUE if the buffer is NULL, or an error * number of the lock fails for any reason. */ int AHardwareBuffer_recvHandleFromUnixSocket(int socketFd, AHardwareBuffer** outBuffer); // ---------------------------------------------------------------------------- // Everything below here is part of the public NDK API, but is intended only // for use by device-specific graphics drivers. struct native_handle; const struct native_handle* AHardwareBuffer_getNativeHandle( const AHardwareBuffer* buffer); __END_DECLS #endif // ANDROID_HARDWARE_BUFFER_H
include/android/hardware_buffer_jni.h 0 → 100644 +50 −0 Original line number Diff line number Diff line /* * Copyright (C) 2017 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @file hardware_buffer_jni.h */ #ifndef ANDROID_HARDWARE_BUFFER_JNI_H #define ANDROID_HARDWARE_BUFFER_JNI_H #include <sys/cdefs.h> #include <android/hardware_buffer.h> #include <jni.h> __BEGIN_DECLS /** * Return the AHardwareBuffer associated with a Java HardwareBuffer object, * for interacting with it through native code. This acquires a reference * on the AHardwareBuffer that is returned; be sure to use * AHardwareBuffer_release() when done with it so that it doesn't leak. */ AHardwareBuffer* AHardwareBuffer_fromHardwareBuffer(JNIEnv* env, jobject hardwareBufferObj); /** * Return a new Java HardwareBuffer object that wraps the passed native * AHardwareBuffer object. */ jobject AHardwareBuffer_toHardwareBuffer(JNIEnv* env, AHardwareBuffer* hardwareBuffer); __END_DECLS #endif // ANDROID_HARDWARE_BUFFER_JNI_H
include/android/native_window.h +6 −4 Original line number Diff line number Diff line Loading @@ -28,6 +28,7 @@ #include <sys/cdefs.h> #include <android/hardware_buffer.h> #include <android/rect.h> #ifdef __cplusplus Loading @@ -35,17 +36,18 @@ extern "C" { #endif /** * Pixel formats that a window can use. * Legacy window pixel format names, kept for backwards compatibility. * New code and APIs should use AHARDWAREBUFFER_FORMAT_*. */ enum { // NOTE: these values must match the values from graphics/common/x.x/types.hal /** Red: 8 bits, Green: 8 bits, Blue: 8 bits, Alpha: 8 bits. **/ WINDOW_FORMAT_RGBA_8888 = 1, WINDOW_FORMAT_RGBA_8888 = AHARDWAREBUFFER_FORMAT_R8G8B8A8_UNORM, /** Red: 8 bits, Green: 8 bits, Blue: 8 bits, Unused: 8 bits. **/ WINDOW_FORMAT_RGBX_8888 = 2, WINDOW_FORMAT_RGBX_8888 = AHARDWAREBUFFER_FORMAT_R8G8B8X8_UNORM, /** Red: 5 bits, Green: 6 bits, Blue: 5 bits. **/ WINDOW_FORMAT_RGB_565 = 4, WINDOW_FORMAT_RGB_565 = AHARDWAREBUFFER_FORMAT_R5G6B5_UNORM, /** Red: 16 bits, Green: 16 bits, Blue: 16 bits, Alpha: 16 bits. **/ WINDOW_FORMAT_RGBA_FP16 = 0x16, }; Loading
