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