libavfilter/vf_convolution_opencl.c
9f178751
 /*
  * Copyright (c) 2018 Danil Iashchenko
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 #include "libavutil/common.h"
 #include "libavutil/imgutils.h"
 #include "libavutil/mem.h"
 #include "libavutil/opt.h"
 #include "libavutil/pixdesc.h"
 #include "libavutil/avstring.h"
 
 
 #include "avfilter.h"
 #include "internal.h"
 #include "opencl.h"
 #include "opencl_source.h"
 #include "video.h"
 
 typedef struct ConvolutionOpenCLContext {
     OpenCLFilterContext ocf;
 
     int              initialised;
     cl_kernel        kernel;
     cl_command_queue command_queue;
 
     char *matrix_str[4];
 
     cl_mem matrix[4];
     cl_int matrix_sizes[4];
     cl_int dims[4];
     cl_float rdivs[4];
     cl_float biases[4];
 
581bafa8
     cl_int planes;
     cl_float scale;
     cl_float delta;
9f178751
 
581bafa8
 } ConvolutionOpenCLContext;
9f178751
 
 static int convolution_opencl_init(AVFilterContext *avctx)
 {
     ConvolutionOpenCLContext *ctx = avctx->priv;
581bafa8
     const char *kernel_name;
9f178751
     cl_int cle;
     int err;
 
     err = ff_opencl_filter_load_program(avctx, &ff_opencl_source_convolution, 1);
     if (err < 0)
         goto fail;
 
     ctx->command_queue = clCreateCommandQueue(ctx->ocf.hwctx->context,
                                               ctx->ocf.hwctx->device_id,
                                               0, &cle);
7cd58a8a
     CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to create OpenCL "
                      "command queue %d.\n", cle);
9f178751
 
581bafa8
     if (!strcmp(avctx->filter->name, "convolution_opencl")) {
         kernel_name = "convolution_global";
     } else if (!strcmp(avctx->filter->name, "sobel_opencl")) {
         kernel_name = "sobel_global";
     } else if (!strcmp(avctx->filter->name, "prewitt_opencl")){
         kernel_name = "prewitt_global";
     } else if (!strcmp(avctx->filter->name, "roberts_opencl")){
         kernel_name = "roberts_global";
     }
     ctx->kernel = clCreateKernel(ctx->ocf.program, kernel_name, &cle);
7cd58a8a
     CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to create "
                      "kernel %d.\n", cle);
9f178751
 
     ctx->initialised = 1;
     return 0;
 
 fail:
     if (ctx->command_queue)
         clReleaseCommandQueue(ctx->command_queue);
     if (ctx->kernel)
         clReleaseKernel(ctx->kernel);
     return err;
 }
 
 
 
 static int convolution_opencl_make_filter_params(AVFilterContext *avctx)
 {
     ConvolutionOpenCLContext *ctx = avctx->priv;
     float *matrix = NULL;
     size_t matrix_bytes;
     cl_mem buffer;
     cl_int cle;
     int i, j;
     int sscanf_err;
     char *p, *arg, *saveptr = NULL;
     float input_matrix[4][49];
 
     for (i = 0; i < 4; i++) {
         ctx->biases[i] = ctx->biases[i] / 255.0;
     }
 
     for (i = 0; i < 4; i++) {
         p = ctx->matrix_str[i];
         while (ctx->matrix_sizes[i] < 49) {
             arg = av_strtok(p, " ", &saveptr);
             if (!arg) {
                 break;
             }
             p = NULL;
             sscanf_err = sscanf(arg, "%f", &input_matrix[i][ctx->matrix_sizes[i]]);
             if (sscanf_err != 1) {
                 av_log(ctx, AV_LOG_ERROR, "Matrix is sequence of 9, 25 or 49 signed numbers\n");
                 return AVERROR(EINVAL);
             }
             ctx->matrix_sizes[i]++;
         }
         if (ctx->matrix_sizes[i] == 9) {
             ctx->dims[i] = 3;
         } else if (ctx->matrix_sizes[i] == 25) {
             ctx->dims[i] = 5;
         } else if (ctx->matrix_sizes[i] == 49) {
             ctx->dims[i] = 7;
         } else {
             av_log(ctx, AV_LOG_ERROR, "Invalid matrix size:%d\n", ctx->matrix_sizes[i]);
             return AVERROR(EINVAL);
         }
 
     }
 
     for (j = 0; j < 4; j++) {
         matrix_bytes = sizeof(float)*ctx->matrix_sizes[j];
         matrix = av_malloc(matrix_bytes);
         if (!matrix) {
             av_freep(&matrix);
             return AVERROR(ENOMEM);
         }
 
         for (i = 0; i < ctx->matrix_sizes[j]; i++)
             matrix[i] = input_matrix[j][i];
 
         buffer = clCreateBuffer(ctx->ocf.hwctx->context,
                                 CL_MEM_READ_ONLY |
                                 CL_MEM_COPY_HOST_PTR |
                                 CL_MEM_HOST_NO_ACCESS,
                                 matrix_bytes, matrix, &cle);
         if (!buffer) {
             av_log(avctx, AV_LOG_ERROR, "Failed to create matrix buffer: "
                    "%d.\n", cle);
             av_freep(&matrix);
             return AVERROR(EIO);
         }
         ctx->matrix[j] = buffer;
         av_freep(&matrix);
     }
 
     return 0;
 }
 
 static int convolution_opencl_filter_frame(AVFilterLink *inlink, AVFrame *input)
 {
     AVFilterContext *avctx = inlink->dst;
     AVFilterLink *outlink = avctx->outputs[0];
     ConvolutionOpenCLContext *ctx = avctx->priv;
     AVFrame *output = NULL;
     cl_int cle;
     size_t global_work[2];
     cl_mem src, dst;
     int err, p;
581bafa8
     size_t origin[3] = {0, 0, 0};
     size_t region[3] = {0, 0, 1};
9f178751
 
     av_log(ctx, AV_LOG_DEBUG, "Filter input: %s, %ux%u (%"PRId64").\n",
            av_get_pix_fmt_name(input->format),
            input->width, input->height, input->pts);
 
     if (!input->hw_frames_ctx)
         return AVERROR(EINVAL);
 
     if (!ctx->initialised) {
         err = convolution_opencl_init(avctx);
         if (err < 0)
             goto fail;
 
581bafa8
         if (!strcmp(avctx->filter->name, "convolution_opencl")) {
             err = convolution_opencl_make_filter_params(avctx);
             if (err < 0)
                 goto fail;
         } else {
             ctx->delta /= 255.0;
         }
 
9f178751
     }
 
     output = ff_get_video_buffer(outlink, outlink->w, outlink->h);
     if (!output) {
         err = AVERROR(ENOMEM);
         goto fail;
     }
 
     for (p = 0; p < FF_ARRAY_ELEMS(output->data); p++) {
         src = (cl_mem) input->data[p];
         dst = (cl_mem)output->data[p];
 
         if (!dst)
             break;
 
581bafa8
         if (!strcmp(avctx->filter->name, "convolution_opencl")) {
             CL_SET_KERNEL_ARG(ctx->kernel, 0, cl_mem,   &dst);
             CL_SET_KERNEL_ARG(ctx->kernel, 1, cl_mem,   &src);
             CL_SET_KERNEL_ARG(ctx->kernel, 2, cl_int,   &ctx->dims[p]);
             CL_SET_KERNEL_ARG(ctx->kernel, 3, cl_mem,   &ctx->matrix[p]);
             CL_SET_KERNEL_ARG(ctx->kernel, 4, cl_float, &ctx->rdivs[p]);
             CL_SET_KERNEL_ARG(ctx->kernel, 5, cl_float, &ctx->biases[p]);
 
             err = ff_opencl_filter_work_size_from_image(avctx, global_work, output, p, 0);
             if (err < 0)
                 goto fail;
 
             av_log(avctx, AV_LOG_DEBUG, "Run kernel on plane %d "
                    "(%"SIZE_SPECIFIER"x%"SIZE_SPECIFIER").\n",
                    p, global_work[0], global_work[1]);
 
             cle = clEnqueueNDRangeKernel(ctx->command_queue, ctx->kernel, 2, NULL,
                                          global_work, NULL,
                                          0, NULL, NULL);
7cd58a8a
             CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to enqueue "
                              "kernel: %d.\n", cle);
581bafa8
         } else {
             if (!(ctx->planes & (1 << p))) {
                 err = ff_opencl_filter_work_size_from_image(avctx, region, output, p, 0);
                 if (err < 0)
                     goto fail;
 
                 cle = clEnqueueCopyImage(ctx->command_queue, src, dst,
                                          origin, origin, region, 0, NULL, NULL);
7cd58a8a
                 CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to copy plane %d: %d.\n",
                                  p, cle);
581bafa8
             } else {
                 CL_SET_KERNEL_ARG(ctx->kernel, 0, cl_mem,   &dst);
                 CL_SET_KERNEL_ARG(ctx->kernel, 1, cl_mem,   &src);
                 CL_SET_KERNEL_ARG(ctx->kernel, 2, cl_float, &ctx->scale);
                 CL_SET_KERNEL_ARG(ctx->kernel, 3, cl_float, &ctx->delta);
 
                 err = ff_opencl_filter_work_size_from_image(avctx, global_work, output, p, 0);
                 if (err < 0)
                     goto fail;
 
                 av_log(avctx, AV_LOG_DEBUG, "Run kernel on plane %d "
                        "(%"SIZE_SPECIFIER"x%"SIZE_SPECIFIER").\n",
                        p, global_work[0], global_work[1]);
 
                 cle = clEnqueueNDRangeKernel(ctx->command_queue, ctx->kernel, 2, NULL,
                                                          global_work, NULL,
                                                          0, NULL, NULL);
7cd58a8a
                 CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to enqueue "
                                  "kernel: %d.\n", cle);
581bafa8
             }
9f178751
         }
     }
 
     cle = clFinish(ctx->command_queue);
7cd58a8a
     CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to finish command queue: %d.\n", cle);
9f178751
 
     err = av_frame_copy_props(output, input);
     if (err < 0)
         goto fail;
 
     av_frame_free(&input);
 
     av_log(ctx, AV_LOG_DEBUG, "Filter output: %s, %ux%u (%"PRId64").\n",
            av_get_pix_fmt_name(output->format),
            output->width, output->height, output->pts);
 
     return ff_filter_frame(outlink, output);
 
 fail:
     clFinish(ctx->command_queue);
     av_frame_free(&input);
     av_frame_free(&output);
     return err;
 }
 
 static av_cold void convolution_opencl_uninit(AVFilterContext *avctx)
 {
     ConvolutionOpenCLContext *ctx = avctx->priv;
     cl_int cle;
     int i;
 
     for (i = 0; i < 4; i++) {
         clReleaseMemObject(ctx->matrix[i]);
     }
 
     if (ctx->kernel) {
         cle = clReleaseKernel(ctx->kernel);
         if (cle != CL_SUCCESS)
             av_log(avctx, AV_LOG_ERROR, "Failed to release "
                    "kernel: %d.\n", cle);
     }
 
     if (ctx->command_queue) {
         cle = clReleaseCommandQueue(ctx->command_queue);
         if (cle != CL_SUCCESS)
             av_log(avctx, AV_LOG_ERROR, "Failed to release "
                    "command queue: %d.\n", cle);
     }
 
     ff_opencl_filter_uninit(avctx);
 }
 
581bafa8
 static const AVFilterPad convolution_opencl_inputs[] = {
     {
         .name         = "default",
         .type         = AVMEDIA_TYPE_VIDEO,
         .filter_frame = &convolution_opencl_filter_frame,
         .config_props = &ff_opencl_filter_config_input,
     },
     { NULL }
 };
 
 static const AVFilterPad convolution_opencl_outputs[] = {
     {
         .name         = "default",
         .type         = AVMEDIA_TYPE_VIDEO,
         .config_props = &ff_opencl_filter_config_output,
     },
     { NULL }
 };
 
9f178751
 #define OFFSET(x) offsetof(ConvolutionOpenCLContext, x)
 #define FLAGS (AV_OPT_FLAG_FILTERING_PARAM | AV_OPT_FLAG_VIDEO_PARAM)
581bafa8
 
 #if CONFIG_CONVOLUTION_OPENCL_FILTER
 
9f178751
 static const AVOption convolution_opencl_options[] = {
     { "0m", "set matrix for 2nd plane", OFFSET(matrix_str[0]), AV_OPT_TYPE_STRING, {.str="0 0 0 0 1 0 0 0 0"}, 0, 0, FLAGS },
     { "1m", "set matrix for 2nd plane", OFFSET(matrix_str[1]), AV_OPT_TYPE_STRING, {.str="0 0 0 0 1 0 0 0 0"}, 0, 0, FLAGS },
     { "2m", "set matrix for 3rd plane", OFFSET(matrix_str[2]), AV_OPT_TYPE_STRING, {.str="0 0 0 0 1 0 0 0 0"}, 0, 0, FLAGS },
     { "3m", "set matrix for 4th plane", OFFSET(matrix_str[3]), AV_OPT_TYPE_STRING, {.str="0 0 0 0 1 0 0 0 0"}, 0, 0, FLAGS },
     { "0rdiv", "set rdiv for 1nd plane", OFFSET(rdivs[0]), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, 0.0, INT_MAX, FLAGS},
     { "1rdiv", "set rdiv for 2nd plane", OFFSET(rdivs[1]), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, 0.0, INT_MAX, FLAGS},
     { "2rdiv", "set rdiv for 3rd plane", OFFSET(rdivs[2]), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, 0.0, INT_MAX, FLAGS},
     { "3rdiv", "set rdiv for 4th plane", OFFSET(rdivs[3]), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, 0.0, INT_MAX, FLAGS},
     { "0bias", "set bias for 1st plane", OFFSET(biases[0]), AV_OPT_TYPE_FLOAT, {.dbl=0.0}, 0.0, INT_MAX, FLAGS},
     { "1bias", "set bias for 2nd plane", OFFSET(biases[1]), AV_OPT_TYPE_FLOAT, {.dbl=0.0}, 0.0, INT_MAX, FLAGS},
     { "2bias", "set bias for 3rd plane", OFFSET(biases[2]), AV_OPT_TYPE_FLOAT, {.dbl=0.0}, 0.0, INT_MAX, FLAGS},
     { "3bias", "set bias for 4th plane", OFFSET(biases[3]), AV_OPT_TYPE_FLOAT, {.dbl=0.0}, 0.0, INT_MAX, FLAGS},
     { NULL }
 };
 
 AVFILTER_DEFINE_CLASS(convolution_opencl);
 
581bafa8
 AVFilter ff_vf_convolution_opencl = {
     .name           = "convolution_opencl",
     .description    = NULL_IF_CONFIG_SMALL("Apply convolution mask to input video"),
     .priv_size      = sizeof(ConvolutionOpenCLContext),
     .priv_class     = &convolution_opencl_class,
     .init           = &ff_opencl_filter_init,
     .uninit         = &convolution_opencl_uninit,
     .query_formats  = &ff_opencl_filter_query_formats,
     .inputs         = convolution_opencl_inputs,
     .outputs        = convolution_opencl_outputs,
     .flags_internal = FF_FILTER_FLAG_HWFRAME_AWARE,
 };
 
 #endif /* CONFIG_CONVOLUTION_OPENCL_FILTER */
 
 #if CONFIG_SOBEL_OPENCL_FILTER
 
 static const AVOption sobel_opencl_options[] = {
     { "planes", "set planes to filter", OFFSET(planes), AV_OPT_TYPE_INT,  {.i64=15}, 0, 15, FLAGS},
     { "scale",  "set scale",            OFFSET(scale), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, 0.0,  65535, FLAGS},
     { "delta",  "set delta",            OFFSET(delta), AV_OPT_TYPE_FLOAT, {.dbl=0}, -65535, 65535, FLAGS},
9f178751
     { NULL }
 };
 
581bafa8
 AVFILTER_DEFINE_CLASS(sobel_opencl);
 
 AVFilter ff_vf_sobel_opencl = {
     .name           = "sobel_opencl",
     .description    = NULL_IF_CONFIG_SMALL("Apply sobel operator"),
     .priv_size      = sizeof(ConvolutionOpenCLContext),
     .priv_class     = &sobel_opencl_class,
     .init           = &ff_opencl_filter_init,
     .uninit         = &convolution_opencl_uninit,
     .query_formats  = &ff_opencl_filter_query_formats,
     .inputs         = convolution_opencl_inputs,
     .outputs        = convolution_opencl_outputs,
     .flags_internal = FF_FILTER_FLAG_HWFRAME_AWARE,
 };
 
 #endif /* CONFIG_SOBEL_OPENCL_FILTER */
 
 #if CONFIG_PREWITT_OPENCL_FILTER
 
 static const AVOption prewitt_opencl_options[] = {
     { "planes", "set planes to filter", OFFSET(planes), AV_OPT_TYPE_INT,  {.i64=15}, 0, 15, FLAGS},
     { "scale",  "set scale",            OFFSET(scale), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, 0.0,  65535, FLAGS},
     { "delta",  "set delta",            OFFSET(delta), AV_OPT_TYPE_FLOAT, {.dbl=0}, -65535, 65535, FLAGS},
9f178751
     { NULL }
 };
 
581bafa8
 AVFILTER_DEFINE_CLASS(prewitt_opencl);
 
 AVFilter ff_vf_prewitt_opencl = {
     .name           = "prewitt_opencl",
     .description    = NULL_IF_CONFIG_SMALL("Apply prewitt operator"),
9f178751
     .priv_size      = sizeof(ConvolutionOpenCLContext),
581bafa8
     .priv_class     = &prewitt_opencl_class,
     .init           = &ff_opencl_filter_init,
     .uninit         = &convolution_opencl_uninit,
     .query_formats  = &ff_opencl_filter_query_formats,
     .inputs         = convolution_opencl_inputs,
     .outputs        = convolution_opencl_outputs,
     .flags_internal = FF_FILTER_FLAG_HWFRAME_AWARE,
 };
 
 #endif /* CONFIG_PREWITT_OPENCL_FILTER */
 
 #if CONFIG_ROBERTS_OPENCL_FILTER
 
 static const AVOption roberts_opencl_options[] = {
     { "planes", "set planes to filter", OFFSET(planes), AV_OPT_TYPE_INT,  {.i64=15}, 0, 15, FLAGS},
     { "scale",  "set scale",            OFFSET(scale), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, 0.0,  65535, FLAGS},
     { "delta",  "set delta",            OFFSET(delta), AV_OPT_TYPE_FLOAT, {.dbl=0}, -65535, 65535, FLAGS},
     { NULL }
 };
 
 AVFILTER_DEFINE_CLASS(roberts_opencl);
 
 AVFilter ff_vf_roberts_opencl = {
     .name           = "roberts_opencl",
     .description    = NULL_IF_CONFIG_SMALL("Apply roberts operator"),
     .priv_size      = sizeof(ConvolutionOpenCLContext),
     .priv_class     = &roberts_opencl_class,
9f178751
     .init           = &ff_opencl_filter_init,
     .uninit         = &convolution_opencl_uninit,
     .query_formats  = &ff_opencl_filter_query_formats,
     .inputs         = convolution_opencl_inputs,
     .outputs        = convolution_opencl_outputs,
     .flags_internal = FF_FILTER_FLAG_HWFRAME_AWARE,
 };
581bafa8
 
 #endif /* CONFIG_ROBERTS_OPENCL_FILTER */