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