9518f8e2d3f92de879a641ebc503509b158b2a82
[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
184     while(*links && strcmp((*links)->name, label))
185         links= &((*links)->next);
186
187     ret= *links;
188
189     if(ret)
190         *links= ret->next;
191
192     return ret;
193 }
194
195
196 static int link_filter_inouts(AVFilterContext *filter,
197                               AVFilterInOut **currInputs,
198                               AVFilterInOut **openLinks, AVClass *log_ctx)
199 {
200     AVFilterInOut *p;
201     int pad = 0;
202
203     pad = filter->input_count;
204     while(pad--) {
205         p = *currInputs;
206         if(!p) {
207             av_log(log_ctx, AV_LOG_ERROR,
208                    "Not enough inputs specified for the \"%s\" filter.\n",
209                    filter->name);
210             return -1;
211         }
212
213         if(p->filter) {
214             if(link_filter(p->filter, p->pad_idx, filter, pad, log_ctx))
215                 return -1;
216             *currInputs = (*currInputs)->next;
217             av_free(p);
218         } else {
219             p = *currInputs;
220             *currInputs = (*currInputs)->next;
221             p->filter = filter;
222             p->pad_idx = pad;
223             p->next = *openLinks;
224             *openLinks = p;
225         }
226     }
227
228
229     if(*currInputs) {
230         av_log(log_ctx, AV_LOG_ERROR,
231                "Too many inputs specified for the \"%s\" filter.\n",
232                filter->name);
233         return -1;
234     }
235
236     pad = filter->output_count;
237     while(pad--) {
238         AVFilterInOut *currlinkn = av_malloc(sizeof(AVFilterInOut));
239         currlinkn->name    = NULL;
240         currlinkn->type    = LinkTypeOut;
241         currlinkn->filter  = filter;
242         currlinkn->pad_idx = pad;
243         currlinkn->next    = *currInputs;
244         *currInputs = currlinkn;
245     }
246
247     return 0;
248 }
249
250 /**
251  * Parse "filter=params"
252  * @arg name a pointer (that need to be free'd after use) to the name of the
253  *           filter
254  * @arg ars  a pointer (that need to be free'd after use) to the args of the
255  *           filter
256  */
257 static AVFilterContext *parse_filter(const char **buf, AVFilterGraph *graph,
258                                      int index, AVClass *log_ctx)
259 {
260     char *opts;
261     char *name = consume_string(buf);
262
263     if(**buf == '=') {
264         (*buf)++;
265         opts = consume_string(buf);
266     } else {
267         opts = NULL;
268     }
269
270     return create_filter(graph, index, name, opts, log_ctx);
271 }
272
273 static int parse_inputs(const char **buf, AVFilterInOut **currInputs,
274                         AVFilterInOut **openLinks, AVClass *log_ctx)
275 {
276     int pad = 0;
277     AVFilterInOut *p;
278
279     while (**buf == '[') {
280         char *name;
281
282         parse_link_name(buf, &name, log_ctx);
283
284         if(!name)
285             return -1;
286
287         /* First check if the label is not in the openLinks list */
288         p = extract_inout(name, openLinks);
289
290         /* Not in the list, so add it as an input */
291         if(!p) {
292             AVFilterInOut *currlinkn = av_malloc(sizeof(AVFilterInOut));
293
294             currlinkn->name    = name;
295             currlinkn->type    = LinkTypeIn;
296             currlinkn->filter  = NULL;
297             currlinkn->pad_idx = pad;
298             currlinkn->next    = *currInputs;
299             *currInputs = currlinkn;
300         } else {
301             /* A label of a open link. Make it one of the inputs of the next
302                filter */
303             AVFilterInOut *currlinkn = p;
304             if (p->type != LinkTypeOut) {
305                 av_log(log_ctx, AV_LOG_ERROR,
306                        "Label \"%s\" appears twice as input!\n", p->name);
307                 return -1;
308             }
309             currlinkn->next = *currInputs;
310             *currInputs = currlinkn;
311         }
312         consume_whitespace(buf);
313         pad++;
314     }
315
316     return pad;
317 }
318
319 static int parse_outputs(const char **buf, AVFilterInOut **currInputs,
320                          AVFilterInOut **openLinks, AVClass *log_ctx)
321 {
322     int pad = 0;
323
324     while (**buf == '[') {
325         char *name;
326         AVFilterInOut *match;
327
328         parse_link_name(buf, &name, log_ctx);
329
330         if(!name)
331             return -1;
332
333         /* First check if the label is not in the openLinks list */
334         match = extract_inout(name, openLinks);
335
336         /* Not in the list, so add the first input as a openLink */
337         if(!match) {
338             AVFilterInOut *p = *currInputs;
339             *currInputs = (*currInputs)->next;
340             p->next = *openLinks;
341             p->type = LinkTypeOut;
342             p->name = name;
343             *openLinks = p;
344         } else {
345             /* A label of a open link. Link it. */
346             AVFilterInOut *p = *currInputs;
347             if (match->type != LinkTypeIn) {
348                 av_log(log_ctx, AV_LOG_ERROR,
349                        "Label \"%s\" appears twice as output!\n", match->name);
350                 return -1;
351             }
352
353             *currInputs = (*currInputs)->next;
354             if(link_filter(p->filter, p->pad_idx,
355                            match->filter, match->pad_idx, log_ctx) < 0)
356                 return -1;
357             av_free(match);
358             av_free(p);
359         }
360         consume_whitespace(buf);
361         pad++;
362     }
363
364     return pad;
365 }
366
367 /**
368  * Parse a string describing a filter graph.
369  */
370 int avfilter_parse_graph(AVFilterGraph *graph, const char *filters,
371                          AVFilterContext *in, int inpad,
372                          AVFilterContext *out, int outpad,
373                          AVClass *log_ctx)
374 {
375     int index = 0;
376     char chr = 0;
377     int pad = 0;
378
379     AVFilterInOut *currInputs=NULL;
380     AVFilterInOut *openLinks  = av_malloc(sizeof(AVFilterInOut));
381
382     openLinks->name = "in";
383     openLinks->filter = in;
384     openLinks->type = LinkTypeOut;
385     openLinks->pad_idx = inpad;
386     openLinks->next = av_malloc(sizeof(AVFilterInOut));
387
388     openLinks->next->name = "out";
389     openLinks->next->filter = out;
390     openLinks->next->type = LinkTypeIn;
391     openLinks->next->pad_idx = outpad;
392     openLinks->next->next = NULL;
393
394     do {
395         AVFilterContext *filter;
396         consume_whitespace(&filters);
397
398         pad = parse_inputs(&filters, &currInputs, &openLinks, log_ctx);
399
400         if(pad < 0)
401             goto fail;
402
403         if(!(filter = parse_filter(&filters, graph, index, log_ctx)))
404             goto fail;
405
406         if(filter->input_count == 1 && !currInputs && !index) {
407             // First input can be ommitted if it is "[in]"
408             const char *tmp = "[in]";
409             pad = parse_inputs(&tmp, &currInputs, &openLinks, log_ctx);
410             if (pad < 0)
411                 goto fail;
412         }
413
414         if(link_filter_inouts(filter, &currInputs, &openLinks, log_ctx) < 0)
415             goto fail;
416
417         pad = parse_outputs(&filters, &currInputs, &openLinks, log_ctx);
418
419         if(pad < 0)
420             goto fail;
421
422         consume_whitespace(&filters);
423         chr = *filters++;
424
425         if (chr == ';' && currInputs) {
426             av_log(log_ctx, AV_LOG_ERROR,
427                    "Could not find a output to link when parsing \"%s\"\n",
428                    filters - 1);
429             goto fail;
430         }
431         index++;
432     } while (chr == ',' || chr == ';');
433
434     if(openLinks && !strcmp(openLinks->name, "out") && currInputs) {
435         // Last output can be ommitted if it is "[out]"
436         const char *tmp = "[out]";
437         if(parse_outputs(&tmp, &currInputs, &openLinks, log_ctx) < 0)
438             goto fail;
439     }
440
441     return 0;
442
443  fail:
444     avfilter_destroy_graph(graph);
445     free_inout(openLinks);
446     free_inout(currInputs);
447     return -1;
448 }