Apply documentation fixes: use third person, fix grammar and remove
[ffmpeg.git] / libavfilter / graphparser.h
index c255824..b3272e8 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
-#ifndef FFMPEG_GRAPHPARSER_H
-#define FFMPEG_GRAPHPARSER_H
+#ifndef AVFILTER_GRAPHPARSER_H
+#define AVFILTER_GRAPHPARSER_H
 
 #include "avfilter.h"
 #include "avfiltergraph.h"
 
 /**
+ * A linked-list of the inputs/outputs of the filter chain.
+ */
+typedef struct AVFilterInOut {
+    const char *name;
+    AVFilterContext *filter;
+    int pad_idx;
+
+    struct AVFilterInOut *next;
+} AVFilterInOut;
+
+/**
  * Add to a graph a graph described by a string.
+ *
  * @param graph   the filter graph where to link the parsed graph context
  * @param filters string to be parsed
- * @param in      input to the graph to be parsed (TODO: allow several)
- * @param inpad   pad index of the input
- * @param out     output to the graph to be parsed (TODO: allow several)
- * @param outpad  pad index of the output
+ * @param inputs  linked list to the inputs of the graph
+ * @param outputs linked list to the outputs of the graph
  * @return        zero on success, -1 on error
  */
-int avfilter_parse_graph(AVFilterGraph *graph, const char *filters,
-                         AVFilterContext *in, int inpad,
-                         AVFilterContext *out, int outpad,
+int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
+                         AVFilterInOut *inputs, AVFilterInOut *outputs,
                          AVClass *log_ctx);
 
-#endif  /* FFMPEG_GRAPHPARSER_H */
+#endif  /* AVFILTER_GRAPHPARSER_H */