git.sesse.net Git - ffmpeg/blob - libavfilter/avfiltergraph.h

   1 /*
   2  * Filter graphs
   3  * copyright (c) 2007 Bobby Bingham
   4  *
   5  * This file is part of FFmpeg.
   6  *
   7  * FFmpeg is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * FFmpeg is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with FFmpeg; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #ifndef FFMPEG_AVFILTERGRAPH_H
  23 #define FFMPEG_AVFILTERGRAPH_H
  24
  25 #include "avfilter.h"
  26
  27 /** Linked-list of filters to create for an AVFilterGraphDesc */
  28 typedef struct AVFilterGraphDescFilter
  29 {
  30     int index;              ///< filter instance index
  31     char *filter;           ///< name of filter type
  32     char *args;             ///< filter parameters
  33     struct AVFilterGraphDescFilter *next;
  34 } AVFilterGraphDescFilter;
  35
  36 /** Linked-list of links between filters */
  37 typedef struct AVFilterGraphDescLink
  38 {
  39     /* TODO: allow referencing pads by name, not just by index */
  40     int src;                ///< index of the source filter
  41     unsigned srcpad;        ///< index of the output pad on the source filter
  42
  43     int dst;                ///< index of the dest filter
  44     unsigned dstpad;        ///< index of the input pad on the dest filter
  45
  46     struct AVFilterGraphDescLink *next;
  47 } AVFilterGraphDescLink;
  48
  49 /** Linked-list of filter pads to be exported from the graph */
  50 typedef struct AVFilterGraphDescExport
  51 {
  52     /* TODO: allow referencing pads by name, not just by index */
  53     char *name;             ///< name of the exported pad
  54     int filter;             ///< index of the filter
  55     unsigned pad;           ///< index of the pad to be exported
  56
  57     struct AVFilterGraphDescExport *next;
  58 } AVFilterGraphDescExport;
  59
  60 /** Sections of a filter graph description */
  61 typedef enum
  62 {
  63     SEC_NONE = 0,
  64     SEC_FILTERS,
  65     SEC_LINKS,
  66     SEC_INPUTS,
  67     SEC_OUTPUTS
  68 } AVFilterGraphDescSection;
  69
  70 /** Description of a graph to be loaded from a file, etc */
  71 typedef struct
  72 {
  73     AVFilterGraphDescFilter *filters;   ///< filters in the graph
  74     AVFilterGraphDescLink   *links;     ///< links between the filters
  75     AVFilterGraphDescExport *inputs;    ///< inputs to export
  76     AVFilterGraphDescExport *outputs;   ///< outputs to export
  77 } AVFilterGraphDesc;
  78
  79 typedef struct
  80 {
  81     AVFilterGraphDescSection section;   ///< current section being parsed
  82
  83     AVFilterGraphDescFilter **filterp;  ///< last parsed filter
  84     AVFilterGraphDescLink   **linkp;    ///< last parsed link
  85     AVFilterGraphDescExport **inputp;   ///< last parsed exported input
  86     AVFilterGraphDescExport **outputp;  ///< last parsed exported output
  87 } AVFilterGraphDescParser;
  88
  89 extern AVFilter avfilter_vf_graph;
  90
  91 /**
  92  * Parse a graph composed of a simple chain of filters which is described by
  93  * a single string.
  94  * @param filters String listing filters and their arguments.
  95  * @return        The parsed graph description.
  96  */
  97 AVFilterGraphDesc *avfilter_graph_parse_chain(const char *filters);
  98
  99 /**
 100  * Free a filter graph description.
 101  * @param desc The graph description to free
 102  */
 103 void avfilter_graph_free_desc(AVFilterGraphDesc *desc);
 104
 105 /**
 106  * Add an existing filter instance to a filter graph.
 107  * @param graph  The filter graph
 108  * @param filter The filter to be added
 109  */
 110 void avfilter_graph_add_filter(AVFilterContext *graphctx, AVFilterContext *filter);
 111
 112 /**
 113  * Configure the formats of all the links in the graph.
 114  */
 115 int avfilter_graph_config_formats(AVFilterContext *graphctx);
 116
 117 /**
 118  * Configure the parameters (resolution, etc) of all links in the graph.
 119  */
 120 int avfilter_graph_config_links(AVFilterContext *graphctx);
 121
 122
 123 int graph_load_from_desc3(AVFilterContext *ctx, AVFilterGraphDesc *desc,
 124                           AVFilterContext *in, int inpad,
 125                           AVFilterContext *out, int outpad);
 126
 127 #endif  /* FFMPEG_AVFILTERGRAPH_H */