avfilter/af_sofalizer: speed up fast convolution
[ffmpeg.git] / libavfilter / vf_overlay_opencl.c
1 /*
2  * This file is part of FFmpeg.
3  *
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.
8  *
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.
13  *
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
17  */
18
19 #include "libavutil/log.h"
20 #include "libavutil/mem.h"
21 #include "libavutil/opt.h"
22 #include "libavutil/pixdesc.h"
23
24 #include "avfilter.h"
25 #include "framesync.h"
26 #include "internal.h"
27 #include "opencl.h"
28 #include "opencl_source.h"
29 #include "video.h"
30
31 typedef struct OverlayOpenCLContext {
32     OpenCLFilterContext ocf;
33
34     int              initialised;
35     cl_kernel        kernel;
36     cl_command_queue command_queue;
37
38     FFFrameSync      fs;
39
40     int              nb_planes;
41     int              x_subsample;
42     int              y_subsample;
43     int              alpha_separate;
44
45     int              x_position;
46     int              y_position;
47 } OverlayOpenCLContext;
48
49 static int overlay_opencl_load(AVFilterContext *avctx,
50                                enum AVPixelFormat main_format,
51                                enum AVPixelFormat overlay_format)
52 {
53     OverlayOpenCLContext *ctx = avctx->priv;
54     cl_int cle;
55     const char *source = ff_opencl_source_overlay;
56     const char *kernel;
57     const AVPixFmtDescriptor *main_desc, *overlay_desc;
58     int err, i, main_planes, overlay_planes;
59
60     main_desc    = av_pix_fmt_desc_get(main_format);
61     overlay_desc = av_pix_fmt_desc_get(overlay_format);
62
63     main_planes = overlay_planes = 0;
64     for (i = 0; i < main_desc->nb_components; i++)
65         main_planes = FFMAX(main_planes,
66                             main_desc->comp[i].plane + 1);
67     for (i = 0; i < overlay_desc->nb_components; i++)
68         overlay_planes = FFMAX(overlay_planes,
69                                overlay_desc->comp[i].plane + 1);
70
71     ctx->nb_planes = main_planes;
72     ctx->x_subsample = 1 << main_desc->log2_chroma_w;
73     ctx->y_subsample = 1 << main_desc->log2_chroma_h;
74
75     if (ctx->x_position % ctx->x_subsample ||
76         ctx->y_position % ctx->y_subsample) {
77         av_log(avctx, AV_LOG_WARNING, "Warning: overlay position (%d, %d) "
78                "does not match subsampling (%d, %d).\n",
79                ctx->x_position, ctx->y_position,
80                ctx->x_subsample, ctx->y_subsample);
81     }
82
83     if (main_planes == overlay_planes) {
84         if (main_desc->nb_components == overlay_desc->nb_components)
85             kernel = "overlay_no_alpha";
86         else
87             kernel = "overlay_internal_alpha";
88         ctx->alpha_separate = 0;
89     } else {
90         kernel = "overlay_external_alpha";
91         ctx->alpha_separate = 1;
92     }
93
94     av_log(avctx, AV_LOG_DEBUG, "Using kernel %s.\n", kernel);
95
96     err = ff_opencl_filter_load_program(avctx, &source, 1);
97     if (err < 0)
98         goto fail;
99
100     ctx->command_queue = clCreateCommandQueue(ctx->ocf.hwctx->context,
101                                               ctx->ocf.hwctx->device_id,
102                                               0, &cle);
103     CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to create OpenCL "
104                      "command queue %d.\n", cle);
105
106     ctx->kernel = clCreateKernel(ctx->ocf.program, kernel, &cle);
107     CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to create kernel %d.\n", cle);
108
109     ctx->initialised = 1;
110     return 0;
111
112 fail:
113     if (ctx->command_queue)
114         clReleaseCommandQueue(ctx->command_queue);
115     if (ctx->kernel)
116         clReleaseKernel(ctx->kernel);
117     return err;
118 }
119
120 static int overlay_opencl_blend(FFFrameSync *fs)
121 {
122     AVFilterContext    *avctx = fs->parent;
123     AVFilterLink     *outlink = avctx->outputs[0];
124     OverlayOpenCLContext *ctx = avctx->priv;
125     AVFrame *input_main, *input_overlay;
126     AVFrame *output;
127     cl_mem mem;
128     cl_int cle, x, y;
129     size_t global_work[2];
130     int kernel_arg = 0;
131     int err, plane;
132
133     err = ff_framesync_get_frame(fs, 0, &input_main, 0);
134     if (err < 0)
135         return err;
136     err = ff_framesync_get_frame(fs, 1, &input_overlay, 0);
137     if (err < 0)
138         return err;
139
140     if (!ctx->initialised) {
141         AVHWFramesContext *main_fc =
142             (AVHWFramesContext*)input_main->hw_frames_ctx->data;
143         AVHWFramesContext *overlay_fc =
144             (AVHWFramesContext*)input_overlay->hw_frames_ctx->data;
145
146         err = overlay_opencl_load(avctx, main_fc->sw_format,
147                                   overlay_fc->sw_format);
148         if (err < 0)
149             return err;
150     }
151
152     output = ff_get_video_buffer(outlink, outlink->w, outlink->h);
153     if (!output) {
154         err = AVERROR(ENOMEM);
155         goto fail;
156     }
157
158     for (plane = 0; plane < ctx->nb_planes; plane++) {
159         kernel_arg = 0;
160
161         mem = (cl_mem)output->data[plane];
162         CL_SET_KERNEL_ARG(ctx->kernel, kernel_arg, cl_mem, &mem);
163         kernel_arg++;
164
165         mem = (cl_mem)input_main->data[plane];
166         CL_SET_KERNEL_ARG(ctx->kernel, kernel_arg, cl_mem, &mem);
167         kernel_arg++;
168
169         mem = (cl_mem)input_overlay->data[plane];
170         CL_SET_KERNEL_ARG(ctx->kernel, kernel_arg, cl_mem, &mem);
171         kernel_arg++;
172
173         if (ctx->alpha_separate) {
174             mem = (cl_mem)input_overlay->data[ctx->nb_planes];
175             CL_SET_KERNEL_ARG(ctx->kernel, kernel_arg, cl_mem, &mem);
176             kernel_arg++;
177         }
178
179         x = ctx->x_position / (plane == 0 ? 1 : ctx->x_subsample);
180         y = ctx->y_position / (plane == 0 ? 1 : ctx->y_subsample);
181
182         CL_SET_KERNEL_ARG(ctx->kernel, kernel_arg, cl_int, &x);
183         kernel_arg++;
184         CL_SET_KERNEL_ARG(ctx->kernel, kernel_arg, cl_int, &y);
185         kernel_arg++;
186
187         if (ctx->alpha_separate) {
188             cl_int alpha_adj_x = plane == 0 ? 1 : ctx->x_subsample;
189             cl_int alpha_adj_y = plane == 0 ? 1 : ctx->y_subsample;
190
191             CL_SET_KERNEL_ARG(ctx->kernel, kernel_arg, cl_int, &alpha_adj_x);
192             kernel_arg++;
193             CL_SET_KERNEL_ARG(ctx->kernel, kernel_arg, cl_int, &alpha_adj_y);
194             kernel_arg++;
195         }
196
197         err = ff_opencl_filter_work_size_from_image(avctx, global_work,
198                                                     output, plane, 0);
199         if (err < 0)
200             goto fail;
201
202         cle = clEnqueueNDRangeKernel(ctx->command_queue, ctx->kernel, 2, NULL,
203                                      global_work, NULL, 0, NULL, NULL);
204         CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to enqueue overlay kernel "
205                          "for plane %d: %d.\n", plane, cle);
206     }
207
208     cle = clFinish(ctx->command_queue);
209     CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to finish command queue: %d.\n", cle);
210
211     err = av_frame_copy_props(output, input_main);
212
213     av_log(avctx, AV_LOG_DEBUG, "Filter output: %s, %ux%u (%"PRId64").\n",
214            av_get_pix_fmt_name(output->format),
215            output->width, output->height, output->pts);
216
217     return ff_filter_frame(outlink, output);
218
219 fail:
220     av_frame_free(&output);
221     return err;
222 }
223
224 static int overlay_opencl_config_output(AVFilterLink *outlink)
225 {
226     AVFilterContext *avctx = outlink->src;
227     OverlayOpenCLContext *ctx = avctx->priv;
228     int err;
229
230     err = ff_opencl_filter_config_output(outlink);
231     if (err < 0)
232         return err;
233
234     err = ff_framesync_init_dualinput(&ctx->fs, avctx);
235     if (err < 0)
236         return err;
237
238     return ff_framesync_configure(&ctx->fs);
239 }
240
241 static av_cold int overlay_opencl_init(AVFilterContext *avctx)
242 {
243     OverlayOpenCLContext *ctx = avctx->priv;
244
245     ctx->fs.on_event = &overlay_opencl_blend;
246
247     return ff_opencl_filter_init(avctx);
248 }
249
250 static int overlay_opencl_activate(AVFilterContext *avctx)
251 {
252     OverlayOpenCLContext *ctx = avctx->priv;
253
254     return ff_framesync_activate(&ctx->fs);
255 }
256
257 static av_cold void overlay_opencl_uninit(AVFilterContext *avctx)
258 {
259     OverlayOpenCLContext *ctx = avctx->priv;
260     cl_int cle;
261
262     if (ctx->kernel) {
263         cle = clReleaseKernel(ctx->kernel);
264         if (cle != CL_SUCCESS)
265             av_log(avctx, AV_LOG_ERROR, "Failed to release "
266                    "kernel: %d.\n", cle);
267     }
268
269     if (ctx->command_queue) {
270         cle = clReleaseCommandQueue(ctx->command_queue);
271         if (cle != CL_SUCCESS)
272             av_log(avctx, AV_LOG_ERROR, "Failed to release "
273                    "command queue: %d.\n", cle);
274     }
275
276     ff_opencl_filter_uninit(avctx);
277
278     ff_framesync_uninit(&ctx->fs);
279 }
280
281 #define OFFSET(x) offsetof(OverlayOpenCLContext, x)
282 #define FLAGS (AV_OPT_FLAG_FILTERING_PARAM | AV_OPT_FLAG_VIDEO_PARAM)
283 static const AVOption overlay_opencl_options[] = {
284     { "x", "Overlay x position",
285       OFFSET(x_position), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, .flags = FLAGS },
286     { "y", "Overlay y position",
287       OFFSET(y_position), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, .flags = FLAGS },
288     { NULL },
289 };
290
291 AVFILTER_DEFINE_CLASS(overlay_opencl);
292
293 static const AVFilterPad overlay_opencl_inputs[] = {
294     {
295         .name         = "main",
296         .type         = AVMEDIA_TYPE_VIDEO,
297         .config_props = &ff_opencl_filter_config_input,
298     },
299     {
300         .name         = "overlay",
301         .type         = AVMEDIA_TYPE_VIDEO,
302         .config_props = &ff_opencl_filter_config_input,
303     },
304     { NULL }
305 };
306
307 static const AVFilterPad overlay_opencl_outputs[] = {
308     {
309         .name          = "default",
310         .type          = AVMEDIA_TYPE_VIDEO,
311         .config_props  = &overlay_opencl_config_output,
312     },
313     { NULL }
314 };
315
316 AVFilter ff_vf_overlay_opencl = {
317     .name            = "overlay_opencl",
318     .description     = NULL_IF_CONFIG_SMALL("Overlay one video on top of another"),
319     .priv_size       = sizeof(OverlayOpenCLContext),
320     .priv_class      = &overlay_opencl_class,
321     .init            = &overlay_opencl_init,
322     .uninit          = &overlay_opencl_uninit,
323     .query_formats   = &ff_opencl_filter_query_formats,
324     .activate        = &overlay_opencl_activate,
325     .inputs          = overlay_opencl_inputs,
326     .outputs         = overlay_opencl_outputs,
327     .flags_internal  = FF_FILTER_FLAG_HWFRAME_AWARE,
328 };