1 /*
2  * Copyright © 2016 Intel Corporation
3  * Copyright © 2019 The Android Open Source Project
4  * Copyright © 2019 Google Inc.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the "Software"),
8  * to deal in the Software without restriction, including without limitation
9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  * and/or sell copies of the Software, and to permit persons to whom the
11  * Software is furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice (including the next
14  * paragraph) shall be included in all copies or substantial portions of the
15  * Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
23  * IN THE SOFTWARE.
24  */
25 
26 #ifndef VK_FORMAT_INFO_H
27 #define VK_FORMAT_INFO_H
28 
29 #include <stdbool.h>
30 #ifdef VK_USE_PLATFORM_ANDROID_KHR
31 #include <system/graphics.h>
32 #else
33 /* See system/graphics.h. */
34 enum {
35     HAL_PIXEL_FORMAT_YV12 = 842094169,
36 };
37 #endif
38 #include <vulkan/vulkan.h>
39 #include <vndk/hardware_buffer.h>
40 
41 namespace gfxstream {
42 namespace vk {
43 
44 /* See i915_private_android_types.h in minigbm. */
45 #define HAL_PIXEL_FORMAT_NV12_Y_TILED_INTEL 0x100
46 
47 // TODO(b/167698976): We should not use OMX_COLOR_FormatYUV420Planar
48 // but we seem to miss a format translation somewhere.
49 
50 #define OMX_COLOR_FormatYUV420Planar 0x13
51 
52 // TODO: update users of this function to query the DRM fourcc
53 // code using the standard Gralloc4 metadata type and instead
54 // translate the DRM fourcc code to a Vulkan format as Android
55 // formats such as AHARDWAREBUFFER_FORMAT_Y8Cb8Cr8_420 could be
56 // either VK_FORMAT_G8_B8_R8_3PLANE_420_UNORM or
57 // VK_FORMAT_G8_B8R8_2PLANE_420_UNORM.
58 static inline VkFormat
vk_format_from_android(unsigned android_format)59 vk_format_from_android(unsigned android_format)
60 {
61    switch (android_format) {
62    case AHARDWAREBUFFER_FORMAT_R8G8B8A8_UNORM:
63       return VK_FORMAT_R8G8B8A8_UNORM;
64    case AHARDWAREBUFFER_FORMAT_R8G8B8X8_UNORM:
65       return VK_FORMAT_R8G8B8A8_UNORM;
66    case AHARDWAREBUFFER_FORMAT_R8G8B8_UNORM:
67       return VK_FORMAT_R8G8B8_UNORM;
68    case AHARDWAREBUFFER_FORMAT_R5G6B5_UNORM:
69       return VK_FORMAT_R5G6B5_UNORM_PACK16;
70    case AHARDWAREBUFFER_FORMAT_R16G16B16A16_FLOAT:
71       return VK_FORMAT_R16G16B16A16_SFLOAT;
72    case AHARDWAREBUFFER_FORMAT_R10G10B10A2_UNORM:
73       return VK_FORMAT_A2B10G10R10_UNORM_PACK32;
74    case HAL_PIXEL_FORMAT_NV12_Y_TILED_INTEL:
75    case AHARDWAREBUFFER_FORMAT_Y8Cb8Cr8_420:
76       return VK_FORMAT_G8_B8R8_2PLANE_420_UNORM;
77 #if __ANDROID_API__ >= 30
78    case AHARDWAREBUFFER_FORMAT_YCbCr_P010:
79       return VK_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16;
80 #endif
81 #ifdef VK_USE_PLATFORM_ANDROID_KHR
82    case HAL_PIXEL_FORMAT_YV12:
83    case OMX_COLOR_FormatYUV420Planar:
84       return VK_FORMAT_G8_B8_R8_3PLANE_420_UNORM;
85    case AHARDWAREBUFFER_FORMAT_BLOB:
86 #endif
87    default:
88       return VK_FORMAT_UNDEFINED;
89    }
90 }
91 
92 static inline unsigned
android_format_from_vk(VkFormat vk_format)93 android_format_from_vk(VkFormat vk_format)
94 {
95    switch (vk_format) {
96    case VK_FORMAT_R8G8B8A8_UNORM:
97       return AHARDWAREBUFFER_FORMAT_R8G8B8A8_UNORM;
98    case VK_FORMAT_R8G8B8_UNORM:
99       return AHARDWAREBUFFER_FORMAT_R8G8B8_UNORM;
100    case VK_FORMAT_R5G6B5_UNORM_PACK16:
101       return AHARDWAREBUFFER_FORMAT_R5G6B5_UNORM;
102    case VK_FORMAT_R16G16B16A16_SFLOAT:
103       return AHARDWAREBUFFER_FORMAT_R16G16B16A16_FLOAT;
104    case VK_FORMAT_A2B10G10R10_UNORM_PACK32:
105       return AHARDWAREBUFFER_FORMAT_R10G10B10A2_UNORM;
106    case VK_FORMAT_G8_B8R8_2PLANE_420_UNORM:
107       return HAL_PIXEL_FORMAT_NV12_Y_TILED_INTEL;
108    case VK_FORMAT_G8_B8_R8_3PLANE_420_UNORM:
109       return HAL_PIXEL_FORMAT_YV12;
110    default:
111       return AHARDWAREBUFFER_FORMAT_BLOB;
112    }
113 }
114 
115 static inline bool
android_format_is_yuv(unsigned android_format)116 android_format_is_yuv(unsigned android_format)
117 {
118    switch (android_format) {
119    case AHARDWAREBUFFER_FORMAT_BLOB:
120    case AHARDWAREBUFFER_FORMAT_R8G8B8A8_UNORM:
121    case AHARDWAREBUFFER_FORMAT_R8G8B8X8_UNORM:
122    case AHARDWAREBUFFER_FORMAT_R8G8B8_UNORM:
123    case AHARDWAREBUFFER_FORMAT_R5G6B5_UNORM:
124    case AHARDWAREBUFFER_FORMAT_R16G16B16A16_FLOAT:
125    case AHARDWAREBUFFER_FORMAT_R10G10B10A2_UNORM:
126    case AHARDWAREBUFFER_FORMAT_D16_UNORM:
127    case AHARDWAREBUFFER_FORMAT_D24_UNORM:
128    case AHARDWAREBUFFER_FORMAT_D24_UNORM_S8_UINT:
129    case AHARDWAREBUFFER_FORMAT_D32_FLOAT:
130    case AHARDWAREBUFFER_FORMAT_D32_FLOAT_S8_UINT:
131    case AHARDWAREBUFFER_FORMAT_S8_UINT:
132       return false;
133    case HAL_PIXEL_FORMAT_NV12_Y_TILED_INTEL:
134    case OMX_COLOR_FormatYUV420Planar:
135    case HAL_PIXEL_FORMAT_YV12:
136 #if __ANDROID_API__ >= 30
137    case AHARDWAREBUFFER_FORMAT_YCbCr_P010:
138 #endif
139    case AHARDWAREBUFFER_FORMAT_Y8Cb8Cr8_420:
140       return true;
141    default:
142       ALOGE("%s: unhandled format: %d", __FUNCTION__, android_format);
143       return false;
144    }
145 }
146 
147 static inline VkImageAspectFlags
vk_format_aspects(VkFormat format)148 vk_format_aspects(VkFormat format)
149 {
150    switch (format) {
151    case VK_FORMAT_UNDEFINED:
152       return 0;
153 
154    case VK_FORMAT_S8_UINT:
155       return VK_IMAGE_ASPECT_STENCIL_BIT;
156 
157    case VK_FORMAT_D16_UNORM_S8_UINT:
158    case VK_FORMAT_D24_UNORM_S8_UINT:
159    case VK_FORMAT_D32_SFLOAT_S8_UINT:
160       return VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
161 
162    case VK_FORMAT_D16_UNORM:
163    case VK_FORMAT_X8_D24_UNORM_PACK32:
164    case VK_FORMAT_D32_SFLOAT:
165       return VK_IMAGE_ASPECT_DEPTH_BIT;
166 
167    case VK_FORMAT_G8_B8_R8_3PLANE_420_UNORM:
168    case VK_FORMAT_G8_B8_R8_3PLANE_422_UNORM:
169    case VK_FORMAT_G8_B8_R8_3PLANE_444_UNORM:
170    case VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16:
171    case VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16:
172    case VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16:
173    case VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16:
174    case VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16:
175    case VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16:
176    case VK_FORMAT_G16_B16_R16_3PLANE_420_UNORM:
177    case VK_FORMAT_G16_B16_R16_3PLANE_422_UNORM:
178    case VK_FORMAT_G16_B16_R16_3PLANE_444_UNORM:
179       return (VK_IMAGE_ASPECT_PLANE_0_BIT |
180               VK_IMAGE_ASPECT_PLANE_1_BIT |
181               VK_IMAGE_ASPECT_PLANE_2_BIT);
182 
183    case VK_FORMAT_G8_B8R8_2PLANE_420_UNORM:
184    case VK_FORMAT_G8_B8R8_2PLANE_422_UNORM:
185    case VK_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16:
186    case VK_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16:
187    case VK_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16:
188    case VK_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16:
189    case VK_FORMAT_G16_B16R16_2PLANE_420_UNORM:
190    case VK_FORMAT_G16_B16R16_2PLANE_422_UNORM:
191       return (VK_IMAGE_ASPECT_PLANE_0_BIT |
192               VK_IMAGE_ASPECT_PLANE_1_BIT);
193 
194    default:
195       return VK_IMAGE_ASPECT_COLOR_BIT;
196    }
197 }
198 
199 static inline bool
vk_format_is_color(VkFormat format)200 vk_format_is_color(VkFormat format)
201 {
202    return vk_format_aspects(format) == VK_IMAGE_ASPECT_COLOR_BIT;
203 }
204 
205 static inline bool
vk_format_is_depth_or_stencil(VkFormat format)206 vk_format_is_depth_or_stencil(VkFormat format)
207 {
208    const VkImageAspectFlags aspects = vk_format_aspects(format);
209    return aspects & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
210 }
211 
212 static inline bool
vk_format_has_depth(VkFormat format)213 vk_format_has_depth(VkFormat format)
214 {
215    const VkImageAspectFlags aspects = vk_format_aspects(format);
216    return aspects & VK_IMAGE_ASPECT_DEPTH_BIT;
217 }
218 
219 }  // namespace vk
220 }  // namespace gfxstream
221 
222 #endif /* VK_FORMAT_INFO_H */
223