vf_frei0r.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2010 Stefano Sabatini
3  * This file is part of Libav.
4  *
5  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18  */
19 
25 /* #define DEBUG */
26 
27 #include <dlfcn.h>
28 #include <frei0r.h>
29 #include <stdio.h>
30 #include <string.h>
31 #include <stdlib.h>
32 #include "config.h"
33 #include "libavutil/avstring.h"
34 #include "libavutil/imgutils.h"
35 #include "libavutil/internal.h"
36 #include "libavutil/mathematics.h"
37 #include "libavutil/mem.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 {
57  void *dl_handle; /* dynamic library handle */
58  f0r_instance_t instance;
59  f0r_plugin_info_t plugin_info;
60 
67  char params[256];
68 
69  /* only used by the source */
70  int w, h;
72  uint64_t pts;
74 
75 static void *load_sym(AVFilterContext *ctx, const char *sym_name)
76 {
77  Frei0rContext *frei0r = ctx->priv;
78  void *sym = dlsym(frei0r->dl_handle, sym_name);
79  if (!sym)
80  av_log(ctx, AV_LOG_ERROR, "Could not find symbol '%s' in loaded module\n", sym_name);
81  return sym;
82 }
83 
84 static int set_param(AVFilterContext *ctx, f0r_param_info_t info, int index, char *param)
85 {
86  Frei0rContext *frei0r = ctx->priv;
87  union {
88  double d;
89  f0r_param_color_t col;
90  f0r_param_position_t pos;
91  } val;
92  char *tail;
93  uint8_t rgba[4];
94 
95  switch (info.type) {
96  case F0R_PARAM_BOOL:
97  if (!strcmp(param, "y")) val.d = 1.0;
98  else if (!strcmp(param, "n")) val.d = 0.0;
99  else goto fail;
100  break;
101 
102  case F0R_PARAM_DOUBLE:
103  val.d = strtod(param, &tail);
104  if (*tail || val.d == HUGE_VAL)
105  goto fail;
106  break;
107 
108  case F0R_PARAM_COLOR:
109  if (sscanf(param, "%f/%f/%f", &val.col.r, &val.col.g, &val.col.b) != 3) {
110  if (av_parse_color(rgba, param, -1, ctx) < 0)
111  goto fail;
112  val.col.r = rgba[0] / 255.0;
113  val.col.g = rgba[1] / 255.0;
114  val.col.b = rgba[2] / 255.0;
115  }
116  break;
117 
118  case F0R_PARAM_POSITION:
119  if (sscanf(param, "%lf/%lf", &val.pos.x, &val.pos.y) != 2)
120  goto fail;
121  break;
122  }
123 
124  frei0r->set_param_value(frei0r->instance, &val, index);
125  return 0;
126 
127 fail:
128  av_log(ctx, AV_LOG_ERROR, "Invalid value '%s' for parameter '%s'\n",
129  param, info.name);
130  return AVERROR(EINVAL);
131 }
132 
133 static int set_params(AVFilterContext *ctx, const char *params)
134 {
135  Frei0rContext *frei0r = ctx->priv;
136  int i;
137 
138  for (i = 0; i < frei0r->plugin_info.num_params; i++) {
139  f0r_param_info_t info;
140  char *param;
141  int ret;
142 
143  frei0r->get_param_info(&info, i);
144 
145  if (*params) {
146  if (!(param = av_get_token(&params, ":")))
147  return AVERROR(ENOMEM);
148  params++; /* skip ':' */
149  ret = set_param(ctx, info, i, param);
150  av_free(param);
151  if (ret < 0)
152  return ret;
153  }
154 
155  av_log(ctx, AV_LOG_VERBOSE,
156  "idx:%d name:'%s' type:%s explanation:'%s' ",
157  i, info.name,
158  info.type == F0R_PARAM_BOOL ? "bool" :
159  info.type == F0R_PARAM_DOUBLE ? "double" :
160  info.type == F0R_PARAM_COLOR ? "color" :
161  info.type == F0R_PARAM_POSITION ? "position" :
162  info.type == F0R_PARAM_STRING ? "string" : "unknown",
163  info.explanation);
164 
165 #ifdef DEBUG
166  av_log(ctx, AV_LOG_DEBUG, "value:");
167  switch (info.type) {
168  void *v;
169  double d;
170  char s[128];
171  f0r_param_color_t col;
172  f0r_param_position_t pos;
173 
174  case F0R_PARAM_BOOL:
175  v = &d;
176  frei0r->get_param_value(frei0r->instance, v, i);
177  av_log(ctx, AV_LOG_DEBUG, "%s", d >= 0.5 && d <= 1.0 ? "y" : "n");
178  break;
179  case F0R_PARAM_DOUBLE:
180  v = &d;
181  frei0r->get_param_value(frei0r->instance, v, i);
182  av_log(ctx, AV_LOG_DEBUG, "%f", d);
183  break;
184  case F0R_PARAM_COLOR:
185  v = &col;
186  frei0r->get_param_value(frei0r->instance, v, i);
187  av_log(ctx, AV_LOG_DEBUG, "%f/%f/%f", col.r, col.g, col.b);
188  break;
189  case F0R_PARAM_POSITION:
190  v = &pos;
191  frei0r->get_param_value(frei0r->instance, v, i);
192  av_log(ctx, AV_LOG_DEBUG, "%f/%f", pos.x, pos.y);
193  break;
194  default: /* F0R_PARAM_STRING */
195  v = s;
196  frei0r->get_param_value(frei0r->instance, v, i);
197  av_log(ctx, AV_LOG_DEBUG, "'%s'\n", s);
198  break;
199  }
200 #endif
201  av_log(ctx, AV_LOG_VERBOSE, "\n");
202  }
203 
204  return 0;
205 }
206 
207 static void *load_path(AVFilterContext *ctx, const char *prefix, const char *name)
208 {
209  char path[1024];
210 
211  snprintf(path, sizeof(path), "%s%s%s", prefix, name, SLIBSUF);
212  av_log(ctx, AV_LOG_DEBUG, "Looking for frei0r effect in '%s'\n", path);
213  return dlopen(path, RTLD_NOW|RTLD_LOCAL);
214 }
215 
217  const char *dl_name, int type)
218 {
219  Frei0rContext *frei0r = ctx->priv;
220  f0r_init_f f0r_init;
221  f0r_get_plugin_info_f f0r_get_plugin_info;
222  f0r_plugin_info_t *pi;
223  char *path;
224 
225  /* see: http://piksel.org/frei0r/1.2/spec/1.2/spec/group__pluglocations.html */
226  if ((path = av_strdup(getenv("FREI0R_PATH")))) {
227  char *p, *ptr = NULL;
228  for (p = path; p = strtok_r(p, ":", &ptr); p = NULL)
229  if (frei0r->dl_handle = load_path(ctx, p, dl_name))
230  break;
231  av_free(path);
232  }
233  if (!frei0r->dl_handle && (path = getenv("HOME"))) {
234  char prefix[1024];
235  snprintf(prefix, sizeof(prefix), "%s/.frei0r-1/lib/", path);
236  frei0r->dl_handle = load_path(ctx, prefix, dl_name);
237  }
238  if (!frei0r->dl_handle)
239  frei0r->dl_handle = load_path(ctx, "/usr/local/lib/frei0r-1/", dl_name);
240  if (!frei0r->dl_handle)
241  frei0r->dl_handle = load_path(ctx, "/usr/lib/frei0r-1/", dl_name);
242  if (!frei0r->dl_handle) {
243  av_log(ctx, AV_LOG_ERROR, "Could not find module '%s'\n", dl_name);
244  return AVERROR(EINVAL);
245  }
246 
247  if (!(f0r_init = load_sym(ctx, "f0r_init" )) ||
248  !(f0r_get_plugin_info = load_sym(ctx, "f0r_get_plugin_info")) ||
249  !(frei0r->get_param_info = load_sym(ctx, "f0r_get_param_info" )) ||
250  !(frei0r->get_param_value = load_sym(ctx, "f0r_get_param_value")) ||
251  !(frei0r->set_param_value = load_sym(ctx, "f0r_set_param_value")) ||
252  !(frei0r->update = load_sym(ctx, "f0r_update" )) ||
253  !(frei0r->construct = load_sym(ctx, "f0r_construct" )) ||
254  !(frei0r->destruct = load_sym(ctx, "f0r_destruct" )) ||
255  !(frei0r->deinit = load_sym(ctx, "f0r_deinit" )))
256  return AVERROR(EINVAL);
257 
258  if (f0r_init() < 0) {
259  av_log(ctx, AV_LOG_ERROR, "Could not init the frei0r module");
260  return AVERROR(EINVAL);
261  }
262 
263  f0r_get_plugin_info(&frei0r->plugin_info);
264  pi = &frei0r->plugin_info;
265  if (pi->plugin_type != type) {
266  av_log(ctx, AV_LOG_ERROR,
267  "Invalid type '%s' for the plugin\n",
268  pi->plugin_type == F0R_PLUGIN_TYPE_FILTER ? "filter" :
269  pi->plugin_type == F0R_PLUGIN_TYPE_SOURCE ? "source" :
270  pi->plugin_type == F0R_PLUGIN_TYPE_MIXER2 ? "mixer2" :
271  pi->plugin_type == F0R_PLUGIN_TYPE_MIXER3 ? "mixer3" : "unknown");
272  return AVERROR(EINVAL);
273  }
274 
275  av_log(ctx, AV_LOG_VERBOSE,
276  "name:%s author:'%s' explanation:'%s' color_model:%s "
277  "frei0r_version:%d version:%d.%d num_params:%d\n",
278  pi->name, pi->author, pi->explanation,
279  pi->color_model == F0R_COLOR_MODEL_BGRA8888 ? "bgra8888" :
280  pi->color_model == F0R_COLOR_MODEL_RGBA8888 ? "rgba8888" :
281  pi->color_model == F0R_COLOR_MODEL_PACKED32 ? "packed32" : "unknown",
282  pi->frei0r_version, pi->major_version, pi->minor_version, pi->num_params);
283 
284  return 0;
285 }
286 
287 static av_cold int filter_init(AVFilterContext *ctx, const char *args)
288 {
289  Frei0rContext *frei0r = ctx->priv;
290  char dl_name[1024], c;
291  *frei0r->params = 0;
292 
293  if (args)
294  sscanf(args, "%1023[^:=]%c%255c", dl_name, &c, frei0r->params);
295 
296  return frei0r_init(ctx, dl_name, F0R_PLUGIN_TYPE_FILTER);
297 }
298 
299 static av_cold void uninit(AVFilterContext *ctx)
300 {
301  Frei0rContext *frei0r = ctx->priv;
302 
303  if (frei0r->destruct && frei0r->instance)
304  frei0r->destruct(frei0r->instance);
305  if (frei0r->deinit)
306  frei0r->deinit();
307  if (frei0r->dl_handle)
308  dlclose(frei0r->dl_handle);
309 
310  memset(frei0r, 0, sizeof(*frei0r));
311 }
312 
313 static int config_input_props(AVFilterLink *inlink)
314 {
315  AVFilterContext *ctx = inlink->dst;
316  Frei0rContext *frei0r = ctx->priv;
317 
318  if (!(frei0r->instance = frei0r->construct(inlink->w, inlink->h))) {
319  av_log(ctx, AV_LOG_ERROR, "Impossible to load frei0r instance");
320  return AVERROR(EINVAL);
321  }
322 
323  return set_params(ctx, frei0r->params);
324 }
325 
327 {
328  Frei0rContext *frei0r = ctx->priv;
330 
331  if (frei0r->plugin_info.color_model == F0R_COLOR_MODEL_BGRA8888) {
332  ff_add_format(&formats, AV_PIX_FMT_BGRA);
333  } else if (frei0r->plugin_info.color_model == F0R_COLOR_MODEL_RGBA8888) {
334  ff_add_format(&formats, AV_PIX_FMT_RGBA);
335  } else { /* F0R_COLOR_MODEL_PACKED32 */
336  static const enum AVPixelFormat pix_fmts[] = {
338  };
339  formats = ff_make_format_list(pix_fmts);
340  }
341 
342  if (!formats)
343  return AVERROR(ENOMEM);
344 
345  ff_set_common_formats(ctx, formats);
346  return 0;
347 }
348 
350 {
351  Frei0rContext *frei0r = inlink->dst->priv;
352  AVFilterLink *outlink = inlink->dst->outputs[0];
353  AVFilterBufferRef *out;
354 
355  out = ff_get_video_buffer(outlink, AV_PERM_WRITE, outlink->w, outlink->h);
356  if (!out) {
358  return AVERROR(ENOMEM);
359  }
361 
362  frei0r->update(frei0r->instance, in->pts * av_q2d(inlink->time_base) * 1000,
363  (const uint32_t *)in->data[0],
364  (uint32_t *)out->data[0]);
365 
367 
368  return ff_filter_frame(outlink, out);
369 }
370 
372  {
373  .name = "default",
374  .type = AVMEDIA_TYPE_VIDEO,
375  .config_props = config_input_props,
376  .filter_frame = filter_frame,
377  .min_perms = AV_PERM_READ
378  },
379  { NULL }
380 };
381 
383  {
384  .name = "default",
385  .type = AVMEDIA_TYPE_VIDEO,
386  },
387  { NULL }
388 };
389 
391  .name = "frei0r",
392  .description = NULL_IF_CONFIG_SMALL("Apply a frei0r effect."),
393 
394  .query_formats = query_formats,
395  .init = filter_init,
396  .uninit = uninit,
397 
398  .priv_size = sizeof(Frei0rContext),
399 
400  .inputs = avfilter_vf_frei0r_inputs,
401 
402  .outputs = avfilter_vf_frei0r_outputs,
403 };
404 
405 static av_cold int source_init(AVFilterContext *ctx, const char *args)
406 {
407  Frei0rContext *frei0r = ctx->priv;
408  char dl_name[1024], c;
409  char frame_size[128] = "";
410  char frame_rate[128] = "";
411  AVRational frame_rate_q;
412 
413  memset(frei0r->params, 0, sizeof(frei0r->params));
414 
415  if (args)
416  sscanf(args, "%127[^:]:%127[^:]:%1023[^:=]%c%255c",
417  frame_size, frame_rate, dl_name, &c, frei0r->params);
418 
419  if (av_parse_video_size(&frei0r->w, &frei0r->h, frame_size) < 0) {
420  av_log(ctx, AV_LOG_ERROR, "Invalid frame size: '%s'\n", frame_size);
421  return AVERROR(EINVAL);
422  }
423 
424  if (av_parse_video_rate(&frame_rate_q, frame_rate) < 0 ||
425  frame_rate_q.den <= 0 || frame_rate_q.num <= 0) {
426  av_log(ctx, AV_LOG_ERROR, "Invalid frame rate: '%s'\n", frame_rate);
427  return AVERROR(EINVAL);
428  }
429  frei0r->time_base.num = frame_rate_q.den;
430  frei0r->time_base.den = frame_rate_q.num;
431 
432  return frei0r_init(ctx, dl_name, F0R_PLUGIN_TYPE_SOURCE);
433 }
434 
435 static int source_config_props(AVFilterLink *outlink)
436 {
437  AVFilterContext *ctx = outlink->src;
438  Frei0rContext *frei0r = ctx->priv;
439 
440  if (av_image_check_size(frei0r->w, frei0r->h, 0, ctx) < 0)
441  return AVERROR(EINVAL);
442  outlink->w = frei0r->w;
443  outlink->h = frei0r->h;
444  outlink->time_base = frei0r->time_base;
445 
446  if (!(frei0r->instance = frei0r->construct(outlink->w, outlink->h))) {
447  av_log(ctx, AV_LOG_ERROR, "Impossible to load frei0r instance");
448  return AVERROR(EINVAL);
449  }
450 
451  return set_params(ctx, frei0r->params);
452 }
453 
454 static int source_request_frame(AVFilterLink *outlink)
455 {
456  Frei0rContext *frei0r = outlink->src->priv;
457  AVFilterBufferRef *picref = ff_get_video_buffer(outlink, AV_PERM_WRITE, outlink->w, outlink->h);
458 
459  if (!picref)
460  return AVERROR(ENOMEM);
461 
462  picref->video->pixel_aspect = (AVRational) {1, 1};
463  picref->pts = frei0r->pts++;
464  picref->pos = -1;
465 
466  frei0r->update(frei0r->instance, av_rescale_q(picref->pts, frei0r->time_base, (AVRational){1,1000}),
467  NULL, (uint32_t *)picref->data[0]);
468 
469  return ff_filter_frame(outlink, picref);
470 }
471 
473  {
474  .name = "default",
475  .type = AVMEDIA_TYPE_VIDEO,
476  .request_frame = source_request_frame,
477  .config_props = source_config_props
478  },
479  { NULL }
480 };
481 
483  .name = "frei0r_src",
484  .description = NULL_IF_CONFIG_SMALL("Generate a frei0r source."),
485 
486  .priv_size = sizeof(Frei0rContext),
487  .init = source_init,
488  .uninit = uninit,
489 
491 
492  .inputs = NULL,
493 
494  .outputs = avfilter_vsrc_frei0r_src_outputs,
495 };