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