lavfi: Always propagate hw_frames_ctx through links
[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     int flags_internal; ///< Additional flags for avfilter internal use only.
248
249     /**
250      * Used by the filter registration system. Must not be touched by any other
251      * code.
252      */
253     struct AVFilter *next;
254 } AVFilter;
255
256 /**
257  * Process multiple parts of the frame concurrently.
258  */
259 #define AVFILTER_THREAD_SLICE (1 << 0)
260
261 typedef struct AVFilterInternal AVFilterInternal;
262
263 /** An instance of a filter */
264 struct AVFilterContext {
265     const AVClass *av_class;              ///< needed for av_log()
266
267     const AVFilter *filter;         ///< the AVFilter of which this is an instance
268
269     char *name;                     ///< name of this filter instance
270
271     AVFilterPad   *input_pads;      ///< array of input pads
272     AVFilterLink **inputs;          ///< array of pointers to input links
273     unsigned    nb_inputs;          ///< number of input pads
274
275     AVFilterPad   *output_pads;     ///< array of output pads
276     AVFilterLink **outputs;         ///< array of pointers to output links
277     unsigned    nb_outputs;         ///< number of output pads
278
279     void *priv;                     ///< private data for use by the filter
280
281     struct AVFilterGraph *graph;    ///< filtergraph this filter belongs to
282
283     /**
284      * Type of multithreading being allowed/used. A combination of
285      * AVFILTER_THREAD_* flags.
286      *
287      * May be set by the caller before initializing the filter to forbid some
288      * or all kinds of multithreading for this filter. The default is allowing
289      * everything.
290      *
291      * When the filter is initialized, this field is combined using bit AND with
292      * AVFilterGraph.thread_type to get the final mask used for determining
293      * allowed threading types. I.e. a threading type needs to be set in both
294      * to be allowed.
295      *
296      * After the filter is initialzed, libavfilter sets this field to the
297      * threading type that is actually used (0 for no multithreading).
298      */
299     int thread_type;
300
301     /**
302      * An opaque struct for libavfilter internal use.
303      */
304     AVFilterInternal *internal;
305
306     /**
307      * For filters which will create hardware frames, sets the device the
308      * filter should create them in.  All other filters will ignore this field:
309      * in particular, a filter which consumes or processes hardware frames will
310      * instead use the hw_frames_ctx field in AVFilterLink to carry the
311      * hardware context information.
312      */
313     AVBufferRef *hw_device_ctx;
314 };
315
316 /**
317  * A link between two filters. This contains pointers to the source and
318  * destination filters between which this link exists, and the indexes of
319  * the pads involved. In addition, this link also contains the parameters
320  * which have been negotiated and agreed upon between the filter, such as
321  * image dimensions, format, etc.
322  */
323 struct AVFilterLink {
324     AVFilterContext *src;       ///< source filter
325     AVFilterPad *srcpad;        ///< output pad on the source filter
326
327     AVFilterContext *dst;       ///< dest filter
328     AVFilterPad *dstpad;        ///< input pad on the dest filter
329
330     enum AVMediaType type;      ///< filter media type
331
332     /* These parameters apply only to video */
333     int w;                      ///< agreed upon image width
334     int h;                      ///< agreed upon image height
335     AVRational sample_aspect_ratio; ///< agreed upon sample aspect ratio
336     /* These two parameters apply only to audio */
337     uint64_t channel_layout;    ///< channel layout of current buffer (see libavutil/channel_layout.h)
338     int sample_rate;            ///< samples per second
339
340     int format;                 ///< agreed upon media format
341
342     /**
343      * Define the time base used by the PTS of the frames/samples
344      * which will pass through this link.
345      * During the configuration stage, each filter is supposed to
346      * change only the output timebase, while the timebase of the
347      * input link is assumed to be an unchangeable property.
348      */
349     AVRational time_base;
350
351     /*****************************************************************
352      * All fields below this line are not part of the public API. They
353      * may not be used outside of libavfilter and can be changed and
354      * removed at will.
355      * New public fields should be added right above.
356      *****************************************************************
357      */
358     /**
359      * Lists of formats supported by the input and output filters respectively.
360      * These lists are used for negotiating the format to actually be used,
361      * which will be loaded into the format member, above, when chosen.
362      */
363     AVFilterFormats *in_formats;
364     AVFilterFormats *out_formats;
365
366     /**
367      * Lists of channel layouts and sample rates used for automatic
368      * negotiation.
369      */
370     AVFilterFormats  *in_samplerates;
371     AVFilterFormats *out_samplerates;
372     struct AVFilterChannelLayouts  *in_channel_layouts;
373     struct AVFilterChannelLayouts *out_channel_layouts;
374
375     /**
376      * Audio only, the destination filter sets this to a non-zero value to
377      * request that buffers with the given number of samples should be sent to
378      * it. AVFilterPad.needs_fifo must also be set on the corresponding input
379      * pad.
380      * Last buffer before EOF will be padded with silence.
381      */
382     int request_samples;
383
384     /** stage of the initialization of the link properties (dimensions, etc) */
385     enum {
386         AVLINK_UNINIT = 0,      ///< not started
387         AVLINK_STARTINIT,       ///< started, but incomplete
388         AVLINK_INIT             ///< complete
389     } init_state;
390
391     /**
392      * Frame rate of the stream on the link, or 1/0 if unknown or variable;
393      * if left to 0/0, will be automatically copied from the first input
394      * of the source filter if it exists.
395      *
396      * Sources should set it to the real constant frame rate.
397      * If the source frame rate is unknown or variable, set this to 1/0.
398      * Filters should update it if necessary depending on their function.
399      * Sinks can use it to set a default output frame rate.
400      */
401     AVRational frame_rate;
402
403     /**
404      * For hwaccel pixel formats, this should be a reference to the
405      * AVHWFramesContext describing the frames.
406      */
407     AVBufferRef *hw_frames_ctx;
408 };
409
410 /**
411  * Link two filters together.
412  *
413  * @param src    the source filter
414  * @param srcpad index of the output pad on the source filter
415  * @param dst    the destination filter
416  * @param dstpad index of the input pad on the destination filter
417  * @return       zero on success
418  */
419 int avfilter_link(AVFilterContext *src, unsigned srcpad,
420                   AVFilterContext *dst, unsigned dstpad);
421
422 /**
423  * Negotiate the media format, dimensions, etc of all inputs to a filter.
424  *
425  * @param filter the filter to negotiate the properties for its inputs
426  * @return       zero on successful negotiation
427  */
428 int avfilter_config_links(AVFilterContext *filter);
429
430 /** Initialize the filter system. Register all builtin filters. */
431 void avfilter_register_all(void);
432
433 #if FF_API_OLD_FILTER_REGISTER
434 /** Uninitialize the filter system. Unregister all filters. */
435 attribute_deprecated
436 void avfilter_uninit(void);
437 #endif
438
439 /**
440  * Register a filter. This is only needed if you plan to use
441  * avfilter_get_by_name later to lookup the AVFilter structure by name. A
442  * filter can still by instantiated with avfilter_graph_alloc_filter even if it
443  * is not registered.
444  *
445  * @param filter the filter to register
446  * @return 0 if the registration was successful, a negative value
447  * otherwise
448  */
449 int avfilter_register(AVFilter *filter);
450
451 /**
452  * Get a filter definition matching the given name.
453  *
454  * @param name the filter name to find
455  * @return     the filter definition, if any matching one is registered.
456  *             NULL if none found.
457  */
458 #if !FF_API_NOCONST_GET_NAME
459 const
460 #endif
461 AVFilter *avfilter_get_by_name(const char *name);
462
463 /**
464  * Iterate over all registered filters.
465  * @return If prev is non-NULL, next registered filter after prev or NULL if
466  * prev is the last filter. If prev is NULL, return the first registered filter.
467  */
468 const AVFilter *avfilter_next(const AVFilter *prev);
469
470 #if FF_API_OLD_FILTER_REGISTER
471 /**
472  * If filter is NULL, returns a pointer to the first registered filter pointer,
473  * if filter is non-NULL, returns the next pointer after filter.
474  * If the returned pointer points to NULL, the last registered filter
475  * was already reached.
476  * @deprecated use avfilter_next()
477  */
478 attribute_deprecated
479 AVFilter **av_filter_next(AVFilter **filter);
480 #endif
481
482 #if FF_API_AVFILTER_OPEN
483 /**
484  * Create a filter instance.
485  *
486  * @param filter_ctx put here a pointer to the created filter context
487  * on success, NULL on failure
488  * @param filter    the filter to create an instance of
489  * @param inst_name Name to give to the new instance. Can be NULL for none.
490  * @return >= 0 in case of success, a negative error code otherwise
491  * @deprecated use avfilter_graph_alloc_filter() instead
492  */
493 attribute_deprecated
494 int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name);
495 #endif
496
497
498 #if FF_API_AVFILTER_INIT_FILTER
499 /**
500  * Initialize a filter.
501  *
502  * @param filter the filter to initialize
503  * @param args   A string of parameters to use when initializing the filter.
504  *               The format and meaning of this string varies by filter.
505  * @param opaque Any extra non-string data needed by the filter. The meaning
506  *               of this parameter varies by filter.
507  * @return       zero on success
508  */
509 attribute_deprecated
510 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
511 #endif
512
513 /**
514  * Initialize a filter with the supplied parameters.
515  *
516  * @param ctx  uninitialized filter context to initialize
517  * @param args Options to initialize the filter with. This must be a
518  *             ':'-separated list of options in the 'key=value' form.
519  *             May be NULL if the options have been set directly using the
520  *             AVOptions API or there are no options that need to be set.
521  * @return 0 on success, a negative AVERROR on failure
522  */
523 int avfilter_init_str(AVFilterContext *ctx, const char *args);
524
525 /**
526  * Initialize a filter with the supplied dictionary of options.
527  *
528  * @param ctx     uninitialized filter context to initialize
529  * @param options An AVDictionary filled with options for this filter. On
530  *                return this parameter will be destroyed and replaced with
531  *                a dict containing options that were not found. This dictionary
532  *                must be freed by the caller.
533  *                May be NULL, then this function is equivalent to
534  *                avfilter_init_str() with the second parameter set to NULL.
535  * @return 0 on success, a negative AVERROR on failure
536  *
537  * @note This function and avfilter_init_str() do essentially the same thing,
538  * the difference is in manner in which the options are passed. It is up to the
539  * calling code to choose whichever is more preferable. The two functions also
540  * behave differently when some of the provided options are not declared as
541  * supported by the filter. In such a case, avfilter_init_str() will fail, but
542  * this function will leave those extra options in the options AVDictionary and
543  * continue as usual.
544  */
545 int avfilter_init_dict(AVFilterContext *ctx, AVDictionary **options);
546
547 /**
548  * Free a filter context. This will also remove the filter from its
549  * filtergraph's list of filters.
550  *
551  * @param filter the filter to free
552  */
553 void avfilter_free(AVFilterContext *filter);
554
555 /**
556  * Insert a filter in the middle of an existing link.
557  *
558  * @param link the link into which the filter should be inserted
559  * @param filt the filter to be inserted
560  * @param filt_srcpad_idx the input pad on the filter to connect
561  * @param filt_dstpad_idx the output pad on the filter to connect
562  * @return     zero on success
563  */
564 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
565                            unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
566
567 /**
568  * @return AVClass for AVFilterContext.
569  *
570  * @see av_opt_find().
571  */
572 const AVClass *avfilter_get_class(void);
573
574 typedef struct AVFilterGraphInternal AVFilterGraphInternal;
575
576 /**
577  * A function pointer passed to the @ref AVFilterGraph.execute callback to be
578  * executed multiple times, possibly in parallel.
579  *
580  * @param ctx the filter context the job belongs to
581  * @param arg an opaque parameter passed through from @ref
582  *            AVFilterGraph.execute
583  * @param jobnr the index of the job being executed
584  * @param nb_jobs the total number of jobs
585  *
586  * @return 0 on success, a negative AVERROR on error
587  */
588 typedef int (avfilter_action_func)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
589
590 /**
591  * A function executing multiple jobs, possibly in parallel.
592  *
593  * @param ctx the filter context to which the jobs belong
594  * @param func the function to be called multiple times
595  * @param arg the argument to be passed to func
596  * @param ret a nb_jobs-sized array to be filled with return values from each
597  *            invocation of func
598  * @param nb_jobs the number of jobs to execute
599  *
600  * @return 0 on success, a negative AVERROR on error
601  */
602 typedef int (avfilter_execute_func)(AVFilterContext *ctx, avfilter_action_func *func,
603                                     void *arg, int *ret, int nb_jobs);
604
605 typedef struct AVFilterGraph {
606     const AVClass *av_class;
607     AVFilterContext **filters;
608     unsigned nb_filters;
609
610     char *scale_sws_opts; ///< sws options to use for the auto-inserted scale filters
611     char *resample_lavr_opts;   ///< libavresample options to use for the auto-inserted resample filters
612
613     /**
614      * Type of multithreading allowed for filters in this graph. A combination
615      * of AVFILTER_THREAD_* flags.
616      *
617      * May be set by the caller at any point, the setting will apply to all
618      * filters initialized after that. The default is allowing everything.
619      *
620      * When a filter in this graph is initialized, this field is combined using
621      * bit AND with AVFilterContext.thread_type to get the final mask used for
622      * determining allowed threading types. I.e. a threading type needs to be
623      * set in both to be allowed.
624      */
625     int thread_type;
626
627     /**
628      * Maximum number of threads used by filters in this graph. May be set by
629      * the caller before adding any filters to the filtergraph. Zero (the
630      * default) means that the number of threads is determined automatically.
631      */
632     int nb_threads;
633
634     /**
635      * Opaque object for libavfilter internal use.
636      */
637     AVFilterGraphInternal *internal;
638
639     /**
640      * Opaque user data. May be set by the caller to an arbitrary value, e.g. to
641      * be used from callbacks like @ref AVFilterGraph.execute.
642      * Libavfilter will not touch this field in any way.
643      */
644     void *opaque;
645
646     /**
647      * This callback may be set by the caller immediately after allocating the
648      * graph and before adding any filters to it, to provide a custom
649      * multithreading implementation.
650      *
651      * If set, filters with slice threading capability will call this callback
652      * to execute multiple jobs in parallel.
653      *
654      * If this field is left unset, libavfilter will use its internal
655      * implementation, which may or may not be multithreaded depending on the
656      * platform and build options.
657      */
658     avfilter_execute_func *execute;
659 } AVFilterGraph;
660
661 /**
662  * Allocate a filter graph.
663  *
664  * @return the allocated filter graph on success or NULL.
665  */
666 AVFilterGraph *avfilter_graph_alloc(void);
667
668 /**
669  * Create a new filter instance in a filter graph.
670  *
671  * @param graph graph in which the new filter will be used
672  * @param filter the filter to create an instance of
673  * @param name Name to give to the new instance (will be copied to
674  *             AVFilterContext.name). This may be used by the caller to identify
675  *             different filters, libavfilter itself assigns no semantics to
676  *             this parameter. May be NULL.
677  *
678  * @return the context of the newly created filter instance (note that it is
679  *         also retrievable directly through AVFilterGraph.filters or with
680  *         avfilter_graph_get_filter()) on success or NULL or failure.
681  */
682 AVFilterContext *avfilter_graph_alloc_filter(AVFilterGraph *graph,
683                                              const AVFilter *filter,
684                                              const char *name);
685
686 /**
687  * Get a filter instance with name name from graph.
688  *
689  * @return the pointer to the found filter instance or NULL if it
690  * cannot be found.
691  */
692 AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, char *name);
693
694 #if FF_API_AVFILTER_OPEN
695 /**
696  * Add an existing filter instance to a filter graph.
697  *
698  * @param graphctx  the filter graph
699  * @param filter the filter to be added
700  *
701  * @deprecated use avfilter_graph_alloc_filter() to allocate a filter in a
702  * filter graph
703  */
704 attribute_deprecated
705 int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter);
706 #endif
707
708 /**
709  * Create and add a filter instance into an existing graph.
710  * The filter instance is created from the filter filt and inited
711  * with the parameters args and opaque.
712  *
713  * In case of success put in *filt_ctx the pointer to the created
714  * filter instance, otherwise set *filt_ctx to NULL.
715  *
716  * @param name the instance name to give to the created filter instance
717  * @param graph_ctx the filter graph
718  * @return a negative AVERROR error code in case of failure, a non
719  * negative value otherwise
720  */
721 int avfilter_graph_create_filter(AVFilterContext **filt_ctx, const AVFilter *filt,
722                                  const char *name, const char *args, void *opaque,
723                                  AVFilterGraph *graph_ctx);
724
725 /**
726  * Check validity and configure all the links and formats in the graph.
727  *
728  * @param graphctx the filter graph
729  * @param log_ctx context used for logging
730  * @return 0 in case of success, a negative AVERROR code otherwise
731  */
732 int avfilter_graph_config(AVFilterGraph *graphctx, void *log_ctx);
733
734 /**
735  * Free a graph, destroy its links, and set *graph to NULL.
736  * If *graph is NULL, do nothing.
737  */
738 void avfilter_graph_free(AVFilterGraph **graph);
739
740 /**
741  * A linked-list of the inputs/outputs of the filter chain.
742  *
743  * This is mainly useful for avfilter_graph_parse() / avfilter_graph_parse2(),
744  * where it is used to communicate open (unlinked) inputs and outputs from and
745  * to the caller.
746  * This struct specifies, per each not connected pad contained in the graph, the
747  * filter context and the pad index required for establishing a link.
748  */
749 typedef struct AVFilterInOut {
750     /** unique name for this input/output in the list */
751     char *name;
752
753     /** filter context associated to this input/output */
754     AVFilterContext *filter_ctx;
755
756     /** index of the filt_ctx pad to use for linking */
757     int pad_idx;
758
759     /** next input/input in the list, NULL if this is the last */
760     struct AVFilterInOut *next;
761 } AVFilterInOut;
762
763 /**
764  * Allocate a single AVFilterInOut entry.
765  * Must be freed with avfilter_inout_free().
766  * @return allocated AVFilterInOut on success, NULL on failure.
767  */
768 AVFilterInOut *avfilter_inout_alloc(void);
769
770 /**
771  * Free the supplied list of AVFilterInOut and set *inout to NULL.
772  * If *inout is NULL, do nothing.
773  */
774 void avfilter_inout_free(AVFilterInOut **inout);
775
776 /**
777  * Add a graph described by a string to a graph.
778  *
779  * @param graph   the filter graph where to link the parsed graph context
780  * @param filters string to be parsed
781  * @param inputs  linked list to the inputs of the graph
782  * @param outputs linked list to the outputs of the graph
783  * @return zero on success, a negative AVERROR code on error
784  */
785 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
786                          AVFilterInOut *inputs, AVFilterInOut *outputs,
787                          void *log_ctx);
788
789 /**
790  * Add a graph described by a string to a graph.
791  *
792  * @param[in]  graph   the filter graph where to link the parsed graph context
793  * @param[in]  filters string to be parsed
794  * @param[out] inputs  a linked list of all free (unlinked) inputs of the
795  *                     parsed graph will be returned here. It is to be freed
796  *                     by the caller using avfilter_inout_free().
797  * @param[out] outputs a linked list of all free (unlinked) outputs of the
798  *                     parsed graph will be returned here. It is to be freed by the
799  *                     caller using avfilter_inout_free().
800  * @return zero on success, a negative AVERROR code on error
801  *
802  * @note the difference between avfilter_graph_parse2() and
803  * avfilter_graph_parse() is that in avfilter_graph_parse(), the caller provides
804  * the lists of inputs and outputs, which therefore must be known before calling
805  * the function. On the other hand, avfilter_graph_parse2() \em returns the
806  * inputs and outputs that are left unlinked after parsing the graph and the
807  * caller then deals with them. Another difference is that in
808  * avfilter_graph_parse(), the inputs parameter describes inputs of the
809  * <em>already existing</em> part of the graph; i.e. from the point of view of
810  * the newly created part, they are outputs. Similarly the outputs parameter
811  * describes outputs of the already existing filters, which are provided as
812  * inputs to the parsed filters.
813  * avfilter_graph_parse2() takes the opposite approach -- it makes no reference
814  * whatsoever to already existing parts of the graph and the inputs parameter
815  * will on return contain inputs of the newly parsed part of the graph.
816  * Analogously the outputs parameter will contain outputs of the newly created
817  * filters.
818  */
819 int avfilter_graph_parse2(AVFilterGraph *graph, const char *filters,
820                           AVFilterInOut **inputs,
821                           AVFilterInOut **outputs);
822
823 /**
824  * @}
825  */
826
827 #endif /* AVFILTER_AVFILTER_H */