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