Allow code to pass data to filters it creates.
[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 typedef struct AVFilterGraph AVFilterGraph;
28
29 /**
30  * Create a new filter graph
31  */
32 AVFilterGraph *avfilter_create_graph(void);
33
34 /**
35  * Destroy a filter graph, and any filters in it.
36  * @param graph The filter graph to destroy
37  */
38 void avfilter_destroy_graph(AVFilterGraph *graph);
39
40 /**
41  * Add an existing filter instance to a filter graph.
42  * @param graph  The filter graph
43  * @param filter The filter to be added
44  */
45 void avfilter_graph_add_filter(AVFilterGraph *graph, AVFilterContext *filter);
46
47 /**
48  * Loads the filter graph with a simple chain described by filters.
49  * @param graph   The filter graph to load filters into
50  * @param count   The number of filters to be created
51  * @param filters_list An array of strings describing the filters to be created.
52  *                The format of each string is "name=params".
53  * @param first   If non-NULL, will be set to the first filter in the chain.
54  * @param last    If non-NULL, will be set to the last filter in the chain.
55  * @return 0 on success.  -1 on error.
56  */
57 int avfilter_graph_load_chain(AVFilterGraph *graph,
58                               unsigned count, char **filter_list, void **opaque,
59                               AVFilterContext **first, AVFilterContext **last);
60 #endif  /* FFMPEG_AVFILTER_H */