lavfi: generic hardware surface upload and download filters
[ffmpeg.git] / libavfilter / avfilter.h
1 /*
2  * filter layer
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_AVFILTER_H
23 #define AVFILTER_AVFILTER_H
24
25 /**
26  * @file
27  * @ingroup lavfi
28  * Main libavfilter public API header
29  */
30
31 /**
32  * @defgroup lavfi Libavfilter - graph-based frame editing library
33  * @{
34  */
35
36 #include "libavutil/attributes.h"
37 #include "libavutil/avutil.h"
38 #include "libavutil/buffer.h"
39 #include "libavutil/frame.h"
40 #include "libavutil/log.h"
41 #include "libavutil/samplefmt.h"
42 #include "libavutil/pixfmt.h"
43 #include "libavutil/rational.h"
44
45 #include <stddef.h>
46
47 #include "libavfilter/version.h"
48
49 /**
50  * Return the LIBAVFILTER_VERSION_INT constant.
51  */
52 unsigned avfilter_version(void);
53
54 /**
55  * Return the libavfilter build-time configuration.
56  */
57 const char *avfilter_configuration(void);
58
59 /**
60  * Return the libavfilter license.
61  */
62 const char *avfilter_license(void);
63
64
65 typedef struct AVFilterContext AVFilterContext;
66 typedef struct AVFilterLink    AVFilterLink;
67 typedef struct AVFilterPad     AVFilterPad;
68 typedef struct AVFilterFormats AVFilterFormats;
69
70 /**
71  * Get the number of elements in a NULL-terminated array of AVFilterPads (e.g.
72  * AVFilter.inputs/outputs).
73  */
74 int avfilter_pad_count(const AVFilterPad *pads);
75
76 /**
77  * Get the name of an AVFilterPad.
78  *
79  * @param pads an array of AVFilterPads
80  * @param pad_idx index of the pad in the array it; is the caller's
81  *                responsibility to ensure the index is valid
82  *
83  * @return name of the pad_idx'th pad in pads
84  */
85 const char *avfilter_pad_get_name(const AVFilterPad *pads, int pad_idx);
86
87 /**
88  * Get the type of an AVFilterPad.
89  *
90  * @param pads an array of AVFilterPads
91  * @param pad_idx index of the pad in the array; it is the caller's
92  *                responsibility to ensure the index is valid
93  *
94  * @return type of the pad_idx'th pad in pads
95  */
96 enum AVMediaType avfilter_pad_get_type(const AVFilterPad *pads, int pad_idx);
97
98 /**
99  * The number of the filter inputs is not determined just by AVFilter.inputs.
100  * The filter might add additional inputs during initialization depending on the
101  * options supplied to it.
102  */
103 #define AVFILTER_FLAG_DYNAMIC_INPUTS        (1 << 0)
104 /**
105  * The number of the filter outputs is not determined just by AVFilter.outputs.
106  * The filter might add additional outputs during initialization depending on
107  * the options supplied to it.
108  */
109 #define AVFILTER_FLAG_DYNAMIC_OUTPUTS       (1 << 1)
110 /**
111  * The filter supports multithreading by splitting frames into multiple parts
112  * and processing them concurrently.
113  */
114 #define AVFILTER_FLAG_SLICE_THREADS         (1 << 2)
115
116 /**
117  * Filter definition. This defines the pads a filter contains, and all the
118  * callback functions used to interact with the filter.
119  */
120 typedef struct AVFilter {
121     /**
122      * Filter name. Must be non-NULL and unique among filters.
123      */
124     const char *name;
125
126     /**
127      * A description of the filter. May be NULL.
128      *
129      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
130      */
131     const char *description;
132
133     /**
134      * List of inputs, terminated by a zeroed element.
135      *
136      * NULL if there are no (static) inputs. Instances of filters with
137      * AVFILTER_FLAG_DYNAMIC_INPUTS set may have more inputs than present in
138      * this list.
139      */
140     const AVFilterPad *inputs;
141     /**
142      * List of outputs, terminated by a zeroed element.
143      *
144      * NULL if there are no (static) outputs. Instances of filters with
145      * AVFILTER_FLAG_DYNAMIC_OUTPUTS set may have more outputs than present in
146      * this list.
147      */
148     const AVFilterPad *outputs;
149
150     /**
151      * A class for the private data, used to declare filter private AVOptions.
152      * This field is NULL for filters that do not declare any options.
153      *
154      * If this field is non-NULL, the first member of the filter private data
155      * must be a pointer to AVClass, which will be set by libavfilter generic
156      * code to this class.
157      */
158     const AVClass *priv_class;
159
160     /**
161      * A combination of AVFILTER_FLAG_*
162      */
163     int flags;
164
165     /*****************************************************************
166      * All fields below this line are not part of the public API. They
167      * may not be used outside of libavfilter and can be changed and
168      * removed at will.
169      * New public fields should be added right above.
170      *****************************************************************
171      */
172
173     /**
174      * Filter initialization function.
175      *
176      * This callback will be called only once during the filter lifetime, after
177      * all the options have been set, but before links between filters are
178      * established and format negotiation is done.
179      *
180      * Basic filter initialization should be done here. Filters with dynamic
181      * inputs and/or outputs should create those inputs/outputs here based on
182      * provided options. No more changes to this filter's inputs/outputs can be
183      * done after this callback.
184      *
185      * This callback must not assume that the filter links exist or frame
186      * parameters are known.
187      *
188      * @ref AVFilter.uninit "uninit" is guaranteed to be called even if
189      * initialization fails, so this callback does not have to clean up on
190      * failure.
191      *
192      * @return 0 on success, a negative AVERROR on failure
193      */
194     int (*init)(AVFilterContext *ctx);
195
196     /**
197      * Should be set instead of @ref AVFilter.init "init" by the filters that
198      * want to pass a dictionary of AVOptions to nested contexts that are
199      * allocated during init.
200      *
201      * On return, the options dict should be freed and replaced with one that
202      * contains all the options which could not be processed by this filter (or
203      * with NULL if all the options were processed).
204      *
205      * Otherwise the semantics is the same as for @ref AVFilter.init "init".
206      */
207     int (*init_dict)(AVFilterContext *ctx, AVDictionary **options);
208
209     /**
210      * Filter uninitialization function.
211      *
212      * Called only once right before the filter is freed. Should deallocate any
213      * memory held by the filter, release any buffer references, etc. It does
214      * not need to deallocate the AVFilterContext.priv memory itself.
215      *
216      * This callback may be called even if @ref AVFilter.init "init" was not
217      * called or failed, so it must be prepared to handle such a situation.
218      */
219     void (*uninit)(AVFilterContext *ctx);
220
221     /**
222      * Query formats supported by the filter on its inputs and outputs.
223      *
224      * This callback is called after the filter is initialized (so the inputs
225      * and outputs are fixed), shortly before the format negotiation. This
226      * callback may be called more than once.
227      *
228      * This callback must set AVFilterLink.out_formats on every input link and
229      * AVFilterLink.in_formats on every output link to a list of pixel/sample
230      * formats that the filter supports on that link. For audio links, this
231      * filter must also set @ref AVFilterLink.in_samplerates "in_samplerates" /
232      * @ref AVFilterLink.out_samplerates "out_samplerates" and
233      * @ref AVFilterLink.in_channel_layouts "in_channel_layouts" /
234      * @ref AVFilterLink.out_channel_layouts "out_channel_layouts" analogously.
235      *
236      * This callback may be NULL for filters with one input, in which case
237      * libavfilter assumes that it supports all input formats and preserves
238      * them on output.
239      *
240      * @return zero on success, a negative value corresponding to an
241      * AVERROR code otherwise
242      */
243     int (*query_formats)(AVFilterContext *);
244
245     int priv_size;      ///< size of private data to allocate for the filter
246
247     /**
248      * Used by the filter registration system. Must not be touched by any other
249      * code.
250      */
251     struct AVFilter *next;
252 } AVFilter;
253
254 /**
255  * Process multiple parts of the frame concurrently.
256  */
257 #define AVFILTER_THREAD_SLICE (1 << 0)
258
259 typedef struct AVFilterInternal AVFilterInternal;
260
261 /** An instance of a filter */
262 struct AVFilterContext {
263     const AVClass *av_class;              ///< needed for av_log()
264
265     const AVFilter *filter;         ///< the AVFilter of which this is an instance
266
267     char *name;                     ///< name of this filter instance
268
269     AVFilterPad   *input_pads;      ///< array of input pads
270     AVFilterLink **inputs;          ///< array of pointers to input links
271     unsigned    nb_inputs;          ///< number of input pads
272
273     AVFilterPad   *output_pads;     ///< array of output pads
274     AVFilterLink **outputs;         ///< array of pointers to output links
275     unsigned    nb_outputs;         ///< number of output pads
276
277     void *priv;                     ///< private data for use by the filter
278
279     struct AVFilterGraph *graph;    ///< filtergraph this filter belongs to
280
281     /**
282      * Type of multithreading being allowed/used. A combination of
283      * AVFILTER_THREAD_* flags.
284      *
285      * May be set by the caller before initializing the filter to forbid some
286      * or all kinds of multithreading for this filter. The default is allowing
287      * everything.
288      *
289      * When the filter is initialized, this field is combined using bit AND with
290      * AVFilterGraph.thread_type to get the final mask used for determining
291      * allowed threading types. I.e. a threading type needs to be set in both
292      * to be allowed.
293      *
294      * After the filter is initialzed, libavfilter sets this field to the
295      * threading type that is actually used (0 for no multithreading).
296      */
297     int thread_type;
298
299     /**
300      * An opaque struct for libavfilter internal use.
301      */
302     AVFilterInternal *internal;
303
304     /**
305      * For filters which will create hardware frames, sets the device the
306      * filter should create them in.  All other filters will ignore this field:
307      * in particular, a filter which consumes or processes hardware frames will
308      * instead use the hw_frames_ctx field in AVFilterLink to carry the
309      * hardware context information.
310      */
311     AVBufferRef *hw_device_ctx;
312 };
313
314 /**
315  * A link between two filters. This contains pointers to the source and
316  * destination filters between which this link exists, and the indexes of
317  * the pads involved. In addition, this link also contains the parameters
318  * which have been negotiated and agreed upon between the filter, such as
319  * image dimensions, format, etc.
320  */
321 struct AVFilterLink {
322     AVFilterContext *src;       ///< source filter
323     AVFilterPad *srcpad;        ///< output pad on the source filter
324
325     AVFilterContext *dst;       ///< dest filter
326     AVFilterPad *dstpad;        ///< input pad on the dest filter
327
328     enum AVMediaType type;      ///< filter media type
329
330     /* These parameters apply only to video */
331     int w;                      ///< agreed upon image width
332     int h;                      ///< agreed upon image height
333     AVRational sample_aspect_ratio; ///< agreed upon sample aspect ratio
334     /* These two parameters apply only to audio */
335     uint64_t channel_layout;    ///< channel layout of current buffer (see libavutil/channel_layout.h)
336     int sample_rate;            ///< samples per second
337
338     int format;                 ///< agreed upon media format
339
340     /**
341      * Define the time base used by the PTS of the frames/samples
342      * which will pass through this link.
343      * During the configuration stage, each filter is supposed to
344      * change only the output timebase, while the timebase of the
345      * input link is assumed to be an unchangeable property.
346      */
347     AVRational time_base;
348
349     /*****************************************************************
350      * All fields below this line are not part of the public API. They
351      * may not be used outside of libavfilter and can be changed and
352      * removed at will.
353      * New public fields should be added right above.
354      *****************************************************************
355      */
356     /**
357      * Lists of formats supported by the input and output filters respectively.
358      * These lists are used for negotiating the format to actually be used,
359      * which will be loaded into the format member, above, when chosen.
360      */
361     AVFilterFormats *in_formats;
362     AVFilterFormats *out_formats;
363
364     /**
365      * Lists of channel layouts and sample rates used for automatic
366      * negotiation.
367      */
368     AVFilterFormats  *in_samplerates;
369     AVFilterFormats *out_samplerates;
370     struct AVFilterChannelLayouts  *in_channel_layouts;
371     struct AVFilterChannelLayouts *out_channel_layouts;
372
373     /**
374      * Audio only, the destination filter sets this to a non-zero value to
375      * request that buffers with the given number of samples should be sent to
376      * it. AVFilterPad.needs_fifo must also be set on the corresponding input
377      * pad.
378      * Last buffer before EOF will be padded with silence.
379      */
380     int request_samples;
381
382     /** stage of the initialization of the link properties (dimensions, etc) */
383     enum {
384         AVLINK_UNINIT = 0,      ///< not started
385         AVLINK_STARTINIT,       ///< started, but incomplete
386         AVLINK_INIT             ///< complete
387     } init_state;
388
389     /**
390      * Frame rate of the stream on the link, or 1/0 if unknown or variable;
391      * if left to 0/0, will be automatically copied from the first input
392      * of the source filter if it exists.
393      *
394      * Sources should set it to the real constant frame rate.
395      * If the source frame rate is unknown or variable, set this to 1/0.
396      * Filters should update it if necessary depending on their function.
397      * Sinks can use it to set a default output frame rate.
398      */
399     AVRational frame_rate;
400
401     /**
402      * For hwaccel pixel formats, this should be a reference to the
403      * AVHWFramesContext describing the frames.
404      */
405     AVBufferRef *hw_frames_ctx;
406 };
407
408 /**
409  * Link two filters together.
410  *
411  * @param src    the source filter
412  * @param srcpad index of the output pad on the source filter
413  * @param dst    the destination filter
414  * @param dstpad index of the input pad on the destination filter
415  * @return       zero on success
416  */
417 int avfilter_link(AVFilterContext *src, unsigned srcpad,
418                   AVFilterContext *dst, unsigned dstpad);
419
420 /**
421  * Negotiate the media format, dimensions, etc of all inputs to a filter.
422  *
423  * @param filter the filter to negotiate the properties for its inputs
424  * @return       zero on successful negotiation
425  */
426 int avfilter_config_links(AVFilterContext *filter);
427
428 /** Initialize the filter system. Register all builtin filters. */
429 void avfilter_register_all(void);
430
431 #if FF_API_OLD_FILTER_REGISTER
432 /** Uninitialize the filter system. Unregister all filters. */
433 attribute_deprecated
434 void avfilter_uninit(void);
435 #endif
436
437 /**
438  * Register a filter. This is only needed if you plan to use
439  * avfilter_get_by_name later to lookup the AVFilter structure by name. A
440  * filter can still by instantiated with avfilter_graph_alloc_filter even if it
441  * is not registered.
442  *
443  * @param filter the filter to register
444  * @return 0 if the registration was succesfull, a negative value
445  * otherwise
446  */
447 int avfilter_register(AVFilter *filter);
448
449 /**
450  * Get a filter definition matching the given name.
451  *
452  * @param name the filter name to find
453  * @return     the filter definition, if any matching one is registered.
454  *             NULL if none found.
455  */
456 #if !FF_API_NOCONST_GET_NAME
457 const
458 #endif
459 AVFilter *avfilter_get_by_name(const char *name);
460
461 /**
462  * Iterate over all registered filters.
463  * @return If prev is non-NULL, next registered filter after prev or NULL if
464  * prev is the last filter. If prev is NULL, return the first registered filter.
465  */
466 const AVFilter *avfilter_next(const AVFilter *prev);
467
468 #if FF_API_OLD_FILTER_REGISTER
469 /**
470  * If filter is NULL, returns a pointer to the first registered filter pointer,
471  * if filter is non-NULL, returns the next pointer after filter.
472  * If the returned pointer points to NULL, the last registered filter
473  * was already reached.
474  * @deprecated use avfilter_next()
475  */
476 attribute_deprecated
477 AVFilter **av_filter_next(AVFilter **filter);
478 #endif
479
480 #if FF_API_AVFILTER_OPEN
481 /**
482  * Create a filter instance.
483  *
484  * @param filter_ctx put here a pointer to the created filter context
485  * on success, NULL on failure
486  * @param filter    the filter to create an instance of
487  * @param inst_name Name to give to the new instance. Can be NULL for none.
488  * @return >= 0 in case of success, a negative error code otherwise
489  * @deprecated use avfilter_graph_alloc_filter() instead
490  */
491 attribute_deprecated
492 int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name);
493 #endif
494
495
496 #if FF_API_AVFILTER_INIT_FILTER
497 /**
498  * Initialize a filter.
499  *
500  * @param filter the filter to initialize
501  * @param args   A string of parameters to use when initializing the filter.
502  *               The format and meaning of this string varies by filter.
503  * @param opaque Any extra non-string data needed by the filter. The meaning
504  *               of this parameter varies by filter.
505  * @return       zero on success
506  */
507 attribute_deprecated
508 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
509 #endif
510
511 /**
512  * Initialize a filter with the supplied parameters.
513  *
514  * @param ctx  uninitialized filter context to initialize
515  * @param args Options to initialize the filter with. This must be a
516  *             ':'-separated list of options in the 'key=value' form.
517  *             May be NULL if the options have been set directly using the
518  *             AVOptions API or there are no options that need to be set.
519  * @return 0 on success, a negative AVERROR on failure
520  */
521 int avfilter_init_str(AVFilterContext *ctx, const char *args);
522
523 /**
524  * Initialize a filter with the supplied dictionary of options.
525  *
526  * @param ctx     uninitialized filter context to initialize
527  * @param options An AVDictionary filled with options for this filter. On
528  *                return this parameter will be destroyed and replaced with
529  *                a dict containing options that were not found. This dictionary
530  *                must be freed by the caller.
531  *                May be NULL, then this function is equivalent to
532  *                avfilter_init_str() with the second parameter set to NULL.
533  * @return 0 on success, a negative AVERROR on failure
534  *
535  * @note This function and avfilter_init_str() do essentially the same thing,
536  * the difference is in manner in which the options are passed. It is up to the
537  * calling code to choose whichever is more preferable. The two functions also
538  * behave differently when some of the provided options are not declared as
539  * supported by the filter. In such a case, avfilter_init_str() will fail, but
540  * this function will leave those extra options in the options AVDictionary and
541  * continue as usual.
542  */
543 int avfilter_init_dict(AVFilterContext *ctx, AVDictionary **options);
544
545 /**
546  * Free a filter context. This will also remove the filter from its
547  * filtergraph's list of filters.
548  *
549  * @param filter the filter to free
550  */
551 void avfilter_free(AVFilterContext *filter);
552
553 /**
554  * Insert a filter in the middle of an existing link.
555  *
556  * @param link the link into which the filter should be inserted
557  * @param filt the filter to be inserted
558  * @param filt_srcpad_idx the input pad on the filter to connect
559  * @param filt_dstpad_idx the output pad on the filter to connect
560  * @return     zero on success
561  */
562 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
563                            unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
564
565 /**
566  * @return AVClass for AVFilterContext.
567  *
568  * @see av_opt_find().
569  */
570 const AVClass *avfilter_get_class(void);
571
572 typedef struct AVFilterGraphInternal AVFilterGraphInternal;
573
574 /**
575  * A function pointer passed to the @ref AVFilterGraph.execute callback to be
576  * executed multiple times, possibly in parallel.
577  *
578  * @param ctx the filter context the job belongs to
579  * @param arg an opaque parameter passed through from @ref
580  *            AVFilterGraph.execute
581  * @param jobnr the index of the job being executed
582  * @param nb_jobs the total number of jobs
583  *
584  * @return 0 on success, a negative AVERROR on error
585  */
586 typedef int (avfilter_action_func)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
587
588 /**
589  * A function executing multiple jobs, possibly in parallel.
590  *
591  * @param ctx the filter context to which the jobs belong
592  * @param func the function to be called multiple times
593  * @param arg the argument to be passed to func
594  * @param ret a nb_jobs-sized array to be filled with return values from each
595  *            invocation of func
596  * @param nb_jobs the number of jobs to execute
597  *
598  * @return 0 on success, a negative AVERROR on error
599  */
600 typedef int (avfilter_execute_func)(AVFilterContext *ctx, avfilter_action_func *func,
601                                     void *arg, int *ret, int nb_jobs);
602
603 typedef struct AVFilterGraph {
604     const AVClass *av_class;
605     AVFilterContext **filters;
606     unsigned nb_filters;
607
608     char *scale_sws_opts; ///< sws options to use for the auto-inserted scale filters
609     char *resample_lavr_opts;   ///< libavresample options to use for the auto-inserted resample filters
610
611     /**
612      * Type of multithreading allowed for filters in this graph. A combination
613      * of AVFILTER_THREAD_* flags.
614      *
615      * May be set by the caller at any point, the setting will apply to all
616      * filters initialized after that. The default is allowing everything.
617      *
618      * When a filter in this graph is initialized, this field is combined using
619      * bit AND with AVFilterContext.thread_type to get the final mask used for
620      * determining allowed threading types. I.e. a threading type needs to be
621      * set in both to be allowed.
622      */
623     int thread_type;
624
625     /**
626      * Maximum number of threads used by filters in this graph. May be set by
627      * the caller before adding any filters to the filtergraph. Zero (the
628      * default) means that the number of threads is determined automatically.
629      */
630     int nb_threads;
631
632     /**
633      * Opaque object for libavfilter internal use.
634      */
635     AVFilterGraphInternal *internal;
636
637     /**
638      * Opaque user data. May be set by the caller to an arbitrary value, e.g. to
639      * be used from callbacks like @ref AVFilterGraph.execute.
640      * Libavfilter will not touch this field in any way.
641      */
642     void *opaque;
643
644     /**
645      * This callback may be set by the caller immediately after allocating the
646      * graph and before adding any filters to it, to provide a custom
647      * multithreading implementation.
648      *
649      * If set, filters with slice threading capability will call this callback
650      * to execute multiple jobs in parallel.
651      *
652      * If this field is left unset, libavfilter will use its internal
653      * implementation, which may or may not be multithreaded depending on the
654      * platform and build options.
655      */
656     avfilter_execute_func *execute;
657 } AVFilterGraph;
658
659 /**
660  * Allocate a filter graph.
661  *
662  * @return the allocated filter graph on success or NULL.
663  */
664 AVFilterGraph *avfilter_graph_alloc(void);
665
666 /**
667  * Create a new filter instance in a filter graph.
668  *
669  * @param graph graph in which the new filter will be used
670  * @param filter the filter to create an instance of
671  * @param name Name to give to the new instance (will be copied to
672  *             AVFilterContext.name). This may be used by the caller to identify
673  *             different filters, libavfilter itself assigns no semantics to
674  *             this parameter. May be NULL.
675  *
676  * @return the context of the newly created filter instance (note that it is
677  *         also retrievable directly through AVFilterGraph.filters or with
678  *         avfilter_graph_get_filter()) on success or NULL or failure.
679  */
680 AVFilterContext *avfilter_graph_alloc_filter(AVFilterGraph *graph,
681                                              const AVFilter *filter,
682                                              const char *name);
683
684 /**
685  * Get a filter instance with name name from graph.
686  *
687  * @return the pointer to the found filter instance or NULL if it
688  * cannot be found.
689  */
690 AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, char *name);
691
692 #if FF_API_AVFILTER_OPEN
693 /**
694  * Add an existing filter instance to a filter graph.
695  *
696  * @param graphctx  the filter graph
697  * @param filter the filter to be added
698  *
699  * @deprecated use avfilter_graph_alloc_filter() to allocate a filter in a
700  * filter graph
701  */
702 attribute_deprecated
703 int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter);
704 #endif
705
706 /**
707  * Create and add a filter instance into an existing graph.
708  * The filter instance is created from the filter filt and inited
709  * with the parameters args and opaque.
710  *
711  * In case of success put in *filt_ctx the pointer to the created
712  * filter instance, otherwise set *filt_ctx to NULL.
713  *
714  * @param name the instance name to give to the created filter instance
715  * @param graph_ctx the filter graph
716  * @return a negative AVERROR error code in case of failure, a non
717  * negative value otherwise
718  */
719 int avfilter_graph_create_filter(AVFilterContext **filt_ctx, const AVFilter *filt,
720                                  const char *name, const char *args, void *opaque,
721                                  AVFilterGraph *graph_ctx);
722
723 /**
724  * Check validity and configure all the links and formats in the graph.
725  *
726  * @param graphctx the filter graph
727  * @param log_ctx context used for logging
728  * @return 0 in case of success, a negative AVERROR code otherwise
729  */
730 int avfilter_graph_config(AVFilterGraph *graphctx, void *log_ctx);
731
732 /**
733  * Free a graph, destroy its links, and set *graph to NULL.
734  * If *graph is NULL, do nothing.
735  */
736 void avfilter_graph_free(AVFilterGraph **graph);
737
738 /**
739  * A linked-list of the inputs/outputs of the filter chain.
740  *
741  * This is mainly useful for avfilter_graph_parse() / avfilter_graph_parse2(),
742  * where it is used to communicate open (unlinked) inputs and outputs from and
743  * to the caller.
744  * This struct specifies, per each not connected pad contained in the graph, the
745  * filter context and the pad index required for establishing a link.
746  */
747 typedef struct AVFilterInOut {
748     /** unique name for this input/output in the list */
749     char *name;
750
751     /** filter context associated to this input/output */
752     AVFilterContext *filter_ctx;
753
754     /** index of the filt_ctx pad to use for linking */
755     int pad_idx;
756
757     /** next input/input in the list, NULL if this is the last */
758     struct AVFilterInOut *next;
759 } AVFilterInOut;
760
761 /**
762  * Allocate a single AVFilterInOut entry.
763  * Must be freed with avfilter_inout_free().
764  * @return allocated AVFilterInOut on success, NULL on failure.
765  */
766 AVFilterInOut *avfilter_inout_alloc(void);
767
768 /**
769  * Free the supplied list of AVFilterInOut and set *inout to NULL.
770  * If *inout is NULL, do nothing.
771  */
772 void avfilter_inout_free(AVFilterInOut **inout);
773
774 /**
775  * Add a graph described by a string to a graph.
776  *
777  * @param graph   the filter graph where to link the parsed graph context
778  * @param filters string to be parsed
779  * @param inputs  linked list to the inputs of the graph
780  * @param outputs linked list to the outputs of the graph
781  * @return zero on success, a negative AVERROR code on error
782  */
783 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
784                          AVFilterInOut *inputs, AVFilterInOut *outputs,
785                          void *log_ctx);
786
787 /**
788  * Add a graph described by a string to a graph.
789  *
790  * @param[in]  graph   the filter graph where to link the parsed graph context
791  * @param[in]  filters string to be parsed
792  * @param[out] inputs  a linked list of all free (unlinked) inputs of the
793  *                     parsed graph will be returned here. It is to be freed
794  *                     by the caller using avfilter_inout_free().
795  * @param[out] outputs a linked list of all free (unlinked) outputs of the
796  *                     parsed graph will be returned here. It is to be freed by the
797  *                     caller using avfilter_inout_free().
798  * @return zero on success, a negative AVERROR code on error
799  *
800  * @note the difference between avfilter_graph_parse2() and
801  * avfilter_graph_parse() is that in avfilter_graph_parse(), the caller provides
802  * the lists of inputs and outputs, which therefore must be known before calling
803  * the function. On the other hand, avfilter_graph_parse2() \em returns the
804  * inputs and outputs that are left unlinked after parsing the graph and the
805  * caller then deals with them. Another difference is that in
806  * avfilter_graph_parse(), the inputs parameter describes inputs of the
807  * <em>already existing</em> part of the graph; i.e. from the point of view of
808  * the newly created part, they are outputs. Similarly the outputs parameter
809  * describes outputs of the already existing filters, which are provided as
810  * inputs to the parsed filters.
811  * avfilter_graph_parse2() takes the opposite approach -- it makes no reference
812  * whatsoever to already existing parts of the graph and the inputs parameter
813  * will on return contain inputs of the newly parsed part of the graph.
814  * Analogously the outputs parameter will contain outputs of the newly created
815  * filters.
816  */
817 int avfilter_graph_parse2(AVFilterGraph *graph, const char *filters,
818                           AVFilterInOut **inputs,
819                           AVFilterInOut **outputs);
820
821 /**
822  * @}
823  */
824
825 #endif /* AVFILTER_AVFILTER_H */