graphparser: fix the order in which unlabeled input links are returned.
[ffmpeg.git] / libavfilter / graphparser.c
1 /*
2  * filter graph parser
3  * Copyright (c) 2008 Vitor Sessak
4  * Copyright (c) 2007 Bobby Bingham
5  *
6  * This file is part of Libav.
7  *
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.
12  *
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.
17  *
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
21  */
22
23 #include <ctype.h>
24 #include <string.h>
25
26 #include "libavutil/avstring.h"
27 #include "avfilter.h"
28 #include "avfiltergraph.h"
29
30 #define WHITESPACES " \n\t"
31
32 /**
33  * Link two filters together.
34  *
35  * @see avfilter_link()
36  */
37 static int link_filter(AVFilterContext *src, int srcpad,
38                        AVFilterContext *dst, int dstpad,
39                        void *log_ctx)
40 {
41     int ret;
42     if ((ret = avfilter_link(src, srcpad, dst, dstpad))) {
43         av_log(log_ctx, AV_LOG_ERROR,
44                "Cannot create the link %s:%d -> %s:%d\n",
45                src->filter->name, srcpad, dst->filter->name, dstpad);
46         return ret;
47     }
48
49     return 0;
50 }
51
52 /**
53  * Parse the name of a link, which has the format "[linkname]".
54  *
55  * @return a pointer (that need to be freed after use) to the name
56  * between parenthesis
57  */
58 static char *parse_link_name(const char **buf, void *log_ctx)
59 {
60     const char *start = *buf;
61     char *name;
62     (*buf)++;
63
64     name = av_get_token(buf, "]");
65
66     if (!name[0]) {
67         av_log(log_ctx, AV_LOG_ERROR,
68                "Bad (empty?) label found in the following: \"%s\".\n", start);
69         goto fail;
70     }
71
72     if (*(*buf)++ != ']') {
73         av_log(log_ctx, AV_LOG_ERROR,
74                "Mismatched '[' found in the following: \"%s\".\n", start);
75     fail:
76         av_freep(&name);
77     }
78
79     return name;
80 }
81
82 /**
83  * Create an instance of a filter, initialize and insert it in the
84  * filtergraph in *ctx.
85  *
86  * @param filt_ctx put here a filter context in case of successful creation and configuration, NULL otherwise.
87  * @param ctx the filtergraph context
88  * @param index an index which is supposed to be unique for each filter instance added to the filtergraph
89  * @param filt_name the name of the filter to create
90  * @param args the arguments provided to the filter during its initialization
91  * @param log_ctx the log context to use
92  * @return 0 in case of success, a negative AVERROR code otherwise
93  */
94 static int create_filter(AVFilterContext **filt_ctx, AVFilterGraph *ctx, int index,
95                          const char *filt_name, const char *args, void *log_ctx)
96 {
97     AVFilter *filt;
98     char inst_name[30];
99     char tmp_args[256];
100     int ret;
101
102     snprintf(inst_name, sizeof(inst_name), "Parsed filter %d %s", index, filt_name);
103
104     filt = avfilter_get_by_name(filt_name);
105
106     if (!filt) {
107         av_log(log_ctx, AV_LOG_ERROR,
108                "No such filter: '%s'\n", filt_name);
109         return AVERROR(EINVAL);
110     }
111
112     ret = avfilter_open(filt_ctx, filt, inst_name);
113     if (!*filt_ctx) {
114         av_log(log_ctx, AV_LOG_ERROR,
115                "Error creating filter '%s'\n", filt_name);
116         return ret;
117     }
118
119     if ((ret = avfilter_graph_add_filter(ctx, *filt_ctx)) < 0) {
120         avfilter_free(*filt_ctx);
121         return ret;
122     }
123
124     if (!strcmp(filt_name, "scale") && args && !strstr(args, "flags")) {
125         snprintf(tmp_args, sizeof(tmp_args), "%s:%s",
126                  args, ctx->scale_sws_opts);
127         args = tmp_args;
128     }
129
130     if ((ret = avfilter_init_filter(*filt_ctx, args, NULL)) < 0) {
131         av_log(log_ctx, AV_LOG_ERROR,
132                "Error initializing filter '%s' with args '%s'\n", filt_name, args);
133         return ret;
134     }
135
136     return 0;
137 }
138
139 /**
140  * Parse a string of the form FILTER_NAME[=PARAMS], and create a
141  * corresponding filter instance which is added to graph with
142  * create_filter().
143  *
144  * @param filt_ctx Pointer that is set to the created and configured filter
145  *                 context on success, set to NULL on failure.
146  * @param filt_ctx put here a pointer to the created filter context on
147  * success, NULL otherwise
148  * @param buf pointer to the buffer to parse, *buf will be updated to
149  * point to the char next after the parsed string
150  * @param index an index which is assigned to the created filter
151  * instance, and which is supposed to be unique for each filter
152  * instance added to the filtergraph
153  * @return 0 in case of success, a negative AVERROR code otherwise
154  */
155 static int parse_filter(AVFilterContext **filt_ctx, const char **buf, AVFilterGraph *graph,
156                         int index, void *log_ctx)
157 {
158     char *opts = NULL;
159     char *name = av_get_token(buf, "=,;[\n");
160     int ret;
161
162     if (**buf == '=') {
163         (*buf)++;
164         opts = av_get_token(buf, "[],;\n");
165     }
166
167     ret = create_filter(filt_ctx, graph, index, name, opts, log_ctx);
168     av_free(name);
169     av_free(opts);
170     return ret;
171 }
172
173 AVFilterInOut *avfilter_inout_alloc(void)
174 {
175     return av_mallocz(sizeof(AVFilterInOut));
176 }
177
178 void avfilter_inout_free(AVFilterInOut **inout)
179 {
180     while (*inout) {
181         AVFilterInOut *next = (*inout)->next;
182         av_freep(&(*inout)->name);
183         av_freep(inout);
184         *inout = next;
185     }
186 }
187
188 static AVFilterInOut *extract_inout(const char *label, AVFilterInOut **links)
189 {
190     AVFilterInOut *ret;
191
192     while (*links && (!(*links)->name || strcmp((*links)->name, label)))
193         links = &((*links)->next);
194
195     ret = *links;
196
197     if (ret) {
198         *links = ret->next;
199         ret->next = NULL;
200     }
201
202     return ret;
203 }
204
205 static void insert_inout(AVFilterInOut **inouts, AVFilterInOut *element)
206 {
207     element->next = *inouts;
208     *inouts = element;
209 }
210
211 static void append_inout(AVFilterInOut **inouts, AVFilterInOut **element)
212 {
213     while (*inouts && (*inouts)->next)
214         inouts = &((*inouts)->next);
215
216     if (!*inouts)
217         *inouts = *element;
218     else
219         (*inouts)->next = *element;
220     *element = NULL;
221 }
222
223 static int link_filter_inouts(AVFilterContext *filt_ctx,
224                               AVFilterInOut **curr_inputs,
225                               AVFilterInOut **open_inputs, void *log_ctx)
226 {
227     int pad, ret;
228
229     for (pad = 0; pad < filt_ctx->input_count; pad++) {
230         AVFilterInOut *p = *curr_inputs;
231
232         if (p)
233             *curr_inputs = (*curr_inputs)->next;
234         else if (!(p = av_mallocz(sizeof(*p))))
235             return AVERROR(ENOMEM);
236
237         if (p->filter_ctx) {
238             if ((ret = link_filter(p->filter_ctx, p->pad_idx, filt_ctx, pad, log_ctx)) < 0)
239                 return ret;
240             av_free(p->name);
241             av_free(p);
242         } else {
243             p->filter_ctx = filt_ctx;
244             p->pad_idx = pad;
245             append_inout(open_inputs, &p);
246         }
247     }
248
249     if (*curr_inputs) {
250         av_log(log_ctx, AV_LOG_ERROR,
251                "Too many inputs specified for the \"%s\" filter.\n",
252                filt_ctx->filter->name);
253         return AVERROR(EINVAL);
254     }
255
256     pad = filt_ctx->output_count;
257     while (pad--) {
258         AVFilterInOut *currlinkn = av_mallocz(sizeof(AVFilterInOut));
259         if (!currlinkn)
260             return AVERROR(ENOMEM);
261         currlinkn->filter_ctx  = filt_ctx;
262         currlinkn->pad_idx = pad;
263         insert_inout(curr_inputs, currlinkn);
264     }
265
266     return 0;
267 }
268
269 static int parse_inputs(const char **buf, AVFilterInOut **curr_inputs,
270                         AVFilterInOut **open_outputs, void *log_ctx)
271 {
272     AVFilterInOut *parsed_inputs = NULL;
273     int pad = 0;
274
275     while (**buf == '[') {
276         char *name = parse_link_name(buf, log_ctx);
277         AVFilterInOut *match;
278
279         if (!name)
280             return AVERROR(EINVAL);
281
282         /* First check if the label is not in the open_outputs list */
283         match = extract_inout(name, open_outputs);
284
285         if (match) {
286             av_free(name);
287         } else {
288             /* Not in the list, so add it as an input */
289             if (!(match = av_mallocz(sizeof(AVFilterInOut))))
290                 return AVERROR(ENOMEM);
291             match->name    = name;
292             match->pad_idx = pad;
293         }
294
295         append_inout(&parsed_inputs, &match);
296
297         *buf += strspn(*buf, WHITESPACES);
298         pad++;
299     }
300
301     append_inout(&parsed_inputs, curr_inputs);
302     *curr_inputs = parsed_inputs;
303
304     return pad;
305 }
306
307 static int parse_outputs(const char **buf, AVFilterInOut **curr_inputs,
308                          AVFilterInOut **open_inputs,
309                          AVFilterInOut **open_outputs, void *log_ctx)
310 {
311     int ret, pad = 0;
312
313     while (**buf == '[') {
314         char *name = parse_link_name(buf, log_ctx);
315         AVFilterInOut *match;
316
317         AVFilterInOut *input = *curr_inputs;
318         if (!input) {
319             av_log(log_ctx, AV_LOG_ERROR,
320                    "No output pad can be associated to link label '%s'.\n",
321                    name);
322             return AVERROR(EINVAL);
323         }
324         *curr_inputs = (*curr_inputs)->next;
325
326         if (!name)
327             return AVERROR(EINVAL);
328
329         /* First check if the label is not in the open_inputs list */
330         match = extract_inout(name, open_inputs);
331
332         if (match) {
333             if ((ret = link_filter(input->filter_ctx, input->pad_idx,
334                                    match->filter_ctx, match->pad_idx, log_ctx)) < 0)
335                 return ret;
336             av_free(match->name);
337             av_free(name);
338             av_free(match);
339             av_free(input);
340         } else {
341             /* Not in the list, so add the first input as a open_output */
342             input->name = name;
343             insert_inout(open_outputs, input);
344         }
345         *buf += strspn(*buf, WHITESPACES);
346         pad++;
347     }
348
349     return pad;
350 }
351
352 #if FF_API_GRAPH_AVCLASS
353 #define log_ctx graph
354 #else
355 #define log_ctx NULL
356 #endif
357
358 static int parse_sws_flags(const char **buf, AVFilterGraph *graph)
359 {
360     char *p = strchr(*buf, ';');
361
362     if (strncmp(*buf, "sws_flags=", 10))
363         return 0;
364
365     if (!p) {
366         av_log(log_ctx, AV_LOG_ERROR, "sws_flags not terminated with ';'.\n");
367         return AVERROR(EINVAL);
368     }
369
370     *buf += 4;  // keep the 'flags=' part
371
372     av_freep(&graph->scale_sws_opts);
373     if (!(graph->scale_sws_opts = av_mallocz(p - *buf + 1)))
374         return AVERROR(ENOMEM);
375     av_strlcpy(graph->scale_sws_opts, *buf, p - *buf + 1);
376
377     *buf = p + 1;
378     return 0;
379 }
380
381 int avfilter_graph_parse2(AVFilterGraph *graph, const char *filters,
382                           AVFilterInOut **inputs,
383                           AVFilterInOut **outputs)
384 {
385     int index = 0, ret;
386     char chr = 0;
387
388     AVFilterInOut *curr_inputs = NULL, *open_inputs = NULL, *open_outputs = NULL;
389
390     filters += strspn(filters, WHITESPACES);
391
392     if ((ret = parse_sws_flags(&filters, graph)) < 0)
393         goto fail;
394
395     do {
396         AVFilterContext *filter;
397         filters += strspn(filters, WHITESPACES);
398
399         if ((ret = parse_inputs(&filters, &curr_inputs, &open_outputs, log_ctx)) < 0)
400             goto fail;
401
402         if ((ret = parse_filter(&filter, &filters, graph, index, log_ctx)) < 0)
403             goto fail;
404
405
406         if ((ret = link_filter_inouts(filter, &curr_inputs, &open_inputs, log_ctx)) < 0)
407             goto fail;
408
409         if ((ret = parse_outputs(&filters, &curr_inputs, &open_inputs, &open_outputs,
410                                  log_ctx)) < 0)
411             goto fail;
412
413         filters += strspn(filters, WHITESPACES);
414         chr = *filters++;
415
416         if (chr == ';' && curr_inputs)
417             append_inout(&open_outputs, &curr_inputs);
418         index++;
419     } while (chr == ',' || chr == ';');
420
421     if (chr) {
422         av_log(log_ctx, AV_LOG_ERROR,
423                "Unable to parse graph description substring: \"%s\"\n",
424                filters - 1);
425         ret = AVERROR(EINVAL);
426         goto fail;
427     }
428
429     append_inout(&open_outputs, &curr_inputs);
430
431     *inputs  = open_inputs;
432     *outputs = open_outputs;
433     return 0;
434
435  fail:
436     for (; graph->filter_count > 0; graph->filter_count--)
437         avfilter_free(graph->filters[graph->filter_count - 1]);
438     av_freep(&graph->filters);
439     avfilter_inout_free(&open_inputs);
440     avfilter_inout_free(&open_outputs);
441     avfilter_inout_free(&curr_inputs);
442
443     *inputs  = NULL;
444     *outputs = NULL;
445
446     return ret;
447 }
448 #undef log_ctx
449
450 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
451                          AVFilterInOut *open_inputs,
452                          AVFilterInOut *open_outputs, void *log_ctx)
453 {
454     int ret;
455     AVFilterInOut *cur, *match, *inputs = NULL, *outputs = NULL;
456
457     if ((ret = avfilter_graph_parse2(graph, filters, &inputs, &outputs)) < 0)
458         goto fail;
459
460     /* First input can be omitted if it is "[in]" */
461     if (inputs && !inputs->name)
462         inputs->name = av_strdup("in");
463     for (cur = inputs; cur; cur = cur->next) {
464         if (!cur->name) {
465               av_log(log_ctx, AV_LOG_ERROR,
466                      "Not enough inputs specified for the \"%s\" filter.\n",
467                      cur->filter_ctx->filter->name);
468               ret = AVERROR(EINVAL);
469               goto fail;
470         }
471         if (!(match = extract_inout(cur->name, &open_outputs)))
472             continue;
473         ret = avfilter_link(match->filter_ctx, match->pad_idx,
474                             cur->filter_ctx,   cur->pad_idx);
475         avfilter_inout_free(&match);
476         if (ret < 0)
477             goto fail;
478     }
479
480     /* Last output can be omitted if it is "[out]" */
481     if (outputs && !outputs->name)
482         outputs->name = av_strdup("out");
483     for (cur = outputs; cur; cur = cur->next) {
484         if (!cur->name) {
485             av_log(log_ctx, AV_LOG_ERROR,
486                    "Invalid filterchain containing an unlabelled output pad: \"%s\"\n",
487                    filters);
488             ret = AVERROR(EINVAL);
489             goto fail;
490         }
491         if (!(match = extract_inout(cur->name, &open_inputs)))
492             continue;
493         ret = avfilter_link(cur->filter_ctx,   cur->pad_idx,
494                             match->filter_ctx, match->pad_idx);
495         avfilter_inout_free(&match);
496         if (ret < 0)
497             goto fail;
498     }
499
500  fail:
501     if (ret < 0) {
502         for (; graph->filter_count > 0; graph->filter_count--)
503             avfilter_free(graph->filters[graph->filter_count - 1]);
504         av_freep(&graph->filters);
505     }
506     avfilter_inout_free(&inputs);
507     avfilter_inout_free(&outputs);
508     avfilter_inout_free(&open_inputs);
509     avfilter_inout_free(&open_outputs);
510     return ret;
511 }