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/avstring.h"
20 #include "libavutil/log.h"
21 #include "libavutil/mem.h"
22 #include "libavutil/opt.h"
23 #include "libavutil/pixdesc.h"
26 #include "framesync.h"
31 typedef struct ProgramOpenCLContext {
32 OpenCLFilterContext ocf;
37 cl_command_queue command_queue;
42 const char *source_file;
43 const char *kernel_name;
46 enum AVPixelFormat source_format;
47 AVRational source_rate;
48 } ProgramOpenCLContext;
50 static int program_opencl_load(AVFilterContext *avctx)
52 ProgramOpenCLContext *ctx = avctx->priv;
56 err = ff_opencl_filter_load_program_from_file(avctx, ctx->source_file);
60 ctx->command_queue = clCreateCommandQueue(ctx->ocf.hwctx->context,
61 ctx->ocf.hwctx->device_id,
63 if (!ctx->command_queue) {
64 av_log(avctx, AV_LOG_ERROR, "Failed to create OpenCL "
65 "command queue: %d.\n", cle);
69 ctx->kernel = clCreateKernel(ctx->ocf.program, ctx->kernel_name, &cle);
71 if (cle == CL_INVALID_KERNEL_NAME) {
72 av_log(avctx, AV_LOG_ERROR, "Kernel function '%s' not found in "
73 "program.\n", ctx->kernel_name);
75 av_log(avctx, AV_LOG_ERROR, "Failed to create kernel: %d.\n", cle);
84 static int program_opencl_run(AVFilterContext *avctx)
86 AVFilterLink *outlink = avctx->outputs[0];
87 ProgramOpenCLContext *ctx = avctx->priv;
88 AVFrame *output = NULL;
90 size_t global_work[2];
92 int err, input, plane;
95 err = program_opencl_load(avctx);
100 output = ff_get_video_buffer(outlink, outlink->w, outlink->h);
102 err = AVERROR(ENOMEM);
106 for (plane = 0; plane < FF_ARRAY_ELEMS(output->data); plane++) {
107 dst = (cl_mem)output->data[plane];
111 cle = clSetKernelArg(ctx->kernel, 0, sizeof(cl_mem), &dst);
112 if (cle != CL_SUCCESS) {
113 av_log(avctx, AV_LOG_ERROR, "Failed to set kernel "
114 "destination image argument: %d.\n", cle);
115 err = AVERROR_UNKNOWN;
118 cle = clSetKernelArg(ctx->kernel, 1, sizeof(cl_uint), &ctx->index);
119 if (cle != CL_SUCCESS) {
120 av_log(avctx, AV_LOG_ERROR, "Failed to set kernel "
121 "index argument: %d.\n", cle);
122 err = AVERROR_UNKNOWN;
126 for (input = 0; input < ctx->nb_inputs; input++) {
127 av_assert0(ctx->frames[input]);
129 src = (cl_mem)ctx->frames[input]->data[plane];
132 cle = clSetKernelArg(ctx->kernel, 2 + input, sizeof(cl_mem), &src);
133 if (cle != CL_SUCCESS) {
134 av_log(avctx, AV_LOG_ERROR, "Failed to set kernel "
135 "source image argument %d: %d.\n", input, cle);
136 err = AVERROR_UNKNOWN;
141 err = ff_opencl_filter_work_size_from_image(avctx, global_work,
146 av_log(avctx, AV_LOG_DEBUG, "Run kernel on plane %d "
147 "(%zux%zu).\n", plane, global_work[0], global_work[1]);
149 cle = clEnqueueNDRangeKernel(ctx->command_queue, ctx->kernel, 2, NULL,
150 global_work, NULL, 0, NULL, NULL);
151 CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to enqueue kernel: %d.\n", cle);
154 cle = clFinish(ctx->command_queue);
155 CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to finish command queue: %d.\n", cle);
157 if (ctx->nb_inputs > 0) {
158 err = av_frame_copy_props(output, ctx->frames[0]);
162 output->pts = ctx->index;
166 av_log(ctx, AV_LOG_DEBUG, "Filter output: %s, %ux%u (%"PRId64").\n",
167 av_get_pix_fmt_name(output->format),
168 output->width, output->height, output->pts);
170 return ff_filter_frame(outlink, output);
173 clFinish(ctx->command_queue);
174 av_frame_free(&output);
178 static int program_opencl_request_frame(AVFilterLink *outlink)
180 AVFilterContext *avctx = outlink->src;
182 return program_opencl_run(avctx);
185 static int program_opencl_filter(FFFrameSync *fs)
187 AVFilterContext *avctx = fs->parent;
188 ProgramOpenCLContext *ctx = avctx->priv;
191 for (i = 0; i < ctx->nb_inputs; i++) {
192 err = ff_framesync_get_frame(&ctx->fs, i, &ctx->frames[i], 0);
197 return program_opencl_run(avctx);
200 static int program_opencl_activate(AVFilterContext *avctx)
202 ProgramOpenCLContext *ctx = avctx->priv;
204 av_assert0(ctx->nb_inputs > 0);
206 return ff_framesync_activate(&ctx->fs);
209 static int program_opencl_config_output(AVFilterLink *outlink)
211 AVFilterContext *avctx = outlink->src;
212 ProgramOpenCLContext *ctx = avctx->priv;
215 err = ff_opencl_filter_config_output(outlink);
219 if (ctx->nb_inputs > 0) {
223 err = ff_framesync_init(&ctx->fs, avctx, ctx->nb_inputs);
227 ctx->fs.opaque = ctx;
228 ctx->fs.on_event = &program_opencl_filter;
231 for (i = 0; i < ctx->nb_inputs; i++) {
232 const AVFilterLink *inlink = avctx->inputs[i];
234 in[i].time_base = inlink->time_base;
236 in[i].before = EXT_STOP;
237 in[i].after = EXT_INFINITY;
240 err = ff_framesync_configure(&ctx->fs);
245 outlink->time_base = av_inv_q(ctx->source_rate);
251 static av_cold int program_opencl_init(AVFilterContext *avctx)
253 ProgramOpenCLContext *ctx = avctx->priv;
256 ff_opencl_filter_init(avctx);
258 ctx->ocf.output_width = ctx->width;
259 ctx->ocf.output_height = ctx->height;
261 if (!strcmp(avctx->filter->name, "openclsrc")) {
262 if (!ctx->ocf.output_width || !ctx->ocf.output_height) {
263 av_log(avctx, AV_LOG_ERROR, "OpenCL source requires output "
264 "dimensions to be specified.\n");
265 return AVERROR(EINVAL);
269 ctx->ocf.output_format = ctx->source_format;
273 ctx->frames = av_mallocz_array(ctx->nb_inputs,
274 sizeof(*ctx->frames));
276 return AVERROR(ENOMEM);
278 for (i = 0; i < ctx->nb_inputs; i++) {
280 memset(&input, 0, sizeof(input));
282 input.type = AVMEDIA_TYPE_VIDEO;
283 input.name = av_asprintf("input%d", i);
285 return AVERROR(ENOMEM);
287 input.config_props = &ff_opencl_filter_config_input;
289 err = ff_insert_inpad(avctx, i, &input);
291 av_freep(&input.name);
300 static av_cold void program_opencl_uninit(AVFilterContext *avctx)
302 ProgramOpenCLContext *ctx = avctx->priv;
306 if (ctx->nb_inputs > 0) {
307 ff_framesync_uninit(&ctx->fs);
309 av_freep(&ctx->frames);
310 for (i = 0; i < avctx->nb_inputs; i++)
311 av_freep(&avctx->input_pads[i].name);
315 cle = clReleaseKernel(ctx->kernel);
316 if (cle != CL_SUCCESS)
317 av_log(avctx, AV_LOG_ERROR, "Failed to release "
318 "kernel: %d.\n", cle);
321 if (ctx->command_queue) {
322 cle = clReleaseCommandQueue(ctx->command_queue);
323 if (cle != CL_SUCCESS)
324 av_log(avctx, AV_LOG_ERROR, "Failed to release "
325 "command queue: %d.\n", cle);
328 ff_opencl_filter_uninit(avctx);
331 #define OFFSET(x) offsetof(ProgramOpenCLContext, x)
332 #define FLAGS (AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_FILTERING_PARAM)
334 #if CONFIG_PROGRAM_OPENCL_FILTER
336 static const AVOption program_opencl_options[] = {
337 { "source", "OpenCL program source file", OFFSET(source_file),
338 AV_OPT_TYPE_STRING, { .str = NULL }, .flags = FLAGS },
339 { "kernel", "Kernel name in program", OFFSET(kernel_name),
340 AV_OPT_TYPE_STRING, { .str = NULL }, .flags = FLAGS },
342 { "inputs", "Number of inputs", OFFSET(nb_inputs),
343 AV_OPT_TYPE_INT, { .i64 = 1 }, 1, INT_MAX, FLAGS },
345 { "size", "Video size", OFFSET(width),
346 AV_OPT_TYPE_IMAGE_SIZE, { .str = NULL }, 0, 0, FLAGS },
347 { "s", "Video size", OFFSET(width),
348 AV_OPT_TYPE_IMAGE_SIZE, { .str = NULL }, 0, 0, FLAGS },
353 FRAMESYNC_DEFINE_CLASS(program_opencl, ProgramOpenCLContext, fs);
355 static const AVFilterPad program_opencl_outputs[] = {
358 .type = AVMEDIA_TYPE_VIDEO,
359 .config_props = &program_opencl_config_output,
364 AVFilter ff_vf_program_opencl = {
365 .name = "program_opencl",
366 .description = NULL_IF_CONFIG_SMALL("Filter video using an OpenCL program"),
367 .priv_size = sizeof(ProgramOpenCLContext),
368 .priv_class = &program_opencl_class,
369 .preinit = &program_opencl_framesync_preinit,
370 .init = &program_opencl_init,
371 .uninit = &program_opencl_uninit,
372 .query_formats = &ff_opencl_filter_query_formats,
373 .activate = &program_opencl_activate,
375 .outputs = program_opencl_outputs,
376 .flags_internal = FF_FILTER_FLAG_HWFRAME_AWARE,
381 #if CONFIG_OPENCLSRC_FILTER
383 static const AVOption openclsrc_options[] = {
384 { "source", "OpenCL program source file", OFFSET(source_file),
385 AV_OPT_TYPE_STRING, { .str = NULL }, .flags = FLAGS },
386 { "kernel", "Kernel name in program", OFFSET(kernel_name),
387 AV_OPT_TYPE_STRING, { .str = NULL }, .flags = FLAGS },
389 { "size", "Video size", OFFSET(width),
390 AV_OPT_TYPE_IMAGE_SIZE, { .str = NULL }, 0, 0, FLAGS },
391 { "s", "Video size", OFFSET(width),
392 AV_OPT_TYPE_IMAGE_SIZE, { .str = NULL }, 0, 0, FLAGS },
394 { "format", "Video format", OFFSET(source_format),
395 AV_OPT_TYPE_PIXEL_FMT, { .i64 = AV_PIX_FMT_NONE }, -1, INT_MAX, FLAGS },
397 { "rate", "Video frame rate", OFFSET(source_rate),
398 AV_OPT_TYPE_VIDEO_RATE, { .str = "25" }, 0, INT_MAX, FLAGS },
399 { "r", "Video frame rate", OFFSET(source_rate),
400 AV_OPT_TYPE_VIDEO_RATE, { .str = "25" }, 0, INT_MAX, FLAGS },
405 AVFILTER_DEFINE_CLASS(openclsrc);
407 static const AVFilterPad openclsrc_outputs[] = {
410 .type = AVMEDIA_TYPE_VIDEO,
411 .config_props = &program_opencl_config_output,
412 .request_frame = &program_opencl_request_frame,
417 AVFilter ff_vsrc_openclsrc = {
419 .description = NULL_IF_CONFIG_SMALL("Generate video using an OpenCL program"),
420 .priv_size = sizeof(ProgramOpenCLContext),
421 .priv_class = &openclsrc_class,
422 .init = &program_opencl_init,
423 .uninit = &program_opencl_uninit,
424 .query_formats = &ff_opencl_filter_query_formats,
426 .outputs = openclsrc_outputs,
427 .flags_internal = FF_FILTER_FLAG_HWFRAME_AWARE,