c92f7e14d41f3ac744c1ba7d1e6bbb2dd04f3a03
[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 typedef struct AVFilterFormats AVFilterFormats;
56
57 /**
58  * A reference-counted buffer data type used by the filter system. Filters
59  * should not store pointers to this structure directly, but instead use the
60  * AVFilterBufferRef structure below.
61  */
62 typedef struct AVFilterBuffer {
63     uint8_t *data[8];           ///< buffer data for each plane/channel
64     int linesize[8];            ///< number of bytes per line
65
66     unsigned refcount;          ///< number of references to this buffer
67
68     /** private data to be used by a custom free function */
69     void *priv;
70     /**
71      * A pointer to the function to deallocate this buffer if the default
72      * function is not sufficient. This could, for example, add the memory
73      * back into a memory pool to be reused later without the overhead of
74      * reallocating it from scratch.
75      */
76     void (*free)(struct AVFilterBuffer *buf);
77
78     int format;                 ///< media format
79     int w, h;                   ///< width and height of the allocated buffer
80
81     /**
82      * pointers to the data planes/channels.
83      *
84      * For video, this should simply point to data[].
85      *
86      * For planar audio, each channel has a separate data pointer, and
87      * linesize[0] contains the size of each channel buffer.
88      * For packed audio, there is just one data pointer, and linesize[0]
89      * contains the total size of the buffer for all channels.
90      *
91      * Note: Both data and extended_data will always be set, but for planar
92      * audio with more channels that can fit in data, extended_data must be used
93      * in order to access all channels.
94      */
95     uint8_t **extended_data;
96 } AVFilterBuffer;
97
98 #define AV_PERM_READ     0x01   ///< can read from the buffer
99 #define AV_PERM_WRITE    0x02   ///< can write to the buffer
100 #define AV_PERM_PRESERVE 0x04   ///< nobody else can overwrite the buffer
101 #define AV_PERM_REUSE    0x08   ///< can output the buffer multiple times, with the same contents each time
102 #define AV_PERM_REUSE2   0x10   ///< can output the buffer multiple times, modified each time
103 #define AV_PERM_NEG_LINESIZES 0x20  ///< the buffer requested can have negative linesizes
104
105 /**
106  * Audio specific properties in a reference to an AVFilterBuffer. Since
107  * AVFilterBufferRef is common to different media formats, audio specific
108  * per reference properties must be separated out.
109  */
110 typedef struct AVFilterBufferRefAudioProps {
111     uint64_t channel_layout;    ///< channel layout of audio buffer
112     int nb_samples;             ///< number of audio samples
113     int 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 #if FF_API_FILTERS_PUBLIC
202 /**
203  * @addtogroup lavfi_deprecated
204  * @deprecated Those functions are only useful inside filters and
205  * user filters are not supported at this point.
206  * @{
207  */
208 struct AVFilterFormats {
209     unsigned format_count;      ///< number of formats
210     int *formats;               ///< list of media formats
211
212     unsigned refcount;          ///< number of references to this list
213     struct AVFilterFormats ***refs; ///< references to this list
214 };
215
216 attribute_deprecated
217 AVFilterFormats *avfilter_make_format_list(const int *fmts);
218 attribute_deprecated
219 int avfilter_add_format(AVFilterFormats **avff, int fmt);
220 attribute_deprecated
221 AVFilterFormats *avfilter_all_formats(enum AVMediaType type);
222 attribute_deprecated
223 AVFilterFormats *avfilter_merge_formats(AVFilterFormats *a, AVFilterFormats *b);
224 attribute_deprecated
225 void avfilter_formats_ref(AVFilterFormats *formats, AVFilterFormats **ref);
226 attribute_deprecated
227 void avfilter_formats_unref(AVFilterFormats **ref);
228 attribute_deprecated
229 void avfilter_formats_changeref(AVFilterFormats **oldref,
230                                 AVFilterFormats **newref);
231 attribute_deprecated
232 void avfilter_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats);
233 /**
234  * @}
235  */
236 #endif
237
238 #if FF_API_AVFILTERPAD_PUBLIC
239 /**
240  * A filter pad used for either input or output.
241  *
242  * @warning this struct will be removed from public API.
243  * users should call avfilter_pad_get_name() and avfilter_pad_get_type()
244  * to access the name and type fields; there should be no need to access
245  * any other fields from outside of libavfilter.
246  */
247 struct AVFilterPad {
248     /**
249      * Pad name. The name is unique among inputs and among outputs, but an
250      * input may have the same name as an output. This may be NULL if this
251      * pad has no need to ever be referenced by name.
252      */
253     const char *name;
254
255     /**
256      * AVFilterPad type.
257      */
258     enum AVMediaType type;
259
260     /**
261      * Minimum required permissions on incoming buffers. Any buffer with
262      * insufficient permissions will be automatically copied by the filter
263      * system to a new buffer which provides the needed access permissions.
264      *
265      * Input pads only.
266      */
267     int min_perms;
268
269     /**
270      * Permissions which are not accepted on incoming buffers. Any buffer
271      * which has any of these permissions set will be automatically copied
272      * by the filter system to a new buffer which does not have those
273      * permissions. This can be used to easily disallow buffers with
274      * AV_PERM_REUSE.
275      *
276      * Input pads only.
277      */
278     int rej_perms;
279
280     /**
281      * Callback called before passing the first slice of a new frame. If
282      * NULL, the filter layer will default to storing a reference to the
283      * picture inside the link structure.
284      *
285      * Input video pads only.
286      */
287     void (*start_frame)(AVFilterLink *link, AVFilterBufferRef *picref);
288
289     /**
290      * Callback function to get a video buffer. If NULL, the filter system will
291      * use avfilter_default_get_video_buffer().
292      *
293      * Input video pads only.
294      */
295     AVFilterBufferRef *(*get_video_buffer)(AVFilterLink *link, int perms, int w, int h);
296
297     /**
298      * Callback function to get an audio buffer. If NULL, the filter system will
299      * use avfilter_default_get_audio_buffer().
300      *
301      * Input audio pads only.
302      */
303     AVFilterBufferRef *(*get_audio_buffer)(AVFilterLink *link, int perms,
304                                            int nb_samples);
305
306     /**
307      * Callback called after the slices of a frame are completely sent. If
308      * NULL, the filter layer will default to releasing the reference stored
309      * in the link structure during start_frame().
310      *
311      * Input video pads only.
312      */
313     void (*end_frame)(AVFilterLink *link);
314
315     /**
316      * Slice drawing callback. This is where a filter receives video data
317      * and should do its processing.
318      *
319      * Input video pads only.
320      */
321     void (*draw_slice)(AVFilterLink *link, int y, int height, int slice_dir);
322
323     /**
324      * Samples filtering callback. This is where a filter receives audio data
325      * and should do its processing.
326      *
327      * Input audio pads only.
328      */
329     void (*filter_samples)(AVFilterLink *link, AVFilterBufferRef *samplesref);
330
331     /**
332      * Frame poll callback. This returns the number of immediately available
333      * samples. It should return a positive value if the next request_frame()
334      * is guaranteed to return one frame (with no delay).
335      *
336      * Defaults to just calling the source poll_frame() method.
337      *
338      * Output pads only.
339      */
340     int (*poll_frame)(AVFilterLink *link);
341
342     /**
343      * Frame request callback. A call to this should result in at least one
344      * frame being output over the given link. This should return zero on
345      * success, and another value on error.
346      *
347      * Output pads only.
348      */
349     int (*request_frame)(AVFilterLink *link);
350
351     /**
352      * Link configuration callback.
353      *
354      * For output pads, this should set the link properties such as
355      * width/height. This should NOT set the format property - that is
356      * negotiated between filters by the filter system using the
357      * query_formats() callback before this function is called.
358      *
359      * For input pads, this should check the properties of the link, and update
360      * the filter's internal state as necessary.
361      *
362      * For both input and output filters, this should return zero on success,
363      * and another value on error.
364      */
365     int (*config_props)(AVFilterLink *link);
366
367     /**
368      * The filter expects a fifo to be inserted on its input link,
369      * typically because it has a delay.
370      *
371      * input pads only.
372      */
373     int needs_fifo;
374 };
375 #endif
376
377 /**
378  * Get the name of an AVFilterPad.
379  *
380  * @param pads an array of AVFilterPads
381  * @param pad_idx index of the pad in the array it; is the caller's
382  *                responsibility to ensure the index is valid
383  *
384  * @return name of the pad_idx'th pad in pads
385  */
386 const char *avfilter_pad_get_name(AVFilterPad *pads, int pad_idx);
387
388 /**
389  * Get the type of an AVFilterPad.
390  *
391  * @param pads an array of AVFilterPads
392  * @param pad_idx index of the pad in the array; it is the caller's
393  *                responsibility to ensure the index is valid
394  *
395  * @return type of the pad_idx'th pad in pads
396  */
397 enum AVMediaType avfilter_pad_get_type(AVFilterPad *pads, int pad_idx);
398
399 #if FF_API_FILTERS_PUBLIC
400 /** default handler for start_frame() for video inputs */
401 attribute_deprecated
402 void avfilter_default_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
403
404 /** default handler for draw_slice() for video inputs */
405 attribute_deprecated
406 void avfilter_default_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
407
408 /** default handler for end_frame() for video inputs */
409 attribute_deprecated
410 void avfilter_default_end_frame(AVFilterLink *link);
411
412 #if FF_API_DEFAULT_CONFIG_OUTPUT_LINK
413 /** default handler for config_props() for audio/video outputs */
414 attribute_deprecated
415 int avfilter_default_config_output_link(AVFilterLink *link);
416 #endif
417
418 /** default handler for get_video_buffer() for video inputs */
419 attribute_deprecated
420 AVFilterBufferRef *avfilter_default_get_video_buffer(AVFilterLink *link,
421                                                      int perms, int w, int h);
422
423 /** Default handler for query_formats() */
424 attribute_deprecated
425 int avfilter_default_query_formats(AVFilterContext *ctx);
426 #endif
427
428 #if FF_API_FILTERS_PUBLIC
429 /** start_frame() handler for filters which simply pass video along */
430 attribute_deprecated
431 void avfilter_null_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
432
433 /** draw_slice() handler for filters which simply pass video along */
434 attribute_deprecated
435 void avfilter_null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
436
437 /** end_frame() handler for filters which simply pass video along */
438 attribute_deprecated
439 void avfilter_null_end_frame(AVFilterLink *link);
440
441 /** get_video_buffer() handler for filters which simply pass video along */
442 attribute_deprecated
443 AVFilterBufferRef *avfilter_null_get_video_buffer(AVFilterLink *link,
444                                                   int perms, int w, int h);
445 #endif
446
447 /**
448  * Filter definition. This defines the pads a filter contains, and all the
449  * callback functions used to interact with the filter.
450  */
451 typedef struct AVFilter {
452     const char *name;         ///< filter name
453
454     int priv_size;      ///< size of private data to allocate for the filter
455
456     /**
457      * Filter initialization function. Args contains the user-supplied
458      * parameters. FIXME: maybe an AVOption-based system would be better?
459      * opaque is data provided by the code requesting creation of the filter,
460      * and is used to pass data to the filter.
461      */
462     int (*init)(AVFilterContext *ctx, const char *args, void *opaque);
463
464     /**
465      * Filter uninitialization function. Should deallocate any memory held
466      * by the filter, release any buffer references, etc. This does not need
467      * to deallocate the AVFilterContext->priv memory itself.
468      */
469     void (*uninit)(AVFilterContext *ctx);
470
471     /**
472      * Queries formats supported by the filter and its pads, and sets the
473      * in_formats for links connected to its output pads, and out_formats
474      * for links connected to its input pads.
475      *
476      * @return zero on success, a negative value corresponding to an
477      * AVERROR code otherwise
478      */
479     int (*query_formats)(AVFilterContext *);
480
481     const AVFilterPad *inputs;  ///< NULL terminated list of inputs. NULL if none
482     const AVFilterPad *outputs; ///< NULL terminated list of outputs. NULL if none
483
484     /**
485      * A description for the filter. You should use the
486      * NULL_IF_CONFIG_SMALL() macro to define it.
487      */
488     const char *description;
489 } AVFilter;
490
491 /** An instance of a filter */
492 struct AVFilterContext {
493     const AVClass *av_class;              ///< needed for av_log()
494
495     AVFilter *filter;               ///< the AVFilter of which this is an instance
496
497     char *name;                     ///< name of this filter instance
498
499 #if FF_API_FOO_COUNT
500     unsigned input_count;           ///< @deprecated use nb_inputs
501 #endif
502     AVFilterPad   *input_pads;      ///< array of input pads
503     AVFilterLink **inputs;          ///< array of pointers to input links
504
505 #if FF_API_FOO_COUNT
506     unsigned output_count;          ///< @deprecated use nb_outputs
507 #endif
508     AVFilterPad   *output_pads;     ///< array of output pads
509     AVFilterLink **outputs;         ///< array of pointers to output links
510
511     void *priv;                     ///< private data for use by the filter
512
513     unsigned nb_inputs;             ///< number of input pads
514     unsigned nb_outputs;            ///< number of output pads
515 };
516
517 /**
518  * A link between two filters. This contains pointers to the source and
519  * destination filters between which this link exists, and the indexes of
520  * the pads involved. In addition, this link also contains the parameters
521  * which have been negotiated and agreed upon between the filter, such as
522  * image dimensions, format, etc.
523  */
524 struct AVFilterLink {
525     AVFilterContext *src;       ///< source filter
526     AVFilterPad *srcpad;        ///< output pad on the source filter
527
528     AVFilterContext *dst;       ///< dest filter
529     AVFilterPad *dstpad;        ///< input pad on the dest filter
530
531     /** stage of the initialization of the link properties (dimensions, etc) */
532     enum {
533         AVLINK_UNINIT = 0,      ///< not started
534         AVLINK_STARTINIT,       ///< started, but incomplete
535         AVLINK_INIT             ///< complete
536     } init_state;
537
538     enum AVMediaType type;      ///< filter media type
539
540     /* These parameters apply only to video */
541     int w;                      ///< agreed upon image width
542     int h;                      ///< agreed upon image height
543     AVRational sample_aspect_ratio; ///< agreed upon sample aspect ratio
544     /* These two parameters apply only to audio */
545     uint64_t channel_layout;    ///< channel layout of current buffer (see libavutil/audioconvert.h)
546 #if FF_API_SAMPLERATE64
547     int64_t sample_rate;        ///< samples per second
548 #else
549     int sample_rate;            ///< samples per second
550 #endif
551
552     int format;                 ///< agreed upon media format
553
554     /**
555      * Lists of formats supported by the input and output filters respectively.
556      * These lists are used for negotiating the format to actually be used,
557      * which will be loaded into the format member, above, when chosen.
558      */
559     AVFilterFormats *in_formats;
560     AVFilterFormats *out_formats;
561
562     /**
563      * The buffer reference currently being sent across the link by the source
564      * filter. This is used internally by the filter system to allow
565      * automatic copying of buffers which do not have sufficient permissions
566      * for the destination. This should not be accessed directly by the
567      * filters.
568      */
569     AVFilterBufferRef *src_buf;
570
571     AVFilterBufferRef *cur_buf;
572     AVFilterBufferRef *out_buf;
573
574     /**
575      * Define the time base used by the PTS of the frames/samples
576      * which will pass through this link.
577      * During the configuration stage, each filter is supposed to
578      * change only the output timebase, while the timebase of the
579      * input link is assumed to be an unchangeable property.
580      */
581     AVRational time_base;
582
583     /*****************************************************************
584      * All fields below this line are not part of the public API. They
585      * may not be used outside of libavfilter and can be changed and
586      * removed at will.
587      * New public fields should be added right above.
588      *****************************************************************
589      */
590     /**
591      * Lists of channel layouts and sample rates used for automatic
592      * negotiation.
593      */
594     AVFilterFormats  *in_samplerates;
595     AVFilterFormats *out_samplerates;
596     struct AVFilterChannelLayouts  *in_channel_layouts;
597     struct AVFilterChannelLayouts *out_channel_layouts;
598 };
599
600 /**
601  * Link two filters together.
602  *
603  * @param src    the source filter
604  * @param srcpad index of the output pad on the source filter
605  * @param dst    the destination filter
606  * @param dstpad index of the input pad on the destination filter
607  * @return       zero on success
608  */
609 int avfilter_link(AVFilterContext *src, unsigned srcpad,
610                   AVFilterContext *dst, unsigned dstpad);
611
612 /**
613  * Negotiate the media format, dimensions, etc of all inputs to a filter.
614  *
615  * @param filter the filter to negotiate the properties for its inputs
616  * @return       zero on successful negotiation
617  */
618 int avfilter_config_links(AVFilterContext *filter);
619
620 #if FF_API_FILTERS_PUBLIC
621 attribute_deprecated
622 AVFilterBufferRef *avfilter_get_video_buffer(AVFilterLink *link, int perms,
623                                           int w, int h);
624 #endif
625
626 /**
627  * Create a buffer reference wrapped around an already allocated image
628  * buffer.
629  *
630  * @param data pointers to the planes of the image to reference
631  * @param linesize linesizes for the planes of the image to reference
632  * @param perms the required access permissions
633  * @param w the width of the image specified by the data and linesize arrays
634  * @param h the height of the image specified by the data and linesize arrays
635  * @param format the pixel format of the image specified by the data and linesize arrays
636  */
637 AVFilterBufferRef *
638 avfilter_get_video_buffer_ref_from_arrays(uint8_t *data[4], int linesize[4], int perms,
639                                           int w, int h, enum PixelFormat format);
640
641 /**
642  * Create an audio buffer reference wrapped around an already
643  * allocated samples buffer.
644  *
645  * @param data           pointers to the samples plane buffers
646  * @param linesize       linesize for the samples plane buffers
647  * @param perms          the required access permissions
648  * @param nb_samples     number of samples per channel
649  * @param sample_fmt     the format of each sample in the buffer to allocate
650  * @param channel_layout the channel layout of the buffer
651  */
652 AVFilterBufferRef *avfilter_get_audio_buffer_ref_from_arrays(uint8_t **data,
653                                                              int linesize,
654                                                              int perms,
655                                                              int nb_samples,
656                                                              enum AVSampleFormat sample_fmt,
657                                                              uint64_t channel_layout);
658
659 #if FF_API_FILTERS_PUBLIC
660 attribute_deprecated
661 int avfilter_request_frame(AVFilterLink *link);
662
663 attribute_deprecated
664 int avfilter_poll_frame(AVFilterLink *link);
665
666 attribute_deprecated
667 void avfilter_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
668 attribute_deprecated
669 void avfilter_end_frame(AVFilterLink *link);
670 attribute_deprecated
671 void avfilter_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
672 #endif
673
674 /** Initialize the filter system. Register all builtin filters. */
675 void avfilter_register_all(void);
676
677 /** Uninitialize the filter system. Unregister all filters. */
678 void avfilter_uninit(void);
679
680 /**
681  * Register a filter. This is only needed if you plan to use
682  * avfilter_get_by_name later to lookup the AVFilter structure by name. A
683  * filter can still by instantiated with avfilter_open even if it is not
684  * registered.
685  *
686  * @param filter the filter to register
687  * @return 0 if the registration was succesfull, a negative value
688  * otherwise
689  */
690 int avfilter_register(AVFilter *filter);
691
692 /**
693  * Get a filter definition matching the given name.
694  *
695  * @param name the filter name to find
696  * @return     the filter definition, if any matching one is registered.
697  *             NULL if none found.
698  */
699 AVFilter *avfilter_get_by_name(const char *name);
700
701 /**
702  * If filter is NULL, returns a pointer to the first registered filter pointer,
703  * if filter is non-NULL, returns the next pointer after filter.
704  * If the returned pointer points to NULL, the last registered filter
705  * was already reached.
706  */
707 AVFilter **av_filter_next(AVFilter **filter);
708
709 /**
710  * Create a filter instance.
711  *
712  * @param filter_ctx put here a pointer to the created filter context
713  * on success, NULL on failure
714  * @param filter    the filter to create an instance of
715  * @param inst_name Name to give to the new instance. Can be NULL for none.
716  * @return >= 0 in case of success, a negative error code otherwise
717  */
718 int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name);
719
720 /**
721  * Initialize a filter.
722  *
723  * @param filter the filter to initialize
724  * @param args   A string of parameters to use when initializing the filter.
725  *               The format and meaning of this string varies by filter.
726  * @param opaque Any extra non-string data needed by the filter. The meaning
727  *               of this parameter varies by filter.
728  * @return       zero on success
729  */
730 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
731
732 /**
733  * Free a filter context.
734  *
735  * @param filter the filter to free
736  */
737 void avfilter_free(AVFilterContext *filter);
738
739 /**
740  * Insert a filter in the middle of an existing link.
741  *
742  * @param link the link into which the filter should be inserted
743  * @param filt the filter to be inserted
744  * @param filt_srcpad_idx the input pad on the filter to connect
745  * @param filt_dstpad_idx the output pad on the filter to connect
746  * @return     zero on success
747  */
748 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
749                            unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
750
751 #if FF_API_FILTERS_PUBLIC
752 attribute_deprecated
753 void avfilter_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
754                          AVFilterPad **pads, AVFilterLink ***links,
755                          AVFilterPad *newpad);
756
757 attribute_deprecated
758 void avfilter_insert_inpad(AVFilterContext *f, unsigned index,
759                            AVFilterPad *p);
760 attribute_deprecated
761 void avfilter_insert_outpad(AVFilterContext *f, unsigned index,
762                             AVFilterPad *p);
763 #endif
764
765 /**
766  * Copy the frame properties of src to dst, without copying the actual
767  * image data.
768  *
769  * @return 0 on success, a negative number on error.
770  */
771 int avfilter_copy_frame_props(AVFilterBufferRef *dst, const AVFrame *src);
772
773 /**
774  * Copy the frame properties and data pointers of src to dst, without copying
775  * the actual data.
776  *
777  * @return 0 on success, a negative number on error.
778  */
779 int avfilter_copy_buf_props(AVFrame *dst, const AVFilterBufferRef *src);
780
781 #endif /* AVFILTER_AVFILTER_H */