lavfi/framepool: rename FFVideoFramePool to FFFramePool
[ffmpeg.git] / libavfilter / avfilter.h
1 /*
2  * filter layer
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_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
33  * Graph-based frame editing library.
34  *
35  * @{
36  */
37
38 #include <stddef.h>
39
40 #include "libavutil/attributes.h"
41 #include "libavutil/avutil.h"
42 #include "libavutil/buffer.h"
43 #include "libavutil/dict.h"
44 #include "libavutil/frame.h"
45 #include "libavutil/log.h"
46 #include "libavutil/samplefmt.h"
47 #include "libavutil/pixfmt.h"
48 #include "libavutil/rational.h"
49
50 #include "libavfilter/version.h"
51
52 /**
53  * Return the LIBAVFILTER_VERSION_INT constant.
54  */
55 unsigned avfilter_version(void);
56
57 /**
58  * Return the libavfilter build-time configuration.
59  */
60 const char *avfilter_configuration(void);
61
62 /**
63  * Return the libavfilter license.
64  */
65 const char *avfilter_license(void);
66
67 typedef struct AVFilterContext AVFilterContext;
68 typedef struct AVFilterLink    AVFilterLink;
69 typedef struct AVFilterPad     AVFilterPad;
70 typedef struct AVFilterFormats AVFilterFormats;
71
72 /**
73  * Get the number of elements in a NULL-terminated array of AVFilterPads (e.g.
74  * AVFilter.inputs/outputs).
75  */
76 int avfilter_pad_count(const AVFilterPad *pads);
77
78 /**
79  * Get the name of an AVFilterPad.
80  *
81  * @param pads an array of AVFilterPads
82  * @param pad_idx index of the pad in the array it; is the caller's
83  *                responsibility to ensure the index is valid
84  *
85  * @return name of the pad_idx'th pad in pads
86  */
87 const char *avfilter_pad_get_name(const AVFilterPad *pads, int pad_idx);
88
89 /**
90  * Get the type of an AVFilterPad.
91  *
92  * @param pads an array of AVFilterPads
93  * @param pad_idx index of the pad in the array; it is the caller's
94  *                responsibility to ensure the index is valid
95  *
96  * @return type of the pad_idx'th pad in pads
97  */
98 enum AVMediaType avfilter_pad_get_type(const AVFilterPad *pads, int pad_idx);
99
100 /**
101  * The number of the filter inputs is not determined just by AVFilter.inputs.
102  * The filter might add additional inputs during initialization depending on the
103  * options supplied to it.
104  */
105 #define AVFILTER_FLAG_DYNAMIC_INPUTS        (1 << 0)
106 /**
107  * The number of the filter outputs is not determined just by AVFilter.outputs.
108  * The filter might add additional outputs during initialization depending on
109  * the options supplied to it.
110  */
111 #define AVFILTER_FLAG_DYNAMIC_OUTPUTS       (1 << 1)
112 /**
113  * The filter supports multithreading by splitting frames into multiple parts
114  * and processing them concurrently.
115  */
116 #define AVFILTER_FLAG_SLICE_THREADS         (1 << 2)
117 /**
118  * Some filters support a generic "enable" expression option that can be used
119  * to enable or disable a filter in the timeline. Filters supporting this
120  * option have this flag set. When the enable expression is false, the default
121  * no-op filter_frame() function is called in place of the filter_frame()
122  * callback defined on each input pad, thus the frame is passed unchanged to
123  * the next filters.
124  */
125 #define AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC  (1 << 16)
126 /**
127  * Same as AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC, except that the filter will
128  * have its filter_frame() callback(s) called as usual even when the enable
129  * expression is false. The filter will disable filtering within the
130  * filter_frame() callback(s) itself, for example executing code depending on
131  * the AVFilterContext->is_disabled value.
132  */
133 #define AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL (1 << 17)
134 /**
135  * Handy mask to test whether the filter supports or no the timeline feature
136  * (internally or generically).
137  */
138 #define AVFILTER_FLAG_SUPPORT_TIMELINE (AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL)
139
140 /**
141  * Filter definition. This defines the pads a filter contains, and all the
142  * callback functions used to interact with the filter.
143  */
144 typedef struct AVFilter {
145     /**
146      * Filter name. Must be non-NULL and unique among filters.
147      */
148     const char *name;
149
150     /**
151      * A description of the filter. May be NULL.
152      *
153      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
154      */
155     const char *description;
156
157     /**
158      * List of inputs, terminated by a zeroed element.
159      *
160      * NULL if there are no (static) inputs. Instances of filters with
161      * AVFILTER_FLAG_DYNAMIC_INPUTS set may have more inputs than present in
162      * this list.
163      */
164     const AVFilterPad *inputs;
165     /**
166      * List of outputs, terminated by a zeroed element.
167      *
168      * NULL if there are no (static) outputs. Instances of filters with
169      * AVFILTER_FLAG_DYNAMIC_OUTPUTS set may have more outputs than present in
170      * this list.
171      */
172     const AVFilterPad *outputs;
173
174     /**
175      * A class for the private data, used to declare filter private AVOptions.
176      * This field is NULL for filters that do not declare any options.
177      *
178      * If this field is non-NULL, the first member of the filter private data
179      * must be a pointer to AVClass, which will be set by libavfilter generic
180      * code to this class.
181      */
182     const AVClass *priv_class;
183
184     /**
185      * A combination of AVFILTER_FLAG_*
186      */
187     int flags;
188
189     /*****************************************************************
190      * All fields below this line are not part of the public API. They
191      * may not be used outside of libavfilter and can be changed and
192      * removed at will.
193      * New public fields should be added right above.
194      *****************************************************************
195      */
196
197     /**
198      * Filter initialization function.
199      *
200      * This callback will be called only once during the filter lifetime, after
201      * all the options have been set, but before links between filters are
202      * established and format negotiation is done.
203      *
204      * Basic filter initialization should be done here. Filters with dynamic
205      * inputs and/or outputs should create those inputs/outputs here based on
206      * provided options. No more changes to this filter's inputs/outputs can be
207      * done after this callback.
208      *
209      * This callback must not assume that the filter links exist or frame
210      * parameters are known.
211      *
212      * @ref AVFilter.uninit "uninit" is guaranteed to be called even if
213      * initialization fails, so this callback does not have to clean up on
214      * failure.
215      *
216      * @return 0 on success, a negative AVERROR on failure
217      */
218     int (*init)(AVFilterContext *ctx);
219
220     /**
221      * Should be set instead of @ref AVFilter.init "init" by the filters that
222      * want to pass a dictionary of AVOptions to nested contexts that are
223      * allocated during init.
224      *
225      * On return, the options dict should be freed and replaced with one that
226      * contains all the options which could not be processed by this filter (or
227      * with NULL if all the options were processed).
228      *
229      * Otherwise the semantics is the same as for @ref AVFilter.init "init".
230      */
231     int (*init_dict)(AVFilterContext *ctx, AVDictionary **options);
232
233     /**
234      * Filter uninitialization function.
235      *
236      * Called only once right before the filter is freed. Should deallocate any
237      * memory held by the filter, release any buffer references, etc. It does
238      * not need to deallocate the AVFilterContext.priv memory itself.
239      *
240      * This callback may be called even if @ref AVFilter.init "init" was not
241      * called or failed, so it must be prepared to handle such a situation.
242      */
243     void (*uninit)(AVFilterContext *ctx);
244
245     /**
246      * Query formats supported by the filter on its inputs and outputs.
247      *
248      * This callback is called after the filter is initialized (so the inputs
249      * and outputs are fixed), shortly before the format negotiation. This
250      * callback may be called more than once.
251      *
252      * This callback must set AVFilterLink.out_formats on every input link and
253      * AVFilterLink.in_formats on every output link to a list of pixel/sample
254      * formats that the filter supports on that link. For audio links, this
255      * filter must also set @ref AVFilterLink.in_samplerates "in_samplerates" /
256      * @ref AVFilterLink.out_samplerates "out_samplerates" and
257      * @ref AVFilterLink.in_channel_layouts "in_channel_layouts" /
258      * @ref AVFilterLink.out_channel_layouts "out_channel_layouts" analogously.
259      *
260      * This callback may be NULL for filters with one input, in which case
261      * libavfilter assumes that it supports all input formats and preserves
262      * them on output.
263      *
264      * @return zero on success, a negative value corresponding to an
265      * AVERROR code otherwise
266      */
267     int (*query_formats)(AVFilterContext *);
268
269     int priv_size;      ///< size of private data to allocate for the filter
270
271     /**
272      * Used by the filter registration system. Must not be touched by any other
273      * code.
274      */
275     struct AVFilter *next;
276
277     /**
278      * Make the filter instance process a command.
279      *
280      * @param cmd    the command to process, for handling simplicity all commands must be alphanumeric only
281      * @param arg    the argument for the command
282      * @param res    a buffer with size res_size where the filter(s) can return a response. This must not change when the command is not supported.
283      * @param flags  if AVFILTER_CMD_FLAG_FAST is set and the command would be
284      *               time consuming then a filter should treat it like an unsupported command
285      *
286      * @returns >=0 on success otherwise an error code.
287      *          AVERROR(ENOSYS) on unsupported commands
288      */
289     int (*process_command)(AVFilterContext *, const char *cmd, const char *arg, char *res, int res_len, int flags);
290
291     /**
292      * Filter initialization function, alternative to the init()
293      * callback. Args contains the user-supplied parameters, opaque is
294      * used for providing binary data.
295      */
296     int (*init_opaque)(AVFilterContext *ctx, void *opaque);
297 } AVFilter;
298
299 /**
300  * Process multiple parts of the frame concurrently.
301  */
302 #define AVFILTER_THREAD_SLICE (1 << 0)
303
304 typedef struct AVFilterInternal AVFilterInternal;
305
306 /** An instance of a filter */
307 struct AVFilterContext {
308     const AVClass *av_class;        ///< needed for av_log() and filters common options
309
310     const AVFilter *filter;         ///< the AVFilter of which this is an instance
311
312     char *name;                     ///< name of this filter instance
313
314     AVFilterPad   *input_pads;      ///< array of input pads
315     AVFilterLink **inputs;          ///< array of pointers to input links
316     unsigned    nb_inputs;          ///< number of input pads
317
318     AVFilterPad   *output_pads;     ///< array of output pads
319     AVFilterLink **outputs;         ///< array of pointers to output links
320     unsigned    nb_outputs;         ///< number of output pads
321
322     void *priv;                     ///< private data for use by the filter
323
324     struct AVFilterGraph *graph;    ///< filtergraph this filter belongs to
325
326     /**
327      * Type of multithreading being allowed/used. A combination of
328      * AVFILTER_THREAD_* flags.
329      *
330      * May be set by the caller before initializing the filter to forbid some
331      * or all kinds of multithreading for this filter. The default is allowing
332      * everything.
333      *
334      * When the filter is initialized, this field is combined using bit AND with
335      * AVFilterGraph.thread_type to get the final mask used for determining
336      * allowed threading types. I.e. a threading type needs to be set in both
337      * to be allowed.
338      *
339      * After the filter is initialized, libavfilter sets this field to the
340      * threading type that is actually used (0 for no multithreading).
341      */
342     int thread_type;
343
344     /**
345      * An opaque struct for libavfilter internal use.
346      */
347     AVFilterInternal *internal;
348
349     struct AVFilterCommand *command_queue;
350
351     char *enable_str;               ///< enable expression string
352     void *enable;                   ///< parsed expression (AVExpr*)
353     double *var_values;             ///< variable values for the enable expression
354     int is_disabled;                ///< the enabled state from the last expression evaluation
355
356     /**
357      * For filters which will create hardware frames, sets the device the
358      * filter should create them in.  All other filters will ignore this field:
359      * in particular, a filter which consumes or processes hardware frames will
360      * instead use the hw_frames_ctx field in AVFilterLink to carry the
361      * hardware context information.
362      */
363     AVBufferRef *hw_device_ctx;
364
365     /**
366      * Max number of threads allowed in this filter instance.
367      * If <= 0, its value is ignored.
368      * Overrides global number of threads set per filter graph.
369      */
370     int nb_threads;
371
372     /**
373      * Ready status of the filter.
374      * A non-0 value means that the filter needs activating;
375      * a higher value suggests a more urgent activation.
376      */
377     unsigned ready;
378 };
379
380 /**
381  * A link between two filters. This contains pointers to the source and
382  * destination filters between which this link exists, and the indexes of
383  * the pads involved. In addition, this link also contains the parameters
384  * which have been negotiated and agreed upon between the filter, such as
385  * image dimensions, format, etc.
386  */
387 struct AVFilterLink {
388     AVFilterContext *src;       ///< source filter
389     AVFilterPad *srcpad;        ///< output pad on the source filter
390
391     AVFilterContext *dst;       ///< dest filter
392     AVFilterPad *dstpad;        ///< input pad on the dest filter
393
394     enum AVMediaType type;      ///< filter media type
395
396     /* These parameters apply only to video */
397     int w;                      ///< agreed upon image width
398     int h;                      ///< agreed upon image height
399     AVRational sample_aspect_ratio; ///< agreed upon sample aspect ratio
400     /* These parameters apply only to audio */
401     uint64_t channel_layout;    ///< channel layout of current buffer (see libavutil/channel_layout.h)
402     int sample_rate;            ///< samples per second
403
404     int format;                 ///< agreed upon media format
405
406     /**
407      * Define the time base used by the PTS of the frames/samples
408      * which will pass through this link.
409      * During the configuration stage, each filter is supposed to
410      * change only the output timebase, while the timebase of the
411      * input link is assumed to be an unchangeable property.
412      */
413     AVRational time_base;
414
415     /*****************************************************************
416      * All fields below this line are not part of the public API. They
417      * may not be used outside of libavfilter and can be changed and
418      * removed at will.
419      * New public fields should be added right above.
420      *****************************************************************
421      */
422     /**
423      * Lists of formats and channel layouts supported by the input and output
424      * filters respectively. These lists are used for negotiating the format
425      * to actually be used, which will be loaded into the format and
426      * channel_layout members, above, when chosen.
427      *
428      */
429     AVFilterFormats *in_formats;
430     AVFilterFormats *out_formats;
431
432     /**
433      * Lists of channel layouts and sample rates used for automatic
434      * negotiation.
435      */
436     AVFilterFormats  *in_samplerates;
437     AVFilterFormats *out_samplerates;
438     struct AVFilterChannelLayouts  *in_channel_layouts;
439     struct AVFilterChannelLayouts *out_channel_layouts;
440
441     /**
442      * Audio only, the destination filter sets this to a non-zero value to
443      * request that buffers with the given number of samples should be sent to
444      * it. AVFilterPad.needs_fifo must also be set on the corresponding input
445      * pad.
446      * Last buffer before EOF will be padded with silence.
447      */
448     int request_samples;
449
450     /** stage of the initialization of the link properties (dimensions, etc) */
451     enum {
452         AVLINK_UNINIT = 0,      ///< not started
453         AVLINK_STARTINIT,       ///< started, but incomplete
454         AVLINK_INIT             ///< complete
455     } init_state;
456
457     /**
458      * Graph the filter belongs to.
459      */
460     struct AVFilterGraph *graph;
461
462     /**
463      * Current timestamp of the link, as defined by the most recent
464      * frame(s), in link time_base units.
465      */
466     int64_t current_pts;
467
468     /**
469      * Current timestamp of the link, as defined by the most recent
470      * frame(s), in AV_TIME_BASE units.
471      */
472     int64_t current_pts_us;
473
474     /**
475      * Index in the age array.
476      */
477     int age_index;
478
479     /**
480      * Frame rate of the stream on the link, or 1/0 if unknown or variable;
481      * if left to 0/0, will be automatically copied from the first input
482      * of the source filter if it exists.
483      *
484      * Sources should set it to the best estimation of the real frame rate.
485      * If the source frame rate is unknown or variable, set this to 1/0.
486      * Filters should update it if necessary depending on their function.
487      * Sinks can use it to set a default output frame rate.
488      * It is similar to the r_frame_rate field in AVStream.
489      */
490     AVRational frame_rate;
491
492     /**
493      * Buffer partially filled with samples to achieve a fixed/minimum size.
494      */
495     AVFrame *partial_buf;
496
497     /**
498      * Size of the partial buffer to allocate.
499      * Must be between min_samples and max_samples.
500      */
501     int partial_buf_size;
502
503     /**
504      * Minimum number of samples to filter at once. If filter_frame() is
505      * called with fewer samples, it will accumulate them in partial_buf.
506      * This field and the related ones must not be changed after filtering
507      * has started.
508      * If 0, all related fields are ignored.
509      */
510     int min_samples;
511
512     /**
513      * Maximum number of samples to filter at once. If filter_frame() is
514      * called with more samples, it will split them.
515      */
516     int max_samples;
517
518     /**
519      * Number of channels.
520      */
521     int channels;
522
523     /**
524      * Link processing flags.
525      */
526     unsigned flags;
527
528     /**
529      * Number of past frames sent through the link.
530      */
531     int64_t frame_count_in, frame_count_out;
532
533     /**
534      * A pointer to a FFFramePool struct.
535      */
536     void *frame_pool;
537
538     /**
539      * True if a frame is currently wanted on the output of this filter.
540      * Set when ff_request_frame() is called by the output,
541      * cleared when a frame is filtered.
542      */
543     int frame_wanted_out;
544
545     /**
546      * For hwaccel pixel formats, this should be a reference to the
547      * AVHWFramesContext describing the frames.
548      */
549     AVBufferRef *hw_frames_ctx;
550
551 #ifndef FF_INTERNAL_FIELDS
552
553     /**
554      * Internal structure members.
555      * The fields below this limit are internal for libavfilter's use
556      * and must in no way be accessed by applications.
557      */
558     char reserved[0xF000];
559
560 #else /* FF_INTERNAL_FIELDS */
561
562     /**
563      * Queue of frames waiting to be filtered.
564      */
565     FFFrameQueue fifo;
566
567     /**
568      * If set, the source filter can not generate a frame as is.
569      * The goal is to avoid repeatedly calling the request_frame() method on
570      * the same link.
571      */
572     int frame_blocked_in;
573
574     /**
575      * Link input status.
576      * If not zero, all attempts of filter_frame will fail with the
577      * corresponding code.
578      */
579     int status_in;
580
581     /**
582      * Timestamp of the input status change.
583      */
584     int64_t status_in_pts;
585
586     /**
587      * Link output status.
588      * If not zero, all attempts of request_frame will fail with the
589      * corresponding code.
590      */
591     int status_out;
592
593 #endif /* FF_INTERNAL_FIELDS */
594
595 };
596
597 /**
598  * Link two filters together.
599  *
600  * @param src    the source filter
601  * @param srcpad index of the output pad on the source filter
602  * @param dst    the destination filter
603  * @param dstpad index of the input pad on the destination filter
604  * @return       zero on success
605  */
606 int avfilter_link(AVFilterContext *src, unsigned srcpad,
607                   AVFilterContext *dst, unsigned dstpad);
608
609 /**
610  * Free the link in *link, and set its pointer to NULL.
611  */
612 void avfilter_link_free(AVFilterLink **link);
613
614 /**
615  * Get the number of channels of a link.
616  */
617 int avfilter_link_get_channels(AVFilterLink *link);
618
619 /**
620  * Set the closed field of a link.
621  * @deprecated applications are not supposed to mess with links, they should
622  * close the sinks.
623  */
624 attribute_deprecated
625 void avfilter_link_set_closed(AVFilterLink *link, int closed);
626
627 /**
628  * Negotiate the media format, dimensions, etc of all inputs to a filter.
629  *
630  * @param filter the filter to negotiate the properties for its inputs
631  * @return       zero on successful negotiation
632  */
633 int avfilter_config_links(AVFilterContext *filter);
634
635 #define AVFILTER_CMD_FLAG_ONE   1 ///< Stop once a filter understood the command (for target=all for example), fast filters are favored automatically
636 #define AVFILTER_CMD_FLAG_FAST  2 ///< Only execute command when its fast (like a video out that supports contrast adjustment in hw)
637
638 /**
639  * Make the filter instance process a command.
640  * It is recommended to use avfilter_graph_send_command().
641  */
642 int avfilter_process_command(AVFilterContext *filter, const char *cmd, const char *arg, char *res, int res_len, int flags);
643
644 /** Initialize the filter system. Register all builtin filters. */
645 void avfilter_register_all(void);
646
647 #if FF_API_OLD_FILTER_REGISTER
648 /** Uninitialize the filter system. Unregister all filters. */
649 attribute_deprecated
650 void avfilter_uninit(void);
651 #endif
652
653 /**
654  * Register a filter. This is only needed if you plan to use
655  * avfilter_get_by_name later to lookup the AVFilter structure by name. A
656  * filter can still by instantiated with avfilter_graph_alloc_filter even if it
657  * is not registered.
658  *
659  * @param filter the filter to register
660  * @return 0 if the registration was successful, a negative value
661  * otherwise
662  */
663 int avfilter_register(AVFilter *filter);
664
665 /**
666  * Get a filter definition matching the given name.
667  *
668  * @param name the filter name to find
669  * @return     the filter definition, if any matching one is registered.
670  *             NULL if none found.
671  */
672 #if !FF_API_NOCONST_GET_NAME
673 const
674 #endif
675 AVFilter *avfilter_get_by_name(const char *name);
676
677 /**
678  * Iterate over all registered filters.
679  * @return If prev is non-NULL, next registered filter after prev or NULL if
680  * prev is the last filter. If prev is NULL, return the first registered filter.
681  */
682 const AVFilter *avfilter_next(const AVFilter *prev);
683
684 #if FF_API_OLD_FILTER_REGISTER
685 /**
686  * If filter is NULL, returns a pointer to the first registered filter pointer,
687  * if filter is non-NULL, returns the next pointer after filter.
688  * If the returned pointer points to NULL, the last registered filter
689  * was already reached.
690  * @deprecated use avfilter_next()
691  */
692 attribute_deprecated
693 AVFilter **av_filter_next(AVFilter **filter);
694 #endif
695
696 #if FF_API_AVFILTER_OPEN
697 /**
698  * Create a filter instance.
699  *
700  * @param filter_ctx put here a pointer to the created filter context
701  * on success, NULL on failure
702  * @param filter    the filter to create an instance of
703  * @param inst_name Name to give to the new instance. Can be NULL for none.
704  * @return >= 0 in case of success, a negative error code otherwise
705  * @deprecated use avfilter_graph_alloc_filter() instead
706  */
707 attribute_deprecated
708 int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name);
709 #endif
710
711
712 #if FF_API_AVFILTER_INIT_FILTER
713 /**
714  * Initialize a filter.
715  *
716  * @param filter the filter to initialize
717  * @param args   A string of parameters to use when initializing the filter.
718  *               The format and meaning of this string varies by filter.
719  * @param opaque Any extra non-string data needed by the filter. The meaning
720  *               of this parameter varies by filter.
721  * @return       zero on success
722  */
723 attribute_deprecated
724 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
725 #endif
726
727 /**
728  * Initialize a filter with the supplied parameters.
729  *
730  * @param ctx  uninitialized filter context to initialize
731  * @param args Options to initialize the filter with. This must be a
732  *             ':'-separated list of options in the 'key=value' form.
733  *             May be NULL if the options have been set directly using the
734  *             AVOptions API or there are no options that need to be set.
735  * @return 0 on success, a negative AVERROR on failure
736  */
737 int avfilter_init_str(AVFilterContext *ctx, const char *args);
738
739 /**
740  * Initialize a filter with the supplied dictionary of options.
741  *
742  * @param ctx     uninitialized filter context to initialize
743  * @param options An AVDictionary filled with options for this filter. On
744  *                return this parameter will be destroyed and replaced with
745  *                a dict containing options that were not found. This dictionary
746  *                must be freed by the caller.
747  *                May be NULL, then this function is equivalent to
748  *                avfilter_init_str() with the second parameter set to NULL.
749  * @return 0 on success, a negative AVERROR on failure
750  *
751  * @note This function and avfilter_init_str() do essentially the same thing,
752  * the difference is in manner in which the options are passed. It is up to the
753  * calling code to choose whichever is more preferable. The two functions also
754  * behave differently when some of the provided options are not declared as
755  * supported by the filter. In such a case, avfilter_init_str() will fail, but
756  * this function will leave those extra options in the options AVDictionary and
757  * continue as usual.
758  */
759 int avfilter_init_dict(AVFilterContext *ctx, AVDictionary **options);
760
761 /**
762  * Free a filter context. This will also remove the filter from its
763  * filtergraph's list of filters.
764  *
765  * @param filter the filter to free
766  */
767 void avfilter_free(AVFilterContext *filter);
768
769 /**
770  * Insert a filter in the middle of an existing link.
771  *
772  * @param link the link into which the filter should be inserted
773  * @param filt the filter to be inserted
774  * @param filt_srcpad_idx the input pad on the filter to connect
775  * @param filt_dstpad_idx the output pad on the filter to connect
776  * @return     zero on success
777  */
778 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
779                            unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
780
781 /**
782  * @return AVClass for AVFilterContext.
783  *
784  * @see av_opt_find().
785  */
786 const AVClass *avfilter_get_class(void);
787
788 typedef struct AVFilterGraphInternal AVFilterGraphInternal;
789
790 /**
791  * A function pointer passed to the @ref AVFilterGraph.execute callback to be
792  * executed multiple times, possibly in parallel.
793  *
794  * @param ctx the filter context the job belongs to
795  * @param arg an opaque parameter passed through from @ref
796  *            AVFilterGraph.execute
797  * @param jobnr the index of the job being executed
798  * @param nb_jobs the total number of jobs
799  *
800  * @return 0 on success, a negative AVERROR on error
801  */
802 typedef int (avfilter_action_func)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
803
804 /**
805  * A function executing multiple jobs, possibly in parallel.
806  *
807  * @param ctx the filter context to which the jobs belong
808  * @param func the function to be called multiple times
809  * @param arg the argument to be passed to func
810  * @param ret a nb_jobs-sized array to be filled with return values from each
811  *            invocation of func
812  * @param nb_jobs the number of jobs to execute
813  *
814  * @return 0 on success, a negative AVERROR on error
815  */
816 typedef int (avfilter_execute_func)(AVFilterContext *ctx, avfilter_action_func *func,
817                                     void *arg, int *ret, int nb_jobs);
818
819 typedef struct AVFilterGraph {
820     const AVClass *av_class;
821     AVFilterContext **filters;
822     unsigned nb_filters;
823
824     char *scale_sws_opts; ///< sws options to use for the auto-inserted scale filters
825     char *resample_lavr_opts;   ///< libavresample options to use for the auto-inserted resample filters
826
827     /**
828      * Type of multithreading allowed for filters in this graph. A combination
829      * of AVFILTER_THREAD_* flags.
830      *
831      * May be set by the caller at any point, the setting will apply to all
832      * filters initialized after that. The default is allowing everything.
833      *
834      * When a filter in this graph is initialized, this field is combined using
835      * bit AND with AVFilterContext.thread_type to get the final mask used for
836      * determining allowed threading types. I.e. a threading type needs to be
837      * set in both to be allowed.
838      */
839     int thread_type;
840
841     /**
842      * Maximum number of threads used by filters in this graph. May be set by
843      * the caller before adding any filters to the filtergraph. Zero (the
844      * default) means that the number of threads is determined automatically.
845      */
846     int nb_threads;
847
848     /**
849      * Opaque object for libavfilter internal use.
850      */
851     AVFilterGraphInternal *internal;
852
853     /**
854      * Opaque user data. May be set by the caller to an arbitrary value, e.g. to
855      * be used from callbacks like @ref AVFilterGraph.execute.
856      * Libavfilter will not touch this field in any way.
857      */
858     void *opaque;
859
860     /**
861      * This callback may be set by the caller immediately after allocating the
862      * graph and before adding any filters to it, to provide a custom
863      * multithreading implementation.
864      *
865      * If set, filters with slice threading capability will call this callback
866      * to execute multiple jobs in parallel.
867      *
868      * If this field is left unset, libavfilter will use its internal
869      * implementation, which may or may not be multithreaded depending on the
870      * platform and build options.
871      */
872     avfilter_execute_func *execute;
873
874     char *aresample_swr_opts; ///< swr options to use for the auto-inserted aresample filters, Access ONLY through AVOptions
875
876     /**
877      * Private fields
878      *
879      * The following fields are for internal use only.
880      * Their type, offset, number and semantic can change without notice.
881      */
882
883     AVFilterLink **sink_links;
884     int sink_links_count;
885
886     unsigned disable_auto_convert;
887 } AVFilterGraph;
888
889 /**
890  * Allocate a filter graph.
891  *
892  * @return the allocated filter graph on success or NULL.
893  */
894 AVFilterGraph *avfilter_graph_alloc(void);
895
896 /**
897  * Create a new filter instance in a filter graph.
898  *
899  * @param graph graph in which the new filter will be used
900  * @param filter the filter to create an instance of
901  * @param name Name to give to the new instance (will be copied to
902  *             AVFilterContext.name). This may be used by the caller to identify
903  *             different filters, libavfilter itself assigns no semantics to
904  *             this parameter. May be NULL.
905  *
906  * @return the context of the newly created filter instance (note that it is
907  *         also retrievable directly through AVFilterGraph.filters or with
908  *         avfilter_graph_get_filter()) on success or NULL on failure.
909  */
910 AVFilterContext *avfilter_graph_alloc_filter(AVFilterGraph *graph,
911                                              const AVFilter *filter,
912                                              const char *name);
913
914 /**
915  * Get a filter instance identified by instance name from graph.
916  *
917  * @param graph filter graph to search through.
918  * @param name filter instance name (should be unique in the graph).
919  * @return the pointer to the found filter instance or NULL if it
920  * cannot be found.
921  */
922 AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, const char *name);
923
924 #if FF_API_AVFILTER_OPEN
925 /**
926  * Add an existing filter instance to a filter graph.
927  *
928  * @param graphctx  the filter graph
929  * @param filter the filter to be added
930  *
931  * @deprecated use avfilter_graph_alloc_filter() to allocate a filter in a
932  * filter graph
933  */
934 attribute_deprecated
935 int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter);
936 #endif
937
938 /**
939  * Create and add a filter instance into an existing graph.
940  * The filter instance is created from the filter filt and inited
941  * with the parameters args and opaque.
942  *
943  * In case of success put in *filt_ctx the pointer to the created
944  * filter instance, otherwise set *filt_ctx to NULL.
945  *
946  * @param name the instance name to give to the created filter instance
947  * @param graph_ctx the filter graph
948  * @return a negative AVERROR error code in case of failure, a non
949  * negative value otherwise
950  */
951 int avfilter_graph_create_filter(AVFilterContext **filt_ctx, const AVFilter *filt,
952                                  const char *name, const char *args, void *opaque,
953                                  AVFilterGraph *graph_ctx);
954
955 /**
956  * Enable or disable automatic format conversion inside the graph.
957  *
958  * Note that format conversion can still happen inside explicitly inserted
959  * scale and aresample filters.
960  *
961  * @param flags  any of the AVFILTER_AUTO_CONVERT_* constants
962  */
963 void avfilter_graph_set_auto_convert(AVFilterGraph *graph, unsigned flags);
964
965 enum {
966     AVFILTER_AUTO_CONVERT_ALL  =  0, /**< all automatic conversions enabled */
967     AVFILTER_AUTO_CONVERT_NONE = -1, /**< all automatic conversions disabled */
968 };
969
970 /**
971  * Check validity and configure all the links and formats in the graph.
972  *
973  * @param graphctx the filter graph
974  * @param log_ctx context used for logging
975  * @return >= 0 in case of success, a negative AVERROR code otherwise
976  */
977 int avfilter_graph_config(AVFilterGraph *graphctx, void *log_ctx);
978
979 /**
980  * Free a graph, destroy its links, and set *graph to NULL.
981  * If *graph is NULL, do nothing.
982  */
983 void avfilter_graph_free(AVFilterGraph **graph);
984
985 /**
986  * A linked-list of the inputs/outputs of the filter chain.
987  *
988  * This is mainly useful for avfilter_graph_parse() / avfilter_graph_parse2(),
989  * where it is used to communicate open (unlinked) inputs and outputs from and
990  * to the caller.
991  * This struct specifies, per each not connected pad contained in the graph, the
992  * filter context and the pad index required for establishing a link.
993  */
994 typedef struct AVFilterInOut {
995     /** unique name for this input/output in the list */
996     char *name;
997
998     /** filter context associated to this input/output */
999     AVFilterContext *filter_ctx;
1000
1001     /** index of the filt_ctx pad to use for linking */
1002     int pad_idx;
1003
1004     /** next input/input in the list, NULL if this is the last */
1005     struct AVFilterInOut *next;
1006 } AVFilterInOut;
1007
1008 /**
1009  * Allocate a single AVFilterInOut entry.
1010  * Must be freed with avfilter_inout_free().
1011  * @return allocated AVFilterInOut on success, NULL on failure.
1012  */
1013 AVFilterInOut *avfilter_inout_alloc(void);
1014
1015 /**
1016  * Free the supplied list of AVFilterInOut and set *inout to NULL.
1017  * If *inout is NULL, do nothing.
1018  */
1019 void avfilter_inout_free(AVFilterInOut **inout);
1020
1021 /**
1022  * Add a graph described by a string to a graph.
1023  *
1024  * @note The caller must provide the lists of inputs and outputs,
1025  * which therefore must be known before calling the function.
1026  *
1027  * @note The inputs parameter describes inputs of the already existing
1028  * part of the graph; i.e. from the point of view of the newly created
1029  * part, they are outputs. Similarly the outputs parameter describes
1030  * outputs of the already existing filters, which are provided as
1031  * inputs to the parsed filters.
1032  *
1033  * @param graph   the filter graph where to link the parsed graph context
1034  * @param filters string to be parsed
1035  * @param inputs  linked list to the inputs of the graph
1036  * @param outputs linked list to the outputs of the graph
1037  * @return zero on success, a negative AVERROR code on error
1038  */
1039 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
1040                          AVFilterInOut *inputs, AVFilterInOut *outputs,
1041                          void *log_ctx);
1042
1043 /**
1044  * Add a graph described by a string to a graph.
1045  *
1046  * In the graph filters description, if the input label of the first
1047  * filter is not specified, "in" is assumed; if the output label of
1048  * the last filter is not specified, "out" is assumed.
1049  *
1050  * @param graph   the filter graph where to link the parsed graph context
1051  * @param filters string to be parsed
1052  * @param inputs  pointer to a linked list to the inputs of the graph, may be NULL.
1053  *                If non-NULL, *inputs is updated to contain the list of open inputs
1054  *                after the parsing, should be freed with avfilter_inout_free().
1055  * @param outputs pointer to a linked list to the outputs of the graph, may be NULL.
1056  *                If non-NULL, *outputs is updated to contain the list of open outputs
1057  *                after the parsing, should be freed with avfilter_inout_free().
1058  * @return non negative on success, a negative AVERROR code on error
1059  */
1060 int avfilter_graph_parse_ptr(AVFilterGraph *graph, const char *filters,
1061                              AVFilterInOut **inputs, AVFilterInOut **outputs,
1062                              void *log_ctx);
1063
1064 /**
1065  * Add a graph described by a string to a graph.
1066  *
1067  * @param[in]  graph   the filter graph where to link the parsed graph context
1068  * @param[in]  filters string to be parsed
1069  * @param[out] inputs  a linked list of all free (unlinked) inputs of the
1070  *                     parsed graph will be returned here. It is to be freed
1071  *                     by the caller using avfilter_inout_free().
1072  * @param[out] outputs a linked list of all free (unlinked) outputs of the
1073  *                     parsed graph will be returned here. It is to be freed by the
1074  *                     caller using avfilter_inout_free().
1075  * @return zero on success, a negative AVERROR code on error
1076  *
1077  * @note This function returns the inputs and outputs that are left
1078  * unlinked after parsing the graph and the caller then deals with
1079  * them.
1080  * @note This function makes no reference whatsoever to already
1081  * existing parts of the graph and the inputs parameter will on return
1082  * contain inputs of the newly parsed part of the graph.  Analogously
1083  * the outputs parameter will contain outputs of the newly created
1084  * filters.
1085  */
1086 int avfilter_graph_parse2(AVFilterGraph *graph, const char *filters,
1087                           AVFilterInOut **inputs,
1088                           AVFilterInOut **outputs);
1089
1090 /**
1091  * Send a command to one or more filter instances.
1092  *
1093  * @param graph  the filter graph
1094  * @param target the filter(s) to which the command should be sent
1095  *               "all" sends to all filters
1096  *               otherwise it can be a filter or filter instance name
1097  *               which will send the command to all matching filters.
1098  * @param cmd    the command to send, for handling simplicity all commands must be alphanumeric only
1099  * @param arg    the argument for the command
1100  * @param res    a buffer with size res_size where the filter(s) can return a response.
1101  *
1102  * @returns >=0 on success otherwise an error code.
1103  *              AVERROR(ENOSYS) on unsupported commands
1104  */
1105 int avfilter_graph_send_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, char *res, int res_len, int flags);
1106
1107 /**
1108  * Queue a command for one or more filter instances.
1109  *
1110  * @param graph  the filter graph
1111  * @param target the filter(s) to which the command should be sent
1112  *               "all" sends to all filters
1113  *               otherwise it can be a filter or filter instance name
1114  *               which will send the command to all matching filters.
1115  * @param cmd    the command to sent, for handling simplicity all commands must be alphanumeric only
1116  * @param arg    the argument for the command
1117  * @param ts     time at which the command should be sent to the filter
1118  *
1119  * @note As this executes commands after this function returns, no return code
1120  *       from the filter is provided, also AVFILTER_CMD_FLAG_ONE is not supported.
1121  */
1122 int avfilter_graph_queue_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, int flags, double ts);
1123
1124
1125 /**
1126  * Dump a graph into a human-readable string representation.
1127  *
1128  * @param graph    the graph to dump
1129  * @param options  formatting options; currently ignored
1130  * @return  a string, or NULL in case of memory allocation failure;
1131  *          the string must be freed using av_free
1132  */
1133 char *avfilter_graph_dump(AVFilterGraph *graph, const char *options);
1134
1135 /**
1136  * Request a frame on the oldest sink link.
1137  *
1138  * If the request returns AVERROR_EOF, try the next.
1139  *
1140  * Note that this function is not meant to be the sole scheduling mechanism
1141  * of a filtergraph, only a convenience function to help drain a filtergraph
1142  * in a balanced way under normal circumstances.
1143  *
1144  * Also note that AVERROR_EOF does not mean that frames did not arrive on
1145  * some of the sinks during the process.
1146  * When there are multiple sink links, in case the requested link
1147  * returns an EOF, this may cause a filter to flush pending frames
1148  * which are sent to another sink link, although unrequested.
1149  *
1150  * @return  the return value of ff_request_frame(),
1151  *          or AVERROR_EOF if all links returned AVERROR_EOF
1152  */
1153 int avfilter_graph_request_oldest(AVFilterGraph *graph);
1154
1155 /**
1156  * @}
1157  */
1158
1159 #endif /* AVFILTER_AVFILTER_H */