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 * Link processing flags.
596 * Number of past frames sent through the link.
598 int64_t frame_count_in, frame_count_out;
601 * A pointer to a FFFramePool struct.
606 * True if a frame is currently wanted on the output of this filter.
607 * Set when ff_request_frame() is called by the output,
608 * cleared when a frame is filtered.
610 int frame_wanted_out;
613 * For hwaccel pixel formats, this should be a reference to the
614 * AVHWFramesContext describing the frames.
616 AVBufferRef *hw_frames_ctx;
618 #ifndef FF_INTERNAL_FIELDS
621 * Internal structure members.
622 * The fields below this limit are internal for libavfilter's use
623 * and must in no way be accessed by applications.
625 char reserved[0xF000];
627 #else /* FF_INTERNAL_FIELDS */
630 * Queue of frames waiting to be filtered.
635 * If set, the source filter can not generate a frame as is.
636 * The goal is to avoid repeatedly calling the request_frame() method on
639 int frame_blocked_in;
643 * If not zero, all attempts of filter_frame will fail with the
644 * corresponding code.
649 * Timestamp of the input status change.
651 int64_t status_in_pts;
654 * Link output status.
655 * If not zero, all attempts of request_frame will fail with the
656 * corresponding code.
660 #endif /* FF_INTERNAL_FIELDS */
665 * Link two filters together.
667 * @param src the source filter
668 * @param srcpad index of the output pad on the source filter
669 * @param dst the destination filter
670 * @param dstpad index of the input pad on the destination filter
671 * @return zero on success
673 int avfilter_link(AVFilterContext *src, unsigned srcpad,
674 AVFilterContext *dst, unsigned dstpad);
677 * Free the link in *link, and set its pointer to NULL.
679 void avfilter_link_free(AVFilterLink **link);
681 #if FF_API_FILTER_GET_SET
683 * Get the number of channels of a link.
684 * @deprecated Use av_buffersink_get_channels()
687 int avfilter_link_get_channels(AVFilterLink *link);
691 * Set the closed field of a link.
692 * @deprecated applications are not supposed to mess with links, they should
696 void avfilter_link_set_closed(AVFilterLink *link, int closed);
699 * Negotiate the media format, dimensions, etc of all inputs to a filter.
701 * @param filter the filter to negotiate the properties for its inputs
702 * @return zero on successful negotiation
704 int avfilter_config_links(AVFilterContext *filter);
706 #define AVFILTER_CMD_FLAG_ONE 1 ///< Stop once a filter understood the command (for target=all for example), fast filters are favored automatically
707 #define AVFILTER_CMD_FLAG_FAST 2 ///< Only execute command when its fast (like a video out that supports contrast adjustment in hw)
710 * Make the filter instance process a command.
711 * It is recommended to use avfilter_graph_send_command().
713 int avfilter_process_command(AVFilterContext *filter, const char *cmd, const char *arg, char *res, int res_len, int flags);
716 * Iterate over all registered filters.
718 * @param opaque a pointer where libavfilter will store the iteration state. Must
719 * point to NULL to start the iteration.
721 * @return the next registered filter or NULL when the iteration is
724 const AVFilter *av_filter_iterate(void **opaque);
727 /** Initialize the filter system. Register all builtin filters. */
729 void avfilter_register_all(void);
732 * Register a filter. This is only needed if you plan to use
733 * avfilter_get_by_name later to lookup the AVFilter structure by name. A
734 * filter can still by instantiated with avfilter_graph_alloc_filter even if it
737 * @param filter the filter to register
738 * @return 0 if the registration was successful, a negative value
742 int avfilter_register(AVFilter *filter);
745 * Iterate over all registered filters.
746 * @return If prev is non-NULL, next registered filter after prev or NULL if
747 * prev is the last filter. If prev is NULL, return the first registered filter.
750 const AVFilter *avfilter_next(const AVFilter *prev);
754 * Get a filter definition matching the given name.
756 * @param name the filter name to find
757 * @return the filter definition, if any matching one is registered.
758 * NULL if none found.
760 const AVFilter *avfilter_get_by_name(const char *name);
764 * Initialize a filter with the supplied parameters.
766 * @param ctx uninitialized filter context to initialize
767 * @param args Options to initialize the filter with. This must be a
768 * ':'-separated list of options in the 'key=value' form.
769 * May be NULL if the options have been set directly using the
770 * AVOptions API or there are no options that need to be set.
771 * @return 0 on success, a negative AVERROR on failure
773 int avfilter_init_str(AVFilterContext *ctx, const char *args);
776 * Initialize a filter with the supplied dictionary of options.
778 * @param ctx uninitialized filter context to initialize
779 * @param options An AVDictionary filled with options for this filter. On
780 * return this parameter will be destroyed and replaced with
781 * a dict containing options that were not found. This dictionary
782 * must be freed by the caller.
783 * May be NULL, then this function is equivalent to
784 * avfilter_init_str() with the second parameter set to NULL.
785 * @return 0 on success, a negative AVERROR on failure
787 * @note This function and avfilter_init_str() do essentially the same thing,
788 * the difference is in manner in which the options are passed. It is up to the
789 * calling code to choose whichever is more preferable. The two functions also
790 * behave differently when some of the provided options are not declared as
791 * supported by the filter. In such a case, avfilter_init_str() will fail, but
792 * this function will leave those extra options in the options AVDictionary and
795 int avfilter_init_dict(AVFilterContext *ctx, AVDictionary **options);
798 * Free a filter context. This will also remove the filter from its
799 * filtergraph's list of filters.
801 * @param filter the filter to free
803 void avfilter_free(AVFilterContext *filter);
806 * Insert a filter in the middle of an existing link.
808 * @param link the link into which the filter should be inserted
809 * @param filt the filter to be inserted
810 * @param filt_srcpad_idx the input pad on the filter to connect
811 * @param filt_dstpad_idx the output pad on the filter to connect
812 * @return zero on success
814 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
815 unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
818 * @return AVClass for AVFilterContext.
820 * @see av_opt_find().
822 const AVClass *avfilter_get_class(void);
824 typedef struct AVFilterGraphInternal AVFilterGraphInternal;
827 * A function pointer passed to the @ref AVFilterGraph.execute callback to be
828 * executed multiple times, possibly in parallel.
830 * @param ctx the filter context the job belongs to
831 * @param arg an opaque parameter passed through from @ref
832 * AVFilterGraph.execute
833 * @param jobnr the index of the job being executed
834 * @param nb_jobs the total number of jobs
836 * @return 0 on success, a negative AVERROR on error
838 typedef int (avfilter_action_func)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
841 * A function executing multiple jobs, possibly in parallel.
843 * @param ctx the filter context to which the jobs belong
844 * @param func the function to be called multiple times
845 * @param arg the argument to be passed to func
846 * @param ret a nb_jobs-sized array to be filled with return values from each
848 * @param nb_jobs the number of jobs to execute
850 * @return 0 on success, a negative AVERROR on error
852 typedef int (avfilter_execute_func)(AVFilterContext *ctx, avfilter_action_func *func,
853 void *arg, int *ret, int nb_jobs);
855 typedef struct AVFilterGraph {
856 const AVClass *av_class;
857 AVFilterContext **filters;
860 char *scale_sws_opts; ///< sws options to use for the auto-inserted scale filters
862 attribute_deprecated char *resample_lavr_opts; ///< libavresample options to use for the auto-inserted resample filters
866 * Type of multithreading allowed for filters in this graph. A combination
867 * of AVFILTER_THREAD_* flags.
869 * May be set by the caller at any point, the setting will apply to all
870 * filters initialized after that. The default is allowing everything.
872 * When a filter in this graph is initialized, this field is combined using
873 * bit AND with AVFilterContext.thread_type to get the final mask used for
874 * determining allowed threading types. I.e. a threading type needs to be
875 * set in both to be allowed.
880 * Maximum number of threads used by filters in this graph. May be set by
881 * the caller before adding any filters to the filtergraph. Zero (the
882 * default) means that the number of threads is determined automatically.
887 * Opaque object for libavfilter internal use.
889 AVFilterGraphInternal *internal;
892 * Opaque user data. May be set by the caller to an arbitrary value, e.g. to
893 * be used from callbacks like @ref AVFilterGraph.execute.
894 * Libavfilter will not touch this field in any way.
899 * This callback may be set by the caller immediately after allocating the
900 * graph and before adding any filters to it, to provide a custom
901 * multithreading implementation.
903 * If set, filters with slice threading capability will call this callback
904 * to execute multiple jobs in parallel.
906 * If this field is left unset, libavfilter will use its internal
907 * implementation, which may or may not be multithreaded depending on the
908 * platform and build options.
910 avfilter_execute_func *execute;
912 char *aresample_swr_opts; ///< swr options to use for the auto-inserted aresample filters, Access ONLY through AVOptions
917 * The following fields are for internal use only.
918 * Their type, offset, number and semantic can change without notice.
921 AVFilterLink **sink_links;
922 int sink_links_count;
924 unsigned disable_auto_convert;
928 * Allocate a filter graph.
930 * @return the allocated filter graph on success or NULL.
932 AVFilterGraph *avfilter_graph_alloc(void);
935 * Create a new filter instance in a filter graph.
937 * @param graph graph in which the new filter will be used
938 * @param filter the filter to create an instance of
939 * @param name Name to give to the new instance (will be copied to
940 * AVFilterContext.name). This may be used by the caller to identify
941 * different filters, libavfilter itself assigns no semantics to
942 * this parameter. May be NULL.
944 * @return the context of the newly created filter instance (note that it is
945 * also retrievable directly through AVFilterGraph.filters or with
946 * avfilter_graph_get_filter()) on success or NULL on failure.
948 AVFilterContext *avfilter_graph_alloc_filter(AVFilterGraph *graph,
949 const AVFilter *filter,
953 * Get a filter instance identified by instance name from graph.
955 * @param graph filter graph to search through.
956 * @param name filter instance name (should be unique in the graph).
957 * @return the pointer to the found filter instance or NULL if it
960 AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, const char *name);
963 * Create and add a filter instance into an existing graph.
964 * The filter instance is created from the filter filt and inited
965 * with the parameter args. opaque is currently ignored.
967 * In case of success put in *filt_ctx the pointer to the created
968 * filter instance, otherwise set *filt_ctx to NULL.
970 * @param name the instance name to give to the created filter instance
971 * @param graph_ctx the filter graph
972 * @return a negative AVERROR error code in case of failure, a non
973 * negative value otherwise
975 int avfilter_graph_create_filter(AVFilterContext **filt_ctx, const AVFilter *filt,
976 const char *name, const char *args, void *opaque,
977 AVFilterGraph *graph_ctx);
980 * Enable or disable automatic format conversion inside the graph.
982 * Note that format conversion can still happen inside explicitly inserted
983 * scale and aresample filters.
985 * @param flags any of the AVFILTER_AUTO_CONVERT_* constants
987 void avfilter_graph_set_auto_convert(AVFilterGraph *graph, unsigned flags);
990 AVFILTER_AUTO_CONVERT_ALL = 0, /**< all automatic conversions enabled */
991 AVFILTER_AUTO_CONVERT_NONE = -1, /**< all automatic conversions disabled */
995 * Check validity and configure all the links and formats in the graph.
997 * @param graphctx the filter graph
998 * @param log_ctx context used for logging
999 * @return >= 0 in case of success, a negative AVERROR code otherwise
1001 int avfilter_graph_config(AVFilterGraph *graphctx, void *log_ctx);
1004 * Free a graph, destroy its links, and set *graph to NULL.
1005 * If *graph is NULL, do nothing.
1007 void avfilter_graph_free(AVFilterGraph **graph);
1010 * A linked-list of the inputs/outputs of the filter chain.
1012 * This is mainly useful for avfilter_graph_parse() / avfilter_graph_parse2(),
1013 * where it is used to communicate open (unlinked) inputs and outputs from and
1015 * This struct specifies, per each not connected pad contained in the graph, the
1016 * filter context and the pad index required for establishing a link.
1018 typedef struct AVFilterInOut {
1019 /** unique name for this input/output in the list */
1022 /** filter context associated to this input/output */
1023 AVFilterContext *filter_ctx;
1025 /** index of the filt_ctx pad to use for linking */
1028 /** next input/input in the list, NULL if this is the last */
1029 struct AVFilterInOut *next;
1033 * Allocate a single AVFilterInOut entry.
1034 * Must be freed with avfilter_inout_free().
1035 * @return allocated AVFilterInOut on success, NULL on failure.
1037 AVFilterInOut *avfilter_inout_alloc(void);
1040 * Free the supplied list of AVFilterInOut and set *inout to NULL.
1041 * If *inout is NULL, do nothing.
1043 void avfilter_inout_free(AVFilterInOut **inout);
1046 * Add a graph described by a string to a graph.
1048 * @note The caller must provide the lists of inputs and outputs,
1049 * which therefore must be known before calling the function.
1051 * @note The inputs parameter describes inputs of the already existing
1052 * part of the graph; i.e. from the point of view of the newly created
1053 * part, they are outputs. Similarly the outputs parameter describes
1054 * outputs of the already existing filters, which are provided as
1055 * inputs to the parsed filters.
1057 * @param graph the filter graph where to link the parsed graph context
1058 * @param filters string to be parsed
1059 * @param inputs linked list to the inputs of the graph
1060 * @param outputs linked list to the outputs of the graph
1061 * @return zero on success, a negative AVERROR code on error
1063 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
1064 AVFilterInOut *inputs, AVFilterInOut *outputs,
1068 * Add a graph described by a string to a graph.
1070 * In the graph filters description, if the input label of the first
1071 * filter is not specified, "in" is assumed; if the output label of
1072 * the last filter is not specified, "out" is assumed.
1074 * @param graph the filter graph where to link the parsed graph context
1075 * @param filters string to be parsed
1076 * @param inputs pointer to a linked list to the inputs of the graph, may be NULL.
1077 * If non-NULL, *inputs is updated to contain the list of open inputs
1078 * after the parsing, should be freed with avfilter_inout_free().
1079 * @param outputs pointer to a linked list to the outputs of the graph, may be NULL.
1080 * If non-NULL, *outputs is updated to contain the list of open outputs
1081 * after the parsing, should be freed with avfilter_inout_free().
1082 * @return non negative on success, a negative AVERROR code on error
1084 int avfilter_graph_parse_ptr(AVFilterGraph *graph, const char *filters,
1085 AVFilterInOut **inputs, AVFilterInOut **outputs,
1089 * Add a graph described by a string to a graph.
1091 * @param[in] graph the filter graph where to link the parsed graph context
1092 * @param[in] filters string to be parsed
1093 * @param[out] inputs a linked list of all free (unlinked) inputs of the
1094 * parsed graph will be returned here. It is to be freed
1095 * by the caller using avfilter_inout_free().
1096 * @param[out] outputs a linked list of all free (unlinked) outputs of the
1097 * parsed graph will be returned here. It is to be freed by the
1098 * caller using avfilter_inout_free().
1099 * @return zero on success, a negative AVERROR code on error
1101 * @note This function returns the inputs and outputs that are left
1102 * unlinked after parsing the graph and the caller then deals with
1104 * @note This function makes no reference whatsoever to already
1105 * existing parts of the graph and the inputs parameter will on return
1106 * contain inputs of the newly parsed part of the graph. Analogously
1107 * the outputs parameter will contain outputs of the newly created
1110 int avfilter_graph_parse2(AVFilterGraph *graph, const char *filters,
1111 AVFilterInOut **inputs,
1112 AVFilterInOut **outputs);
1115 * Send a command to one or more filter instances.
1117 * @param graph the filter graph
1118 * @param target the filter(s) to which the command should be sent
1119 * "all" sends to all filters
1120 * otherwise it can be a filter or filter instance name
1121 * which will send the command to all matching filters.
1122 * @param cmd the command to send, for handling simplicity all commands must be alphanumeric only
1123 * @param arg the argument for the command
1124 * @param res a buffer with size res_size where the filter(s) can return a response.
1126 * @returns >=0 on success otherwise an error code.
1127 * AVERROR(ENOSYS) on unsupported commands
1129 int avfilter_graph_send_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, char *res, int res_len, int flags);
1132 * Queue a command for one or more filter instances.
1134 * @param graph the filter graph
1135 * @param target the filter(s) to which the command should be sent
1136 * "all" sends to all filters
1137 * otherwise it can be a filter or filter instance name
1138 * which will send the command to all matching filters.
1139 * @param cmd the command to sent, for handling simplicity all commands must be alphanumeric only
1140 * @param arg the argument for the command
1141 * @param ts time at which the command should be sent to the filter
1143 * @note As this executes commands after this function returns, no return code
1144 * from the filter is provided, also AVFILTER_CMD_FLAG_ONE is not supported.
1146 int avfilter_graph_queue_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, int flags, double ts);
1150 * Dump a graph into a human-readable string representation.
1152 * @param graph the graph to dump
1153 * @param options formatting options; currently ignored
1154 * @return a string, or NULL in case of memory allocation failure;
1155 * the string must be freed using av_free
1157 char *avfilter_graph_dump(AVFilterGraph *graph, const char *options);
1160 * Request a frame on the oldest sink link.
1162 * If the request returns AVERROR_EOF, try the next.
1164 * Note that this function is not meant to be the sole scheduling mechanism
1165 * of a filtergraph, only a convenience function to help drain a filtergraph
1166 * in a balanced way under normal circumstances.
1168 * Also note that AVERROR_EOF does not mean that frames did not arrive on
1169 * some of the sinks during the process.
1170 * When there are multiple sink links, in case the requested link
1171 * returns an EOF, this may cause a filter to flush pending frames
1172 * which are sent to another sink link, although unrequested.
1174 * @return the return value of ff_request_frame(),
1175 * or AVERROR_EOF if all links returned AVERROR_EOF
1177 int avfilter_graph_request_oldest(AVFilterGraph *graph);
1183 #endif /* AVFILTER_AVFILTER_H */