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;
73 * Get the number of elements in a NULL-terminated array of AVFilterPads (e.g.
74 * AVFilter.inputs/outputs).
76 int avfilter_pad_count(const AVFilterPad *pads);
79 * Get the name of an AVFilterPad.
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
85 * @return name of the pad_idx'th pad in pads
87 const char *avfilter_pad_get_name(const AVFilterPad *pads, int pad_idx);
90 * Get the type of an AVFilterPad.
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
96 * @return type of the pad_idx'th pad in pads
98 enum AVMediaType avfilter_pad_get_type(const AVFilterPad *pads, int pad_idx);
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.
105 #define AVFILTER_FLAG_DYNAMIC_INPUTS (1 << 0)
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.
111 #define AVFILTER_FLAG_DYNAMIC_OUTPUTS (1 << 1)
113 * The filter supports multithreading by splitting frames into multiple parts
114 * and processing them concurrently.
116 #define AVFILTER_FLAG_SLICE_THREADS (1 << 2)
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
125 #define AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC (1 << 16)
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.
133 #define AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL (1 << 17)
135 * Handy mask to test whether the filter supports or no the timeline feature
136 * (internally or generically).
138 #define AVFILTER_FLAG_SUPPORT_TIMELINE (AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL)
141 * Filter definition. This defines the pads a filter contains, and all the
142 * callback functions used to interact with the filter.
144 typedef struct AVFilter {
146 * Filter name. Must be non-NULL and unique among filters.
151 * A description of the filter. May be NULL.
153 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
155 const char *description;
158 * List of inputs, terminated by a zeroed element.
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
164 const AVFilterPad *inputs;
166 * List of outputs, terminated by a zeroed element.
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
172 const AVFilterPad *outputs;
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.
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.
182 const AVClass *priv_class;
185 * A combination of AVFILTER_FLAG_*
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
193 * New public fields should be added right above.
194 *****************************************************************
198 * Filter initialization function.
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.
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.
209 * This callback must not assume that the filter links exist or frame
210 * parameters are known.
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
216 * @return 0 on success, a negative AVERROR on failure
218 int (*init)(AVFilterContext *ctx);
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.
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).
229 * Otherwise the semantics is the same as for @ref AVFilter.init "init".
231 int (*init_dict)(AVFilterContext *ctx, AVDictionary **options);
234 * Filter uninitialization function.
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.
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.
243 void (*uninit)(AVFilterContext *ctx);
246 * Query formats supported by the filter on its inputs and outputs.
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.
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.
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
264 * @return zero on success, a negative value corresponding to an
265 * AVERROR code otherwise
267 int (*query_formats)(AVFilterContext *);
269 int priv_size; ///< size of private data to allocate for the filter
272 * Used by the filter registration system. Must not be touched by any other
275 struct AVFilter *next;
278 * Make the filter instance process a command.
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
286 * @returns >=0 on success otherwise an error code.
287 * AVERROR(ENOSYS) on unsupported commands
289 int (*process_command)(AVFilterContext *, const char *cmd, const char *arg, char *res, int res_len, int flags);
292 * Filter initialization function, alternative to the init()
293 * callback. Args contains the user-supplied parameters, opaque is
294 * used for providing binary data.
296 int (*init_opaque)(AVFilterContext *ctx, void *opaque);
300 * Process multiple parts of the frame concurrently.
302 #define AVFILTER_THREAD_SLICE (1 << 0)
304 typedef struct AVFilterInternal AVFilterInternal;
306 /** An instance of a filter */
307 struct AVFilterContext {
308 const AVClass *av_class; ///< needed for av_log() and filters common options
310 const AVFilter *filter; ///< the AVFilter of which this is an instance
312 char *name; ///< name of this filter instance
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
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
322 void *priv; ///< private data for use by the filter
324 struct AVFilterGraph *graph; ///< filtergraph this filter belongs to
327 * Type of multithreading being allowed/used. A combination of
328 * AVFILTER_THREAD_* flags.
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
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
339 * After the filter is initialized, libavfilter sets this field to the
340 * threading type that is actually used (0 for no multithreading).
345 * An opaque struct for libavfilter internal use.
347 AVFilterInternal *internal;
349 struct AVFilterCommand *command_queue;
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
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.
363 AVBufferRef *hw_device_ctx;
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.
374 * A link between two filters. This contains pointers to the source and
375 * destination filters between which this link exists, and the indexes of
376 * the pads involved. In addition, this link also contains the parameters
377 * which have been negotiated and agreed upon between the filter, such as
378 * image dimensions, format, etc.
380 struct AVFilterLink {
381 AVFilterContext *src; ///< source filter
382 AVFilterPad *srcpad; ///< output pad on the source filter
384 AVFilterContext *dst; ///< dest filter
385 AVFilterPad *dstpad; ///< input pad on the dest filter
387 enum AVMediaType type; ///< filter media type
389 /* These parameters apply only to video */
390 int w; ///< agreed upon image width
391 int h; ///< agreed upon image height
392 AVRational sample_aspect_ratio; ///< agreed upon sample aspect ratio
393 /* These parameters apply only to audio */
394 uint64_t channel_layout; ///< channel layout of current buffer (see libavutil/channel_layout.h)
395 int sample_rate; ///< samples per second
397 int format; ///< agreed upon media format
400 * Define the time base used by the PTS of the frames/samples
401 * which will pass through this link.
402 * During the configuration stage, each filter is supposed to
403 * change only the output timebase, while the timebase of the
404 * input link is assumed to be an unchangeable property.
406 AVRational time_base;
408 /*****************************************************************
409 * All fields below this line are not part of the public API. They
410 * may not be used outside of libavfilter and can be changed and
412 * New public fields should be added right above.
413 *****************************************************************
416 * Lists of formats and channel layouts supported by the input and output
417 * filters respectively. These lists are used for negotiating the format
418 * to actually be used, which will be loaded into the format and
419 * channel_layout members, above, when chosen.
422 AVFilterFormats *in_formats;
423 AVFilterFormats *out_formats;
426 * Lists of channel layouts and sample rates used for automatic
429 AVFilterFormats *in_samplerates;
430 AVFilterFormats *out_samplerates;
431 struct AVFilterChannelLayouts *in_channel_layouts;
432 struct AVFilterChannelLayouts *out_channel_layouts;
435 * Audio only, the destination filter sets this to a non-zero value to
436 * request that buffers with the given number of samples should be sent to
437 * it. AVFilterPad.needs_fifo must also be set on the corresponding input
439 * Last buffer before EOF will be padded with silence.
443 /** stage of the initialization of the link properties (dimensions, etc) */
445 AVLINK_UNINIT = 0, ///< not started
446 AVLINK_STARTINIT, ///< started, but incomplete
447 AVLINK_INIT ///< complete
451 * Graph the filter belongs to.
453 struct AVFilterGraph *graph;
456 * Current timestamp of the link, as defined by the most recent
457 * frame(s), in link time_base units.
462 * Current timestamp of the link, as defined by the most recent
463 * frame(s), in AV_TIME_BASE units.
465 int64_t current_pts_us;
468 * Index in the age array.
473 * Frame rate of the stream on the link, or 1/0 if unknown or variable;
474 * if left to 0/0, will be automatically copied from the first input
475 * of the source filter if it exists.
477 * Sources should set it to the best estimation of the real frame rate.
478 * If the source frame rate is unknown or variable, set this to 1/0.
479 * Filters should update it if necessary depending on their function.
480 * Sinks can use it to set a default output frame rate.
481 * It is similar to the r_frame_rate field in AVStream.
483 AVRational frame_rate;
486 * Buffer partially filled with samples to achieve a fixed/minimum size.
488 AVFrame *partial_buf;
491 * Size of the partial buffer to allocate.
492 * Must be between min_samples and max_samples.
494 int partial_buf_size;
497 * Minimum number of samples to filter at once. If filter_frame() is
498 * called with fewer samples, it will accumulate them in partial_buf.
499 * This field and the related ones must not be changed after filtering
501 * If 0, all related fields are ignored.
506 * Maximum number of samples to filter at once. If filter_frame() is
507 * called with more samples, it will split them.
513 * If not zero, all attempts of filter_frame or request_frame
514 * will fail with the corresponding code, and if necessary the reference
516 * If request_frame returns an error, the status is set on the
517 * corresponding link.
518 * It can be set also be set by either the source or the destination
524 * Number of channels.
529 * Link processing flags.
534 * Number of past frames sent through the link.
536 int64_t frame_count_in, frame_count_out;
539 * A pointer to a FFVideoFramePool struct.
541 void *video_frame_pool;
544 * True if a frame is currently wanted on the input of this filter.
545 * Set when ff_request_frame() is called by the output,
546 * cleared when the request is handled or forwarded.
551 * True if a frame is currently wanted on the output of this filter.
552 * Set when ff_request_frame() is called by the output,
553 * cleared when a frame is filtered.
555 int frame_wanted_out;
558 * For hwaccel pixel formats, this should be a reference to the
559 * AVHWFramesContext describing the frames.
561 AVBufferRef *hw_frames_ctx;
565 * Link two filters together.
567 * @param src the source filter
568 * @param srcpad index of the output pad on the source filter
569 * @param dst the destination filter
570 * @param dstpad index of the input pad on the destination filter
571 * @return zero on success
573 int avfilter_link(AVFilterContext *src, unsigned srcpad,
574 AVFilterContext *dst, unsigned dstpad);
577 * Free the link in *link, and set its pointer to NULL.
579 void avfilter_link_free(AVFilterLink **link);
582 * Get the number of channels of a link.
584 int avfilter_link_get_channels(AVFilterLink *link);
587 * Set the closed field of a link.
588 * @deprecated applications are not supposed to mess with links, they should
592 void avfilter_link_set_closed(AVFilterLink *link, int closed);
595 * Negotiate the media format, dimensions, etc of all inputs to a filter.
597 * @param filter the filter to negotiate the properties for its inputs
598 * @return zero on successful negotiation
600 int avfilter_config_links(AVFilterContext *filter);
602 #define AVFILTER_CMD_FLAG_ONE 1 ///< Stop once a filter understood the command (for target=all for example), fast filters are favored automatically
603 #define AVFILTER_CMD_FLAG_FAST 2 ///< Only execute command when its fast (like a video out that supports contrast adjustment in hw)
606 * Make the filter instance process a command.
607 * It is recommended to use avfilter_graph_send_command().
609 int avfilter_process_command(AVFilterContext *filter, const char *cmd, const char *arg, char *res, int res_len, int flags);
611 /** Initialize the filter system. Register all builtin filters. */
612 void avfilter_register_all(void);
614 #if FF_API_OLD_FILTER_REGISTER
615 /** Uninitialize the filter system. Unregister all filters. */
617 void avfilter_uninit(void);
621 * Register a filter. This is only needed if you plan to use
622 * avfilter_get_by_name later to lookup the AVFilter structure by name. A
623 * filter can still by instantiated with avfilter_graph_alloc_filter even if it
626 * @param filter the filter to register
627 * @return 0 if the registration was successful, a negative value
630 int avfilter_register(AVFilter *filter);
633 * Get a filter definition matching the given name.
635 * @param name the filter name to find
636 * @return the filter definition, if any matching one is registered.
637 * NULL if none found.
639 #if !FF_API_NOCONST_GET_NAME
642 AVFilter *avfilter_get_by_name(const char *name);
645 * Iterate over all registered filters.
646 * @return If prev is non-NULL, next registered filter after prev or NULL if
647 * prev is the last filter. If prev is NULL, return the first registered filter.
649 const AVFilter *avfilter_next(const AVFilter *prev);
651 #if FF_API_OLD_FILTER_REGISTER
653 * If filter is NULL, returns a pointer to the first registered filter pointer,
654 * if filter is non-NULL, returns the next pointer after filter.
655 * If the returned pointer points to NULL, the last registered filter
656 * was already reached.
657 * @deprecated use avfilter_next()
660 AVFilter **av_filter_next(AVFilter **filter);
663 #if FF_API_AVFILTER_OPEN
665 * Create a filter instance.
667 * @param filter_ctx put here a pointer to the created filter context
668 * on success, NULL on failure
669 * @param filter the filter to create an instance of
670 * @param inst_name Name to give to the new instance. Can be NULL for none.
671 * @return >= 0 in case of success, a negative error code otherwise
672 * @deprecated use avfilter_graph_alloc_filter() instead
675 int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name);
679 #if FF_API_AVFILTER_INIT_FILTER
681 * Initialize a filter.
683 * @param filter the filter to initialize
684 * @param args A string of parameters to use when initializing the filter.
685 * The format and meaning of this string varies by filter.
686 * @param opaque Any extra non-string data needed by the filter. The meaning
687 * of this parameter varies by filter.
688 * @return zero on success
691 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
695 * Initialize a filter with the supplied parameters.
697 * @param ctx uninitialized filter context to initialize
698 * @param args Options to initialize the filter with. This must be a
699 * ':'-separated list of options in the 'key=value' form.
700 * May be NULL if the options have been set directly using the
701 * AVOptions API or there are no options that need to be set.
702 * @return 0 on success, a negative AVERROR on failure
704 int avfilter_init_str(AVFilterContext *ctx, const char *args);
707 * Initialize a filter with the supplied dictionary of options.
709 * @param ctx uninitialized filter context to initialize
710 * @param options An AVDictionary filled with options for this filter. On
711 * return this parameter will be destroyed and replaced with
712 * a dict containing options that were not found. This dictionary
713 * must be freed by the caller.
714 * May be NULL, then this function is equivalent to
715 * avfilter_init_str() with the second parameter set to NULL.
716 * @return 0 on success, a negative AVERROR on failure
718 * @note This function and avfilter_init_str() do essentially the same thing,
719 * the difference is in manner in which the options are passed. It is up to the
720 * calling code to choose whichever is more preferable. The two functions also
721 * behave differently when some of the provided options are not declared as
722 * supported by the filter. In such a case, avfilter_init_str() will fail, but
723 * this function will leave those extra options in the options AVDictionary and
726 int avfilter_init_dict(AVFilterContext *ctx, AVDictionary **options);
729 * Free a filter context. This will also remove the filter from its
730 * filtergraph's list of filters.
732 * @param filter the filter to free
734 void avfilter_free(AVFilterContext *filter);
737 * Insert a filter in the middle of an existing link.
739 * @param link the link into which the filter should be inserted
740 * @param filt the filter to be inserted
741 * @param filt_srcpad_idx the input pad on the filter to connect
742 * @param filt_dstpad_idx the output pad on the filter to connect
743 * @return zero on success
745 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
746 unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
749 * @return AVClass for AVFilterContext.
751 * @see av_opt_find().
753 const AVClass *avfilter_get_class(void);
755 typedef struct AVFilterGraphInternal AVFilterGraphInternal;
758 * A function pointer passed to the @ref AVFilterGraph.execute callback to be
759 * executed multiple times, possibly in parallel.
761 * @param ctx the filter context the job belongs to
762 * @param arg an opaque parameter passed through from @ref
763 * AVFilterGraph.execute
764 * @param jobnr the index of the job being executed
765 * @param nb_jobs the total number of jobs
767 * @return 0 on success, a negative AVERROR on error
769 typedef int (avfilter_action_func)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
772 * A function executing multiple jobs, possibly in parallel.
774 * @param ctx the filter context to which the jobs belong
775 * @param func the function to be called multiple times
776 * @param arg the argument to be passed to func
777 * @param ret a nb_jobs-sized array to be filled with return values from each
779 * @param nb_jobs the number of jobs to execute
781 * @return 0 on success, a negative AVERROR on error
783 typedef int (avfilter_execute_func)(AVFilterContext *ctx, avfilter_action_func *func,
784 void *arg, int *ret, int nb_jobs);
786 typedef struct AVFilterGraph {
787 const AVClass *av_class;
788 AVFilterContext **filters;
791 char *scale_sws_opts; ///< sws options to use for the auto-inserted scale filters
792 char *resample_lavr_opts; ///< libavresample options to use for the auto-inserted resample filters
795 * Type of multithreading allowed for filters in this graph. A combination
796 * of AVFILTER_THREAD_* flags.
798 * May be set by the caller at any point, the setting will apply to all
799 * filters initialized after that. The default is allowing everything.
801 * When a filter in this graph is initialized, this field is combined using
802 * bit AND with AVFilterContext.thread_type to get the final mask used for
803 * determining allowed threading types. I.e. a threading type needs to be
804 * set in both to be allowed.
809 * Maximum number of threads used by filters in this graph. May be set by
810 * the caller before adding any filters to the filtergraph. Zero (the
811 * default) means that the number of threads is determined automatically.
816 * Opaque object for libavfilter internal use.
818 AVFilterGraphInternal *internal;
821 * Opaque user data. May be set by the caller to an arbitrary value, e.g. to
822 * be used from callbacks like @ref AVFilterGraph.execute.
823 * Libavfilter will not touch this field in any way.
828 * This callback may be set by the caller immediately after allocating the
829 * graph and before adding any filters to it, to provide a custom
830 * multithreading implementation.
832 * If set, filters with slice threading capability will call this callback
833 * to execute multiple jobs in parallel.
835 * If this field is left unset, libavfilter will use its internal
836 * implementation, which may or may not be multithreaded depending on the
837 * platform and build options.
839 avfilter_execute_func *execute;
841 char *aresample_swr_opts; ///< swr options to use for the auto-inserted aresample filters, Access ONLY through AVOptions
846 * The following fields are for internal use only.
847 * Their type, offset, number and semantic can change without notice.
850 AVFilterLink **sink_links;
851 int sink_links_count;
853 unsigned disable_auto_convert;
857 * Allocate a filter graph.
859 * @return the allocated filter graph on success or NULL.
861 AVFilterGraph *avfilter_graph_alloc(void);
864 * Create a new filter instance in a filter graph.
866 * @param graph graph in which the new filter will be used
867 * @param filter the filter to create an instance of
868 * @param name Name to give to the new instance (will be copied to
869 * AVFilterContext.name). This may be used by the caller to identify
870 * different filters, libavfilter itself assigns no semantics to
871 * this parameter. May be NULL.
873 * @return the context of the newly created filter instance (note that it is
874 * also retrievable directly through AVFilterGraph.filters or with
875 * avfilter_graph_get_filter()) on success or NULL on failure.
877 AVFilterContext *avfilter_graph_alloc_filter(AVFilterGraph *graph,
878 const AVFilter *filter,
882 * Get a filter instance identified by instance name from graph.
884 * @param graph filter graph to search through.
885 * @param name filter instance name (should be unique in the graph).
886 * @return the pointer to the found filter instance or NULL if it
889 AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, const char *name);
891 #if FF_API_AVFILTER_OPEN
893 * Add an existing filter instance to a filter graph.
895 * @param graphctx the filter graph
896 * @param filter the filter to be added
898 * @deprecated use avfilter_graph_alloc_filter() to allocate a filter in a
902 int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter);
906 * Create and add a filter instance into an existing graph.
907 * The filter instance is created from the filter filt and inited
908 * with the parameters args and opaque.
910 * In case of success put in *filt_ctx the pointer to the created
911 * filter instance, otherwise set *filt_ctx to NULL.
913 * @param name the instance name to give to the created filter instance
914 * @param graph_ctx the filter graph
915 * @return a negative AVERROR error code in case of failure, a non
916 * negative value otherwise
918 int avfilter_graph_create_filter(AVFilterContext **filt_ctx, const AVFilter *filt,
919 const char *name, const char *args, void *opaque,
920 AVFilterGraph *graph_ctx);
923 * Enable or disable automatic format conversion inside the graph.
925 * Note that format conversion can still happen inside explicitly inserted
926 * scale and aresample filters.
928 * @param flags any of the AVFILTER_AUTO_CONVERT_* constants
930 void avfilter_graph_set_auto_convert(AVFilterGraph *graph, unsigned flags);
933 AVFILTER_AUTO_CONVERT_ALL = 0, /**< all automatic conversions enabled */
934 AVFILTER_AUTO_CONVERT_NONE = -1, /**< all automatic conversions disabled */
938 * Check validity and configure all the links and formats in the graph.
940 * @param graphctx the filter graph
941 * @param log_ctx context used for logging
942 * @return >= 0 in case of success, a negative AVERROR code otherwise
944 int avfilter_graph_config(AVFilterGraph *graphctx, void *log_ctx);
947 * Free a graph, destroy its links, and set *graph to NULL.
948 * If *graph is NULL, do nothing.
950 void avfilter_graph_free(AVFilterGraph **graph);
953 * A linked-list of the inputs/outputs of the filter chain.
955 * This is mainly useful for avfilter_graph_parse() / avfilter_graph_parse2(),
956 * where it is used to communicate open (unlinked) inputs and outputs from and
958 * This struct specifies, per each not connected pad contained in the graph, the
959 * filter context and the pad index required for establishing a link.
961 typedef struct AVFilterInOut {
962 /** unique name for this input/output in the list */
965 /** filter context associated to this input/output */
966 AVFilterContext *filter_ctx;
968 /** index of the filt_ctx pad to use for linking */
971 /** next input/input in the list, NULL if this is the last */
972 struct AVFilterInOut *next;
976 * Allocate a single AVFilterInOut entry.
977 * Must be freed with avfilter_inout_free().
978 * @return allocated AVFilterInOut on success, NULL on failure.
980 AVFilterInOut *avfilter_inout_alloc(void);
983 * Free the supplied list of AVFilterInOut and set *inout to NULL.
984 * If *inout is NULL, do nothing.
986 void avfilter_inout_free(AVFilterInOut **inout);
989 * Add a graph described by a string to a graph.
991 * @note The caller must provide the lists of inputs and outputs,
992 * which therefore must be known before calling the function.
994 * @note The inputs parameter describes inputs of the already existing
995 * part of the graph; i.e. from the point of view of the newly created
996 * part, they are outputs. Similarly the outputs parameter describes
997 * outputs of the already existing filters, which are provided as
998 * inputs to the parsed filters.
1000 * @param graph the filter graph where to link the parsed graph context
1001 * @param filters string to be parsed
1002 * @param inputs linked list to the inputs of the graph
1003 * @param outputs linked list to the outputs of the graph
1004 * @return zero on success, a negative AVERROR code on error
1006 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
1007 AVFilterInOut *inputs, AVFilterInOut *outputs,
1011 * Add a graph described by a string to a graph.
1013 * In the graph filters description, if the input label of the first
1014 * filter is not specified, "in" is assumed; if the output label of
1015 * the last filter is not specified, "out" is assumed.
1017 * @param graph the filter graph where to link the parsed graph context
1018 * @param filters string to be parsed
1019 * @param inputs pointer to a linked list to the inputs of the graph, may be NULL.
1020 * If non-NULL, *inputs is updated to contain the list of open inputs
1021 * after the parsing, should be freed with avfilter_inout_free().
1022 * @param outputs pointer to a linked list to the outputs of the graph, may be NULL.
1023 * If non-NULL, *outputs is updated to contain the list of open outputs
1024 * after the parsing, should be freed with avfilter_inout_free().
1025 * @return non negative on success, a negative AVERROR code on error
1027 int avfilter_graph_parse_ptr(AVFilterGraph *graph, const char *filters,
1028 AVFilterInOut **inputs, AVFilterInOut **outputs,
1032 * Add a graph described by a string to a graph.
1034 * @param[in] graph the filter graph where to link the parsed graph context
1035 * @param[in] filters string to be parsed
1036 * @param[out] inputs a linked list of all free (unlinked) inputs of the
1037 * parsed graph will be returned here. It is to be freed
1038 * by the caller using avfilter_inout_free().
1039 * @param[out] outputs a linked list of all free (unlinked) outputs of the
1040 * parsed graph will be returned here. It is to be freed by the
1041 * caller using avfilter_inout_free().
1042 * @return zero on success, a negative AVERROR code on error
1044 * @note This function returns the inputs and outputs that are left
1045 * unlinked after parsing the graph and the caller then deals with
1047 * @note This function makes no reference whatsoever to already
1048 * existing parts of the graph and the inputs parameter will on return
1049 * contain inputs of the newly parsed part of the graph. Analogously
1050 * the outputs parameter will contain outputs of the newly created
1053 int avfilter_graph_parse2(AVFilterGraph *graph, const char *filters,
1054 AVFilterInOut **inputs,
1055 AVFilterInOut **outputs);
1058 * Send a command to one or more filter instances.
1060 * @param graph the filter graph
1061 * @param target the filter(s) to which the command should be sent
1062 * "all" sends to all filters
1063 * otherwise it can be a filter or filter instance name
1064 * which will send the command to all matching filters.
1065 * @param cmd the command to send, for handling simplicity all commands must be alphanumeric only
1066 * @param arg the argument for the command
1067 * @param res a buffer with size res_size where the filter(s) can return a response.
1069 * @returns >=0 on success otherwise an error code.
1070 * AVERROR(ENOSYS) on unsupported commands
1072 int avfilter_graph_send_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, char *res, int res_len, int flags);
1075 * Queue a command for one or more filter instances.
1077 * @param graph the filter graph
1078 * @param target the filter(s) to which the command should be sent
1079 * "all" sends to all filters
1080 * otherwise it can be a filter or filter instance name
1081 * which will send the command to all matching filters.
1082 * @param cmd the command to sent, for handling simplicity all commands must be alphanumeric only
1083 * @param arg the argument for the command
1084 * @param ts time at which the command should be sent to the filter
1086 * @note As this executes commands after this function returns, no return code
1087 * from the filter is provided, also AVFILTER_CMD_FLAG_ONE is not supported.
1089 int avfilter_graph_queue_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, int flags, double ts);
1093 * Dump a graph into a human-readable string representation.
1095 * @param graph the graph to dump
1096 * @param options formatting options; currently ignored
1097 * @return a string, or NULL in case of memory allocation failure;
1098 * the string must be freed using av_free
1100 char *avfilter_graph_dump(AVFilterGraph *graph, const char *options);
1103 * Request a frame on the oldest sink link.
1105 * If the request returns AVERROR_EOF, try the next.
1107 * Note that this function is not meant to be the sole scheduling mechanism
1108 * of a filtergraph, only a convenience function to help drain a filtergraph
1109 * in a balanced way under normal circumstances.
1111 * Also note that AVERROR_EOF does not mean that frames did not arrive on
1112 * some of the sinks during the process.
1113 * When there are multiple sink links, in case the requested link
1114 * returns an EOF, this may cause a filter to flush pending frames
1115 * which are sent to another sink link, although unrequested.
1117 * @return the return value of ff_request_frame(),
1118 * or AVERROR_EOF if all links returned AVERROR_EOF
1120 int avfilter_graph_request_oldest(AVFilterGraph *graph);
1126 #endif /* AVFILTER_AVFILTER_H */