lavfi: Drop deprecated non-const filter retrieval
[ffmpeg.git] / libavfilter / avfilter.c
1 /*
2  * filter layer
3  * Copyright (c) 2007 Bobby Bingham
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #include "libavutil/avassert.h"
23 #include "libavutil/avstring.h"
24 #include "libavutil/buffer.h"
25 #include "libavutil/channel_layout.h"
26 #include "libavutil/common.h"
27 #include "libavutil/hwcontext.h"
28 #include "libavutil/imgutils.h"
29 #include "libavutil/internal.h"
30 #include "libavutil/opt.h"
31 #include "libavutil/pixdesc.h"
32 #include "libavutil/rational.h"
33 #include "libavutil/samplefmt.h"
34
35 #include "audio.h"
36 #include "avfilter.h"
37 #include "formats.h"
38 #include "internal.h"
39 #include "video.h"
40
41 unsigned avfilter_version(void)
42 {
43     return LIBAVFILTER_VERSION_INT;
44 }
45
46 const char *avfilter_configuration(void)
47 {
48     return LIBAV_CONFIGURATION;
49 }
50
51 const char *avfilter_license(void)
52 {
53 #define LICENSE_PREFIX "libavfilter license: "
54     return LICENSE_PREFIX LIBAV_LICENSE + sizeof(LICENSE_PREFIX) - 1;
55 }
56
57 void ff_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
58                    AVFilterPad **pads, AVFilterLink ***links,
59                    AVFilterPad *newpad)
60 {
61     unsigned i;
62
63     idx = FFMIN(idx, *count);
64
65     *pads  = av_realloc(*pads,  sizeof(AVFilterPad)   * (*count + 1));
66     *links = av_realloc(*links, sizeof(AVFilterLink*) * (*count + 1));
67     memmove(*pads  + idx + 1, *pads  + idx, sizeof(AVFilterPad)   * (*count - idx));
68     memmove(*links + idx + 1, *links + idx, sizeof(AVFilterLink*) * (*count - idx));
69     memcpy(*pads + idx, newpad, sizeof(AVFilterPad));
70     (*links)[idx] = NULL;
71
72     (*count)++;
73     for (i = idx + 1; i < *count; i++)
74         if (*links[i])
75             (*(unsigned *)((uint8_t *) *links[i] + padidx_off))++;
76 }
77
78 int avfilter_link(AVFilterContext *src, unsigned srcpad,
79                   AVFilterContext *dst, unsigned dstpad)
80 {
81     AVFilterLink *link;
82
83     if (src->nb_outputs <= srcpad || dst->nb_inputs <= dstpad ||
84         src->outputs[srcpad]      || dst->inputs[dstpad])
85         return AVERROR(EINVAL);
86
87     if (src->output_pads[srcpad].type != dst->input_pads[dstpad].type) {
88         av_log(src, AV_LOG_ERROR,
89                "Media type mismatch between the '%s' filter output pad %d and the '%s' filter input pad %d\n",
90                src->name, srcpad, dst->name, dstpad);
91         return AVERROR(EINVAL);
92     }
93
94     link = av_mallocz(sizeof(*link));
95     if (!link)
96         return AVERROR(ENOMEM);
97
98     src->outputs[srcpad] = dst->inputs[dstpad] = link;
99
100     link->src     = src;
101     link->dst     = dst;
102     link->srcpad  = &src->output_pads[srcpad];
103     link->dstpad  = &dst->input_pads[dstpad];
104     link->type    = src->output_pads[srcpad].type;
105     assert(AV_PIX_FMT_NONE == -1 && AV_SAMPLE_FMT_NONE == -1);
106     link->format  = -1;
107
108     return 0;
109 }
110
111 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
112                            unsigned filt_srcpad_idx, unsigned filt_dstpad_idx)
113 {
114     int ret;
115     unsigned dstpad_idx = link->dstpad - link->dst->input_pads;
116
117     av_log(link->dst, AV_LOG_VERBOSE, "auto-inserting filter '%s' "
118            "between the filter '%s' and the filter '%s'\n",
119            filt->name, link->src->name, link->dst->name);
120
121     link->dst->inputs[dstpad_idx] = NULL;
122     if ((ret = avfilter_link(filt, filt_dstpad_idx, link->dst, dstpad_idx)) < 0) {
123         /* failed to link output filter to new filter */
124         link->dst->inputs[dstpad_idx] = link;
125         return ret;
126     }
127
128     /* re-hookup the link to the new destination filter we inserted */
129     link->dst                     = filt;
130     link->dstpad                  = &filt->input_pads[filt_srcpad_idx];
131     filt->inputs[filt_srcpad_idx] = link;
132
133     /* if any information on supported media formats already exists on the
134      * link, we need to preserve that */
135     if (link->out_formats)
136         ff_formats_changeref(&link->out_formats,
137                              &filt->outputs[filt_dstpad_idx]->out_formats);
138     if (link->out_samplerates)
139         ff_formats_changeref(&link->out_samplerates,
140                              &filt->outputs[filt_dstpad_idx]->out_samplerates);
141     if (link->out_channel_layouts)
142         ff_channel_layouts_changeref(&link->out_channel_layouts,
143                                      &filt->outputs[filt_dstpad_idx]->out_channel_layouts);
144
145     return 0;
146 }
147
148 int avfilter_config_links(AVFilterContext *filter)
149 {
150     int (*config_link)(AVFilterLink *);
151     unsigned i;
152     int ret;
153
154     for (i = 0; i < filter->nb_inputs; i ++) {
155         AVFilterLink *link = filter->inputs[i];
156
157         if (!link) continue;
158         if (!link->src || !link->dst) {
159             av_log(filter, AV_LOG_ERROR,
160                    "Not all input and output are properly linked (%d).\n", i);
161             return AVERROR(EINVAL);
162         }
163
164         switch (link->init_state) {
165         case AVLINK_INIT:
166             continue;
167         case AVLINK_STARTINIT:
168             av_log(filter, AV_LOG_INFO, "circular filter chain detected\n");
169             return 0;
170         case AVLINK_UNINIT:
171             link->init_state = AVLINK_STARTINIT;
172
173             if ((ret = avfilter_config_links(link->src)) < 0)
174                 return ret;
175
176             if (!(config_link = link->srcpad->config_props)) {
177                 if (link->src->nb_inputs != 1) {
178                     av_log(link->src, AV_LOG_ERROR, "Source filters and filters "
179                                                     "with more than one input "
180                                                     "must set config_props() "
181                                                     "callbacks on all outputs\n");
182                     return AVERROR(EINVAL);
183                 }
184             } else if ((ret = config_link(link)) < 0) {
185                 av_log(link->src, AV_LOG_ERROR,
186                        "Failed to configure output pad on %s\n",
187                        link->src->name);
188                 return ret;
189             }
190
191             if (link->time_base.num == 0 && link->time_base.den == 0)
192                 link->time_base = link->src->nb_inputs ?
193                     link->src->inputs[0]->time_base : AV_TIME_BASE_Q;
194
195             if (link->type == AVMEDIA_TYPE_VIDEO) {
196                 if (!link->sample_aspect_ratio.num && !link->sample_aspect_ratio.den)
197                     link->sample_aspect_ratio = link->src->nb_inputs ?
198                         link->src->inputs[0]->sample_aspect_ratio : (AVRational){1,1};
199
200                 if (link->src->nb_inputs) {
201                     if (!link->frame_rate.num && !link->frame_rate.den)
202                         link->frame_rate = link->src->inputs[0]->frame_rate;
203                     if (!link->w)
204                         link->w = link->src->inputs[0]->w;
205                     if (!link->h)
206                         link->h = link->src->inputs[0]->h;
207                 } else if (!link->w || !link->h) {
208                     av_log(link->src, AV_LOG_ERROR,
209                            "Video source filters must set their output link's "
210                            "width and height\n");
211                     return AVERROR(EINVAL);
212                 }
213             }
214
215             if (link->src->nb_inputs && link->src->inputs[0]->hw_frames_ctx &&
216                 !(link->src->filter->flags_internal & FF_FILTER_FLAG_HWFRAME_AWARE)) {
217                 av_assert0(!link->hw_frames_ctx &&
218                            "should not be set by non-hwframe-aware filter");
219                 link->hw_frames_ctx = av_buffer_ref(link->src->inputs[0]->hw_frames_ctx);
220                 if (!link->hw_frames_ctx)
221                     return AVERROR(ENOMEM);
222             }
223
224             if ((config_link = link->dstpad->config_props))
225                 if ((ret = config_link(link)) < 0) {
226                     av_log(link->dst, AV_LOG_ERROR,
227                            "Failed to configure input pad on %s\n",
228                            link->dst->name);
229                     return ret;
230                 }
231
232             link->init_state = AVLINK_INIT;
233         }
234     }
235
236     return 0;
237 }
238
239 void ff_dlog_link(void *ctx, AVFilterLink *link, int end)
240 {
241     if (link->type == AVMEDIA_TYPE_VIDEO) {
242         av_log(ctx, AV_LOG_TRACE,
243                 "link[%p s:%dx%d fmt:%-16s %-16s->%-16s]%s",
244                 link, link->w, link->h,
245                 av_get_pix_fmt_name(link->format),
246                 link->src ? link->src->filter->name : "",
247                 link->dst ? link->dst->filter->name : "",
248                 end ? "\n" : "");
249     } else {
250         char buf[128];
251         av_get_channel_layout_string(buf, sizeof(buf), -1, link->channel_layout);
252
253         av_log(ctx, AV_LOG_TRACE,
254                 "link[%p r:%d cl:%s fmt:%-16s %-16s->%-16s]%s",
255                 link, link->sample_rate, buf,
256                 av_get_sample_fmt_name(link->format),
257                 link->src ? link->src->filter->name : "",
258                 link->dst ? link->dst->filter->name : "",
259                 end ? "\n" : "");
260     }
261 }
262
263 int ff_request_frame(AVFilterLink *link)
264 {
265     FF_DPRINTF_START(NULL, request_frame); ff_dlog_link(NULL, link, 1);
266
267     if (link->srcpad->request_frame)
268         return link->srcpad->request_frame(link);
269     else if (link->src->inputs[0])
270         return ff_request_frame(link->src->inputs[0]);
271     else
272         return AVERROR(EINVAL);
273 }
274
275 int ff_poll_frame(AVFilterLink *link)
276 {
277     int i, min = INT_MAX;
278
279     if (link->srcpad->poll_frame)
280         return link->srcpad->poll_frame(link);
281
282     for (i = 0; i < link->src->nb_inputs; i++) {
283         int val;
284         if (!link->src->inputs[i])
285             return AVERROR(EINVAL);
286         val = ff_poll_frame(link->src->inputs[i]);
287         min = FFMIN(min, val);
288     }
289
290     return min;
291 }
292
293 static AVFilter *first_filter;
294
295 const AVFilter *avfilter_get_by_name(const char *name)
296 {
297     const AVFilter *f = NULL;
298
299     if (!name)
300         return NULL;
301
302     while ((f = avfilter_next(f)))
303         if (!strcmp(f->name, name))
304             return f;
305
306     return NULL;
307 }
308
309 int avfilter_register(AVFilter *filter)
310 {
311     AVFilter **f = &first_filter;
312     while (*f)
313         f = &(*f)->next;
314     *f = filter;
315     filter->next = NULL;
316     return 0;
317 }
318
319 const AVFilter *avfilter_next(const AVFilter *prev)
320 {
321     return prev ? prev->next : first_filter;
322 }
323
324 int avfilter_pad_count(const AVFilterPad *pads)
325 {
326     int count;
327
328     if (!pads)
329         return 0;
330
331     for (count = 0; pads->name; count++)
332         pads++;
333     return count;
334 }
335
336 static const char *filter_name(void *p)
337 {
338     AVFilterContext *filter = p;
339     return filter->filter->name;
340 }
341
342 static void *filter_child_next(void *obj, void *prev)
343 {
344     AVFilterContext *ctx = obj;
345     if (!prev && ctx->filter && ctx->filter->priv_class && ctx->priv)
346         return ctx->priv;
347     return NULL;
348 }
349
350 static const AVClass *filter_child_class_next(const AVClass *prev)
351 {
352     const AVFilter *f = NULL;
353
354     while (prev && (f = avfilter_next(f)))
355         if (f->priv_class == prev)
356             break;
357
358     while ((f = avfilter_next(f)))
359         if (f->priv_class)
360             return f->priv_class;
361
362     return NULL;
363 }
364
365 #define OFFSET(x) offsetof(AVFilterContext, x)
366 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM
367 static const AVOption avfilter_options[] = {
368     { "thread_type", "Allowed thread types", OFFSET(thread_type), AV_OPT_TYPE_FLAGS,
369         { .i64 = AVFILTER_THREAD_SLICE }, 0, INT_MAX, FLAGS, "thread_type" },
370         { "slice", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = AVFILTER_THREAD_SLICE }, .unit = "thread_type" },
371     { NULL },
372 };
373
374 static const AVClass avfilter_class = {
375     .class_name = "AVFilter",
376     .item_name  = filter_name,
377     .version    = LIBAVUTIL_VERSION_INT,
378     .child_next = filter_child_next,
379     .child_class_next = filter_child_class_next,
380     .option           = avfilter_options,
381 };
382
383 static int default_execute(AVFilterContext *ctx, avfilter_action_func *func, void *arg,
384                            int *ret, int nb_jobs)
385 {
386     int i;
387
388     for (i = 0; i < nb_jobs; i++) {
389         int r = func(ctx, arg, i, nb_jobs);
390         if (ret)
391             ret[i] = r;
392     }
393     return 0;
394 }
395
396 AVFilterContext *ff_filter_alloc(const AVFilter *filter, const char *inst_name)
397 {
398     AVFilterContext *ret;
399
400     if (!filter)
401         return NULL;
402
403     ret = av_mallocz(sizeof(AVFilterContext));
404     if (!ret)
405         return NULL;
406
407     ret->av_class = &avfilter_class;
408     ret->filter   = filter;
409     ret->name     = inst_name ? av_strdup(inst_name) : NULL;
410     if (filter->priv_size) {
411         ret->priv     = av_mallocz(filter->priv_size);
412         if (!ret->priv)
413             goto err;
414     }
415
416     av_opt_set_defaults(ret);
417     if (filter->priv_class) {
418         *(const AVClass**)ret->priv = filter->priv_class;
419         av_opt_set_defaults(ret->priv);
420     }
421
422     ret->internal = av_mallocz(sizeof(*ret->internal));
423     if (!ret->internal)
424         goto err;
425     ret->internal->execute = default_execute;
426
427     ret->nb_inputs = avfilter_pad_count(filter->inputs);
428     if (ret->nb_inputs ) {
429         ret->input_pads   = av_malloc(sizeof(AVFilterPad) * ret->nb_inputs);
430         if (!ret->input_pads)
431             goto err;
432         memcpy(ret->input_pads, filter->inputs, sizeof(AVFilterPad) * ret->nb_inputs);
433         ret->inputs       = av_mallocz(sizeof(AVFilterLink*) * ret->nb_inputs);
434         if (!ret->inputs)
435             goto err;
436     }
437
438     ret->nb_outputs = avfilter_pad_count(filter->outputs);
439     if (ret->nb_outputs) {
440         ret->output_pads  = av_malloc(sizeof(AVFilterPad) * ret->nb_outputs);
441         if (!ret->output_pads)
442             goto err;
443         memcpy(ret->output_pads, filter->outputs, sizeof(AVFilterPad) * ret->nb_outputs);
444         ret->outputs      = av_mallocz(sizeof(AVFilterLink*) * ret->nb_outputs);
445         if (!ret->outputs)
446             goto err;
447     }
448
449     return ret;
450
451 err:
452     av_freep(&ret->inputs);
453     av_freep(&ret->input_pads);
454     ret->nb_inputs = 0;
455     av_freep(&ret->outputs);
456     av_freep(&ret->output_pads);
457     ret->nb_outputs = 0;
458     av_freep(&ret->priv);
459     av_freep(&ret->internal);
460     av_free(ret);
461     return NULL;
462 }
463
464 static void free_link(AVFilterLink *link)
465 {
466     if (!link)
467         return;
468
469     if (link->src)
470         link->src->outputs[link->srcpad - link->src->output_pads] = NULL;
471     if (link->dst)
472         link->dst->inputs[link->dstpad - link->dst->input_pads] = NULL;
473
474     av_buffer_unref(&link->hw_frames_ctx);
475
476     ff_formats_unref(&link->in_formats);
477     ff_formats_unref(&link->out_formats);
478     ff_formats_unref(&link->in_samplerates);
479     ff_formats_unref(&link->out_samplerates);
480     ff_channel_layouts_unref(&link->in_channel_layouts);
481     ff_channel_layouts_unref(&link->out_channel_layouts);
482     av_freep(&link);
483 }
484
485 void avfilter_free(AVFilterContext *filter)
486 {
487     int i;
488
489     if (filter->graph)
490         ff_filter_graph_remove_filter(filter->graph, filter);
491
492     if (filter->filter->uninit)
493         filter->filter->uninit(filter);
494
495     for (i = 0; i < filter->nb_inputs; i++) {
496         free_link(filter->inputs[i]);
497     }
498     for (i = 0; i < filter->nb_outputs; i++) {
499         free_link(filter->outputs[i]);
500     }
501
502     if (filter->filter->priv_class)
503         av_opt_free(filter->priv);
504
505     av_buffer_unref(&filter->hw_device_ctx);
506
507     av_freep(&filter->name);
508     av_freep(&filter->input_pads);
509     av_freep(&filter->output_pads);
510     av_freep(&filter->inputs);
511     av_freep(&filter->outputs);
512     av_freep(&filter->priv);
513     av_freep(&filter->internal);
514     av_free(filter);
515 }
516
517 /* process a list of value1:value2:..., each value corresponding
518  * to subsequent AVOption, in the order they are declared */
519 static int process_unnamed_options(AVFilterContext *ctx, AVDictionary **options,
520                                    const char *args)
521 {
522     const AVOption *o = NULL;
523     const char *p = args;
524     char *val;
525
526     while (*p) {
527         o = av_opt_next(ctx->priv, o);
528         if (!o) {
529             av_log(ctx, AV_LOG_ERROR, "More options provided than "
530                    "this filter supports.\n");
531             return AVERROR(EINVAL);
532         }
533         if (o->type == AV_OPT_TYPE_CONST)
534             continue;
535
536         val = av_get_token(&p, ":");
537         if (!val)
538             return AVERROR(ENOMEM);
539
540         av_dict_set(options, o->name, val, 0);
541
542         av_freep(&val);
543         if (*p)
544             p++;
545     }
546
547     return 0;
548 }
549
550 int avfilter_init_dict(AVFilterContext *ctx, AVDictionary **options)
551 {
552     int ret = 0;
553
554     ret = av_opt_set_dict(ctx, options);
555     if (ret < 0) {
556         av_log(ctx, AV_LOG_ERROR, "Error applying generic filter options.\n");
557         return ret;
558     }
559
560     if (ctx->filter->flags & AVFILTER_FLAG_SLICE_THREADS &&
561         ctx->thread_type & ctx->graph->thread_type & AVFILTER_THREAD_SLICE &&
562         ctx->graph->internal->thread_execute) {
563         ctx->thread_type       = AVFILTER_THREAD_SLICE;
564         ctx->internal->execute = ctx->graph->internal->thread_execute;
565     } else {
566         ctx->thread_type = 0;
567     }
568
569     if (ctx->filter->priv_class) {
570         ret = av_opt_set_dict(ctx->priv, options);
571         if (ret < 0) {
572             av_log(ctx, AV_LOG_ERROR, "Error applying options to the filter.\n");
573             return ret;
574         }
575     }
576
577     if (ctx->filter->init)
578         ret = ctx->filter->init(ctx);
579     else if (ctx->filter->init_dict)
580         ret = ctx->filter->init_dict(ctx, options);
581
582     return ret;
583 }
584
585 int avfilter_init_str(AVFilterContext *filter, const char *args)
586 {
587     AVDictionary *options = NULL;
588     AVDictionaryEntry *e;
589     int ret = 0;
590
591     if (args && *args) {
592         if (!filter->filter->priv_class) {
593             av_log(filter, AV_LOG_ERROR, "This filter does not take any "
594                    "options, but options were provided: %s.\n", args);
595             return AVERROR(EINVAL);
596         }
597
598         if (strchr(args, '=')) {
599             /* assume a list of key1=value1:key2=value2:... */
600             ret = av_dict_parse_string(&options, args, "=", ":", 0);
601             if (ret < 0)
602                 goto fail;
603         } else {
604             ret = process_unnamed_options(filter, &options, args);
605             if (ret < 0)
606                 goto fail;
607         }
608     }
609
610     ret = avfilter_init_dict(filter, &options);
611     if (ret < 0)
612         goto fail;
613
614     if ((e = av_dict_get(options, "", NULL, AV_DICT_IGNORE_SUFFIX))) {
615         av_log(filter, AV_LOG_ERROR, "No such option: %s.\n", e->key);
616         ret = AVERROR_OPTION_NOT_FOUND;
617         goto fail;
618     }
619
620 fail:
621     av_dict_free(&options);
622
623     return ret;
624 }
625
626 const char *avfilter_pad_get_name(const AVFilterPad *pads, int pad_idx)
627 {
628     return pads[pad_idx].name;
629 }
630
631 enum AVMediaType avfilter_pad_get_type(const AVFilterPad *pads, int pad_idx)
632 {
633     return pads[pad_idx].type;
634 }
635
636 static int default_filter_frame(AVFilterLink *link, AVFrame *frame)
637 {
638     return ff_filter_frame(link->dst->outputs[0], frame);
639 }
640
641 int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
642 {
643     int (*filter_frame)(AVFilterLink *, AVFrame *);
644     AVFilterPad *dst = link->dstpad;
645     AVFrame *out = NULL;
646     int ret;
647
648     FF_DPRINTF_START(NULL, filter_frame);
649     ff_dlog_link(NULL, link, 1);
650
651     if (!(filter_frame = dst->filter_frame))
652         filter_frame = default_filter_frame;
653
654     /* copy the frame if needed */
655     if (dst->needs_writable && !av_frame_is_writable(frame)) {
656         av_log(link->dst, AV_LOG_DEBUG, "Copying data in avfilter.\n");
657
658         switch (link->type) {
659         case AVMEDIA_TYPE_VIDEO:
660             out = ff_get_video_buffer(link, link->w, link->h);
661             break;
662         case AVMEDIA_TYPE_AUDIO:
663             out = ff_get_audio_buffer(link, frame->nb_samples);
664             break;
665         default:
666             ret = AVERROR(EINVAL);
667             goto fail;
668         }
669         if (!out) {
670             ret = AVERROR(ENOMEM);
671             goto fail;
672         }
673
674         ret = av_frame_copy_props(out, frame);
675         if (ret < 0)
676             goto fail;
677
678         switch (link->type) {
679         case AVMEDIA_TYPE_VIDEO:
680             av_image_copy(out->data, out->linesize, frame->data, frame->linesize,
681                           frame->format, frame->width, frame->height);
682             break;
683         case AVMEDIA_TYPE_AUDIO:
684             av_samples_copy(out->extended_data, frame->extended_data,
685                             0, 0, frame->nb_samples,
686                             av_get_channel_layout_nb_channels(frame->channel_layout),
687                             frame->format);
688             break;
689         default:
690             ret = AVERROR(EINVAL);
691             goto fail;
692         }
693
694         av_frame_free(&frame);
695     } else
696         out = frame;
697
698     return filter_frame(link, out);
699
700 fail:
701     av_frame_free(&out);
702     av_frame_free(&frame);
703     return ret;
704 }
705
706 const AVClass *avfilter_get_class(void)
707 {
708     return &avfilter_class;
709 }