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 - graph-based frame editing library
38 #include "libavutil/attributes.h"
39 #include "libavutil/avutil.h"
40 #include "libavutil/dict.h"
41 #include "libavutil/frame.h"
42 #include "libavutil/log.h"
43 #include "libavutil/samplefmt.h"
44 #include "libavutil/pixfmt.h"
45 #include "libavutil/rational.h"
47 #include "libavfilter/version.h"
50 * Return the LIBAVFILTER_VERSION_INT constant.
52 unsigned avfilter_version(void);
55 * Return the libavfilter build-time configuration.
57 const char *avfilter_configuration(void);
60 * Return the libavfilter license.
62 const char *avfilter_license(void);
64 typedef struct AVFilterContext AVFilterContext;
65 typedef struct AVFilterLink AVFilterLink;
66 typedef struct AVFilterPad AVFilterPad;
67 typedef struct AVFilterFormats AVFilterFormats;
70 * Get the number of elements in a NULL-terminated array of AVFilterPads (e.g.
71 * AVFilter.inputs/outputs).
73 int avfilter_pad_count(const AVFilterPad *pads);
76 * Get the name of an AVFilterPad.
78 * @param pads an array of AVFilterPads
79 * @param pad_idx index of the pad in the array it; is the caller's
80 * responsibility to ensure the index is valid
82 * @return name of the pad_idx'th pad in pads
84 const char *avfilter_pad_get_name(const AVFilterPad *pads, int pad_idx);
87 * Get the type of an AVFilterPad.
89 * @param pads an array of AVFilterPads
90 * @param pad_idx index of the pad in the array; it is the caller's
91 * responsibility to ensure the index is valid
93 * @return type of the pad_idx'th pad in pads
95 enum AVMediaType avfilter_pad_get_type(const AVFilterPad *pads, int pad_idx);
98 * The number of the filter inputs is not determined just by AVFilter.inputs.
99 * The filter might add additional inputs during initialization depending on the
100 * options supplied to it.
102 #define AVFILTER_FLAG_DYNAMIC_INPUTS (1 << 0)
104 * The number of the filter outputs is not determined just by AVFilter.outputs.
105 * The filter might add additional outputs during initialization depending on
106 * the options supplied to it.
108 #define AVFILTER_FLAG_DYNAMIC_OUTPUTS (1 << 1)
110 * The filter supports multithreading by splitting frames into multiple parts
111 * and processing them concurrently.
113 #define AVFILTER_FLAG_SLICE_THREADS (1 << 2)
115 * Some filters support a generic "enable" expression option that can be used
116 * to enable or disable a filter in the timeline. Filters supporting this
117 * option have this flag set. When the enable expression is false, the default
118 * no-op filter_frame() function is called in place of the filter_frame()
119 * callback defined on each input pad, thus the frame is passed unchanged to
122 #define AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC (1 << 16)
124 * Same as AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC, except that the filter will
125 * have its filter_frame() callback(s) called as usual even when the enable
126 * expression is false. The filter will disable filtering within the
127 * filter_frame() callback(s) itself, for example executing code depending on
128 * the AVFilterContext->is_disabled value.
130 #define AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL (1 << 17)
132 * Handy mask to test whether the filter supports or no the timeline feature
133 * (internally or generically).
135 #define AVFILTER_FLAG_SUPPORT_TIMELINE (AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL)
138 * Filter definition. This defines the pads a filter contains, and all the
139 * callback functions used to interact with the filter.
141 typedef struct AVFilter {
143 * Filter name. Must be non-NULL and unique among filters.
148 * A description of the filter. May be NULL.
150 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
152 const char *description;
155 * List of inputs, terminated by a zeroed element.
157 * NULL if there are no (static) inputs. Instances of filters with
158 * AVFILTER_FLAG_DYNAMIC_INPUTS set may have more inputs than present in
161 const AVFilterPad *inputs;
163 * List of outputs, terminated by a zeroed element.
165 * NULL if there are no (static) outputs. Instances of filters with
166 * AVFILTER_FLAG_DYNAMIC_OUTPUTS set may have more outputs than present in
169 const AVFilterPad *outputs;
172 * A class for the private data, used to declare filter private AVOptions.
173 * This field is NULL for filters that do not declare any options.
175 * If this field is non-NULL, the first member of the filter private data
176 * must be a pointer to AVClass, which will be set by libavfilter generic
177 * code to this class.
179 const AVClass *priv_class;
182 * A combination of AVFILTER_FLAG_*
186 /*****************************************************************
187 * All fields below this line are not part of the public API. They
188 * may not be used outside of libavfilter and can be changed and
190 * New public fields should be added right above.
191 *****************************************************************
195 * Filter initialization function.
197 * This callback will be called only once during the filter lifetime, after
198 * all the options have been set, but before links between filters are
199 * established and format negotiation is done.
201 * Basic filter initialization should be done here. Filters with dynamic
202 * inputs and/or outputs should create those inputs/outputs here based on
203 * provided options. No more changes to this filter's inputs/outputs can be
204 * done after this callback.
206 * This callback must not assume that the filter links exist or frame
207 * parameters are known.
209 * @ref AVFilter.uninit "uninit" is guaranteed to be called even if
210 * initialization fails, so this callback does not have to clean up on
213 * @return 0 on success, a negative AVERROR on failure
215 int (*init)(AVFilterContext *ctx);
218 * Should be set instead of @ref AVFilter.init "init" by the filters that
219 * want to pass a dictionary of AVOptions to nested contexts that are
220 * allocated during init.
222 * On return, the options dict should be freed and replaced with one that
223 * contains all the options which could not be processed by this filter (or
224 * with NULL if all the options were processed).
226 * Otherwise the semantics is the same as for @ref AVFilter.init "init".
228 int (*init_dict)(AVFilterContext *ctx, AVDictionary **options);
231 * Filter uninitialization function.
233 * Called only once right before the filter is freed. Should deallocate any
234 * memory held by the filter, release any buffer references, etc. It does
235 * not need to deallocate the AVFilterContext.priv memory itself.
237 * This callback may be called even if @ref AVFilter.init "init" was not
238 * called or failed, so it must be prepared to handle such a situation.
240 void (*uninit)(AVFilterContext *ctx);
243 * Query formats supported by the filter on its inputs and outputs.
245 * This callback is called after the filter is initialized (so the inputs
246 * and outputs are fixed), shortly before the format negotiation. This
247 * callback may be called more than once.
249 * This callback must set AVFilterLink.out_formats on every input link and
250 * AVFilterLink.in_formats on every output link to a list of pixel/sample
251 * formats that the filter supports on that link. For audio links, this
252 * filter must also set @ref AVFilterLink.in_samplerates "in_samplerates" /
253 * @ref AVFilterLink.out_samplerates "out_samplerates" and
254 * @ref AVFilterLink.in_channel_layouts "in_channel_layouts" /
255 * @ref AVFilterLink.out_channel_layouts "out_channel_layouts" analogously.
257 * This callback may be NULL for filters with one input, in which case
258 * libavfilter assumes that it supports all input formats and preserves
261 * @return zero on success, a negative value corresponding to an
262 * AVERROR code otherwise
264 int (*query_formats)(AVFilterContext *);
266 int priv_size; ///< size of private data to allocate for the filter
269 * Used by the filter registration system. Must not be touched by any other
272 struct AVFilter *next;
275 * Make the filter instance process a command.
277 * @param cmd the command to process, for handling simplicity all commands must be alphanumeric only
278 * @param arg the argument for the command
279 * @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.
280 * @param flags if AVFILTER_CMD_FLAG_FAST is set and the command would be
281 * time consuming then a filter should treat it like an unsupported command
283 * @returns >=0 on success otherwise an error code.
284 * AVERROR(ENOSYS) on unsupported commands
286 int (*process_command)(AVFilterContext *, const char *cmd, const char *arg, char *res, int res_len, int flags);
289 * Filter initialization function, alternative to the init()
290 * callback. Args contains the user-supplied parameters, opaque is
291 * used for providing binary data.
293 int (*init_opaque)(AVFilterContext *ctx, void *opaque);
297 * Process multiple parts of the frame concurrently.
299 #define AVFILTER_THREAD_SLICE (1 << 0)
301 typedef struct AVFilterInternal AVFilterInternal;
303 /** An instance of a filter */
304 struct AVFilterContext {
305 const AVClass *av_class; ///< needed for av_log() and filters common options
307 const AVFilter *filter; ///< the AVFilter of which this is an instance
309 char *name; ///< name of this filter instance
311 AVFilterPad *input_pads; ///< array of input pads
312 AVFilterLink **inputs; ///< array of pointers to input links
313 unsigned nb_inputs; ///< number of input pads
315 AVFilterPad *output_pads; ///< array of output pads
316 AVFilterLink **outputs; ///< array of pointers to output links
317 unsigned nb_outputs; ///< number of output pads
319 void *priv; ///< private data for use by the filter
321 struct AVFilterGraph *graph; ///< filtergraph this filter belongs to
324 * Type of multithreading being allowed/used. A combination of
325 * AVFILTER_THREAD_* flags.
327 * May be set by the caller before initializing the filter to forbid some
328 * or all kinds of multithreading for this filter. The default is allowing
331 * When the filter is initialized, this field is combined using bit AND with
332 * AVFilterGraph.thread_type to get the final mask used for determining
333 * allowed threading types. I.e. a threading type needs to be set in both
336 * After the filter is initialized, libavfilter sets this field to the
337 * threading type that is actually used (0 for no multithreading).
342 * An opaque struct for libavfilter internal use.
344 AVFilterInternal *internal;
346 struct AVFilterCommand *command_queue;
348 char *enable_str; ///< enable expression string
349 void *enable; ///< parsed expression (AVExpr*)
350 double *var_values; ///< variable values for the enable expression
351 int is_disabled; ///< the enabled state from the last expression evaluation
355 * A link between two filters. This contains pointers to the source and
356 * destination filters between which this link exists, and the indexes of
357 * the pads involved. In addition, this link also contains the parameters
358 * which have been negotiated and agreed upon between the filter, such as
359 * image dimensions, format, etc.
361 struct AVFilterLink {
362 AVFilterContext *src; ///< source filter
363 AVFilterPad *srcpad; ///< output pad on the source filter
365 AVFilterContext *dst; ///< dest filter
366 AVFilterPad *dstpad; ///< input pad on the dest filter
368 enum AVMediaType type; ///< filter media type
370 /* These parameters apply only to video */
371 int w; ///< agreed upon image width
372 int h; ///< agreed upon image height
373 AVRational sample_aspect_ratio; ///< agreed upon sample aspect ratio
374 /* These parameters apply only to audio */
375 uint64_t channel_layout; ///< channel layout of current buffer (see libavutil/channel_layout.h)
376 int sample_rate; ///< samples per second
378 int format; ///< agreed upon media format
381 * Define the time base used by the PTS of the frames/samples
382 * which will pass through this link.
383 * During the configuration stage, each filter is supposed to
384 * change only the output timebase, while the timebase of the
385 * input link is assumed to be an unchangeable property.
387 AVRational time_base;
389 /*****************************************************************
390 * All fields below this line are not part of the public API. They
391 * may not be used outside of libavfilter and can be changed and
393 * New public fields should be added right above.
394 *****************************************************************
397 * Lists of formats and channel layouts supported by the input and output
398 * filters respectively. These lists are used for negotiating the format
399 * to actually be used, which will be loaded into the format and
400 * channel_layout members, above, when chosen.
403 AVFilterFormats *in_formats;
404 AVFilterFormats *out_formats;
407 * Lists of channel layouts and sample rates used for automatic
410 AVFilterFormats *in_samplerates;
411 AVFilterFormats *out_samplerates;
412 struct AVFilterChannelLayouts *in_channel_layouts;
413 struct AVFilterChannelLayouts *out_channel_layouts;
416 * Audio only, the destination filter sets this to a non-zero value to
417 * request that buffers with the given number of samples should be sent to
418 * it. AVFilterPad.needs_fifo must also be set on the corresponding input
420 * Last buffer before EOF will be padded with silence.
424 /** stage of the initialization of the link properties (dimensions, etc) */
426 AVLINK_UNINIT = 0, ///< not started
427 AVLINK_STARTINIT, ///< started, but incomplete
428 AVLINK_INIT ///< complete
432 * Graph the filter belongs to.
434 struct AVFilterGraph *graph;
437 * Current timestamp of the link, as defined by the most recent
438 * frame(s), in link time_base units.
443 * Current timestamp of the link, as defined by the most recent
444 * frame(s), in AV_TIME_BASE units.
446 int64_t current_pts_us;
449 * Index in the age array.
454 * Frame rate of the stream on the link, or 1/0 if unknown or variable;
455 * if left to 0/0, will be automatically copied from the first input
456 * of the source filter if it exists.
458 * Sources should set it to the best estimation of the real frame rate.
459 * If the source frame rate is unknown or variable, set this to 1/0.
460 * Filters should update it if necessary depending on their function.
461 * Sinks can use it to set a default output frame rate.
462 * It is similar to the r_frame_rate field in AVStream.
464 AVRational frame_rate;
467 * Buffer partially filled with samples to achieve a fixed/minimum size.
469 AVFrame *partial_buf;
472 * Size of the partial buffer to allocate.
473 * Must be between min_samples and max_samples.
475 int partial_buf_size;
478 * Minimum number of samples to filter at once. If filter_frame() is
479 * called with fewer samples, it will accumulate them in partial_buf.
480 * This field and the related ones must not be changed after filtering
482 * If 0, all related fields are ignored.
487 * Maximum number of samples to filter at once. If filter_frame() is
488 * called with more samples, it will split them.
493 * True if the link is closed.
494 * If set, all attempts of start_frame, filter_frame or request_frame
495 * will fail with AVERROR_EOF, and if necessary the reference will be
497 * If request_frame returns AVERROR_EOF, this flag is set on the
498 * corresponding link.
499 * It can be set also be set by either the source or the destination
505 * Number of channels.
510 * Link processing flags.
515 * Number of past frames sent through the link.
520 * A pointer to a FFVideoFramePool struct.
522 void *video_frame_pool;
526 * Link two filters together.
528 * @param src the source filter
529 * @param srcpad index of the output pad on the source filter
530 * @param dst the destination filter
531 * @param dstpad index of the input pad on the destination filter
532 * @return zero on success
534 int avfilter_link(AVFilterContext *src, unsigned srcpad,
535 AVFilterContext *dst, unsigned dstpad);
538 * Free the link in *link, and set its pointer to NULL.
540 void avfilter_link_free(AVFilterLink **link);
543 * Get the number of channels of a link.
545 int avfilter_link_get_channels(AVFilterLink *link);
548 * Set the closed field of a link.
550 void avfilter_link_set_closed(AVFilterLink *link, int closed);
553 * Negotiate the media format, dimensions, etc of all inputs to a filter.
555 * @param filter the filter to negotiate the properties for its inputs
556 * @return zero on successful negotiation
558 int avfilter_config_links(AVFilterContext *filter);
560 #define AVFILTER_CMD_FLAG_ONE 1 ///< Stop once a filter understood the command (for target=all for example), fast filters are favored automatically
561 #define AVFILTER_CMD_FLAG_FAST 2 ///< Only execute command when its fast (like a video out that supports contrast adjustment in hw)
564 * Make the filter instance process a command.
565 * It is recommended to use avfilter_graph_send_command().
567 int avfilter_process_command(AVFilterContext *filter, const char *cmd, const char *arg, char *res, int res_len, int flags);
569 /** Initialize the filter system. Register all builtin filters. */
570 void avfilter_register_all(void);
572 #if FF_API_OLD_FILTER_REGISTER
573 /** Uninitialize the filter system. Unregister all filters. */
575 void avfilter_uninit(void);
579 * Register a filter. This is only needed if you plan to use
580 * avfilter_get_by_name later to lookup the AVFilter structure by name. A
581 * filter can still by instantiated with avfilter_graph_alloc_filter even if it
584 * @param filter the filter to register
585 * @return 0 if the registration was successful, a negative value
588 int avfilter_register(AVFilter *filter);
591 * Get a filter definition matching the given name.
593 * @param name the filter name to find
594 * @return the filter definition, if any matching one is registered.
595 * NULL if none found.
597 #if !FF_API_NOCONST_GET_NAME
600 AVFilter *avfilter_get_by_name(const char *name);
603 * Iterate over all registered filters.
604 * @return If prev is non-NULL, next registered filter after prev or NULL if
605 * prev is the last filter. If prev is NULL, return the first registered filter.
607 const AVFilter *avfilter_next(const AVFilter *prev);
609 #if FF_API_OLD_FILTER_REGISTER
611 * If filter is NULL, returns a pointer to the first registered filter pointer,
612 * if filter is non-NULL, returns the next pointer after filter.
613 * If the returned pointer points to NULL, the last registered filter
614 * was already reached.
615 * @deprecated use avfilter_next()
618 AVFilter **av_filter_next(AVFilter **filter);
621 #if FF_API_AVFILTER_OPEN
623 * Create a filter instance.
625 * @param filter_ctx put here a pointer to the created filter context
626 * on success, NULL on failure
627 * @param filter the filter to create an instance of
628 * @param inst_name Name to give to the new instance. Can be NULL for none.
629 * @return >= 0 in case of success, a negative error code otherwise
630 * @deprecated use avfilter_graph_alloc_filter() instead
633 int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name);
637 #if FF_API_AVFILTER_INIT_FILTER
639 * Initialize a filter.
641 * @param filter the filter to initialize
642 * @param args A string of parameters to use when initializing the filter.
643 * The format and meaning of this string varies by filter.
644 * @param opaque Any extra non-string data needed by the filter. The meaning
645 * of this parameter varies by filter.
646 * @return zero on success
649 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
653 * Initialize a filter with the supplied parameters.
655 * @param ctx uninitialized filter context to initialize
656 * @param args Options to initialize the filter with. This must be a
657 * ':'-separated list of options in the 'key=value' form.
658 * May be NULL if the options have been set directly using the
659 * AVOptions API or there are no options that need to be set.
660 * @return 0 on success, a negative AVERROR on failure
662 int avfilter_init_str(AVFilterContext *ctx, const char *args);
665 * Initialize a filter with the supplied dictionary of options.
667 * @param ctx uninitialized filter context to initialize
668 * @param options An AVDictionary filled with options for this filter. On
669 * return this parameter will be destroyed and replaced with
670 * a dict containing options that were not found. This dictionary
671 * must be freed by the caller.
672 * May be NULL, then this function is equivalent to
673 * avfilter_init_str() with the second parameter set to NULL.
674 * @return 0 on success, a negative AVERROR on failure
676 * @note This function and avfilter_init_str() do essentially the same thing,
677 * the difference is in manner in which the options are passed. It is up to the
678 * calling code to choose whichever is more preferable. The two functions also
679 * behave differently when some of the provided options are not declared as
680 * supported by the filter. In such a case, avfilter_init_str() will fail, but
681 * this function will leave those extra options in the options AVDictionary and
684 int avfilter_init_dict(AVFilterContext *ctx, AVDictionary **options);
687 * Free a filter context. This will also remove the filter from its
688 * filtergraph's list of filters.
690 * @param filter the filter to free
692 void avfilter_free(AVFilterContext *filter);
695 * Insert a filter in the middle of an existing link.
697 * @param link the link into which the filter should be inserted
698 * @param filt the filter to be inserted
699 * @param filt_srcpad_idx the input pad on the filter to connect
700 * @param filt_dstpad_idx the output pad on the filter to connect
701 * @return zero on success
703 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
704 unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
707 * @return AVClass for AVFilterContext.
709 * @see av_opt_find().
711 const AVClass *avfilter_get_class(void);
713 typedef struct AVFilterGraphInternal AVFilterGraphInternal;
716 * A function pointer passed to the @ref AVFilterGraph.execute callback to be
717 * executed multiple times, possibly in parallel.
719 * @param ctx the filter context the job belongs to
720 * @param arg an opaque parameter passed through from @ref
721 * AVFilterGraph.execute
722 * @param jobnr the index of the job being executed
723 * @param nb_jobs the total number of jobs
725 * @return 0 on success, a negative AVERROR on error
727 typedef int (avfilter_action_func)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
730 * A function executing multiple jobs, possibly in parallel.
732 * @param ctx the filter context to which the jobs belong
733 * @param func the function to be called multiple times
734 * @param arg the argument to be passed to func
735 * @param ret a nb_jobs-sized array to be filled with return values from each
737 * @param nb_jobs the number of jobs to execute
739 * @return 0 on success, a negative AVERROR on error
741 typedef int (avfilter_execute_func)(AVFilterContext *ctx, avfilter_action_func *func,
742 void *arg, int *ret, int nb_jobs);
744 typedef struct AVFilterGraph {
745 const AVClass *av_class;
746 AVFilterContext **filters;
749 char *scale_sws_opts; ///< sws options to use for the auto-inserted scale filters
750 char *resample_lavr_opts; ///< libavresample options to use for the auto-inserted resample filters
753 * Type of multithreading allowed for filters in this graph. A combination
754 * of AVFILTER_THREAD_* flags.
756 * May be set by the caller at any point, the setting will apply to all
757 * filters initialized after that. The default is allowing everything.
759 * When a filter in this graph is initialized, this field is combined using
760 * bit AND with AVFilterContext.thread_type to get the final mask used for
761 * determining allowed threading types. I.e. a threading type needs to be
762 * set in both to be allowed.
767 * Maximum number of threads used by filters in this graph. May be set by
768 * the caller before adding any filters to the filtergraph. Zero (the
769 * default) means that the number of threads is determined automatically.
774 * Opaque object for libavfilter internal use.
776 AVFilterGraphInternal *internal;
779 * Opaque user data. May be set by the caller to an arbitrary value, e.g. to
780 * be used from callbacks like @ref AVFilterGraph.execute.
781 * Libavfilter will not touch this field in any way.
786 * This callback may be set by the caller immediately after allocating the
787 * graph and before adding any filters to it, to provide a custom
788 * multithreading implementation.
790 * If set, filters with slice threading capability will call this callback
791 * to execute multiple jobs in parallel.
793 * If this field is left unset, libavfilter will use its internal
794 * implementation, which may or may not be multithreaded depending on the
795 * platform and build options.
797 avfilter_execute_func *execute;
799 char *aresample_swr_opts; ///< swr options to use for the auto-inserted aresample filters, Access ONLY through AVOptions
804 * The following fields are for internal use only.
805 * Their type, offset, number and semantic can change without notice.
808 AVFilterLink **sink_links;
809 int sink_links_count;
811 unsigned disable_auto_convert;
815 * Allocate a filter graph.
817 * @return the allocated filter graph on success or NULL.
819 AVFilterGraph *avfilter_graph_alloc(void);
822 * Create a new filter instance in a filter graph.
824 * @param graph graph in which the new filter will be used
825 * @param filter the filter to create an instance of
826 * @param name Name to give to the new instance (will be copied to
827 * AVFilterContext.name). This may be used by the caller to identify
828 * different filters, libavfilter itself assigns no semantics to
829 * this parameter. May be NULL.
831 * @return the context of the newly created filter instance (note that it is
832 * also retrievable directly through AVFilterGraph.filters or with
833 * avfilter_graph_get_filter()) on success or NULL on failure.
835 AVFilterContext *avfilter_graph_alloc_filter(AVFilterGraph *graph,
836 const AVFilter *filter,
840 * Get a filter instance identified by instance name from graph.
842 * @param graph filter graph to search through.
843 * @param name filter instance name (should be unique in the graph).
844 * @return the pointer to the found filter instance or NULL if it
847 AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, const char *name);
849 #if FF_API_AVFILTER_OPEN
851 * Add an existing filter instance to a filter graph.
853 * @param graphctx the filter graph
854 * @param filter the filter to be added
856 * @deprecated use avfilter_graph_alloc_filter() to allocate a filter in a
860 int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter);
864 * Create and add a filter instance into an existing graph.
865 * The filter instance is created from the filter filt and inited
866 * with the parameters args and opaque.
868 * In case of success put in *filt_ctx the pointer to the created
869 * filter instance, otherwise set *filt_ctx to NULL.
871 * @param name the instance name to give to the created filter instance
872 * @param graph_ctx the filter graph
873 * @return a negative AVERROR error code in case of failure, a non
874 * negative value otherwise
876 int avfilter_graph_create_filter(AVFilterContext **filt_ctx, const AVFilter *filt,
877 const char *name, const char *args, void *opaque,
878 AVFilterGraph *graph_ctx);
881 * Enable or disable automatic format conversion inside the graph.
883 * Note that format conversion can still happen inside explicitly inserted
884 * scale and aresample filters.
886 * @param flags any of the AVFILTER_AUTO_CONVERT_* constants
888 void avfilter_graph_set_auto_convert(AVFilterGraph *graph, unsigned flags);
891 AVFILTER_AUTO_CONVERT_ALL = 0, /**< all automatic conversions enabled */
892 AVFILTER_AUTO_CONVERT_NONE = -1, /**< all automatic conversions disabled */
896 * Check validity and configure all the links and formats in the graph.
898 * @param graphctx the filter graph
899 * @param log_ctx context used for logging
900 * @return >= 0 in case of success, a negative AVERROR code otherwise
902 int avfilter_graph_config(AVFilterGraph *graphctx, void *log_ctx);
905 * Free a graph, destroy its links, and set *graph to NULL.
906 * If *graph is NULL, do nothing.
908 void avfilter_graph_free(AVFilterGraph **graph);
911 * A linked-list of the inputs/outputs of the filter chain.
913 * This is mainly useful for avfilter_graph_parse() / avfilter_graph_parse2(),
914 * where it is used to communicate open (unlinked) inputs and outputs from and
916 * This struct specifies, per each not connected pad contained in the graph, the
917 * filter context and the pad index required for establishing a link.
919 typedef struct AVFilterInOut {
920 /** unique name for this input/output in the list */
923 /** filter context associated to this input/output */
924 AVFilterContext *filter_ctx;
926 /** index of the filt_ctx pad to use for linking */
929 /** next input/input in the list, NULL if this is the last */
930 struct AVFilterInOut *next;
934 * Allocate a single AVFilterInOut entry.
935 * Must be freed with avfilter_inout_free().
936 * @return allocated AVFilterInOut on success, NULL on failure.
938 AVFilterInOut *avfilter_inout_alloc(void);
941 * Free the supplied list of AVFilterInOut and set *inout to NULL.
942 * If *inout is NULL, do nothing.
944 void avfilter_inout_free(AVFilterInOut **inout);
947 * Add a graph described by a string to a graph.
949 * @note The caller must provide the lists of inputs and outputs,
950 * which therefore must be known before calling the function.
952 * @note The inputs parameter describes inputs of the already existing
953 * part of the graph; i.e. from the point of view of the newly created
954 * part, they are outputs. Similarly the outputs parameter describes
955 * outputs of the already existing filters, which are provided as
956 * inputs to the parsed filters.
958 * @param graph the filter graph where to link the parsed graph context
959 * @param filters string to be parsed
960 * @param inputs linked list to the inputs of the graph
961 * @param outputs linked list to the outputs of the graph
962 * @return zero on success, a negative AVERROR code on error
964 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
965 AVFilterInOut *inputs, AVFilterInOut *outputs,
969 * Add a graph described by a string to a graph.
971 * In the graph filters description, if the input label of the first
972 * filter is not specified, "in" is assumed; if the output label of
973 * the last filter is not specified, "out" is assumed.
975 * @param graph the filter graph where to link the parsed graph context
976 * @param filters string to be parsed
977 * @param inputs pointer to a linked list to the inputs of the graph, may be NULL.
978 * If non-NULL, *inputs is updated to contain the list of open inputs
979 * after the parsing, should be freed with avfilter_inout_free().
980 * @param outputs pointer to a linked list to the outputs of the graph, may be NULL.
981 * If non-NULL, *outputs is updated to contain the list of open outputs
982 * after the parsing, should be freed with avfilter_inout_free().
983 * @return non negative on success, a negative AVERROR code on error
985 int avfilter_graph_parse_ptr(AVFilterGraph *graph, const char *filters,
986 AVFilterInOut **inputs, AVFilterInOut **outputs,
990 * Add a graph described by a string to a graph.
992 * @param[in] graph the filter graph where to link the parsed graph context
993 * @param[in] filters string to be parsed
994 * @param[out] inputs a linked list of all free (unlinked) inputs of the
995 * parsed graph will be returned here. It is to be freed
996 * by the caller using avfilter_inout_free().
997 * @param[out] outputs a linked list of all free (unlinked) outputs of the
998 * parsed graph will be returned here. It is to be freed by the
999 * caller using avfilter_inout_free().
1000 * @return zero on success, a negative AVERROR code on error
1002 * @note This function returns the inputs and outputs that are left
1003 * unlinked after parsing the graph and the caller then deals with
1005 * @note This function makes no reference whatsoever to already
1006 * existing parts of the graph and the inputs parameter will on return
1007 * contain inputs of the newly parsed part of the graph. Analogously
1008 * the outputs parameter will contain outputs of the newly created
1011 int avfilter_graph_parse2(AVFilterGraph *graph, const char *filters,
1012 AVFilterInOut **inputs,
1013 AVFilterInOut **outputs);
1016 * Send a command to one or more filter instances.
1018 * @param graph the filter graph
1019 * @param target the filter(s) to which the command should be sent
1020 * "all" sends to all filters
1021 * otherwise it can be a filter or filter instance name
1022 * which will send the command to all matching filters.
1023 * @param cmd the command to send, for handling simplicity all commands must be alphanumeric only
1024 * @param arg the argument for the command
1025 * @param res a buffer with size res_size where the filter(s) can return a response.
1027 * @returns >=0 on success otherwise an error code.
1028 * AVERROR(ENOSYS) on unsupported commands
1030 int avfilter_graph_send_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, char *res, int res_len, int flags);
1033 * Queue a command for one or more filter instances.
1035 * @param graph the filter graph
1036 * @param target the filter(s) to which the command should be sent
1037 * "all" sends to all filters
1038 * otherwise it can be a filter or filter instance name
1039 * which will send the command to all matching filters.
1040 * @param cmd the command to sent, for handling simplicity all commands must be alphanumeric only
1041 * @param arg the argument for the command
1042 * @param ts time at which the command should be sent to the filter
1044 * @note As this executes commands after this function returns, no return code
1045 * from the filter is provided, also AVFILTER_CMD_FLAG_ONE is not supported.
1047 int avfilter_graph_queue_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, int flags, double ts);
1051 * Dump a graph into a human-readable string representation.
1053 * @param graph the graph to dump
1054 * @param options formatting options; currently ignored
1055 * @return a string, or NULL in case of memory allocation failure;
1056 * the string must be freed using av_free
1058 char *avfilter_graph_dump(AVFilterGraph *graph, const char *options);
1061 * Request a frame on the oldest sink link.
1063 * If the request returns AVERROR_EOF, try the next.
1065 * Note that this function is not meant to be the sole scheduling mechanism
1066 * of a filtergraph, only a convenience function to help drain a filtergraph
1067 * in a balanced way under normal circumstances.
1069 * Also note that AVERROR_EOF does not mean that frames did not arrive on
1070 * some of the sinks during the process.
1071 * When there are multiple sink links, in case the requested link
1072 * returns an EOF, this may cause a filter to flush pending frames
1073 * which are sent to another sink link, although unrequested.
1075 * @return the return value of ff_request_frame(),
1076 * or AVERROR_EOF if all links returned AVERROR_EOF
1078 int avfilter_graph_request_oldest(AVFilterGraph *graph);
1084 #endif /* AVFILTER_AVFILTER_H */