git.sesse.net Git - ffmpeg/blob - 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 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(), since this
  95  * function may accept a description of a graph with not connected
  96  * input/output pads. This struct specifies, per each not connected
  97  * pad contained in the graph, the filter context and the pad index
  98  * 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  * Create an AVFilterInOut.
 116  * Must be free with avfilter_inout_free().
 117  */
 118 AVFilterInOut *avfilter_inout_alloc(void);
 119
 120 /**
 121  * Free the AVFilterInOut in *inout, and set its pointer to NULL.
 122  * If *inout is NULL, do nothing.
 123  */
 124 void avfilter_inout_free(AVFilterInOut **inout);
 125
 126 /**
 127  * Add a graph described by a string to a graph.
 128  *
 129  * @param graph   the filter graph where to link the parsed graph context
 130  * @param filters string to be parsed
 131  * @param inputs  pointer to a linked list to the inputs of the graph, may be NULL.
 132  *                If non-NULL, *inputs is updated to contain the list of open inputs
 133  *                after the parsing, should be freed with avfilter_inout_free().
 134  * @param outputs pointer to a linked list to the outputs of the graph, may be NULL.
 135  *                If non-NULL, *outputs is updated to contain the list of open outputs
 136  *                after the parsing, should be freed with avfilter_inout_free().
 137  * @return non negative on success, a negative AVERROR code on error
 138  */
 139 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
 140                          AVFilterInOut **inputs, AVFilterInOut **outputs,
 141                          void *log_ctx);
 142
 143 /**
 144  * Send a command to one or more filter instances.
 145  *
 146  * @param graph  the filter graph
 147  * @param target the filter(s) to which the command should be sent
 148  *               "all" sends to all filters
 149  *               otherwise it can be a filter or filter instance name
 150  *               which will send the command to all matching filters.
 151  * @param cmd    the command to sent, for handling simplicity all commands must be alphanumeric only
 152  * @param arg    the argument for the command
 153  * @param res    a buffer with size res_size where the filter(s) can return a response.
 154  *
 155  * @returns >=0 on success otherwise an error code.
 156  *              AVERROR(ENOSYS) on unsupported commands
 157  */
 158 int avfilter_graph_send_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, char *res, int res_len, int flags);
 159
 160 /**
 161  * Queue a command for one or more filter instances.
 162  *
 163  * @param graph  the filter graph
 164  * @param target the filter(s) to which the command should be sent
 165  *               "all" sends to all filters
 166  *               otherwise it can be a filter or filter instance name
 167  *               which will send the command to all matching filters.
 168  * @param cmd    the command to sent, for handling simplicity all commands must be alphanummeric only
 169  * @param arg    the argument for the command
 170  * @param ts     time at which the command should be sent to the filter
 171  *
 172  * @note As this executes commands after this function returns, no return code
 173  *       from the filter is provided, also AVFILTER_CMD_FLAG_ONE is not supported.
 174  */
 175 int avfilter_graph_queue_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, int flags, double ts);
 176
 177
 178 /**
 179  * Dump a graph into a human-readable string representation.
 180  *
 181  * @param graph    the graph to dump
 182  * @param options  formatting options; currently ignored
 183  * @return  a string, or NULL in case of memory allocation failure;
 184  *          the string must be freed using av_free
 185  */
 186 char *avfilter_graph_dump(AVFilterGraph *graph, const char *options);
 187
 188 #endif /* AVFILTER_AVFILTERGRAPH_H */