libavfilter/avfilter.h
a5cbb2f4
 /*
664f6595
  * filter layer
3fa77bde
  * Copyright (c) 2007 Bobby Bingham
a5cbb2f4
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
98790382
 #ifndef AVFILTER_AVFILTER_H
 #define AVFILTER_AVFILTER_H
a5cbb2f4
 
18d93981
 /**
  * @file
  * @ingroup lavfi
bc8c1cdc
  * Main libavfilter public API header
18d93981
  */
 
 /**
bc8c1cdc
  * @defgroup lavfi Libavfilter - graph-based frame editing library
18d93981
  * @{
  */
 
8a354414
 #include <stddef.h>
 
bf4b0ed1
 #include "libavutil/attributes.h"
1f20782c
 #include "libavutil/avutil.h"
95d07f33
 #include "libavutil/dict.h"
7e350379
 #include "libavutil/frame.h"
abc78a5a
 #include "libavutil/log.h"
7ffe76e5
 #include "libavutil/samplefmt.h"
d49ea4af
 #include "libavutil/pixfmt.h"
e91709ca
 #include "libavutil/rational.h"
1f20782c
 
3167dc95
 #include "libavfilter/version.h"
 
540f1c7b
 /**
49bd8e4b
  * Return the LIBAVFILTER_VERSION_INT constant.
540f1c7b
  */
 unsigned avfilter_version(void);
 
c1736936
 /**
49bd8e4b
  * Return the libavfilter build-time configuration.
c1736936
  */
41600690
 const char *avfilter_configuration(void);
c1736936
 
 /**
49bd8e4b
  * Return the libavfilter license.
c1736936
  */
41600690
 const char *avfilter_license(void);
c1736936
 
a5cbb2f4
 typedef struct AVFilterContext AVFilterContext;
 typedef struct AVFilterLink    AVFilterLink;
 typedef struct AVFilterPad     AVFilterPad;
b74a1da4
 typedef struct AVFilterFormats AVFilterFormats;
a5cbb2f4
 
7e350379
 #if FF_API_AVFILTERBUFFER
a5cbb2f4
 /**
32d7bcd4
  * A reference-counted buffer data type used by the filter system. Filters
a5cbb2f4
  * should not store pointers to this structure directly, but instead use the
ecc8dada
  * AVFilterBufferRef structure below.
a5cbb2f4
  */
f607cc18
 typedef struct AVFilterBuffer {
56b5e9d5
     uint8_t *data[8];           ///< buffer data for each plane/channel
9453c9e1
 
     /**
      * pointers to the data planes/channels.
      *
      * For video, this should simply point to data[].
      *
      * For planar audio, each channel has a separate data pointer, and
      * linesize[0] contains the size of each channel buffer.
      * For packed audio, there is just one data pointer, and linesize[0]
      * contains the total size of the buffer for all channels.
      *
      * Note: Both data and extended_data will always be set, but for planar
      * audio with more channels that can fit in data, extended_data must be used
      * in order to access all channels.
      */
     uint8_t **extended_data;
cb81e291
     int linesize[8];            ///< number of bytes per line
 
     /** private data to be used by a custom free function */
     void *priv;
     /**
      * A pointer to the function to deallocate this buffer if the default
      * function is not sufficient. This could, for example, add the memory
      * back into a memory pool to be reused later without the overhead of
      * reallocating it from scratch.
      */
     void (*free)(struct AVFilterBuffer *buf);
 
     int format;                 ///< media format
     int w, h;                   ///< width and height of the allocated buffer
     unsigned refcount;          ///< number of references to this buffer
f0d77b20
 } AVFilterBuffer;
a5cbb2f4
 
ff5f1be0
 #define AV_PERM_READ     0x01   ///< can read from the buffer
 #define AV_PERM_WRITE    0x02   ///< can write to the buffer
 #define AV_PERM_PRESERVE 0x04   ///< nobody else can overwrite the buffer
 #define AV_PERM_REUSE    0x08   ///< can output the buffer multiple times, with the same contents each time
 #define AV_PERM_REUSE2   0x10   ///< can output the buffer multiple times, modified each time
0ccabeea
 #define AV_PERM_NEG_LINESIZES 0x20  ///< the buffer requested can have negative linesizes
4d34b6c1
 #define AV_PERM_ALIGN    0x40   ///< the buffer must be aligned
ff5f1be0
 
d18fd13f
 #define AVFILTER_ALIGN 16 //not part of ABI
 
a5cbb2f4
 /**
ad2c9501
  * Audio specific properties in a reference to an AVFilterBuffer. Since
  * AVFilterBufferRef is common to different media formats, audio specific
  * per reference properties must be separated out.
  */
 typedef struct AVFilterBufferRefAudioProps {
cc276c85
     uint64_t channel_layout;    ///< channel layout of audio buffer
95a02426
     int nb_samples;             ///< number of audio samples per channel
4381bddc
     int sample_rate;            ///< audio buffer sample rate
34de47aa
     int channels;               ///< number of channels (do not access directly)
ad2c9501
 } AVFilterBufferRefAudioProps;
 
 /**
cc80caff
  * Video specific properties in a reference to an AVFilterBuffer. Since
  * AVFilterBufferRef is common to different media formats, video specific
  * per reference properties must be separated out.
  */
f607cc18
 typedef struct AVFilterBufferRefVideoProps {
cc80caff
     int w;                      ///< image width
     int h;                      ///< image height
35fe66ab
     AVRational sample_aspect_ratio; ///< sample aspect ratio
cc80caff
     int interlaced;             ///< is frame interlaced
     int top_field_first;        ///< field order
bebe72f4
     enum AVPictureType pict_type; ///< picture type of the frame
09a1416d
     int key_frame;              ///< 1 -> keyframe, 0-> not
c9a0f9bf
     int qp_table_linesize;                ///< qp_table stride
91141f2a
     int qp_table_size;            ///< qp_table size
c9a0f9bf
     int8_t *qp_table;             ///< array of Quantization Parameters
cc80caff
 } AVFilterBufferRefVideoProps;
 
 /**
f0d77b20
  * A reference to an AVFilterBuffer. Since filters can manipulate the origin of
7fce481a
  * a buffer to, for example, crop image without any memcpy, the buffer origin
38efe768
  * and dimensions are per-reference properties. Linesize is also useful for
bbf42679
  * image flipping, frame to field filters, etc, and so is also per-reference.
a5cbb2f4
  *
1a18860a
  * TODO: add anything necessary for frame reordering
a5cbb2f4
  */
f607cc18
 typedef struct AVFilterBufferRef {
7fce481a
     AVFilterBuffer *buf;        ///< the buffer that this is a reference to
ad2c9501
     uint8_t *data[8];           ///< picture/audio data for each plane
9453c9e1
     /**
      * pointers to the data planes/channels.
      *
      * For video, this should simply point to data[].
      *
      * For planar audio, each channel has a separate data pointer, and
      * linesize[0] contains the size of each channel buffer.
      * For packed audio, there is just one data pointer, and linesize[0]
      * contains the total size of the buffer for all channels.
      *
      * Note: Both data and extended_data will always be set, but for planar
      * audio with more channels that can fit in data, extended_data must be used
      * in order to access all channels.
      */
     uint8_t **extended_data;
f14e6856
     int linesize[8];            ///< number of bytes per line
 
     AVFilterBufferRefVideoProps *video; ///< video buffer specific properties
     AVFilterBufferRefAudioProps *audio; ///< audio buffer specific properties
 
     /**
      * presentation timestamp. The time unit may change during
      * filtering, as it is specified in the link and the filter code
      * may need to rescale the PTS accordingly.
      */
     int64_t pts;
     int64_t pos;                ///< byte position in stream, -1 if unknown
 
     int format;                 ///< media format
 
     int perms;                  ///< permissions, see the AV_PERM_* flags
 
     enum AVMediaType type;      ///< media type of buffer data
6fb2fd89
 
     AVDictionary *metadata;     ///< dictionary containing metadata key=value tags
ecc8dada
 } AVFilterBufferRef;
a5cbb2f4
 
 /**
ad2c9501
  * Copy properties of src to dst, without copying the actual data
4d508e4d
  */
7e350379
 attribute_deprecated
f5d718ac
 void avfilter_copy_buffer_ref_props(AVFilterBufferRef *dst, const AVFilterBufferRef *src);
4d508e4d
 
 /**
7fce481a
  * Add a new reference to a buffer.
3fa3e4f4
  *
7fce481a
  * @param ref   an existing reference to the buffer
664f6595
  * @param pmask a bitmask containing the allowable permissions in the new
13ff8fd0
  *              reference
7fce481a
  * @return      a new reference to the buffer with the same properties as the
13ff8fd0
  *              old, excluding any permissions denied by pmask
a5cbb2f4
  */
7e350379
 attribute_deprecated
7fce481a
 AVFilterBufferRef *avfilter_ref_buffer(AVFilterBufferRef *ref, int pmask);
a5cbb2f4
 
 /**
7fce481a
  * Remove a reference to a buffer. If this is the last reference to the
  * buffer, the buffer itself is also automatically freed.
3fa3e4f4
  *
6baf4afa
  * @param ref reference to the buffer, may be NULL
b70d89a0
  *
  * @note it is recommended to use avfilter_unref_bufferp() instead of this
  * function
a5cbb2f4
  */
7e350379
 attribute_deprecated
7fce481a
 void avfilter_unref_buffer(AVFilterBufferRef *ref);
a5cbb2f4
 
13ff8fd0
 /**
65fa7bc1
  * Remove a reference to a buffer and set the pointer to NULL.
  * If this is the last reference to the buffer, the buffer itself
  * is also automatically freed.
  *
  * @param ref pointer to the buffer reference
  */
7e350379
 attribute_deprecated
65fa7bc1
 void avfilter_unref_bufferp(AVFilterBufferRef **ref);
7e350379
 #endif
65fa7bc1
 
34de47aa
 /**
  * Get the number of channels of a buffer reference.
  */
a05a44e2
 attribute_deprecated
34de47aa
 int avfilter_ref_get_channels(AVFilterBufferRef *ref);
 
9d0bfc50
 #if FF_API_AVFILTERPAD_PUBLIC
35f3fdf4
 /**
664f6595
  * A filter pad used for either input or output.
7a442233
  *
  * See doc/filter_design.txt for details on how to implement the methods.
c7b9eab2
  *
  * @warning this struct might be removed from public API.
9d0bfc50
  * users should call avfilter_pad_get_name() and avfilter_pad_get_type()
  * to access the name and type fields; there should be no need to access
  * any other fields from outside of libavfilter.
13ff8fd0
  */
f607cc18
 struct AVFilterPad {
a5cbb2f4
     /**
38efe768
      * Pad name. The name is unique among inputs and among outputs, but an
      * input may have the same name as an output. This may be NULL if this
13ff8fd0
      * pad has no need to ever be referenced by name.
a5cbb2f4
      */
2844dd39
     const char *name;
a5cbb2f4
 
     /**
0ce4a627
      * AVFilterPad type.
a5cbb2f4
      */
72415b2a
     enum AVMediaType type;
a5cbb2f4
 
     /**
271ddb11
      * Input pads:
38efe768
      * Minimum required permissions on incoming buffers. Any buffer with
60bf6ce3
      * insufficient permissions will be automatically copied by the filter
      * system to a new buffer which provides the needed access permissions.
      *
271ddb11
      * Output pads:
      * Guaranteed permissions on outgoing buffers. Any buffer pushed on the
      * link must have at least these permissions; this fact is checked by
      * asserts. It can be used to optimize buffer allocation.
60bf6ce3
      */
7e350379
     attribute_deprecated int min_perms;
60bf6ce3
 
     /**
271ddb11
      * Input pads:
38efe768
      * Permissions which are not accepted on incoming buffers. Any buffer
9ce95f27
      * which has any of these permissions set will be automatically copied
      * by the filter system to a new buffer which does not have those
38efe768
      * permissions. This can be used to easily disallow buffers with
9ce95f27
      * AV_PERM_REUSE.
60bf6ce3
      *
271ddb11
      * Output pads:
      * Permissions which are automatically removed on outgoing buffers. It
      * can be used to optimize buffer allocation.
60bf6ce3
      */
7e350379
     attribute_deprecated int rej_perms;
60bf6ce3
 
     /**
9178235f
      * @deprecated unused
a5cbb2f4
      */
ebc8d974
     int (*start_frame)(AVFilterLink *link, AVFilterBufferRef *picref);
a5cbb2f4
 
     /**
ad2c9501
      * Callback function to get a video buffer. If NULL, the filter system will
54a48d2f
      * use ff_default_get_video_buffer().
13ff8fd0
      *
      * Input video pads only.
a5cbb2f4
      */
7e350379
     AVFrame *(*get_video_buffer)(AVFilterLink *link, int w, int h);
a5cbb2f4
 
     /**
ad2c9501
      * Callback function to get an audio buffer. If NULL, the filter system will
54a48d2f
      * use ff_default_get_audio_buffer().
ad2c9501
      *
      * Input audio pads only.
      */
7e350379
     AVFrame *(*get_audio_buffer)(AVFilterLink *link, int nb_samples);
ad2c9501
 
     /**
9178235f
      * @deprecated unused
a5cbb2f4
      */
d4f89906
     int (*end_frame)(AVFilterLink *link);
a5cbb2f4
 
     /**
9178235f
      * @deprecated unused
a5cbb2f4
      */
e9b992d0
     int (*draw_slice)(AVFilterLink *link, int y, int height, int slice_dir);
a5cbb2f4
 
     /**
8227a0b7
      * Filtering callback. This is where a filter receives a frame with
      * audio/video data and should do its processing.
ad2c9501
      *
8227a0b7
      * Input pads only.
cd991462
      *
      * @return >= 0 on success, a negative AVERROR on error. This function
8227a0b7
      * must ensure that frame is properly unreferenced on error if it
cd991462
      * hasn't been passed on to another filter.
ad2c9501
      */
7e350379
     int (*filter_frame)(AVFilterLink *link, AVFrame *frame);
ad2c9501
 
     /**
38efe768
      * Frame poll callback. This returns the number of immediately available
177477f5
      * samples. It should return a positive value if the next request_frame()
d224d73a
      * is guaranteed to return one frame (with no delay).
      *
      * Defaults to just calling the source poll_frame() method.
      *
ce353a88
      * Output pads only.
d224d73a
      */
     int (*poll_frame)(AVFilterLink *link);
 
     /**
38efe768
      * Frame request callback. A call to this should result in at least one
      * frame being output over the given link. This should return zero on
13ff8fd0
      * success, and another value on error.
1c600888
      * See ff_request_frame() for the error codes with a specific
78ac49c2
      * meaning.
13ff8fd0
      *
ce353a88
      * Output pads only.
a5cbb2f4
      */
63f64e6f
     int (*request_frame)(AVFilterLink *link);
a5cbb2f4
 
     /**
13ff8fd0
      * Link configuration callback.
      *
3e12b589
      * For output pads, this should set the following link properties:
      * video: width, height, sample_aspect_ratio, time_base
      * audio: sample_rate.
      *
      * This should NOT set properties such as format, channel_layout, etc which
      * are negotiated between filters by the filter system using the
13ff8fd0
      * query_formats() callback before this function is called.
d3e57c15
      *
      * For input pads, this should check the properties of the link, and update
      * the filter's internal state as necessary.
13ff8fd0
      *
3e12b589
      * For both input and output pads, this should return zero on success,
13ff8fd0
      * and another value on error.
a5cbb2f4
      */
d3e57c15
     int (*config_props)(AVFilterLink *link);
58b049f2
 
     /**
      * The filter expects a fifo to be inserted on its input link,
      * typically because it has a delay.
      *
      * input pads only.
      */
     int needs_fifo;
7e350379
 
d44bd7fb
     /**
      * The filter expects writable frames from its input link,
      * duplicating data buffers if needed.
      *
      * input pads only.
      */
7e350379
     int needs_writable;
a5cbb2f4
 };
9d0bfc50
 #endif
a5cbb2f4
 
84b9fbe0
 /**
7e8fe4be
  * Get the number of elements in a NULL-terminated array of AVFilterPads (e.g.
  * AVFilter.inputs/outputs).
  */
 int avfilter_pad_count(const AVFilterPad *pads);
 
 /**
84b9fbe0
  * Get the name of an AVFilterPad.
  *
  * @param pads an array of AVFilterPads
  * @param pad_idx index of the pad in the array it; is the caller's
  *                responsibility to ensure the index is valid
  *
  * @return name of the pad_idx'th pad in pads
  */
4a37d4b3
 const char *avfilter_pad_get_name(const AVFilterPad *pads, int pad_idx);
84b9fbe0
 
 /**
  * Get the type of an AVFilterPad.
  *
  * @param pads an array of AVFilterPads
  * @param pad_idx index of the pad in the array; it is the caller's
  *                responsibility to ensure the index is valid
  *
  * @return type of the pad_idx'th pad in pads
  */
4a37d4b3
 enum AVMediaType avfilter_pad_get_type(const AVFilterPad *pads, int pad_idx);
a5cbb2f4
 
13ff8fd0
 /**
7cdd737b
  * The number of the filter inputs is not determined just by AVFilter.inputs.
  * The filter might add additional inputs during initialization depending on the
  * options supplied to it.
  */
 #define AVFILTER_FLAG_DYNAMIC_INPUTS        (1 << 0)
 /**
  * The number of the filter outputs is not determined just by AVFilter.outputs.
  * The filter might add additional outputs during initialization depending on
  * the options supplied to it.
  */
 #define AVFILTER_FLAG_DYNAMIC_OUTPUTS       (1 << 1)
fdd93eab
 /**
129bb238
  * The filter supports multithreading by splitting frames into multiple parts
  * and processing them concurrently.
  */
 #define AVFILTER_FLAG_SLICE_THREADS         (1 << 2)
8d4e969a
 /**
fdd93eab
  * Some filters support a generic "enable" expression option that can be used
  * to enable or disable a filter in the timeline. Filters supporting this
1776177b
  * option have this flag set. When the enable expression is false, the default
  * no-op filter_frame() function is called in place of the filter_frame()
  * callback defined on each input pad, thus the frame is passed unchanged to
  * the next filters.
  */
 #define AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC  (1 << 16)
 /**
  * Same as AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC, except that the filter will
  * have its filter_frame() callback(s) called as usual even when the enable
  * expression is false. The filter will disable filtering within the
  * filter_frame() callback(s) itself, for example executing code depending on
  * the AVFilterContext->is_disabled value.
  */
 #define AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL (1 << 17)
 /**
  * Handy mask to test whether the filter supports or no the timeline feature
  * (internally or generically).
fdd93eab
  */
1776177b
 #define AVFILTER_FLAG_SUPPORT_TIMELINE (AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL)
7cdd737b
 
 /**
38efe768
  * Filter definition. This defines the pads a filter contains, and all the
13ff8fd0
  * callback functions used to interact with the filter.
  */
f607cc18
 typedef struct AVFilter {
8b7dffc2
     /**
      * Filter name. Must be non-NULL and unique among filters.
      */
     const char *name;
a5cbb2f4
 
96180805
     /**
8b7dffc2
      * A description of the filter. May be NULL.
      *
      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
96180805
      */
     const char *description;
 
8b7dffc2
     /**
      * List of inputs, terminated by a zeroed element.
      *
      * NULL if there are no (static) inputs. Instances of filters with
      * AVFILTER_FLAG_DYNAMIC_INPUTS set may have more inputs than present in
      * this list.
      */
     const AVFilterPad *inputs;
     /**
      * List of outputs, terminated by a zeroed element.
      *
      * NULL if there are no (static) outputs. Instances of filters with
      * AVFILTER_FLAG_DYNAMIC_OUTPUTS set may have more outputs than present in
      * this list.
      */
     const AVFilterPad *outputs;
96180805
 
b439c992
     /**
8b7dffc2
      * A class for the private data, used to declare filter private AVOptions.
      * This field is NULL for filters that do not declare any options.
      *
      * If this field is non-NULL, the first member of the filter private data
      * must be a pointer to AVClass, which will be set by libavfilter generic
      * code to this class.
b439c992
      */
     const AVClass *priv_class;
 
7cdd737b
     /**
      * A combination of AVFILTER_FLAG_*
      */
     int flags;
 
96180805
     /*****************************************************************
      * All fields below this line are not part of the public API. They
      * may not be used outside of libavfilter and can be changed and
      * removed at will.
      * New public fields should be added right above.
      *****************************************************************
      */
a5cbb2f4
 
4d96a914
     /**
8b7dffc2
      * Filter initialization function.
      *
      * This callback will be called only once during the filter lifetime, after
      * all the options have been set, but before links between filters are
      * established and format negotiation is done.
      *
      * Basic filter initialization should be done here. Filters with dynamic
      * inputs and/or outputs should create those inputs/outputs here based on
      * provided options. No more changes to this filter's inputs/outputs can be
      * done after this callback.
      *
      * This callback must not assume that the filter links exist or frame
      * parameters are known.
      *
      * @ref AVFilter.uninit "uninit" is guaranteed to be called even if
      * initialization fails, so this callback does not have to clean up on
      * failure.
      *
      * @return 0 on success, a negative AVERROR on failure
4d96a914
      */
d69a4177
     int (*init)(AVFilterContext *ctx);
13ff8fd0
 
     /**
8b7dffc2
      * Should be set instead of @ref AVFilter.init "init" by the filters that
      * want to pass a dictionary of AVOptions to nested contexts that are
      * allocated during init.
      *
      * On return, the options dict should be freed and replaced with one that
      * contains all the options which could not be processed by this filter (or
      * with NULL if all the options were processed).
      *
      * Otherwise the semantics is the same as for @ref AVFilter.init "init".
4fa1f52e
      */
     int (*init_dict)(AVFilterContext *ctx, AVDictionary **options);
 
     /**
8b7dffc2
      * Filter uninitialization function.
      *
      * Called only once right before the filter is freed. Should deallocate any
      * memory held by the filter, release any buffer references, etc. It does
      * not need to deallocate the AVFilterContext.priv memory itself.
      *
      * This callback may be called even if @ref AVFilter.init "init" was not
      * called or failed, so it must be prepared to handle such a situation.
13ff8fd0
      */
a5cbb2f4
     void (*uninit)(AVFilterContext *ctx);
 
35f3fdf4
     /**
8b7dffc2
      * Query formats supported by the filter on its inputs and outputs.
      *
      * This callback is called after the filter is initialized (so the inputs
      * and outputs are fixed), shortly before the format negotiation. This
      * callback may be called more than once.
      *
      * This callback must set AVFilterLink.out_formats on every input link and
      * AVFilterLink.in_formats on every output link to a list of pixel/sample
      * formats that the filter supports on that link. For audio links, this
      * filter must also set @ref AVFilterLink.in_samplerates "in_samplerates" /
      * @ref AVFilterLink.out_samplerates "out_samplerates" and
      * @ref AVFilterLink.in_channel_layouts "in_channel_layouts" /
      * @ref AVFilterLink.out_channel_layouts "out_channel_layouts" analogously.
      *
      * This callback may be NULL for filters with one input, in which case
      * libavfilter assumes that it supports all input formats and preserves
      * them on output.
35f3fdf4
      *
fe592585
      * @return zero on success, a negative value corresponding to an
      * AVERROR code otherwise
35f3fdf4
      */
     int (*query_formats)(AVFilterContext *);
 
96180805
     int priv_size;      ///< size of private data to allocate for the filter
1e5014c7
 
8b7dffc2
     /**
      * Used by the filter registration system. Must not be touched by any other
      * code.
      */
fa2a34cd
     struct AVFilter *next;
835cc0f2
 
1e5014c7
     /**
      * Make the filter instance process a command.
      *
      * @param cmd    the command to process, for handling simplicity all commands must be alphanumeric only
      * @param arg    the argument for the command
      * @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.
      * @param flags  if AVFILTER_CMD_FLAG_FAST is set and the command would be
16b809ce
      *               time consuming then a filter should treat it like an unsupported command
1e5014c7
      *
      * @returns >=0 on success otherwise an error code.
      *          AVERROR(ENOSYS) on unsupported commands
      */
     int (*process_command)(AVFilterContext *, const char *cmd, const char *arg, char *res, int res_len, int flags);
21d56098
 
     /**
      * Filter initialization function, alternative to the init()
      * callback. Args contains the user-supplied parameters, opaque is
      * used for providing binary data.
      */
fd6228e6
     int (*init_opaque)(AVFilterContext *ctx, void *opaque);
a5cbb2f4
 } AVFilter;
 
129bb238
 /**
  * Process multiple parts of the frame concurrently.
  */
 #define AVFILTER_THREAD_SLICE (1 << 0)
 
 typedef struct AVFilterInternal AVFilterInternal;
 
13ff8fd0
 /** An instance of a filter */
f607cc18
 struct AVFilterContext {
fdd93eab
     const AVClass *av_class;        ///< needed for av_log() and filters common options
a5cbb2f4
 
91d2efa7
     const AVFilter *filter;         ///< the AVFilter of which this is an instance
a5cbb2f4
 
13ff8fd0
     char *name;                     ///< name of this filter instance
dcea2482
 
f892013a
     AVFilterPad   *input_pads;      ///< array of input pads
     AVFilterLink **inputs;          ///< array of pointers to input links
9baeff95
 #if FF_API_FOO_COUNT
bf4b0ed1
     attribute_deprecated unsigned input_count; ///< @deprecated use nb_inputs
9baeff95
 #endif
f892013a
     unsigned    nb_inputs;          ///< number of input pads
25f8e601
 
f892013a
     AVFilterPad   *output_pads;     ///< array of output pads
     AVFilterLink **outputs;         ///< array of pointers to output links
9baeff95
 #if FF_API_FOO_COUNT
bf4b0ed1
     attribute_deprecated unsigned output_count; ///< @deprecated use nb_outputs
9baeff95
 #endif
f892013a
     unsigned    nb_outputs;         ///< number of output pads
a5cbb2f4
 
13ff8fd0
     void *priv;                     ///< private data for use by the filter
3d8176d2
 
11136726
     struct AVFilterGraph *graph;    ///< filtergraph this filter belongs to
4fde7053
 
129bb238
     /**
      * Type of multithreading being allowed/used. A combination of
      * AVFILTER_THREAD_* flags.
      *
      * May be set by the caller before initializing the filter to forbid some
      * or all kinds of multithreading for this filter. The default is allowing
      * everything.
      *
      * When the filter is initialized, this field is combined using bit AND with
      * AVFilterGraph.thread_type to get the final mask used for determining
      * allowed threading types. I.e. a threading type needs to be set in both
      * to be allowed.
      *
b2682db3
      * After the filter is initialized, libavfilter sets this field to the
129bb238
      * threading type that is actually used (0 for no multithreading).
      */
     int thread_type;
 
     /**
      * An opaque struct for libavfilter internal use.
      */
     AVFilterInternal *internal;
8d4e969a
 
3d8176d2
     struct AVFilterCommand *command_queue;
fdd93eab
 
     char *enable_str;               ///< enable expression string
     void *enable;                   ///< parsed expression (AVExpr*)
     double *var_values;             ///< variable values for the enable expression
df9f9cab
     int is_disabled;                ///< the enabled state from the last expression evaluation
a5cbb2f4
 };
 
13ff8fd0
 /**
38efe768
  * A link between two filters. This contains pointers to the source and
f4433de9
  * destination filters between which this link exists, and the indexes of
38efe768
  * the pads involved. In addition, this link also contains the parameters
13ff8fd0
  * which have been negotiated and agreed upon between the filter, such as
2b187df9
  * image dimensions, format, etc.
13ff8fd0
  */
f607cc18
 struct AVFilterLink {
13ff8fd0
     AVFilterContext *src;       ///< source filter
acc0490f
     AVFilterPad *srcpad;        ///< output pad on the source filter
a5cbb2f4
 
13ff8fd0
     AVFilterContext *dst;       ///< dest filter
acc0490f
     AVFilterPad *dstpad;        ///< input pad on the dest filter
a5cbb2f4
 
bdab614b
     enum AVMediaType type;      ///< filter media type
 
14b171cd
     /* These parameters apply only to video */
13ff8fd0
     int w;                      ///< agreed upon image width
     int h;                      ///< agreed upon image height
14b171cd
     AVRational sample_aspect_ratio; ///< agreed upon sample aspect ratio
b57df29f
     /* These parameters apply only to audio */
a903f8f0
     uint64_t channel_layout;    ///< channel layout of current buffer (see libavutil/channel_layout.h)
4381bddc
     int sample_rate;            ///< samples per second
ad2c9501
 
bdab614b
     int format;                 ///< agreed upon media format
a5cbb2f4
 
60bf6ce3
     /**
867ae7aa
      * Define the time base used by the PTS of the frames/samples
      * which will pass through this link.
      * During the configuration stage, each filter is supposed to
      * change only the output timebase, while the timebase of the
      * input link is assumed to be an unchangeable property.
      */
     AVRational time_base;
39f66edb
 
9567f410
     /*****************************************************************
      * All fields below this line are not part of the public API. They
      * may not be used outside of libavfilter and can be changed and
      * removed at will.
      * New public fields should be added right above.
      *****************************************************************
      */
     /**
b536e2fa
      * Lists of formats and channel layouts supported by the input and output
      * filters respectively. These lists are used for negotiating the format
      * to actually be used, which will be loaded into the format and
      * channel_layout members, above, when chosen.
      *
83ba2239
      */
     AVFilterFormats *in_formats;
     AVFilterFormats *out_formats;
 
     /**
9567f410
      * Lists of channel layouts and sample rates used for automatic
      * negotiation.
      */
     AVFilterFormats  *in_samplerates;
     AVFilterFormats *out_samplerates;
     struct AVFilterChannelLayouts  *in_channel_layouts;
     struct AVFilterChannelLayouts *out_channel_layouts;
 
f75be985
     /**
      * Audio only, the destination filter sets this to a non-zero value to
      * request that buffers with the given number of samples should be sent to
      * it. AVFilterPad.needs_fifo must also be set on the corresponding input
      * pad.
      * Last buffer before EOF will be padded with silence.
      */
     int request_samples;
1c600888
 
83ba2239
     /** stage of the initialization of the link properties (dimensions, etc) */
     enum {
         AVLINK_UNINIT = 0,      ///< not started
         AVLINK_STARTINIT,       ///< started, but incomplete
         AVLINK_INIT             ///< complete
     } init_state;
 
39f66edb
     struct AVFilterPool *pool;
e0761fee
 
     /**
      * Graph the filter belongs to.
      */
     struct AVFilterGraph *graph;
 
2ce79727
     /**
      * Current timestamp of the link, as defined by the most recent
      * frame(s), in AV_TIME_BASE units.
      */
     int64_t current_pts;
 
     /**
      * Index in the age array.
      */
     int age_index;
1cbf7fb4
 
7b42036b
     /**
      * Frame rate of the stream on the link, or 1/0 if unknown;
      * if left to 0/0, will be automatically be copied from the first input
      * of the source filter if it exists.
      *
      * Sources should set it to the best estimation of the real frame rate.
      * Filters should update it if necessary depending on their function.
      * Sinks can use it to set a default output frame rate.
dfd8f2ff
      * It is similar to the r_frame_rate field in AVStream.
7b42036b
      */
     AVRational frame_rate;
0689d5e1
 
     /**
      * Buffer partially filled with samples to achieve a fixed/minimum size.
      */
a05a44e2
     AVFrame *partial_buf;
0689d5e1
 
     /**
      * Size of the partial buffer to allocate.
      * Must be between min_samples and max_samples.
      */
     int partial_buf_size;
 
     /**
cd7febd3
      * Minimum number of samples to filter at once. If filter_frame() is
0689d5e1
      * called with fewer samples, it will accumulate them in partial_buf.
      * This field and the related ones must not be changed after filtering
      * has started.
      * If 0, all related fields are ignored.
      */
     int min_samples;
 
     /**
cd7febd3
      * Maximum number of samples to filter at once. If filter_frame() is
0689d5e1
      * called with more samples, it will split them.
      */
     int max_samples;
8ef740ce
 
     /**
      * The buffer reference currently being received across the link by the
      * destination filter. This is used internally by the filter system to
      * allow automatic copying of buffers which do not have sufficient
      * permissions for the destination. This should not be accessed directly
      * by the filters.
      */
     AVFilterBufferRef *cur_buf_copy;
beeba916
 
     /**
      * True if the link is closed.
b2682db3
      * If set, all attempts of start_frame, filter_frame or request_frame
beeba916
      * will fail with AVERROR_EOF, and if necessary the reference will be
      * destroyed.
      * If request_frame returns AVERROR_EOF, this flag is set on the
      * corresponding link.
      * It can be set also be set by either the source or the destination
      * filter.
      */
     int closed;
238edd2f
 
     /**
      * Number of channels.
      */
     int channels;
79d8cfac
 
     /**
      * True if a frame is being requested on the link.
      * Used internally by the framework.
      */
     unsigned frame_requested;
 
     /**
      * Link processing flags.
      */
     unsigned flags;
b8a5c761
 
     /**
      * Number of past frames sent through the link.
      */
     int64_t frame_count;
a5cbb2f4
 };
 
13ff8fd0
 /**
49bd8e4b
  * Link two filters together.
3fa3e4f4
  *
664f6595
  * @param src    the source filter
  * @param srcpad index of the output pad on the source filter
  * @param dst    the destination filter
  * @param dstpad index of the input pad on the destination filter
  * @return       zero on success
13ff8fd0
  */
a5cbb2f4
 int avfilter_link(AVFilterContext *src, unsigned srcpad,
                   AVFilterContext *dst, unsigned dstpad);
 
13ff8fd0
 /**
e977ca26
  * Free the link in *link, and set its pointer to NULL.
  */
 void avfilter_link_free(AVFilterLink **link);
 
 /**
238edd2f
  * Get the number of channels of a link.
  */
 int avfilter_link_get_channels(AVFilterLink *link);
 
 /**
beeba916
  * Set the closed field of a link.
  */
 void avfilter_link_set_closed(AVFilterLink *link, int closed);
 
 /**
bdab614b
  * Negotiate the media format, dimensions, etc of all inputs to a filter.
3fa3e4f4
  *
664f6595
  * @param filter the filter to negotiate the properties for its inputs
  * @return       zero on successful negotiation
13ff8fd0
  */
24c4eff6
 int avfilter_config_links(AVFilterContext *filter);
85322466
 
7e350379
 #if FF_API_AVFILTERBUFFER
13ff8fd0
 /**
d38c340f
  * Create a buffer reference wrapped around an already allocated image
  * buffer.
  *
  * @param data pointers to the planes of the image to reference
  * @param linesize linesizes for the planes of the image to reference
  * @param perms the required access permissions
  * @param w the width of the image specified by the data and linesize arrays
  * @param h the height of the image specified by the data and linesize arrays
  * @param format the pixel format of the image specified by the data and linesize arrays
  */
7e350379
 attribute_deprecated
d38c340f
 AVFilterBufferRef *
612d0782
 avfilter_get_video_buffer_ref_from_arrays(uint8_t * const data[4], const int linesize[4], int perms,
716d413c
                                           int w, int h, enum AVPixelFormat format);
d38c340f
 
 /**
c3819600
  * Create an audio buffer reference wrapped around an already
  * allocated samples buffer.
  *
2eb2e179
  * See avfilter_get_audio_buffer_ref_from_arrays_channels() for a version
  * that can handle unknown channel layouts.
  *
c3819600
  * @param data           pointers to the samples plane buffers
  * @param linesize       linesize for the samples plane buffers
  * @param perms          the required access permissions
  * @param nb_samples     number of samples per channel
  * @param sample_fmt     the format of each sample in the buffer to allocate
  * @param channel_layout the channel layout of the buffer
  */
7e350379
 attribute_deprecated
47aae2bc
 AVFilterBufferRef *avfilter_get_audio_buffer_ref_from_arrays(uint8_t **data,
1b8c9271
                                                              int linesize,
                                                              int perms,
                                                              int nb_samples,
                                                              enum AVSampleFormat sample_fmt,
                                                              uint64_t channel_layout);
2eb2e179
 /**
  * Create an audio buffer reference wrapped around an already
  * allocated samples buffer.
  *
  * @param data           pointers to the samples plane buffers
  * @param linesize       linesize for the samples plane buffers
  * @param perms          the required access permissions
  * @param nb_samples     number of samples per channel
  * @param sample_fmt     the format of each sample in the buffer to allocate
  * @param channels       the number of channels of the buffer
  * @param channel_layout the channel layout of the buffer,
  *                       must be either 0 or consistent with channels
  */
a05a44e2
 attribute_deprecated
2eb2e179
 AVFilterBufferRef *avfilter_get_audio_buffer_ref_from_arrays_channels(uint8_t **data,
                                                                       int linesize,
                                                                       int perms,
                                                                       int nb_samples,
                                                                       enum AVSampleFormat sample_fmt,
                                                                       int channels,
                                                                       uint64_t channel_layout);
 
7e350379
 #endif
1b8c9271
 
a5cbb2f4
 
1e5014c7
 #define AVFILTER_CMD_FLAG_ONE   1 ///< Stop once a filter understood the command (for target=all for example), fast filters are favored automatically
 #define AVFILTER_CMD_FLAG_FAST  2 ///< Only execute command when its fast (like a video out that supports contrast adjustment in hw)
 
 /**
  * Make the filter instance process a command.
16b809ce
  * It is recommended to use avfilter_graph_send_command().
1e5014c7
  */
 int avfilter_process_command(AVFilterContext *filter, const char *cmd, const char *arg, char *res, int res_len, int flags);
 
49bd8e4b
 /** Initialize the filter system. Register all builtin filters. */
11de6cac
 void avfilter_register_all(void);
e4152452
 
fa2a34cd
 #if FF_API_OLD_FILTER_REGISTER
49bd8e4b
 /** Uninitialize the filter system. Unregister all filters. */
fa2a34cd
 attribute_deprecated
a5cbb2f4
 void avfilter_uninit(void);
fa2a34cd
 #endif
13ff8fd0
 
 /**
49bd8e4b
  * Register a filter. This is only needed if you plan to use
fc815c56
  * avfilter_get_by_name later to lookup the AVFilter structure by name. A
bc1a985b
  * filter can still by instantiated with avfilter_graph_alloc_filter even if it
  * is not registered.
3fa3e4f4
  *
664f6595
  * @param filter the filter to register
16b809ce
  * @return 0 if the registration was successful, a negative value
86a60fa1
  * otherwise
13ff8fd0
  */
86a60fa1
 int avfilter_register(AVFilter *filter);
13ff8fd0
 
 /**
49bd8e4b
  * Get a filter definition matching the given name.
3fa3e4f4
  *
664f6595
  * @param name the filter name to find
  * @return     the filter definition, if any matching one is registered.
13ff8fd0
  *             NULL if none found.
  */
5c439b41
 #if !FF_API_NOCONST_GET_NAME
 const
 #endif
2844dd39
 AVFilter *avfilter_get_by_name(const char *name);
a5cbb2f4
 
13ff8fd0
 /**
fa2a34cd
  * Iterate over all registered filters.
  * @return If prev is non-NULL, next registered filter after prev or NULL if
  * prev is the last filter. If prev is NULL, return the first registered filter.
  */
 const AVFilter *avfilter_next(const AVFilter *prev);
 
 #if FF_API_OLD_FILTER_REGISTER
 /**
1433c4ab
  * If filter is NULL, returns a pointer to the first registered filter pointer,
  * if filter is non-NULL, returns the next pointer after filter.
  * If the returned pointer points to NULL, the last registered filter
  * was already reached.
fa2a34cd
  * @deprecated use avfilter_next()
1433c4ab
  */
fa2a34cd
 attribute_deprecated
1433c4ab
 AVFilter **av_filter_next(AVFilter **filter);
fa2a34cd
 #endif
1433c4ab
 
bc1a985b
 #if FF_API_AVFILTER_OPEN
1433c4ab
 /**
49bd8e4b
  * Create a filter instance.
84c03869
  *
  * @param filter_ctx put here a pointer to the created filter context
  * on success, NULL on failure
664f6595
  * @param filter    the filter to create an instance of
38efe768
  * @param inst_name Name to give to the new instance. Can be NULL for none.
84c03869
  * @return >= 0 in case of success, a negative error code otherwise
bc1a985b
  * @deprecated use avfilter_graph_alloc_filter() instead
13ff8fd0
  */
bc1a985b
 attribute_deprecated
84c03869
 int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name);
bc1a985b
 #endif
13ff8fd0
 
48a5adab
 
 #if FF_API_AVFILTER_INIT_FILTER
13ff8fd0
 /**
49bd8e4b
  * Initialize a filter.
3fa3e4f4
  *
664f6595
  * @param filter the filter to initialize
13ff8fd0
  * @param args   A string of parameters to use when initializing the filter.
  *               The format and meaning of this string varies by filter.
38efe768
  * @param opaque Any extra non-string data needed by the filter. The meaning
13ff8fd0
  *               of this parameter varies by filter.
664f6595
  * @return       zero on success
13ff8fd0
  */
48a5adab
 attribute_deprecated
6e365c57
 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
48a5adab
 #endif
 
 /**
  * Initialize a filter with the supplied parameters.
  *
  * @param ctx  uninitialized filter context to initialize
  * @param args Options to initialize the filter with. This must be a
  *             ':'-separated list of options in the 'key=value' form.
  *             May be NULL if the options have been set directly using the
  *             AVOptions API or there are no options that need to be set.
  * @return 0 on success, a negative AVERROR on failure
  */
 int avfilter_init_str(AVFilterContext *ctx, const char *args);
13ff8fd0
 
 /**
1ba95a9c
  * Initialize a filter with the supplied dictionary of options.
  *
  * @param ctx     uninitialized filter context to initialize
  * @param options An AVDictionary filled with options for this filter. On
  *                return this parameter will be destroyed and replaced with
  *                a dict containing options that were not found. This dictionary
  *                must be freed by the caller.
  *                May be NULL, then this function is equivalent to
  *                avfilter_init_str() with the second parameter set to NULL.
  * @return 0 on success, a negative AVERROR on failure
  *
  * @note This function and avfilter_init_str() do essentially the same thing,
  * the difference is in manner in which the options are passed. It is up to the
  * calling code to choose whichever is more preferable. The two functions also
  * behave differently when some of the provided options are not declared as
  * supported by the filter. In such a case, avfilter_init_str() will fail, but
  * this function will leave those extra options in the options AVDictionary and
  * continue as usual.
  */
 int avfilter_init_dict(AVFilterContext *ctx, AVDictionary **options);
 
 /**
1565cbc6
  * Free a filter context. This will also remove the filter from its
  * filtergraph's list of filters.
3fa3e4f4
  *
24de0edb
  * @param filter the filter to free
13ff8fd0
  */
24de0edb
 void avfilter_free(AVFilterContext *filter);
a5cbb2f4
 
13ff8fd0
 /**
49bd8e4b
  * Insert a filter in the middle of an existing link.
3fa3e4f4
  *
664f6595
  * @param link the link into which the filter should be inserted
  * @param filt the filter to be inserted
486adc55
  * @param filt_srcpad_idx the input pad on the filter to connect
  * @param filt_dstpad_idx the output pad on the filter to connect
664f6595
  * @return     zero on success
13ff8fd0
  */
35f3fdf4
 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
486adc55
                            unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
d3e57c15
 
7e350379
 #if FF_API_AVFILTERBUFFER
1c9e340d
 /**
  * Copy the frame properties of src to dst, without copying the actual
  * image data.
  *
  * @return 0 on success, a negative number on error.
  */
7e350379
 attribute_deprecated
1c9e340d
 int avfilter_copy_frame_props(AVFilterBufferRef *dst, const AVFrame *src);
 
ab165047
 /**
  * Copy the frame properties and data pointers of src to dst, without copying
  * the actual data.
  *
  * @return 0 on success, a negative number on error.
  */
7e350379
 attribute_deprecated
ab165047
 int avfilter_copy_buf_props(AVFrame *dst, const AVFilterBufferRef *src);
7e350379
 #endif
ab165047
 
18d93981
 /**
8114c101
  * @return AVClass for AVFilterContext.
  *
  * @see av_opt_find().
18d93981
  */
8114c101
 const AVClass *avfilter_get_class(void);
18d93981
 
129bb238
 typedef struct AVFilterGraphInternal AVFilterGraphInternal;
 
0767bfd1
 /**
  * A function pointer passed to the @ref AVFilterGraph.execute callback to be
  * executed multiple times, possibly in parallel.
  *
  * @param ctx the filter context the job belongs to
  * @param arg an opaque parameter passed through from @ref
  *            AVFilterGraph.execute
  * @param jobnr the index of the job being executed
  * @param nb_jobs the total number of jobs
  *
  * @return 0 on success, a negative AVERROR on error
  */
 typedef int (avfilter_action_func)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
 
 /**
  * A function executing multiple jobs, possibly in parallel.
  *
  * @param ctx the filter context to which the jobs belong
  * @param func the function to be called multiple times
  * @param arg the argument to be passed to func
  * @param ret a nb_jobs-sized array to be filled with return values from each
  *            invocation of func
  * @param nb_jobs the number of jobs to execute
  *
  * @return 0 on success, a negative AVERROR on error
  */
 typedef int (avfilter_execute_func)(AVFilterContext *ctx, avfilter_action_func *func,
                                     void *arg, int *ret, int nb_jobs);
 
38f0c078
 typedef struct AVFilterGraph {
     const AVClass *av_class;
 #if FF_API_FOO_COUNT
     attribute_deprecated
231fd441
     unsigned filter_count_unused;
38f0c078
 #endif
     AVFilterContext **filters;
 #if !FF_API_FOO_COUNT
     unsigned nb_filters;
 #endif
 
     char *scale_sws_opts; ///< sws options to use for the auto-inserted scale filters
     char *resample_lavr_opts;   ///< libavresample options to use for the auto-inserted resample filters
 #if FF_API_FOO_COUNT
     unsigned nb_filters;
 #endif
129bb238
 
     /**
      * Type of multithreading allowed for filters in this graph. A combination
      * of AVFILTER_THREAD_* flags.
      *
      * May be set by the caller at any point, the setting will apply to all
      * filters initialized after that. The default is allowing everything.
      *
      * When a filter in this graph is initialized, this field is combined using
      * bit AND with AVFilterContext.thread_type to get the final mask used for
      * determining allowed threading types. I.e. a threading type needs to be
      * set in both to be allowed.
      */
     int thread_type;
 
     /**
      * Maximum number of threads used by filters in this graph. May be set by
      * the caller before adding any filters to the filtergraph. Zero (the
      * default) means that the number of threads is determined automatically.
      */
     int nb_threads;
 
     /**
      * Opaque object for libavfilter internal use.
      */
     AVFilterGraphInternal *internal;
8d4e969a
 
0767bfd1
     /**
      * Opaque user data. May be set by the caller to an arbitrary value, e.g. to
      * be used from callbacks like @ref AVFilterGraph.execute.
      * Libavfilter will not touch this field in any way.
      */
     void *opaque;
 
     /**
      * This callback may be set by the caller immediately after allocating the
      * graph and before adding any filters to it, to provide a custom
      * multithreading implementation.
      *
      * If set, filters with slice threading capability will call this callback
      * to execute multiple jobs in parallel.
      *
      * If this field is left unset, libavfilter will use its internal
      * implementation, which may or may not be multithreaded depending on the
      * platform and build options.
      */
     avfilter_execute_func *execute;
7381d31f
 
231fd441
     char *aresample_swr_opts; ///< swr options to use for the auto-inserted aresample filters, Access ONLY through AVOptions
 
     /**
      * Private fields
      *
      * The following fields are for internal use only.
      * Their type, offset, number and semantic can change without notice.
      */
 
     AVFilterLink **sink_links;
     int sink_links_count;
 
     unsigned disable_auto_convert;
38f0c078
 } AVFilterGraph;
 
 /**
  * Allocate a filter graph.
  */
 AVFilterGraph *avfilter_graph_alloc(void);
 
 /**
bc1a985b
  * Create a new filter instance in a filter graph.
  *
  * @param graph graph in which the new filter will be used
  * @param filter the filter to create an instance of
  * @param name Name to give to the new instance (will be copied to
  *             AVFilterContext.name). This may be used by the caller to identify
  *             different filters, libavfilter itself assigns no semantics to
  *             this parameter. May be NULL.
  *
  * @return the context of the newly created filter instance (note that it is
  *         also retrievable directly through AVFilterGraph.filters or with
b2682db3
  *         avfilter_graph_get_filter()) on success or NULL on failure.
bc1a985b
  */
 AVFilterContext *avfilter_graph_alloc_filter(AVFilterGraph *graph,
                                              const AVFilter *filter,
                                              const char *name);
 
 /**
b217dc91
  * Get a filter instance identified by instance name from graph.
38f0c078
  *
b217dc91
  * @param graph filter graph to search through.
  * @param name filter instance name (should be unique in the graph).
38f0c078
  * @return the pointer to the found filter instance or NULL if it
  * cannot be found.
  */
fbe9ae48
 AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, const char *name);
38f0c078
 
c2c9801b
 #if FF_API_AVFILTER_OPEN
38f0c078
 /**
  * Add an existing filter instance to a filter graph.
  *
  * @param graphctx  the filter graph
  * @param filter the filter to be added
c2c9801b
  *
  * @deprecated use avfilter_graph_alloc_filter() to allocate a filter in a
  * filter graph
38f0c078
  */
c2c9801b
 attribute_deprecated
38f0c078
 int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter);
c2c9801b
 #endif
38f0c078
 
 /**
  * Create and add a filter instance into an existing graph.
  * The filter instance is created from the filter filt and inited
  * with the parameters args and opaque.
  *
  * In case of success put in *filt_ctx the pointer to the created
  * filter instance, otherwise set *filt_ctx to NULL.
  *
  * @param name the instance name to give to the created filter instance
  * @param graph_ctx the filter graph
  * @return a negative AVERROR error code in case of failure, a non
  * negative value otherwise
  */
77cc958f
 int avfilter_graph_create_filter(AVFilterContext **filt_ctx, const AVFilter *filt,
38f0c078
                                  const char *name, const char *args, void *opaque,
                                  AVFilterGraph *graph_ctx);
 
 /**
231fd441
  * Enable or disable automatic format conversion inside the graph.
  *
  * Note that format conversion can still happen inside explicitly inserted
  * scale and aresample filters.
  *
  * @param flags  any of the AVFILTER_AUTO_CONVERT_* constants
  */
 void avfilter_graph_set_auto_convert(AVFilterGraph *graph, unsigned flags);
 
 enum {
     AVFILTER_AUTO_CONVERT_ALL  =  0, /**< all automatic conversions enabled */
     AVFILTER_AUTO_CONVERT_NONE = -1, /**< all automatic conversions disabled */
 };
 
 /**
38f0c078
  * Check validity and configure all the links and formats in the graph.
  *
  * @param graphctx the filter graph
  * @param log_ctx context used for logging
d5ec8ba7
  * @return >= 0 in case of success, a negative AVERROR code otherwise
38f0c078
  */
 int avfilter_graph_config(AVFilterGraph *graphctx, void *log_ctx);
 
 /**
  * Free a graph, destroy its links, and set *graph to NULL.
  * If *graph is NULL, do nothing.
  */
 void avfilter_graph_free(AVFilterGraph **graph);
 
 /**
  * A linked-list of the inputs/outputs of the filter chain.
  *
  * This is mainly useful for avfilter_graph_parse() / avfilter_graph_parse2(),
  * where it is used to communicate open (unlinked) inputs and outputs from and
  * to the caller.
  * This struct specifies, per each not connected pad contained in the graph, the
  * filter context and the pad index required for establishing a link.
  */
 typedef struct AVFilterInOut {
     /** unique name for this input/output in the list */
     char *name;
 
     /** filter context associated to this input/output */
     AVFilterContext *filter_ctx;
 
     /** index of the filt_ctx pad to use for linking */
     int pad_idx;
 
     /** next input/input in the list, NULL if this is the last */
     struct AVFilterInOut *next;
 } AVFilterInOut;
 
 /**
  * Allocate a single AVFilterInOut entry.
  * Must be freed with avfilter_inout_free().
  * @return allocated AVFilterInOut on success, NULL on failure.
  */
 AVFilterInOut *avfilter_inout_alloc(void);
 
 /**
  * Free the supplied list of AVFilterInOut and set *inout to NULL.
  * If *inout is NULL, do nothing.
  */
 void avfilter_inout_free(AVFilterInOut **inout);
 
122536e0
 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI || !FF_API_OLD_GRAPH_PARSE
838bd731
 /**
  * Add a graph described by a string to a graph.
  *
  * @note The caller must provide the lists of inputs and outputs,
  * which therefore must be known before calling the function.
  *
  * @note The inputs parameter describes inputs of the already existing
  * part of the graph; i.e. from the point of view of the newly created
  * part, they are outputs. Similarly the outputs parameter describes
  * outputs of the already existing filters, which are provided as
  * inputs to the parsed filters.
  *
b2682db3
  * @param graph   the filter graph where to link the parsed graph context
838bd731
  * @param filters string to be parsed
  * @param inputs  linked list to the inputs of the graph
  * @param outputs linked list to the outputs of the graph
  * @return zero on success, a negative AVERROR code on error
  */
 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
                          AVFilterInOut *inputs, AVFilterInOut *outputs,
                          void *log_ctx);
 #else
38f0c078
 /**
  * Add a graph described by a string to a graph.
  *
  * @param graph   the filter graph where to link the parsed graph context
  * @param filters string to be parsed
231fd441
  * @param inputs  pointer to a linked list to the inputs of the graph, may be NULL.
  *                If non-NULL, *inputs is updated to contain the list of open inputs
  *                after the parsing, should be freed with avfilter_inout_free().
  * @param outputs pointer to a linked list to the outputs of the graph, may be NULL.
  *                If non-NULL, *outputs is updated to contain the list of open outputs
  *                after the parsing, should be freed with avfilter_inout_free().
  * @return non negative on success, a negative AVERROR code on error
838bd731
  * @deprecated Use avfilter_graph_parse_ptr() instead.
38f0c078
  */
838bd731
 attribute_deprecated
38f0c078
 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
231fd441
                          AVFilterInOut **inputs, AVFilterInOut **outputs,
38f0c078
                          void *log_ctx);
838bd731
 #endif
 
 /**
  * Add a graph described by a string to a graph.
  *
af7b89e0
  * In the graph filters description, if the input label of the first
  * filter is not specified, "in" is assumed; if the output label of
  * the last filter is not specified, "out" is assumed.
  *
838bd731
  * @param graph   the filter graph where to link the parsed graph context
  * @param filters string to be parsed
  * @param inputs  pointer to a linked list to the inputs of the graph, may be NULL.
  *                If non-NULL, *inputs is updated to contain the list of open inputs
  *                after the parsing, should be freed with avfilter_inout_free().
  * @param outputs pointer to a linked list to the outputs of the graph, may be NULL.
  *                If non-NULL, *outputs is updated to contain the list of open outputs
  *                after the parsing, should be freed with avfilter_inout_free().
  * @return non negative on success, a negative AVERROR code on error
  */
 int avfilter_graph_parse_ptr(AVFilterGraph *graph, const char *filters,
                              AVFilterInOut **inputs, AVFilterInOut **outputs,
                              void *log_ctx);
38f0c078
 
 /**
  * Add a graph described by a string to a graph.
  *
  * @param[in]  graph   the filter graph where to link the parsed graph context
  * @param[in]  filters string to be parsed
  * @param[out] inputs  a linked list of all free (unlinked) inputs of the
  *                     parsed graph will be returned here. It is to be freed
  *                     by the caller using avfilter_inout_free().
  * @param[out] outputs a linked list of all free (unlinked) outputs of the
  *                     parsed graph will be returned here. It is to be freed by the
  *                     caller using avfilter_inout_free().
  * @return zero on success, a negative AVERROR code on error
  *
838bd731
  * @note This function returns the inputs and outputs that are left
  * unlinked after parsing the graph and the caller then deals with
  * them.
  * @note This function makes no reference whatsoever to already
  * existing parts of the graph and the inputs parameter will on return
  * contain inputs of the newly parsed part of the graph.  Analogously
  * the outputs parameter will contain outputs of the newly created
38f0c078
  * filters.
  */
 int avfilter_graph_parse2(AVFilterGraph *graph, const char *filters,
                           AVFilterInOut **inputs,
                           AVFilterInOut **outputs);
 
231fd441
 /**
  * Send a command to one or more filter instances.
  *
  * @param graph  the filter graph
  * @param target the filter(s) to which the command should be sent
  *               "all" sends to all filters
  *               otherwise it can be a filter or filter instance name
  *               which will send the command to all matching filters.
e1332ff3
  * @param cmd    the command to send, for handling simplicity all commands must be alphanumeric only
231fd441
  * @param arg    the argument for the command
  * @param res    a buffer with size res_size where the filter(s) can return a response.
  *
  * @returns >=0 on success otherwise an error code.
  *              AVERROR(ENOSYS) on unsupported commands
  */
 int avfilter_graph_send_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, char *res, int res_len, int flags);
 
 /**
  * Queue a command for one or more filter instances.
  *
  * @param graph  the filter graph
  * @param target the filter(s) to which the command should be sent
  *               "all" sends to all filters
  *               otherwise it can be a filter or filter instance name
  *               which will send the command to all matching filters.
b2682db3
  * @param cmd    the command to sent, for handling simplicity all commands must be alphanumeric only
231fd441
  * @param arg    the argument for the command
  * @param ts     time at which the command should be sent to the filter
  *
  * @note As this executes commands after this function returns, no return code
  *       from the filter is provided, also AVFILTER_CMD_FLAG_ONE is not supported.
  */
 int avfilter_graph_queue_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, int flags, double ts);
 
 
 /**
  * Dump a graph into a human-readable string representation.
  *
  * @param graph    the graph to dump
  * @param options  formatting options; currently ignored
  * @return  a string, or NULL in case of memory allocation failure;
  *          the string must be freed using av_free
  */
 char *avfilter_graph_dump(AVFilterGraph *graph, const char *options);
 
 /**
  * Request a frame on the oldest sink link.
  *
  * If the request returns AVERROR_EOF, try the next.
  *
  * Note that this function is not meant to be the sole scheduling mechanism
  * of a filtergraph, only a convenience function to help drain a filtergraph
  * in a balanced way under normal circumstances.
  *
  * Also note that AVERROR_EOF does not mean that frames did not arrive on
  * some of the sinks during the process.
  * When there are multiple sink links, in case the requested link
  * returns an EOF, this may cause a filter to flush pending frames
  * which are sent to another sink link, although unrequested.
  *
  * @return  the return value of ff_request_frame(),
  *          or AVERROR_EOF if all links returned AVERROR_EOF
  */
 int avfilter_graph_request_oldest(AVFilterGraph *graph);
 
44d44883
 /**
  * @}
  */
bc8c1cdc
 
153382e1
 #endif /* AVFILTER_AVFILTER_H */