649355fb25a9d5331e378a12499886a7d33bef1b
[ffmpeg.git] / libavfilter / avfiltergraph.c
1 /*
2  * Filter graphs
3  * copyright (c) 2007 Bobby Bingham
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 #include <string.h>
23 #include <stddef.h>
24
25 #include "avstring.h"
26 #include "avfilter.h"
27 #include "avfiltergraph.h"
28
29 #include "allfilters.h"
30
31 typedef struct AVFilterGraph {
32     unsigned filter_count;
33     AVFilterContext **filters;
34
35     /** fake filter to handle links to internal filters */
36     AVFilterContext *link_filter;
37 } GraphContext;
38
39 typedef struct {
40     AVFilterContext *graph;
41 } GraphLinkContext;
42
43 static int link_init(AVFilterContext *ctx, const char *args, void *opaque)
44 {
45     GraphLinkContext *linkctx = ctx->priv;
46     linkctx->graph = opaque;
47     return !opaque;
48 }
49
50 /**
51  * Given the link between the dummy filter and an internal filter whose input
52  * is being exported outside the graph, this returns the externally visible
53  * link
54  */
55 static inline AVFilterLink *get_extern_input_link(AVFilterLink *link)
56 {
57     GraphLinkContext *lctx = link->src->priv;
58     return lctx->graph->inputs[link->srcpad];
59 }
60
61 /** query the formats supported by a filter providing input to the graph */
62 static int *link_in_query_formats(AVFilterLink *link)
63 {
64     AVFilterLink *link2 = get_extern_input_link(link);
65     int *(*query_formats)(AVFilterLink *);
66
67     if(!link2)
68         return avfilter_make_format_list(0);
69
70     if(!(query_formats = link2->src->output_pads[link2->srcpad].query_formats))
71         query_formats = avfilter_default_query_output_formats;
72
73     return query_formats(link2);
74 }
75
76 /** request a frame from a filter providing input to the graph */
77 static int link_in_request_frame(AVFilterLink *link)
78 {
79     AVFilterLink *link2 = get_extern_input_link(link);
80
81     if(!link2)
82         return -1;
83     return avfilter_request_frame(link2);
84 }
85
86 static int link_in_config_props(AVFilterLink *link)
87 {
88     AVFilterLink *link2 = get_extern_input_link(link);
89     int (*config_props)(AVFilterLink *);
90     int ret;
91
92     if(!link2)
93         return -1;
94     if(!(config_props = link2->src->output_pads[link2->srcpad].config_props))
95         config_props = avfilter_default_config_output_link;
96     ret = config_props(link2);
97
98     link->w = link2->w;
99     link->h = link2->h;
100
101     return ret;
102 }
103
104 /**
105  * Given the link between the dummy filter and an internal filter whose input
106  * is being exported outside the graph, this returns the externally visible
107  * link
108  */
109 static inline AVFilterLink *get_extern_output_link(AVFilterLink *link)
110 {
111     GraphLinkContext *lctx = link->dst->priv;
112     return lctx->graph->outputs[link->dstpad];
113 }
114
115 /** query the formats supported by a filter taking output from the graph */
116 static int *link_out_query_formats(AVFilterLink *link)
117 {
118     AVFilterLink *link2 = get_extern_output_link(link);
119
120     if(!link2)
121         return avfilter_make_format_list(0);
122
123     return link2->dst->input_pads[link2->dstpad].query_formats(link2);
124 }
125
126 static int link_out_config_props(AVFilterLink *link)
127 {
128     AVFilterLink *link2 = get_extern_output_link(link);
129     int (*config_props)(AVFilterLink *);
130
131     if(!link2)
132         return 0;
133
134     link2->w = link->w;
135     link2->h = link->h;
136
137     if(!(config_props = link2->dst->input_pads[link2->dstpad].config_props))
138         config_props = avfilter_default_config_input_link;
139     return config_props(link2);
140 }
141
142 static void link_out_start_frame(AVFilterLink *link, AVFilterPicRef *picref)
143 {
144     AVFilterLink *link2 = get_extern_output_link(link);
145
146     if(!link2)
147         avfilter_unref_pic(picref);
148     else
149         avfilter_start_frame(link2, picref);
150 }
151
152 static void link_out_end_frame(AVFilterLink *link)
153 {
154     AVFilterLink *link2 = get_extern_output_link(link);
155
156     if(link2)
157         avfilter_end_frame(link2);
158 }
159
160 static AVFilterPicRef *link_out_get_video_buffer(AVFilterLink *link, int perms)
161 {
162     AVFilterLink *link2 = get_extern_output_link(link);
163
164     if(!link2)
165         return NULL;
166     else
167         return avfilter_get_video_buffer(link2, perms);
168 }
169
170 static void link_out_draw_slice(AVFilterLink *link, int y, int height)
171 {
172     AVFilterLink *link2 = get_extern_output_link(link);
173
174     if(link2)
175         avfilter_draw_slice(link2, y, height);
176 }
177
178 /** dummy filter used to help export filters pads outside the graph */
179 static AVFilter vf_graph_dummy =
180 {
181     .name      = "graph_dummy",
182     .author    = "Bobby Bingham",
183
184     .priv_size = sizeof(GraphLinkContext),
185
186     .init      = link_init,
187
188     .inputs    = (AVFilterPad[]) {{ .name = NULL, }},
189     .outputs   = (AVFilterPad[]) {{ .name = NULL, }},
190 };
191
192 static AVFilterLink *get_intern_input_link(AVFilterLink *link)
193 {
194     GraphContext *graph = link->dst->priv;
195     return graph->link_filter->outputs[link->dstpad];
196 }
197
198 static void graph_in_start_frame(AVFilterLink *link, AVFilterPicRef *picref)
199 {
200     AVFilterLink *link2 = get_intern_input_link(link);
201     if(link2)
202         avfilter_start_frame(link2, picref);
203 }
204
205 static void graph_in_end_frame(AVFilterLink *link)
206 {
207     AVFilterLink *link2 = get_intern_input_link(link);
208     if(link2)
209         avfilter_end_frame(link2);
210 }
211
212 static AVFilterPicRef *graph_in_get_video_buffer(AVFilterLink *link, int perms)
213 {
214     AVFilterLink *link2 = get_intern_input_link(link);
215     if(link2)
216         return avfilter_get_video_buffer(link2, perms);
217     return NULL;
218 }
219
220 static void graph_in_draw_slice(AVFilterLink *link, int y, int height)
221 {
222     AVFilterLink *link2 = get_intern_input_link(link);
223     if(link2)
224         avfilter_draw_slice(link2, y, height);
225 }
226
227 static int *graph_in_query_formats(AVFilterLink *link)
228 {
229     AVFilterLink *link2 = get_intern_input_link(link);
230
231     if(!link2 || !link2->dst->input_pads[link2->dstpad].query_formats)
232         return avfilter_make_format_list(0);
233     return link2->dst->input_pads[link2->dstpad].query_formats(link2);
234 }
235
236 static int graph_in_config_props(AVFilterLink *link)
237 {
238     AVFilterLink *link2 = get_intern_input_link(link);
239     int (*config_props)(AVFilterLink *);
240
241     if(!link2)
242         return -1;
243
244     /* copy link properties over to the dummy internal link */
245     link2->w = link->w;
246     link2->h = link->h;
247     link2->format = link->format;
248
249     if(!(config_props = link2->dst->input_pads[link2->dstpad].config_props))
250         return 0;   /* FIXME? */
251         //config_props = avfilter_default_config_input_link;
252     return config_props(link2);
253 }
254
255 static AVFilterLink *get_intern_output_link(AVFilterLink *link)
256 {
257     GraphContext *graph = link->src->priv;
258     return graph->link_filter->inputs[link->srcpad];
259 }
260
261 static int *graph_out_query_formats(AVFilterLink *link)
262 {
263     AVFilterLink *link2 = get_intern_output_link(link);
264
265     if(!link2)
266         return avfilter_make_format_list(0);
267     if(!link2->src->output_pads[link2->srcpad].query_formats)
268         return avfilter_default_query_output_formats(link2);
269     return link2->src->output_pads[link2->srcpad].query_formats(link2);
270 }
271
272 static int graph_out_request_frame(AVFilterLink *link)
273 {
274     AVFilterLink *link2 = get_intern_output_link(link);
275
276     if(link2)
277         return avfilter_request_frame(link2);
278     return -1;
279 }
280
281 static int graph_out_config_props(AVFilterLink *link)
282 {
283     AVFilterLink *link2 = get_intern_output_link(link);
284     int (*config_props)(AVFilterLink *);
285     int ret;
286
287     if(!link2)
288         return 0;
289
290     link2->w = link->w;
291     link2->h = link->h;
292     link2->format = link->format;
293
294     if(!(config_props = link2->src->output_pads[link2->srcpad].config_props))
295         config_props = avfilter_default_config_output_link;
296     ret = config_props(link2);
297
298     link->w = link2->w;
299     link->h = link2->h;
300     link->format = link2->format;
301
302     return ret;
303 }
304
305 static int add_graph_input(AVFilterContext *gctx, AVFilterContext *filt, unsigned idx,
306                            char *name)
307 {
308     GraphContext *graph = gctx->priv;
309
310     AVFilterPad graph_inpad =
311     {
312         .name             = name,
313         .type             = AV_PAD_VIDEO,
314         .start_frame      = graph_in_start_frame,
315         .end_frame        = graph_in_end_frame,
316         .get_video_buffer = graph_in_get_video_buffer,
317         .draw_slice       = graph_in_draw_slice,
318         .query_formats    = graph_in_query_formats,
319         .config_props     = graph_in_config_props,
320         /* XXX */
321     };
322     AVFilterPad dummy_outpad =
323     {
324         .name          = NULL,          /* FIXME? */
325         .type          = AV_PAD_VIDEO,
326         .query_formats = link_in_query_formats,
327         .request_frame = link_in_request_frame,
328         .config_props  = link_in_config_props,
329     };
330
331     avfilter_insert_inpad (gctx, gctx->input_count, &graph_inpad);
332     avfilter_insert_outpad(graph->link_filter, graph->link_filter->output_count,
333                            &dummy_outpad);
334     return avfilter_link(graph->link_filter,
335                          graph->link_filter->output_count-1, filt, idx);
336 }
337
338 static int add_graph_output(AVFilterContext *gctx, AVFilterContext *filt, unsigned idx,
339                             char *name)
340 {
341     GraphContext *graph = gctx->priv;
342
343     AVFilterPad graph_outpad =
344     {
345         .name             = name,
346         .type             = AV_PAD_VIDEO,
347         .request_frame    = graph_out_request_frame,
348         .query_formats    = graph_out_query_formats,
349         .config_props     = graph_out_config_props,
350     };
351     AVFilterPad dummy_inpad =
352     {
353         .name             = NULL,          /* FIXME? */
354         .type             = AV_PAD_VIDEO,
355         .start_frame      = link_out_start_frame,
356         .end_frame        = link_out_end_frame,
357         .draw_slice       = link_out_draw_slice,
358         .get_video_buffer = link_out_get_video_buffer,
359         .query_formats    = link_out_query_formats,
360         .config_props     = link_out_config_props,
361     };
362
363     avfilter_insert_outpad(gctx, gctx->output_count, &graph_outpad);
364     avfilter_insert_inpad (graph->link_filter, graph->link_filter->input_count,
365                            &dummy_inpad);
366     return avfilter_link(filt, idx, graph->link_filter,
367                          graph->link_filter->input_count-1);
368 }
369
370 static void uninit(AVFilterContext *ctx)
371 {
372     GraphContext *graph = ctx->priv;
373
374     if(graph->link_filter) {
375         avfilter_destroy(graph->link_filter);
376         graph->link_filter = NULL;
377     }
378     for(; graph->filter_count > 0; graph->filter_count --)
379         avfilter_destroy(graph->filters[graph->filter_count - 1]);
380     av_freep(&graph->filters);
381 }
382
383 /* TODO: insert in sorted order */
384 void avfilter_graph_add_filter(AVFilterContext *graphctx, AVFilterContext *filter)
385 {
386     GraphContext *graph = graphctx->priv;
387
388     graph->filters = av_realloc(graph->filters,
389                                 sizeof(AVFilterContext*) * ++graph->filter_count);
390     graph->filters[graph->filter_count - 1] = filter;
391 }
392
393 /* search intelligently, once we insert in order */
394 AVFilterContext *avfilter_graph_get_filter(AVFilterContext *ctx, char *name)
395 {
396     GraphContext *graph = ctx->priv;
397     int i;
398
399     if(!name)
400         return NULL;
401
402     for(i = 0; i < graph->filter_count; i ++)
403         if(graph->filters[i]->name && !strcmp(name, graph->filters[i]->name))
404             return graph->filters[i];
405
406     return NULL;
407 }
408
409 int avfilter_graph_config_links(AVFilterContext *graphctx)
410 {
411     GraphContext *graph = graphctx->priv;
412     int i, j;
413
414     for(i = 0; i < graph->filter_count; i ++) {
415         for(j = 0; j < graph->filters[i]->input_count; j ++) {
416             /* ensure that graphs contained within graphs are configured */
417             if((graph->filters[i]->filter == &avfilter_vf_graph     ||
418                 graph->filters[i]->filter == &avfilter_vf_graphfile ||
419                 graph->filters[i]->filter == &avfilter_vf_graphdesc) &&
420                 avfilter_graph_config_links(graph->filters[i]))
421                 return -1;
422             if(avfilter_config_link(graph->filters[i]->inputs[j]))
423                 return -1;
424         }
425     }
426
427     return 0;
428 }
429
430 static AVFilterContext *create_filter_with_args(const char *filt, void *opaque)
431 {
432     AVFilterContext *ret;
433     char *filter = av_strdup(filt); /* copy - don't mangle the input string */
434     char *name, *args;
435
436     name = filter;
437     if((args = strchr(filter, '='))) {
438         /* ensure we at least have a name */
439         if(args == filter)
440             goto fail;
441
442         *args ++ = 0;
443     }
444
445     av_log(NULL, AV_LOG_INFO, "creating filter \"%s\" with args \"%s\"\n",
446            name, args ? args : "(none)");
447
448     if((ret = avfilter_open(avfilter_get_by_name(name), NULL))) {
449         if(avfilter_init_filter(ret, args, opaque)) {
450             av_log(NULL, AV_LOG_ERROR, "error initializing filter!\n");
451             avfilter_destroy(ret);
452             goto fail;
453         }
454     } else av_log(NULL, AV_LOG_ERROR, "error creating filter!\n");
455
456     av_free(filter);
457
458     return ret;
459
460 fail:
461     av_free(filter);
462     return NULL;
463 }
464
465 static int graph_load_chain(AVFilterContext *graphctx,
466                               unsigned count, char **filter_list, void **opaque,
467                               AVFilterContext **first, AVFilterContext **last)
468 {
469     unsigned i;
470     AVFilterContext *filters[2] = {NULL,NULL};
471
472     for(i = 0; i < count; i ++) {
473         void *op;
474
475         if(opaque) op = opaque[i];
476         else       op = NULL;
477
478         if(!(filters[1] = create_filter_with_args(filter_list[i], op)))
479             goto fail;
480         if(i == 0) {
481             if(first) *first = filters[1];
482         } else {
483             if(avfilter_link(filters[0], 0, filters[1], 0)) {
484                 av_log(NULL, AV_LOG_ERROR, "error linking filters!\n");
485                 goto fail;
486             }
487         }
488         avfilter_graph_add_filter(graphctx, filters[1]);
489         if(i == 0 && filters[1]->input_count > 0)
490             add_graph_input(graphctx, filters[1], 0, "default");
491         filters[0] = filters[1];
492     }
493
494     if(filters[1]->output_count > 0)
495         add_graph_output(graphctx, filters[1], 0, "default");
496
497     if(last) *last = filters[1];
498     return 0;
499
500 fail:
501     uninit(graphctx);
502     if(first) *first = NULL;
503     if(last)  *last  = NULL;
504     return -1;
505 }
506
507 static int graph_load_chain_from_string(AVFilterContext *ctx, const char *str,
508                                         AVFilterContext **first,
509                                         AVFilterContext **last)
510 {
511     int count, ret = 0;
512     char **strings;
513     char *filt;
514
515     strings    = av_malloc(sizeof(char *));
516     strings[0] = av_strdup(str);
517
518     filt = strchr(strings[0], ',');
519     for(count = 1; filt; count ++) {
520         if(filt == strings[count-1]) {
521             ret = -1;
522             goto done;
523         }
524
525         strings = av_realloc(strings, sizeof(char *) * (count+1));
526         strings[count] = filt + 1;
527         *filt = '\0';
528         filt = strchr(strings[count], ',');
529     }
530
531     ret = graph_load_chain(ctx, count, strings, NULL, first, last);
532
533 done:
534     av_free(strings[0]);
535     av_free(strings);
536
537     return ret;
538 }
539
540 static int init(AVFilterContext *ctx, const char *args, void *opaque)
541 {
542     GraphContext *gctx = ctx->priv;
543
544     if(!args)
545         return 0;
546
547     if(!(gctx->link_filter = avfilter_open(&vf_graph_dummy, NULL)))
548         return -1;
549     if(avfilter_init_filter(gctx->link_filter, NULL, ctx))
550         goto fail;
551
552     return graph_load_chain_from_string(ctx, args, NULL, NULL);
553
554 fail:
555     avfilter_destroy(gctx->link_filter);
556     return -1;
557 }
558
559 AVFilter avfilter_vf_graph =
560 {
561     .name      = "graph",
562     .author    = "Bobby Bingham",
563
564     .priv_size = sizeof(GraphContext),
565
566     .init      = init,
567     .uninit    = uninit,
568
569     .inputs    = (AVFilterPad[]) {{ .name = NULL, }},
570     .outputs   = (AVFilterPad[]) {{ .name = NULL, }},
571 };
572
573 static int graph_load_from_desc(AVFilterContext *ctx, AVFilterGraphDesc *desc)
574 {
575     AVFilterGraphDescFilter *curfilt;
576     AVFilterGraphDescLink   *curlink;
577     AVFilterGraphDescExport *curpad;
578     AVFilterContext *filt, *filtb;
579
580     AVFilter *filterdef;
581
582     /* create all filters */
583     for(curfilt = desc->filters; curfilt; curfilt = curfilt->next) {
584         if(!(filterdef = avfilter_get_by_name(curfilt->filter)) ||
585            !(filt = avfilter_open(filterdef, curfilt->name))) {
586             av_log(ctx, AV_LOG_ERROR, "error creating filter\n");
587             goto fail;
588         }
589         avfilter_graph_add_filter(ctx, filt);
590         if(avfilter_init_filter(filt, curfilt->args, NULL)) {
591             av_log(ctx, AV_LOG_ERROR, "error initializing filter\n");
592             goto fail;
593         }
594     }
595
596     /* create all links */
597     for(curlink = desc->links; curlink; curlink = curlink->next) {
598         if(!(filt = avfilter_graph_get_filter(ctx, curlink->src))) {
599             av_log(ctx, AV_LOG_ERROR, "link source does not exist in graph\n");
600             goto fail;
601         }
602         if(!(filtb = avfilter_graph_get_filter(ctx, curlink->dst))) {
603             av_log(ctx, AV_LOG_ERROR, "link destination does not exist in graph\n");
604             goto fail;
605         }
606         if(avfilter_link(filt, curlink->srcpad, filtb, curlink->dstpad)) {
607             av_log(ctx, AV_LOG_ERROR, "cannot create link between source and destination filters\n");
608             goto fail;
609         }
610     }
611
612     /* export all input pads */
613     for(curpad = desc->inputs; curpad; curpad = curpad->next) {
614         if(!(filt = avfilter_graph_get_filter(ctx, curpad->filter))) {
615             av_log(ctx, AV_LOG_ERROR, "filter owning exported pad does not exist\n");
616             goto fail;
617         }
618         add_graph_input(ctx, filt, curpad->pad, curpad->name);
619     }
620
621     /* export all output pads */
622     for(curpad = desc->outputs; curpad; curpad = curpad->next) {
623         if(!(filt = avfilter_graph_get_filter(ctx, curpad->filter))) {
624             av_log(ctx, AV_LOG_ERROR, "filter owning exported pad does not exist\n");
625             goto fail;
626         }
627         add_graph_output(ctx, filt, curpad->pad, curpad->name);
628     }
629
630     return 0;
631
632 fail:
633     uninit(ctx);
634     return -1;
635 }
636
637 static int init_desc(AVFilterContext *ctx, const char *args, void *opaque)
638 {
639     GraphContext *gctx = ctx->priv;
640
641     if(!opaque)
642         return -1;
643
644     if(!(gctx->link_filter = avfilter_open(&vf_graph_dummy, NULL)))
645         return -1;
646     if(avfilter_init_filter(gctx->link_filter, NULL, ctx))
647         goto fail;
648
649     return graph_load_from_desc(ctx, opaque);
650
651 fail:
652     avfilter_destroy(gctx->link_filter);
653     return -1;
654 }
655
656 AVFilter avfilter_vf_graphdesc =
657 {
658     .name      = "graph_desc",
659     .author    = "Bobby Bingham",
660
661     .priv_size = sizeof(GraphContext),
662
663     .init      = init_desc,
664     .uninit    = uninit,
665
666     .inputs    = (AVFilterPad[]) {{ .name = NULL, }},
667     .outputs   = (AVFilterPad[]) {{ .name = NULL, }},
668 };
669
670 static int init_file(AVFilterContext *ctx, const char *args, void *opaque)
671 {
672     AVFilterGraphDesc *desc;
673     int ret;
674
675     if(!args)
676         return -1;
677     if(!(desc = avfilter_graph_load_desc(args)))
678         return -1;
679
680     ret = init_desc(ctx, NULL, desc);
681     avfilter_graph_free_desc(desc);
682     return ret;
683 }
684
685 AVFilter avfilter_vf_graphfile =
686 {
687     .name      = "graph_file",
688     .author    = "Bobby Bingham",
689
690     .priv_size = sizeof(GraphContext),
691
692     .init      = init_file,
693     .uninit    = uninit,
694
695     .inputs    = (AVFilterPad[]) {{ .name = NULL, }},
696     .outputs   = (AVFilterPad[]) {{ .name = NULL, }},
697 };
698