Allow creation of filter graphs from a graph description structure which
[ffmpeg.git] / 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_AVFILTER_GRAPH_H
23 #define FFMPEG_AVFILTER_GRAPH_H
24
25 #include "avfilter.h"
26
27 /** Linked-list of filters to create for an AVFilterGraphDesc */
28 typedef struct AVFilterGraphDescFilter
29 {
30     char *name;             ///< filter instance name
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     char *src;              ///< name of the source filter
41     unsigned srcpad;        ///< index of the output pad on the source filter
42
43     char *dst;              ///< name 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     char *filter;           ///< name of the filter
55     unsigned pad;           ///< index of the pad to be exported
56
57     struct AVFilterGraphDescExport *next;
58 } AVFilterGraphDescExport;
59
60 /** Description of a graph to be loaded from a file, etc */
61 typedef struct
62 {
63     AVFilterGraphDescFilter *filters;   ///< filters in the graph
64     AVFilterGraphDescLink   *links;     ///< links between the filters
65     AVFilterGraphDescExport *inputs;    ///< inputs to export
66     AVFilterGraphDescExport *outputs;   ///< outputs to export
67 } AVFilterGraphDesc;
68
69 /**
70  * Load a filter graph description from a file
71  * @param filename Name of the file from which to load the description
72  * @return         Pointer to the description on success.  NULL on failure
73  */
74 AVFilterGraphDesc *avfilter_graph_load_desc(const char *filename);
75
76 /**
77  * Free a filter graph description
78  * @param desc The graph description to free
79  */
80 void avfilter_graph_free_desc(AVFilterGraphDesc *desc);
81
82 /**
83  * Add an existing filter instance to a filter graph.
84  * @param graph  The filter graph
85  * @param filter The filter to be added
86  */
87 void avfilter_graph_add_filter(AVFilterContext *graphctx, AVFilterContext *filter);
88
89 /**
90  * Configure the colorspace, resolution, etc of all links in the graph
91  */
92 int avfilter_graph_config_links(AVFilterContext *graphctx);
93
94 #endif  /* FFMPEG_AVFILTER_H */