FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
vf_frei0r.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2010 Stefano Sabatini
3  * This file is part of FFmpeg.
4  *
5  * FFmpeg is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * FFmpeg is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with FFmpeg; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18  */
19 
20 /**
21  * @file
22  * frei0r wrapper
23  */
24 
25 #include <dlfcn.h>
26 #include <frei0r.h>
27 #include <stdio.h>
28 #include <string.h>
29 #include <stdlib.h>
30 #include "config.h"
31 #include "libavutil/avstring.h"
32 #include "libavutil/common.h"
33 #include "libavutil/imgutils.h"
34 #include "libavutil/internal.h"
35 #include "libavutil/mathematics.h"
36 #include "libavutil/mem.h"
37 #include "libavutil/opt.h"
38 #include "libavutil/parseutils.h"
39 #include "avfilter.h"
40 #include "formats.h"
41 #include "internal.h"
42 #include "video.h"
43 
44 typedef f0r_instance_t (*f0r_construct_f)(unsigned int width, unsigned int height);
45 typedef void (*f0r_destruct_f)(f0r_instance_t instance);
46 typedef void (*f0r_deinit_f)(void);
47 typedef int (*f0r_init_f)(void);
48 typedef void (*f0r_get_plugin_info_f)(f0r_plugin_info_t *info);
49 typedef void (*f0r_get_param_info_f)(f0r_param_info_t *info, int param_index);
50 typedef void (*f0r_update_f)(f0r_instance_t instance, double time, const uint32_t *inframe, uint32_t *outframe);
51 typedef void (*f0r_update2_f)(f0r_instance_t instance, double time, const uint32_t *inframe1, const uint32_t *inframe2, const uint32_t *inframe3, uint32_t *outframe);
52 typedef void (*f0r_set_param_value_f)(f0r_instance_t instance, f0r_param_t param, int param_index);
53 typedef void (*f0r_get_param_value_f)(f0r_instance_t instance, f0r_param_t param, int param_index);
54 
55 typedef struct Frei0rContext {
56  const AVClass *class;
58  void *dl_handle; /* dynamic library handle */
59  f0r_instance_t instance;
60  f0r_plugin_info_t plugin_info;
61 
68 
69  char *dl_name;
70  char *params;
72 
73  /* only used by the source */
74  int w, h;
76  uint64_t pts;
78 
79 static void *load_sym(AVFilterContext *ctx, const char *sym_name)
80 {
81  Frei0rContext *s = ctx->priv;
82  void *sym = dlsym(s->dl_handle, sym_name);
83  if (!sym)
84  av_log(ctx, AV_LOG_ERROR, "Could not find symbol '%s' in loaded module.\n", sym_name);
85  return sym;
86 }
87 
88 static int set_param(AVFilterContext *ctx, f0r_param_info_t info, int index, char *param)
89 {
90  Frei0rContext *s = ctx->priv;
91  union {
92  double d;
93  f0r_param_color_t col;
94  f0r_param_position_t pos;
95  } val;
96  char *tail;
97  uint8_t rgba[4];
98 
99  switch (info.type) {
100  case F0R_PARAM_BOOL:
101  if (!strcmp(param, "y")) val.d = 1.0;
102  else if (!strcmp(param, "n")) val.d = 0.0;
103  else goto fail;
104  break;
105 
106  case F0R_PARAM_DOUBLE:
107  val.d = strtod(param, &tail);
108  if (*tail || val.d == HUGE_VAL)
109  goto fail;
110  break;
111 
112  case F0R_PARAM_COLOR:
113  if (sscanf(param, "%f/%f/%f", &val.col.r, &val.col.g, &val.col.b) != 3) {
114  if (av_parse_color(rgba, param, -1, ctx) < 0)
115  goto fail;
116  val.col.r = rgba[0] / 255.0;
117  val.col.g = rgba[1] / 255.0;
118  val.col.b = rgba[2] / 255.0;
119  }
120  break;
121 
122  case F0R_PARAM_POSITION:
123  if (sscanf(param, "%lf/%lf", &val.pos.x, &val.pos.y) != 2)
124  goto fail;
125  break;
126  }
127 
128  s->set_param_value(s->instance, &val, index);
129  return 0;
130 
131 fail:
132  av_log(ctx, AV_LOG_ERROR, "Invalid value '%s' for parameter '%s'.\n",
133  param, info.name);
134  return AVERROR(EINVAL);
135 }
136 
137 static int set_params(AVFilterContext *ctx, const char *params)
138 {
139  Frei0rContext *s = ctx->priv;
140  int i;
141 
142  if (!params)
143  return 0;
144 
145  for (i = 0; i < s->plugin_info.num_params; i++) {
146  f0r_param_info_t info;
147  char *param;
148  int ret;
149 
150  s->get_param_info(&info, i);
151 
152  if (*params) {
153  if (!(param = av_get_token(&params, "|")))
154  return AVERROR(ENOMEM);
155  if (*params)
156  params++; /* skip ':' */
157  ret = set_param(ctx, info, i, param);
158  av_free(param);
159  if (ret < 0)
160  return ret;
161  }
162 
163  av_log(ctx, AV_LOG_VERBOSE,
164  "idx:%d name:'%s' type:%s explanation:'%s' ",
165  i, info.name,
166  info.type == F0R_PARAM_BOOL ? "bool" :
167  info.type == F0R_PARAM_DOUBLE ? "double" :
168  info.type == F0R_PARAM_COLOR ? "color" :
169  info.type == F0R_PARAM_POSITION ? "position" :
170  info.type == F0R_PARAM_STRING ? "string" : "unknown",
171  info.explanation);
172 
173 #ifdef DEBUG
174  av_log(ctx, AV_LOG_DEBUG, "value:");
175  switch (info.type) {
176  void *v;
177  double d;
178  char str[128];
179  f0r_param_color_t col;
180  f0r_param_position_t pos;
181 
182  case F0R_PARAM_BOOL:
183  v = &d;
184  s->get_param_value(s->instance, v, i);
185  av_log(ctx, AV_LOG_DEBUG, "%s", d >= 0.5 && d <= 1.0 ? "y" : "n");
186  break;
187  case F0R_PARAM_DOUBLE:
188  v = &d;
189  s->get_param_value(s->instance, v, i);
190  av_log(ctx, AV_LOG_DEBUG, "%f", d);
191  break;
192  case F0R_PARAM_COLOR:
193  v = &col;
194  s->get_param_value(s->instance, v, i);
195  av_log(ctx, AV_LOG_DEBUG, "%f/%f/%f", col.r, col.g, col.b);
196  break;
197  case F0R_PARAM_POSITION:
198  v = &pos;
199  s->get_param_value(s->instance, v, i);
200  av_log(ctx, AV_LOG_DEBUG, "%f/%f", pos.x, pos.y);
201  break;
202  default: /* F0R_PARAM_STRING */
203  v = str;
204  s->get_param_value(s->instance, v, i);
205  av_log(ctx, AV_LOG_DEBUG, "'%s'", str);
206  break;
207  }
208 #endif
209  av_log(ctx, AV_LOG_VERBOSE, ".\n");
210  }
211 
212  return 0;
213 }
214 
215 static int load_path(AVFilterContext *ctx, void **handle_ptr, const char *prefix, const char *name)
216 {
217  char *path = av_asprintf("%s%s%s", prefix, name, SLIBSUF);
218  if (!path)
219  return AVERROR(ENOMEM);
220  av_log(ctx, AV_LOG_DEBUG, "Looking for frei0r effect in '%s'.\n", path);
221  *handle_ptr = dlopen(path, RTLD_NOW|RTLD_LOCAL);
222  av_free(path);
223  return 0;
224 }
225 
227  const char *dl_name, int type)
228 {
229  Frei0rContext *s = ctx->priv;
230  f0r_init_f f0r_init;
231  f0r_get_plugin_info_f f0r_get_plugin_info;
232  f0r_plugin_info_t *pi;
233  char *path;
234  int ret = 0;
235  int i;
236  static const char* const frei0r_pathlist[] = {
237  "/usr/local/lib/frei0r-1/",
238  "/usr/lib/frei0r-1/",
239  "/usr/local/lib64/frei0r-1/",
240  "/usr/lib64/frei0r-1/"
241  };
242 
243  if (!dl_name) {
244  av_log(ctx, AV_LOG_ERROR, "No filter name provided.\n");
245  return AVERROR(EINVAL);
246  }
247 
248  /* see: http://frei0r.dyne.org/codedoc/html/group__pluglocations.html */
249  if ((path = av_strdup(getenv("FREI0R_PATH")))) {
250 #ifdef _WIN32
251  const char *separator = ";";
252 #else
253  const char *separator = ":";
254 #endif
255  char *p, *ptr = NULL;
256  for (p = path; p = av_strtok(p, separator, &ptr); p = NULL) {
257  /* add additional trailing slash in case it is missing */
258  char *p1 = av_asprintf("%s/", p);
259  if (!p1) {
260  ret = AVERROR(ENOMEM);
261  goto check_path_end;
262  }
263  ret = load_path(ctx, &s->dl_handle, p1, dl_name);
264  av_free(p1);
265  if (ret < 0)
266  goto check_path_end;
267  if (s->dl_handle)
268  break;
269  }
270 
271  check_path_end:
272  av_free(path);
273  if (ret < 0)
274  return ret;
275  }
276  if (!s->dl_handle && (path = getenv("HOME"))) {
277  char *prefix = av_asprintf("%s/.frei0r-1/lib/", path);
278  if (!prefix)
279  return AVERROR(ENOMEM);
280  ret = load_path(ctx, &s->dl_handle, prefix, dl_name);
281  av_free(prefix);
282  if (ret < 0)
283  return ret;
284  }
285  for (i = 0; !s->dl_handle && i < FF_ARRAY_ELEMS(frei0r_pathlist); i++) {
286  ret = load_path(ctx, &s->dl_handle, frei0r_pathlist[i], dl_name);
287  if (ret < 0)
288  return ret;
289  }
290  if (!s->dl_handle) {
291  av_log(ctx, AV_LOG_ERROR, "Could not find module '%s'.\n", dl_name);
292  return AVERROR(EINVAL);
293  }
294 
295  if (!(f0r_init = load_sym(ctx, "f0r_init" )) ||
296  !(f0r_get_plugin_info = load_sym(ctx, "f0r_get_plugin_info")) ||
297  !(s->get_param_info = load_sym(ctx, "f0r_get_param_info" )) ||
298  !(s->get_param_value = load_sym(ctx, "f0r_get_param_value")) ||
299  !(s->set_param_value = load_sym(ctx, "f0r_set_param_value")) ||
300  !(s->update = load_sym(ctx, "f0r_update" )) ||
301  !(s->construct = load_sym(ctx, "f0r_construct" )) ||
302  !(s->destruct = load_sym(ctx, "f0r_destruct" )) ||
303  !(s->deinit = load_sym(ctx, "f0r_deinit" )))
304  return AVERROR(EINVAL);
305 
306  if (f0r_init() < 0) {
307  av_log(ctx, AV_LOG_ERROR, "Could not init the frei0r module.\n");
308  return AVERROR(EINVAL);
309  }
310 
311  f0r_get_plugin_info(&s->plugin_info);
312  pi = &s->plugin_info;
313  if (pi->plugin_type != type) {
314  av_log(ctx, AV_LOG_ERROR,
315  "Invalid type '%s' for this plugin\n",
316  pi->plugin_type == F0R_PLUGIN_TYPE_FILTER ? "filter" :
317  pi->plugin_type == F0R_PLUGIN_TYPE_SOURCE ? "source" :
318  pi->plugin_type == F0R_PLUGIN_TYPE_MIXER2 ? "mixer2" :
319  pi->plugin_type == F0R_PLUGIN_TYPE_MIXER3 ? "mixer3" : "unknown");
320  return AVERROR(EINVAL);
321  }
322 
323  av_log(ctx, AV_LOG_VERBOSE,
324  "name:%s author:'%s' explanation:'%s' color_model:%s "
325  "frei0r_version:%d version:%d.%d num_params:%d\n",
326  pi->name, pi->author, pi->explanation,
327  pi->color_model == F0R_COLOR_MODEL_BGRA8888 ? "bgra8888" :
328  pi->color_model == F0R_COLOR_MODEL_RGBA8888 ? "rgba8888" :
329  pi->color_model == F0R_COLOR_MODEL_PACKED32 ? "packed32" : "unknown",
330  pi->frei0r_version, pi->major_version, pi->minor_version, pi->num_params);
331 
332  return 0;
333 }
334 
336 {
337  Frei0rContext *s = ctx->priv;
338 
339  return frei0r_init(ctx, s->dl_name, F0R_PLUGIN_TYPE_FILTER);
340 }
341 
342 static av_cold void uninit(AVFilterContext *ctx)
343 {
344  Frei0rContext *s = ctx->priv;
345 
346  if (s->destruct && s->instance)
347  s->destruct(s->instance);
348  if (s->deinit)
349  s->deinit();
350  if (s->dl_handle)
351  dlclose(s->dl_handle);
352 }
353 
354 static int config_input_props(AVFilterLink *inlink)
355 {
356  AVFilterContext *ctx = inlink->dst;
357  Frei0rContext *s = ctx->priv;
358 
359  if (s->destruct && s->instance)
360  s->destruct(s->instance);
361  if (!(s->instance = s->construct(inlink->w, inlink->h))) {
362  av_log(ctx, AV_LOG_ERROR, "Impossible to load frei0r instance.\n");
363  return AVERROR(EINVAL);
364  }
365 
366  return set_params(ctx, s->params);
367 }
368 
370 {
371  Frei0rContext *s = ctx->priv;
373 
374  if (s->plugin_info.color_model == F0R_COLOR_MODEL_BGRA8888) {
375  ff_add_format(&formats, AV_PIX_FMT_BGRA);
376  } else if (s->plugin_info.color_model == F0R_COLOR_MODEL_RGBA8888) {
377  ff_add_format(&formats, AV_PIX_FMT_RGBA);
378  } else { /* F0R_COLOR_MODEL_PACKED32 */
379  static const enum AVPixelFormat pix_fmts[] = {
381  };
382  formats = ff_make_format_list(pix_fmts);
383  }
384 
385  if (!formats)
386  return AVERROR(ENOMEM);
387 
388  return ff_set_common_formats(ctx, formats);
389 }
390 
391 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
392 {
393  Frei0rContext *s = inlink->dst->priv;
394  AVFilterLink *outlink = inlink->dst->outputs[0];
395  AVFrame *out;
396 
397  out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
398  if (!out) {
399  av_frame_free(&in);
400  return AVERROR(ENOMEM);
401  }
402  av_frame_copy_props(out, in);
403 
404  s->update(s->instance, in->pts * av_q2d(inlink->time_base) * 1000,
405  (const uint32_t *)in->data[0],
406  (uint32_t *)out->data[0]);
407 
408  av_frame_free(&in);
409 
410  return ff_filter_frame(outlink, out);
411 }
412 
413 #define OFFSET(x) offsetof(Frei0rContext, x)
414 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_FILTERING_PARAM
415 static const AVOption frei0r_options[] = {
416  { "filter_name", NULL, OFFSET(dl_name), AV_OPT_TYPE_STRING, .flags = FLAGS },
417  { "filter_params", NULL, OFFSET(params), AV_OPT_TYPE_STRING, .flags = FLAGS },
418  { NULL }
419 };
420 
421 AVFILTER_DEFINE_CLASS(frei0r);
422 
424  {
425  .name = "default",
426  .type = AVMEDIA_TYPE_VIDEO,
427  .config_props = config_input_props,
428  .filter_frame = filter_frame,
429  },
430  { NULL }
431 };
432 
434  {
435  .name = "default",
436  .type = AVMEDIA_TYPE_VIDEO,
437  },
438  { NULL }
439 };
440 
442  .name = "frei0r",
443  .description = NULL_IF_CONFIG_SMALL("Apply a frei0r effect."),
444  .query_formats = query_formats,
445  .init = filter_init,
446  .uninit = uninit,
447  .priv_size = sizeof(Frei0rContext),
448  .priv_class = &frei0r_class,
449  .inputs = avfilter_vf_frei0r_inputs,
450  .outputs = avfilter_vf_frei0r_outputs,
451 };
452 
454 {
455  Frei0rContext *s = ctx->priv;
456 
457  s->time_base.num = s->framerate.den;
458  s->time_base.den = s->framerate.num;
459 
460  return frei0r_init(ctx, s->dl_name, F0R_PLUGIN_TYPE_SOURCE);
461 }
462 
463 static int source_config_props(AVFilterLink *outlink)
464 {
465  AVFilterContext *ctx = outlink->src;
466  Frei0rContext *s = ctx->priv;
467 
468  if (av_image_check_size(s->w, s->h, 0, ctx) < 0)
469  return AVERROR(EINVAL);
470  outlink->w = s->w;
471  outlink->h = s->h;
472  outlink->time_base = s->time_base;
473  outlink->frame_rate = av_inv_q(s->time_base);
474  outlink->sample_aspect_ratio = (AVRational){1,1};
475 
476  if (s->destruct && s->instance)
477  s->destruct(s->instance);
478  if (!(s->instance = s->construct(outlink->w, outlink->h))) {
479  av_log(ctx, AV_LOG_ERROR, "Impossible to load frei0r instance.\n");
480  return AVERROR(EINVAL);
481  }
482  if (!s->params) {
483  av_log(ctx, AV_LOG_ERROR, "frei0r filter parameters not set.\n");
484  return AVERROR(EINVAL);
485  }
486 
487  return set_params(ctx, s->params);
488 }
489 
490 static int source_request_frame(AVFilterLink *outlink)
491 {
492  Frei0rContext *s = outlink->src->priv;
493  AVFrame *frame = ff_get_video_buffer(outlink, outlink->w, outlink->h);
494 
495  if (!frame)
496  return AVERROR(ENOMEM);
497 
498  frame->sample_aspect_ratio = (AVRational) {1, 1};
499  frame->pts = s->pts++;
500 
501  s->update(s->instance, av_rescale_q(frame->pts, s->time_base, (AVRational){1,1000}),
502  NULL, (uint32_t *)frame->data[0]);
503 
504  return ff_filter_frame(outlink, frame);
505 }
506 
507 static const AVOption frei0r_src_options[] = {
508  { "size", "Dimensions of the generated video.", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, { .str = "320x240" }, .flags = FLAGS },
509  { "framerate", NULL, OFFSET(framerate), AV_OPT_TYPE_VIDEO_RATE, { .str = "25" }, .flags = FLAGS },
510  { "filter_name", NULL, OFFSET(dl_name), AV_OPT_TYPE_STRING, .flags = FLAGS },
511  { "filter_params", NULL, OFFSET(params), AV_OPT_TYPE_STRING, .flags = FLAGS },
512  { NULL },
513 };
514 
515 AVFILTER_DEFINE_CLASS(frei0r_src);
516 
518  {
519  .name = "default",
520  .type = AVMEDIA_TYPE_VIDEO,
521  .request_frame = source_request_frame,
522  .config_props = source_config_props
523  },
524  { NULL }
525 };
526 
528  .name = "frei0r_src",
529  .description = NULL_IF_CONFIG_SMALL("Generate a frei0r source."),
530  .priv_size = sizeof(Frei0rContext),
531  .priv_class = &frei0r_src_class,
532  .init = source_init,
533  .uninit = uninit,
535  .inputs = NULL,
536  .outputs = avfilter_vsrc_frei0r_src_outputs,
537 };