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