Clarify AVFilterBuffer documentation, make it clear that it is not
[ffmpeg.git] / libavfilter / avfilter.h
1 /*
2  * filter layer
3  * copyright (c) 2007 Bobby Bingham
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #ifndef AVFILTER_AVFILTER_H
23 #define AVFILTER_AVFILTER_H
24
25 #include "libavutil/avutil.h"
26
27 #define LIBAVFILTER_VERSION_MAJOR  1
28 #define LIBAVFILTER_VERSION_MINOR 25
29 #define LIBAVFILTER_VERSION_MICRO  0
30
31 #define LIBAVFILTER_VERSION_INT AV_VERSION_INT(LIBAVFILTER_VERSION_MAJOR, \
32                                                LIBAVFILTER_VERSION_MINOR, \
33                                                LIBAVFILTER_VERSION_MICRO)
34 #define LIBAVFILTER_VERSION     AV_VERSION(LIBAVFILTER_VERSION_MAJOR,   \
35                                            LIBAVFILTER_VERSION_MINOR,   \
36                                            LIBAVFILTER_VERSION_MICRO)
37 #define LIBAVFILTER_BUILD       LIBAVFILTER_VERSION_INT
38
39 #include <stddef.h>
40 #include "libavcodec/avcodec.h"
41
42 /**
43  * Return the LIBAVFILTER_VERSION_INT constant.
44  */
45 unsigned avfilter_version(void);
46
47 /**
48  * Return the libavfilter build-time configuration.
49  */
50 const char *avfilter_configuration(void);
51
52 /**
53  * Return the libavfilter license.
54  */
55 const char *avfilter_license(void);
56
57
58 typedef struct AVFilterContext AVFilterContext;
59 typedef struct AVFilterLink    AVFilterLink;
60 typedef struct AVFilterPad     AVFilterPad;
61
62 /**
63  * A reference-counted buffer data type used by the filter system. Filters
64  * should not store pointers to this structure directly, but instead use the
65  * AVFilterPicRef structure below.
66  */
67 typedef struct AVFilterBuffer
68 {
69     uint8_t *data[4];           ///< buffer data for each plane
70     int linesize[4];            ///< number of bytes per line
71     enum PixelFormat format;    ///< colorspace
72
73     unsigned refcount;          ///< number of references to this buffer
74
75     /** private data to be used by a custom free function */
76     void *priv;
77     /**
78      * A pointer to the function to deallocate this buffer if the default
79      * function is not sufficient. This could, for example, add the memory
80      * back into a memory pool to be reused later without the overhead of
81      * reallocating it from scratch.
82      */
83     void (*free)(struct AVFilterBuffer *buf);
84 } AVFilterBuffer;
85
86 /**
87  * A reference to an AVFilterBuffer. Since filters can manipulate the origin of
88  * a picture to, for example, crop image without any memcpy, the picture origin
89  * and dimensions are per-reference properties. Linesize is also useful for
90  * image flipping, frame to field filters, etc, and so is also per-reference.
91  *
92  * TODO: add anything necessary for frame reordering
93  */
94 typedef struct AVFilterPicRef
95 {
96     AVFilterBuffer *pic;        ///< the picture that this is a reference to
97     uint8_t *data[4];           ///< picture data for each plane
98     int linesize[4];            ///< number of bytes per line
99     int w;                      ///< image width
100     int h;                      ///< image height
101
102     int64_t pts;                ///< presentation timestamp in units of 1/AV_TIME_BASE
103     int64_t pos;                ///< byte position in stream, -1 if unknown
104
105     AVRational pixel_aspect;    ///< pixel aspect ratio
106
107     int perms;                  ///< permissions
108 #define AV_PERM_READ     0x01   ///< can read from the buffer
109 #define AV_PERM_WRITE    0x02   ///< can write to the buffer
110 #define AV_PERM_PRESERVE 0x04   ///< nobody else can overwrite the buffer
111 #define AV_PERM_REUSE    0x08   ///< can output the buffer multiple times, with the same contents each time
112 #define AV_PERM_REUSE2   0x10   ///< can output the buffer multiple times, modified each time
113
114     int interlaced;             ///< is frame interlaced
115     int top_field_first;
116 } AVFilterPicRef;
117
118 /**
119  * Copy properties of src to dst, without copying the actual video
120  * data.
121  */
122 static inline void avfilter_copy_picref_props(AVFilterPicRef *dst, AVFilterPicRef *src)
123 {
124     dst->pts             = src->pts;
125     dst->pos             = src->pos;
126     dst->pixel_aspect    = src->pixel_aspect;
127     dst->interlaced      = src->interlaced;
128     dst->top_field_first = src->top_field_first;
129 }
130
131 /**
132  * Add a new reference to a picture.
133  * @param ref   an existing reference to the picture
134  * @param pmask a bitmask containing the allowable permissions in the new
135  *              reference
136  * @return      a new reference to the picture with the same properties as the
137  *              old, excluding any permissions denied by pmask
138  */
139 AVFilterPicRef *avfilter_ref_pic(AVFilterPicRef *ref, int pmask);
140
141 /**
142  * Remove a reference to a picture. If this is the last reference to the
143  * picture, the picture itself is also automatically freed.
144  * @param ref reference to the picture
145  */
146 void avfilter_unref_pic(AVFilterPicRef *ref);
147
148 /**
149  * A list of supported formats for one end of a filter link. This is used
150  * during the format negotiation process to try to pick the best format to
151  * use to minimize the number of necessary conversions. Each filter gives a
152  * list of the formats supported by each input and output pad. The list
153  * given for each pad need not be distinct - they may be references to the
154  * same list of formats, as is often the case when a filter supports multiple
155  * formats, but will always output the same format as it is given in input.
156  *
157  * In this way, a list of possible input formats and a list of possible
158  * output formats are associated with each link. When a set of formats is
159  * negotiated over a link, the input and output lists are merged to form a
160  * new list containing only the common elements of each list. In the case
161  * that there were no common elements, a format conversion is necessary.
162  * Otherwise, the lists are merged, and all other links which reference
163  * either of the format lists involved in the merge are also affected.
164  *
165  * For example, consider the filter chain:
166  * filter (a) --> (b) filter (b) --> (c) filter
167  *
168  * where the letters in parenthesis indicate a list of formats supported on
169  * the input or output of the link. Suppose the lists are as follows:
170  * (a) = {A, B}
171  * (b) = {A, B, C}
172  * (c) = {B, C}
173  *
174  * First, the first link's lists are merged, yielding:
175  * filter (a) --> (a) filter (a) --> (c) filter
176  *
177  * Notice that format list (b) now refers to the same list as filter list (a).
178  * Next, the lists for the second link are merged, yielding:
179  * filter (a) --> (a) filter (a) --> (a) filter
180  *
181  * where (a) = {B}.
182  *
183  * Unfortunately, when the format lists at the two ends of a link are merged,
184  * we must ensure that all links which reference either pre-merge format list
185  * get updated as well. Therefore, we have the format list structure store a
186  * pointer to each of the pointers to itself.
187  */
188 typedef struct AVFilterFormats AVFilterFormats;
189 struct AVFilterFormats
190 {
191     unsigned format_count;      ///< number of formats
192     enum PixelFormat *formats;  ///< list of pixel formats
193
194     unsigned refcount;          ///< number of references to this list
195     AVFilterFormats ***refs;    ///< references to this list
196 };
197
198 /**
199  * Create a list of supported formats. This is intended for use in
200  * AVFilter->query_formats().
201  * @param pix_fmts list of pixel formats, terminated by PIX_FMT_NONE
202  * @return the format list, with no existing references
203  */
204 AVFilterFormats *avfilter_make_format_list(const enum PixelFormat *pix_fmts);
205
206 /**
207  * Add pix_fmt to the list of pixel formats contained in *avff.
208  * If *avff is NULL the function allocates the filter formats struct
209  * and puts its pointer in *avff.
210  *
211  * @return a non negative value in case of success, or a negative
212  * value corresponding to an AVERROR code in case of error
213  */
214 int avfilter_add_colorspace(AVFilterFormats **avff, enum PixelFormat pix_fmt);
215
216 /**
217  * Return a list of all colorspaces supported by FFmpeg.
218  */
219 AVFilterFormats *avfilter_all_colorspaces(void);
220
221 /**
222  * Return a format list which contains the intersection of the formats of
223  * a and b. Also, all the references of a, all the references of b, and
224  * a and b themselves will be deallocated.
225  *
226  * If a and b do not share any common formats, neither is modified, and NULL
227  * is returned.
228  */
229 AVFilterFormats *avfilter_merge_formats(AVFilterFormats *a, AVFilterFormats *b);
230
231 /**
232  * Add *ref as a new reference to formats.
233  * That is the pointers will point like in the ascii art below:
234  *   ________
235  *  |formats |<--------.
236  *  |  ____  |     ____|___________________
237  *  | |refs| |    |  __|_
238  *  | |* * | |    | |  | |  AVFilterLink
239  *  | |* *--------->|*ref|
240  *  | |____| |    | |____|
241  *  |________|    |________________________
242  */
243 void avfilter_formats_ref(AVFilterFormats *formats, AVFilterFormats **ref);
244
245 /**
246  * If *ref is non-NULL, remove *ref as a reference to the format list
247  * it currently points to, deallocates that list if this was the last
248  * reference, and sets *ref to NULL.
249  *
250  *         Before                                 After
251  *   ________                               ________         NULL
252  *  |formats |<--------.                   |formats |         ^
253  *  |  ____  |     ____|________________   |  ____  |     ____|________________
254  *  | |refs| |    |  __|_                  | |refs| |    |  __|_
255  *  | |* * | |    | |  | |  AVFilterLink   | |* * | |    | |  | |  AVFilterLink
256  *  | |* *--------->|*ref|                 | |*   | |    | |*ref|
257  *  | |____| |    | |____|                 | |____| |    | |____|
258  *  |________|    |_____________________   |________|    |_____________________
259  */
260 void avfilter_formats_unref(AVFilterFormats **ref);
261
262 /**
263  *
264  *         Before                                 After
265  *   ________                         ________
266  *  |formats |<---------.            |formats |<---------.
267  *  |  ____  |       ___|___         |  ____  |       ___|___
268  *  | |refs| |      |   |   |        | |refs| |      |   |   |   NULL
269  *  | |* *--------->|*oldref|        | |* *--------->|*newref|     ^
270  *  | |* * | |      |_______|        | |* * | |      |_______|  ___|___
271  *  | |____| |                       | |____| |                |   |   |
272  *  |________|                       |________|                |*oldref|
273  *                                                             |_______|
274  */
275 void avfilter_formats_changeref(AVFilterFormats **oldref,
276                                 AVFilterFormats **newref);
277
278 /**
279  * A filter pad used for either input or output.
280  */
281 struct AVFilterPad
282 {
283     /**
284      * Pad name. The name is unique among inputs and among outputs, but an
285      * input may have the same name as an output. This may be NULL if this
286      * pad has no need to ever be referenced by name.
287      */
288     const char *name;
289
290     /**
291      * AVFilterPad type. Only video supported now, hopefully someone will
292      * add audio in the future.
293      */
294     enum AVMediaType type;
295
296     /**
297      * Minimum required permissions on incoming buffers. Any buffer with
298      * insufficient permissions will be automatically copied by the filter
299      * system to a new buffer which provides the needed access permissions.
300      *
301      * Input pads only.
302      */
303     int min_perms;
304
305     /**
306      * Permissions which are not accepted on incoming buffers. Any buffer
307      * which has any of these permissions set will be automatically copied
308      * by the filter system to a new buffer which does not have those
309      * permissions. This can be used to easily disallow buffers with
310      * AV_PERM_REUSE.
311      *
312      * Input pads only.
313      */
314     int rej_perms;
315
316     /**
317      * Callback called before passing the first slice of a new frame. If
318      * NULL, the filter layer will default to storing a reference to the
319      * picture inside the link structure.
320      *
321      * Input video pads only.
322      */
323     void (*start_frame)(AVFilterLink *link, AVFilterPicRef *picref);
324
325     /**
326      * Callback function to get a buffer. If NULL, the filter system will
327      * use avfilter_default_get_video_buffer().
328      *
329      * Input video pads only.
330      */
331     AVFilterPicRef *(*get_video_buffer)(AVFilterLink *link, int perms, int w, int h);
332
333     /**
334      * Callback called after the slices of a frame are completely sent. If
335      * NULL, the filter layer will default to releasing the reference stored
336      * in the link structure during start_frame().
337      *
338      * Input video pads only.
339      */
340     void (*end_frame)(AVFilterLink *link);
341
342     /**
343      * Slice drawing callback. This is where a filter receives video data
344      * and should do its processing.
345      *
346      * Input video pads only.
347      */
348     void (*draw_slice)(AVFilterLink *link, int y, int height, int slice_dir);
349
350     /**
351      * Frame poll callback. This returns the number of immediately available
352      * frames. It should return a positive value if the next request_frame()
353      * is guaranteed to return one frame (with no delay).
354      *
355      * Defaults to just calling the source poll_frame() method.
356      *
357      * Output video pads only.
358      */
359     int (*poll_frame)(AVFilterLink *link);
360
361     /**
362      * Frame request callback. A call to this should result in at least one
363      * frame being output over the given link. This should return zero on
364      * success, and another value on error.
365      *
366      * Output video pads only.
367      */
368     int (*request_frame)(AVFilterLink *link);
369
370     /**
371      * Link configuration callback.
372      *
373      * For output pads, this should set the link properties such as
374      * width/height. This should NOT set the format property - that is
375      * negotiated between filters by the filter system using the
376      * query_formats() callback before this function is called.
377      *
378      * For input pads, this should check the properties of the link, and update
379      * the filter's internal state as necessary.
380      *
381      * For both input and output filters, this should return zero on success,
382      * and another value on error.
383      */
384     int (*config_props)(AVFilterLink *link);
385 };
386
387 /** default handler for start_frame() for video inputs */
388 void avfilter_default_start_frame(AVFilterLink *link, AVFilterPicRef *picref);
389 /** default handler for draw_slice() for video inputs */
390 void avfilter_default_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
391 /** default handler for end_frame() for video inputs */
392 void avfilter_default_end_frame(AVFilterLink *link);
393 /** default handler for config_props() for video outputs */
394 int avfilter_default_config_output_link(AVFilterLink *link);
395 /** default handler for config_props() for video inputs */
396 int avfilter_default_config_input_link (AVFilterLink *link);
397 /** default handler for get_video_buffer() for video inputs */
398 AVFilterPicRef *avfilter_default_get_video_buffer(AVFilterLink *link,
399                                                   int perms, int w, int h);
400 /**
401  * A helper for query_formats() which sets all links to the same list of
402  * formats. If there are no links hooked to this filter, the list of formats is
403  * freed.
404  */
405 void avfilter_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats);
406 /** Default handler for query_formats() */
407 int avfilter_default_query_formats(AVFilterContext *ctx);
408
409 /** start_frame() handler for filters which simply pass video along */
410 void avfilter_null_start_frame(AVFilterLink *link, AVFilterPicRef *picref);
411
412 /** draw_slice() handler for filters which simply pass video along */
413 void avfilter_null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
414
415 /** end_frame() handler for filters which simply pass video along */
416 void avfilter_null_end_frame(AVFilterLink *link);
417
418 /** get_video_buffer() handler for filters which simply pass video along */
419 AVFilterPicRef *avfilter_null_get_video_buffer(AVFilterLink *link,
420                                                   int perms, int w, int h);
421
422 /**
423  * Filter definition. This defines the pads a filter contains, and all the
424  * callback functions used to interact with the filter.
425  */
426 typedef struct AVFilter
427 {
428     const char *name;         ///< filter name
429
430     int priv_size;      ///< size of private data to allocate for the filter
431
432     /**
433      * Filter initialization function. Args contains the user-supplied
434      * parameters. FIXME: maybe an AVOption-based system would be better?
435      * opaque is data provided by the code requesting creation of the filter,
436      * and is used to pass data to the filter.
437      */
438     int (*init)(AVFilterContext *ctx, const char *args, void *opaque);
439
440     /**
441      * Filter uninitialization function. Should deallocate any memory held
442      * by the filter, release any picture references, etc. This does not need
443      * to deallocate the AVFilterContext->priv memory itself.
444      */
445     void (*uninit)(AVFilterContext *ctx);
446
447     /**
448      * Queries formats supported by the filter and its pads, and sets the
449      * in_formats for links connected to its output pads, and out_formats
450      * for links connected to its input pads.
451      *
452      * @return zero on success, a negative value corresponding to an
453      * AVERROR code otherwise
454      */
455     int (*query_formats)(AVFilterContext *);
456
457     const AVFilterPad *inputs;  ///< NULL terminated list of inputs. NULL if none
458     const AVFilterPad *outputs; ///< NULL terminated list of outputs. NULL if none
459
460     /**
461      * A description for the filter. You should use the
462      * NULL_IF_CONFIG_SMALL() macro to define it.
463      */
464     const char *description;
465 } AVFilter;
466
467 /** An instance of a filter */
468 struct AVFilterContext
469 {
470     const AVClass *av_class;              ///< needed for av_log()
471
472     AVFilter *filter;               ///< the AVFilter of which this is an instance
473
474     char *name;                     ///< name of this filter instance
475
476     unsigned input_count;           ///< number of input pads
477     AVFilterPad   *input_pads;      ///< array of input pads
478     AVFilterLink **inputs;          ///< array of pointers to input links
479
480     unsigned output_count;          ///< number of output pads
481     AVFilterPad   *output_pads;     ///< array of output pads
482     AVFilterLink **outputs;         ///< array of pointers to output links
483
484     void *priv;                     ///< private data for use by the filter
485 };
486
487 /**
488  * A link between two filters. This contains pointers to the source and
489  * destination filters between which this link exists, and the indexes of
490  * the pads involved. In addition, this link also contains the parameters
491  * which have been negotiated and agreed upon between the filter, such as
492  * image dimensions, format, etc.
493  */
494 struct AVFilterLink
495 {
496     AVFilterContext *src;       ///< source filter
497     unsigned int srcpad;        ///< index of the output pad on the source filter
498
499     AVFilterContext *dst;       ///< dest filter
500     unsigned int dstpad;        ///< index of the input pad on the dest filter
501
502     /** stage of the initialization of the link properties (dimensions, etc) */
503     enum {
504         AVLINK_UNINIT = 0,      ///< not started
505         AVLINK_STARTINIT,       ///< started, but incomplete
506         AVLINK_INIT             ///< complete
507     } init_state;
508
509     int w;                      ///< agreed upon image width
510     int h;                      ///< agreed upon image height
511     enum PixelFormat format;    ///< agreed upon image colorspace
512
513     /**
514      * Lists of formats supported by the input and output filters respectively.
515      * These lists are used for negotiating the format to actually be used,
516      * which will be loaded into the format member, above, when chosen.
517      */
518     AVFilterFormats *in_formats;
519     AVFilterFormats *out_formats;
520
521     /**
522      * The picture reference currently being sent across the link by the source
523      * filter. This is used internally by the filter system to allow
524      * automatic copying of pictures which do not have sufficient permissions
525      * for the destination. This should not be accessed directly by the
526      * filters.
527      */
528     AVFilterPicRef *srcpic;
529
530     AVFilterPicRef *cur_pic;
531     AVFilterPicRef *outpic;
532 };
533
534 /**
535  * Link two filters together.
536  * @param src    the source filter
537  * @param srcpad index of the output pad on the source filter
538  * @param dst    the destination filter
539  * @param dstpad index of the input pad on the destination filter
540  * @return       zero on success
541  */
542 int avfilter_link(AVFilterContext *src, unsigned srcpad,
543                   AVFilterContext *dst, unsigned dstpad);
544
545 /**
546  * Negotiate the colorspace, dimensions, etc of all inputs to a filter.
547  * @param filter the filter to negotiate the properties for its inputs
548  * @return       zero on successful negotiation
549  */
550 int avfilter_config_links(AVFilterContext *filter);
551
552 /**
553  * Request a picture buffer with a specific set of permissions.
554  * @param link  the output link to the filter from which the picture will
555  *              be requested
556  * @param perms the required access permissions
557  * @param w     the minimum width of the buffer to allocate
558  * @param h     the minimum height of the buffer to allocate
559  * @return      A reference to the picture. This must be unreferenced with
560  *              avfilter_unref_pic when you are finished with it.
561  */
562 AVFilterPicRef *avfilter_get_video_buffer(AVFilterLink *link, int perms,
563                                           int w, int h);
564
565 /**
566  * Request an input frame from the filter at the other end of the link.
567  * @param link the input link
568  * @return     zero on success
569  */
570 int avfilter_request_frame(AVFilterLink *link);
571
572 /**
573  * Poll a frame from the filter chain.
574  * @param  link the input link
575  * @return the number of immediately available frames, a negative
576  * number in case of error
577  */
578 int avfilter_poll_frame(AVFilterLink *link);
579
580 /**
581  * Notifie the next filter of the start of a frame.
582  * @param link   the output link the frame will be sent over
583  * @param picref A reference to the frame about to be sent. The data for this
584  *               frame need only be valid once draw_slice() is called for that
585  *               portion. The receiving filter will free this reference when
586  *               it no longer needs it.
587  */
588 void avfilter_start_frame(AVFilterLink *link, AVFilterPicRef *picref);
589
590 /**
591  * Notifie the next filter that the current frame has finished.
592  * @param link the output link the frame was sent over
593  */
594 void avfilter_end_frame(AVFilterLink *link);
595
596 /**
597  * Send a slice to the next filter.
598  *
599  * Slices have to be provided in sequential order, either in
600  * top-bottom or bottom-top order. If slices are provided in
601  * non-sequential order the behavior of the function is undefined.
602  *
603  * @param link the output link over which the frame is being sent
604  * @param y    offset in pixels from the top of the image for this slice
605  * @param h    height of this slice in pixels
606  * @param slice_dir the assumed direction for sending slices,
607  *             from the top slice to the bottom slice if the value is 1,
608  *             from the bottom slice to the top slice if the value is -1,
609  *             for other values the behavior of the function is undefined.
610  */
611 void avfilter_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
612
613 /** Initialize the filter system. Register all builtin filters. */
614 void avfilter_register_all(void);
615
616 /** Uninitialize the filter system. Unregister all filters. */
617 void avfilter_uninit(void);
618
619 /**
620  * Register a filter. This is only needed if you plan to use
621  * avfilter_get_by_name later to lookup the AVFilter structure by name. A
622  * filter can still by instantiated with avfilter_open even if it is not
623  * registered.
624  * @param filter the filter to register
625  * @return 0 if the registration was succesfull, a negative value
626  * otherwise
627  */
628 int avfilter_register(AVFilter *filter);
629
630 /**
631  * Get a filter definition matching the given name.
632  * @param name the filter name to find
633  * @return     the filter definition, if any matching one is registered.
634  *             NULL if none found.
635  */
636 AVFilter *avfilter_get_by_name(const char *name);
637
638 /**
639  * If filter is NULL, returns a pointer to the first registered filter pointer,
640  * if filter is non-NULL, returns the next pointer after filter.
641  * If the returned pointer points to NULL, the last registered filter
642  * was already reached.
643  */
644 AVFilter **av_filter_next(AVFilter **filter);
645
646 /**
647  * Create a filter instance.
648  * @param filter    the filter to create an instance of
649  * @param inst_name Name to give to the new instance. Can be NULL for none.
650  * @return          Pointer to the new instance on success. NULL on failure.
651  */
652 AVFilterContext *avfilter_open(AVFilter *filter, const char *inst_name);
653
654 /**
655  * Initialize a filter.
656  * @param filter the filter to initialize
657  * @param args   A string of parameters to use when initializing the filter.
658  *               The format and meaning of this string varies by filter.
659  * @param opaque Any extra non-string data needed by the filter. The meaning
660  *               of this parameter varies by filter.
661  * @return       zero on success
662  */
663 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
664
665 /**
666  * Destroy a filter.
667  * @param filter the filter to destroy
668  */
669 void avfilter_destroy(AVFilterContext *filter);
670
671 /**
672  * Insert a filter in the middle of an existing link.
673  * @param link the link into which the filter should be inserted
674  * @param filt the filter to be inserted
675  * @param in   the input pad on the filter to connect
676  * @param out  the output pad on the filter to connect
677  * @return     zero on success
678  */
679 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
680                            unsigned in, unsigned out);
681
682 /**
683  * Insert a new pad.
684  * @param idx Insertion point. Pad is inserted at the end if this point
685  *            is beyond the end of the list of pads.
686  * @param count Pointer to the number of pads in the list
687  * @param padidx_off Offset within an AVFilterLink structure to the element
688  *                   to increment when inserting a new pad causes link
689  *                   numbering to change
690  * @param pads Pointer to the pointer to the beginning of the list of pads
691  * @param links Pointer to the pointer to the beginning of the list of links
692  * @param newpad The new pad to add. A copy is made when adding.
693  */
694 void avfilter_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
695                          AVFilterPad **pads, AVFilterLink ***links,
696                          AVFilterPad *newpad);
697
698 /** Insert a new input pad for the filter. */
699 static inline void avfilter_insert_inpad(AVFilterContext *f, unsigned index,
700                                          AVFilterPad *p)
701 {
702     avfilter_insert_pad(index, &f->input_count, offsetof(AVFilterLink, dstpad),
703                         &f->input_pads, &f->inputs, p);
704 }
705
706 /** Insert a new output pad for the filter. */
707 static inline void avfilter_insert_outpad(AVFilterContext *f, unsigned index,
708                                           AVFilterPad *p)
709 {
710     avfilter_insert_pad(index, &f->output_count, offsetof(AVFilterLink, srcpad),
711                         &f->output_pads, &f->outputs, p);
712 }
713
714 #endif  /* AVFILTER_AVFILTER_H */