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