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 #include "libavutil/opt.h"
21 #include "scale_eval.h"
23 #include "colorspace.h"
25 #define CGROUPS (int [3]){ 32, 32, 1 }
34 typedef struct ScaleVulkanContext {
35 VulkanFilterContext vkctx;
38 FFVkExecContext *exec;
40 FFVkBuffer params_buf;
42 /* Shader updators, must be in the main filter struct */
43 VkDescriptorImageInfo input_images[3];
44 VkDescriptorImageInfo output_images[3];
45 VkDescriptorBufferInfo params_desc;
47 enum ScalerFunc scaler;
48 char *out_format_string;
49 enum AVColorRange out_range;
54 static const char scale_bilinear[] = {
55 C(0, vec4 scale_bilinear(int idx, ivec2 pos, vec2 crop_range, vec2 crop_off))
57 C(1, vec2 npos = (vec2(pos) + 0.5f) / imageSize(output_img[idx]); )
58 C(1, npos *= crop_range; /* Reduce the range */ )
59 C(1, npos += crop_off; /* Offset the start */ )
60 C(1, return texture(input_img[idx], npos); )
64 static const char rgb2yuv[] = {
65 C(0, vec4 rgb2yuv(vec4 src, int fullrange) )
67 C(1, src *= yuv_matrix; )
68 C(1, if (fullrange == 1) { )
69 C(2, src += vec4(0.0, 0.5, 0.5, 0.0); )
71 C(2, src *= vec4(219.0 / 255.0, 224.0 / 255.0, 224.0 / 255.0, 1.0); )
72 C(2, src += vec4(16.0 / 255.0, 128.0 / 255.0, 128.0 / 255.0, 0.0); )
78 static const char write_nv12[] = {
79 C(0, void write_nv12(vec4 src, ivec2 pos) )
81 C(1, imageStore(output_img[0], pos, vec4(src.r, 0.0, 0.0, 0.0)); )
82 C(1, pos /= ivec2(2); )
83 C(1, imageStore(output_img[1], pos, vec4(src.g, src.b, 0.0, 0.0)); )
87 static const char write_420[] = {
88 C(0, void write_420(vec4 src, ivec2 pos) )
90 C(1, imageStore(output_img[0], pos, vec4(src.r, 0.0, 0.0, 0.0)); )
91 C(1, pos /= ivec2(2); )
92 C(1, imageStore(output_img[1], pos, vec4(src.g, 0.0, 0.0, 0.0)); )
93 C(1, imageStore(output_img[2], pos, vec4(src.b, 0.0, 0.0, 0.0)); )
97 static const char write_444[] = {
98 C(0, void write_444(vec4 src, ivec2 pos) )
100 C(1, imageStore(output_img[0], pos, vec4(src.r, 0.0, 0.0, 0.0)); )
101 C(1, imageStore(output_img[1], pos, vec4(src.g, 0.0, 0.0, 0.0)); )
102 C(1, imageStore(output_img[2], pos, vec4(src.b, 0.0, 0.0, 0.0)); )
106 static av_cold int init_filter(AVFilterContext *ctx, AVFrame *in)
110 VkFilter sampler_mode;
111 ScaleVulkanContext *s = ctx->priv;
113 int crop_x = in->crop_left;
114 int crop_y = in->crop_top;
115 int crop_w = in->width - (in->crop_left + in->crop_right);
116 int crop_h = in->height - (in->crop_top + in->crop_bottom);
118 s->vkctx.queue_family_idx = s->vkctx.hwctx->queue_family_comp_index;
119 s->vkctx.queue_count = GET_QUEUE_COUNT(s->vkctx.hwctx, 0, 1, 0);
120 s->vkctx.cur_queue_idx = rand() % s->vkctx.queue_count;
124 sampler_mode = VK_FILTER_NEAREST;
127 sampler_mode = VK_FILTER_LINEAR;
131 /* Create a sampler */
132 sampler = ff_vk_init_sampler(ctx, 0, sampler_mode);
134 return AVERROR_EXTERNAL;
136 s->pl = ff_vk_create_pipeline(ctx);
138 return AVERROR(ENOMEM);
140 { /* Create the shader */
141 VulkanDescriptorSetBinding desc_i[2] = {
144 .type = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER,
146 .elems = av_pix_fmt_count_planes(s->vkctx.input_format),
147 .stages = VK_SHADER_STAGE_COMPUTE_BIT,
148 .updater = s->input_images,
149 .samplers = DUP_SAMPLER_ARRAY4(*sampler),
152 .name = "output_img",
153 .type = VK_DESCRIPTOR_TYPE_STORAGE_IMAGE,
154 .mem_layout = ff_vk_shader_rep_fmt(s->vkctx.output_format),
155 .mem_quali = "writeonly",
157 .elems = av_pix_fmt_count_planes(s->vkctx.output_format),
158 .stages = VK_SHADER_STAGE_COMPUTE_BIT,
159 .updater = s->output_images,
163 VulkanDescriptorSetBinding desc_b = {
165 .type = VK_DESCRIPTOR_TYPE_STORAGE_BUFFER,
166 .mem_quali = "readonly",
167 .mem_layout = "std430",
168 .stages = VK_SHADER_STAGE_COMPUTE_BIT,
169 .updater = &s->params_desc,
170 .buf_content = "mat4 yuv_matrix;",
173 SPIRVShader *shd = ff_vk_init_shader(ctx, s->pl, "scale_compute",
174 VK_SHADER_STAGE_COMPUTE_BIT);
176 return AVERROR(ENOMEM);
178 ff_vk_set_compute_shader_sizes(ctx, shd, CGROUPS);
180 RET(ff_vk_add_descriptor_set(ctx, s->pl, shd, desc_i, 2, 0)); /* set 0 */
181 RET(ff_vk_add_descriptor_set(ctx, s->pl, shd, &desc_b, 1, 0)); /* set 0 */
183 GLSLD( scale_bilinear );
185 if (s->vkctx.output_format != s->vkctx.input_format) {
189 switch (s->vkctx.output_format) {
190 case AV_PIX_FMT_NV12: GLSLD(write_nv12); break;
191 case AV_PIX_FMT_YUV420P: GLSLD( write_420); break;
192 case AV_PIX_FMT_YUV444P: GLSLD( write_444); break;
196 GLSLC(0, void main() );
198 GLSLC(1, ivec2 size; );
199 GLSLC(1, ivec2 pos = ivec2(gl_GlobalInvocationID.xy); );
200 GLSLF(1, vec2 in_d = vec2(%i, %i); ,in->width, in->height);
201 GLSLF(1, vec2 c_r = vec2(%i, %i) / in_d; ,crop_w, crop_h);
202 GLSLF(1, vec2 c_o = vec2(%i, %i) / in_d; ,crop_x,crop_y);
205 if (s->vkctx.output_format == s->vkctx.input_format) {
206 for (int i = 0; i < desc_i[1].elems; i++) {
207 GLSLF(1, size = imageSize(output_img[%i]); ,i);
208 GLSLC(1, if (IS_WITHIN(pos, size)) { );
212 GLSLF(2, vec4 res = scale_bilinear(%i, pos, c_r, c_o); ,i);
213 GLSLF(2, imageStore(output_img[%i], pos, res); ,i);
219 GLSLC(1, vec4 res = scale_bilinear(0, pos, c_r, c_o); );
220 GLSLF(1, res = rgb2yuv(res, %i); ,s->out_range == AVCOL_RANGE_JPEG);
221 switch (s->vkctx.output_format) {
222 case AV_PIX_FMT_NV12: GLSLC(1, write_nv12(res, pos); ); break;
223 case AV_PIX_FMT_YUV420P: GLSLC(1, write_420(res, pos); ); break;
224 case AV_PIX_FMT_YUV444P: GLSLC(1, write_444(res, pos); ); break;
225 default: return AVERROR(EINVAL);
231 RET(ff_vk_compile_shader(ctx, shd, "main"));
234 RET(ff_vk_init_pipeline_layout(ctx, s->pl));
235 RET(ff_vk_init_compute_pipeline(ctx, s->pl));
237 if (s->vkctx.output_format != s->vkctx.input_format) {
238 const struct LumaCoefficients *lcoeffs;
239 double tmp_mat[3][3];
242 float yuv_matrix[4][4];
245 lcoeffs = ff_get_luma_coefficients(in->colorspace);
247 av_log(ctx, AV_LOG_ERROR, "Unsupported colorspace\n");
248 return AVERROR(EINVAL);
251 err = ff_vk_create_buf(ctx, &s->params_buf,
253 VK_BUFFER_USAGE_STORAGE_BUFFER_BIT,
254 VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT);
258 err = ff_vk_map_buffers(ctx, &s->params_buf, (uint8_t **)&par, 1, 0);
262 ff_fill_rgb2yuv_table(lcoeffs, tmp_mat);
264 memset(par, 0, sizeof(*par));
266 for (int y = 0; y < 3; y++)
267 for (int x = 0; x < 3; x++)
268 par->yuv_matrix[x][y] = tmp_mat[x][y];
270 par->yuv_matrix[3][3] = 1.0;
272 err = ff_vk_unmap_buffers(ctx, &s->params_buf, 1, 1);
276 s->params_desc.buffer = s->params_buf.buf;
277 s->params_desc.range = VK_WHOLE_SIZE;
279 ff_vk_update_descriptor_set(ctx, s->pl, 1);
282 /* Execution context */
283 RET(ff_vk_create_exec_ctx(ctx, &s->exec));
293 static int process_frames(AVFilterContext *avctx, AVFrame *out_f, AVFrame *in_f)
296 VkCommandBuffer cmd_buf;
297 ScaleVulkanContext *s = avctx->priv;
298 AVVkFrame *in = (AVVkFrame *)in_f->data[0];
299 AVVkFrame *out = (AVVkFrame *)out_f->data[0];
300 VkImageMemoryBarrier barriers[AV_NUM_DATA_POINTERS*2];
301 int barrier_count = 0;
303 /* Update descriptors and init the exec context */
304 ff_vk_start_exec_recording(avctx, s->exec);
305 cmd_buf = ff_vk_get_exec_buf(avctx, s->exec);
307 for (int i = 0; i < av_pix_fmt_count_planes(s->vkctx.input_format); i++) {
308 RET(ff_vk_create_imageview(avctx, s->exec, &s->input_images[i].imageView,
310 av_vkfmt_from_pixfmt(s->vkctx.input_format)[i],
311 ff_comp_identity_map));
313 s->input_images[i].imageLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
316 for (int i = 0; i < av_pix_fmt_count_planes(s->vkctx.output_format); i++) {
317 RET(ff_vk_create_imageview(avctx, s->exec, &s->output_images[i].imageView,
319 av_vkfmt_from_pixfmt(s->vkctx.output_format)[i],
320 ff_comp_identity_map));
322 s->output_images[i].imageLayout = VK_IMAGE_LAYOUT_GENERAL;
325 ff_vk_update_descriptor_set(avctx, s->pl, 0);
327 for (int i = 0; i < av_pix_fmt_count_planes(s->vkctx.input_format); i++) {
328 VkImageMemoryBarrier bar = {
329 .sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER,
331 .dstAccessMask = VK_ACCESS_SHADER_READ_BIT,
332 .oldLayout = in->layout[i],
333 .newLayout = s->input_images[i].imageLayout,
334 .srcQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED,
335 .dstQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED,
337 .subresourceRange.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT,
338 .subresourceRange.levelCount = 1,
339 .subresourceRange.layerCount = 1,
342 memcpy(&barriers[barrier_count++], &bar, sizeof(VkImageMemoryBarrier));
344 in->layout[i] = bar.newLayout;
345 in->access[i] = bar.dstAccessMask;
348 for (int i = 0; i < av_pix_fmt_count_planes(s->vkctx.output_format); i++) {
349 VkImageMemoryBarrier bar = {
350 .sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER,
352 .dstAccessMask = VK_ACCESS_SHADER_WRITE_BIT,
353 .oldLayout = out->layout[i],
354 .newLayout = s->output_images[i].imageLayout,
355 .srcQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED,
356 .dstQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED,
357 .image = out->img[i],
358 .subresourceRange.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT,
359 .subresourceRange.levelCount = 1,
360 .subresourceRange.layerCount = 1,
363 memcpy(&barriers[barrier_count++], &bar, sizeof(VkImageMemoryBarrier));
365 out->layout[i] = bar.newLayout;
366 out->access[i] = bar.dstAccessMask;
369 vkCmdPipelineBarrier(cmd_buf, VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT,
370 VK_PIPELINE_STAGE_COMPUTE_SHADER_BIT, 0,
371 0, NULL, 0, NULL, barrier_count, barriers);
373 ff_vk_bind_pipeline_exec(avctx, s->exec, s->pl);
375 vkCmdDispatch(cmd_buf,
376 FFALIGN(s->vkctx.output_width, CGROUPS[0])/CGROUPS[0],
377 FFALIGN(s->vkctx.output_height, CGROUPS[1])/CGROUPS[1], 1);
379 ff_vk_add_exec_dep(avctx, s->exec, in_f, VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT);
380 ff_vk_add_exec_dep(avctx, s->exec, out_f, VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT);
382 err = ff_vk_submit_exec_queue(avctx, s->exec);
389 ff_vk_discard_exec_deps(avctx, s->exec);
393 static int scale_vulkan_filter_frame(AVFilterLink *link, AVFrame *in)
396 AVFilterContext *ctx = link->dst;
397 ScaleVulkanContext *s = ctx->priv;
398 AVFilterLink *outlink = ctx->outputs[0];
400 AVFrame *out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
402 err = AVERROR(ENOMEM);
407 RET(init_filter(ctx, in));
409 RET(process_frames(ctx, out, in));
411 err = av_frame_copy_props(out, in);
415 if (s->out_range != AVCOL_RANGE_UNSPECIFIED)
416 out->color_range = s->out_range;
417 if (s->vkctx.output_format != s->vkctx.input_format)
418 out->chroma_location = AVCHROMA_LOC_TOPLEFT;
422 return ff_filter_frame(outlink, out);
430 static int scale_vulkan_config_output(AVFilterLink *outlink)
433 AVFilterContext *avctx = outlink->src;
434 ScaleVulkanContext *s = avctx->priv;
435 AVFilterLink *inlink = outlink->src->inputs[0];
437 err = ff_scale_eval_dimensions(s, s->w_expr, s->h_expr, inlink, outlink,
438 &s->vkctx.output_width,
439 &s->vkctx.output_height);
443 if (s->out_format_string) {
444 s->vkctx.output_format = av_get_pix_fmt(s->out_format_string);
445 if (s->vkctx.output_format == AV_PIX_FMT_NONE) {
446 av_log(avctx, AV_LOG_ERROR, "Invalid output format.\n");
447 return AVERROR(EINVAL);
450 s->vkctx.output_format = s->vkctx.input_format;
453 if (s->vkctx.output_format != s->vkctx.input_format) {
454 if (!ff_vk_mt_is_np_rgb(s->vkctx.input_format)) {
455 av_log(avctx, AV_LOG_ERROR, "Unsupported input format for conversion\n");
456 return AVERROR(EINVAL);
458 if (s->vkctx.output_format != AV_PIX_FMT_NV12 &&
459 s->vkctx.output_format != AV_PIX_FMT_YUV420P &&
460 s->vkctx.output_format != AV_PIX_FMT_YUV444P) {
461 av_log(avctx, AV_LOG_ERROR, "Unsupported output format\n");
462 return AVERROR(EINVAL);
464 } else if (s->out_range != AVCOL_RANGE_UNSPECIFIED) {
465 av_log(avctx, AV_LOG_ERROR, "Cannot change range without converting format\n");
466 return AVERROR(EINVAL);
469 err = ff_vk_filter_config_output(outlink);
476 static void scale_vulkan_uninit(AVFilterContext *avctx)
478 ScaleVulkanContext *s = avctx->priv;
480 ff_vk_filter_uninit(avctx);
481 ff_vk_free_buf(avctx, &s->params_buf);
486 #define OFFSET(x) offsetof(ScaleVulkanContext, x)
487 #define FLAGS (AV_OPT_FLAG_FILTERING_PARAM | AV_OPT_FLAG_VIDEO_PARAM)
488 static const AVOption scale_vulkan_options[] = {
489 { "w", "Output video width", OFFSET(w_expr), AV_OPT_TYPE_STRING, {.str = "iw"}, .flags = FLAGS },
490 { "h", "Output video height", OFFSET(h_expr), AV_OPT_TYPE_STRING, {.str = "ih"}, .flags = FLAGS },
491 { "scaler", "Scaler function", OFFSET(scaler), AV_OPT_TYPE_INT, {.i64 = F_BILINEAR}, 0, F_NB, .flags = FLAGS, "scaler" },
492 { "bilinear", "Bilinear interpolation (fastest)", 0, AV_OPT_TYPE_CONST, {.i64 = F_BILINEAR}, 0, 0, .flags = FLAGS, "scaler" },
493 { "nearest", "Nearest (useful for pixel art)", 0, AV_OPT_TYPE_CONST, {.i64 = F_NEAREST}, 0, 0, .flags = FLAGS, "scaler" },
494 { "format", "Output video format (software format of hardware frames)", OFFSET(out_format_string), AV_OPT_TYPE_STRING, .flags = FLAGS },
495 { "out_range", "Output colour range (from 0 to 2) (default 0)", OFFSET(out_range), AV_OPT_TYPE_INT, {.i64 = AVCOL_RANGE_UNSPECIFIED}, AVCOL_RANGE_UNSPECIFIED, AVCOL_RANGE_JPEG, .flags = FLAGS, "range" },
496 { "full", "Full range", 0, AV_OPT_TYPE_CONST, { .i64 = AVCOL_RANGE_JPEG }, 0, 0, FLAGS, "range" },
497 { "limited", "Limited range", 0, AV_OPT_TYPE_CONST, { .i64 = AVCOL_RANGE_MPEG }, 0, 0, FLAGS, "range" },
498 { "jpeg", "Full range", 0, AV_OPT_TYPE_CONST, { .i64 = AVCOL_RANGE_JPEG }, 0, 0, FLAGS, "range" },
499 { "mpeg", "Limited range", 0, AV_OPT_TYPE_CONST, { .i64 = AVCOL_RANGE_MPEG }, 0, 0, FLAGS, "range" },
500 { "tv", "Limited range", 0, AV_OPT_TYPE_CONST, { .i64 = AVCOL_RANGE_MPEG }, 0, 0, FLAGS, "range" },
501 { "pc", "Full range", 0, AV_OPT_TYPE_CONST, { .i64 = AVCOL_RANGE_JPEG }, 0, 0, FLAGS, "range" },
505 AVFILTER_DEFINE_CLASS(scale_vulkan);
507 static const AVFilterPad scale_vulkan_inputs[] = {
510 .type = AVMEDIA_TYPE_VIDEO,
511 .filter_frame = &scale_vulkan_filter_frame,
512 .config_props = &ff_vk_filter_config_input,
517 static const AVFilterPad scale_vulkan_outputs[] = {
520 .type = AVMEDIA_TYPE_VIDEO,
521 .config_props = &scale_vulkan_config_output,
526 AVFilter ff_vf_scale_vulkan = {
527 .name = "scale_vulkan",
528 .description = NULL_IF_CONFIG_SMALL("Scale Vulkan frames"),
529 .priv_size = sizeof(ScaleVulkanContext),
530 .init = &ff_vk_filter_init,
531 .uninit = &scale_vulkan_uninit,
532 .query_formats = &ff_vk_filter_query_formats,
533 .inputs = scale_vulkan_inputs,
534 .outputs = scale_vulkan_outputs,
535 .priv_class = &scale_vulkan_class,
536 .flags_internal = FF_FILTER_FLAG_HWFRAME_AWARE,