FFmpeg
af_ladspa.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013 Paul B Mahol
3  * Copyright (c) 2011 Mina Nagy Zaki
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
22 /**
23  * @file
24  * LADSPA wrapper
25  */
26 
27 #include <dlfcn.h>
28 #include <ladspa.h>
29 #include "libavutil/avassert.h"
30 #include "libavutil/avstring.h"
32 #include "libavutil/opt.h"
33 #include "audio.h"
34 #include "avfilter.h"
35 #include "internal.h"
36 
37 typedef struct LADSPAContext {
38  const AVClass *class;
39  char *dl_name;
40  char *plugin;
41  char *options;
42  void *dl_handle;
43 
44  unsigned long nb_inputs;
45  unsigned long *ipmap; /* map input number to port number */
46 
47  unsigned long nb_inputcontrols;
48  unsigned long *icmap; /* map input control number to port number */
49  LADSPA_Data *ictlv; /* input controls values */
50 
51  unsigned long nb_outputs;
52  unsigned long *opmap; /* map output number to port number */
53 
54  unsigned long nb_outputcontrols;
55  unsigned long *ocmap; /* map output control number to port number */
56  LADSPA_Data *octlv; /* output controls values */
57 
58  const LADSPA_Descriptor *desc;
61  LADSPA_Handle *handles;
62 
65  int64_t pts;
66  int64_t duration;
67  int in_trim;
68  int out_pad;
69  int latency;
71 
72 #define OFFSET(x) offsetof(LADSPAContext, x)
73 #define FLAGS AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_FILTERING_PARAM
74 static const AVOption ladspa_options[] = {
75  { "file", "set library name or full path", OFFSET(dl_name), AV_OPT_TYPE_STRING, .flags = FLAGS },
76  { "f", "set library name or full path", OFFSET(dl_name), AV_OPT_TYPE_STRING, .flags = FLAGS },
77  { "plugin", "set plugin name", OFFSET(plugin), AV_OPT_TYPE_STRING, .flags = FLAGS },
78  { "p", "set plugin name", OFFSET(plugin), AV_OPT_TYPE_STRING, .flags = FLAGS },
79  { "controls", "set plugin options", OFFSET(options), AV_OPT_TYPE_STRING, .flags = FLAGS },
80  { "c", "set plugin options", OFFSET(options), AV_OPT_TYPE_STRING, .flags = FLAGS },
81  { "sample_rate", "set sample rate", OFFSET(sample_rate), AV_OPT_TYPE_INT, {.i64=44100}, 1, INT32_MAX, FLAGS },
82  { "s", "set sample rate", OFFSET(sample_rate), AV_OPT_TYPE_INT, {.i64=44100}, 1, INT32_MAX, FLAGS },
83  { "nb_samples", "set the number of samples per requested frame", OFFSET(nb_samples), AV_OPT_TYPE_INT, {.i64=1024}, 1, INT_MAX, FLAGS },
84  { "n", "set the number of samples per requested frame", OFFSET(nb_samples), AV_OPT_TYPE_INT, {.i64=1024}, 1, INT_MAX, FLAGS },
85  { "duration", "set audio duration", OFFSET(duration), AV_OPT_TYPE_DURATION, {.i64=-1}, -1, INT64_MAX, FLAGS },
86  { "d", "set audio duration", OFFSET(duration), AV_OPT_TYPE_DURATION, {.i64=-1}, -1, INT64_MAX, FLAGS },
87  { "latency", "enable latency compensation", OFFSET(latency), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
88  { "l", "enable latency compensation", OFFSET(latency), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
89  { NULL }
90 };
91 
92 AVFILTER_DEFINE_CLASS(ladspa);
93 
95 {
96  int latency = 0;
97 
98  for (int ctl = 0; ctl < s->nb_outputcontrols; ctl++) {
99  if (av_strcasecmp("latency", s->desc->PortNames[s->ocmap[ctl]]))
100  continue;
101 
102  latency = lrintf(s->octlv[ctl]);
103  break;
104  }
105 
106  return latency;
107 }
108 
110  LADSPAContext *s, int ctl, unsigned long *map,
111  LADSPA_Data *values, int print)
112 {
113  const LADSPA_PortRangeHint *h = s->desc->PortRangeHints + map[ctl];
114 
115  av_log(ctx, level, "c%i: %s [", ctl, s->desc->PortNames[map[ctl]]);
116 
117  if (LADSPA_IS_HINT_TOGGLED(h->HintDescriptor)) {
118  av_log(ctx, level, "toggled (1 or 0)");
119 
120  if (LADSPA_IS_HINT_HAS_DEFAULT(h->HintDescriptor))
121  av_log(ctx, level, " (default %i)", (int)values[ctl]);
122  } else {
123  if (LADSPA_IS_HINT_INTEGER(h->HintDescriptor)) {
124  av_log(ctx, level, "<int>");
125 
126  if (LADSPA_IS_HINT_BOUNDED_BELOW(h->HintDescriptor))
127  av_log(ctx, level, ", min: %i", (int)h->LowerBound);
128 
129  if (LADSPA_IS_HINT_BOUNDED_ABOVE(h->HintDescriptor))
130  av_log(ctx, level, ", max: %i", (int)h->UpperBound);
131 
132  if (print)
133  av_log(ctx, level, " (value %d)", (int)values[ctl]);
134  else if (LADSPA_IS_HINT_HAS_DEFAULT(h->HintDescriptor))
135  av_log(ctx, level, " (default %d)", (int)values[ctl]);
136  } else {
137  av_log(ctx, level, "<float>");
138 
139  if (LADSPA_IS_HINT_BOUNDED_BELOW(h->HintDescriptor))
140  av_log(ctx, level, ", min: %f", h->LowerBound);
141 
142  if (LADSPA_IS_HINT_BOUNDED_ABOVE(h->HintDescriptor))
143  av_log(ctx, level, ", max: %f", h->UpperBound);
144 
145  if (print)
146  av_log(ctx, level, " (value %f)", values[ctl]);
147  else if (LADSPA_IS_HINT_HAS_DEFAULT(h->HintDescriptor))
148  av_log(ctx, level, " (default %f)", values[ctl]);
149  }
150 
151  if (LADSPA_IS_HINT_SAMPLE_RATE(h->HintDescriptor))
152  av_log(ctx, level, ", multiple of sample rate");
153 
154  if (LADSPA_IS_HINT_LOGARITHMIC(h->HintDescriptor))
155  av_log(ctx, level, ", logarithmic scale");
156  }
157 
158  av_log(ctx, level, "]\n");
159 }
160 
162 {
163  AVFilterContext *ctx = inlink->dst;
164  LADSPAContext *s = ctx->priv;
165  AVFrame *out;
166  int i, h, p, new_out_samples;
167 
168  av_assert0(in->channels == (s->nb_inputs * s->nb_handles));
169 
170  if (!s->nb_outputs ||
171  (av_frame_is_writable(in) && s->nb_inputs == s->nb_outputs &&
172  s->in_trim == 0 && s->out_pad == 0 &&
173  !(s->desc->Properties & LADSPA_PROPERTY_INPLACE_BROKEN))) {
174  out = in;
175  } else {
176  out = ff_get_audio_buffer(ctx->outputs[0], in->nb_samples);
177  if (!out) {
178  av_frame_free(&in);
179  return AVERROR(ENOMEM);
180  }
182  }
183 
184  av_assert0(!s->nb_outputs || out->channels == (s->nb_outputs * s->nb_handles));
185 
186  for (h = 0; h < s->nb_handles; h++) {
187  for (i = 0; i < s->nb_inputs; i++) {
188  p = s->nb_handles > 1 ? h : i;
189  s->desc->connect_port(s->handles[h], s->ipmap[i],
190  (LADSPA_Data*)in->extended_data[p]);
191  }
192 
193  for (i = 0; i < s->nb_outputs; i++) {
194  p = s->nb_handles > 1 ? h : i;
195  s->desc->connect_port(s->handles[h], s->opmap[i],
196  (LADSPA_Data*)out->extended_data[p]);
197  }
198 
199  s->desc->run(s->handles[h], in->nb_samples);
200  if (s->latency)
201  s->in_trim = s->out_pad = find_latency(ctx, s);
202  s->latency = 0;
203  }
204 
205  for (i = 0; i < s->nb_outputcontrols; i++)
206  print_ctl_info(ctx, AV_LOG_VERBOSE, s, i, s->ocmap, s->octlv, 1);
207 
208  if (out != in)
209  av_frame_free(&in);
210 
211  new_out_samples = out->nb_samples;
212  if (s->in_trim > 0) {
213  int trim = FFMIN(new_out_samples, s->in_trim);
214 
215  new_out_samples -= trim;
216  s->in_trim -= trim;
217  }
218 
219  if (new_out_samples <= 0) {
220  av_frame_free(&out);
221  return 0;
222  } else if (new_out_samples < out->nb_samples) {
223  int offset = out->nb_samples - new_out_samples;
224  for (int ch = 0; ch < out->channels; ch++)
225  memmove(out->extended_data[ch], out->extended_data[ch] + sizeof(float) * offset,
226  sizeof(float) * new_out_samples);
227  out->nb_samples = new_out_samples;
228  }
229 
230  return ff_filter_frame(ctx->outputs[0], out);
231 }
232 
233 static int request_frame(AVFilterLink *outlink)
234 {
235  AVFilterContext *ctx = outlink->src;
236  LADSPAContext *s = ctx->priv;
237  AVFrame *out;
238  int64_t t;
239  int i;
240 
241  if (ctx->nb_inputs) {
242  int ret = ff_request_frame(ctx->inputs[0]);
243 
244  if (ret == AVERROR_EOF && s->out_pad > 0) {
245  AVFrame *frame = ff_get_audio_buffer(outlink, FFMIN(2048, s->out_pad));
246  if (!frame)
247  return AVERROR(ENOMEM);
248 
249  s->out_pad -= frame->nb_samples;
250  return filter_frame(ctx->inputs[0], frame);
251  }
252  return ret;
253  }
254 
255  t = av_rescale(s->pts, AV_TIME_BASE, s->sample_rate);
256  if (s->duration >= 0 && t >= s->duration)
257  return AVERROR_EOF;
258 
259  out = ff_get_audio_buffer(outlink, s->nb_samples);
260  if (!out)
261  return AVERROR(ENOMEM);
262 
263  for (i = 0; i < s->nb_outputs; i++)
264  s->desc->connect_port(s->handles[0], s->opmap[i],
265  (LADSPA_Data*)out->extended_data[i]);
266 
267  s->desc->run(s->handles[0], s->nb_samples);
268 
269  for (i = 0; i < s->nb_outputcontrols; i++)
270  print_ctl_info(ctx, AV_LOG_INFO, s, i, s->ocmap, s->octlv, 1);
271 
272  out->sample_rate = s->sample_rate;
273  out->pts = s->pts;
274  s->pts += s->nb_samples;
275 
276  return ff_filter_frame(outlink, out);
277 }
278 
279 static void set_default_ctl_value(LADSPAContext *s, int ctl,
280  unsigned long *map, LADSPA_Data *values)
281 {
282  const LADSPA_PortRangeHint *h = s->desc->PortRangeHints + map[ctl];
283  const LADSPA_Data lower = h->LowerBound;
284  const LADSPA_Data upper = h->UpperBound;
285 
286  if (LADSPA_IS_HINT_DEFAULT_MINIMUM(h->HintDescriptor)) {
287  values[ctl] = lower;
288  } else if (LADSPA_IS_HINT_DEFAULT_MAXIMUM(h->HintDescriptor)) {
289  values[ctl] = upper;
290  } else if (LADSPA_IS_HINT_DEFAULT_0(h->HintDescriptor)) {
291  values[ctl] = 0.0;
292  } else if (LADSPA_IS_HINT_DEFAULT_1(h->HintDescriptor)) {
293  values[ctl] = 1.0;
294  } else if (LADSPA_IS_HINT_DEFAULT_100(h->HintDescriptor)) {
295  values[ctl] = 100.0;
296  } else if (LADSPA_IS_HINT_DEFAULT_440(h->HintDescriptor)) {
297  values[ctl] = 440.0;
298  } else if (LADSPA_IS_HINT_DEFAULT_LOW(h->HintDescriptor)) {
299  if (LADSPA_IS_HINT_LOGARITHMIC(h->HintDescriptor))
300  values[ctl] = exp(log(lower) * 0.75 + log(upper) * 0.25);
301  else
302  values[ctl] = lower * 0.75 + upper * 0.25;
303  } else if (LADSPA_IS_HINT_DEFAULT_MIDDLE(h->HintDescriptor)) {
304  if (LADSPA_IS_HINT_LOGARITHMIC(h->HintDescriptor))
305  values[ctl] = exp(log(lower) * 0.5 + log(upper) * 0.5);
306  else
307  values[ctl] = lower * 0.5 + upper * 0.5;
308  } else if (LADSPA_IS_HINT_DEFAULT_HIGH(h->HintDescriptor)) {
309  if (LADSPA_IS_HINT_LOGARITHMIC(h->HintDescriptor))
310  values[ctl] = exp(log(lower) * 0.25 + log(upper) * 0.75);
311  else
312  values[ctl] = lower * 0.25 + upper * 0.75;
313  }
314 }
315 
317 {
318  LADSPAContext *s = ctx->priv;
319  int i, j;
320 
321  s->nb_handles = s->nb_inputs == 1 && s->nb_outputs == 1 ? link->channels : 1;
322  s->handles = av_calloc(s->nb_handles, sizeof(*s->handles));
323  if (!s->handles)
324  return AVERROR(ENOMEM);
325 
326  for (i = 0; i < s->nb_handles; i++) {
327  s->handles[i] = s->desc->instantiate(s->desc, link->sample_rate);
328  if (!s->handles[i]) {
329  av_log(ctx, AV_LOG_ERROR, "Could not instantiate plugin.\n");
330  return AVERROR_EXTERNAL;
331  }
332 
333  // Connect the input control ports
334  for (j = 0; j < s->nb_inputcontrols; j++)
335  s->desc->connect_port(s->handles[i], s->icmap[j], s->ictlv + j);
336 
337  // Connect the output control ports
338  for (j = 0; j < s->nb_outputcontrols; j++)
339  s->desc->connect_port(s->handles[i], s->ocmap[j], &s->octlv[j]);
340 
341  if (s->desc->activate)
342  s->desc->activate(s->handles[i]);
343  }
344 
345  av_log(ctx, AV_LOG_DEBUG, "handles: %d\n", s->nb_handles);
346 
347  return 0;
348 }
349 
351 {
352  AVFilterContext *ctx = inlink->dst;
353 
354  return connect_ports(ctx, inlink);
355 }
356 
357 static int config_output(AVFilterLink *outlink)
358 {
359  AVFilterContext *ctx = outlink->src;
360  LADSPAContext *s = ctx->priv;
361  int ret;
362 
363  if (ctx->nb_inputs) {
364  AVFilterLink *inlink = ctx->inputs[0];
365 
366  outlink->format = inlink->format;
367  outlink->sample_rate = inlink->sample_rate;
368  if (s->nb_inputs == s->nb_outputs) {
369  outlink->channel_layout = inlink->channel_layout;
370  outlink->channels = inlink->channels;
371  }
372 
373  ret = 0;
374  } else {
375  outlink->sample_rate = s->sample_rate;
376  outlink->time_base = (AVRational){1, s->sample_rate};
377 
378  ret = connect_ports(ctx, outlink);
379  }
380 
381  return ret;
382 }
383 
384 static void count_ports(const LADSPA_Descriptor *desc,
385  unsigned long *nb_inputs, unsigned long *nb_outputs)
386 {
387  LADSPA_PortDescriptor pd;
388  int i;
389 
390  for (i = 0; i < desc->PortCount; i++) {
391  pd = desc->PortDescriptors[i];
392 
393  if (LADSPA_IS_PORT_AUDIO(pd)) {
394  if (LADSPA_IS_PORT_INPUT(pd)) {
395  (*nb_inputs)++;
396  } else if (LADSPA_IS_PORT_OUTPUT(pd)) {
397  (*nb_outputs)++;
398  }
399  }
400  }
401 }
402 
403 static void *try_load(const char *dir, const char *soname)
404 {
405  char *path = av_asprintf("%s/%s.so", dir, soname);
406  void *ret = NULL;
407 
408  if (path) {
409  ret = dlopen(path, RTLD_LOCAL|RTLD_NOW);
410  av_free(path);
411  }
412 
413  return ret;
414 }
415 
416 static int set_control(AVFilterContext *ctx, unsigned long port, LADSPA_Data value)
417 {
418  LADSPAContext *s = ctx->priv;
419  const char *label = s->desc->Label;
420  LADSPA_PortRangeHint *h = (LADSPA_PortRangeHint *)s->desc->PortRangeHints +
421  s->icmap[port];
422 
423  if (port >= s->nb_inputcontrols) {
424  av_log(ctx, AV_LOG_ERROR, "Control c%ld is out of range [0 - %lu].\n",
425  port, s->nb_inputcontrols);
426  return AVERROR(EINVAL);
427  }
428 
429  if (LADSPA_IS_HINT_BOUNDED_BELOW(h->HintDescriptor) &&
430  value < h->LowerBound) {
432  "%s: input control c%ld is below lower boundary of %0.4f.\n",
433  label, port, h->LowerBound);
434  return AVERROR(EINVAL);
435  }
436 
437  if (LADSPA_IS_HINT_BOUNDED_ABOVE(h->HintDescriptor) &&
438  value > h->UpperBound) {
440  "%s: input control c%ld is above upper boundary of %0.4f.\n",
441  label, port, h->UpperBound);
442  return AVERROR(EINVAL);
443  }
444 
445  s->ictlv[port] = value;
446 
447  return 0;
448 }
449 
451 {
452  LADSPAContext *s = ctx->priv;
453  LADSPA_Descriptor_Function descriptor_fn;
454  const LADSPA_Descriptor *desc;
455  LADSPA_PortDescriptor pd;
456  AVFilterPad pad = { NULL };
457  char *p, *arg, *saveptr = NULL;
458  unsigned long nb_ports;
459  int i, j = 0, ret;
460 
461  if (!s->dl_name) {
462  av_log(ctx, AV_LOG_ERROR, "No plugin name provided\n");
463  return AVERROR(EINVAL);
464  }
465 
466  if (s->dl_name[0] == '/' || s->dl_name[0] == '.') {
467  // argument is a path
468  s->dl_handle = dlopen(s->dl_name, RTLD_LOCAL|RTLD_NOW);
469  } else {
470  // argument is a shared object name
471  char *paths = av_strdup(getenv("LADSPA_PATH"));
472  const char *home_path = getenv("HOME");
473  const char *separator = ":";
474 
475  if (paths) {
476  p = paths;
477  while ((arg = av_strtok(p, separator, &saveptr)) && !s->dl_handle) {
478  s->dl_handle = try_load(arg, s->dl_name);
479  p = NULL;
480  }
481  }
482 
483  av_free(paths);
484  if (!s->dl_handle && home_path && (paths = av_asprintf("%s/.ladspa", home_path))) {
485  s->dl_handle = try_load(paths, s->dl_name);
486  av_free(paths);
487  }
488 
489  if (!s->dl_handle && home_path && (paths = av_asprintf("%s/.ladspa/lib", home_path))) {
490  s->dl_handle = try_load(paths, s->dl_name);
491  av_free(paths);
492  }
493 
494  if (!s->dl_handle)
495  s->dl_handle = try_load("/usr/local/lib/ladspa", s->dl_name);
496 
497  if (!s->dl_handle)
498  s->dl_handle = try_load("/usr/lib/ladspa", s->dl_name);
499  }
500  if (!s->dl_handle) {
501  av_log(ctx, AV_LOG_ERROR, "Failed to load '%s'\n", s->dl_name);
502  return AVERROR(EINVAL);
503  }
504 
505  descriptor_fn = dlsym(s->dl_handle, "ladspa_descriptor");
506  if (!descriptor_fn) {
507  av_log(ctx, AV_LOG_ERROR, "Could not find ladspa_descriptor: %s\n", dlerror());
508  return AVERROR(EINVAL);
509  }
510 
511  // Find the requested plugin, or list plugins
512  if (!s->plugin) {
513  av_log(ctx, AV_LOG_INFO, "The '%s' library contains the following plugins:\n", s->dl_name);
514  av_log(ctx, AV_LOG_INFO, "I = Input Channels\n");
515  av_log(ctx, AV_LOG_INFO, "O = Output Channels\n");
516  av_log(ctx, AV_LOG_INFO, "I:O %-25s %s\n", "Plugin", "Description");
517  av_log(ctx, AV_LOG_INFO, "\n");
518  for (i = 0; desc = descriptor_fn(i); i++) {
519  unsigned long inputs = 0, outputs = 0;
520 
522  av_log(ctx, AV_LOG_INFO, "%lu:%lu %-25s %s\n", inputs, outputs, desc->Label,
523  (char *)av_x_if_null(desc->Name, "?"));
524  av_log(ctx, AV_LOG_VERBOSE, "Maker: %s\n",
525  (char *)av_x_if_null(desc->Maker, "?"));
526  av_log(ctx, AV_LOG_VERBOSE, "Copyright: %s\n",
527  (char *)av_x_if_null(desc->Copyright, "?"));
528  }
529  return AVERROR_EXIT;
530  } else {
531  for (i = 0;; i++) {
532  desc = descriptor_fn(i);
533  if (!desc) {
534  av_log(ctx, AV_LOG_ERROR, "Could not find plugin: %s\n", s->plugin);
535  return AVERROR(EINVAL);
536  }
537 
538  if (desc->Label && !strcmp(desc->Label, s->plugin))
539  break;
540  }
541  }
542 
543  s->desc = desc;
544  nb_ports = desc->PortCount;
545 
546  s->ipmap = av_calloc(nb_ports, sizeof(*s->ipmap));
547  s->opmap = av_calloc(nb_ports, sizeof(*s->opmap));
548  s->icmap = av_calloc(nb_ports, sizeof(*s->icmap));
549  s->ocmap = av_calloc(nb_ports, sizeof(*s->ocmap));
550  s->ictlv = av_calloc(nb_ports, sizeof(*s->ictlv));
551  s->octlv = av_calloc(nb_ports, sizeof(*s->octlv));
552  s->ctl_needs_value = av_calloc(nb_ports, sizeof(*s->ctl_needs_value));
553  if (!s->ipmap || !s->opmap || !s->icmap ||
554  !s->ocmap || !s->ictlv || !s->octlv || !s->ctl_needs_value)
555  return AVERROR(ENOMEM);
556 
557  for (i = 0; i < nb_ports; i++) {
558  pd = desc->PortDescriptors[i];
559 
560  if (LADSPA_IS_PORT_AUDIO(pd)) {
561  if (LADSPA_IS_PORT_INPUT(pd)) {
562  s->ipmap[s->nb_inputs] = i;
563  s->nb_inputs++;
564  } else if (LADSPA_IS_PORT_OUTPUT(pd)) {
565  s->opmap[s->nb_outputs] = i;
566  s->nb_outputs++;
567  }
568  } else if (LADSPA_IS_PORT_CONTROL(pd)) {
569  if (LADSPA_IS_PORT_INPUT(pd)) {
570  s->icmap[s->nb_inputcontrols] = i;
571 
572  if (LADSPA_IS_HINT_HAS_DEFAULT(desc->PortRangeHints[i].HintDescriptor))
573  set_default_ctl_value(s, s->nb_inputcontrols, s->icmap, s->ictlv);
574  else
575  s->ctl_needs_value[s->nb_inputcontrols] = 1;
576 
577  s->nb_inputcontrols++;
578  } else if (LADSPA_IS_PORT_OUTPUT(pd)) {
579  s->ocmap[s->nb_outputcontrols] = i;
580  s->nb_outputcontrols++;
581  }
582  }
583  }
584 
585  // List Control Ports if "help" is specified
586  if (s->options && !strcmp(s->options, "help")) {
587  if (!s->nb_inputcontrols) {
589  "The '%s' plugin does not have any input controls.\n",
590  desc->Label);
591  } else {
593  "The '%s' plugin has the following input controls:\n",
594  desc->Label);
595  for (i = 0; i < s->nb_inputcontrols; i++)
596  print_ctl_info(ctx, AV_LOG_INFO, s, i, s->icmap, s->ictlv, 0);
597  }
598  return AVERROR_EXIT;
599  }
600 
601  // Parse control parameters
602  p = s->options;
603  while (s->options) {
604  LADSPA_Data val;
605  int ret;
606 
607  if (!(arg = av_strtok(p, " |", &saveptr)))
608  break;
609  p = NULL;
610 
611  if (av_sscanf(arg, "c%d=%f", &i, &val) != 2) {
612  if (av_sscanf(arg, "%f", &val) != 1) {
613  av_log(ctx, AV_LOG_ERROR, "Invalid syntax.\n");
614  return AVERROR(EINVAL);
615  }
616  i = j++;
617  }
618 
619  if ((ret = set_control(ctx, i, val)) < 0)
620  return ret;
621  s->ctl_needs_value[i] = 0;
622  }
623 
624  // Check if any controls are not set
625  for (i = 0; i < s->nb_inputcontrols; i++) {
626  if (s->ctl_needs_value[i]) {
627  av_log(ctx, AV_LOG_ERROR, "Control c%d must be set.\n", i);
628  print_ctl_info(ctx, AV_LOG_ERROR, s, i, s->icmap, s->ictlv, 0);
629  return AVERROR(EINVAL);
630  }
631  }
632 
633  pad.type = AVMEDIA_TYPE_AUDIO;
634 
635  if (s->nb_inputs) {
636  pad.name = av_asprintf("in0:%s%lu", desc->Label, s->nb_inputs);
637  if (!pad.name)
638  return AVERROR(ENOMEM);
639 
642  if ((ret = ff_append_inpad_free_name(ctx, &pad)) < 0)
643  return ret;
644  }
645 
646  av_log(ctx, AV_LOG_DEBUG, "ports: %lu\n", nb_ports);
647  av_log(ctx, AV_LOG_DEBUG, "inputs: %lu outputs: %lu\n",
648  s->nb_inputs, s->nb_outputs);
649  av_log(ctx, AV_LOG_DEBUG, "input controls: %lu output controls: %lu\n",
650  s->nb_inputcontrols, s->nb_outputcontrols);
651 
652  return 0;
653 }
654 
656 {
657  LADSPAContext *s = ctx->priv;
659  static const enum AVSampleFormat sample_fmts[] = {
662  if (ret < 0)
663  return ret;
664 
665  if (s->nb_inputs) {
667  if (ret < 0)
668  return ret;
669  } else {
670  int sample_rates[] = { s->sample_rate, -1 };
671 
673  if (ret < 0)
674  return ret;
675  }
676 
677  if (s->nb_inputs == 1 && s->nb_outputs == 1) {
678  // We will instantiate multiple LADSPA_Handle, one over each channel
680  if (ret < 0)
681  return ret;
682  } else if (s->nb_inputs == 2 && s->nb_outputs == 2) {
683  layouts = NULL;
685  if (ret < 0)
686  return ret;
688  if (ret < 0)
689  return ret;
690  } else {
691  AVFilterLink *outlink = ctx->outputs[0];
692 
693  if (s->nb_inputs >= 1) {
694  AVFilterLink *inlink = ctx->inputs[0];
695  uint64_t inlayout = FF_COUNT2LAYOUT(s->nb_inputs);
696 
697  layouts = NULL;
698  ret = ff_add_channel_layout(&layouts, inlayout);
699  if (ret < 0)
700  return ret;
701  ret = ff_channel_layouts_ref(layouts, &inlink->outcfg.channel_layouts);
702  if (ret < 0)
703  return ret;
704 
705  if (!s->nb_outputs) {
707  if (ret < 0)
708  return ret;
709  }
710  }
711 
712  if (s->nb_outputs >= 1) {
713  uint64_t outlayout = FF_COUNT2LAYOUT(s->nb_outputs);
714 
715  layouts = NULL;
716  ret = ff_add_channel_layout(&layouts, outlayout);
717  if (ret < 0)
718  return ret;
720  if (ret < 0)
721  return ret;
722  }
723  }
724 
725  return 0;
726 }
727 
729 {
730  LADSPAContext *s = ctx->priv;
731  int i;
732 
733  for (i = 0; i < s->nb_handles; i++) {
734  if (s->desc->deactivate)
735  s->desc->deactivate(s->handles[i]);
736  if (s->desc->cleanup)
737  s->desc->cleanup(s->handles[i]);
738  }
739 
740  if (s->dl_handle)
741  dlclose(s->dl_handle);
742 
743  av_freep(&s->ipmap);
744  av_freep(&s->opmap);
745  av_freep(&s->icmap);
746  av_freep(&s->ocmap);
747  av_freep(&s->ictlv);
748  av_freep(&s->octlv);
749  av_freep(&s->handles);
750  av_freep(&s->ctl_needs_value);
751 }
752 
753 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
754  char *res, int res_len, int flags)
755 {
756  LADSPA_Data value;
757  unsigned long port;
758 
759  if (av_sscanf(cmd, "c%ld", &port) + av_sscanf(args, "%f", &value) != 2)
760  return AVERROR(EINVAL);
761 
762  return set_control(ctx, port, value);
763 }
764 
765 static const AVFilterPad ladspa_outputs[] = {
766  {
767  .name = "default",
768  .type = AVMEDIA_TYPE_AUDIO,
769  .config_props = config_output,
770  .request_frame = request_frame,
771  },
772 };
773 
775  .name = "ladspa",
776  .description = NULL_IF_CONFIG_SMALL("Apply LADSPA effect."),
777  .priv_size = sizeof(LADSPAContext),
778  .priv_class = &ladspa_class,
779  .init = init,
780  .uninit = uninit,
782  .inputs = 0,
786 };
LADSPAContext::nb_inputs
unsigned long nb_inputs
Definition: af_ladspa.c:44
try_load
static void * try_load(const char *dir, const char *soname)
Definition: af_ladspa.c:403
ff_get_audio_buffer
AVFrame * ff_get_audio_buffer(AVFilterLink *link, int nb_samples)
Request an audio samples buffer with a specific set of permissions.
Definition: audio.c:88
AV_SAMPLE_FMT_FLTP
@ AV_SAMPLE_FMT_FLTP
float, planar
Definition: samplefmt.h:69
AVFilterChannelLayouts
A list of supported channel layouts.
Definition: formats.h:85
level
uint8_t level
Definition: svq3.c:204
AVERROR
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
opt.h
AVFilterFormatsConfig::channel_layouts
AVFilterChannelLayouts * channel_layouts
Lists of supported channel layouts, only for audio.
Definition: avfilter.h:500
out
FILE * out
Definition: movenc.c:54
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1018
sample_fmts
static enum AVSampleFormat sample_fmts[]
Definition: adpcmenc.c:948
ff_channel_layouts_ref
int ff_channel_layouts_ref(AVFilterChannelLayouts *f, AVFilterChannelLayouts **ref)
Add *ref as a new reference to f.
Definition: formats.c:550
layouts
enum MovChannelLayoutTag * layouts
Definition: mov_chan.c:434
AVERROR_EOF
#define AVERROR_EOF
End of file.
Definition: error.h:57
ff_set_common_samplerates_from_list
int ff_set_common_samplerates_from_list(AVFilterContext *ctx, const int *samplerates)
Equivalent to ff_set_common_samplerates(ctx, ff_make_format_list(samplerates))
Definition: formats.c:683
inlink
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
Definition: filter_design.txt:212
av_asprintf
char * av_asprintf(const char *fmt,...)
Definition: avstring.c:113
av_strcasecmp
int av_strcasecmp(const char *a, const char *b)
Locale-independent case-insensitive compare.
Definition: avstring.c:215
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(ladspa)
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:112
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
AVOption
AVOption.
Definition: opt.h:247
FILTER_QUERY_FUNC
#define FILTER_QUERY_FUNC(func)
Definition: internal.h:168
AV_OPT_TYPE_DURATION
@ AV_OPT_TYPE_DURATION
Definition: opt.h:238
ff_request_frame
int ff_request_frame(AVFilterLink *link)
Request an input frame from the filter at the other end of the link.
Definition: avfilter.c:420
LADSPAContext::handles
LADSPA_Handle * handles
Definition: af_ladspa.c:61
LADSPAContext::ctl_needs_value
int * ctl_needs_value
Definition: af_ladspa.c:59
AV_LOG_VERBOSE
#define AV_LOG_VERBOSE
Detailed information.
Definition: log.h:196
ff_set_common_all_samplerates
int ff_set_common_all_samplerates(AVFilterContext *ctx)
Equivalent to ff_set_common_samplerates(ctx, ff_all_samplerates())
Definition: formats.c:689
LADSPAContext
Definition: af_ladspa.c:37
config_output
static int config_output(AVFilterLink *outlink)
Definition: af_ladspa.c:357
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:153
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: af_ladspa.c:728
sample_rate
sample_rate
Definition: ffmpeg_filter.c:156
LADSPAContext::options
char * options
Definition: af_ladspa.c:41
LADSPAContext::icmap
unsigned long * icmap
Definition: af_ladspa.c:48
process_command
static int process_command(AVFilterContext *ctx, const char *cmd, const char *args, char *res, int res_len, int flags)
Definition: af_ladspa.c:753
LADSPAContext::nb_outputs
unsigned long nb_outputs
Definition: af_ladspa.c:51
connect_ports
static int connect_ports(AVFilterContext *ctx, AVFilterLink *link)
Definition: af_ladspa.c:316
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: af_ladspa.c:161
LADSPAContext::nb_handles
int nb_handles
Definition: af_ladspa.c:60
LADSPAContext::desc
const LADSPA_Descriptor * desc
Definition: af_ladspa.c:58
val
static double val(void *priv, double ch)
Definition: aeval.c:76
request_frame
static int request_frame(AVFilterLink *outlink)
Definition: af_ladspa.c:233
AVFILTER_FLAG_DYNAMIC_INPUTS
#define AVFILTER_FLAG_DYNAMIC_INPUTS
The number of the filter inputs is not determined just by AVFilter.inputs.
Definition: avfilter.h:110
AV_CH_LAYOUT_STEREO
#define AV_CH_LAYOUT_STEREO
Definition: channel_layout.h:91
LADSPAContext::plugin
char * plugin
Definition: af_ladspa.c:40
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:50
LADSPAContext::out_pad
int out_pad
Definition: af_ladspa.c:68
avassert.h
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
av_cold
#define av_cold
Definition: attributes.h:90
inputs
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
Definition: filter_design.txt:243
duration
int64_t duration
Definition: movenc.c:64
ff_add_channel_layout
int ff_add_channel_layout(AVFilterChannelLayouts **l, uint64_t channel_layout)
Definition: formats.c:426
s
#define s(width, name)
Definition: cbs_vp9.c:257
LADSPAContext::sample_rate
int sample_rate
Definition: af_ladspa.c:63
AVFrame::channels
int channels
number of audio channels, only used for audio.
Definition: frame.h:592
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
av_strtok
char * av_strtok(char *s, const char *delim, char **saveptr)
Split the string into several tokens which can be accessed by successive calls to av_strtok().
Definition: avstring.c:186
ff_set_common_formats_from_list
int ff_set_common_formats_from_list(AVFilterContext *ctx, const int *fmts)
Equivalent to ff_set_common_formats(ctx, ff_make_format_list(fmts))
Definition: formats.c:705
av_assert0
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
outputs
static const AVFilterPad outputs[]
Definition: af_acontrast.c:172
LADSPAContext::dl_handle
void * dl_handle
Definition: af_ladspa.c:42
AV_LOG_DEBUG
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:201
ctx
AVFormatContext * ctx
Definition: movenc.c:48
LADSPAContext::ipmap
unsigned long * ipmap
Definition: af_ladspa.c:45
link
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 link
Definition: filter_design.txt:23
arg
const char * arg
Definition: jacosubdec.c:67
if
if(ret)
Definition: filter_design.txt:179
av_sscanf
int av_sscanf(const char *string, const char *format,...)
See libc sscanf manual for more information.
Definition: avsscanf.c:960
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
LADSPAContext::ictlv
LADSPA_Data * ictlv
Definition: af_ladspa.c:49
NULL
#define NULL
Definition: coverity.c:32
av_frame_copy_props
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:537
LADSPAContext::in_trim
int in_trim
Definition: af_ladspa.c:67
AVRational
Rational number (pair of numerator and denominator).
Definition: rational.h:58
ff_append_inpad_free_name
int ff_append_inpad_free_name(AVFilterContext *f, AVFilterPad *p)
Definition: avfilter.c:144
OFFSET
#define OFFSET(x)
Definition: af_ladspa.c:72
count_ports
static void count_ports(const LADSPA_Descriptor *desc, unsigned long *nb_inputs, unsigned long *nb_outputs)
Definition: af_ladspa.c:384
AVFilterPad::filter_frame
int(* filter_frame)(AVFilterLink *link, AVFrame *frame)
Filtering callback.
Definition: internal.h:105
config_input
static int config_input(AVFilterLink *inlink)
Definition: af_ladspa.c:350
ff_set_common_all_channel_counts
int ff_set_common_all_channel_counts(AVFilterContext *ctx)
Equivalent to ff_set_common_channel_layouts(ctx, ff_all_channel_counts())
Definition: formats.c:671
exp
int8_t exp
Definition: eval.c:72
LADSPAContext::ocmap
unsigned long * ocmap
Definition: af_ladspa.c:55
print_ctl_info
static void print_ctl_info(AVFilterContext *ctx, int level, LADSPAContext *s, int ctl, unsigned long *map, LADSPA_Data *values, int print)
Definition: af_ladspa.c:109
AVFilterPad::config_props
int(* config_props)(AVFilterLink *link)
Link configuration callback.
Definition: internal.h:130
options
const OptionDef options[]
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:117
LADSPAContext::nb_inputcontrols
unsigned long nb_inputcontrols
Definition: af_ladspa.c:47
set_control
static int set_control(AVFilterContext *ctx, unsigned long port, LADSPA_Data value)
Definition: af_ladspa.c:416
AVFrame::sample_rate
int sample_rate
Sample rate of the audio data.
Definition: frame.h:458
print
static void print(AVTreeNode *t, int depth)
Definition: tree.c:44
LADSPAContext::dl_name
char * dl_name
Definition: af_ladspa.c:39
AV_SAMPLE_FMT_NONE
@ AV_SAMPLE_FMT_NONE
Definition: samplefmt.h:59
av_frame_is_writable
int av_frame_is_writable(AVFrame *frame)
Check if the frame data is writable.
Definition: frame.c:473
AVERROR_EXTERNAL
#define AVERROR_EXTERNAL
Generic error in an external library.
Definition: error.h:59
offset
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf offset
Definition: writing_filters.txt:86
AV_LOG_INFO
#define AV_LOG_INFO
Standard information.
Definition: log.h:191
sample_rates
sample_rates
Definition: ffmpeg_filter.c:156
internal.h
AVFrame::nb_samples
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:369
query_formats
static int query_formats(AVFilterContext *ctx)
Definition: af_ladspa.c:655
lrintf
#define lrintf(x)
Definition: libm_mips.h:72
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:271
LADSPAContext::latency
int latency
Definition: af_ladspa.c:69
AV_TIME_BASE
#define AV_TIME_BASE
Internal time base represented as integer.
Definition: avutil.h:254
AVFrame::extended_data
uint8_t ** extended_data
pointers to the data planes/channels.
Definition: frame.h:350
AVSampleFormat
AVSampleFormat
Audio sample formats.
Definition: samplefmt.h:58
value
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf default value
Definition: writing_filters.txt:86
FFMIN
#define FFMIN(a, b)
Definition: macros.h:49
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:56
av_rescale
int64_t av_rescale(int64_t a, int64_t b, int64_t c)
Rescale a 64-bit integer with rounding to nearest.
Definition: mathematics.c:128
av_calloc
void * av_calloc(size_t nmemb, size_t size)
Definition: mem.c:271
AVFilter
Filter definition.
Definition: avfilter.h:149
ret
ret
Definition: filter_design.txt:187
AVFilterPad::type
enum AVMediaType type
AVFilterPad type.
Definition: internal.h:61
frame
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 the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:264
FF_COUNT2LAYOUT
#define FF_COUNT2LAYOUT(c)
Encode a channel count as a channel layout.
Definition: formats.h:102
ff_af_ladspa
const AVFilter ff_af_ladspa
Definition: af_ladspa.c:774
LADSPAContext::duration
int64_t duration
Definition: af_ladspa.c:66
channel_layout.h
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:224
avfilter.h
values
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 the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return values
Definition: filter_design.txt:263
AVFilterContext
An instance of a filter.
Definition: avfilter.h:386
find_latency
static int find_latency(AVFilterContext *ctx, LADSPAContext *s)
Definition: af_ladspa.c:94
av_strdup
char * av_strdup(const char *s)
Duplicate a string.
Definition: mem.c:279
set_default_ctl_value
static void set_default_ctl_value(LADSPAContext *s, int ctl, unsigned long *map, LADSPA_Data *values)
Definition: af_ladspa.c:279
desc
const char * desc
Definition: libsvtav1.c:79
audio.h
LADSPAContext::octlv
LADSPA_Data * octlv
Definition: af_ladspa.c:56
LADSPAContext::opmap
unsigned long * opmap
Definition: af_ladspa.c:52
map
const VDPAUPixFmtMap * map
Definition: hwcontext_vdpau.c:71
av_free
#define av_free(p)
Definition: tableprint_vlc.h:34
ladspa_options
static const AVOption ladspa_options[]
Definition: af_ladspa.c:74
AV_OPT_TYPE_BOOL
@ AV_OPT_TYPE_BOOL
Definition: opt.h:241
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:192
ladspa_outputs
static const AVFilterPad ladspa_outputs[]
Definition: af_ladspa.c:765
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:35
FLAGS
#define FLAGS
Definition: af_ladspa.c:73
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
h
h
Definition: vp9dsp_template.c:2038
AVERROR_EXIT
#define AVERROR_EXIT
Immediate exit was requested; the called function should not be restarted.
Definition: error.h:58
avstring.h
AV_OPT_TYPE_STRING
@ AV_OPT_TYPE_STRING
Definition: opt.h:228
init
static av_cold int init(AVFilterContext *ctx)
Definition: af_ladspa.c:450
LADSPAContext::pts
int64_t pts
Definition: af_ladspa.c:65
LADSPAContext::nb_outputcontrols
unsigned long nb_outputcontrols
Definition: af_ladspa.c:54
av_x_if_null
static void * av_x_if_null(const void *p, const void *x)
Return x default pointer in case p is NULL.
Definition: avutil.h:308
LADSPAContext::nb_samples
int nb_samples
Definition: af_ladspa.c:64
ff_set_common_channel_layouts
int ff_set_common_channel_layouts(AVFilterContext *ctx, AVFilterChannelLayouts *channel_layouts)
Helpers for query_formats() which set all free audio links to the same list of channel layouts/sample...
Definition: formats.c:658