FFmpeg
vulkan_loader.h
Go to the documentation of this file.
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * FFmpeg is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 
19 #ifndef AVUTIL_VULKAN_LOADER_H
20 #define AVUTIL_VULKAN_LOADER_H
21 
22 #include <stdio.h>
23 
24 #include "avassert.h"
25 #include "vulkan_functions.h"
26 
27 /* Macro to turn a function name into a loader struct */
28 #define PFN_LOAD_INFO(req_inst, req_dev, ext_flag, name) \
29  { \
30  req_inst, \
31  req_dev, \
32  offsetof(FFVulkanFunctions, name), \
33  ext_flag, \
34  },
35 
36 static inline uint64_t ff_vk_extensions_to_mask(const char * const *extensions,
37  int nb_extensions)
38 {
39  static const struct ExtensionMap {
40  const char *name;
42  } extension_map[] = {
43  { VK_EXT_EXTERNAL_MEMORY_DMA_BUF_EXTENSION_NAME, FF_VK_EXT_EXTERNAL_DMABUF_MEMORY },
44  { VK_EXT_IMAGE_DRM_FORMAT_MODIFIER_EXTENSION_NAME, FF_VK_EXT_DRM_MODIFIER_FLAGS },
45  { VK_KHR_EXTERNAL_MEMORY_FD_EXTENSION_NAME, FF_VK_EXT_EXTERNAL_FD_MEMORY },
46  { VK_KHR_EXTERNAL_SEMAPHORE_FD_EXTENSION_NAME, FF_VK_EXT_EXTERNAL_FD_SEM },
47  { VK_EXT_EXTERNAL_MEMORY_HOST_EXTENSION_NAME, FF_VK_EXT_EXTERNAL_HOST_MEMORY },
48  { VK_EXT_DEBUG_UTILS_EXTENSION_NAME, FF_VK_EXT_DEBUG_UTILS },
49  { VK_EXT_PHYSICAL_DEVICE_DRM_EXTENSION_NAME, FF_VK_EXT_DEVICE_DRM },
50  { VK_EXT_SHADER_ATOMIC_FLOAT_EXTENSION_NAME, FF_VK_EXT_ATOMIC_FLOAT },
51  { VK_KHR_COOPERATIVE_MATRIX_EXTENSION_NAME, FF_VK_EXT_COOP_MATRIX },
52 #ifdef _WIN32
53  { VK_KHR_EXTERNAL_MEMORY_WIN32_EXTENSION_NAME, FF_VK_EXT_EXTERNAL_WIN32_MEMORY },
54  { VK_KHR_EXTERNAL_SEMAPHORE_WIN32_EXTENSION_NAME, FF_VK_EXT_EXTERNAL_WIN32_SEM },
55 #endif
56  { VK_EXT_DESCRIPTOR_BUFFER_EXTENSION_NAME, FF_VK_EXT_DESCRIPTOR_BUFFER, },
57  { VK_KHR_VIDEO_QUEUE_EXTENSION_NAME, FF_VK_EXT_VIDEO_QUEUE },
58  { VK_KHR_VIDEO_DECODE_QUEUE_EXTENSION_NAME, FF_VK_EXT_VIDEO_DECODE_QUEUE },
59  { VK_KHR_VIDEO_DECODE_H264_EXTENSION_NAME, FF_VK_EXT_VIDEO_DECODE_H264 },
60  { VK_KHR_VIDEO_DECODE_H265_EXTENSION_NAME, FF_VK_EXT_VIDEO_DECODE_H265 },
61  { VK_KHR_VIDEO_DECODE_AV1_EXTENSION_NAME, FF_VK_EXT_VIDEO_DECODE_AV1 },
62  };
63 
65 
66  for (int i = 0; i < nb_extensions; i++) {
67  for (int j = 0; j < FF_ARRAY_ELEMS(extension_map); j++) {
68  if (!strcmp(extensions[i], extension_map[j].name)) {
69  mask |= extension_map[j].flag;
70  continue;
71  }
72  }
73  }
74 
75  return mask;
76 }
77 
78 /**
79  * Function loader.
80  * Vulkan function from scratch loading happens in 3 stages - the first one
81  * is before any initialization has happened, and you have neither an instance
82  * structure nor a device structure. At this stage, you can only get the bare
83  * minimals to initialize an instance.
84  * The second stage is when you have an instance. At this stage, you can
85  * initialize a VkDevice, and have an idea of what extensions each device
86  * supports.
87  * Finally, in the third stage, you can proceed and load all core functions,
88  * plus you can be sure that any extensions you've enabled during device
89  * initialization will be available.
90  */
93  uint64_t extensions_mask,
94  int has_inst, int has_dev)
95 {
96  AVVulkanDeviceContext *hwctx = ctx->hwctx;
97 
98  static const struct FunctionLoadInfo {
99  char req_inst;
100  char req_dev;
101  uint16_t struct_offset;
102  FFVulkanExtensions ext_flag;
103  } vk_load_info[] = {
105 #ifdef _WIN32
107 #endif
108  };
109  // Concatenate the names to avoid relocations. The resulting string
110  // will end with \0\0
111 #define FUNC_NAME(req_inst, req_dev, ext_flag, name) "vk"#name"\0"
112  const char *name =
114 #ifdef _WIN32
116 #endif
117  ;
118 #undef FUNC_NAME
119 
120  for (int i = 0; i < FF_ARRAY_ELEMS(vk_load_info); name += strlen(name) + 1, i++) {
121  const struct FunctionLoadInfo *load = &vk_load_info[i];
122  static const char extensions[][4] = { "", "EXT", "KHR" };
123  PFN_vkVoidFunction fn;
124 
125  if (load->req_dev && !has_dev)
126  continue;
127  if (load->req_inst && !has_inst)
128  continue;
129 
130  for (int j = 0; j < FF_ARRAY_ELEMS(extensions); j++) {
131  char ext_name[128];
132  av_unused int n;
133 
134  n = snprintf(ext_name, sizeof(ext_name), "%s%s", name, extensions[j]);
135  av_assert1(n < sizeof(ext_name));
136 
137  if (load->req_dev)
138  fn = vk->GetDeviceProcAddr(hwctx->act_dev, ext_name);
139  else if (load->req_inst)
140  fn = hwctx->get_proc_addr(hwctx->inst, ext_name);
141  else
142  fn = hwctx->get_proc_addr(NULL, ext_name);
143 
144  if (fn)
145  break;
146  }
147 
148  if (!fn && ((extensions_mask &~ FF_VK_EXT_NO_FLAG) & load->ext_flag)) {
149  av_log(ctx, AV_LOG_ERROR, "Loader error, function \"%s\" indicated "
150  "as supported, but got NULL function pointer!\n", name);
151  return AVERROR_EXTERNAL;
152  }
153 
154  *(PFN_vkVoidFunction *)((uint8_t *)vk + load->struct_offset) = fn;
155  }
156  av_assert1(*name == '\0');
157 
158  return 0;
159 }
160 
161 #endif /* AVUTIL_VULKAN_LOADER_H */
FF_VK_EXT_NO_FLAG
@ FF_VK_EXT_NO_FLAG
Definition: vulkan_functions.h:50
name
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf default minimum maximum flags name is the option name
Definition: writing_filters.txt:88
FF_VK_EXT_VIDEO_DECODE_H264
@ FF_VK_EXT_VIDEO_DECODE_H264
Definition: vulkan_functions.h:44
av_unused
#define av_unused
Definition: attributes.h:131
FF_VK_EXT_VIDEO_DECODE_AV1
@ FF_VK_EXT_VIDEO_DECODE_AV1
Definition: vulkan_functions.h:46
AVVulkanDeviceContext::get_proc_addr
PFN_vkGetInstanceProcAddr get_proc_addr
Pointer to the instance-provided vkGetInstanceProcAddr loading function.
Definition: hwcontext_vulkan.h:55
FF_VK_EXT_DESCRIPTOR_BUFFER
@ FF_VK_EXT_DESCRIPTOR_BUFFER
Definition: vulkan_functions.h:40
AVVulkanDeviceContext::inst
VkInstance inst
Vulkan instance.
Definition: hwcontext_vulkan.h:60
FF_VK_EXT_VIDEO_DECODE_H265
@ FF_VK_EXT_VIDEO_DECODE_H265
Definition: vulkan_functions.h:45
FF_VK_EXT_VIDEO_DECODE_QUEUE
@ FF_VK_EXT_VIDEO_DECODE_QUEUE
Definition: vulkan_functions.h:43
FF_VK_EXT_COOP_MATRIX
@ FF_VK_EXT_COOP_MATRIX
Definition: vulkan_functions.h:48
FN_LIST_WIN32
#define FN_LIST_WIN32(MACRO)
Definition: vulkan_functions.h:217
AVHWDeviceContext
This struct aggregates all the (hardware/vendor-specific) "high-level" state, i.e.
Definition: hwcontext.h:60
FF_VK_EXT_VIDEO_QUEUE
@ FF_VK_EXT_VIDEO_QUEUE
Definition: vulkan_functions.h:42
avassert.h
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
FF_ARRAY_ELEMS
#define FF_ARRAY_ELEMS(a)
Definition: sinewin_tablegen.c:29
mask
static const uint16_t mask[17]
Definition: lzw.c:38
ff_vk_load_functions
static int ff_vk_load_functions(AVHWDeviceContext *ctx, FFVulkanFunctions *vk, uint64_t extensions_mask, int has_inst, int has_dev)
Function loader.
Definition: vulkan_loader.h:91
PFN_LOAD_INFO
#define PFN_LOAD_INFO(req_inst, req_dev, ext_flag, name)
Definition: vulkan_loader.h:28
FN_LIST
#define FN_LIST(MACRO)
Definition: vulkan_functions.h:54
FF_VK_EXT_EXTERNAL_HOST_MEMORY
@ FF_VK_EXT_EXTERNAL_HOST_MEMORY
Definition: vulkan_functions.h:34
ctx
AVFormatContext * ctx
Definition: movenc.c:48
AVVulkanDeviceContext
Main Vulkan context, allocated as AVHWDeviceContext.hwctx.
Definition: hwcontext_vulkan.h:44
NULL
#define NULL
Definition: coverity.c:32
FF_VK_EXT_DRM_MODIFIER_FLAGS
@ FF_VK_EXT_DRM_MODIFIER_FLAGS
Definition: vulkan_functions.h:31
FF_VK_EXT_EXTERNAL_DMABUF_MEMORY
@ FF_VK_EXT_EXTERNAL_DMABUF_MEMORY
Definition: vulkan_functions.h:30
fn
#define fn(a)
Definition: aap_template.c:37
AVERROR_EXTERNAL
#define AVERROR_EXTERNAL
Generic error in an external library.
Definition: error.h:59
flag
#define flag(name)
Definition: cbs_av1.c:474
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:255
FF_VK_EXT_EXTERNAL_FD_MEMORY
@ FF_VK_EXT_EXTERNAL_FD_MEMORY
Definition: vulkan_functions.h:32
av_assert1
#define av_assert1(cond)
assert() equivalent, that does not lie in speed critical code.
Definition: avassert.h:56
vulkan_functions.h
FF_VK_EXT_DEBUG_UTILS
@ FF_VK_EXT_DEBUG_UTILS
Definition: vulkan_functions.h:35
FUNC_NAME
#define FUNC_NAME(req_inst, req_dev, ext_flag, name)
FFVulkanExtensions
FFVulkanExtensions
Definition: vulkan_functions.h:29
AVVulkanDeviceContext::act_dev
VkDevice act_dev
Active device.
Definition: hwcontext_vulkan.h:70
FF_VK_EXT_EXTERNAL_FD_SEM
@ FF_VK_EXT_EXTERNAL_FD_SEM
Definition: vulkan_functions.h:33
FF_VK_EXT_DEVICE_DRM
@ FF_VK_EXT_DEVICE_DRM
Definition: vulkan_functions.h:41
FF_VK_EXT_ATOMIC_FLOAT
@ FF_VK_EXT_ATOMIC_FLOAT
Definition: vulkan_functions.h:47
ff_vk_extensions_to_mask
static uint64_t ff_vk_extensions_to_mask(const char *const *extensions, int nb_extensions)
Definition: vulkan_loader.h:36
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
snprintf
#define snprintf
Definition: snprintf.h:34
FFVulkanFunctions
Definition: vulkan_functions.h:226