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