FFmpeg
vf_neighbor_opencl.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 Danil Iashchenko
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 #include "libavutil/common.h"
22 #include "libavutil/imgutils.h"
23 #include "libavutil/mem.h"
24 #include "libavutil/opt.h"
25 #include "libavutil/pixdesc.h"
26 #include "libavutil/avstring.h"
27 
28 
29 #include "avfilter.h"
30 #include "internal.h"
31 #include "opencl.h"
32 #include "opencl_source.h"
33 #include "video.h"
34 
35 typedef struct NeighborOpenCLContext {
37 
39  cl_kernel kernel;
40  cl_command_queue command_queue;
41 
42  char *matrix_str[4];
43 
44  cl_float threshold[4];
45  cl_int coordinates;
46  cl_mem coord;
47 
49 
51 {
52  NeighborOpenCLContext *ctx = avctx->priv;
53  const char *kernel_name;
54  cl_int cle;
55  int err;
56 
58  if (err < 0)
59  goto fail;
60 
61  ctx->command_queue = clCreateCommandQueue(ctx->ocf.hwctx->context,
62  ctx->ocf.hwctx->device_id,
63  0, &cle);
64  CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to create OpenCL "
65  "command queue %d.\n", cle);
66 
67  if (!strcmp(avctx->filter->name, "erosion_opencl")){
68  kernel_name = "erosion_global";
69  } else if (!strcmp(avctx->filter->name, "dilation_opencl")){
70  kernel_name = "dilation_global";
71  }
72  ctx->kernel = clCreateKernel(ctx->ocf.program, kernel_name, &cle);
73  CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to create "
74  "kernel %d.\n", cle);
75 
76  ctx->initialised = 1;
77  return 0;
78 
79 fail:
80  if (ctx->command_queue)
81  clReleaseCommandQueue(ctx->command_queue);
82  if (ctx->kernel)
83  clReleaseKernel(ctx->kernel);
84  return err;
85 }
86 
88 {
89  NeighborOpenCLContext *ctx = avctx->priv;
90  cl_int matrix[9];
91  cl_mem buffer;
92  cl_int cle;
93  int i;
94 
95  for (i = 0; i < 4; i++) {
96  ctx->threshold[i] /= 255.0;
97  }
98 
99  matrix[4] = 0;
100  for (i = 0; i < 8; i++) {
101  if (ctx->coordinates & (1 << i)) {
102  matrix[i > 3 ? i + 1: i] = 1;
103  }
104  }
105  buffer = clCreateBuffer(ctx->ocf.hwctx->context,
106  CL_MEM_READ_ONLY |
107  CL_MEM_COPY_HOST_PTR |
108  CL_MEM_HOST_NO_ACCESS,
109  9 * sizeof(cl_int), matrix, &cle);
110  if (!buffer) {
111  av_log(avctx, AV_LOG_ERROR, "Failed to create matrix buffer: "
112  "%d.\n", cle);
113  return AVERROR(EIO);
114  }
115  ctx->coord = buffer;
116 
117  return 0;
118 }
119 
120 
122 {
123  AVFilterContext *avctx = inlink->dst;
124  AVFilterLink *outlink = avctx->outputs[0];
125  NeighborOpenCLContext *ctx = avctx->priv;
126  AVFrame *output = NULL;
127  cl_int cle;
128  size_t global_work[2];
129  cl_mem src, dst;
130  int err, p;
131  size_t origin[3] = {0, 0, 0};
132  size_t region[3] = {0, 0, 1};
133 
134  av_log(ctx, AV_LOG_DEBUG, "Filter input: %s, %ux%u (%"PRId64").\n",
135  av_get_pix_fmt_name(input->format),
136  input->width, input->height, input->pts);
137 
138  if (!input->hw_frames_ctx)
139  return AVERROR(EINVAL);
140 
141  if (!ctx->initialised) {
142  err = neighbor_opencl_init(avctx);
143  if (err < 0)
144  goto fail;
145 
147  if (err < 0)
148  goto fail;
149 
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 (p = 0; p < FF_ARRAY_ELEMS(output->data); p++) {
159  src = (cl_mem) input->data[p];
160  dst = (cl_mem)output->data[p];
161 
162  if (!dst)
163  break;
164 
165  if (ctx->threshold[p] == 0) {
166  err = ff_opencl_filter_work_size_from_image(avctx, region, output, p, 0);
167  if (err < 0)
168  goto fail;
169 
170  cle = clEnqueueCopyImage(ctx->command_queue, src, dst,
171  origin, origin, region, 0, NULL, NULL);
172  CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to copy plane %d: %d.\n",
173  p, cle);
174  } else {
175  CL_SET_KERNEL_ARG(ctx->kernel, 0, cl_mem, &dst);
176  CL_SET_KERNEL_ARG(ctx->kernel, 1, cl_mem, &src);
177  CL_SET_KERNEL_ARG(ctx->kernel, 2, cl_float, &ctx->threshold[p]);
178  CL_SET_KERNEL_ARG(ctx->kernel, 3, cl_mem, &ctx->coord);
179 
180  err = ff_opencl_filter_work_size_from_image(avctx, global_work, output, p, 0);
181  if (err < 0)
182  goto fail;
183 
184  av_log(avctx, AV_LOG_DEBUG, "Run kernel on plane %d "
185  "(%"SIZE_SPECIFIER"x%"SIZE_SPECIFIER").\n",
186  p, global_work[0], global_work[1]);
187 
188  cle = clEnqueueNDRangeKernel(ctx->command_queue, ctx->kernel, 2, NULL,
189  global_work, NULL,
190  0, NULL, NULL);
191  CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to enqueue "
192  "kernel: %d.\n", cle);
193  }
194  }
195 
196  cle = clFinish(ctx->command_queue);
197  CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to finish command queue: %d.\n", cle);
198 
199  err = av_frame_copy_props(output, input);
200  if (err < 0)
201  goto fail;
202 
203  av_frame_free(&input);
204 
205  av_log(ctx, AV_LOG_DEBUG, "Filter output: %s, %ux%u (%"PRId64").\n",
206  av_get_pix_fmt_name(output->format),
207  output->width, output->height, output->pts);
208 
209  return ff_filter_frame(outlink, output);
210 
211 fail:
212  clFinish(ctx->command_queue);
213  av_frame_free(&input);
214  av_frame_free(&output);
215  return err;
216 }
217 
219 {
220  NeighborOpenCLContext *ctx = avctx->priv;
221  cl_int cle;
222 
223  clReleaseMemObject(ctx->coord);
224 
225  if (ctx->kernel) {
226  cle = clReleaseKernel(ctx->kernel);
227  if (cle != CL_SUCCESS)
228  av_log(avctx, AV_LOG_ERROR, "Failed to release "
229  "kernel: %d.\n", cle);
230  }
231 
232  if (ctx->command_queue) {
233  cle = clReleaseCommandQueue(ctx->command_queue);
234  if (cle != CL_SUCCESS)
235  av_log(avctx, AV_LOG_ERROR, "Failed to release "
236  "command queue: %d.\n", cle);
237  }
238 
240 }
241 
243  {
244  .name = "default",
245  .type = AVMEDIA_TYPE_VIDEO,
246  .filter_frame = &neighbor_opencl_filter_frame,
247  .config_props = &ff_opencl_filter_config_input,
248  },
249  { NULL }
250 };
251 
253  {
254  .name = "default",
255  .type = AVMEDIA_TYPE_VIDEO,
256  .config_props = &ff_opencl_filter_config_output,
257  },
258  { NULL }
259 };
260 
261 #define OFFSET(x) offsetof(NeighborOpenCLContext, x)
262 #define FLAGS (AV_OPT_FLAG_FILTERING_PARAM | AV_OPT_FLAG_VIDEO_PARAM)
263 
264 #if CONFIG_EROSION_OPENCL_FILTER
265 
266 static const AVOption erosion_opencl_options[] = {
267  { "threshold0", "set threshold for 1st plane", OFFSET(threshold[0]), AV_OPT_TYPE_FLOAT, {.dbl=65535.0}, 0.0, 65535, FLAGS },
268  { "threshold1", "set threshold for 2nd plane", OFFSET(threshold[1]), AV_OPT_TYPE_FLOAT, {.dbl=65535.0}, 0.0, 65535, FLAGS },
269  { "threshold2", "set threshold for 3rd plane", OFFSET(threshold[2]), AV_OPT_TYPE_FLOAT, {.dbl=65535.0}, 0.0, 65535, FLAGS },
270  { "threshold3", "set threshold for 4th plane", OFFSET(threshold[3]), AV_OPT_TYPE_FLOAT, {.dbl=65535.0}, 0.0, 65535, FLAGS },
271  { "coordinates", "set coordinates", OFFSET(coordinates), AV_OPT_TYPE_INT, {.i64=255}, 0, 255, FLAGS },
272  { NULL }
273 };
274 
275 AVFILTER_DEFINE_CLASS(erosion_opencl);
276 
278  .name = "erosion_opencl",
279  .description = NULL_IF_CONFIG_SMALL("Apply erosion effect"),
280  .priv_size = sizeof(NeighborOpenCLContext),
281  .priv_class = &erosion_opencl_class,
285  .inputs = neighbor_opencl_inputs,
286  .outputs = neighbor_opencl_outputs,
287  .flags_internal = FF_FILTER_FLAG_HWFRAME_AWARE,
288 };
289 
290 #endif /* CONFIG_EROSION_OPENCL_FILTER */
291 
292 #if CONFIG_DILATION_OPENCL_FILTER
293 
294 static const AVOption dilation_opencl_options[] = {
295  { "threshold0", "set threshold for 1st plane", OFFSET(threshold[0]), AV_OPT_TYPE_FLOAT, {.dbl=65535.0}, 0.0, 65535, FLAGS },
296  { "threshold1", "set threshold for 2nd plane", OFFSET(threshold[1]), AV_OPT_TYPE_FLOAT, {.dbl=65535.0}, 0.0, 65535, FLAGS },
297  { "threshold2", "set threshold for 3rd plane", OFFSET(threshold[2]), AV_OPT_TYPE_FLOAT, {.dbl=65535.0}, 0.0, 65535, FLAGS },
298  { "threshold3", "set threshold for 4th plane", OFFSET(threshold[3]), AV_OPT_TYPE_FLOAT, {.dbl=65535.0}, 0.0, 65535, FLAGS },
299  { "coordinates", "set coordinates", OFFSET(coordinates), AV_OPT_TYPE_INT, {.i64=255}, 0, 255, FLAGS },
300  { NULL }
301 };
302 
303 AVFILTER_DEFINE_CLASS(dilation_opencl);
304 
306  .name = "dilation_opencl",
307  .description = NULL_IF_CONFIG_SMALL("Apply dilation effect"),
308  .priv_size = sizeof(NeighborOpenCLContext),
309  .priv_class = &dilation_opencl_class,
313  .inputs = neighbor_opencl_inputs,
314  .outputs = neighbor_opencl_outputs,
315  .flags_internal = FF_FILTER_FLAG_HWFRAME_AWARE,
316 };
317 
318 #endif /* CONFIG_DILATION_OPENCL_FILTER */
#define NULL
Definition: coverity.c:32
#define FF_FILTER_FLAG_HWFRAME_AWARE
The filter is aware of hardware frames, and any hardware frame context should not be automatically pr...
Definition: internal.h:385
This structure describes decoded (raw) audio or video data.
Definition: frame.h:295
AVOption.
Definition: opt.h:246
int ff_opencl_filter_work_size_from_image(AVFilterContext *avctx, size_t *work_size, AVFrame *frame, int plane, int block_alignment)
Find the work size needed needed for a given plane of an image.
Definition: opencl.c:278
int ff_opencl_filter_config_input(AVFilterLink *inlink)
Check that the input link contains a suitable hardware frames context and extract the device from it...
Definition: opencl.c:60
AVFilter ff_vf_dilation_opencl
int ff_opencl_filter_query_formats(AVFilterContext *avctx)
Return that all inputs and outputs support only AV_PIX_FMT_OPENCL.
Definition: opencl.c:28
misc image utilities
Main libavfilter public API header.
Memory handling functions.
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
AVFrame * ff_get_video_buffer(AVFilterLink *link, int w, int h)
Request a picture buffer with a specific set of permissions.
Definition: video.c:99
#define src
Definition: vp8dsp.c:254
int ff_opencl_filter_init(AVFilterContext *avctx)
Initialise an OpenCL filter context.
Definition: opencl.c:147
static const AVFilterPad neighbor_opencl_outputs[]
AVOpenCLDeviceContext * hwctx
Definition: opencl.h:41
AVBufferRef * hw_frames_ctx
For hwaccel-format frames, this should be a reference to the AVHWFramesContext describing the frame...
Definition: frame.h:634
const char * name
Pad name.
Definition: internal.h:60
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1093
#define av_cold
Definition: attributes.h:82
static av_cold int uninit(AVCodecContext *avctx)
Definition: crystalhd.c:279
AVOptions.
#define OFFSET(x)
cl_device_id device_id
The primary device ID of the device.
filter_frame For filters that do not use the this method is called when a frame is pushed to the filter s input It can be called at any time except in a reentrant way If the input frame is enough to produce output
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:388
int ff_opencl_filter_config_output(AVFilterLink *outlink)
Create a suitable hardware frames context for the output.
Definition: opencl.c:96
#define av_log(a,...)
A filter pad used for either input or output.
Definition: internal.h:54
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:259
int width
Definition: frame.h:353
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:202
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
static av_cold void neighbor_opencl_uninit(AVFilterContext *avctx)
void * priv
private data for use by the filter
Definition: avfilter.h:353
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:197
#define fail()
Definition: checkasm.h:122
static int neighbor_opencl_make_filter_params(AVFilterContext *avctx)
AVFormatContext * ctx
Definition: movenc.c:48
AVFilter ff_vf_erosion_opencl
static const AVFilterPad outputs[]
Definition: af_acontrast.c:203
#define FF_ARRAY_ELEMS(a)
int format
format of the frame, -1 if unknown or unset Values correspond to enum AVPixelFormat for video frames...
Definition: frame.h:368
#define CL_SET_KERNEL_ARG(kernel, arg_num, type, arg)
set argument to specific Kernel.
Definition: opencl.h:61
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several inputs
Filter definition.
Definition: avfilter.h:144
const char * name
Filter name.
Definition: avfilter.h:148
and forward the test the status of outputs and forward it to the corresponding return FFERROR_NOT_READY If the filters stores internally one or a few frame for some input
static const AVFilterPad neighbor_opencl_inputs[]
AVFilterLink ** outputs
array of pointers to output links
Definition: avfilter.h:350
#define CL_FAIL_ON_ERROR(errcode,...)
A helper macro to handle OpenCL errors.
Definition: opencl.h:74
static int neighbor_opencl_filter_frame(AVFilterLink *inlink, AVFrame *input)
#define SIZE_SPECIFIER
Definition: internal.h:262
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:309
cl_command_queue command_queue
The exact code depends on how similar the blocks are and how related they are to the and needs to apply these operations to the correct inlink or outlink if there are several Macros are available to factor that when no extra processing is inlink
static int query_formats(AVFilterContext *ctx)
Definition: aeval.c:244
common internal and external API header
void ff_opencl_filter_uninit(AVFilterContext *avctx)
Uninitialise an OpenCL filter context.
Definition: opencl.c:156
OpenCLFilterContext ocf
#define FLAGS
const char * ff_opencl_source_neighbor
#define AVFILTER_DEFINE_CLASS(fname)
Definition: internal.h:334
static int neighbor_opencl_init(AVFilterContext *avctx)
cl_context context
The OpenCL context which will contain all operations and frames on this device.
An instance of a filter.
Definition: avfilter.h:338
int height
Definition: frame.h:353
cl_program program
Definition: opencl.h:43
int ff_opencl_filter_load_program(AVFilterContext *avctx, const char **program_source_array, int nb_strings)
Load a new OpenCL program from strings in memory.
Definition: opencl.c:171
const char * av_get_pix_fmt_name(enum AVPixelFormat pix_fmt)
Return the short name for a pixel format, NULL in case pix_fmt is unknown.
Definition: pixdesc.c:2438
internal API functions
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
const AVFilter * filter
the AVFilter of which this is an instance
Definition: avfilter.h:341
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:654
GLuint buffer
Definition: opengl_enc.c:101