lavfi: add qp_table_size
[ffmpeg.git] / libavfilter / avfilter.h
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 #include <stddef.h>
26
27 #include "libavutil/avutil.h"
28 #include "libavutil/log.h"
29 #include "libavutil/samplefmt.h"
30 #include "libavutil/pixfmt.h"
31 #include "libavutil/rational.h"
32
33 #include "libavfilter/version.h"
34
35 /**
36  * Return the LIBAVFILTER_VERSION_INT constant.
37  */
38 unsigned avfilter_version(void);
39
40 /**
41  * Return the libavfilter build-time configuration.
42  */
43 const char *avfilter_configuration(void);
44
45 /**
46  * Return the libavfilter license.
47  */
48 const char *avfilter_license(void);
49
50 /**
51  * Get the class for the AVFilterContext struct.
52  */
53 const AVClass *avfilter_get_class(void);
54
55 typedef struct AVFilterContext AVFilterContext;
56 typedef struct AVFilterLink    AVFilterLink;
57 typedef struct AVFilterPad     AVFilterPad;
58 typedef struct AVFilterFormats AVFilterFormats;
59
60 /**
61  * A reference-counted buffer data type used by the filter system. Filters
62  * should not store pointers to this structure directly, but instead use the
63  * AVFilterBufferRef structure below.
64  */
65 typedef struct AVFilterBuffer {
66     uint8_t *data[8];           ///< buffer data for each plane/channel
67
68     /**
69      * pointers to the data planes/channels.
70      *
71      * For video, this should simply point to data[].
72      *
73      * For planar audio, each channel has a separate data pointer, and
74      * linesize[0] contains the size of each channel buffer.
75      * For packed audio, there is just one data pointer, and linesize[0]
76      * contains the total size of the buffer for all channels.
77      *
78      * Note: Both data and extended_data will always be set, but for planar
79      * audio with more channels that can fit in data, extended_data must be used
80      * in order to access all channels.
81      */
82     uint8_t **extended_data;
83     int linesize[8];            ///< number of bytes per line
84
85     /** private data to be used by a custom free function */
86     void *priv;
87     /**
88      * A pointer to the function to deallocate this buffer if the default
89      * function is not sufficient. This could, for example, add the memory
90      * back into a memory pool to be reused later without the overhead of
91      * reallocating it from scratch.
92      */
93     void (*free)(struct AVFilterBuffer *buf);
94
95     int format;                 ///< media format
96     int w, h;                   ///< width and height of the allocated buffer
97     unsigned refcount;          ///< number of references to this buffer
98 } AVFilterBuffer;
99
100 #define AV_PERM_READ     0x01   ///< can read from the buffer
101 #define AV_PERM_WRITE    0x02   ///< can write to the buffer
102 #define AV_PERM_PRESERVE 0x04   ///< nobody else can overwrite the buffer
103 #define AV_PERM_REUSE    0x08   ///< can output the buffer multiple times, with the same contents each time
104 #define AV_PERM_REUSE2   0x10   ///< can output the buffer multiple times, modified each time
105 #define AV_PERM_NEG_LINESIZES 0x20  ///< the buffer requested can have negative linesizes
106 #define AV_PERM_ALIGN    0x40   ///< the buffer must be aligned
107
108 #define AVFILTER_ALIGN 16 //not part of ABI
109
110 /**
111  * Audio specific properties in a reference to an AVFilterBuffer. Since
112  * AVFilterBufferRef is common to different media formats, audio specific
113  * per reference properties must be separated out.
114  */
115 typedef struct AVFilterBufferRefAudioProps {
116     uint64_t channel_layout;    ///< channel layout of audio buffer
117     int nb_samples;             ///< number of audio samples per channel
118     int sample_rate;            ///< audio buffer sample rate
119 } AVFilterBufferRefAudioProps;
120
121 /**
122  * Video specific properties in a reference to an AVFilterBuffer. Since
123  * AVFilterBufferRef is common to different media formats, video specific
124  * per reference properties must be separated out.
125  */
126 typedef struct AVFilterBufferRefVideoProps {
127     int w;                      ///< image width
128     int h;                      ///< image height
129     AVRational sample_aspect_ratio; ///< sample aspect ratio
130     int interlaced;             ///< is frame interlaced
131     int top_field_first;        ///< field order
132     enum AVPictureType pict_type; ///< picture type of the frame
133     int key_frame;              ///< 1 -> keyframe, 0-> not
134     int qp_table_linesize;                ///< qp_table stride
135     int qp_table_size;            ///< qp_table size
136     int8_t *qp_table;             ///< array of Quantization Parameters
137 } AVFilterBufferRefVideoProps;
138
139 /**
140  * A reference to an AVFilterBuffer. Since filters can manipulate the origin of
141  * a buffer to, for example, crop image without any memcpy, the buffer origin
142  * and dimensions are per-reference properties. Linesize is also useful for
143  * image flipping, frame to field filters, etc, and so is also per-reference.
144  *
145  * TODO: add anything necessary for frame reordering
146  */
147 typedef struct AVFilterBufferRef {
148     AVFilterBuffer *buf;        ///< the buffer that this is a reference to
149     uint8_t *data[8];           ///< picture/audio data for each plane
150     /**
151      * pointers to the data planes/channels.
152      *
153      * For video, this should simply point to data[].
154      *
155      * For planar audio, each channel has a separate data pointer, and
156      * linesize[0] contains the size of each channel buffer.
157      * For packed audio, there is just one data pointer, and linesize[0]
158      * contains the total size of the buffer for all channels.
159      *
160      * Note: Both data and extended_data will always be set, but for planar
161      * audio with more channels that can fit in data, extended_data must be used
162      * in order to access all channels.
163      */
164     uint8_t **extended_data;
165     int linesize[8];            ///< number of bytes per line
166
167     AVFilterBufferRefVideoProps *video; ///< video buffer specific properties
168     AVFilterBufferRefAudioProps *audio; ///< audio buffer specific properties
169
170     /**
171      * presentation timestamp. The time unit may change during
172      * filtering, as it is specified in the link and the filter code
173      * may need to rescale the PTS accordingly.
174      */
175     int64_t pts;
176     int64_t pos;                ///< byte position in stream, -1 if unknown
177
178     int format;                 ///< media format
179
180     int perms;                  ///< permissions, see the AV_PERM_* flags
181
182     enum AVMediaType type;      ///< media type of buffer data
183 } AVFilterBufferRef;
184
185 /**
186  * Copy properties of src to dst, without copying the actual data
187  */
188 void avfilter_copy_buffer_ref_props(AVFilterBufferRef *dst, AVFilterBufferRef *src);
189
190 /**
191  * Add a new reference to a buffer.
192  *
193  * @param ref   an existing reference to the buffer
194  * @param pmask a bitmask containing the allowable permissions in the new
195  *              reference
196  * @return      a new reference to the buffer with the same properties as the
197  *              old, excluding any permissions denied by pmask
198  */
199 AVFilterBufferRef *avfilter_ref_buffer(AVFilterBufferRef *ref, int pmask);
200
201 /**
202  * Remove a reference to a buffer. If this is the last reference to the
203  * buffer, the buffer itself is also automatically freed.
204  *
205  * @param ref reference to the buffer, may be NULL
206  *
207  * @note it is recommended to use avfilter_unref_bufferp() instead of this
208  * function
209  */
210 void avfilter_unref_buffer(AVFilterBufferRef *ref);
211
212 /**
213  * Remove a reference to a buffer and set the pointer to NULL.
214  * If this is the last reference to the buffer, the buffer itself
215  * is also automatically freed.
216  *
217  * @param ref pointer to the buffer reference
218  */
219 void avfilter_unref_bufferp(AVFilterBufferRef **ref);
220
221 #if FF_API_AVFILTERPAD_PUBLIC
222 /**
223  * A filter pad used for either input or output.
224  *
225  * See doc/filter_design.txt for details on how to implement the methods.
226  *
227  * @warning this struct might be removed from public API.
228  * users should call avfilter_pad_get_name() and avfilter_pad_get_type()
229  * to access the name and type fields; there should be no need to access
230  * any other fields from outside of libavfilter.
231  */
232 struct AVFilterPad {
233     /**
234      * Pad name. The name is unique among inputs and among outputs, but an
235      * input may have the same name as an output. This may be NULL if this
236      * pad has no need to ever be referenced by name.
237      */
238     const char *name;
239
240     /**
241      * AVFilterPad type.
242      */
243     enum AVMediaType type;
244
245     /**
246      * Input pads:
247      * Minimum required permissions on incoming buffers. Any buffer with
248      * insufficient permissions will be automatically copied by the filter
249      * system to a new buffer which provides the needed access permissions.
250      *
251      * Output pads:
252      * Guaranteed permissions on outgoing buffers. Any buffer pushed on the
253      * link must have at least these permissions; this fact is checked by
254      * asserts. It can be used to optimize buffer allocation.
255      */
256     int min_perms;
257
258     /**
259      * Input pads:
260      * Permissions which are not accepted on incoming buffers. Any buffer
261      * which has any of these permissions set will be automatically copied
262      * by the filter system to a new buffer which does not have those
263      * permissions. This can be used to easily disallow buffers with
264      * AV_PERM_REUSE.
265      *
266      * Output pads:
267      * Permissions which are automatically removed on outgoing buffers. It
268      * can be used to optimize buffer allocation.
269      */
270     int rej_perms;
271
272     /**
273      * Callback called before passing the first slice of a new frame. If
274      * NULL, the filter layer will default to storing a reference to the
275      * picture inside the link structure.
276      *
277      * The reference given as argument is also available in link->cur_buf.
278      * It can be stored elsewhere or given away, but then clearing
279      * link->cur_buf is advised, as it is automatically unreferenced.
280      * The reference must not be unreferenced before end_frame(), as it may
281      * still be in use by the automatic copy mechanism.
282      *
283      * Input video pads only.
284      *
285      * @return >= 0 on success, a negative AVERROR on error. picref will be
286      * unreferenced by the caller in case of error.
287      */
288     int (*start_frame)(AVFilterLink *link, AVFilterBufferRef *picref);
289
290     /**
291      * Callback function to get a video buffer. If NULL, the filter system will
292      * use avfilter_default_get_video_buffer().
293      *
294      * Input video pads only.
295      */
296     AVFilterBufferRef *(*get_video_buffer)(AVFilterLink *link, int perms, int w, int h);
297
298     /**
299      * Callback function to get an audio buffer. If NULL, the filter system will
300      * use avfilter_default_get_audio_buffer().
301      *
302      * Input audio pads only.
303      */
304     AVFilterBufferRef *(*get_audio_buffer)(AVFilterLink *link, int perms,
305                                            int nb_samples);
306
307     /**
308      * Callback called after the slices of a frame are completely sent. If
309      * NULL, the filter layer will default to releasing the reference stored
310      * in the link structure during start_frame().
311      *
312      * Input video pads only.
313      *
314      * @return >= 0 on success, a negative AVERROR on error.
315      */
316     int (*end_frame)(AVFilterLink *link);
317
318     /**
319      * Slice drawing callback. This is where a filter receives video data
320      * and should do its processing.
321      *
322      * Input video pads only.
323      *
324      * @return >= 0 on success, a negative AVERROR on error.
325      */
326     int (*draw_slice)(AVFilterLink *link, int y, int height, int slice_dir);
327
328     /**
329      * Samples filtering callback. This is where a filter receives audio data
330      * and should do its processing.
331      *
332      * Input audio pads only.
333      *
334      * @return >= 0 on success, a negative AVERROR on error. This function
335      * must ensure that samplesref is properly unreferenced on error if it
336      * hasn't been passed on to another filter.
337      */
338     int (*filter_samples)(AVFilterLink *link, AVFilterBufferRef *samplesref);
339
340     /**
341      * Frame poll callback. This returns the number of immediately available
342      * samples. It should return a positive value if the next request_frame()
343      * is guaranteed to return one frame (with no delay).
344      *
345      * Defaults to just calling the source poll_frame() method.
346      *
347      * Output pads only.
348      */
349     int (*poll_frame)(AVFilterLink *link);
350
351     /**
352      * Frame request callback. A call to this should result in at least one
353      * frame being output over the given link. This should return zero on
354      * success, and another value on error.
355      * See ff_request_frame() for the error codes with a specific
356      * meaning.
357      *
358      * Output pads only.
359      */
360     int (*request_frame)(AVFilterLink *link);
361
362     /**
363      * Link configuration callback.
364      *
365      * For output pads, this should set the following link properties:
366      * video: width, height, sample_aspect_ratio, time_base
367      * audio: sample_rate.
368      *
369      * This should NOT set properties such as format, channel_layout, etc which
370      * are negotiated between filters by the filter system using the
371      * query_formats() callback before this function is called.
372      *
373      * For input pads, this should check the properties of the link, and update
374      * the filter's internal state as necessary.
375      *
376      * For both input and output pads, this should return zero on success,
377      * and another value on error.
378      */
379     int (*config_props)(AVFilterLink *link);
380
381     /**
382      * The filter expects a fifo to be inserted on its input link,
383      * typically because it has a delay.
384      *
385      * input pads only.
386      */
387     int needs_fifo;
388 };
389 #endif
390
391 /**
392  * Get the name of an AVFilterPad.
393  *
394  * @param pads an array of AVFilterPads
395  * @param pad_idx index of the pad in the array it; is the caller's
396  *                responsibility to ensure the index is valid
397  *
398  * @return name of the pad_idx'th pad in pads
399  */
400 const char *avfilter_pad_get_name(AVFilterPad *pads, int pad_idx);
401
402 /**
403  * Get the type of an AVFilterPad.
404  *
405  * @param pads an array of AVFilterPads
406  * @param pad_idx index of the pad in the array; it is the caller's
407  *                responsibility to ensure the index is valid
408  *
409  * @return type of the pad_idx'th pad in pads
410  */
411 enum AVMediaType avfilter_pad_get_type(AVFilterPad *pads, int pad_idx);
412
413 /** default handler for end_frame() for video inputs */
414 attribute_deprecated
415 int  avfilter_default_end_frame(AVFilterLink *link);
416
417 /**
418  * Filter definition. This defines the pads a filter contains, and all the
419  * callback functions used to interact with the filter.
420  */
421 typedef struct AVFilter {
422     const char *name;         ///< filter name
423
424     /**
425      * A description for the filter. You should use the
426      * NULL_IF_CONFIG_SMALL() macro to define it.
427      */
428     const char *description;
429
430     const AVFilterPad *inputs;  ///< NULL terminated list of inputs. NULL if none
431     const AVFilterPad *outputs; ///< NULL terminated list of outputs. NULL if none
432
433     /*****************************************************************
434      * All fields below this line are not part of the public API. They
435      * may not be used outside of libavfilter and can be changed and
436      * removed at will.
437      * New public fields should be added right above.
438      *****************************************************************
439      */
440
441     /**
442      * Filter initialization function. Args contains the user-supplied
443      * parameters. FIXME: maybe an AVOption-based system would be better?
444      */
445     int (*init)(AVFilterContext *ctx, const char *args);
446
447     /**
448      * Filter uninitialization function. Should deallocate any memory held
449      * by the filter, release any buffer references, etc. This does not need
450      * to deallocate the AVFilterContext->priv memory itself.
451      */
452     void (*uninit)(AVFilterContext *ctx);
453
454     /**
455      * Queries formats/layouts supported by the filter and its pads, and sets
456      * the in_formats/in_chlayouts for links connected to its output pads,
457      * and out_formats/out_chlayouts for links connected to its input pads.
458      *
459      * @return zero on success, a negative value corresponding to an
460      * AVERROR code otherwise
461      */
462     int (*query_formats)(AVFilterContext *);
463
464     int priv_size;      ///< size of private data to allocate for the filter
465
466     /**
467      * Make the filter instance process a command.
468      *
469      * @param cmd    the command to process, for handling simplicity all commands must be alphanumeric only
470      * @param arg    the argument for the command
471      * @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.
472      * @param flags  if AVFILTER_CMD_FLAG_FAST is set and the command would be
473      *               time consuming then a filter should treat it like an unsupported command
474      *
475      * @returns >=0 on success otherwise an error code.
476      *          AVERROR(ENOSYS) on unsupported commands
477      */
478     int (*process_command)(AVFilterContext *, const char *cmd, const char *arg, char *res, int res_len, int flags);
479
480     /**
481      * Filter initialization function, alternative to the init()
482      * callback. Args contains the user-supplied parameters, opaque is
483      * used for providing binary data.
484      */
485     int (*init_opaque)(AVFilterContext *ctx, const char *args, void *opaque);
486
487     const AVClass *priv_class;      ///< private class, containing filter specific options
488 } AVFilter;
489
490 /** An instance of a filter */
491 struct AVFilterContext {
492     const AVClass *av_class;        ///< needed for av_log()
493
494     AVFilter *filter;               ///< the AVFilter of which this is an instance
495
496     char *name;                     ///< name of this filter instance
497
498     AVFilterPad   *input_pads;      ///< array of input pads
499     AVFilterLink **inputs;          ///< array of pointers to input links
500 #if FF_API_FOO_COUNT
501     unsigned input_count;           ///< @deprecated use nb_inputs
502 #endif
503     unsigned    nb_inputs;          ///< number of input pads
504
505     AVFilterPad   *output_pads;     ///< array of output pads
506     AVFilterLink **outputs;         ///< array of pointers to output links
507 #if FF_API_FOO_COUNT
508     unsigned output_count;          ///< @deprecated use nb_outputs
509 #endif
510     unsigned    nb_outputs;         ///< number of output pads
511
512     void *priv;                     ///< private data for use by the filter
513
514     struct AVFilterCommand *command_queue;
515 };
516
517 /**
518  * A link between two filters. This contains pointers to the source and
519  * destination filters between which this link exists, and the indexes of
520  * the pads involved. In addition, this link also contains the parameters
521  * which have been negotiated and agreed upon between the filter, such as
522  * image dimensions, format, etc.
523  */
524 struct AVFilterLink {
525     AVFilterContext *src;       ///< source filter
526     AVFilterPad *srcpad;        ///< output pad on the source filter
527
528     AVFilterContext *dst;       ///< dest filter
529     AVFilterPad *dstpad;        ///< input pad on the dest filter
530
531     enum AVMediaType type;      ///< filter media type
532
533     /* These parameters apply only to video */
534     int w;                      ///< agreed upon image width
535     int h;                      ///< agreed upon image height
536     AVRational sample_aspect_ratio; ///< agreed upon sample aspect ratio
537     /* These parameters apply only to audio */
538     uint64_t channel_layout;    ///< channel layout of current buffer (see libavutil/audioconvert.h)
539     int sample_rate;            ///< samples per second
540
541     int format;                 ///< agreed upon media format
542
543     /**
544      * Define the time base used by the PTS of the frames/samples
545      * which will pass through this link.
546      * During the configuration stage, each filter is supposed to
547      * change only the output timebase, while the timebase of the
548      * input link is assumed to be an unchangeable property.
549      */
550     AVRational time_base;
551
552     /*****************************************************************
553      * All fields below this line are not part of the public API. They
554      * may not be used outside of libavfilter and can be changed and
555      * removed at will.
556      * New public fields should be added right above.
557      *****************************************************************
558      */
559     /**
560      * Lists of formats and channel layouts supported by the input and output
561      * filters respectively. These lists are used for negotiating the format
562      * to actually be used, which will be loaded into the format and
563      * channel_layout members, above, when chosen.
564      *
565      */
566     AVFilterFormats *in_formats;
567     AVFilterFormats *out_formats;
568
569     /**
570      * Lists of channel layouts and sample rates used for automatic
571      * negotiation.
572      */
573     AVFilterFormats  *in_samplerates;
574     AVFilterFormats *out_samplerates;
575     struct AVFilterChannelLayouts  *in_channel_layouts;
576     struct AVFilterChannelLayouts *out_channel_layouts;
577
578     /**
579      * Audio only, the destination filter sets this to a non-zero value to
580      * request that buffers with the given number of samples should be sent to
581      * it. AVFilterPad.needs_fifo must also be set on the corresponding input
582      * pad.
583      * Last buffer before EOF will be padded with silence.
584      */
585     int request_samples;
586
587     /** stage of the initialization of the link properties (dimensions, etc) */
588     enum {
589         AVLINK_UNINIT = 0,      ///< not started
590         AVLINK_STARTINIT,       ///< started, but incomplete
591         AVLINK_INIT             ///< complete
592     } init_state;
593
594     /**
595      * The buffer reference currently being sent across the link by the source
596      * filter. This is used internally by the filter system to allow
597      * automatic copying of buffers which do not have sufficient permissions
598      * for the destination. This should not be accessed directly by the
599      * filters.
600      */
601     AVFilterBufferRef *src_buf;
602
603     /**
604      * The buffer reference to the frame sent across the link by the
605      * source filter, which is read by the destination filter. It is
606      * automatically set up by ff_start_frame().
607      *
608      * Depending on the permissions, it may either be the same as
609      * src_buf or an automatic copy of it.
610      *
611      * It is automatically freed by the filter system when calling
612      * ff_end_frame(). In case you save the buffer reference
613      * internally (e.g. if you cache it for later reuse), or give it
614      * away (e.g. if you pass the reference to the next filter) it
615      * must be set to NULL before calling ff_end_frame().
616      */
617     AVFilterBufferRef *cur_buf;
618
619     /**
620      * The buffer reference to the frame which is sent to output by
621      * the source filter.
622      *
623      * If no start_frame callback is defined on a link,
624      * ff_start_frame() will automatically request a new buffer on the
625      * first output link of the destination filter. The reference to
626      * the buffer so obtained is stored in the out_buf field on the
627      * output link.
628      *
629      * It can also be set by the filter code in case the filter needs
630      * to access the output buffer later. For example the filter code
631      * may set it in a custom start_frame, and access it in
632      * draw_slice.
633      *
634      * It is automatically freed by the filter system in
635      * ff_end_frame().
636      */
637     AVFilterBufferRef *out_buf;
638
639     struct AVFilterPool *pool;
640
641     /**
642      * Graph the filter belongs to.
643      */
644     struct AVFilterGraph *graph;
645
646     /**
647      * Current timestamp of the link, as defined by the most recent
648      * frame(s), in AV_TIME_BASE units.
649      */
650     int64_t current_pts;
651
652     /**
653      * Index in the age array.
654      */
655     int age_index;
656
657     /**
658      * Frame rate of the stream on the link, or 1/0 if unknown;
659      * if left to 0/0, will be automatically be copied from the first input
660      * of the source filter if it exists.
661      *
662      * Sources should set it to the best estimation of the real frame rate.
663      * Filters should update it if necessary depending on their function.
664      * Sinks can use it to set a default output frame rate.
665      * It is similar to the r_frame_rate field in AVStream.
666      */
667     AVRational frame_rate;
668
669     /**
670      * Buffer partially filled with samples to achieve a fixed/minimum size.
671      */
672     AVFilterBufferRef *partial_buf;
673
674     /**
675      * Size of the partial buffer to allocate.
676      * Must be between min_samples and max_samples.
677      */
678     int partial_buf_size;
679
680     /**
681      * Minimum number of samples to filter at once. If filter_samples() is
682      * called with fewer samples, it will accumulate them in partial_buf.
683      * This field and the related ones must not be changed after filtering
684      * has started.
685      * If 0, all related fields are ignored.
686      */
687     int min_samples;
688
689     /**
690      * Maximum number of samples to filter at once. If filter_samples() is
691      * called with more samples, it will split them.
692      */
693     int max_samples;
694
695     /**
696      * The buffer reference currently being received across the link by the
697      * destination filter. This is used internally by the filter system to
698      * allow automatic copying of buffers which do not have sufficient
699      * permissions for the destination. This should not be accessed directly
700      * by the filters.
701      */
702     AVFilterBufferRef *cur_buf_copy;
703
704     /**
705      * True if the link is closed.
706      * If set, all attemps of start_frame, filter_samples or request_frame
707      * will fail with AVERROR_EOF, and if necessary the reference will be
708      * destroyed.
709      * If request_frame returns AVERROR_EOF, this flag is set on the
710      * corresponding link.
711      * It can be set also be set by either the source or the destination
712      * filter.
713      */
714     int closed;
715 };
716
717 /**
718  * Link two filters together.
719  *
720  * @param src    the source filter
721  * @param srcpad index of the output pad on the source filter
722  * @param dst    the destination filter
723  * @param dstpad index of the input pad on the destination filter
724  * @return       zero on success
725  */
726 int avfilter_link(AVFilterContext *src, unsigned srcpad,
727                   AVFilterContext *dst, unsigned dstpad);
728
729 /**
730  * Free the link in *link, and set its pointer to NULL.
731  */
732 void avfilter_link_free(AVFilterLink **link);
733
734 /**
735  * Set the closed field of a link.
736  */
737 void avfilter_link_set_closed(AVFilterLink *link, int closed);
738
739 /**
740  * Negotiate the media format, dimensions, etc of all inputs to a filter.
741  *
742  * @param filter the filter to negotiate the properties for its inputs
743  * @return       zero on successful negotiation
744  */
745 int avfilter_config_links(AVFilterContext *filter);
746
747 /**
748  * Create a buffer reference wrapped around an already allocated image
749  * buffer.
750  *
751  * @param data pointers to the planes of the image to reference
752  * @param linesize linesizes for the planes of the image to reference
753  * @param perms the required access permissions
754  * @param w the width of the image specified by the data and linesize arrays
755  * @param h the height of the image specified by the data and linesize arrays
756  * @param format the pixel format of the image specified by the data and linesize arrays
757  */
758 AVFilterBufferRef *
759 avfilter_get_video_buffer_ref_from_arrays(uint8_t * const data[4], const int linesize[4], int perms,
760                                           int w, int h, enum PixelFormat format);
761
762 /**
763  * Create an audio buffer reference wrapped around an already
764  * allocated samples buffer.
765  *
766  * @param data           pointers to the samples plane buffers
767  * @param linesize       linesize for the samples plane buffers
768  * @param perms          the required access permissions
769  * @param nb_samples     number of samples per channel
770  * @param sample_fmt     the format of each sample in the buffer to allocate
771  * @param channel_layout the channel layout of the buffer
772  */
773 AVFilterBufferRef *avfilter_get_audio_buffer_ref_from_arrays(uint8_t **data,
774                                                              int linesize,
775                                                              int perms,
776                                                              int nb_samples,
777                                                              enum AVSampleFormat sample_fmt,
778                                                              uint64_t channel_layout);
779
780
781 #define AVFILTER_CMD_FLAG_ONE   1 ///< Stop once a filter understood the command (for target=all for example), fast filters are favored automatically
782 #define AVFILTER_CMD_FLAG_FAST  2 ///< Only execute command when its fast (like a video out that supports contrast adjustment in hw)
783
784 /**
785  * Make the filter instance process a command.
786  * It is recommended to use avfilter_graph_send_command().
787  */
788 int avfilter_process_command(AVFilterContext *filter, const char *cmd, const char *arg, char *res, int res_len, int flags);
789
790 /** Initialize the filter system. Register all builtin filters. */
791 void avfilter_register_all(void);
792
793 /** Uninitialize the filter system. Unregister all filters. */
794 void avfilter_uninit(void);
795
796 /**
797  * Register a filter. This is only needed if you plan to use
798  * avfilter_get_by_name later to lookup the AVFilter structure by name. A
799  * filter can still by instantiated with avfilter_open even if it is not
800  * registered.
801  *
802  * @param filter the filter to register
803  * @return 0 if the registration was successful, a negative value
804  * otherwise
805  */
806 int avfilter_register(AVFilter *filter);
807
808 /**
809  * Get a filter definition matching the given name.
810  *
811  * @param name the filter name to find
812  * @return     the filter definition, if any matching one is registered.
813  *             NULL if none found.
814  */
815 AVFilter *avfilter_get_by_name(const char *name);
816
817 /**
818  * If filter is NULL, returns a pointer to the first registered filter pointer,
819  * if filter is non-NULL, returns the next pointer after filter.
820  * If the returned pointer points to NULL, the last registered filter
821  * was already reached.
822  */
823 AVFilter **av_filter_next(AVFilter **filter);
824
825 /**
826  * Create a filter instance.
827  *
828  * @param filter_ctx put here a pointer to the created filter context
829  * on success, NULL on failure
830  * @param filter    the filter to create an instance of
831  * @param inst_name Name to give to the new instance. Can be NULL for none.
832  * @return >= 0 in case of success, a negative error code otherwise
833  */
834 int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name);
835
836 /**
837  * Initialize a filter.
838  *
839  * @param filter the filter to initialize
840  * @param args   A string of parameters to use when initializing the filter.
841  *               The format and meaning of this string varies by filter.
842  * @param opaque Any extra non-string data needed by the filter. The meaning
843  *               of this parameter varies by filter.
844  * @return       zero on success
845  */
846 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
847
848 /**
849  * Free a filter context.
850  *
851  * @param filter the filter to free
852  */
853 void avfilter_free(AVFilterContext *filter);
854
855 /**
856  * Insert a filter in the middle of an existing link.
857  *
858  * @param link the link into which the filter should be inserted
859  * @param filt the filter to be inserted
860  * @param filt_srcpad_idx the input pad on the filter to connect
861  * @param filt_dstpad_idx the output pad on the filter to connect
862  * @return     zero on success
863  */
864 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
865                            unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
866
867 #endif /* AVFILTER_AVFILTER_H */