graphparser: allow specifying sws flags in the graph description.
[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 static void free_inout(AVFilterInOut *head)
174 {
175     while (head) {
176         AVFilterInOut *next = head->next;
177         av_free(head->name);
178         av_free(head);
179         head = next;
180     }
181 }
182
183 static AVFilterInOut *extract_inout(const char *label, AVFilterInOut **links)
184 {
185     AVFilterInOut *ret;
186
187     while (*links && (!(*links)->name || strcmp((*links)->name, label)))
188         links = &((*links)->next);
189
190     ret = *links;
191
192     if (ret) {
193         *links = ret->next;
194         ret->next = NULL;
195     }
196
197     return ret;
198 }
199
200 static void insert_inout(AVFilterInOut **inouts, AVFilterInOut *element)
201 {
202     element->next = *inouts;
203     *inouts = element;
204 }
205
206 static void append_inout(AVFilterInOut **inouts, AVFilterInOut **element)
207 {
208     while (*inouts && (*inouts)->next)
209         inouts = &((*inouts)->next);
210
211     if (!*inouts)
212         *inouts = *element;
213     else
214         (*inouts)->next = *element;
215     *element = NULL;
216 }
217
218 static int link_filter_inouts(AVFilterContext *filt_ctx,
219                               AVFilterInOut **curr_inputs,
220                               AVFilterInOut **open_inputs, void *log_ctx)
221 {
222     int pad, ret;
223
224     for (pad = 0; pad < filt_ctx->input_count; pad++) {
225         AVFilterInOut *p = *curr_inputs;
226
227         if (p)
228             *curr_inputs = (*curr_inputs)->next;
229         else if (!(p = av_mallocz(sizeof(*p))))
230             return AVERROR(ENOMEM);
231
232         if (p->filter_ctx) {
233             if ((ret = link_filter(p->filter_ctx, p->pad_idx, filt_ctx, pad, log_ctx)) < 0)
234                 return ret;
235             av_free(p->name);
236             av_free(p);
237         } else {
238             p->filter_ctx = filt_ctx;
239             p->pad_idx = pad;
240             insert_inout(open_inputs, p);
241         }
242     }
243
244     if (*curr_inputs) {
245         av_log(log_ctx, AV_LOG_ERROR,
246                "Too many inputs specified for the \"%s\" filter.\n",
247                filt_ctx->filter->name);
248         return AVERROR(EINVAL);
249     }
250
251     pad = filt_ctx->output_count;
252     while (pad--) {
253         AVFilterInOut *currlinkn = av_mallocz(sizeof(AVFilterInOut));
254         if (!currlinkn)
255             return AVERROR(ENOMEM);
256         currlinkn->filter_ctx  = filt_ctx;
257         currlinkn->pad_idx = pad;
258         insert_inout(curr_inputs, currlinkn);
259     }
260
261     return 0;
262 }
263
264 static int parse_inputs(const char **buf, AVFilterInOut **curr_inputs,
265                         AVFilterInOut **open_outputs, void *log_ctx)
266 {
267     AVFilterInOut *parsed_inputs = NULL;
268     int pad = 0;
269
270     while (**buf == '[') {
271         char *name = parse_link_name(buf, log_ctx);
272         AVFilterInOut *match;
273
274         if (!name)
275             return AVERROR(EINVAL);
276
277         /* First check if the label is not in the open_outputs list */
278         match = extract_inout(name, open_outputs);
279
280         if (match) {
281             av_free(name);
282         } else {
283             /* Not in the list, so add it as an input */
284             if (!(match = av_mallocz(sizeof(AVFilterInOut))))
285                 return AVERROR(ENOMEM);
286             match->name    = name;
287             match->pad_idx = pad;
288         }
289
290         append_inout(&parsed_inputs, &match);
291
292         *buf += strspn(*buf, WHITESPACES);
293         pad++;
294     }
295
296     append_inout(&parsed_inputs, curr_inputs);
297     *curr_inputs = parsed_inputs;
298
299     return pad;
300 }
301
302 static int parse_outputs(const char **buf, AVFilterInOut **curr_inputs,
303                          AVFilterInOut **open_inputs,
304                          AVFilterInOut **open_outputs, void *log_ctx)
305 {
306     int ret, pad = 0;
307
308     while (**buf == '[') {
309         char *name = parse_link_name(buf, log_ctx);
310         AVFilterInOut *match;
311
312         AVFilterInOut *input = *curr_inputs;
313         if (!input) {
314             av_log(log_ctx, AV_LOG_ERROR,
315                    "No output pad can be associated to link label '%s'.\n",
316                    name);
317             return AVERROR(EINVAL);
318         }
319         *curr_inputs = (*curr_inputs)->next;
320
321         if (!name)
322             return AVERROR(EINVAL);
323
324         /* First check if the label is not in the open_inputs list */
325         match = extract_inout(name, open_inputs);
326
327         if (match) {
328             if ((ret = link_filter(input->filter_ctx, input->pad_idx,
329                                    match->filter_ctx, match->pad_idx, log_ctx)) < 0)
330                 return ret;
331             av_free(match->name);
332             av_free(name);
333             av_free(match);
334             av_free(input);
335         } else {
336             /* Not in the list, so add the first input as a open_output */
337             input->name = name;
338             insert_inout(open_outputs, input);
339         }
340         *buf += strspn(*buf, WHITESPACES);
341         pad++;
342     }
343
344     return pad;
345 }
346
347 #if FF_API_GRAPH_AVCLASS
348 #define log_ctx graph
349 #else
350 #define log_ctx NULL
351 #endif
352
353 static int parse_sws_flags(const char **buf, AVFilterGraph *graph)
354 {
355     char *p = strchr(*buf, ';');
356
357     if (strncmp(*buf, "sws_flags=", 10))
358         return 0;
359
360     if (!p) {
361         av_log(log_ctx, AV_LOG_ERROR, "sws_flags not terminated with ';'.\n");
362         return AVERROR(EINVAL);
363     }
364
365     *buf += 4;  // keep the 'flags=' part
366
367     av_freep(&graph->scale_sws_opts);
368     if (!(graph->scale_sws_opts = av_mallocz(p - *buf + 1)))
369         return AVERROR(ENOMEM);
370     av_strlcpy(graph->scale_sws_opts, *buf, p - *buf + 1);
371
372     *buf = p + 1;
373     return 0;
374 }
375
376 int avfilter_graph_parse2(AVFilterGraph *graph, const char *filters,
377                           AVFilterInOut **inputs,
378                           AVFilterInOut **outputs)
379 {
380     int index = 0, ret;
381     char chr = 0;
382
383     AVFilterInOut *curr_inputs = NULL, *open_inputs = NULL, *open_outputs = NULL;
384
385     filters += strspn(filters, WHITESPACES);
386
387     if ((ret = parse_sws_flags(&filters, graph)) < 0)
388         goto fail;
389
390     do {
391         AVFilterContext *filter;
392         filters += strspn(filters, WHITESPACES);
393
394         if ((ret = parse_inputs(&filters, &curr_inputs, &open_outputs, log_ctx)) < 0)
395             goto fail;
396
397         if ((ret = parse_filter(&filter, &filters, graph, index, log_ctx)) < 0)
398             goto fail;
399
400
401         if ((ret = link_filter_inouts(filter, &curr_inputs, &open_inputs, log_ctx)) < 0)
402             goto fail;
403
404         if ((ret = parse_outputs(&filters, &curr_inputs, &open_inputs, &open_outputs,
405                                  log_ctx)) < 0)
406             goto fail;
407
408         filters += strspn(filters, WHITESPACES);
409         chr = *filters++;
410
411         if (chr == ';' && curr_inputs)
412             append_inout(&open_outputs, &curr_inputs);
413         index++;
414     } while (chr == ',' || chr == ';');
415
416     if (chr) {
417         av_log(log_ctx, AV_LOG_ERROR,
418                "Unable to parse graph description substring: \"%s\"\n",
419                filters - 1);
420         ret = AVERROR(EINVAL);
421         goto fail;
422     }
423
424     append_inout(&open_outputs, &curr_inputs);
425
426     *inputs  = open_inputs;
427     *outputs = open_outputs;
428     return 0;
429
430  fail:
431     for (; graph->filter_count > 0; graph->filter_count--)
432         avfilter_free(graph->filters[graph->filter_count - 1]);
433     av_freep(&graph->filters);
434     free_inout(open_inputs);
435     free_inout(open_outputs);
436     free_inout(curr_inputs);
437
438     *inputs  = NULL;
439     *outputs = NULL;
440
441     return ret;
442 }
443 #undef log_ctx
444
445 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
446                          AVFilterInOut *open_inputs,
447                          AVFilterInOut *open_outputs, void *log_ctx)
448 {
449     int ret;
450     AVFilterInOut *cur, *match, *inputs = NULL, *outputs = NULL;
451
452     if ((ret = avfilter_graph_parse2(graph, filters, &inputs, &outputs)) < 0)
453         goto fail;
454
455     /* First input can be omitted if it is "[in]" */
456     if (inputs && !inputs->name)
457         inputs->name = av_strdup("in");
458     for (cur = inputs; cur; cur = cur->next) {
459         if (!cur->name) {
460               av_log(log_ctx, AV_LOG_ERROR,
461                      "Not enough inputs specified for the \"%s\" filter.\n",
462                      cur->filter_ctx->filter->name);
463               ret = AVERROR(EINVAL);
464               goto fail;
465         }
466         if (!(match = extract_inout(cur->name, &open_outputs)))
467             continue;
468         ret = avfilter_link(match->filter_ctx, match->pad_idx,
469                             cur->filter_ctx,   cur->pad_idx);
470         free_inout(match);
471         if (ret < 0)
472             goto fail;
473     }
474
475     /* Last output can be omitted if it is "[out]" */
476     if (outputs && !outputs->name)
477         outputs->name = av_strdup("out");
478     for (cur = outputs; cur; cur = cur->next) {
479         if (!cur->name) {
480             av_log(log_ctx, AV_LOG_ERROR,
481                    "Invalid filterchain containing an unlabelled output pad: \"%s\"\n",
482                    filters);
483             ret = AVERROR(EINVAL);
484             goto fail;
485         }
486         if (!(match = extract_inout(cur->name, &open_inputs)))
487             continue;
488         ret = avfilter_link(cur->filter_ctx,   cur->pad_idx,
489                             match->filter_ctx, match->pad_idx);
490         free_inout(match);
491         if (ret < 0)
492             goto fail;
493     }
494
495  fail:
496     if (ret < 0) {
497         for (; graph->filter_count > 0; graph->filter_count--)
498             avfilter_free(graph->filters[graph->filter_count - 1]);
499         av_freep(&graph->filters);
500     }
501     free_inout(inputs);
502     free_inout(outputs);
503     free_inout(open_inputs);
504     free_inout(open_outputs);
505     return ret;
506 }