b8205fd6358fb3ea4698d8d54f7aae76134b23d0
[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 "libavutil/avutil.h"
26 #include "libavutil/log.h"
27 #include "libavutil/samplefmt.h"
28 #include "libavutil/pixfmt.h"
29 #include "libavutil/rational.h"
30
31 #define LIBAVFILTER_VERSION_MAJOR  2
32 #define LIBAVFILTER_VERSION_MINOR 47
33 #define LIBAVFILTER_VERSION_MICRO  0
34
35 #define LIBAVFILTER_VERSION_INT AV_VERSION_INT(LIBAVFILTER_VERSION_MAJOR, \
36                                                LIBAVFILTER_VERSION_MINOR, \
37                                                LIBAVFILTER_VERSION_MICRO)
38 #define LIBAVFILTER_VERSION     AV_VERSION(LIBAVFILTER_VERSION_MAJOR,   \
39                                            LIBAVFILTER_VERSION_MINOR,   \
40                                            LIBAVFILTER_VERSION_MICRO)
41 #define LIBAVFILTER_BUILD       LIBAVFILTER_VERSION_INT
42
43 #ifndef FF_API_OLD_VSINK_API
44 #define FF_API_OLD_VSINK_API        (LIBAVFILTER_VERSION_MAJOR < 3)
45 #endif
46 #ifndef FF_API_OLD_ALL_FORMATS_API
47 #define FF_API_OLD_ALL_FORMATS_API (LIBAVFILTER_VERSION_MAJOR < 3)
48 #endif
49
50 #include <stddef.h>
51
52 /**
53  * Return the LIBAVFILTER_VERSION_INT constant.
54  */
55 unsigned avfilter_version(void);
56
57 /**
58  * Return the libavfilter build-time configuration.
59  */
60 const char *avfilter_configuration(void);
61
62 /**
63  * Return the libavfilter license.
64  */
65 const char *avfilter_license(void);
66
67
68 typedef struct AVFilterContext AVFilterContext;
69 typedef struct AVFilterLink    AVFilterLink;
70 typedef struct AVFilterPad     AVFilterPad;
71
72 /**
73  * A reference-counted buffer data type used by the filter system. Filters
74  * should not store pointers to this structure directly, but instead use the
75  * AVFilterBufferRef structure below.
76  */
77 typedef struct AVFilterBuffer {
78     uint8_t *data[8];           ///< buffer data for each plane/channel
79     int linesize[8];            ///< number of bytes per line
80
81     unsigned refcount;          ///< number of references to this buffer
82
83     /** private data to be used by a custom free function */
84     void *priv;
85     /**
86      * A pointer to the function to deallocate this buffer if the default
87      * function is not sufficient. This could, for example, add the memory
88      * back into a memory pool to be reused later without the overhead of
89      * reallocating it from scratch.
90      */
91     void (*free)(struct AVFilterBuffer *buf);
92
93     int format;                 ///< media format
94     int w, h;                   ///< width and height of the allocated buffer
95 } AVFilterBuffer;
96
97 #define AV_PERM_READ     0x01   ///< can read from the buffer
98 #define AV_PERM_WRITE    0x02   ///< can write to the buffer
99 #define AV_PERM_PRESERVE 0x04   ///< nobody else can overwrite the buffer
100 #define AV_PERM_REUSE    0x08   ///< can output the buffer multiple times, with the same contents each time
101 #define AV_PERM_REUSE2   0x10   ///< can output the buffer multiple times, modified each time
102 #define AV_PERM_NEG_LINESIZES 0x20  ///< the buffer requested can have negative linesizes
103 #define AV_PERM_ALIGN    0x40   ///< the buffer must be aligned
104
105 #define AVFILTER_ALIGN 16 //not part of ABI
106
107 /**
108  * Audio specific properties in a reference to an AVFilterBuffer. Since
109  * AVFilterBufferRef is common to different media formats, audio specific
110  * per reference properties must be separated out.
111  */
112 typedef struct AVFilterBufferRefAudioProps {
113     int64_t channel_layout;     ///< channel layout of audio buffer
114     int nb_samples;             ///< number of audio samples per channel
115     int sample_rate;            ///< audio buffer sample rate
116     int planar;                 ///< audio buffer - planar or packed
117 } AVFilterBufferRefAudioProps;
118
119 /**
120  * Video specific properties in a reference to an AVFilterBuffer. Since
121  * AVFilterBufferRef is common to different media formats, video specific
122  * per reference properties must be separated out.
123  */
124 typedef struct AVFilterBufferRefVideoProps {
125     int w;                      ///< image width
126     int h;                      ///< image height
127     AVRational sample_aspect_ratio; ///< sample aspect ratio
128     int interlaced;             ///< is frame interlaced
129     int top_field_first;        ///< field order
130     enum AVPictureType pict_type; ///< picture type of the frame
131     int key_frame;              ///< 1 -> keyframe, 0-> not
132 } AVFilterBufferRefVideoProps;
133
134 /**
135  * A reference to an AVFilterBuffer. Since filters can manipulate the origin of
136  * a buffer to, for example, crop image without any memcpy, the buffer origin
137  * and dimensions are per-reference properties. Linesize is also useful for
138  * image flipping, frame to field filters, etc, and so is also per-reference.
139  *
140  * TODO: add anything necessary for frame reordering
141  */
142 typedef struct AVFilterBufferRef {
143     AVFilterBuffer *buf;        ///< the buffer that this is a reference to
144     uint8_t *data[8];           ///< picture/audio data for each plane
145     int linesize[8];            ///< number of bytes per line
146     int format;                 ///< media format
147
148     /**
149      * presentation timestamp. The time unit may change during
150      * filtering, as it is specified in the link and the filter code
151      * may need to rescale the PTS accordingly.
152      */
153     int64_t pts;
154     int64_t pos;                ///< byte position in stream, -1 if unknown
155
156     int perms;                  ///< permissions, see the AV_PERM_* flags
157
158     enum AVMediaType type;      ///< media type of buffer data
159     AVFilterBufferRefVideoProps *video; ///< video buffer specific properties
160     AVFilterBufferRefAudioProps *audio; ///< audio buffer specific properties
161 } AVFilterBufferRef;
162
163 /**
164  * Copy properties of src to dst, without copying the actual data
165  */
166 static inline void avfilter_copy_buffer_ref_props(AVFilterBufferRef *dst, AVFilterBufferRef *src)
167 {
168     // copy common properties
169     dst->pts             = src->pts;
170     dst->pos             = src->pos;
171
172     switch (src->type) {
173     case AVMEDIA_TYPE_VIDEO: *dst->video = *src->video; break;
174     case AVMEDIA_TYPE_AUDIO: *dst->audio = *src->audio; break;
175     default: break;
176     }
177 }
178
179 /**
180  * Add a new reference to a buffer.
181  *
182  * @param ref   an existing reference to the buffer
183  * @param pmask a bitmask containing the allowable permissions in the new
184  *              reference
185  * @return      a new reference to the buffer with the same properties as the
186  *              old, excluding any permissions denied by pmask
187  */
188 AVFilterBufferRef *avfilter_ref_buffer(AVFilterBufferRef *ref, int pmask);
189
190 /**
191  * Remove a reference to a buffer. If this is the last reference to the
192  * buffer, the buffer itself is also automatically freed.
193  *
194  * @param ref reference to the buffer, may be NULL
195  */
196 void avfilter_unref_buffer(AVFilterBufferRef *ref);
197
198 /**
199  * A list of supported formats for one end of a filter link. This is used
200  * during the format negotiation process to try to pick the best format to
201  * use to minimize the number of necessary conversions. Each filter gives a
202  * list of the formats supported by each input and output pad. The list
203  * given for each pad need not be distinct - they may be references to the
204  * same list of formats, as is often the case when a filter supports multiple
205  * formats, but will always output the same format as it is given in input.
206  *
207  * In this way, a list of possible input formats and a list of possible
208  * output formats are associated with each link. When a set of formats is
209  * negotiated over a link, the input and output lists are merged to form a
210  * new list containing only the common elements of each list. In the case
211  * that there were no common elements, a format conversion is necessary.
212  * Otherwise, the lists are merged, and all other links which reference
213  * either of the format lists involved in the merge are also affected.
214  *
215  * For example, consider the filter chain:
216  * filter (a) --> (b) filter (b) --> (c) filter
217  *
218  * where the letters in parenthesis indicate a list of formats supported on
219  * the input or output of the link. Suppose the lists are as follows:
220  * (a) = {A, B}
221  * (b) = {A, B, C}
222  * (c) = {B, C}
223  *
224  * First, the first link's lists are merged, yielding:
225  * filter (a) --> (a) filter (a) --> (c) filter
226  *
227  * Notice that format list (b) now refers to the same list as filter list (a).
228  * Next, the lists for the second link are merged, yielding:
229  * filter (a) --> (a) filter (a) --> (a) filter
230  *
231  * where (a) = {B}.
232  *
233  * Unfortunately, when the format lists at the two ends of a link are merged,
234  * we must ensure that all links which reference either pre-merge format list
235  * get updated as well. Therefore, we have the format list structure store a
236  * pointer to each of the pointers to itself.
237  */
238 typedef struct AVFilterFormats {
239     unsigned format_count;      ///< number of formats
240     int64_t *formats;           ///< list of media formats
241
242     unsigned refcount;          ///< number of references to this list
243     struct AVFilterFormats ***refs; ///< references to this list
244 }  AVFilterFormats;
245
246 /**
247  * Create a list of supported formats. This is intended for use in
248  * AVFilter->query_formats().
249  *
250  * @param fmts list of media formats, terminated by -1. If NULL an
251  *        empty list is created.
252  * @return the format list, with no existing references
253  */
254 AVFilterFormats *avfilter_make_format_list(const int *fmts);
255 AVFilterFormats *avfilter_make_format64_list(const int64_t *fmts);
256
257 /**
258  * Add fmt to the list of media formats contained in *avff.
259  * If *avff is NULL the function allocates the filter formats struct
260  * and puts its pointer in *avff.
261  *
262  * @return a non negative value in case of success, or a negative
263  * value corresponding to an AVERROR code in case of error
264  */
265 int avfilter_add_format(AVFilterFormats **avff, int64_t fmt);
266
267 #if FF_API_OLD_ALL_FORMATS_API
268 /**
269  * @deprecated Use avfilter_make_all_formats() instead.
270  */
271 attribute_deprecated
272 AVFilterFormats *avfilter_all_formats(enum AVMediaType type);
273 #endif
274
275 /**
276  * Return a list of all formats supported by FFmpeg for the given media type.
277  */
278 AVFilterFormats *avfilter_make_all_formats(enum AVMediaType type);
279
280 /**
281  * A list of all channel layouts supported by libavfilter.
282  */
283 extern const int64_t avfilter_all_channel_layouts[];
284
285 /**
286  * Return a list of all channel layouts supported by FFmpeg.
287  */
288 AVFilterFormats *avfilter_make_all_channel_layouts(void);
289
290 /**
291  * Return a list of all audio packing formats.
292  */
293 AVFilterFormats *avfilter_make_all_packing_formats(void);
294
295 /**
296  * Return a format list which contains the intersection of the formats of
297  * a and b. Also, all the references of a, all the references of b, and
298  * a and b themselves will be deallocated.
299  *
300  * If a and b do not share any common formats, neither is modified, and NULL
301  * is returned.
302  */
303 AVFilterFormats *avfilter_merge_formats(AVFilterFormats *a, AVFilterFormats *b);
304
305 /**
306  * Add *ref as a new reference to formats.
307  * That is the pointers will point like in the ascii art below:
308  *   ________
309  *  |formats |<--------.
310  *  |  ____  |     ____|___________________
311  *  | |refs| |    |  __|_
312  *  | |* * | |    | |  | |  AVFilterLink
313  *  | |* *--------->|*ref|
314  *  | |____| |    | |____|
315  *  |________|    |________________________
316  */
317 void avfilter_formats_ref(AVFilterFormats *formats, AVFilterFormats **ref);
318
319 /**
320  * If *ref is non-NULL, remove *ref as a reference to the format list
321  * it currently points to, deallocates that list if this was the last
322  * reference, and sets *ref to NULL.
323  *
324  *         Before                                 After
325  *   ________                               ________         NULL
326  *  |formats |<--------.                   |formats |         ^
327  *  |  ____  |     ____|________________   |  ____  |     ____|________________
328  *  | |refs| |    |  __|_                  | |refs| |    |  __|_
329  *  | |* * | |    | |  | |  AVFilterLink   | |* * | |    | |  | |  AVFilterLink
330  *  | |* *--------->|*ref|                 | |*   | |    | |*ref|
331  *  | |____| |    | |____|                 | |____| |    | |____|
332  *  |________|    |_____________________   |________|    |_____________________
333  */
334 void avfilter_formats_unref(AVFilterFormats **ref);
335
336 /**
337  *
338  *         Before                                 After
339  *   ________                         ________
340  *  |formats |<---------.            |formats |<---------.
341  *  |  ____  |       ___|___         |  ____  |       ___|___
342  *  | |refs| |      |   |   |        | |refs| |      |   |   |   NULL
343  *  | |* *--------->|*oldref|        | |* *--------->|*newref|     ^
344  *  | |* * | |      |_______|        | |* * | |      |_______|  ___|___
345  *  | |____| |                       | |____| |                |   |   |
346  *  |________|                       |________|                |*oldref|
347  *                                                             |_______|
348  */
349 void avfilter_formats_changeref(AVFilterFormats **oldref,
350                                 AVFilterFormats **newref);
351
352 /**
353  * A filter pad used for either input or output.
354  */
355 struct AVFilterPad {
356     /**
357      * Pad name. The name is unique among inputs and among outputs, but an
358      * input may have the same name as an output. This may be NULL if this
359      * pad has no need to ever be referenced by name.
360      */
361     const char *name;
362
363     /**
364      * AVFilterPad type. Only video supported now, hopefully someone will
365      * add audio in the future.
366      */
367     enum AVMediaType type;
368
369     /**
370      * Minimum required permissions on incoming buffers. Any buffer with
371      * insufficient permissions will be automatically copied by the filter
372      * system to a new buffer which provides the needed access permissions.
373      *
374      * Input pads only.
375      */
376     int min_perms;
377
378     /**
379      * Permissions which are not accepted on incoming buffers. Any buffer
380      * which has any of these permissions set will be automatically copied
381      * by the filter system to a new buffer which does not have those
382      * permissions. This can be used to easily disallow buffers with
383      * AV_PERM_REUSE.
384      *
385      * Input pads only.
386      */
387     int rej_perms;
388
389     /**
390      * Callback called before passing the first slice of a new frame. If
391      * NULL, the filter layer will default to storing a reference to the
392      * picture inside the link structure.
393      *
394      * Input video pads only.
395      */
396     void (*start_frame)(AVFilterLink *link, AVFilterBufferRef *picref);
397
398     /**
399      * Callback function to get a video buffer. If NULL, the filter system will
400      * use avfilter_default_get_video_buffer().
401      *
402      * Input video pads only.
403      */
404     AVFilterBufferRef *(*get_video_buffer)(AVFilterLink *link, int perms, int w, int h);
405
406     /**
407      * Callback function to get an audio buffer. If NULL, the filter system will
408      * use avfilter_default_get_audio_buffer().
409      *
410      * Input audio pads only.
411      */
412     AVFilterBufferRef *(*get_audio_buffer)(AVFilterLink *link, int perms, int nb_samples);
413
414     /**
415      * Callback called after the slices of a frame are completely sent. If
416      * NULL, the filter layer will default to releasing the reference stored
417      * in the link structure during start_frame().
418      *
419      * Input video pads only.
420      */
421     void (*end_frame)(AVFilterLink *link);
422
423     /**
424      * Slice drawing callback. This is where a filter receives video data
425      * and should do its processing.
426      *
427      * Input video pads only.
428      */
429     void (*draw_slice)(AVFilterLink *link, int y, int height, int slice_dir);
430
431     /**
432      * Samples filtering callback. This is where a filter receives audio data
433      * and should do its processing.
434      *
435      * Input audio pads only.
436      */
437     void (*filter_samples)(AVFilterLink *link, AVFilterBufferRef *samplesref);
438
439     /**
440      * Frame poll callback. This returns the number of immediately available
441      * samples. It should return a positive value if the next request_frame()
442      * is guaranteed to return one frame (with no delay).
443      *
444      * Defaults to just calling the source poll_frame() method.
445      *
446      * Output video pads only.
447      */
448     int (*poll_frame)(AVFilterLink *link);
449
450     /**
451      * Frame request callback. A call to this should result in at least one
452      * frame being output over the given link. This should return zero on
453      * success, and another value on error.
454      *
455      * Output video pads only.
456      */
457     int (*request_frame)(AVFilterLink *link);
458
459     /**
460      * Link configuration callback.
461      *
462      * For output pads, this should set the following link properties:
463      * video: width, height, sample_aspect_ratio, time_base
464      * audio: sample_rate.
465      *
466      * This should NOT set properties such as format, channel_layout, etc which
467      * are negotiated between filters by the filter system using the
468      * query_formats() callback before this function is called.
469      *
470      * For input pads, this should check the properties of the link, and update
471      * the filter's internal state as necessary.
472      *
473      * For both input and output pads, this should return zero on success,
474      * and another value on error.
475      */
476     int (*config_props)(AVFilterLink *link);
477 };
478
479 /** default handler for start_frame() for video inputs */
480 void avfilter_default_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
481
482 /** default handler for draw_slice() for video inputs */
483 void avfilter_default_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
484
485 /** default handler for end_frame() for video inputs */
486 void avfilter_default_end_frame(AVFilterLink *link);
487
488 /** default handler for filter_samples() for audio inputs */
489 void avfilter_default_filter_samples(AVFilterLink *link, AVFilterBufferRef *samplesref);
490
491 /** default handler for get_video_buffer() for video inputs */
492 AVFilterBufferRef *avfilter_default_get_video_buffer(AVFilterLink *link,
493                                                      int perms, int w, int h);
494
495 /** default handler for get_audio_buffer() for audio inputs */
496 AVFilterBufferRef *avfilter_default_get_audio_buffer(AVFilterLink *link,
497                                                      int perms, int nb_samples);
498
499 /**
500  * Helpers for query_formats() which set all links to the same list of
501  * formats/layouts. If there are no links hooked to this filter, the list
502  * of formats is freed.
503  */
504 void avfilter_set_common_pixel_formats(AVFilterContext *ctx, AVFilterFormats *formats);
505 void avfilter_set_common_sample_formats(AVFilterContext *ctx, AVFilterFormats *formats);
506 void avfilter_set_common_channel_layouts(AVFilterContext *ctx, AVFilterFormats *formats);
507 void avfilter_set_common_packing_formats(AVFilterContext *ctx, AVFilterFormats *formats);
508
509 /** Default handler for query_formats() */
510 int avfilter_default_query_formats(AVFilterContext *ctx);
511
512 /** start_frame() handler for filters which simply pass video along */
513 void avfilter_null_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
514
515 /** draw_slice() handler for filters which simply pass video along */
516 void avfilter_null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
517
518 /** end_frame() handler for filters which simply pass video along */
519 void avfilter_null_end_frame(AVFilterLink *link);
520
521 /** filter_samples() handler for filters which simply pass audio along */
522 void avfilter_null_filter_samples(AVFilterLink *link, AVFilterBufferRef *samplesref);
523
524 /** get_video_buffer() handler for filters which simply pass video along */
525 AVFilterBufferRef *avfilter_null_get_video_buffer(AVFilterLink *link,
526                                                   int perms, int w, int h);
527
528 /** get_audio_buffer() handler for filters which simply pass audio along */
529 AVFilterBufferRef *avfilter_null_get_audio_buffer(AVFilterLink *link,
530                                                   int perms, int nb_samples);
531
532 /**
533  * Filter definition. This defines the pads a filter contains, and all the
534  * callback functions used to interact with the filter.
535  */
536 typedef struct AVFilter {
537     const char *name;         ///< filter name
538
539     int priv_size;      ///< size of private data to allocate for the filter
540
541     /**
542      * Filter initialization function. Args contains the user-supplied
543      * parameters. FIXME: maybe an AVOption-based system would be better?
544      * opaque is data provided by the code requesting creation of the filter,
545      * and is used to pass data to the filter.
546      */
547     int (*init)(AVFilterContext *ctx, const char *args, void *opaque);
548
549     /**
550      * Filter uninitialization function. Should deallocate any memory held
551      * by the filter, release any buffer references, etc. This does not need
552      * to deallocate the AVFilterContext->priv memory itself.
553      */
554     void (*uninit)(AVFilterContext *ctx);
555
556     /**
557      * Queries formats/layouts supported by the filter and its pads, and sets
558      * the in_formats/in_chlayouts for links connected to its output pads,
559      * and out_formats/out_chlayouts for links connected to its input pads.
560      *
561      * @return zero on success, a negative value corresponding to an
562      * AVERROR code otherwise
563      */
564     int (*query_formats)(AVFilterContext *);
565
566     const AVFilterPad *inputs;  ///< NULL terminated list of inputs. NULL if none
567     const AVFilterPad *outputs; ///< NULL terminated list of outputs. NULL if none
568
569     /**
570      * A description for the filter. You should use the
571      * NULL_IF_CONFIG_SMALL() macro to define it.
572      */
573     const char *description;
574
575     /**
576      * Make the filter instance process a command.
577      *
578      * @param cmd    the command to process, for handling simplicity all commands must be alphanumeric only
579      * @param arg    the argument for the command
580      * @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.
581      * @param flags  if AVFILTER_CMD_FLAG_FAST is set and the command would be
582      *               timeconsuming then a filter should treat it like an unsupported command
583      *
584      * @returns >=0 on success otherwise an error code.
585      *          AVERROR(ENOSYS) on unsupported commands
586      */
587     int (*process_command)(AVFilterContext *, const char *cmd, const char *arg, char *res, int res_len, int flags);
588 } AVFilter;
589
590 /** An instance of a filter */
591 struct AVFilterContext {
592     const AVClass *av_class;              ///< needed for av_log()
593
594     AVFilter *filter;               ///< the AVFilter of which this is an instance
595
596     char *name;                     ///< name of this filter instance
597
598     unsigned input_count;           ///< number of input pads
599     AVFilterPad   *input_pads;      ///< array of input pads
600     AVFilterLink **inputs;          ///< array of pointers to input links
601
602     unsigned output_count;          ///< number of output pads
603     AVFilterPad   *output_pads;     ///< array of output pads
604     AVFilterLink **outputs;         ///< array of pointers to output links
605
606     void *priv;                     ///< private data for use by the filter
607
608     struct AVFilterCommand *command_queue;
609 };
610
611 enum AVFilterPacking {
612     AVFILTER_PACKED = 0,
613     AVFILTER_PLANAR,
614 };
615
616 /**
617  * A link between two filters. This contains pointers to the source and
618  * destination filters between which this link exists, and the indexes of
619  * the pads involved. In addition, this link also contains the parameters
620  * which have been negotiated and agreed upon between the filter, such as
621  * image dimensions, format, etc.
622  */
623 struct AVFilterLink {
624     AVFilterContext *src;       ///< source filter
625     AVFilterPad *srcpad;        ///< output pad on the source filter
626
627     AVFilterContext *dst;       ///< dest filter
628     AVFilterPad *dstpad;        ///< input pad on the dest filter
629
630     /** stage of the initialization of the link properties (dimensions, etc) */
631     enum {
632         AVLINK_UNINIT = 0,      ///< not started
633         AVLINK_STARTINIT,       ///< started, but incomplete
634         AVLINK_INIT             ///< complete
635     } init_state;
636
637     enum AVMediaType type;      ///< filter media type
638
639     /* These parameters apply only to video */
640     int w;                      ///< agreed upon image width
641     int h;                      ///< agreed upon image height
642     AVRational sample_aspect_ratio; ///< agreed upon sample aspect ratio
643     /* These parameters apply only to audio */
644     int64_t channel_layout;     ///< channel layout of current buffer (see libavutil/audioconvert.h)
645 #if LIBAVFILTER_VERSION_MAJOR < 3
646     int64_t sample_rate;        ///< samples per second
647 #else
648     int sample_rate;            ///< samples per second
649 #endif
650     int planar;                 ///< agreed upon packing mode of audio buffers. true if planar.
651
652     int format;                 ///< agreed upon media format
653
654     /**
655      * Lists of formats and channel layouts supported by the input and output
656      * filters respectively. These lists are used for negotiating the format
657      * to actually be used, which will be loaded into the format and
658      * channel_layout members, above, when chosen.
659      *
660      */
661     AVFilterFormats *in_formats;
662     AVFilterFormats *out_formats;
663
664     AVFilterFormats *in_chlayouts;
665     AVFilterFormats *out_chlayouts;
666     AVFilterFormats *in_packing;
667     AVFilterFormats *out_packing;
668
669     /**
670      * The buffer reference currently being sent across the link by the source
671      * filter. This is used internally by the filter system to allow
672      * automatic copying of buffers which do not have sufficient permissions
673      * for the destination. This should not be accessed directly by the
674      * filters.
675      */
676     AVFilterBufferRef *src_buf;
677
678     AVFilterBufferRef *cur_buf;
679     AVFilterBufferRef *out_buf;
680
681     /**
682      * Define the time base used by the PTS of the frames/samples
683      * which will pass through this link.
684      * During the configuration stage, each filter is supposed to
685      * change only the output timebase, while the timebase of the
686      * input link is assumed to be an unchangeable property.
687      */
688     AVRational time_base;
689
690     struct AVFilterPool *pool;
691 };
692
693 /**
694  * Link two filters together.
695  *
696  * @param src    the source filter
697  * @param srcpad index of the output pad on the source filter
698  * @param dst    the destination filter
699  * @param dstpad index of the input pad on the destination filter
700  * @return       zero on success
701  */
702 int avfilter_link(AVFilterContext *src, unsigned srcpad,
703                   AVFilterContext *dst, unsigned dstpad);
704
705 /**
706  * Free the link in *link, and set its pointer to NULL.
707  */
708 void avfilter_link_free(AVFilterLink **link);
709
710 /**
711  * Negotiate the media format, dimensions, etc of all inputs to a filter.
712  *
713  * @param filter the filter to negotiate the properties for its inputs
714  * @return       zero on successful negotiation
715  */
716 int avfilter_config_links(AVFilterContext *filter);
717
718 /**
719  * Request a picture buffer with a specific set of permissions.
720  *
721  * @param link  the output link to the filter from which the buffer will
722  *              be requested
723  * @param perms the required access permissions
724  * @param w     the minimum width of the buffer to allocate
725  * @param h     the minimum height of the buffer to allocate
726  * @return      A reference to the buffer. This must be unreferenced with
727  *              avfilter_unref_buffer when you are finished with it.
728  */
729 AVFilterBufferRef *avfilter_get_video_buffer(AVFilterLink *link, int perms,
730                                           int w, int h);
731
732 /**
733  * Create a buffer reference wrapped around an already allocated image
734  * buffer.
735  *
736  * @param data pointers to the planes of the image to reference
737  * @param linesize linesizes for the planes of the image to reference
738  * @param perms the required access permissions
739  * @param w the width of the image specified by the data and linesize arrays
740  * @param h the height of the image specified by the data and linesize arrays
741  * @param format the pixel format of the image specified by the data and linesize arrays
742  */
743 AVFilterBufferRef *
744 avfilter_get_video_buffer_ref_from_arrays(uint8_t * const data[4], const int linesize[4], int perms,
745                                           int w, int h, enum PixelFormat format);
746
747 /**
748  * Request an audio samples buffer with a specific set of permissions.
749  *
750  * @param link           the output link to the filter from which the buffer will
751  *                       be requested
752  * @param perms          the required access permissions
753  * @param nb_samples     the number of samples per channel
754  * @return               A reference to the samples. This must be unreferenced with
755  *                       avfilter_unref_buffer when you are finished with it.
756  */
757 AVFilterBufferRef *avfilter_get_audio_buffer(AVFilterLink *link, int perms,
758                                              int nb_samples);
759
760 /**
761  * Create an audio buffer reference wrapped around an already
762  * allocated samples buffer.
763  *
764  * @param data           pointers to the samples plane buffers
765  * @param linesize       linesize for the samples plane buffers
766  * @param perms          the required access permissions
767  * @param nb_samples     number of samples per channel
768  * @param sample_fmt     the format of each sample in the buffer to allocate
769  * @param channel_layout the channel layout of the buffer
770  * @param planar         audio data layout - planar or packed
771  */
772 AVFilterBufferRef *
773 avfilter_get_audio_buffer_ref_from_arrays(uint8_t *data[8], int linesize[8], int perms,
774                                           int nb_samples, enum AVSampleFormat sample_fmt,
775                                           int64_t channel_layout, int planar);
776
777 /**
778  * Request an input frame from the filter at the other end of the link.
779  *
780  * @param link the input link
781  * @return     zero on success
782  */
783 int avfilter_request_frame(AVFilterLink *link);
784
785 /**
786  * Poll a frame from the filter chain.
787  *
788  * @param  link the input link
789  * @return the number of immediately available frames, a negative
790  * number in case of error
791  */
792 int avfilter_poll_frame(AVFilterLink *link);
793
794 /**
795  * Notifie the next filter of the start of a frame.
796  *
797  * @param link   the output link the frame will be sent over
798  * @param picref A reference to the frame about to be sent. The data for this
799  *               frame need only be valid once draw_slice() is called for that
800  *               portion. The receiving filter will free this reference when
801  *               it no longer needs it.
802  */
803 void avfilter_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
804
805 /**
806  * Notifie the next filter that the current frame has finished.
807  *
808  * @param link the output link the frame was sent over
809  */
810 void avfilter_end_frame(AVFilterLink *link);
811
812 /**
813  * Send a slice to the next filter.
814  *
815  * Slices have to be provided in sequential order, either in
816  * top-bottom or bottom-top order. If slices are provided in
817  * non-sequential order the behavior of the function is undefined.
818  *
819  * @param link the output link over which the frame is being sent
820  * @param y    offset in pixels from the top of the image for this slice
821  * @param h    height of this slice in pixels
822  * @param slice_dir the assumed direction for sending slices,
823  *             from the top slice to the bottom slice if the value is 1,
824  *             from the bottom slice to the top slice if the value is -1,
825  *             for other values the behavior of the function is undefined.
826  */
827 void avfilter_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
828
829 #define AVFILTER_CMD_FLAG_ONE   1 ///< Stop once a filter understood the command (for target=all for example), fast filters are favored automatically
830 #define AVFILTER_CMD_FLAG_FAST  2 ///< Only execute command when its fast (like a video out that supports contrast adjustment in hw)
831
832 /**
833  * Make the filter instance process a command.
834  * It is recommanded to use avfilter_graph_send_command().
835  */
836 int avfilter_process_command(AVFilterContext *filter, const char *cmd, const char *arg, char *res, int res_len, int flags);
837
838 /**
839  * Send a buffer of audio samples to the next filter.
840  *
841  * @param link       the output link over which the audio samples are being sent
842  * @param samplesref a reference to the buffer of audio samples being sent. The
843  *                   receiving filter will free this reference when it no longer
844  *                   needs it or pass it on to the next filter.
845  */
846 void avfilter_filter_samples(AVFilterLink *link, AVFilterBufferRef *samplesref);
847
848 /** Initialize the filter system. Register all builtin filters. */
849 void avfilter_register_all(void);
850
851 /** Uninitialize the filter system. Unregister all filters. */
852 void avfilter_uninit(void);
853
854 /**
855  * Register a filter. This is only needed if you plan to use
856  * avfilter_get_by_name later to lookup the AVFilter structure by name. A
857  * filter can still by instantiated with avfilter_open even if it is not
858  * registered.
859  *
860  * @param filter the filter to register
861  * @return 0 if the registration was succesfull, a negative value
862  * otherwise
863  */
864 int avfilter_register(AVFilter *filter);
865
866 /**
867  * Get a filter definition matching the given name.
868  *
869  * @param name the filter name to find
870  * @return     the filter definition, if any matching one is registered.
871  *             NULL if none found.
872  */
873 AVFilter *avfilter_get_by_name(const char *name);
874
875 /**
876  * If filter is NULL, returns a pointer to the first registered filter pointer,
877  * if filter is non-NULL, returns the next pointer after filter.
878  * If the returned pointer points to NULL, the last registered filter
879  * was already reached.
880  */
881 AVFilter **av_filter_next(AVFilter **filter);
882
883 /**
884  * Create a filter instance.
885  *
886  * @param filter_ctx put here a pointer to the created filter context
887  * on success, NULL on failure
888  * @param filter    the filter to create an instance of
889  * @param inst_name Name to give to the new instance. Can be NULL for none.
890  * @return >= 0 in case of success, a negative error code otherwise
891  */
892 int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name);
893
894 /**
895  * Initialize a filter.
896  *
897  * @param filter the filter to initialize
898  * @param args   A string of parameters to use when initializing the filter.
899  *               The format and meaning of this string varies by filter.
900  * @param opaque Any extra non-string data needed by the filter. The meaning
901  *               of this parameter varies by filter.
902  * @return       zero on success
903  */
904 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
905
906 /**
907  * Free a filter context.
908  *
909  * @param filter the filter to free
910  */
911 void avfilter_free(AVFilterContext *filter);
912
913 /**
914  * Insert a filter in the middle of an existing link.
915  *
916  * @param link the link into which the filter should be inserted
917  * @param filt the filter to be inserted
918  * @param filt_srcpad_idx the input pad on the filter to connect
919  * @param filt_dstpad_idx the output pad on the filter to connect
920  * @return     zero on success
921  */
922 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
923                            unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
924
925 /**
926  * Insert a new pad.
927  *
928  * @param idx Insertion point. Pad is inserted at the end if this point
929  *            is beyond the end of the list of pads.
930  * @param count Pointer to the number of pads in the list
931  * @param padidx_off Offset within an AVFilterLink structure to the element
932  *                   to increment when inserting a new pad causes link
933  *                   numbering to change
934  * @param pads Pointer to the pointer to the beginning of the list of pads
935  * @param links Pointer to the pointer to the beginning of the list of links
936  * @param newpad The new pad to add. A copy is made when adding.
937  */
938 void avfilter_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
939                          AVFilterPad **pads, AVFilterLink ***links,
940                          AVFilterPad *newpad);
941
942 /** Insert a new input pad for the filter. */
943 static inline void avfilter_insert_inpad(AVFilterContext *f, unsigned index,
944                                          AVFilterPad *p)
945 {
946     avfilter_insert_pad(index, &f->input_count, offsetof(AVFilterLink, dstpad),
947                         &f->input_pads, &f->inputs, p);
948 }
949
950 /** Insert a new output pad for the filter. */
951 static inline void avfilter_insert_outpad(AVFilterContext *f, unsigned index,
952                                           AVFilterPad *p)
953 {
954     avfilter_insert_pad(index, &f->output_count, offsetof(AVFilterLink, srcpad),
955                         &f->output_pads, &f->outputs, p);
956 }
957
958 #endif /* AVFILTER_AVFILTER_H */