3 * copyright (c) 2007 Bobby Bingham
5 * This file is part of FFmpeg.
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.
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.
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
22 #ifndef AVFILTER_AVFILTERGRAPH_H
23 #define AVFILTER_AVFILTERGRAPH_H
27 typedef struct AVFilterGraph {
28 unsigned filter_count;
29 AVFilterContext **filters;
31 char *scale_sws_opts; ///< sws options to use for the auto-inserted scale filters
35 * Allocate a filter graph.
37 AVFilterGraph *avfilter_graph_alloc(void);
40 * Get a filter instance with name name from graph.
42 * @return the pointer to the found filter instance or NULL if it
45 AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, char *name);
48 * Add an existing filter instance to a filter graph.
50 * @param graphctx the filter graph
51 * @param filter the filter to be added
53 int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter);
56 * Create and add a filter instance into an existing graph.
57 * The filter instance is created from the filter filt and inited
58 * with the parameters args and opaque.
60 * In case of success put in *filt_ctx the pointer to the created
61 * filter instance, otherwise set *filt_ctx to NULL.
63 * @param name the instance name to give to the created filter instance
64 * @param graph_ctx the filter graph
65 * @return a negative AVERROR error code in case of failure, a non
66 * negative value otherwise
68 int avfilter_graph_create_filter(AVFilterContext **filt_ctx, AVFilter *filt,
69 const char *name, const char *args, void *opaque,
70 AVFilterGraph *graph_ctx);
73 * Check validity and configure all the links and formats in the graph.
75 * @param graphctx the filter graph
76 * @param log_ctx context used for logging
77 * @return 0 in case of success, a negative AVERROR code otherwise
79 int avfilter_graph_config(AVFilterGraph *graphctx, void *log_ctx);
82 * Free a graph, destroy its links, and set *graph to NULL.
83 * If *graph is NULL, do nothing.
85 void avfilter_graph_free(AVFilterGraph **graph);
88 * A linked-list of the inputs/outputs of the filter chain.
90 * This is mainly useful for avfilter_graph_parse(), since this
91 * function may accept a description of a graph with not connected
92 * input/output pads. This struct specifies, per each not connected
93 * pad contained in the graph, the filter context and the pad index
94 * required for establishing a link.
96 typedef struct AVFilterInOut {
97 /** unique name for this input/output in the list */
100 /** filter context associated to this input/output */
101 AVFilterContext *filter_ctx;
103 /** index of the filt_ctx pad to use for linking */
106 /** next input/input in the list, NULL if this is the last */
107 struct AVFilterInOut *next;
111 * Create an AVFilterInOut.
112 * Must be free with avfilter_inout_free().
114 AVFilterInOut *avfilter_inout_alloc(void);
117 * Free the AVFilterInOut in *inout, and set its pointer to NULL.
118 * If *inout is NULL, do nothing.
120 void avfilter_inout_free(AVFilterInOut **inout);
123 * Add a graph described by a string to a graph.
125 * @param graph the filter graph where to link the parsed graph context
126 * @param filters string to be parsed
127 * @param inputs pointer to a linked list to the inputs of the graph, may be NULL.
128 * If non-NULL, *inputs is updated to contain the list of open inputs
129 * after the parsing, should be freed with avfilter_inout_free().
130 * @param outputs pointer to a linked list to the outputs of the graph, may be NULL.
131 * If non-NULL, *outputs is updated to contain the list of open outputs
132 * after the parsing, should be freed with avfilter_inout_free().
133 * @return zero on success, a negative AVERROR code on error
135 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
136 AVFilterInOut **inputs, AVFilterInOut **outputs,
139 #endif /* AVFILTER_AVFILTERGRAPH_H */