avfiltergraph: make the AVFilterInOut alloc/free API public
[ffmpeg.git] / libavfilter / avfiltergraph.h
1 /*
2  * Filter graphs
3  * copyright (c) 2007 Bobby Bingham
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #ifndef AVFILTER_AVFILTERGRAPH_H
23 #define AVFILTER_AVFILTERGRAPH_H
24
25 #include "avfilter.h"
26 #include "libavutil/log.h"
27
28 typedef struct AVFilterGraph {
29 #if FF_API_GRAPH_AVCLASS
30     const AVClass *av_class;
31 #endif
32     unsigned filter_count;
33     AVFilterContext **filters;
34
35     char *scale_sws_opts; ///< sws options to use for the auto-inserted scale filters
36 } AVFilterGraph;
37
38 /**
39  * Allocate a filter graph.
40  */
41 AVFilterGraph *avfilter_graph_alloc(void);
42
43 /**
44  * Get a filter instance with name name from graph.
45  *
46  * @return the pointer to the found filter instance or NULL if it
47  * cannot be found.
48  */
49 AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, char *name);
50
51 /**
52  * Add an existing filter instance to a filter graph.
53  *
54  * @param graphctx  the filter graph
55  * @param filter the filter to be added
56  */
57 int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter);
58
59 /**
60  * Create and add a filter instance into an existing graph.
61  * The filter instance is created from the filter filt and inited
62  * with the parameters args and opaque.
63  *
64  * In case of success put in *filt_ctx the pointer to the created
65  * filter instance, otherwise set *filt_ctx to NULL.
66  *
67  * @param name the instance name to give to the created filter instance
68  * @param graph_ctx the filter graph
69  * @return a negative AVERROR error code in case of failure, a non
70  * negative value otherwise
71  */
72 int avfilter_graph_create_filter(AVFilterContext **filt_ctx, AVFilter *filt,
73                                  const char *name, const char *args, void *opaque,
74                                  AVFilterGraph *graph_ctx);
75
76 /**
77  * Check validity and configure all the links and formats in the graph.
78  *
79  * @param graphctx the filter graph
80  * @param log_ctx context used for logging
81  * @return 0 in case of success, a negative AVERROR code otherwise
82  */
83 int avfilter_graph_config(AVFilterGraph *graphctx, void *log_ctx);
84
85 /**
86  * Free a graph, destroy its links, and set *graph to NULL.
87  * If *graph is NULL, do nothing.
88  */
89 void avfilter_graph_free(AVFilterGraph **graph);
90
91 /**
92  * A linked-list of the inputs/outputs of the filter chain.
93  *
94  * This is mainly useful for avfilter_graph_parse() / avfilter_graph_parse2(),
95  * where it is used to communicate open (unlinked) inputs and outputs from and
96  * to the caller.
97  * This struct specifies, per each not connected pad contained in the graph, the
98  * filter context and the pad index required for establishing a link.
99  */
100 typedef struct AVFilterInOut {
101     /** unique name for this input/output in the list */
102     char *name;
103
104     /** filter context associated to this input/output */
105     AVFilterContext *filter_ctx;
106
107     /** index of the filt_ctx pad to use for linking */
108     int pad_idx;
109
110     /** next input/input in the list, NULL if this is the last */
111     struct AVFilterInOut *next;
112 } AVFilterInOut;
113
114 /**
115  * Allocate a single AVFilterInOut entry.
116  * Must be freed with avfilter_inout_free().
117  * @return allocated AVFilterInOut on success, NULL on failure.
118  */
119 AVFilterInOut *avfilter_inout_alloc(void);
120
121 /**
122  * Free the supplied list of AVFilterInOut and set *inout to NULL.
123  * If *inout is NULL, do nothing.
124  */
125 void avfilter_inout_free(AVFilterInOut **inout);
126
127 /**
128  * Add a graph described by a string to a graph.
129  *
130  * @param graph   the filter graph where to link the parsed graph context
131  * @param filters string to be parsed
132  * @param inputs  linked list to the inputs of the graph
133  * @param outputs linked list to the outputs of the graph
134  * @return zero on success, a negative AVERROR code on error
135  */
136 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
137                          AVFilterInOut *inputs, AVFilterInOut *outputs,
138                          void *log_ctx);
139
140 /**
141  * Add a graph described by a string to a graph.
142  *
143  * @param[in]  graph   the filter graph where to link the parsed graph context
144  * @param[in]  filters string to be parsed
145  * @param[out] inputs  a linked list of all free (unlinked) inputs of the
146  *                     parsed graph will be returned here. It is to be freed
147  *                     by the caller using avfilter_inout_free().
148  * @param[out] outputs a linked list of all free (unlinked) outputs of the
149  *                     parsed graph will be returned here. It is to be freed by the
150  *                     caller using avfilter_inout_free().
151  * @return zero on success, a negative AVERROR code on error
152  *
153  * @note the difference between avfilter_graph_parse2() and
154  * avfilter_graph_parse() is that in avfilter_graph_parse(), the caller provides
155  * the lists of inputs and outputs, which therefore must be known before calling
156  * the function. On the other hand, avfilter_graph_parse2() \em returns the
157  * inputs and outputs that are left unlinked after parsing the graph and the
158  * caller then deals with them. Another difference is that in
159  * avfilter_graph_parse(), the inputs parameter describes inputs of the
160  * <em>already existing</em> part of the graph; i.e. from the point of view of
161  * the newly created part, they are outputs. Similarly the outputs parameter
162  * describes outputs of the already existing filters, which are provided as
163  * inputs to the parsed filters.
164  * avfilter_graph_parse2() takes the opposite approach -- it makes no reference
165  * whatsoever to already existing parts of the graph and the inputs parameter
166  * will on return contain inputs of the newly parsed part of the graph.
167  * Analogously the outputs parameter will contain outputs of the newly created
168  * filters.
169  */
170 int avfilter_graph_parse2(AVFilterGraph *graph, const char *filters,
171                           AVFilterInOut **inputs,
172                           AVFilterInOut **outputs);
173
174 #endif /* AVFILTER_AVFILTERGRAPH_H */