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