2 * This file is part of FFmpeg.
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.
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.
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
19 #ifndef AVUTIL_HWCONTEXT_VULKAN_H
20 #define AVUTIL_HWCONTEXT_VULKAN_H
22 #include <vulkan/vulkan.h>
29 * API-specific header for AV_HWDEVICE_TYPE_VULKAN.
31 * For user-allocated pools, AVHWFramesContext.pool must return AVBufferRefs
32 * with the data pointer set to an AVVkFrame.
36 * Main Vulkan context, allocated as AVHWDeviceContext.hwctx.
37 * All of these can be set before init to change what the context uses
39 typedef struct AVVulkanDeviceContext {
41 * Custom memory allocator, else NULL
43 const VkAllocationCallbacks *alloc;
46 * Pointer to the instance-provided vkGetInstanceProcAddr loading function.
47 * If NULL, will pick either libvulkan or libvolk, depending on libavutil's
48 * compilation settings, and set this field.
50 PFN_vkGetInstanceProcAddr get_proc_addr;
53 * Vulkan instance. Must be at least version 1.1.
60 VkPhysicalDevice phys_dev;
68 * This structure should be set to the set of features that present and enabled
69 * during device creation. When a device is created by FFmpeg, it will default to
70 * enabling all that are present of the shaderImageGatherExtended,
71 * fragmentStoresAndAtomics, shaderInt64 and vertexPipelineStoresAndAtomics features.
73 VkPhysicalDeviceFeatures2 device_features;
76 * Enabled instance extensions.
77 * If supplying your own device context, set this to an array of strings, with
78 * each entry containing the specified Vulkan extension string to enable.
79 * Duplicates are possible and accepted.
80 * If no extensions are enabled, set these fields to NULL, and 0 respectively.
82 const char * const *enabled_inst_extensions;
83 int nb_enabled_inst_extensions;
86 * Enabled device extensions. By default, VK_KHR_external_memory_fd,
87 * VK_EXT_external_memory_dma_buf, VK_EXT_image_drm_format_modifier,
88 * VK_KHR_external_semaphore_fd and VK_EXT_external_memory_host are enabled if found.
89 * If supplying your own device context, these fields takes the same format as
90 * the above fields, with the same conditions that duplicates are possible
91 * and accepted, and that NULL and 0 respectively means no extensions are enabled.
93 const char * const *enabled_dev_extensions;
94 int nb_enabled_dev_extensions;
97 * Queue family index for graphics
98 * @note av_hwdevice_create() will set all 3 queue indices if unset
99 * If there is no dedicated queue for compute or transfer operations,
100 * they will be set to the graphics queue index which can handle both.
101 * nb_graphics_queues indicates how many queues were enabled for the
102 * graphics queue (must be at least 1)
104 int queue_family_index;
105 int nb_graphics_queues;
108 * Queue family index to use for transfer operations, and the amount of queues
109 * enabled. In case there is no dedicated transfer queue, nb_tx_queues
110 * must be 0 and queue_family_tx_index must be the same as either the graphics
111 * queue or the compute queue, if available.
113 int queue_family_tx_index;
117 * Queue family index for compute ops, and the amount of queues enabled.
118 * In case there are no dedicated compute queues, nb_comp_queues must be
119 * 0 and its queue family index must be set to the graphics queue.
121 int queue_family_comp_index;
123 } AVVulkanDeviceContext;
126 * Allocated as AVHWFramesContext.hwctx, used to set pool-specific options
128 typedef struct AVVulkanFramesContext {
130 * Controls the tiling of allocated frames.
132 VkImageTiling tiling;
135 * Defines extra usage of output frames. If left as 0, the following bits
136 * are set: TRANSFER_SRC, TRANSFER_DST. SAMPLED and STORAGE.
138 VkImageUsageFlagBits usage;
141 * Extension data for image creation.
146 * Extension data for memory allocation. Must have as many entries as
147 * the number of planes of the sw_format.
148 * This will be chained to VkExportMemoryAllocateInfo, which is used
149 * to make all pool images exportable to other APIs if the necessary
150 * extensions are present in enabled_dev_extensions.
152 void *alloc_pnext[AV_NUM_DATA_POINTERS];
153 } AVVulkanFramesContext;
156 * Frame structure, the VkFormat of the image will always match
157 * the pool's sw_format.
158 * All frames, imported or allocated, will be created with the
159 * VK_IMAGE_CREATE_ALIAS_BIT flag set, so the memory may be aliased if needed.
161 * If all three queue family indices in the device context are the same,
162 * images will be created with the EXCLUSIVE sharing mode. Otherwise, all images
163 * will be created using the CONCURRENT sharing mode.
165 * @note the size of this structure is not part of the ABI, to allocate
166 * you must use @av_vk_frame_alloc().
168 typedef struct AVVkFrame {
170 * Vulkan images to which the memory is bound to.
172 VkImage img[AV_NUM_DATA_POINTERS];
175 * The same tiling must be used for all images in the frame.
177 VkImageTiling tiling;
180 * Memory backing the images. Could be less than the amount of images
181 * if importing from a DRM or VAAPI frame.
183 VkDeviceMemory mem[AV_NUM_DATA_POINTERS];
184 size_t size[AV_NUM_DATA_POINTERS];
187 * OR'd flags for all memory allocated
189 VkMemoryPropertyFlagBits flags;
192 * Updated after every barrier
194 VkAccessFlagBits access[AV_NUM_DATA_POINTERS];
195 VkImageLayout layout[AV_NUM_DATA_POINTERS];
198 * Synchronization semaphores. Must not be freed manually. Must be waited on
199 * and signalled at every queue submission.
200 * Could be less than the amount of images: either one per VkDeviceMemory
201 * or one for the entire frame. All others will be set to VK_NULL_HANDLE.
203 VkSemaphore sem[AV_NUM_DATA_POINTERS];
208 struct AVVkFrameInternal *internal;
212 * Allocates a single AVVkFrame and initializes everything as 0.
213 * @note Must be freed via av_free()
215 AVVkFrame *av_vk_frame_alloc(void);
218 * Returns the format of each image up to the number of planes for a given sw_format.
219 * Returns NULL on unsupported formats.
221 const VkFormat *av_vkfmt_from_pixfmt(enum AVPixelFormat p);
223 #endif /* AVUTIL_HWCONTEXT_VULKAN_H */