lavfi: add avfilter_init_str() to replace avfilter_init_filter().
[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 <string.h>
24 #include <stdio.h>
25
26 #include "libavutil/avstring.h"
27 #include "libavutil/mem.h"
28 #include "avfilter.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     *filt_ctx = avfilter_graph_alloc_filter(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 AVERROR(ENOMEM);
117     }
118
119     if (!strcmp(filt_name, "scale") && args && !strstr(args, "flags") &&
120         ctx->scale_sws_opts) {
121         snprintf(tmp_args, sizeof(tmp_args), "%s:%s",
122                  args, ctx->scale_sws_opts);
123         args = tmp_args;
124     }
125
126     ret = avfilter_init_str(*filt_ctx, args);
127     if (ret < 0) {
128         av_log(log_ctx, AV_LOG_ERROR,
129                "Error initializing filter '%s' with args '%s'\n", filt_name, args);
130         return ret;
131     }
132
133     return 0;
134 }
135
136 /**
137  * Parse a string of the form FILTER_NAME[=PARAMS], and create a
138  * corresponding filter instance which is added to graph with
139  * create_filter().
140  *
141  * @param filt_ctx Pointer that is set to the created and configured filter
142  *                 context on success, set to NULL on failure.
143  * @param filt_ctx put here a pointer to the created filter context on
144  * success, NULL otherwise
145  * @param buf pointer to the buffer to parse, *buf will be updated to
146  * point to the char next after the parsed string
147  * @param index an index which is assigned to the created filter
148  * instance, and which is supposed to be unique for each filter
149  * instance added to the filtergraph
150  * @return 0 in case of success, a negative AVERROR code otherwise
151  */
152 static int parse_filter(AVFilterContext **filt_ctx, const char **buf, AVFilterGraph *graph,
153                         int index, void *log_ctx)
154 {
155     char *opts = NULL;
156     char *name = av_get_token(buf, "=,;[\n");
157     int ret;
158
159     if (**buf == '=') {
160         (*buf)++;
161         opts = av_get_token(buf, "[],;\n");
162     }
163
164     ret = create_filter(filt_ctx, graph, index, name, opts, log_ctx);
165     av_free(name);
166     av_free(opts);
167     return ret;
168 }
169
170 AVFilterInOut *avfilter_inout_alloc(void)
171 {
172     return av_mallocz(sizeof(AVFilterInOut));
173 }
174
175 void avfilter_inout_free(AVFilterInOut **inout)
176 {
177     while (*inout) {
178         AVFilterInOut *next = (*inout)->next;
179         av_freep(&(*inout)->name);
180         av_freep(inout);
181         *inout = next;
182     }
183 }
184
185 static AVFilterInOut *extract_inout(const char *label, AVFilterInOut **links)
186 {
187     AVFilterInOut *ret;
188
189     while (*links && (!(*links)->name || strcmp((*links)->name, label)))
190         links = &((*links)->next);
191
192     ret = *links;
193
194     if (ret) {
195         *links = ret->next;
196         ret->next = NULL;
197     }
198
199     return ret;
200 }
201
202 static void insert_inout(AVFilterInOut **inouts, AVFilterInOut *element)
203 {
204     element->next = *inouts;
205     *inouts = element;
206 }
207
208 static void append_inout(AVFilterInOut **inouts, AVFilterInOut **element)
209 {
210     while (*inouts && (*inouts)->next)
211         inouts = &((*inouts)->next);
212
213     if (!*inouts)
214         *inouts = *element;
215     else
216         (*inouts)->next = *element;
217     *element = NULL;
218 }
219
220 static int link_filter_inouts(AVFilterContext *filt_ctx,
221                               AVFilterInOut **curr_inputs,
222                               AVFilterInOut **open_inputs, void *log_ctx)
223 {
224     int pad, ret;
225
226     for (pad = 0; pad < filt_ctx->nb_inputs; pad++) {
227         AVFilterInOut *p = *curr_inputs;
228
229         if (p) {
230             *curr_inputs = (*curr_inputs)->next;
231             p->next = NULL;
232         } else if (!(p = av_mallocz(sizeof(*p))))
233             return AVERROR(ENOMEM);
234
235         if (p->filter_ctx) {
236             ret = link_filter(p->filter_ctx, p->pad_idx, filt_ctx, pad, log_ctx);
237             av_free(p->name);
238             av_free(p);
239             if (ret < 0)
240                 return ret;
241         } else {
242             p->filter_ctx = filt_ctx;
243             p->pad_idx = pad;
244             append_inout(open_inputs, &p);
245         }
246     }
247
248     if (*curr_inputs) {
249         av_log(log_ctx, AV_LOG_ERROR,
250                "Too many inputs specified for the \"%s\" filter.\n",
251                filt_ctx->filter->name);
252         return AVERROR(EINVAL);
253     }
254
255     pad = filt_ctx->nb_outputs;
256     while (pad--) {
257         AVFilterInOut *currlinkn = av_mallocz(sizeof(AVFilterInOut));
258         if (!currlinkn)
259             return AVERROR(ENOMEM);
260         currlinkn->filter_ctx  = filt_ctx;
261         currlinkn->pad_idx = pad;
262         insert_inout(curr_inputs, currlinkn);
263     }
264
265     return 0;
266 }
267
268 static int parse_inputs(const char **buf, AVFilterInOut **curr_inputs,
269                         AVFilterInOut **open_outputs, void *log_ctx)
270 {
271     AVFilterInOut *parsed_inputs = NULL;
272     int pad = 0;
273
274     while (**buf == '[') {
275         char *name = parse_link_name(buf, log_ctx);
276         AVFilterInOut *match;
277
278         if (!name)
279             return AVERROR(EINVAL);
280
281         /* First check if the label is not in the open_outputs list */
282         match = extract_inout(name, open_outputs);
283
284         if (match) {
285             av_free(name);
286         } else {
287             /* Not in the list, so add it as an input */
288             if (!(match = av_mallocz(sizeof(AVFilterInOut)))) {
289                 av_free(name);
290                 return AVERROR(ENOMEM);
291             }
292             match->name    = name;
293             match->pad_idx = pad;
294         }
295
296         append_inout(&parsed_inputs, &match);
297
298         *buf += strspn(*buf, WHITESPACES);
299         pad++;
300     }
301
302     append_inout(&parsed_inputs, curr_inputs);
303     *curr_inputs = parsed_inputs;
304
305     return pad;
306 }
307
308 static int parse_outputs(const char **buf, AVFilterInOut **curr_inputs,
309                          AVFilterInOut **open_inputs,
310                          AVFilterInOut **open_outputs, void *log_ctx)
311 {
312     int ret, pad = 0;
313
314     while (**buf == '[') {
315         char *name = parse_link_name(buf, log_ctx);
316         AVFilterInOut *match;
317
318         AVFilterInOut *input = *curr_inputs;
319
320         if (!name)
321             return AVERROR(EINVAL);
322
323         if (!input) {
324             av_log(log_ctx, AV_LOG_ERROR,
325                    "No output pad can be associated to link label '%s'.\n", name);
326             av_free(name);
327             return AVERROR(EINVAL);
328         }
329         *curr_inputs = (*curr_inputs)->next;
330
331         /* First check if the label is not in the open_inputs list */
332         match = extract_inout(name, open_inputs);
333
334         if (match) {
335             if ((ret = link_filter(input->filter_ctx, input->pad_idx,
336                                    match->filter_ctx, match->pad_idx, log_ctx)) < 0) {
337                 av_free(name);
338                 return ret;
339             }
340             av_free(match->name);
341             av_free(name);
342             av_free(match);
343             av_free(input);
344         } else {
345             /* Not in the list, so add the first input as a open_output */
346             input->name = name;
347             insert_inout(open_outputs, input);
348         }
349         *buf += strspn(*buf, WHITESPACES);
350         pad++;
351     }
352
353     return pad;
354 }
355
356 static int parse_sws_flags(const char **buf, AVFilterGraph *graph)
357 {
358     char *p = strchr(*buf, ';');
359
360     if (strncmp(*buf, "sws_flags=", 10))
361         return 0;
362
363     if (!p) {
364         av_log(graph, AV_LOG_ERROR, "sws_flags not terminated with ';'.\n");
365         return AVERROR(EINVAL);
366     }
367
368     *buf += 4;  // keep the 'flags=' part
369
370     av_freep(&graph->scale_sws_opts);
371     if (!(graph->scale_sws_opts = av_mallocz(p - *buf + 1)))
372         return AVERROR(ENOMEM);
373     av_strlcpy(graph->scale_sws_opts, *buf, p - *buf + 1);
374
375     *buf = p + 1;
376     return 0;
377 }
378
379 int avfilter_graph_parse2(AVFilterGraph *graph, const char *filters,
380                           AVFilterInOut **inputs,
381                           AVFilterInOut **outputs)
382 {
383     int index = 0, ret;
384     char chr = 0;
385
386     AVFilterInOut *curr_inputs = NULL, *open_inputs = NULL, *open_outputs = NULL;
387
388     filters += strspn(filters, WHITESPACES);
389
390     if ((ret = parse_sws_flags(&filters, graph)) < 0)
391         goto fail;
392
393     do {
394         AVFilterContext *filter;
395         filters += strspn(filters, WHITESPACES);
396
397         if ((ret = parse_inputs(&filters, &curr_inputs, &open_outputs, graph)) < 0)
398             goto fail;
399
400         if ((ret = parse_filter(&filter, &filters, graph, index, graph)) < 0)
401             goto fail;
402
403
404         if ((ret = link_filter_inouts(filter, &curr_inputs, &open_inputs, graph)) < 0)
405             goto fail;
406
407         if ((ret = parse_outputs(&filters, &curr_inputs, &open_inputs, &open_outputs,
408                                  graph)) < 0)
409             goto fail;
410
411         filters += strspn(filters, WHITESPACES);
412         chr = *filters++;
413
414         if (chr == ';' && curr_inputs)
415             append_inout(&open_outputs, &curr_inputs);
416         index++;
417     } while (chr == ',' || chr == ';');
418
419     if (chr) {
420         av_log(graph, AV_LOG_ERROR,
421                "Unable to parse graph description substring: \"%s\"\n",
422                filters - 1);
423         ret = AVERROR(EINVAL);
424         goto fail;
425     }
426
427     append_inout(&open_outputs, &curr_inputs);
428
429     *inputs  = open_inputs;
430     *outputs = open_outputs;
431     return 0;
432
433  fail:
434     while (graph->nb_filters)
435         avfilter_free(graph->filters[0]);
436     av_freep(&graph->filters);
437     avfilter_inout_free(&open_inputs);
438     avfilter_inout_free(&open_outputs);
439     avfilter_inout_free(&curr_inputs);
440
441     *inputs  = NULL;
442     *outputs = NULL;
443
444     return ret;
445 }
446
447 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
448                          AVFilterInOut *open_inputs,
449                          AVFilterInOut *open_outputs, void *log_ctx)
450 {
451     int ret;
452     AVFilterInOut *cur, *match, *inputs = NULL, *outputs = NULL;
453
454     if ((ret = avfilter_graph_parse2(graph, filters, &inputs, &outputs)) < 0)
455         goto fail;
456
457     /* First input can be omitted if it is "[in]" */
458     if (inputs && !inputs->name)
459         inputs->name = av_strdup("in");
460     for (cur = inputs; cur; cur = cur->next) {
461         if (!cur->name) {
462               av_log(log_ctx, AV_LOG_ERROR,
463                      "Not enough inputs specified for the \"%s\" filter.\n",
464                      cur->filter_ctx->filter->name);
465               ret = AVERROR(EINVAL);
466               goto fail;
467         }
468         if (!(match = extract_inout(cur->name, &open_outputs)))
469             continue;
470         ret = avfilter_link(match->filter_ctx, match->pad_idx,
471                             cur->filter_ctx,   cur->pad_idx);
472         avfilter_inout_free(&match);
473         if (ret < 0)
474             goto fail;
475     }
476
477     /* Last output can be omitted if it is "[out]" */
478     if (outputs && !outputs->name)
479         outputs->name = av_strdup("out");
480     for (cur = outputs; cur; cur = cur->next) {
481         if (!cur->name) {
482             av_log(log_ctx, AV_LOG_ERROR,
483                    "Invalid filterchain containing an unlabelled output pad: \"%s\"\n",
484                    filters);
485             ret = AVERROR(EINVAL);
486             goto fail;
487         }
488         if (!(match = extract_inout(cur->name, &open_inputs)))
489             continue;
490         ret = avfilter_link(cur->filter_ctx,   cur->pad_idx,
491                             match->filter_ctx, match->pad_idx);
492         avfilter_inout_free(&match);
493         if (ret < 0)
494             goto fail;
495     }
496
497  fail:
498     if (ret < 0) {
499         while (graph->nb_filters)
500             avfilter_free(graph->filters[0]);
501         av_freep(&graph->filters);
502     }
503     avfilter_inout_free(&inputs);
504     avfilter_inout_free(&outputs);
505     avfilter_inout_free(&open_inputs);
506     avfilter_inout_free(&open_outputs);
507     return ret;
508 }