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