These error messages should print the filter name, not the instance name
[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 "graphparser.h"
27 #include "avfilter.h"
28 #include "avfiltergraph.h"
29
30 static int link_filter(AVFilterContext *src, int srcpad,
31                        AVFilterContext *dst, int dstpad,
32                        AVClass *log_ctx)
33 {
34     if(avfilter_link(src, srcpad, dst, dstpad)) {
35         av_log(log_ctx, AV_LOG_ERROR,
36                "cannot create the link %s:%d -> %s:%d\n",
37                src->filter->name, srcpad, dst->filter->name, dstpad);
38         return -1;
39     }
40
41     return 0;
42 }
43
44 static int consume_whitespace(const char *buf)
45 {
46     return strspn(buf, " \n\t");
47 }
48
49 /**
50  * Consumes a string from *buf.
51  * @return a copy of the consumed string, which should be free'd after use
52  */
53 static char *consume_string(const char **buf)
54 {
55     char *out = av_malloc(strlen(*buf) + 1);
56     char *ret = out;
57
58     *buf += consume_whitespace(*buf);
59
60     do{
61         char c = *(*buf)++;
62         switch (c) {
63         case '\\':
64             *out++ = *(*buf)++;
65             break;
66         case '\'':
67             while(**buf && **buf != '\'')
68                 *out++ = *(*buf)++;
69             if(**buf) (*buf)++;
70             break;
71         case 0:
72         case ']':
73         case '[':
74         case '=':
75         case ',':
76         case ';':
77         case ' ':
78         case '\n':
79             *out++ = 0;
80             break;
81         default:
82             *out++ = c;
83         }
84     } while(out[-1]);
85
86     (*buf)--;
87     *buf += consume_whitespace(*buf);
88
89     return ret;
90 }
91
92 /**
93  * Parse "[linkname]"
94  * @param name a pointer (that need to be free'd after use) to the name between
95  *        parenthesis
96  */
97 static char *parse_link_name(const char **buf, AVClass *log_ctx)
98 {
99     const char *start = *buf;
100     char *name;
101     (*buf)++;
102
103     name = consume_string(buf);
104
105     if(!name[0]) {
106         av_log(log_ctx, AV_LOG_ERROR,
107                "Bad (empty?) label found in the following: \"%s\".\n", start);
108         goto fail;
109     }
110
111     if(*(*buf)++ != ']') {
112         av_log(log_ctx, AV_LOG_ERROR,
113                "Mismatched '[' found in the following: \"%s\".\n", start);
114     fail:
115         av_freep(&name);
116     }
117
118     return name;
119 }
120
121 static AVFilterContext *create_filter(AVFilterGraph *ctx, int index,
122                                       const char *name, const char *args,
123                                       AVClass *log_ctx)
124 {
125     AVFilterContext *filt;
126
127     AVFilter *filterdef;
128     char inst_name[30];
129
130     snprintf(inst_name, sizeof(inst_name), "Parsed filter %d", index);
131
132     filterdef = avfilter_get_by_name(name);
133
134     if(!filterdef) {
135         av_log(log_ctx, AV_LOG_ERROR,
136                "no such filter: '%s'\n", name);
137         return NULL;
138     }
139
140     filt = avfilter_open(filterdef, inst_name);
141     if(!filt) {
142         av_log(log_ctx, AV_LOG_ERROR,
143                "error creating filter '%s'\n", name);
144         return NULL;
145     }
146
147     if(avfilter_graph_add_filter(ctx, filt) < 0)
148         return NULL;
149
150     if(avfilter_init_filter(filt, args, NULL)) {
151         av_log(log_ctx, AV_LOG_ERROR,
152                "error initializing filter '%s' with args '%s'\n", name, args);
153         return NULL;
154     }
155
156     return filt;
157 }
158
159 /**
160  * Parse "filter=params"
161  */
162 static AVFilterContext *parse_filter(const char **buf, AVFilterGraph *graph,
163                                      int index, AVClass *log_ctx)
164 {
165     char *opts = NULL;
166     char *name = consume_string(buf);
167
168     if(**buf == '=') {
169         (*buf)++;
170         opts = consume_string(buf);
171     }
172
173     return create_filter(graph, index, name, opts, log_ctx);
174 }
175
176 static void free_inout(AVFilterInOut *head)
177 {
178     while(head) {
179         AVFilterInOut *next = head->next;
180         av_free(head);
181         head = next;
182     }
183 }
184
185 static AVFilterInOut *extract_inout(const char *label, AVFilterInOut **links)
186 {
187     AVFilterInOut *ret;
188
189     while(*links && strcmp((*links)->name, label))
190         links = &((*links)->next);
191
192     ret = *links;
193
194     if(ret)
195         *links = ret->next;
196
197     return ret;
198 }
199
200
201 static int link_filter_inouts(AVFilterContext *filter,
202                               AVFilterInOut **currInputs,
203                               AVFilterInOut **openLinks, AVClass *log_ctx)
204 {
205     int pad = 0;
206
207     pad = filter->input_count;
208     while(pad--) {
209         AVFilterInOut *p = *currInputs;
210         *currInputs = (*currInputs)->next;
211         if(!p) {
212             av_log(log_ctx, AV_LOG_ERROR,
213                    "Not enough inputs specified for the \"%s\" filter.\n",
214                    filter->filter->name);
215             return -1;
216         }
217
218         if(p->filter) {
219             if(link_filter(p->filter, p->pad_idx, filter, pad, log_ctx))
220                 return -1;
221             av_free(p);
222         } else {
223             p->filter = filter;
224             p->pad_idx = pad;
225             p->next = *openLinks;
226             *openLinks = p;
227         }
228     }
229
230
231     if(*currInputs) {
232         av_log(log_ctx, AV_LOG_ERROR,
233                "Too many inputs specified for the \"%s\" filter.\n",
234                filter->filter->name);
235         return -1;
236     }
237
238     pad = filter->output_count;
239     while(pad--) {
240         AVFilterInOut *currlinkn = av_malloc(sizeof(AVFilterInOut));
241         currlinkn->name    = NULL;
242         currlinkn->type    = LinkTypeOut;
243         currlinkn->filter  = filter;
244         currlinkn->pad_idx = pad;
245         currlinkn->next    = *currInputs;
246         *currInputs = currlinkn;
247     }
248
249     return 0;
250 }
251
252 static int parse_inputs(const char **buf, AVFilterInOut **currInputs,
253                         AVFilterInOut **openLinks, AVClass *log_ctx)
254 {
255     int pad = 0;
256
257     while(**buf == '[') {
258         char *name = parse_link_name(buf, log_ctx);
259         AVFilterInOut *link_to_add;
260         AVFilterInOut *match;
261
262         if(!name)
263             return -1;
264
265         /* First check if the label is not in the openLinks list */
266         match = extract_inout(name, openLinks);
267
268         if(match) {
269             /* A label of a open link. Make it one of the inputs of the next
270                filter */
271             if(match->type != LinkTypeOut) {
272                 av_log(log_ctx, AV_LOG_ERROR,
273                        "Label \"%s\" appears twice as input!\n", match->name);
274                 return -1;
275             }
276
277             link_to_add = match;
278         } else {
279             /* Not in the list, so add it as an input */
280             link_to_add = av_malloc(sizeof(AVFilterInOut));
281
282             link_to_add->name    = name;
283             link_to_add->type    = LinkTypeIn;
284             link_to_add->filter  = NULL;
285             link_to_add->pad_idx = pad;
286         }
287         link_to_add->next = *currInputs;
288         *currInputs = link_to_add;
289         *buf += consume_whitespace(*buf);
290         pad++;
291     }
292
293     return pad;
294 }
295
296 static int parse_outputs(const char **buf, AVFilterInOut **currInputs,
297                          AVFilterInOut **openLinks, AVClass *log_ctx)
298 {
299     int pad = 0;
300
301     while(**buf == '[') {
302         char *name = parse_link_name(buf, log_ctx);
303         AVFilterInOut *match;
304
305         AVFilterInOut *input = *currInputs;
306         *currInputs = (*currInputs)->next;
307
308         if(!name)
309             return -1;
310
311         /* First check if the label is not in the openLinks list */
312         match = extract_inout(name, openLinks);
313
314         if(match) {
315             /* A label of a open link. Link it. */
316             if(match->type != LinkTypeIn) {
317                 av_log(log_ctx, AV_LOG_ERROR,
318                        "Label \"%s\" appears twice as output!\n", match->name);
319                 return -1;
320             }
321
322             if(link_filter(input->filter, input->pad_idx,
323                            match->filter, match->pad_idx, log_ctx) < 0)
324                 return -1;
325             av_free(match);
326             av_free(input);
327         } else {
328             /* Not in the list, so add the first input as a openLink */
329             input->next = *openLinks;
330             input->type = LinkTypeOut;
331             input->name = name;
332             *openLinks = input;
333         }
334         *buf += consume_whitespace(*buf);
335         pad++;
336     }
337
338     return pad;
339 }
340
341 /**
342  * Parse a string describing a filter graph.
343  */
344 int avfilter_parse_graph(AVFilterGraph *graph, const char *filters,
345                          AVFilterInOut *openLinks, AVClass *log_ctx)
346 {
347     int index = 0;
348     char chr = 0;
349     int pad = 0;
350
351     AVFilterInOut *currInputs = NULL;
352
353     do {
354         AVFilterContext *filter;
355         filters += consume_whitespace(filters);
356
357         pad = parse_inputs(&filters, &currInputs, &openLinks, log_ctx);
358
359         if(pad < 0)
360             goto fail;
361
362         filter = parse_filter(&filters, graph, index, log_ctx);
363
364         if(!filter)
365             goto fail;
366
367         if(filter->input_count == 1 && !currInputs && !index) {
368             // First input can be ommitted if it is "[in]"
369             const char *tmp = "[in]";
370             pad = parse_inputs(&tmp, &currInputs, &openLinks, log_ctx);
371             if(pad < 0)
372                 goto fail;
373         }
374
375         if(link_filter_inouts(filter, &currInputs, &openLinks, log_ctx) < 0)
376             goto fail;
377
378         pad = parse_outputs(&filters, &currInputs, &openLinks, log_ctx);
379
380         if(pad < 0)
381             goto fail;
382
383         filters += consume_whitespace(filters);
384         chr = *filters++;
385
386         if(chr == ';' && currInputs) {
387             av_log(log_ctx, AV_LOG_ERROR,
388                    "Could not find a output to link when parsing \"%s\"\n",
389                    filters - 1);
390             goto fail;
391         }
392         index++;
393     } while(chr == ',' || chr == ';');
394
395     if(openLinks && !strcmp(openLinks->name, "out") && currInputs) {
396         // Last output can be ommitted if it is "[out]"
397         const char *tmp = "[out]";
398         if(parse_outputs(&tmp, &currInputs, &openLinks, log_ctx) < 0)
399             goto fail;
400     }
401
402     return 0;
403
404  fail:
405     avfilter_destroy_graph(graph);
406     free_inout(openLinks);
407     free_inout(currInputs);
408     return -1;
409 }