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 AVFILTER_VULKAN_H
20 #define AVFILTER_VULKAN_H
23 #include "libavutil/pixdesc.h"
24 #include "libavutil/bprint.h"
25 #include "libavutil/hwcontext.h"
26 #include "libavutil/hwcontext_vulkan.h"
28 /* GLSL management macros */
29 #define INDENT(N) INDENT_##N
31 #define INDENT_1 INDENT_0 " "
32 #define INDENT_2 INDENT_1 INDENT_1
33 #define INDENT_3 INDENT_2 INDENT_1
34 #define INDENT_4 INDENT_3 INDENT_1
35 #define INDENT_5 INDENT_4 INDENT_1
36 #define INDENT_6 INDENT_5 INDENT_1
37 #define C(N, S) INDENT(N) #S "\n"
38 #define GLSLC(N, S) av_bprintf(&shd->src, C(N, S))
39 #define GLSLA(...) av_bprintf(&shd->src, __VA_ARGS__)
40 #define GLSLF(N, S, ...) av_bprintf(&shd->src, C(N, S), __VA_ARGS__)
41 #define GLSLD(D) GLSLC(0, ); \
42 av_bprint_append_data(&shd->src, D, strlen(D)); \
45 /* Helper, pretty much every Vulkan return value needs to be checked */
48 if ((err = (x)) < 0) \
52 /* Useful for attaching immutable samplers to arrays */
53 #define DUP_SAMPLER_ARRAY4(x) (VkSampler []){ x, x, x, x, }
55 typedef struct SPIRVShader {
56 const char *name; /* Name for id/debugging purposes */
58 int local_size[3]; /* Compute shader workgroup sizes */
59 VkPipelineShaderStageCreateInfo shader;
62 typedef struct VulkanDescriptorSetBinding {
64 VkDescriptorType type;
65 const char *mem_layout; /* Storage images (rgba8, etc.) and buffers (std430, etc.) */
66 const char *mem_quali; /* readonly, writeonly, etc. */
67 const char *buf_content; /* For buffers */
68 uint32_t dimensions; /* Needed for e.g. sampler%iD */
69 uint32_t elems; /* 0 - scalar, 1 or more - vector */
70 VkShaderStageFlags stages;
71 const VkSampler *samplers; /* Immutable samplers, length - #elems */
72 void *updater; /* Pointer to VkDescriptor*Info */
73 } VulkanDescriptorSetBinding;
75 typedef struct FFVkBuffer {
78 VkMemoryPropertyFlagBits flags;
81 typedef struct VulkanPipeline {
82 VkPipelineBindPoint bind_point;
85 VkPipelineLayout pipeline_layout;
89 SPIRVShader **shaders;
93 VkPushConstantRange *push_consts;
97 VkDescriptorSetLayout *desc_layout;
98 VkDescriptorPool desc_pool;
99 VkDescriptorSet *desc_set;
100 VkDescriptorUpdateTemplate *desc_template;
101 int descriptor_sets_num;
102 int pool_size_desc_num;
104 /* Temporary, used to store data in between initialization stages */
105 VkDescriptorUpdateTemplateCreateInfo *desc_template_info;
106 VkDescriptorPoolSize *pool_size_desc;
109 typedef struct FFVkExecContext {
115 VulkanPipeline *bound_pl;
117 VkSemaphore *sem_wait;
118 int sem_wait_alloc; /* Allocated sem_wait */
121 VkPipelineStageFlagBits *sem_wait_dst;
122 int sem_wait_dst_alloc; /* Allocated sem_wait_dst */
124 VkSemaphore *sem_sig;
125 int sem_sig_alloc; /* Allocated sem_sig */
129 typedef struct VulkanFilterContext {
130 const AVClass *class;
132 AVBufferRef *device_ref;
133 AVBufferRef *frames_ref; /* For in-place filtering */
134 AVHWDeviceContext *device;
135 AVVulkanDeviceContext *hwctx;
140 enum AVPixelFormat output_format;
141 enum AVPixelFormat input_format;
144 VkSampler **samplers;
148 FFVkExecContext **exec_ctx;
151 /* Pipelines (each can have 1 shader of each type) */
152 VulkanPipeline **pipelines;
155 void *scratch; /* Scratch memory used only in functions */
156 unsigned int scratch_size;
157 } VulkanFilterContext;
159 /* Identity mapping - r = r, b = b, g = g, a = a */
160 extern const VkComponentMapping ff_comp_identity_map;
163 * General lavfi IO functions
165 int ff_vk_filter_query_formats (AVFilterContext *avctx);
166 int ff_vk_filter_init (AVFilterContext *avctx);
167 int ff_vk_filter_config_input (AVFilterLink *inlink);
168 int ff_vk_filter_config_output (AVFilterLink *outlink);
169 int ff_vk_filter_config_output_inplace(AVFilterLink *outlink);
170 void ff_vk_filter_uninit (AVFilterContext *avctx);
173 * Converts Vulkan return values to strings
175 const char *ff_vk_ret2str(VkResult res);
178 * Returns 1 if the image is any sort of supported RGB
180 int ff_vk_mt_is_np_rgb(enum AVPixelFormat pix_fmt);
183 * Gets the glsl format string for a pixel format
185 const char *ff_vk_shader_rep_fmt(enum AVPixelFormat pixfmt);
188 * Create a Vulkan sampler, will be auto-freed in ff_vk_filter_uninit()
190 VkSampler *ff_vk_init_sampler(AVFilterContext *avctx, int unnorm_coords,
194 * Create an imageview.
196 int ff_vk_create_imageview(AVFilterContext *avctx, VkImageView *v, VkImage img,
197 VkFormat fmt, const VkComponentMapping map);
200 * Destroy an imageview. Command buffer must have completed executing, which
201 * ff_vk_submit_exec_queue() will ensure
203 void ff_vk_destroy_imageview(AVFilterContext *avctx, VkImageView *v);
206 * Define a push constant for a given stage into a pipeline.
207 * Must be called before the pipeline layout has been initialized.
209 int ff_vk_add_push_constant(AVFilterContext *avctx, VulkanPipeline *pl,
210 int offset, int size, VkShaderStageFlagBits stage);
213 * Inits a pipeline. Everything in it will be auto-freed when calling
214 * ff_vk_filter_uninit().
216 VulkanPipeline *ff_vk_create_pipeline(AVFilterContext *avctx);
219 * Inits a shader for a specific pipeline. Will be auto-freed on uninit.
221 SPIRVShader *ff_vk_init_shader(AVFilterContext *avctx, VulkanPipeline *pl,
222 const char *name, VkShaderStageFlags stage);
225 * Writes the workgroup size for a shader.
227 void ff_vk_set_compute_shader_sizes(AVFilterContext *avctx, SPIRVShader *shd,
231 * Adds a descriptor set to the shader and registers them in the pipeline.
233 int ff_vk_add_descriptor_set(AVFilterContext *avctx, VulkanPipeline *pl,
234 SPIRVShader *shd, VulkanDescriptorSetBinding *desc,
235 int num, int only_print_to_shader);
238 * Compiles the shader, entrypoint must be set to "main".
240 int ff_vk_compile_shader(AVFilterContext *avctx, SPIRVShader *shd,
241 const char *entrypoint);
244 * Initializes the pipeline layout after all shaders and descriptor sets have
247 int ff_vk_init_pipeline_layout(AVFilterContext *avctx, VulkanPipeline *pl);
250 * Initializes a compute pipeline. Will pick the first shader with the
253 int ff_vk_init_compute_pipeline(AVFilterContext *avctx, VulkanPipeline *pl);
256 * Updates a descriptor set via the updaters defined.
257 * Can be called immediately after pipeline creation, but must be called
258 * at least once before queue submission.
260 void ff_vk_update_descriptor_set(AVFilterContext *avctx, VulkanPipeline *pl,
264 * Init an execution context for command recording and queue submission.
265 * WIll be auto-freed on uninit.
267 int ff_vk_create_exec_ctx(AVFilterContext *avctx, FFVkExecContext **ctx, int queue);
270 * Begin recording to the command buffer. Previous execution must have been
271 * completed, which ff_vk_submit_exec_queue() will ensure.
273 int ff_vk_start_exec_recording(AVFilterContext *avctx, FFVkExecContext *e);
276 * Add a command to bind the completed pipeline and its descriptor sets.
277 * Must be called after ff_vk_start_exec_recording() and before submission.
279 void ff_vk_bind_pipeline_exec(AVFilterContext *avctx, FFVkExecContext *e,
283 * Updates push constants.
284 * Must be called after binding a pipeline if any push constants were defined.
286 void ff_vk_update_push_exec(AVFilterContext *avctx, FFVkExecContext *e,
287 VkShaderStageFlagBits stage, int offset,
288 size_t size, void *src);
291 * Adds a frame as a queue dependency. This manages semaphore signalling.
292 * Must be called before submission.
294 int ff_vk_add_exec_dep(AVFilterContext *avctx, FFVkExecContext *e,
295 AVFrame *frame, VkPipelineStageFlagBits in_wait_dst_flag);
298 * Submits a command buffer to the queue for execution.
299 * Will block until execution has finished in order to simplify resource
302 int ff_vk_submit_exec_queue(AVFilterContext *avctx, FFVkExecContext *e);
305 * Create a VkBuffer with the specified parameters.
307 int ff_vk_create_buf(AVFilterContext *avctx, FFVkBuffer *buf, size_t size,
308 VkBufferUsageFlags usage, VkMemoryPropertyFlagBits flags);
311 * Maps the buffer to userspace. Set invalidate to 1 if reading the contents
314 int ff_vk_map_buffers(AVFilterContext *avctx, FFVkBuffer *buf, uint8_t *mem[],
315 int nb_buffers, int invalidate);
318 * Unmaps the buffer from userspace. Set flush to 1 to write and sync.
320 int ff_vk_unmap_buffers(AVFilterContext *avctx, FFVkBuffer *buf, int nb_buffers,
326 void ff_vk_free_buf(AVFilterContext *avctx, FFVkBuffer *buf);
328 #endif /* AVFILTER_VULKAN_H */