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