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