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