FFmpeg
vf_flip_vulkan.c
Go to the documentation of this file.
1 /*
2  * copyright (c) 2021 Wu Jianhua <jianhua.wu@intel.com>
3  * Copyright (c) Lynne
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
22 #include "libavutil/random_seed.h"
23 #include "libavutil/opt.h"
24 #include "vulkan_filter.h"
25 #include "vulkan_spirv.h"
26 
27 #include "filters.h"
28 #include "video.h"
29 
30 enum FlipType {
34 };
35 
36 typedef struct FlipVulkanContext {
38 
44  VkSampler sampler;
46 
48 {
49  int err = 0;
50  uint8_t *spv_data;
51  size_t spv_len;
52  void *spv_opaque = NULL;
53  FlipVulkanContext *s = ctx->priv;
54  FFVulkanContext *vkctx = &s->vkctx;
55  const int planes = av_pix_fmt_count_planes(s->vkctx.output_format);
56  FFVkSPIRVShader *shd = &s->shd;
57  FFVkSPIRVCompiler *spv;
59 
60  spv = ff_vk_spirv_init();
61  if (!spv) {
62  av_log(ctx, AV_LOG_ERROR, "Unable to initialize SPIR-V compiler!\n");
63  return AVERROR_EXTERNAL;
64  }
65 
66  ff_vk_qf_init(vkctx, &s->qf, VK_QUEUE_COMPUTE_BIT);
67  RET(ff_vk_exec_pool_init(vkctx, &s->qf, &s->e, s->qf.nb_queues*4, 0, 0, 0, NULL));
68  RET(ff_vk_init_sampler(vkctx, &s->sampler, 1, VK_FILTER_LINEAR));
69  RET(ff_vk_shader_init(&s->pl, &s->shd, "flip_compute",
70  VK_SHADER_STAGE_COMPUTE_BIT, 0));
71 
72  ff_vk_shader_set_compute_sizes(&s->shd, 32, 32, 1);
73 
75  {
76  .name = "input_image",
77  .type = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER,
78  .dimensions = 2,
79  .elems = planes,
80  .stages = VK_SHADER_STAGE_COMPUTE_BIT,
81  .samplers = DUP_SAMPLER(s->sampler),
82  },
83  {
84  .name = "output_image",
85  .type = VK_DESCRIPTOR_TYPE_STORAGE_IMAGE,
86  .mem_layout = ff_vk_shader_rep_fmt(s->vkctx.output_format),
87  .mem_quali = "writeonly",
88  .dimensions = 2,
89  .elems = planes,
90  .stages = VK_SHADER_STAGE_COMPUTE_BIT,
91  },
92  };
93 
94  RET(ff_vk_pipeline_descriptor_set_add(vkctx, &s->pl, shd, desc, 2, 0, 0));
95 
96  GLSLC(0, void main() );
97  GLSLC(0, { );
98  GLSLC(1, ivec2 size; );
99  GLSLC(1, const ivec2 pos = ivec2(gl_GlobalInvocationID.xy); );
100  for (int i = 0; i < planes; i++) {
101  GLSLC(0, );
102  GLSLF(1, size = imageSize(output_image[%i]); ,i);
103  GLSLC(1, if (IS_WITHIN(pos, size)) { );
104  switch (type)
105  {
106  case FLIP_HORIZONTAL:
107  GLSLF(2, vec4 res = texture(input_image[%i], ivec2(size.x - pos.x, pos.y)); ,i);
108  break;
109  case FLIP_VERTICAL:
110  GLSLF(2, vec4 res = texture(input_image[%i], ivec2(pos.x, size.y - pos.y)); ,i);
111  break;
112  case FLIP_BOTH:
113  GLSLF(2, vec4 res = texture(input_image[%i], ivec2(size.xy - pos.xy));, i);
114  break;
115  default:
116  GLSLF(2, vec4 res = texture(input_image[%i], pos); ,i);
117  break;
118  }
119  GLSLF(2, imageStore(output_image[%i], pos, res); ,i);
120  GLSLC(1, } );
121  }
122  GLSLC(0, } );
123 
124  RET(spv->compile_shader(spv, ctx, shd, &spv_data, &spv_len, "main",
125  &spv_opaque));
126  RET(ff_vk_shader_create(vkctx, shd, spv_data, spv_len, "main"));
127 
128  RET(ff_vk_init_compute_pipeline(vkctx, &s->pl, shd));
129  RET(ff_vk_exec_pipeline_register(vkctx, &s->e, &s->pl));
130 
131  s->initialized = 1;
132 
133 fail:
134  if (spv_opaque)
135  spv->free_shader(spv, &spv_opaque);
136  if (spv)
137  spv->uninit(&spv);
138 
139  return err;
140 }
141 
143 {
144  FlipVulkanContext *s = avctx->priv;
145 
146  FFVulkanContext *vkctx = &s->vkctx;
147  FFVulkanFunctions *vk = &vkctx->vkfn;
148 
149  ff_vk_exec_pool_free(vkctx, &s->e);
150  ff_vk_pipeline_free(vkctx, &s->pl);
151  ff_vk_shader_free(vkctx, &s->shd);
152 
153  if (s->sampler)
154  vk->DestroySampler(vkctx->hwctx->act_dev, s->sampler,
155  vkctx->hwctx->alloc);
156 
157  ff_vk_uninit(&s->vkctx);
158 
159  s->initialized = 0;
160 }
161 
163 {
164  int err;
165  AVFrame *out = NULL;
166  AVFilterContext *ctx = link->dst;
167  FlipVulkanContext *s = ctx->priv;
168  AVFilterLink *outlink = ctx->outputs[0];
169 
170  out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
171  if (!out) {
172  err = AVERROR(ENOMEM);
173  goto fail;
174  }
175 
176  if (!s->initialized)
177  RET(init_filter(ctx, in, type));
178 
179  RET(ff_vk_filter_process_simple(&s->vkctx, &s->e, &s->pl, out, in,
180  s->sampler, NULL, 0));
181 
183 
184  av_frame_free(&in);
185 
186  return ff_filter_frame(outlink, out);
187 
188 fail:
189  av_frame_free(&in);
190  av_frame_free(&out);
191  return err;
192 }
193 
195 {
196  return filter_frame(link, in, FLIP_HORIZONTAL);
197 }
198 
200 {
201  return filter_frame(link, in, FLIP_VERTICAL);
202 }
203 
205 {
206  return filter_frame(link, in, FLIP_BOTH);
207 }
208 
210  {
211  .name = "default",
212  .type = AVMEDIA_TYPE_VIDEO,
213  .config_props = &ff_vk_filter_config_output,
214  }
215 };
216 
217 static const AVOption hflip_vulkan_options[] = {
218  { NULL },
219 };
220 
221 AVFILTER_DEFINE_CLASS(hflip_vulkan);
222 
224  {
225  .name = "default",
226  .type = AVMEDIA_TYPE_VIDEO,
227  .filter_frame = &hflip_vulkan_filter_frame,
228  .config_props = &ff_vk_filter_config_input,
229  }
230 };
231 
233  .name = "hflip_vulkan",
234  .description = NULL_IF_CONFIG_SMALL("Horizontally flip the input video in Vulkan"),
235  .priv_size = sizeof(FlipVulkanContext),
241  .priv_class = &hflip_vulkan_class,
242  .flags_internal = FF_FILTER_FLAG_HWFRAME_AWARE,
243 };
244 
245 static const AVOption vflip_vulkan_options[] = {
246  { NULL },
247 };
248 
249 AVFILTER_DEFINE_CLASS(vflip_vulkan);
250 
252  {
253  .name = "default",
254  .type = AVMEDIA_TYPE_VIDEO,
255  .filter_frame = &vflip_vulkan_filter_frame,
256  .config_props = &ff_vk_filter_config_input,
257  }
258 };
259 
261  .name = "vflip_vulkan",
262  .description = NULL_IF_CONFIG_SMALL("Vertically flip the input video in Vulkan"),
263  .priv_size = sizeof(FlipVulkanContext),
269  .priv_class = &vflip_vulkan_class,
270  .flags_internal = FF_FILTER_FLAG_HWFRAME_AWARE,
271 };
272 
273 static const AVOption flip_vulkan_options[] = {
274  { NULL },
275 };
276 
277 AVFILTER_DEFINE_CLASS(flip_vulkan);
278 
279 static const AVFilterPad flip_vulkan_inputs[] = {
280  {
281  .name = "default",
282  .type = AVMEDIA_TYPE_VIDEO,
283  .filter_frame = &flip_vulkan_filter_frame,
284  .config_props = &ff_vk_filter_config_input,
285  }
286 };
287 
289  .name = "flip_vulkan",
290  .description = NULL_IF_CONFIG_SMALL("Flip both horizontally and vertically"),
291  .priv_size = sizeof(FlipVulkanContext),
297  .priv_class = &flip_vulkan_class,
298  .flags_internal = FF_FILTER_FLAG_HWFRAME_AWARE,
299  .flags = AVFILTER_FLAG_HWDEVICE,
300 };
ff_get_video_buffer
AVFrame * ff_get_video_buffer(AVFilterLink *link, int w, int h)
Request a picture buffer with a specific set of permissions.
Definition: video.c:116
ff_vk_pipeline_free
void ff_vk_pipeline_free(FFVulkanContext *s, FFVulkanPipeline *pl)
Definition: vulkan.c:1809
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
out
FILE * out
Definition: movenc.c:55
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1023
ff_vk_qf_init
int ff_vk_qf_init(FFVulkanContext *s, FFVkQueueFamilyCtx *qf, VkQueueFlagBits dev_family)
Chooses a QF and loads it into a context.
Definition: vulkan.c:228
flip_vulkan_filter_frame
static int flip_vulkan_filter_frame(AVFilterLink *link, AVFrame *in)
Definition: vf_flip_vulkan.c:204
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:160
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: filters.h:262
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:374
ff_vk_filter_init
int ff_vk_filter_init(AVFilterContext *avctx)
General lavfi IO functions.
Definition: vulkan_filter.c:243
ff_vk_shader_create
int ff_vk_shader_create(FFVulkanContext *s, FFVkSPIRVShader *shd, uint8_t *spirv, size_t spirv_size, const char *entrypoint)
Definition: vulkan.c:1378
AVOption
AVOption.
Definition: opt.h:429
ff_vk_uninit
void ff_vk_uninit(FFVulkanContext *s)
Frees main context.
Definition: vulkan.c:1838
FFVkSPIRVCompiler::uninit
void(* uninit)(struct FFVkSPIRVCompiler **ctx)
Definition: vulkan_spirv.h:33
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:205
ff_vk_shader_set_compute_sizes
void ff_vk_shader_set_compute_sizes(FFVkSPIRVShader *shd, int x, int y, int z)
Definition: vulkan.c:1336
video.h
AV_PIX_FMT_VULKAN
@ AV_PIX_FMT_VULKAN
Vulkan hardware images.
Definition: pixfmt.h:379
ff_vf_vflip_vulkan
const AVFilter ff_vf_vflip_vulkan
Definition: vf_flip_vulkan.c:260
av_pix_fmt_count_planes
int av_pix_fmt_count_planes(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:3005
FlipType
FlipType
Definition: vf_flip_vulkan.c:30
vflip_vulkan_options
static const AVOption vflip_vulkan_options[]
Definition: vf_flip_vulkan.c:245
AVVulkanDeviceContext::alloc
const VkAllocationCallbacks * alloc
Custom memory allocator, else NULL.
Definition: hwcontext_vulkan.h:63
AVFilterContext::priv
void * priv
private data for use by the filter
Definition: avfilter.h:472
fail
#define fail()
Definition: checkasm.h:188
vulkan_filter.h
type
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 type
Definition: writing_filters.txt:86
AVFilterPad
A filter pad used for either input or output.
Definition: filters.h:38
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
av_cold
#define av_cold
Definition: attributes.h:90
main
int main
Definition: dovi_rpuenc.c:37
ff_vf_hflip_vulkan
const AVFilter ff_vf_hflip_vulkan
Definition: vf_flip_vulkan.c:232
s
#define s(width, name)
Definition: cbs_vp9.c:198
FlipVulkanContext::initialized
int initialized
Definition: vf_flip_vulkan.c:39
vflip_vulkan_inputs
static const AVFilterPad vflip_vulkan_inputs[]
Definition: vf_flip_vulkan.c:251
filters.h
ctx
AVFormatContext * ctx
Definition: movenc.c:49
FFVkSPIRVCompiler::compile_shader
int(* compile_shader)(struct FFVkSPIRVCompiler *ctx, void *avctx, struct FFVkSPIRVShader *shd, uint8_t **data, size_t *size, const char *entrypoint, void **opaque)
Definition: vulkan_spirv.h:29
ff_vk_exec_pool_free
void ff_vk_exec_pool_free(FFVulkanContext *s, FFVkExecPool *pool)
Definition: vulkan.c:238
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: filters.h:263
hflip_vulkan_inputs
static const AVFilterPad hflip_vulkan_inputs[]
Definition: vf_flip_vulkan.c:223
FlipVulkanContext::sampler
VkSampler sampler
Definition: vf_flip_vulkan.c:44
link
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a link
Definition: filter_design.txt:23
NULL
#define NULL
Definition: coverity.c:32
av_frame_copy_props
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:711
init_filter
static av_cold int init_filter(AVFilterContext *ctx, AVFrame *in, enum FlipType type)
Definition: vf_flip_vulkan.c:47
FLIP_VERTICAL
@ FLIP_VERTICAL
Definition: vf_flip_vulkan.c:31
ff_vk_filter_config_output
int ff_vk_filter_config_output(AVFilterLink *outlink)
Definition: vulkan_filter.c:219
filter_frame
static int filter_frame(AVFilterLink *link, AVFrame *in, enum FlipType type)
Definition: vf_flip_vulkan.c:162
ff_vk_init_compute_pipeline
int ff_vk_init_compute_pipeline(FFVulkanContext *s, FFVulkanPipeline *pl, FFVkSPIRVShader *shd)
Definition: vulkan.c:1750
ff_vk_exec_pool_init
int ff_vk_exec_pool_init(FFVulkanContext *s, FFVkQueueFamilyCtx *qf, FFVkExecPool *pool, int nb_contexts, int nb_queries, VkQueryType query_type, int query_64bit, const void *query_create_pnext)
Allocates/frees an execution pool.
Definition: vulkan.c:278
FFVulkanContext
Definition: vulkan.h:229
FFVulkanPipeline
Definition: vulkan.h:132
FlipVulkanContext::qf
FFVkQueueFamilyCtx qf
Definition: vf_flip_vulkan.c:42
FlipVulkanContext::e
FFVkExecPool e
Definition: vf_flip_vulkan.c:41
FF_FILTER_FLAG_HWFRAME_AWARE
#define FF_FILTER_FLAG_HWFRAME_AWARE
The filter is aware of hardware frames, and any hardware frame context should not be automatically pr...
Definition: filters.h:206
ff_vk_shader_init
int ff_vk_shader_init(FFVulkanPipeline *pl, FFVkSPIRVShader *shd, const char *name, VkShaderStageFlags stage, uint32_t required_subgroup_size)
Shader management.
Definition: vulkan.c:1310
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(hflip_vulkan)
init
int(* init)(AVBSFContext *ctx)
Definition: dts2pts.c:366
FFVulkanDescriptorSetBinding
Definition: vulkan.h:83
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:94
AVFILTER_FLAG_HWDEVICE
#define AVFILTER_FLAG_HWDEVICE
The filter can create hardware frames using AVFilterContext.hw_device_ctx.
Definition: avfilter.h:173
FLIP_BOTH
@ FLIP_BOTH
Definition: vf_flip_vulkan.c:33
flip_vulkan_inputs
static const AVFilterPad flip_vulkan_inputs[]
Definition: vf_flip_vulkan.c:279
size
int size
Definition: twinvq_data.h:10344
FFVkQueueFamilyCtx
Definition: vulkan.h:110
FLIP_HORIZONTAL
@ FLIP_HORIZONTAL
Definition: vf_flip_vulkan.c:32
AVERROR_EXTERNAL
#define AVERROR_EXTERNAL
Generic error in an external library.
Definition: error.h:59
hflip_vulkan_filter_frame
static int hflip_vulkan_filter_frame(AVFilterLink *link, AVFrame *in)
Definition: vf_flip_vulkan.c:194
ff_vk_filter_process_simple
int ff_vk_filter_process_simple(FFVulkanContext *vkctx, FFVkExecPool *e, FFVulkanPipeline *pl, AVFrame *out_f, AVFrame *in_f, VkSampler sampler, void *push_src, size_t push_size)
Submit a compute shader with a zero/one input and single out for execution.
Definition: vulkan_filter.c:252
FFVkSPIRVCompiler
Definition: vulkan_spirv.h:27
flip_vulkan_uninit
static av_cold void flip_vulkan_uninit(AVFilterContext *avctx)
Definition: vf_flip_vulkan.c:142
uninit
static void uninit(AVBSFContext *ctx)
Definition: pcm_rechunk.c:68
vflip_vulkan_filter_frame
static int vflip_vulkan_filter_frame(AVFilterLink *link, AVFrame *in)
Definition: vf_flip_vulkan.c:199
FlipVulkanContext::shd
FFVkSPIRVShader shd
Definition: vf_flip_vulkan.c:43
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:256
FlipVulkanContext::vkctx
FFVulkanContext vkctx
Definition: vf_flip_vulkan.c:37
hflip_vulkan_options
static const AVOption hflip_vulkan_options[]
Definition: vf_flip_vulkan.c:217
DUP_SAMPLER
#define DUP_SAMPLER(x)
Definition: vulkan.h:73
FlipVulkanContext::pl
FFVulkanPipeline pl
Definition: vf_flip_vulkan.c:40
ff_vk_shader_rep_fmt
const char * ff_vk_shader_rep_fmt(enum AVPixelFormat pixfmt)
Returns the format to use for images in shaders.
Definition: vulkan.c:1170
ff_vf_flip_vulkan
const AVFilter ff_vf_flip_vulkan
Definition: vf_flip_vulkan.c:288
vulkan_spirv.h
AVFilterPad::name
const char * name
Pad name.
Definition: filters.h:44
GLSLF
#define GLSLF(N, S,...)
Definition: vulkan.h:54
flip_vulkan_outputs
static const AVFilterPad flip_vulkan_outputs[]
Definition: vf_flip_vulkan.c:209
FFVkSPIRVCompiler::free_shader
void(* free_shader)(struct FFVkSPIRVCompiler *ctx, void **opaque)
Definition: vulkan_spirv.h:32
AVFilter
Filter definition.
Definition: avfilter.h:201
ff_vk_pipeline_descriptor_set_add
int ff_vk_pipeline_descriptor_set_add(FFVulkanContext *s, FFVulkanPipeline *pl, FFVkSPIRVShader *shd, FFVulkanDescriptorSetBinding *desc, int nb, int singular, int print_to_shader_only)
Add descriptor to a pipeline.
Definition: vulkan.c:1428
FFVulkanContext::vkfn
FFVulkanFunctions vkfn
Definition: vulkan.h:233
FFVkExecPool
Definition: vulkan.h:211
pos
unsigned int pos
Definition: spdifenc.c:414
random_seed.h
FFVkSPIRVShader
Definition: vulkan.h:75
AVFilterContext
An instance of a filter.
Definition: avfilter.h:457
desc
const char * desc
Definition: libsvtav1.c:79
GLSLC
#define GLSLC(N, S)
Definition: vulkan.h:44
ff_vk_filter_config_input
int ff_vk_filter_config_input(AVFilterLink *inlink)
Definition: vulkan_filter.c:186
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
FFVulkanContext::hwctx
AVVulkanDeviceContext * hwctx
Definition: vulkan.h:257
FlipVulkanContext
Definition: vf_flip_vulkan.c:36
AVVulkanDeviceContext::act_dev
VkDevice act_dev
Active device.
Definition: hwcontext_vulkan.h:84
ff_vk_init_sampler
int ff_vk_init_sampler(FFVulkanContext *s, VkSampler *sampler, int unnorm_coords, VkFilter filt)
Create a sampler.
Definition: vulkan.c:1126
ff_vk_exec_pipeline_register
int ff_vk_exec_pipeline_register(FFVulkanContext *s, FFVkExecPool *pool, FFVulkanPipeline *pl)
Register a pipeline with an exec pool.
Definition: vulkan.c:1542
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
ff_vk_shader_free
void ff_vk_shader_free(FFVulkanContext *s, FFVkSPIRVShader *shd)
Definition: vulkan.c:1369
FILTER_SINGLE_PIXFMT
#define FILTER_SINGLE_PIXFMT(pix_fmt_)
Definition: filters.h:252
RET
#define RET(x)
Definition: vulkan.h:67
FFVulkanFunctions
Definition: vulkan_functions.h:249
planes
static const struct @450 planes[]
flip_vulkan_options
static const AVOption flip_vulkan_options[]
Definition: vf_flip_vulkan.c:273