FFmpeg 7.1.1
Loading...
Searching...
No Matches
hwcontext_vulkan.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_HWCONTEXT_VULKAN_H
20#define AVUTIL_HWCONTEXT_VULKAN_H
21
22#if defined(_WIN32) && !defined(VK_USE_PLATFORM_WIN32_KHR)
23#define VK_USE_PLATFORM_WIN32_KHR
24#endif
25#include <vulkan/vulkan.h>
26
27#include "pixfmt.h"
28#include "frame.h"
29#include "hwcontext.h"
30
31typedef struct AVVkFrame AVVkFrame;
32
34 /* Queue family index */
35 int idx;
36 /* Number of queues in the queue family in use */
37 int num;
38 /* Queue family capabilities. Must be non-zero.
39 * Flags may be removed to indicate the queue family may not be used
40 * for a given purpose. */
41 VkQueueFlagBits flags;
42 /* Vulkan implementations are allowed to list multiple video queues
43 * which differ in what they can encode or decode. */
44 VkVideoCodecOperationFlagBitsKHR video_caps;
46
47/**
48 * @file
49 * API-specific header for AV_HWDEVICE_TYPE_VULKAN.
50 *
51 * For user-allocated pools, AVHWFramesContext.pool must return AVBufferRefs
52 * with the data pointer set to an AVVkFrame.
53 */
54
55/**
56 * Main Vulkan context, allocated as AVHWDeviceContext.hwctx.
57 * All of these can be set before init to change what the context uses
58 */
59typedef struct AVVulkanDeviceContext {
60 /**
61 * Custom memory allocator, else NULL
62 */
63 const VkAllocationCallbacks *alloc;
64
65 /**
66 * Pointer to a vkGetInstanceProcAddr loading function.
67 * If unset, will dynamically load and use libvulkan.
68 */
69 PFN_vkGetInstanceProcAddr get_proc_addr;
70
71 /**
72 * Vulkan instance. Must be at least version 1.3.
73 */
74 VkInstance inst;
75
76 /**
77 * Physical device
78 */
79 VkPhysicalDevice phys_dev;
80
81 /**
82 * Active device
83 */
84 VkDevice act_dev;
85
86 /**
87 * This structure should be set to the set of features that present and enabled
88 * during device creation. When a device is created by FFmpeg, it will default to
89 * enabling all that are present of the shaderImageGatherExtended,
90 * fragmentStoresAndAtomics, shaderInt64 and vertexPipelineStoresAndAtomics features.
91 */
92 VkPhysicalDeviceFeatures2 device_features;
93
94 /**
95 * Enabled instance extensions.
96 * If supplying your own device context, set this to an array of strings, with
97 * each entry containing the specified Vulkan extension string to enable.
98 * Duplicates are possible and accepted.
99 * If no extensions are enabled, set these fields to NULL, and 0 respectively.
100 */
101 const char * const *enabled_inst_extensions;
103
104 /**
105 * Enabled device extensions. By default, VK_KHR_external_memory_fd,
106 * VK_EXT_external_memory_dma_buf, VK_EXT_image_drm_format_modifier,
107 * VK_KHR_external_semaphore_fd and VK_EXT_external_memory_host are enabled if found.
108 * If supplying your own device context, these fields takes the same format as
109 * the above fields, with the same conditions that duplicates are possible
110 * and accepted, and that NULL and 0 respectively means no extensions are enabled.
111 */
112 const char * const *enabled_dev_extensions;
114
115#if FF_API_VULKAN_FIXED_QUEUES
116 /**
117 * Queue family index for graphics operations, and the number of queues
118 * enabled for it. If unavaiable, will be set to -1. Not required.
119 * av_hwdevice_create() will attempt to find a dedicated queue for each
120 * queue family, or pick the one with the least unrelated flags set.
121 * Queue indices here may overlap if a queue has to share capabilities.
122 */
124 int queue_family_index;
126 int nb_graphics_queues;
127
128 /**
129 * Queue family index for transfer operations and the number of queues
130 * enabled. Required.
131 */
133 int queue_family_tx_index;
135 int nb_tx_queues;
136
137 /**
138 * Queue family index for compute operations and the number of queues
139 * enabled. Required.
140 */
142 int queue_family_comp_index;
144 int nb_comp_queues;
145
146 /**
147 * Queue family index for video encode ops, and the amount of queues enabled.
148 * If the device doesn't support such, queue_family_encode_index will be -1.
149 * Not required.
150 */
152 int queue_family_encode_index;
154 int nb_encode_queues;
155
156 /**
157 * Queue family index for video decode ops, and the amount of queues enabled.
158 * If the device doesn't support such, queue_family_decode_index will be -1.
159 * Not required.
160 */
162 int queue_family_decode_index;
164 int nb_decode_queues;
165#endif
166
167 /**
168 * Locks a queue, preventing other threads from submitting any command
169 * buffers to this queue.
170 * If set to NULL, will be set to lavu-internal functions that utilize a
171 * mutex.
172 */
173 void (*lock_queue)(struct AVHWDeviceContext *ctx, uint32_t queue_family, uint32_t index);
174
175 /**
176 * Similar to lock_queue(), unlocks a queue. Must only be called after locking.
177 */
178 void (*unlock_queue)(struct AVHWDeviceContext *ctx, uint32_t queue_family, uint32_t index);
179
180 /**
181 * Queue families used. Must be preferentially ordered. List may contain
182 * duplicates.
183 *
184 * For compatibility reasons, all the enabled queue families listed above
185 * (queue_family_(tx/comp/encode/decode)_index) must also be included in
186 * this list until they're removed after deprecation.
187 */
189 int nb_qf;
191
192/**
193 * Defines the behaviour of frame allocation.
194 */
195typedef enum AVVkFrameFlags {
196 /* Unless this flag is set, autodetected flags will be OR'd based on the
197 * device and tiling during av_hwframe_ctx_init(). */
199
201 /* DEPRECATED: does nothing. Replaced by multiplane images. */
202 AV_VK_FRAME_FLAG_CONTIGUOUS_MEMORY = (1ULL << 1),
203#endif
204
205 /* Disables multiplane images.
206 * This is required to export/import images from CUDA. */
209
210/**
211 * Allocated as AVHWFramesContext.hwctx, used to set pool-specific options
212 */
213typedef struct AVVulkanFramesContext {
214 /**
215 * Controls the tiling of allocated frames.
216 * If left as VK_IMAGE_TILING_OPTIMAL (0), will use optimal tiling.
217 * Can be set to VK_IMAGE_TILING_LINEAR to force linear images,
218 * or VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT to force DMABUF-backed
219 * images.
220 * @note Imported frames from other APIs ignore this.
221 */
222 VkImageTiling tiling;
223
224 /**
225 * Defines extra usage of output frames. If non-zero, all flags MUST be
226 * supported by the VkFormat. Otherwise, will use supported flags amongst:
227 * - VK_IMAGE_USAGE_SAMPLED_BIT
228 * - VK_IMAGE_USAGE_STORAGE_BIT
229 * - VK_IMAGE_USAGE_TRANSFER_SRC_BIT
230 * - VK_IMAGE_USAGE_TRANSFER_DST_BIT
231 */
232 VkImageUsageFlagBits usage;
233
234 /**
235 * Extension data for image creation.
236 * If DRM tiling is used, a VkImageDrmFormatModifierListCreateInfoEXT structure
237 * can be added to specify the exact modifier to use.
238 *
239 * Additional structures may be added at av_hwframe_ctx_init() time,
240 * which will be freed automatically on uninit(), so users must only free
241 * any structures they've allocated themselves.
242 */
244
245 /**
246 * Extension data for memory allocation. Must have as many entries as
247 * the number of planes of the sw_format.
248 * This will be chained to VkExportMemoryAllocateInfo, which is used
249 * to make all pool images exportable to other APIs if the necessary
250 * extensions are present in enabled_dev_extensions.
251 */
253
254 /**
255 * A combination of AVVkFrameFlags. Unless AV_VK_FRAME_FLAG_NONE is set,
256 * autodetected flags will be OR'd based on the device and tiling during
257 * av_hwframe_ctx_init().
258 */
260
261 /**
262 * Flags to set during image creation. If unset, defaults to
263 * VK_IMAGE_CREATE_ALIAS_BIT.
264 */
265 VkImageCreateFlags img_flags;
266
267 /**
268 * Vulkan format for each image. MUST be compatible with the pixel format.
269 * If unset, will be automatically set.
270 * There are at most two compatible formats for a frame - a multiplane
271 * format, and a single-plane multi-image format.
272 */
274
275 /**
276 * Number of layers each image will have.
277 */
279
280 /**
281 * Locks a frame, preventing other threads from changing frame properties.
282 * Users SHOULD only ever lock just before command submission in order
283 * to get accurate frame properties, and unlock immediately after command
284 * submission without waiting for it to finish.
285 *
286 * If unset, will be set to lavu-internal functions that utilize a mutex.
287 */
288 void (*lock_frame)(struct AVHWFramesContext *fc, AVVkFrame *vkf);
289
290 /**
291 * Similar to lock_frame(), unlocks a frame. Must only be called after locking.
292 */
293 void (*unlock_frame)(struct AVHWFramesContext *fc, AVVkFrame *vkf);
295
296/*
297 * Frame structure.
298 *
299 * @note the size of this structure is not part of the ABI, to allocate
300 * you must use @av_vk_frame_alloc().
301 */
302struct AVVkFrame {
303 /**
304 * Vulkan images to which the memory is bound to.
305 * May be one for multiplane formats, or multiple.
306 */
308
309 /**
310 * Tiling for the frame.
311 */
312 VkImageTiling tiling;
313
314 /**
315 * Memory backing the images. Either one, or as many as there are planes
316 * in the sw_format.
317 * In case of having multiple VkImages, but one memory, the offset field
318 * will indicate the bound offset for each image.
319 */
320 VkDeviceMemory mem[AV_NUM_DATA_POINTERS];
322
323 /**
324 * OR'd flags for all memory allocated
325 */
326 VkMemoryPropertyFlagBits flags;
327
328 /**
329 * Updated after every barrier. One per VkImage.
330 */
331 VkAccessFlagBits access[AV_NUM_DATA_POINTERS];
333
334 /**
335 * Synchronization timeline semaphores, one for each VkImage.
336 * Must not be freed manually. Must be waited on at every submission using
337 * the value in sem_value, and must be signalled at every submission,
338 * using an incremented value.
339 */
341
342 /**
343 * Up to date semaphore value at which each image becomes accessible.
344 * One per VkImage.
345 * Clients must wait on this value when submitting a command queue,
346 * and increment it when signalling.
347 */
349
350 /**
351 * Internal data.
352 */
353 struct AVVkFrameInternal *internal;
354
355 /**
356 * Describes the binding offset of each image to the VkDeviceMemory.
357 * One per VkImage.
358 */
360
361 /**
362 * Queue family of the images. Must be VK_QUEUE_FAMILY_IGNORED if
363 * the image was allocated with the CONCURRENT concurrency option.
364 * One per VkImage.
365 */
367};
368
369/**
370 * Allocates a single AVVkFrame and initializes everything as 0.
371 * @note Must be freed via av_free()
372 */
374
375/**
376 * Returns the optimal per-plane Vulkan format for a given sw_format,
377 * one for each plane.
378 * Returns NULL on unsupported formats.
379 */
380const VkFormat *av_vkfmt_from_pixfmt(enum AVPixelFormat p);
381
382#endif /* AVUTIL_HWCONTEXT_VULKAN_H */
#define attribute_deprecated
Definition attributes.h:100
reference-counted frame API
#define AV_NUM_DATA_POINTERS
Definition frame.h:390
#define FF_API_VULKAN_CONTIGUOUS_MEMORY
Definition version.h:113
AVVkFrame * av_vk_frame_alloc(void)
Allocates a single AVVkFrame and initializes everything as 0.
const VkFormat * av_vkfmt_from_pixfmt(enum AVPixelFormat p)
Returns the optimal per-plane Vulkan format for a given sw_format, one for each plane.
AVVkFrameFlags
Defines the behaviour of frame allocation.
@ AV_VK_FRAME_FLAG_DISABLE_MULTIPLANE
@ AV_VK_FRAME_FLAG_NONE
pixel format definitions
AVPixelFormat
Pixel format.
Definition pixfmt.h:71
This struct aggregates all the (hardware/vendor-specific) "high-level" state, i.e.
Definition hwcontext.h:60
This struct describes a set or pool of "hardware" frames (i.e.
Definition hwcontext.h:115
VkAccessFlagBits access[AV_NUM_DATA_POINTERS]
Updated after every barrier.
size_t size[AV_NUM_DATA_POINTERS]
VkImageLayout layout[AV_NUM_DATA_POINTERS]
VkImageTiling tiling
Tiling for the frame.
VkSemaphore sem[AV_NUM_DATA_POINTERS]
Synchronization timeline semaphores, one for each VkImage.
uint32_t queue_family[AV_NUM_DATA_POINTERS]
Queue family of the images.
VkMemoryPropertyFlagBits flags
OR'd flags for all memory allocated.
uint64_t sem_value[AV_NUM_DATA_POINTERS]
Up to date semaphore value at which each image becomes accessible.
struct AVVkFrameInternal * internal
Internal data.
ptrdiff_t offset[AV_NUM_DATA_POINTERS]
Describes the binding offset of each image to the VkDeviceMemory.
VkDeviceMemory mem[AV_NUM_DATA_POINTERS]
Memory backing the images.
VkImage img[AV_NUM_DATA_POINTERS]
Vulkan images to which the memory is bound to.
Main Vulkan context, allocated as AVHWDeviceContext.hwctx.
VkPhysicalDevice phys_dev
Physical device.
AVVulkanDeviceQueueFamily qf[64]
Queue families used.
const char *const * enabled_dev_extensions
Enabled device extensions.
const VkAllocationCallbacks * alloc
Custom memory allocator, else NULL.
VkDevice act_dev
Active device.
void(* lock_queue)(struct AVHWDeviceContext *ctx, uint32_t queue_family, uint32_t index)
Locks a queue, preventing other threads from submitting any command buffers to this queue.
const char *const * enabled_inst_extensions
Enabled instance extensions.
VkInstance inst
Vulkan instance.
VkPhysicalDeviceFeatures2 device_features
This structure should be set to the set of features that present and enabled during device creation.
PFN_vkGetInstanceProcAddr get_proc_addr
Pointer to a vkGetInstanceProcAddr loading function.
void(* unlock_queue)(struct AVHWDeviceContext *ctx, uint32_t queue_family, uint32_t index)
Similar to lock_queue(), unlocks a queue.
VkVideoCodecOperationFlagBitsKHR video_caps
Allocated as AVHWFramesContext.hwctx, used to set pool-specific options.
void * create_pnext
Extension data for image creation.
VkImageTiling tiling
Controls the tiling of allocated frames.
VkImageCreateFlags img_flags
Flags to set during image creation.
void * alloc_pnext[AV_NUM_DATA_POINTERS]
Extension data for memory allocation.
VkImageUsageFlagBits usage
Defines extra usage of output frames.
AVVkFrameFlags flags
A combination of AVVkFrameFlags.
void(* lock_frame)(struct AVHWFramesContext *fc, AVVkFrame *vkf)
Locks a frame, preventing other threads from changing frame properties.
int nb_layers
Number of layers each image will have.
void(* unlock_frame)(struct AVHWFramesContext *fc, AVVkFrame *vkf)
Similar to lock_frame(), unlocks a frame.
VkFormat format[AV_NUM_DATA_POINTERS]
Vulkan format for each image.