Remove graphparser.h header, move AVFilterInOut and
[ffmpeg.git] / libavfilter / avfiltergraph.h
index 2e308f5..5bc8f0d 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
-#ifndef FFMPEG_AVFILTERGRAPH_H
-#define FFMPEG_AVFILTERGRAPH_H
+#ifndef AVFILTER_AVFILTERGRAPH_H
+#define AVFILTER_AVFILTERGRAPH_H
 
 #include "avfilter.h"
 
-/** Linked-list of filters to create for an AVFilterGraphDesc */
-typedef struct AVFilterGraphDescFilter
-{
-    char *name;             ///< filter instance name
-    char *filter;           ///< name of filter type
-    char *args;             ///< filter parameters
-    struct AVFilterGraphDescFilter *next;
-} AVFilterGraphDescFilter;
-
-/** Linked-list of links between filters */
-typedef struct AVFilterGraphDescLink
-{
-    /* TODO: allow referencing pads by name, not just by index */
-    char *src;              ///< name of the source filter
-    unsigned srcpad;        ///< index of the output pad on the source filter
-
-    char *dst;              ///< name of the dest filter
-    unsigned dstpad;        ///< index of the input pad on the dest filter
-
-    struct AVFilterGraphDescLink *next;
-} AVFilterGraphDescLink;
-
-/** Linked-list of filter pads to be exported from the graph */
-typedef struct AVFilterGraphDescExport
-{
-    /* TODO: allow referencing pads by name, not just by index */
-    char *name;             ///< name of the exported pad
-    char *filter;           ///< name of the filter
-    unsigned pad;           ///< index of the pad to be exported
-
-    struct AVFilterGraphDescExport *next;
-} AVFilterGraphDescExport;
-
-/** Sections of a filter graph description */
-typedef enum
-{
-    SEC_NONE = 0,
-    SEC_FILTERS,
-    SEC_LINKS,
-    SEC_INPUTS,
-    SEC_OUTPUTS
-} AVFilterGraphDescSection;
-
-/** Description of a graph to be loaded from a file, etc */
-typedef struct
-{
-    AVFilterGraphDescFilter *filters;   ///< filters in the graph
-    AVFilterGraphDescLink   *links;     ///< links between the filters
-    AVFilterGraphDescExport *inputs;    ///< inputs to export
-    AVFilterGraphDescExport *outputs;   ///< outputs to export
-} AVFilterGraphDesc;
-
-typedef struct
-{
-    AVFilterGraphDescSection section;   ///< current section being parsed
-
-    AVFilterGraphDescFilter **filterp;  ///< last parsed filter
-    AVFilterGraphDescLink   **linkp;    ///< last parsed link
-    AVFilterGraphDescExport **inputp;   ///< last parsed exported input
-    AVFilterGraphDescExport **outputp;  ///< last parsed exported output
-} AVFilterGraphDescParser;
+typedef struct AVFilterGraph {
+    unsigned filter_count;
+    AVFilterContext **filters;
+
+    char *scale_sws_opts; ///< sws options to use for the auto-inserted scale filters
+} AVFilterGraph;
 
 /**
- * Parse a graph composed of a simple chain of filters which is described by
- * a single string.
- * @param filters String listing filters and their arguments.
- * @return        The parsed graph description.
+ * Allocate a filter graph.
  */
-AVFilterGraphDesc *avfilter_graph_parse_chain(const char *filters);
-
-/** Parse a line of a filter graph description.
- * @param desc   Pointer to an AVFilterGraphDesc pointer. If *desc is NULL,
- *               a new AVFilterGraphDesc structure will be created for you.
- *               Must be the same between multiple invocations when parsing
- *               the same description.
- * @param parser Parser state. Must be the same between multiple invocations
- *               when parsing the same description
- * @param line   Line of the graph description to parse.
- * @return       Zero on success, negative on error.
+AVFilterGraph *avfilter_graph_alloc(void);
+
+/**
+ * Get a filter instance with name name from graph.
+ *
+ * @return the pointer to the found filter instance or NULL if it
+ * cannot be found.
  */
-int avfilter_graph_parse_desc(AVFilterGraphDesc **desc,
-                              AVFilterGraphDescParser **parser,
-                              char *line);
+AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, char *name);
 
 /**
- * Load a filter graph description from a file
- * @param filename Name of the file from which to load the description
- * @return         Pointer to the description on success.  NULL on failure
+ * Add an existing filter instance to a filter graph.
+ *
+ * @param graphctx  the filter graph
+ * @param filter the filter to be added
  */
-AVFilterGraphDesc *avfilter_graph_load_desc(const char *filename);
+int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter);
 
 /**
- * Free a filter graph description
- * @param desc The graph description to free
+ * Check for the validity of graph.
+ *
+ * A graph is considered valid if all its input and output pads are
+ * connected.
+ *
+ * @return 0 in case of success, a negative value otherwise
  */
-void avfilter_graph_free_desc(AVFilterGraphDesc *desc);
+int avfilter_graph_check_validity(AVFilterGraph *graphctx, AVClass *log_ctx);
 
 /**
- * Add an existing filter instance to a filter graph.
- * @param graph  The filter graph
- * @param filter The filter to be added
+ * Configure all the links of graphctx.
+ *
+ * @return 0 in case of success, a negative value otherwise
  */
-void avfilter_graph_add_filter(AVFilterContext *graphctx, AVFilterContext *filter);
+int avfilter_graph_config_links(AVFilterGraph *graphctx, AVClass *log_ctx);
 
 /**
- * Configure the formats of all the links in the graph
+ * Configure the formats of all the links in the graph.
  */
-int avfilter_graph_config_formats(AVFilterContext *graphctx);
+int avfilter_graph_config_formats(AVFilterGraph *graphctx, AVClass *log_ctx);
 
 /**
- * Configure the resolution, etc of all links in the graph
+ * Check validity and configure all the links and formats in the graph.
+ *
+ * @see avfilter_graph_check_validity(), avfilter_graph_config_links(),
+ * avfilter_graph_config_formats()
+ */
+int avfilter_graph_config(AVFilterGraph *graphctx, AVClass *log_ctx);
+
+/**
+ * Free a graph and destroy its links.
+ */
+void avfilter_graph_free(AVFilterGraph *graph);
+
+/**
+ * A linked-list of the inputs/outputs of the filter chain.
+ *
+ * This is mainly useful for avfilter_graph_parse(), since this
+ * function may accept a description of a graph with not connected
+ * input/output pads. This struct specifies, per each not connected
+ * pad contained in the graph, the filter context and the pad index
+ * required for establishing a link.
+ */
+typedef struct AVFilterInOut {
+    /** unique name for this input/output in the list */
+    char *name;
+
+    /** filter context associated to this input/output */
+    AVFilterContext *filter_ctx;
+
+    /** index of the filt_ctx pad to use for linking */
+    int pad_idx;
+
+    /** next input/input in the list, NULL if this is the last */
+    struct AVFilterInOut *next;
+} AVFilterInOut;
+
+/**
+ * Add a graph described by a string to a graph.
+ *
+ * @param graph   the filter graph where to link the parsed graph context
+ * @param filters string to be parsed
+ * @param inputs  linked list to the inputs of the graph
+ * @param outputs linked list to the outputs of the graph
+ * @return zero on success, a negative AVERROR code on error
  */
-int avfilter_graph_config_links(AVFilterContext *graphctx);
+int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
+                         AVFilterInOut *inputs, AVFilterInOut *outputs,
+                         AVClass *log_ctx);
 
-#endif  /* FFMPEG_AVFILTER_H */
+#endif  /* AVFILTER_AVFILTERGRAPH_H */