3 * Copyright (c) 2008 Vitor Sessak
4 * Copyright (c) 2007 Bobby Bingham
6 * This file is part of Libav.
8 * Libav is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * Libav is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with Libav; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27 #include "libavutil/avassert.h"
28 #include "libavutil/avstring.h"
29 #include "libavutil/channel_layout.h"
30 #include "libavutil/common.h"
31 #include "libavutil/internal.h"
32 #include "libavutil/log.h"
33 #include "libavutil/opt.h"
40 #define OFFSET(x) offsetof(AVFilterGraph, x)
41 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM
42 static const AVOption filtergraph_options[] = {
43 { "thread_type", "Allowed thread types", OFFSET(thread_type), AV_OPT_TYPE_FLAGS,
44 { .i64 = AVFILTER_THREAD_SLICE }, 0, INT_MAX, FLAGS, "thread_type" },
45 { "slice", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = AVFILTER_THREAD_SLICE }, .flags = FLAGS, .unit = "thread_type" },
46 { "threads", "Maximum number of threads", OFFSET(nb_threads),
47 AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, FLAGS },
51 static const AVClass filtergraph_class = {
52 .class_name = "AVFilterGraph",
53 .item_name = av_default_item_name,
54 .version = LIBAVUTIL_VERSION_INT,
55 .option = filtergraph_options,
59 void ff_graph_thread_free(AVFilterGraph *graph)
63 int ff_graph_thread_init(AVFilterGraph *graph)
65 graph->thread_type = 0;
66 graph->nb_threads = 1;
71 AVFilterGraph *avfilter_graph_alloc(void)
73 AVFilterGraph *ret = av_mallocz(sizeof(*ret));
77 ret->internal = av_mallocz(sizeof(*ret->internal));
83 ret->av_class = &filtergraph_class;
84 av_opt_set_defaults(ret);
89 void ff_filter_graph_remove_filter(AVFilterGraph *graph, AVFilterContext *filter)
92 for (i = 0; i < graph->nb_filters; i++) {
93 if (graph->filters[i] == filter) {
94 FFSWAP(AVFilterContext*, graph->filters[i],
95 graph->filters[graph->nb_filters - 1]);
102 void avfilter_graph_free(AVFilterGraph **graph)
107 while ((*graph)->nb_filters)
108 avfilter_free((*graph)->filters[0]);
110 ff_graph_thread_free(*graph);
112 av_freep(&(*graph)->scale_sws_opts);
113 av_freep(&(*graph)->resample_lavr_opts);
114 av_freep(&(*graph)->filters);
115 av_freep(&(*graph)->internal);
119 #if FF_API_AVFILTER_OPEN
120 int avfilter_graph_add_filter(AVFilterGraph *graph, AVFilterContext *filter)
122 AVFilterContext **filters = av_realloc(graph->filters,
123 sizeof(*filters) * (graph->nb_filters + 1));
125 return AVERROR(ENOMEM);
127 graph->filters = filters;
128 graph->filters[graph->nb_filters++] = filter;
131 FF_DISABLE_DEPRECATION_WARNINGS
132 graph->filter_count = graph->nb_filters;
133 FF_ENABLE_DEPRECATION_WARNINGS
136 filter->graph = graph;
142 int avfilter_graph_create_filter(AVFilterContext **filt_ctx, const AVFilter *filt,
143 const char *name, const char *args, void *opaque,
144 AVFilterGraph *graph_ctx)
148 *filt_ctx = avfilter_graph_alloc_filter(graph_ctx, filt, name);
150 return AVERROR(ENOMEM);
152 ret = avfilter_init_str(*filt_ctx, args);
160 avfilter_free(*filt_ctx);
165 AVFilterContext *avfilter_graph_alloc_filter(AVFilterGraph *graph,
166 const AVFilter *filter,
169 AVFilterContext **filters, *s;
171 if (graph->thread_type && !graph->internal->thread) {
172 int ret = ff_graph_thread_init(graph);
174 av_log(graph, AV_LOG_ERROR, "Error initializing threading.\n");
179 s = ff_filter_alloc(filter, name);
183 filters = av_realloc(graph->filters, sizeof(*filters) * (graph->nb_filters + 1));
189 graph->filters = filters;
190 graph->filters[graph->nb_filters++] = s;
193 FF_DISABLE_DEPRECATION_WARNINGS
194 graph->filter_count = graph->nb_filters;
195 FF_ENABLE_DEPRECATION_WARNINGS
204 * Check for the validity of graph.
206 * A graph is considered valid if all its input and output pads are
209 * @return 0 in case of success, a negative value otherwise
211 static int graph_check_validity(AVFilterGraph *graph, AVClass *log_ctx)
213 AVFilterContext *filt;
216 for (i = 0; i < graph->nb_filters; i++) {
217 filt = graph->filters[i];
219 for (j = 0; j < filt->nb_inputs; j++) {
220 if (!filt->inputs[j] || !filt->inputs[j]->src) {
221 av_log(log_ctx, AV_LOG_ERROR,
222 "Input pad \"%s\" for the filter \"%s\" of type \"%s\" not connected to any source\n",
223 filt->input_pads[j].name, filt->name, filt->filter->name);
224 return AVERROR(EINVAL);
228 for (j = 0; j < filt->nb_outputs; j++) {
229 if (!filt->outputs[j] || !filt->outputs[j]->dst) {
230 av_log(log_ctx, AV_LOG_ERROR,
231 "Output pad \"%s\" for the filter \"%s\" of type \"%s\" not connected to any destination\n",
232 filt->output_pads[j].name, filt->name, filt->filter->name);
233 return AVERROR(EINVAL);
242 * Configure all the links of graphctx.
244 * @return 0 in case of success, a negative value otherwise
246 static int graph_config_links(AVFilterGraph *graph, AVClass *log_ctx)
248 AVFilterContext *filt;
251 for (i = 0; i < graph->nb_filters; i++) {
252 filt = graph->filters[i];
254 if (!filt->nb_outputs) {
255 if ((ret = avfilter_config_links(filt)))
263 AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, char *name)
267 for (i = 0; i < graph->nb_filters; i++)
268 if (graph->filters[i]->name && !strcmp(name, graph->filters[i]->name))
269 return graph->filters[i];
274 static int query_formats(AVFilterGraph *graph, AVClass *log_ctx)
277 int scaler_count = 0, resampler_count = 0;
279 /* ask all the sub-filters for their supported media formats */
280 for (i = 0; i < graph->nb_filters; i++) {
281 if (graph->filters[i]->filter->query_formats)
282 graph->filters[i]->filter->query_formats(graph->filters[i]);
284 ff_default_query_formats(graph->filters[i]);
287 /* go through and merge as many format lists as possible */
288 for (i = 0; i < graph->nb_filters; i++) {
289 AVFilterContext *filter = graph->filters[i];
291 for (j = 0; j < filter->nb_inputs; j++) {
292 AVFilterLink *link = filter->inputs[j];
293 int convert_needed = 0;
298 if (link->in_formats != link->out_formats &&
299 !ff_merge_formats(link->in_formats,
302 if (link->type == AVMEDIA_TYPE_AUDIO) {
303 if (link->in_channel_layouts != link->out_channel_layouts &&
304 !ff_merge_channel_layouts(link->in_channel_layouts,
305 link->out_channel_layouts))
307 if (link->in_samplerates != link->out_samplerates &&
308 !ff_merge_samplerates(link->in_samplerates,
309 link->out_samplerates))
313 if (convert_needed) {
314 AVFilterContext *convert;
316 AVFilterLink *inlink, *outlink;
317 char scale_args[256];
320 /* couldn't merge format lists. auto-insert conversion filter */
321 switch (link->type) {
322 case AVMEDIA_TYPE_VIDEO:
323 if (!(filter = avfilter_get_by_name("scale"))) {
324 av_log(log_ctx, AV_LOG_ERROR, "'scale' filter "
325 "not present, cannot convert pixel formats.\n");
326 return AVERROR(EINVAL);
329 snprintf(inst_name, sizeof(inst_name), "auto-inserted scaler %d",
332 if ((ret = avfilter_graph_create_filter(&convert, filter,
333 inst_name, graph->scale_sws_opts, NULL,
337 case AVMEDIA_TYPE_AUDIO:
338 if (!(filter = avfilter_get_by_name("resample"))) {
339 av_log(log_ctx, AV_LOG_ERROR, "'resample' filter "
340 "not present, cannot convert audio formats.\n");
341 return AVERROR(EINVAL);
344 snprintf(inst_name, sizeof(inst_name), "auto-inserted resampler %d",
346 scale_args[0] = '\0';
347 if (graph->resample_lavr_opts)
348 snprintf(scale_args, sizeof(scale_args), "%s",
349 graph->resample_lavr_opts);
350 if ((ret = avfilter_graph_create_filter(&convert, filter,
351 inst_name, scale_args,
356 return AVERROR(EINVAL);
359 if ((ret = avfilter_insert_filter(link, convert, 0, 0)) < 0)
362 convert->filter->query_formats(convert);
363 inlink = convert->inputs[0];
364 outlink = convert->outputs[0];
365 if (!ff_merge_formats( inlink->in_formats, inlink->out_formats) ||
366 !ff_merge_formats(outlink->in_formats, outlink->out_formats))
367 ret |= AVERROR(ENOSYS);
368 if (inlink->type == AVMEDIA_TYPE_AUDIO &&
369 (!ff_merge_samplerates(inlink->in_samplerates,
370 inlink->out_samplerates) ||
371 !ff_merge_channel_layouts(inlink->in_channel_layouts,
372 inlink->out_channel_layouts)))
373 ret |= AVERROR(ENOSYS);
374 if (outlink->type == AVMEDIA_TYPE_AUDIO &&
375 (!ff_merge_samplerates(outlink->in_samplerates,
376 outlink->out_samplerates) ||
377 !ff_merge_channel_layouts(outlink->in_channel_layouts,
378 outlink->out_channel_layouts)))
379 ret |= AVERROR(ENOSYS);
382 av_log(log_ctx, AV_LOG_ERROR,
383 "Impossible to convert between the formats supported by the filter "
384 "'%s' and the filter '%s'\n", link->src->name, link->dst->name);
394 static int pick_format(AVFilterLink *link)
396 if (!link || !link->in_formats)
399 link->in_formats->nb_formats = 1;
400 link->format = link->in_formats->formats[0];
402 if (link->type == AVMEDIA_TYPE_AUDIO) {
403 if (!link->in_samplerates->nb_formats) {
404 av_log(link->src, AV_LOG_ERROR, "Cannot select sample rate for"
405 " the link between filters %s and %s.\n", link->src->name,
407 return AVERROR(EINVAL);
409 link->in_samplerates->nb_formats = 1;
410 link->sample_rate = link->in_samplerates->formats[0];
412 if (!link->in_channel_layouts->nb_channel_layouts) {
413 av_log(link->src, AV_LOG_ERROR, "Cannot select channel layout for"
414 "the link between filters %s and %s.\n", link->src->name,
416 return AVERROR(EINVAL);
418 link->in_channel_layouts->nb_channel_layouts = 1;
419 link->channel_layout = link->in_channel_layouts->channel_layouts[0];
422 ff_formats_unref(&link->in_formats);
423 ff_formats_unref(&link->out_formats);
424 ff_formats_unref(&link->in_samplerates);
425 ff_formats_unref(&link->out_samplerates);
426 ff_channel_layouts_unref(&link->in_channel_layouts);
427 ff_channel_layouts_unref(&link->out_channel_layouts);
432 #define REDUCE_FORMATS(fmt_type, list_type, list, var, nb, add_format) \
434 for (i = 0; i < filter->nb_inputs; i++) { \
435 AVFilterLink *link = filter->inputs[i]; \
438 if (!link->out_ ## list || link->out_ ## list->nb != 1) \
440 fmt = link->out_ ## list->var[0]; \
442 for (j = 0; j < filter->nb_outputs; j++) { \
443 AVFilterLink *out_link = filter->outputs[j]; \
446 if (link->type != out_link->type || \
447 out_link->in_ ## list->nb == 1) \
449 fmts = out_link->in_ ## list; \
451 if (!out_link->in_ ## list->nb) { \
452 add_format(&out_link->in_ ##list, fmt); \
456 for (k = 0; k < out_link->in_ ## list->nb; k++) \
457 if (fmts->var[k] == fmt) { \
458 fmts->var[0] = fmt; \
467 static int reduce_formats_on_filter(AVFilterContext *filter)
469 int i, j, k, ret = 0;
471 REDUCE_FORMATS(int, AVFilterFormats, formats, formats,
472 nb_formats, ff_add_format);
473 REDUCE_FORMATS(int, AVFilterFormats, samplerates, formats,
474 nb_formats, ff_add_format);
475 REDUCE_FORMATS(uint64_t, AVFilterChannelLayouts, channel_layouts,
476 channel_layouts, nb_channel_layouts, ff_add_channel_layout);
481 static void reduce_formats(AVFilterGraph *graph)
488 for (i = 0; i < graph->nb_filters; i++)
489 reduced |= reduce_formats_on_filter(graph->filters[i]);
493 static void swap_samplerates_on_filter(AVFilterContext *filter)
495 AVFilterLink *link = NULL;
499 for (i = 0; i < filter->nb_inputs; i++) {
500 link = filter->inputs[i];
502 if (link->type == AVMEDIA_TYPE_AUDIO &&
503 link->out_samplerates->nb_formats== 1)
506 if (i == filter->nb_inputs)
509 sample_rate = link->out_samplerates->formats[0];
511 for (i = 0; i < filter->nb_outputs; i++) {
512 AVFilterLink *outlink = filter->outputs[i];
513 int best_idx, best_diff = INT_MAX;
515 if (outlink->type != AVMEDIA_TYPE_AUDIO ||
516 outlink->in_samplerates->nb_formats < 2)
519 for (j = 0; j < outlink->in_samplerates->nb_formats; j++) {
520 int diff = abs(sample_rate - outlink->in_samplerates->formats[j]);
522 if (diff < best_diff) {
527 FFSWAP(int, outlink->in_samplerates->formats[0],
528 outlink->in_samplerates->formats[best_idx]);
532 static void swap_samplerates(AVFilterGraph *graph)
536 for (i = 0; i < graph->nb_filters; i++)
537 swap_samplerates_on_filter(graph->filters[i]);
540 #define CH_CENTER_PAIR (AV_CH_FRONT_LEFT_OF_CENTER | AV_CH_FRONT_RIGHT_OF_CENTER)
541 #define CH_FRONT_PAIR (AV_CH_FRONT_LEFT | AV_CH_FRONT_RIGHT)
542 #define CH_STEREO_PAIR (AV_CH_STEREO_LEFT | AV_CH_STEREO_RIGHT)
543 #define CH_WIDE_PAIR (AV_CH_WIDE_LEFT | AV_CH_WIDE_RIGHT)
544 #define CH_SIDE_PAIR (AV_CH_SIDE_LEFT | AV_CH_SIDE_RIGHT)
545 #define CH_DIRECT_PAIR (AV_CH_SURROUND_DIRECT_LEFT | AV_CH_SURROUND_DIRECT_RIGHT)
546 #define CH_BACK_PAIR (AV_CH_BACK_LEFT | AV_CH_BACK_RIGHT)
548 /* allowable substitutions for channel pairs when comparing layouts,
549 * ordered by priority for both values */
550 static const uint64_t ch_subst[][2] = {
551 { CH_FRONT_PAIR, CH_CENTER_PAIR },
552 { CH_FRONT_PAIR, CH_WIDE_PAIR },
553 { CH_FRONT_PAIR, AV_CH_FRONT_CENTER },
554 { CH_CENTER_PAIR, CH_FRONT_PAIR },
555 { CH_CENTER_PAIR, CH_WIDE_PAIR },
556 { CH_CENTER_PAIR, AV_CH_FRONT_CENTER },
557 { CH_WIDE_PAIR, CH_FRONT_PAIR },
558 { CH_WIDE_PAIR, CH_CENTER_PAIR },
559 { CH_WIDE_PAIR, AV_CH_FRONT_CENTER },
560 { AV_CH_FRONT_CENTER, CH_FRONT_PAIR },
561 { AV_CH_FRONT_CENTER, CH_CENTER_PAIR },
562 { AV_CH_FRONT_CENTER, CH_WIDE_PAIR },
563 { CH_SIDE_PAIR, CH_DIRECT_PAIR },
564 { CH_SIDE_PAIR, CH_BACK_PAIR },
565 { CH_SIDE_PAIR, AV_CH_BACK_CENTER },
566 { CH_BACK_PAIR, CH_DIRECT_PAIR },
567 { CH_BACK_PAIR, CH_SIDE_PAIR },
568 { CH_BACK_PAIR, AV_CH_BACK_CENTER },
569 { AV_CH_BACK_CENTER, CH_BACK_PAIR },
570 { AV_CH_BACK_CENTER, CH_DIRECT_PAIR },
571 { AV_CH_BACK_CENTER, CH_SIDE_PAIR },
574 static void swap_channel_layouts_on_filter(AVFilterContext *filter)
576 AVFilterLink *link = NULL;
579 for (i = 0; i < filter->nb_inputs; i++) {
580 link = filter->inputs[i];
582 if (link->type == AVMEDIA_TYPE_AUDIO &&
583 link->out_channel_layouts->nb_channel_layouts == 1)
586 if (i == filter->nb_inputs)
589 for (i = 0; i < filter->nb_outputs; i++) {
590 AVFilterLink *outlink = filter->outputs[i];
591 int best_idx = -1, best_score = INT_MIN, best_count_diff = INT_MAX;
593 if (outlink->type != AVMEDIA_TYPE_AUDIO ||
594 outlink->in_channel_layouts->nb_channel_layouts < 2)
597 for (j = 0; j < outlink->in_channel_layouts->nb_channel_layouts; j++) {
598 uint64_t in_chlayout = link->out_channel_layouts->channel_layouts[0];
599 uint64_t out_chlayout = outlink->in_channel_layouts->channel_layouts[j];
600 int in_channels = av_get_channel_layout_nb_channels(in_chlayout);
601 int out_channels = av_get_channel_layout_nb_channels(out_chlayout);
602 int count_diff = out_channels - in_channels;
603 int matched_channels, extra_channels;
606 /* channel substitution */
607 for (k = 0; k < FF_ARRAY_ELEMS(ch_subst); k++) {
608 uint64_t cmp0 = ch_subst[k][0];
609 uint64_t cmp1 = ch_subst[k][1];
610 if (( in_chlayout & cmp0) && (!(out_chlayout & cmp0)) &&
611 (out_chlayout & cmp1) && (!( in_chlayout & cmp1))) {
612 in_chlayout &= ~cmp0;
613 out_chlayout &= ~cmp1;
614 /* add score for channel match, minus a deduction for
615 having to do the substitution */
616 score += 10 * av_get_channel_layout_nb_channels(cmp1) - 2;
620 /* no penalty for LFE channel mismatch */
621 if ( (in_chlayout & AV_CH_LOW_FREQUENCY) &&
622 (out_chlayout & AV_CH_LOW_FREQUENCY))
624 in_chlayout &= ~AV_CH_LOW_FREQUENCY;
625 out_chlayout &= ~AV_CH_LOW_FREQUENCY;
627 matched_channels = av_get_channel_layout_nb_channels(in_chlayout &
629 extra_channels = av_get_channel_layout_nb_channels(out_chlayout &
631 score += 10 * matched_channels - 5 * extra_channels;
633 if (score > best_score ||
634 (count_diff < best_count_diff && score == best_score)) {
637 best_count_diff = count_diff;
640 av_assert0(best_idx >= 0);
641 FFSWAP(uint64_t, outlink->in_channel_layouts->channel_layouts[0],
642 outlink->in_channel_layouts->channel_layouts[best_idx]);
647 static void swap_channel_layouts(AVFilterGraph *graph)
651 for (i = 0; i < graph->nb_filters; i++)
652 swap_channel_layouts_on_filter(graph->filters[i]);
655 static void swap_sample_fmts_on_filter(AVFilterContext *filter)
657 AVFilterLink *link = NULL;
661 for (i = 0; i < filter->nb_inputs; i++) {
662 link = filter->inputs[i];
664 if (link->type == AVMEDIA_TYPE_AUDIO &&
665 link->out_formats->nb_formats == 1)
668 if (i == filter->nb_inputs)
671 format = link->out_formats->formats[0];
672 bps = av_get_bytes_per_sample(format);
674 for (i = 0; i < filter->nb_outputs; i++) {
675 AVFilterLink *outlink = filter->outputs[i];
676 int best_idx = -1, best_score = INT_MIN;
678 if (outlink->type != AVMEDIA_TYPE_AUDIO ||
679 outlink->in_formats->nb_formats < 2)
682 for (j = 0; j < outlink->in_formats->nb_formats; j++) {
683 int out_format = outlink->in_formats->formats[j];
684 int out_bps = av_get_bytes_per_sample(out_format);
687 if (av_get_packed_sample_fmt(out_format) == format ||
688 av_get_planar_sample_fmt(out_format) == format) {
693 /* for s32 and float prefer double to prevent loss of information */
694 if (bps == 4 && out_bps == 8) {
699 /* prefer closest higher or equal bps */
700 score = -abs(out_bps - bps);
704 if (score > best_score) {
709 av_assert0(best_idx >= 0);
710 FFSWAP(int, outlink->in_formats->formats[0],
711 outlink->in_formats->formats[best_idx]);
715 static void swap_sample_fmts(AVFilterGraph *graph)
719 for (i = 0; i < graph->nb_filters; i++)
720 swap_sample_fmts_on_filter(graph->filters[i]);
724 static int pick_formats(AVFilterGraph *graph)
728 for (i = 0; i < graph->nb_filters; i++) {
729 AVFilterContext *filter = graph->filters[i];
731 for (j = 0; j < filter->nb_inputs; j++)
732 if ((ret = pick_format(filter->inputs[j])) < 0)
734 for (j = 0; j < filter->nb_outputs; j++)
735 if ((ret = pick_format(filter->outputs[j])) < 0)
742 * Configure the formats of all the links in the graph.
744 static int graph_config_formats(AVFilterGraph *graph, AVClass *log_ctx)
748 /* find supported formats from sub-filters, and merge along links */
749 if ((ret = query_formats(graph, log_ctx)) < 0)
752 /* Once everything is merged, it's possible that we'll still have
753 * multiple valid media format choices. We try to minimize the amount
754 * of format conversion inside filters */
755 reduce_formats(graph);
757 /* for audio filters, ensure the best format, sample rate and channel layout
759 swap_sample_fmts(graph);
760 swap_samplerates(graph);
761 swap_channel_layouts(graph);
763 if ((ret = pick_formats(graph)) < 0)
769 static int graph_insert_fifos(AVFilterGraph *graph, AVClass *log_ctx)
775 for (i = 0; i < graph->nb_filters; i++) {
776 f = graph->filters[i];
778 for (j = 0; j < f->nb_inputs; j++) {
779 AVFilterLink *link = f->inputs[j];
780 AVFilterContext *fifo_ctx;
784 if (!link->dstpad->needs_fifo)
787 fifo = f->inputs[j]->type == AVMEDIA_TYPE_VIDEO ?
788 avfilter_get_by_name("fifo") :
789 avfilter_get_by_name("afifo");
791 snprintf(name, sizeof(name), "auto-inserted fifo %d", fifo_count++);
793 ret = avfilter_graph_create_filter(&fifo_ctx, fifo, name, NULL,
798 ret = avfilter_insert_filter(link, fifo_ctx, 0, 0);
807 int avfilter_graph_config(AVFilterGraph *graphctx, void *log_ctx)
811 if ((ret = graph_check_validity(graphctx, log_ctx)))
813 if ((ret = graph_insert_fifos(graphctx, log_ctx)) < 0)
815 if ((ret = graph_config_formats(graphctx, log_ctx)))
817 if ((ret = graph_config_links(graphctx, log_ctx)))