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