3 * Copyright (c) 2007 Bobby Bingham
5 * This file is part of FFmpeg.
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.
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.
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
22 #ifndef AVFILTER_AVFILTER_H
23 #define AVFILTER_AVFILTER_H
28 * Main libavfilter public API header
32 * @defgroup lavfi libavfilter
33 * Graph-based frame editing library.
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"
50 #include "libavfilter/version.h"
53 * Return the LIBAVFILTER_VERSION_INT constant.
55 unsigned avfilter_version(void);
58 * Return the libavfilter build-time configuration.
60 const char *avfilter_configuration(void);
63 * Return the libavfilter license.
65 const char *avfilter_license(void);
67 typedef struct AVFilterContext AVFilterContext;
68 typedef struct AVFilterLink AVFilterLink;
69 typedef struct AVFilterPad AVFilterPad;
70 typedef struct AVFilterFormats AVFilterFormats;
71 typedef struct AVFilterChannelLayouts AVFilterChannelLayouts;
74 * Get the number of elements in a NULL-terminated array of AVFilterPads (e.g.
75 * AVFilter.inputs/outputs).
77 int avfilter_pad_count(const AVFilterPad *pads);
80 * Get the name of an AVFilterPad.
82 * @param pads an array of AVFilterPads
83 * @param pad_idx index of the pad in the array; it is the caller's
84 * responsibility to ensure the index is valid
86 * @return name of the pad_idx'th pad in pads
88 const char *avfilter_pad_get_name(const AVFilterPad *pads, int pad_idx);
91 * Get the type of an AVFilterPad.
93 * @param pads an array of AVFilterPads
94 * @param pad_idx index of the pad in the array; it is the caller's
95 * responsibility to ensure the index is valid
97 * @return type of the pad_idx'th pad in pads
99 enum AVMediaType avfilter_pad_get_type(const AVFilterPad *pads, int pad_idx);
102 * The number of the filter inputs is not determined just by AVFilter.inputs.
103 * The filter might add additional inputs during initialization depending on the
104 * options supplied to it.
106 #define AVFILTER_FLAG_DYNAMIC_INPUTS (1 << 0)
108 * The number of the filter outputs is not determined just by AVFilter.outputs.
109 * The filter might add additional outputs during initialization depending on
110 * the options supplied to it.
112 #define AVFILTER_FLAG_DYNAMIC_OUTPUTS (1 << 1)
114 * The filter supports multithreading by splitting frames into multiple parts
115 * and processing them concurrently.
117 #define AVFILTER_FLAG_SLICE_THREADS (1 << 2)
119 * Some filters support a generic "enable" expression option that can be used
120 * to enable or disable a filter in the timeline. Filters supporting this
121 * option have this flag set. When the enable expression is false, the default
122 * no-op filter_frame() function is called in place of the filter_frame()
123 * callback defined on each input pad, thus the frame is passed unchanged to
126 #define AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC (1 << 16)
128 * Same as AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC, except that the filter will
129 * have its filter_frame() callback(s) called as usual even when the enable
130 * expression is false. The filter will disable filtering within the
131 * filter_frame() callback(s) itself, for example executing code depending on
132 * the AVFilterContext->is_disabled value.
134 #define AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL (1 << 17)
136 * Handy mask to test whether the filter supports or no the timeline feature
137 * (internally or generically).
139 #define AVFILTER_FLAG_SUPPORT_TIMELINE (AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL)
142 * Filter definition. This defines the pads a filter contains, and all the
143 * callback functions used to interact with the filter.
145 typedef struct AVFilter {
147 * Filter name. Must be non-NULL and unique among filters.
152 * A description of the filter. May be NULL.
154 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
156 const char *description;
159 * List of inputs, terminated by a zeroed element.
161 * NULL if there are no (static) inputs. Instances of filters with
162 * AVFILTER_FLAG_DYNAMIC_INPUTS set may have more inputs than present in
165 const AVFilterPad *inputs;
167 * List of outputs, terminated by a zeroed element.
169 * NULL if there are no (static) outputs. Instances of filters with
170 * AVFILTER_FLAG_DYNAMIC_OUTPUTS set may have more outputs than present in
173 const AVFilterPad *outputs;
176 * A class for the private data, used to declare filter private AVOptions.
177 * This field is NULL for filters that do not declare any options.
179 * If this field is non-NULL, the first member of the filter private data
180 * must be a pointer to AVClass, which will be set by libavfilter generic
181 * code to this class.
183 const AVClass *priv_class;
186 * A combination of AVFILTER_FLAG_*
190 /*****************************************************************
191 * All fields below this line are not part of the public API. They
192 * may not be used outside of libavfilter and can be changed and
194 * New public fields should be added right above.
195 *****************************************************************
199 * Filter pre-initialization function
201 * This callback will be called immediately after the filter context is
202 * allocated, to allow allocating and initing sub-objects.
204 * If this callback is not NULL, the uninit callback will be called on
205 * allocation failure.
207 * @return 0 on success,
208 * AVERROR code on failure (but the code will be
209 * dropped and treated as ENOMEM by the calling code)
211 int (*preinit)(AVFilterContext *ctx);
214 * Filter initialization function.
216 * This callback will be called only once during the filter lifetime, after
217 * all the options have been set, but before links between filters are
218 * established and format negotiation is done.
220 * Basic filter initialization should be done here. Filters with dynamic
221 * inputs and/or outputs should create those inputs/outputs here based on
222 * provided options. No more changes to this filter's inputs/outputs can be
223 * done after this callback.
225 * This callback must not assume that the filter links exist or frame
226 * parameters are known.
228 * @ref AVFilter.uninit "uninit" is guaranteed to be called even if
229 * initialization fails, so this callback does not have to clean up on
232 * @return 0 on success, a negative AVERROR on failure
234 int (*init)(AVFilterContext *ctx);
237 * Should be set instead of @ref AVFilter.init "init" by the filters that
238 * want to pass a dictionary of AVOptions to nested contexts that are
239 * allocated during init.
241 * On return, the options dict should be freed and replaced with one that
242 * contains all the options which could not be processed by this filter (or
243 * with NULL if all the options were processed).
245 * Otherwise the semantics is the same as for @ref AVFilter.init "init".
247 int (*init_dict)(AVFilterContext *ctx, AVDictionary **options);
250 * Filter uninitialization function.
252 * Called only once right before the filter is freed. Should deallocate any
253 * memory held by the filter, release any buffer references, etc. It does
254 * not need to deallocate the AVFilterContext.priv memory itself.
256 * This callback may be called even if @ref AVFilter.init "init" was not
257 * called or failed, so it must be prepared to handle such a situation.
259 void (*uninit)(AVFilterContext *ctx);
262 * Query formats supported by the filter on its inputs and outputs.
264 * This callback is called after the filter is initialized (so the inputs
265 * and outputs are fixed), shortly before the format negotiation. This
266 * callback may be called more than once.
268 * This callback must set AVFilterLink.outcfg.formats on every input link and
269 * AVFilterLink.incfg.formats on every output link to a list of pixel/sample
270 * formats that the filter supports on that link. For audio links, this
271 * filter must also set @ref AVFilterLink.incfg.samplerates "in_samplerates" /
272 * @ref AVFilterLink.outcfg.samplerates "out_samplerates" and
273 * @ref AVFilterLink.incfg.channel_layouts "in_channel_layouts" /
274 * @ref AVFilterLink.outcfg.channel_layouts "out_channel_layouts" analogously.
276 * This callback may be NULL for filters with one input, in which case
277 * libavfilter assumes that it supports all input formats and preserves
280 * @return zero on success, a negative value corresponding to an
281 * AVERROR code otherwise
283 int (*query_formats)(AVFilterContext *);
285 int priv_size; ///< size of private data to allocate for the filter
287 int flags_internal; ///< Additional flags for avfilter internal use only.
291 * Used by the filter registration system. Must not be touched by any other
294 struct AVFilter *next;
298 * Make the filter instance process a command.
300 * @param cmd the command to process, for handling simplicity all commands must be alphanumeric only
301 * @param arg the argument for the command
302 * @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.
303 * @param flags if AVFILTER_CMD_FLAG_FAST is set and the command would be
304 * time consuming then a filter should treat it like an unsupported command
306 * @returns >=0 on success otherwise an error code.
307 * AVERROR(ENOSYS) on unsupported commands
309 int (*process_command)(AVFilterContext *, const char *cmd, const char *arg, char *res, int res_len, int flags);
312 * Filter initialization function, alternative to the init()
313 * callback. Args contains the user-supplied parameters, opaque is
314 * used for providing binary data.
316 int (*init_opaque)(AVFilterContext *ctx, void *opaque);
319 * Filter activation function.
321 * Called when any processing is needed from the filter, instead of any
322 * filter_frame and request_frame on pads.
324 * The function must examine inlinks and outlinks and perform a single
325 * step of processing. If there is nothing to do, the function must do
326 * nothing and not return an error. If more steps are or may be
327 * possible, it must use ff_filter_set_ready() to schedule another
330 int (*activate)(AVFilterContext *ctx);
334 * Process multiple parts of the frame concurrently.
336 #define AVFILTER_THREAD_SLICE (1 << 0)
338 typedef struct AVFilterInternal AVFilterInternal;
340 /** An instance of a filter */
341 struct AVFilterContext {
342 const AVClass *av_class; ///< needed for av_log() and filters common options
344 const AVFilter *filter; ///< the AVFilter of which this is an instance
346 char *name; ///< name of this filter instance
348 AVFilterPad *input_pads; ///< array of input pads
349 AVFilterLink **inputs; ///< array of pointers to input links
350 unsigned nb_inputs; ///< number of input pads
352 AVFilterPad *output_pads; ///< array of output pads
353 AVFilterLink **outputs; ///< array of pointers to output links
354 unsigned nb_outputs; ///< number of output pads
356 void *priv; ///< private data for use by the filter
358 struct AVFilterGraph *graph; ///< filtergraph this filter belongs to
361 * Type of multithreading being allowed/used. A combination of
362 * AVFILTER_THREAD_* flags.
364 * May be set by the caller before initializing the filter to forbid some
365 * or all kinds of multithreading for this filter. The default is allowing
368 * When the filter is initialized, this field is combined using bit AND with
369 * AVFilterGraph.thread_type to get the final mask used for determining
370 * allowed threading types. I.e. a threading type needs to be set in both
373 * After the filter is initialized, libavfilter sets this field to the
374 * threading type that is actually used (0 for no multithreading).
379 * An opaque struct for libavfilter internal use.
381 AVFilterInternal *internal;
383 struct AVFilterCommand *command_queue;
385 char *enable_str; ///< enable expression string
386 void *enable; ///< parsed expression (AVExpr*)
387 double *var_values; ///< variable values for the enable expression
388 int is_disabled; ///< the enabled state from the last expression evaluation
391 * For filters which will create hardware frames, sets the device the
392 * filter should create them in. All other filters will ignore this field:
393 * in particular, a filter which consumes or processes hardware frames will
394 * instead use the hw_frames_ctx field in AVFilterLink to carry the
395 * hardware context information.
397 AVBufferRef *hw_device_ctx;
400 * Max number of threads allowed in this filter instance.
401 * If <= 0, its value is ignored.
402 * Overrides global number of threads set per filter graph.
407 * Ready status of the filter.
408 * A non-0 value means that the filter needs activating;
409 * a higher value suggests a more urgent activation.
414 * Sets the number of extra hardware frames which the filter will
415 * allocate on its output links for use in following filters or by
418 * Some hardware filters require all frames that they will use for
419 * output to be defined in advance before filtering starts. For such
420 * filters, any hardware frame pools used for output must therefore be
421 * of fixed size. The extra frames set here are on top of any number
422 * that the filter needs internally in order to operate normally.
424 * This field must be set before the graph containing this filter is
431 * Lists of formats / etc. supported by an end of a link.
433 * This structure is directly part of AVFilterLink, in two copies:
434 * one for the source filter, one for the destination filter.
436 * These lists are used for negotiating the format to actually be used,
437 * which will be loaded into the format and channel_layout members of
438 * AVFilterLink, when chosen.
440 typedef struct AVFilterFormatsConfig {
443 * List of supported formats (pixel or sample).
445 AVFilterFormats *formats;
448 * Lists of supported sample rates, only for audio.
450 AVFilterFormats *samplerates;
453 * Lists of supported channel layouts, only for audio.
455 AVFilterChannelLayouts *channel_layouts;
457 } AVFilterFormatsConfig;
460 * A link between two filters. This contains pointers to the source and
461 * destination filters between which this link exists, and the indexes of
462 * the pads involved. In addition, this link also contains the parameters
463 * which have been negotiated and agreed upon between the filter, such as
464 * image dimensions, format, etc.
466 * Applications must not normally access the link structure directly.
467 * Use the buffersrc and buffersink API instead.
468 * In the future, access to the header may be reserved for filters
471 struct AVFilterLink {
472 AVFilterContext *src; ///< source filter
473 AVFilterPad *srcpad; ///< output pad on the source filter
475 AVFilterContext *dst; ///< dest filter
476 AVFilterPad *dstpad; ///< input pad on the dest filter
478 enum AVMediaType type; ///< filter media type
480 /* These parameters apply only to video */
481 int w; ///< agreed upon image width
482 int h; ///< agreed upon image height
483 AVRational sample_aspect_ratio; ///< agreed upon sample aspect ratio
484 /* These parameters apply only to audio */
485 uint64_t channel_layout; ///< channel layout of current buffer (see libavutil/channel_layout.h)
486 int sample_rate; ///< samples per second
488 int format; ///< agreed upon media format
491 * Define the time base used by the PTS of the frames/samples
492 * which will pass through this link.
493 * During the configuration stage, each filter is supposed to
494 * change only the output timebase, while the timebase of the
495 * input link is assumed to be an unchangeable property.
497 AVRational time_base;
499 /*****************************************************************
500 * All fields below this line are not part of the public API. They
501 * may not be used outside of libavfilter and can be changed and
503 * New public fields should be added right above.
504 *****************************************************************
508 * Lists of supported formats / etc. supported by the input filter.
510 AVFilterFormatsConfig incfg;
513 * Lists of supported formats / etc. supported by the output filter.
515 AVFilterFormatsConfig outcfg;
517 /** stage of the initialization of the link properties (dimensions, etc) */
519 AVLINK_UNINIT = 0, ///< not started
520 AVLINK_STARTINIT, ///< started, but incomplete
521 AVLINK_INIT ///< complete
525 * Graph the filter belongs to.
527 struct AVFilterGraph *graph;
530 * Current timestamp of the link, as defined by the most recent
531 * frame(s), in link time_base units.
536 * Current timestamp of the link, as defined by the most recent
537 * frame(s), in AV_TIME_BASE units.
539 int64_t current_pts_us;
542 * Index in the age array.
547 * Frame rate of the stream on the link, or 1/0 if unknown or variable;
548 * if left to 0/0, will be automatically copied from the first input
549 * of the source filter if it exists.
551 * Sources should set it to the best estimation of the real frame rate.
552 * If the source frame rate is unknown or variable, set this to 1/0.
553 * Filters should update it if necessary depending on their function.
554 * Sinks can use it to set a default output frame rate.
555 * It is similar to the r_frame_rate field in AVStream.
557 AVRational frame_rate;
560 * Buffer partially filled with samples to achieve a fixed/minimum size.
562 AVFrame *partial_buf;
565 * Size of the partial buffer to allocate.
566 * Must be between min_samples and max_samples.
568 int partial_buf_size;
571 * Minimum number of samples to filter at once. If filter_frame() is
572 * called with fewer samples, it will accumulate them in partial_buf.
573 * This field and the related ones must not be changed after filtering
575 * If 0, all related fields are ignored.
580 * Maximum number of samples to filter at once. If filter_frame() is
581 * called with more samples, it will split them.
586 * Number of channels.
591 * Number of past frames sent through the link.
593 int64_t frame_count_in, frame_count_out;
596 * A pointer to a FFFramePool struct.
601 * True if a frame is currently wanted on the output of this filter.
602 * Set when ff_request_frame() is called by the output,
603 * cleared when a frame is filtered.
605 int frame_wanted_out;
608 * For hwaccel pixel formats, this should be a reference to the
609 * AVHWFramesContext describing the frames.
611 AVBufferRef *hw_frames_ctx;
613 #ifndef FF_INTERNAL_FIELDS
616 * Internal structure members.
617 * The fields below this limit are internal for libavfilter's use
618 * and must in no way be accessed by applications.
620 char reserved[0xF000];
622 #else /* FF_INTERNAL_FIELDS */
625 * Queue of frames waiting to be filtered.
630 * If set, the source filter can not generate a frame as is.
631 * The goal is to avoid repeatedly calling the request_frame() method on
634 int frame_blocked_in;
638 * If not zero, all attempts of filter_frame will fail with the
639 * corresponding code.
644 * Timestamp of the input status change.
646 int64_t status_in_pts;
649 * Link output status.
650 * If not zero, all attempts of request_frame will fail with the
651 * corresponding code.
655 #endif /* FF_INTERNAL_FIELDS */
660 * Link two filters together.
662 * @param src the source filter
663 * @param srcpad index of the output pad on the source filter
664 * @param dst the destination filter
665 * @param dstpad index of the input pad on the destination filter
666 * @return zero on success
668 int avfilter_link(AVFilterContext *src, unsigned srcpad,
669 AVFilterContext *dst, unsigned dstpad);
672 * Free the link in *link, and set its pointer to NULL.
674 void avfilter_link_free(AVFilterLink **link);
676 #if FF_API_FILTER_GET_SET
678 * Get the number of channels of a link.
679 * @deprecated Use av_buffersink_get_channels()
682 int avfilter_link_get_channels(AVFilterLink *link);
684 #if FF_API_FILTER_LINK_SET_CLOSED
686 * Set the closed field of a link.
687 * @deprecated applications are not supposed to mess with links, they should
691 void avfilter_link_set_closed(AVFilterLink *link, int closed);
694 * Negotiate the media format, dimensions, etc of all inputs to a filter.
696 * @param filter the filter to negotiate the properties for its inputs
697 * @return zero on successful negotiation
699 int avfilter_config_links(AVFilterContext *filter);
701 #define AVFILTER_CMD_FLAG_ONE 1 ///< Stop once a filter understood the command (for target=all for example), fast filters are favored automatically
702 #define AVFILTER_CMD_FLAG_FAST 2 ///< Only execute command when its fast (like a video out that supports contrast adjustment in hw)
705 * Make the filter instance process a command.
706 * It is recommended to use avfilter_graph_send_command().
708 int avfilter_process_command(AVFilterContext *filter, const char *cmd, const char *arg, char *res, int res_len, int flags);
711 * Iterate over all registered filters.
713 * @param opaque a pointer where libavfilter will store the iteration state. Must
714 * point to NULL to start the iteration.
716 * @return the next registered filter or NULL when the iteration is
719 const AVFilter *av_filter_iterate(void **opaque);
722 /** Initialize the filter system. Register all builtin filters. */
724 void avfilter_register_all(void);
727 * Register a filter. This is only needed if you plan to use
728 * avfilter_get_by_name later to lookup the AVFilter structure by name. A
729 * filter can still by instantiated with avfilter_graph_alloc_filter even if it
732 * @param filter the filter to register
733 * @return 0 if the registration was successful, a negative value
737 int avfilter_register(AVFilter *filter);
740 * Iterate over all registered filters.
741 * @return If prev is non-NULL, next registered filter after prev or NULL if
742 * prev is the last filter. If prev is NULL, return the first registered filter.
745 const AVFilter *avfilter_next(const AVFilter *prev);
749 * Get a filter definition matching the given name.
751 * @param name the filter name to find
752 * @return the filter definition, if any matching one is registered.
753 * NULL if none found.
755 const AVFilter *avfilter_get_by_name(const char *name);
759 * Initialize a filter with the supplied parameters.
761 * @param ctx uninitialized filter context to initialize
762 * @param args Options to initialize the filter with. This must be a
763 * ':'-separated list of options in the 'key=value' form.
764 * May be NULL if the options have been set directly using the
765 * AVOptions API or there are no options that need to be set.
766 * @return 0 on success, a negative AVERROR on failure
768 int avfilter_init_str(AVFilterContext *ctx, const char *args);
771 * Initialize a filter with the supplied dictionary of options.
773 * @param ctx uninitialized filter context to initialize
774 * @param options An AVDictionary filled with options for this filter. On
775 * return this parameter will be destroyed and replaced with
776 * a dict containing options that were not found. This dictionary
777 * must be freed by the caller.
778 * May be NULL, then this function is equivalent to
779 * avfilter_init_str() with the second parameter set to NULL.
780 * @return 0 on success, a negative AVERROR on failure
782 * @note This function and avfilter_init_str() do essentially the same thing,
783 * the difference is in manner in which the options are passed. It is up to the
784 * calling code to choose whichever is more preferable. The two functions also
785 * behave differently when some of the provided options are not declared as
786 * supported by the filter. In such a case, avfilter_init_str() will fail, but
787 * this function will leave those extra options in the options AVDictionary and
790 int avfilter_init_dict(AVFilterContext *ctx, AVDictionary **options);
793 * Free a filter context. This will also remove the filter from its
794 * filtergraph's list of filters.
796 * @param filter the filter to free
798 void avfilter_free(AVFilterContext *filter);
801 * Insert a filter in the middle of an existing link.
803 * @param link the link into which the filter should be inserted
804 * @param filt the filter to be inserted
805 * @param filt_srcpad_idx the input pad on the filter to connect
806 * @param filt_dstpad_idx the output pad on the filter to connect
807 * @return zero on success
809 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
810 unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
813 * @return AVClass for AVFilterContext.
815 * @see av_opt_find().
817 const AVClass *avfilter_get_class(void);
819 typedef struct AVFilterGraphInternal AVFilterGraphInternal;
822 * A function pointer passed to the @ref AVFilterGraph.execute callback to be
823 * executed multiple times, possibly in parallel.
825 * @param ctx the filter context the job belongs to
826 * @param arg an opaque parameter passed through from @ref
827 * AVFilterGraph.execute
828 * @param jobnr the index of the job being executed
829 * @param nb_jobs the total number of jobs
831 * @return 0 on success, a negative AVERROR on error
833 typedef int (avfilter_action_func)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
836 * A function executing multiple jobs, possibly in parallel.
838 * @param ctx the filter context to which the jobs belong
839 * @param func the function to be called multiple times
840 * @param arg the argument to be passed to func
841 * @param ret a nb_jobs-sized array to be filled with return values from each
843 * @param nb_jobs the number of jobs to execute
845 * @return 0 on success, a negative AVERROR on error
847 typedef int (avfilter_execute_func)(AVFilterContext *ctx, avfilter_action_func *func,
848 void *arg, int *ret, int nb_jobs);
850 typedef struct AVFilterGraph {
851 const AVClass *av_class;
852 AVFilterContext **filters;
855 char *scale_sws_opts; ///< sws options to use for the auto-inserted scale filters
857 attribute_deprecated char *resample_lavr_opts; ///< libavresample options to use for the auto-inserted resample filters
861 * Type of multithreading allowed for filters in this graph. A combination
862 * of AVFILTER_THREAD_* flags.
864 * May be set by the caller at any point, the setting will apply to all
865 * filters initialized after that. The default is allowing everything.
867 * When a filter in this graph is initialized, this field is combined using
868 * bit AND with AVFilterContext.thread_type to get the final mask used for
869 * determining allowed threading types. I.e. a threading type needs to be
870 * set in both to be allowed.
875 * Maximum number of threads used by filters in this graph. May be set by
876 * the caller before adding any filters to the filtergraph. Zero (the
877 * default) means that the number of threads is determined automatically.
882 * Opaque object for libavfilter internal use.
884 AVFilterGraphInternal *internal;
887 * Opaque user data. May be set by the caller to an arbitrary value, e.g. to
888 * be used from callbacks like @ref AVFilterGraph.execute.
889 * Libavfilter will not touch this field in any way.
894 * This callback may be set by the caller immediately after allocating the
895 * graph and before adding any filters to it, to provide a custom
896 * multithreading implementation.
898 * If set, filters with slice threading capability will call this callback
899 * to execute multiple jobs in parallel.
901 * If this field is left unset, libavfilter will use its internal
902 * implementation, which may or may not be multithreaded depending on the
903 * platform and build options.
905 avfilter_execute_func *execute;
907 char *aresample_swr_opts; ///< swr options to use for the auto-inserted aresample filters, Access ONLY through AVOptions
912 * The following fields are for internal use only.
913 * Their type, offset, number and semantic can change without notice.
916 AVFilterLink **sink_links;
917 int sink_links_count;
919 unsigned disable_auto_convert;
923 * Allocate a filter graph.
925 * @return the allocated filter graph on success or NULL.
927 AVFilterGraph *avfilter_graph_alloc(void);
930 * Create a new filter instance in a filter graph.
932 * @param graph graph in which the new filter will be used
933 * @param filter the filter to create an instance of
934 * @param name Name to give to the new instance (will be copied to
935 * AVFilterContext.name). This may be used by the caller to identify
936 * different filters, libavfilter itself assigns no semantics to
937 * this parameter. May be NULL.
939 * @return the context of the newly created filter instance (note that it is
940 * also retrievable directly through AVFilterGraph.filters or with
941 * avfilter_graph_get_filter()) on success or NULL on failure.
943 AVFilterContext *avfilter_graph_alloc_filter(AVFilterGraph *graph,
944 const AVFilter *filter,
948 * Get a filter instance identified by instance name from graph.
950 * @param graph filter graph to search through.
951 * @param name filter instance name (should be unique in the graph).
952 * @return the pointer to the found filter instance or NULL if it
955 AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, const char *name);
958 * Create and add a filter instance into an existing graph.
959 * The filter instance is created from the filter filt and inited
960 * with the parameter args. opaque is currently ignored.
962 * In case of success put in *filt_ctx the pointer to the created
963 * filter instance, otherwise set *filt_ctx to NULL.
965 * @param name the instance name to give to the created filter instance
966 * @param graph_ctx the filter graph
967 * @return a negative AVERROR error code in case of failure, a non
968 * negative value otherwise
970 int avfilter_graph_create_filter(AVFilterContext **filt_ctx, const AVFilter *filt,
971 const char *name, const char *args, void *opaque,
972 AVFilterGraph *graph_ctx);
975 * Enable or disable automatic format conversion inside the graph.
977 * Note that format conversion can still happen inside explicitly inserted
978 * scale and aresample filters.
980 * @param flags any of the AVFILTER_AUTO_CONVERT_* constants
982 void avfilter_graph_set_auto_convert(AVFilterGraph *graph, unsigned flags);
985 AVFILTER_AUTO_CONVERT_ALL = 0, /**< all automatic conversions enabled */
986 AVFILTER_AUTO_CONVERT_NONE = -1, /**< all automatic conversions disabled */
990 * Check validity and configure all the links and formats in the graph.
992 * @param graphctx the filter graph
993 * @param log_ctx context used for logging
994 * @return >= 0 in case of success, a negative AVERROR code otherwise
996 int avfilter_graph_config(AVFilterGraph *graphctx, void *log_ctx);
999 * Free a graph, destroy its links, and set *graph to NULL.
1000 * If *graph is NULL, do nothing.
1002 void avfilter_graph_free(AVFilterGraph **graph);
1005 * A linked-list of the inputs/outputs of the filter chain.
1007 * This is mainly useful for avfilter_graph_parse() / avfilter_graph_parse2(),
1008 * where it is used to communicate open (unlinked) inputs and outputs from and
1010 * This struct specifies, per each not connected pad contained in the graph, the
1011 * filter context and the pad index required for establishing a link.
1013 typedef struct AVFilterInOut {
1014 /** unique name for this input/output in the list */
1017 /** filter context associated to this input/output */
1018 AVFilterContext *filter_ctx;
1020 /** index of the filt_ctx pad to use for linking */
1023 /** next input/input in the list, NULL if this is the last */
1024 struct AVFilterInOut *next;
1028 * Allocate a single AVFilterInOut entry.
1029 * Must be freed with avfilter_inout_free().
1030 * @return allocated AVFilterInOut on success, NULL on failure.
1032 AVFilterInOut *avfilter_inout_alloc(void);
1035 * Free the supplied list of AVFilterInOut and set *inout to NULL.
1036 * If *inout is NULL, do nothing.
1038 void avfilter_inout_free(AVFilterInOut **inout);
1041 * Add a graph described by a string to a graph.
1043 * @note The caller must provide the lists of inputs and outputs,
1044 * which therefore must be known before calling the function.
1046 * @note The inputs parameter describes inputs of the already existing
1047 * part of the graph; i.e. from the point of view of the newly created
1048 * part, they are outputs. Similarly the outputs parameter describes
1049 * outputs of the already existing filters, which are provided as
1050 * inputs to the parsed filters.
1052 * @param graph the filter graph where to link the parsed graph context
1053 * @param filters string to be parsed
1054 * @param inputs linked list to the inputs of the graph
1055 * @param outputs linked list to the outputs of the graph
1056 * @return zero on success, a negative AVERROR code on error
1058 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
1059 AVFilterInOut *inputs, AVFilterInOut *outputs,
1063 * Add a graph described by a string to a graph.
1065 * In the graph filters description, if the input label of the first
1066 * filter is not specified, "in" is assumed; if the output label of
1067 * the last filter is not specified, "out" is assumed.
1069 * @param graph the filter graph where to link the parsed graph context
1070 * @param filters string to be parsed
1071 * @param inputs pointer to a linked list to the inputs of the graph, may be NULL.
1072 * If non-NULL, *inputs is updated to contain the list of open inputs
1073 * after the parsing, should be freed with avfilter_inout_free().
1074 * @param outputs pointer to a linked list to the outputs of the graph, may be NULL.
1075 * If non-NULL, *outputs is updated to contain the list of open outputs
1076 * after the parsing, should be freed with avfilter_inout_free().
1077 * @return non negative on success, a negative AVERROR code on error
1079 int avfilter_graph_parse_ptr(AVFilterGraph *graph, const char *filters,
1080 AVFilterInOut **inputs, AVFilterInOut **outputs,
1084 * Add a graph described by a string to a graph.
1086 * @param[in] graph the filter graph where to link the parsed graph context
1087 * @param[in] filters string to be parsed
1088 * @param[out] inputs a linked list of all free (unlinked) inputs of the
1089 * parsed graph will be returned here. It is to be freed
1090 * by the caller using avfilter_inout_free().
1091 * @param[out] outputs a linked list of all free (unlinked) outputs of the
1092 * parsed graph will be returned here. It is to be freed by the
1093 * caller using avfilter_inout_free().
1094 * @return zero on success, a negative AVERROR code on error
1096 * @note This function returns the inputs and outputs that are left
1097 * unlinked after parsing the graph and the caller then deals with
1099 * @note This function makes no reference whatsoever to already
1100 * existing parts of the graph and the inputs parameter will on return
1101 * contain inputs of the newly parsed part of the graph. Analogously
1102 * the outputs parameter will contain outputs of the newly created
1105 int avfilter_graph_parse2(AVFilterGraph *graph, const char *filters,
1106 AVFilterInOut **inputs,
1107 AVFilterInOut **outputs);
1110 * Send a command to one or more filter instances.
1112 * @param graph the filter graph
1113 * @param target the filter(s) to which the command should be sent
1114 * "all" sends to all filters
1115 * otherwise it can be a filter or filter instance name
1116 * which will send the command to all matching filters.
1117 * @param cmd the command to send, for handling simplicity all commands must be alphanumeric only
1118 * @param arg the argument for the command
1119 * @param res a buffer with size res_size where the filter(s) can return a response.
1121 * @returns >=0 on success otherwise an error code.
1122 * AVERROR(ENOSYS) on unsupported commands
1124 int avfilter_graph_send_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, char *res, int res_len, int flags);
1127 * Queue a command for one or more filter instances.
1129 * @param graph the filter graph
1130 * @param target the filter(s) to which the command should be sent
1131 * "all" sends to all filters
1132 * otherwise it can be a filter or filter instance name
1133 * which will send the command to all matching filters.
1134 * @param cmd the command to sent, for handling simplicity all commands must be alphanumeric only
1135 * @param arg the argument for the command
1136 * @param ts time at which the command should be sent to the filter
1138 * @note As this executes commands after this function returns, no return code
1139 * from the filter is provided, also AVFILTER_CMD_FLAG_ONE is not supported.
1141 int avfilter_graph_queue_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, int flags, double ts);
1145 * Dump a graph into a human-readable string representation.
1147 * @param graph the graph to dump
1148 * @param options formatting options; currently ignored
1149 * @return a string, or NULL in case of memory allocation failure;
1150 * the string must be freed using av_free
1152 char *avfilter_graph_dump(AVFilterGraph *graph, const char *options);
1155 * Request a frame on the oldest sink link.
1157 * If the request returns AVERROR_EOF, try the next.
1159 * Note that this function is not meant to be the sole scheduling mechanism
1160 * of a filtergraph, only a convenience function to help drain a filtergraph
1161 * in a balanced way under normal circumstances.
1163 * Also note that AVERROR_EOF does not mean that frames did not arrive on
1164 * some of the sinks during the process.
1165 * When there are multiple sink links, in case the requested link
1166 * returns an EOF, this may cause a filter to flush pending frames
1167 * which are sent to another sink link, although unrequested.
1169 * @return the return value of ff_request_frame(),
1170 * or AVERROR_EOF if all links returned AVERROR_EOF
1172 int avfilter_graph_request_oldest(AVFilterGraph *graph);
1178 #endif /* AVFILTER_AVFILTER_H */