FFmpeg
Data Structures | Macros | Functions | Variables
vulkan.h File Reference
#include "avfilter.h"
#include "libavutil/pixdesc.h"
#include "libavutil/bprint.h"
#include "libavutil/hwcontext.h"
#include "libavutil/hwcontext_vulkan.h"

Go to the source code of this file.

Data Structures

struct  SPIRVShader
 
struct  VulkanDescriptorSetBinding
 
struct  FFVkBuffer
 
struct  VulkanPipeline
 
struct  FFVkQueueCtx
 
struct  FFVkExecContext
 
struct  VulkanFilterContext
 

Macros

#define INDENT(N)   INDENT_##N
 
#define INDENT_0
 
#define INDENT_1   INDENT_0 " "
 
#define INDENT_2   INDENT_1 INDENT_1
 
#define INDENT_3   INDENT_2 INDENT_1
 
#define INDENT_4   INDENT_3 INDENT_1
 
#define INDENT_5   INDENT_4 INDENT_1
 
#define INDENT_6   INDENT_5 INDENT_1
 
#define C(N, S)   INDENT(N) #S "\n"
 
#define GLSLC(N, S)   av_bprintf(&shd->src, C(N, S))
 
#define GLSLA(...)   av_bprintf(&shd->src, __VA_ARGS__)
 
#define GLSLF(N, S, ...)   av_bprintf(&shd->src, C(N, S), __VA_ARGS__)
 
#define GLSLD(D)
 
#define RET(x)
 
#define GET_QUEUE_COUNT(hwctx, graph, comp, tx)
 
#define DUP_SAMPLER_ARRAY4(x)   (VkSampler []){ x, x, x, x, }
 

Functions

int ff_vk_filter_query_formats (AVFilterContext *avctx)
 General lavfi IO functions. More...
 
int ff_vk_filter_init (AVFilterContext *avctx)
 
int ff_vk_filter_config_input (AVFilterLink *inlink)
 
int ff_vk_filter_config_output (AVFilterLink *outlink)
 
int ff_vk_filter_config_output_inplace (AVFilterLink *outlink)
 
void ff_vk_filter_uninit (AVFilterContext *avctx)
 
const char * ff_vk_ret2str (VkResult res)
 Converts Vulkan return values to strings. More...
 
int ff_vk_mt_is_np_rgb (enum AVPixelFormat pix_fmt)
 Returns 1 if the image is any sort of supported RGB. More...
 
const char * ff_vk_shader_rep_fmt (enum AVPixelFormat pixfmt)
 Gets the glsl format string for a pixel format. More...
 
VkSampler * ff_vk_init_sampler (AVFilterContext *avctx, int unnorm_coords, VkFilter filt)
 Create a Vulkan sampler, will be auto-freed in ff_vk_filter_uninit() More...
 
int ff_vk_create_imageview (AVFilterContext *avctx, FFVkExecContext *e, VkImageView *v, VkImage img, VkFormat fmt, const VkComponentMapping map)
 Create an imageview. More...
 
int ff_vk_add_push_constant (AVFilterContext *avctx, VulkanPipeline *pl, int offset, int size, VkShaderStageFlagBits stage)
 Define a push constant for a given stage into a pipeline. More...
 
VulkanPipelineff_vk_create_pipeline (AVFilterContext *avctx)
 Inits a pipeline. More...
 
SPIRVShaderff_vk_init_shader (AVFilterContext *avctx, VulkanPipeline *pl, const char *name, VkShaderStageFlags stage)
 Inits a shader for a specific pipeline. More...
 
void ff_vk_set_compute_shader_sizes (AVFilterContext *avctx, SPIRVShader *shd, int local_size[3])
 Writes the workgroup size for a shader. More...
 
int ff_vk_add_descriptor_set (AVFilterContext *avctx, VulkanPipeline *pl, SPIRVShader *shd, VulkanDescriptorSetBinding *desc, int num, int only_print_to_shader)
 Adds a descriptor set to the shader and registers them in the pipeline. More...
 
int ff_vk_compile_shader (AVFilterContext *avctx, SPIRVShader *shd, const char *entrypoint)
 Compiles the shader, entrypoint must be set to "main". More...
 
int ff_vk_init_pipeline_layout (AVFilterContext *avctx, VulkanPipeline *pl)
 Initializes the pipeline layout after all shaders and descriptor sets have been finished. More...
 
int ff_vk_init_compute_pipeline (AVFilterContext *avctx, VulkanPipeline *pl)
 Initializes a compute pipeline. More...
 
void ff_vk_update_descriptor_set (AVFilterContext *avctx, VulkanPipeline *pl, int set_id)
 Updates a descriptor set via the updaters defined. More...
 
int ff_vk_create_exec_ctx (AVFilterContext *avctx, FFVkExecContext **ctx)
 Init an execution context for command recording and queue submission. More...
 
int ff_vk_start_exec_recording (AVFilterContext *avctx, FFVkExecContext *e)
 Begin recording to the command buffer. More...
 
void ff_vk_bind_pipeline_exec (AVFilterContext *avctx, FFVkExecContext *e, VulkanPipeline *pl)
 Add a command to bind the completed pipeline and its descriptor sets. More...
 
void ff_vk_update_push_exec (AVFilterContext *avctx, FFVkExecContext *e, VkShaderStageFlagBits stage, int offset, size_t size, void *src)
 Updates push constants. More...
 
VkCommandBuffer ff_vk_get_exec_buf (AVFilterContext *avctx, FFVkExecContext *e)
 Gets the command buffer to use for this submission from the exe context. More...
 
int ff_vk_add_dep_exec_ctx (AVFilterContext *avctx, FFVkExecContext *e, AVBufferRef **deps, int nb_deps)
 Adds a generic AVBufferRef as a queue depenency. More...
 
void ff_vk_discard_exec_deps (AVFilterContext *avctx, FFVkExecContext *e)
 Discards all queue dependencies. More...
 
int ff_vk_add_exec_dep (AVFilterContext *avctx, FFVkExecContext *e, AVFrame *frame, VkPipelineStageFlagBits in_wait_dst_flag)
 Adds a frame as a queue dependency. More...
 
int ff_vk_submit_exec_queue (AVFilterContext *avctx, FFVkExecContext *e)
 Submits a command buffer to the queue for execution. More...
 
int ff_vk_create_buf (AVFilterContext *avctx, FFVkBuffer *buf, size_t size, VkBufferUsageFlags usage, VkMemoryPropertyFlagBits flags)
 Create a VkBuffer with the specified parameters. More...
 
int ff_vk_map_buffers (AVFilterContext *avctx, FFVkBuffer *buf, uint8_t *mem[], int nb_buffers, int invalidate)
 Maps the buffer to userspace. More...
 
int ff_vk_unmap_buffers (AVFilterContext *avctx, FFVkBuffer *buf, int nb_buffers, int flush)
 Unmaps the buffer from userspace. More...
 
void ff_vk_free_buf (AVFilterContext *avctx, FFVkBuffer *buf)
 Frees a buffer. More...
 

Variables

const VkComponentMapping ff_comp_identity_map
 

Macro Definition Documentation

#define INDENT (   N)    INDENT_##N

Definition at line 29 of file vulkan.h.

#define INDENT_0

Definition at line 30 of file vulkan.h.

#define INDENT_1   INDENT_0 " "

Definition at line 31 of file vulkan.h.

#define INDENT_2   INDENT_1 INDENT_1

Definition at line 32 of file vulkan.h.

#define INDENT_3   INDENT_2 INDENT_1

Definition at line 33 of file vulkan.h.

#define INDENT_4   INDENT_3 INDENT_1

Definition at line 34 of file vulkan.h.

#define INDENT_5   INDENT_4 INDENT_1

Definition at line 35 of file vulkan.h.

#define INDENT_6   INDENT_5 INDENT_1

Definition at line 36 of file vulkan.h.

#define C (   N,
  S 
)    INDENT(N) #S "\n"

Definition at line 37 of file vulkan.h.

#define GLSLC (   N,
  S 
)    av_bprintf(&shd->src, C(N, S))

Definition at line 38 of file vulkan.h.

Referenced by ff_vk_init_shader(), and init_filter().

#define GLSLA (   ...)    av_bprintf(&shd->src, __VA_ARGS__)

Definition at line 39 of file vulkan.h.

Referenced by ff_vk_add_descriptor_set().

#define GLSLF (   N,
  S,
  ... 
)    av_bprintf(&shd->src, C(N, S), __VA_ARGS__)

Definition at line 40 of file vulkan.h.

Referenced by ff_vk_init_shader(), and init_filter().

#define GLSLD (   D)
Value:
GLSLC(0, ); \
av_bprint_append_data(&shd->src, D, strlen(D)); \
GLSLC(0, )
void av_bprint_append_data(AVBPrint *buf, const char *data, unsigned size)
Append data to a print buffer.
Definition: bprint.c:158
#define GLSLC(N, S)
Definition: vulkan.h:38
D(D(float, sse)
Definition: rematrix_init.c:28

Definition at line 41 of file vulkan.h.

Referenced by init_filter().

#define RET (   x)
Value:
do { \
if ((err = (x)) < 0) \
goto fail; \
} while (0)
#define fail()
Definition: checkasm.h:123
if(ret)

Definition at line 46 of file vulkan.h.

Referenced by avgblur_vulkan_filter_frame(), chromaber_vulkan_filter_frame(), init_filter(), overlay_vulkan_blend(), process_frames(), and scale_vulkan_filter_frame().

#define GET_QUEUE_COUNT (   hwctx,
  graph,
  comp,
  tx 
)
Value:
( \
graph ? hwctx->nb_graphics_queues : \
comp ? (hwctx->nb_comp_queues ? \
hwctx->nb_comp_queues : hwctx->nb_graphics_queues) : \
tx ? (hwctx->nb_tx_queues ? hwctx->nb_tx_queues : \
(hwctx->nb_comp_queues ? \
hwctx->nb_comp_queues : hwctx->nb_graphics_queues)) : \
0 \
)
static void comp(unsigned char *dst, ptrdiff_t dst_stride, unsigned char *src, ptrdiff_t src_stride, int add)
Definition: eamad.c:83

Definition at line 53 of file vulkan.h.

Referenced by init_filter().

#define DUP_SAMPLER_ARRAY4 (   x)    (VkSampler []){ x, x, x, x, }

Definition at line 64 of file vulkan.h.

Referenced by init_filter().

Function Documentation

int ff_vk_filter_query_formats ( AVFilterContext avctx)

General lavfi IO functions.

Definition at line 592 of file vulkan.c.

int ff_vk_filter_init ( AVFilterContext avctx)

Definition at line 756 of file vulkan.c.

Referenced by overlay_vulkan_init().

int ff_vk_filter_config_input ( AVFilterLink inlink)

Definition at line 635 of file vulkan.c.

int ff_vk_filter_config_output ( AVFilterLink outlink)

Definition at line 705 of file vulkan.c.

Referenced by overlay_vulkan_config_output(), and scale_vulkan_config_output().

int ff_vk_filter_config_output_inplace ( AVFilterLink outlink)

Definition at line 675 of file vulkan.c.

void ff_vk_filter_uninit ( AVFilterContext avctx)
const char* ff_vk_ret2str ( VkResult  res)
int ff_vk_mt_is_np_rgb ( enum AVPixelFormat  pix_fmt)

Returns 1 if the image is any sort of supported RGB.

Definition at line 805 of file vulkan.c.

Referenced by scale_vulkan_config_output().

const char* ff_vk_shader_rep_fmt ( enum AVPixelFormat  pixfmt)

Gets the glsl format string for a pixel format.

Definition at line 817 of file vulkan.c.

Referenced by init_filter().

VkSampler* ff_vk_init_sampler ( AVFilterContext avctx,
int  unnorm_coords,
VkFilter  filt 
)

Create a Vulkan sampler, will be auto-freed in ff_vk_filter_uninit()

Definition at line 769 of file vulkan.c.

Referenced by init_filter().

int ff_vk_create_imageview ( AVFilterContext avctx,
FFVkExecContext e,
VkImageView *  v,
VkImage  img,
VkFormat  fmt,
const VkComponentMapping  map 
)

Create an imageview.

Guaranteed to remain alive until the queue submission has finished executing, and will be destroyed after that.

Definition at line 836 of file vulkan.c.

Referenced by process_frames().

int ff_vk_add_push_constant ( AVFilterContext avctx,
VulkanPipeline pl,
int  offset,
int  size,
VkShaderStageFlagBits  stage 
)

Define a push constant for a given stage into a pipeline.

Must be called before the pipeline layout has been initialized.

Definition at line 318 of file vulkan.c.

Referenced by init_filter().

VulkanPipeline* ff_vk_create_pipeline ( AVFilterContext avctx)

Inits a pipeline.

Everything in it will be auto-freed when calling ff_vk_filter_uninit().

Definition at line 1276 of file vulkan.c.

Referenced by init_filter().

SPIRVShader* ff_vk_init_shader ( AVFilterContext avctx,
VulkanPipeline pl,
const char *  name,
VkShaderStageFlags  stage 
)

Inits a shader for a specific pipeline.

Will be auto-freed on uninit.

Definition at line 888 of file vulkan.c.

Referenced by init_filter().

void ff_vk_set_compute_shader_sizes ( AVFilterContext avctx,
SPIRVShader shd,
int  local_size[3] 
)

Writes the workgroup size for a shader.

Definition at line 909 of file vulkan.c.

Referenced by init_filter().

int ff_vk_add_descriptor_set ( AVFilterContext avctx,
VulkanPipeline pl,
SPIRVShader shd,
VulkanDescriptorSetBinding desc,
int  num,
int  only_print_to_shader 
)

Adds a descriptor set to the shader and registers them in the pipeline.

Definition at line 1020 of file vulkan.c.

Referenced by init_filter().

int ff_vk_compile_shader ( AVFilterContext avctx,
SPIRVShader shd,
const char *  entrypoint 
)

Compiles the shader, entrypoint must be set to "main".

Definition at line 942 of file vulkan.c.

Referenced by init_filter().

int ff_vk_init_pipeline_layout ( AVFilterContext avctx,
VulkanPipeline pl 
)

Initializes the pipeline layout after all shaders and descriptor sets have been finished.

Definition at line 1180 of file vulkan.c.

Referenced by init_filter().

int ff_vk_init_compute_pipeline ( AVFilterContext avctx,
VulkanPipeline pl 
)

Initializes a compute pipeline.

Will pick the first shader with the COMPUTE flag set.

Definition at line 1281 of file vulkan.c.

Referenced by init_filter().

void ff_vk_update_descriptor_set ( AVFilterContext avctx,
VulkanPipeline pl,
int  set_id 
)

Updates a descriptor set via the updaters defined.

Can be called immediately after pipeline creation, but must be called at least once before queue submission.

Definition at line 1160 of file vulkan.c.

Referenced by init_filter(), and process_frames().

int ff_vk_create_exec_ctx ( AVFilterContext avctx,
FFVkExecContext **  ctx 
)

Init an execution context for command recording and queue submission.

WIll be auto-freed on uninit.

Definition at line 339 of file vulkan.c.

Referenced by init_filter().

int ff_vk_start_exec_recording ( AVFilterContext avctx,
FFVkExecContext e 
)

Begin recording to the command buffer.

Previous execution must have been completed, which ff_vk_submit_exec_queue() will ensure.

Definition at line 417 of file vulkan.c.

Referenced by process_frames().

void ff_vk_bind_pipeline_exec ( AVFilterContext avctx,
FFVkExecContext e,
VulkanPipeline pl 
)

Add a command to bind the completed pipeline and its descriptor sets.

Must be called after ff_vk_start_exec_recording() and before submission.

Definition at line 1316 of file vulkan.c.

Referenced by process_frames().

void ff_vk_update_push_exec ( AVFilterContext avctx,
FFVkExecContext e,
VkShaderStageFlagBits  stage,
int  offset,
size_t  size,
void src 
)

Updates push constants.

Must be called after binding a pipeline if any push constants were defined.

Definition at line 1171 of file vulkan.c.

Referenced by process_frames().

VkCommandBuffer ff_vk_get_exec_buf ( AVFilterContext avctx,
FFVkExecContext e 
)

Gets the command buffer to use for this submission from the exe context.

Definition at line 458 of file vulkan.c.

Referenced by process_frames().

int ff_vk_add_dep_exec_ctx ( AVFilterContext avctx,
FFVkExecContext e,
AVBufferRef **  deps,
int  nb_deps 
)

Adds a generic AVBufferRef as a queue depenency.

Definition at line 561 of file vulkan.c.

Referenced by ff_vk_create_imageview().

void ff_vk_discard_exec_deps ( AVFilterContext avctx,
FFVkExecContext e 
)

Discards all queue dependencies.

Definition at line 400 of file vulkan.c.

Referenced by ff_vk_add_dep_exec_ctx(), ff_vk_add_exec_dep(), ff_vk_start_exec_recording(), and process_frames().

int ff_vk_add_exec_dep ( AVFilterContext avctx,
FFVkExecContext e,
AVFrame frame,
VkPipelineStageFlagBits  in_wait_dst_flag 
)

Adds a frame as a queue dependency.

This also manages semaphore signalling. Must be called before submission.

Definition at line 464 of file vulkan.c.

Referenced by process_frames().

int ff_vk_submit_exec_queue ( AVFilterContext avctx,
FFVkExecContext e 
)

Submits a command buffer to the queue for execution.

Will block until execution has finished in order to simplify resource management.

Definition at line 522 of file vulkan.c.

Referenced by process_frames().

int ff_vk_create_buf ( AVFilterContext avctx,
FFVkBuffer buf,
size_t  size,
VkBufferUsageFlags  usage,
VkMemoryPropertyFlagBits  flags 
)

Create a VkBuffer with the specified parameters.

Definition at line 150 of file vulkan.c.

Referenced by init_filter().

int ff_vk_map_buffers ( AVFilterContext avctx,
FFVkBuffer buf,
uint8_t mem[],
int  nb_buffers,
int  invalidate 
)

Maps the buffer to userspace.

Set invalidate to 1 if reading the contents is necessary.

Definition at line 215 of file vulkan.c.

Referenced by init_filter().

int ff_vk_unmap_buffers ( AVFilterContext avctx,
FFVkBuffer buf,
int  nb_buffers,
int  flush 
)

Unmaps the buffer from userspace.

Set flush to 1 to write and sync.

Definition at line 264 of file vulkan.c.

Referenced by init_filter().

void ff_vk_free_buf ( AVFilterContext avctx,
FFVkBuffer buf 
)

Frees a buffer.

Definition at line 306 of file vulkan.c.

Referenced by overlay_vulkan_uninit(), and scale_vulkan_uninit().

Variable Documentation

const VkComponentMapping ff_comp_identity_map

Definition at line 44 of file vulkan.c.

Referenced by process_frames().