cosmetics: fix some typos
[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 FFmpeg.
7  *
8  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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_%s_%d", filt_name, index);
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 && strcmp((*links)->name, label))
193         links = &((*links)->next);
194
195     ret = *links;
196
197     if (ret)
198         *links = ret->next;
199
200     return ret;
201 }
202
203 static void insert_inout(AVFilterInOut **inouts, AVFilterInOut *element)
204 {
205     element->next = *inouts;
206     *inouts = element;
207 }
208
209 static int link_filter_inouts(AVFilterContext *filt_ctx,
210                               AVFilterInOut **curr_inputs,
211                               AVFilterInOut **open_inputs, void *log_ctx)
212 {
213     int pad = filt_ctx->input_count, ret;
214
215     while (pad--) {
216         AVFilterInOut *p = *curr_inputs;
217         if (!p) {
218             av_log(log_ctx, AV_LOG_ERROR,
219                    "Not enough inputs specified for the \"%s\" filter.\n",
220                    filt_ctx->filter->name);
221             return AVERROR(EINVAL);
222         }
223
224         *curr_inputs = (*curr_inputs)->next;
225
226         if (p->filter_ctx) {
227             if ((ret = link_filter(p->filter_ctx, p->pad_idx, filt_ctx, pad, log_ctx)) < 0)
228                 return ret;
229             av_free(p->name);
230             av_free(p);
231         } else {
232             p->filter_ctx = filt_ctx;
233             p->pad_idx = pad;
234             insert_inout(open_inputs, p);
235         }
236     }
237
238     if (*curr_inputs) {
239         av_log(log_ctx, AV_LOG_ERROR,
240                "Too many inputs specified for the \"%s\" filter.\n",
241                filt_ctx->filter->name);
242         return AVERROR(EINVAL);
243     }
244
245     pad = filt_ctx->output_count;
246     while (pad--) {
247         AVFilterInOut *currlinkn = av_mallocz(sizeof(AVFilterInOut));
248         if (!currlinkn)
249             return AVERROR(ENOMEM);
250         currlinkn->filter_ctx  = filt_ctx;
251         currlinkn->pad_idx = pad;
252         insert_inout(curr_inputs, currlinkn);
253     }
254
255     return 0;
256 }
257
258 static int parse_inputs(const char **buf, AVFilterInOut **curr_inputs,
259                         AVFilterInOut **open_outputs, void *log_ctx)
260 {
261     int pad = 0;
262
263     while (**buf == '[') {
264         char *name = parse_link_name(buf, log_ctx);
265         AVFilterInOut *match;
266
267         if (!name)
268             return AVERROR(EINVAL);
269
270         /* First check if the label is not in the open_outputs list */
271         match = extract_inout(name, open_outputs);
272
273         if (match) {
274             av_free(name);
275         } else {
276             /* Not in the list, so add it as an input */
277             if (!(match = av_mallocz(sizeof(AVFilterInOut))))
278                 return AVERROR(ENOMEM);
279             match->name    = name;
280             match->pad_idx = pad;
281         }
282
283         insert_inout(curr_inputs, match);
284
285         *buf += strspn(*buf, WHITESPACES);
286         pad++;
287     }
288
289     return pad;
290 }
291
292 static int parse_outputs(const char **buf, AVFilterInOut **curr_inputs,
293                          AVFilterInOut **open_inputs,
294                          AVFilterInOut **open_outputs, void *log_ctx)
295 {
296     int ret, pad = 0;
297
298     while (**buf == '[') {
299         char *name = parse_link_name(buf, log_ctx);
300         AVFilterInOut *match;
301
302         AVFilterInOut *input = *curr_inputs;
303         if (!input) {
304             av_log(log_ctx, AV_LOG_ERROR,
305                    "No output pad can be associated to link label '%s'.\n",
306                    name);
307             return AVERROR(EINVAL);
308         }
309         *curr_inputs = (*curr_inputs)->next;
310
311         if (!name)
312             return AVERROR(EINVAL);
313
314         /* First check if the label is not in the open_inputs list */
315         match = extract_inout(name, open_inputs);
316
317         if (match) {
318             if ((ret = link_filter(input->filter_ctx, input->pad_idx,
319                                    match->filter_ctx, match->pad_idx, log_ctx)) < 0)
320                 return ret;
321             av_free(match->name);
322             av_free(name);
323             av_free(match);
324             av_free(input);
325         } else {
326             /* Not in the list, so add the first input as a open_output */
327             input->name = name;
328             insert_inout(open_outputs, input);
329         }
330         *buf += strspn(*buf, WHITESPACES);
331         pad++;
332     }
333
334     return pad;
335 }
336
337 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
338                          AVFilterInOut **open_inputs_ptr, AVFilterInOut **open_outputs_ptr,
339                          void *log_ctx)
340 {
341     int index = 0, ret = 0;
342     char chr = 0;
343
344     AVFilterInOut *curr_inputs = NULL;
345     AVFilterInOut *open_inputs  = open_inputs_ptr  ? *open_inputs_ptr  : NULL;
346     AVFilterInOut *open_outputs = open_outputs_ptr ? *open_outputs_ptr : NULL;
347
348     do {
349         AVFilterContext *filter;
350         const char *filterchain = filters;
351         filters += strspn(filters, WHITESPACES);
352
353         if ((ret = parse_inputs(&filters, &curr_inputs, &open_outputs, log_ctx)) < 0)
354             goto end;
355
356         if ((ret = parse_filter(&filter, &filters, graph, index, log_ctx)) < 0)
357             goto end;
358
359         if (filter->input_count == 1 && !curr_inputs && !index) {
360             /* First input pad, assume it is "[in]" if not specified */
361             const char *tmp = "[in]";
362             if ((ret = parse_inputs(&tmp, &curr_inputs, &open_outputs, log_ctx)) < 0)
363                 goto end;
364         }
365
366         if ((ret = link_filter_inouts(filter, &curr_inputs, &open_inputs, log_ctx)) < 0)
367             goto end;
368
369         if ((ret = parse_outputs(&filters, &curr_inputs, &open_inputs, &open_outputs,
370                                  log_ctx)) < 0)
371             goto end;
372
373         filters += strspn(filters, WHITESPACES);
374         chr = *filters++;
375
376         if (chr == ';' && curr_inputs) {
377             av_log(log_ctx, AV_LOG_ERROR,
378                    "Invalid filterchain containing an unlabelled output pad: \"%s\"\n",
379                    filterchain);
380             ret = AVERROR(EINVAL);
381             goto end;
382         }
383         index++;
384     } while (chr == ',' || chr == ';');
385
386     if (chr) {
387         av_log(log_ctx, AV_LOG_ERROR,
388                "Unable to parse graph description substring: \"%s\"\n",
389                filters - 1);
390         ret = AVERROR(EINVAL);
391         goto end;
392     }
393
394     if (curr_inputs) {
395         /* Last output pad, assume it is "[out]" if not specified */
396         const char *tmp = "[out]";
397         if ((ret = parse_outputs(&tmp, &curr_inputs, &open_inputs, &open_outputs,
398                                  log_ctx)) < 0)
399             goto end;
400     }
401
402 end:
403     /* clear open_in/outputs only if not passed as parameters */
404     if (open_inputs_ptr) *open_inputs_ptr = open_inputs;
405     else avfilter_inout_free(&open_inputs);
406     if (open_outputs_ptr) *open_outputs_ptr = open_outputs;
407     else avfilter_inout_free(&open_outputs);
408     avfilter_inout_free(&curr_inputs);
409
410     if (ret < 0) {
411         for (; graph->filter_count > 0; graph->filter_count--)
412             avfilter_free(graph->filters[graph->filter_count - 1]);
413         av_freep(&graph->filters);
414     }
415     return ret;
416 }