lavfi: add init_opaque callback
[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 <stddef.h>
26
27 #include "libavutil/avutil.h"
28 #include "libavutil/log.h"
29 #include "libavutil/samplefmt.h"
30 #include "libavutil/pixfmt.h"
31 #include "libavutil/rational.h"
32
33 #include "libavfilter/version.h"
34
35 /**
36  * Return the LIBAVFILTER_VERSION_INT constant.
37  */
38 unsigned avfilter_version(void);
39
40 /**
41  * Return the libavfilter build-time configuration.
42  */
43 const char *avfilter_configuration(void);
44
45 /**
46  * Return the libavfilter license.
47  */
48 const char *avfilter_license(void);
49
50
51 typedef struct AVFilterContext AVFilterContext;
52 typedef struct AVFilterLink    AVFilterLink;
53 typedef struct AVFilterPad     AVFilterPad;
54 typedef struct AVFilterFormats AVFilterFormats;
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
64     /**
65      * pointers to the data planes/channels.
66      *
67      * For video, this should simply point to data[].
68      *
69      * For planar audio, each channel has a separate data pointer, and
70      * linesize[0] contains the size of each channel buffer.
71      * For packed audio, there is just one data pointer, and linesize[0]
72      * contains the total size of the buffer for all channels.
73      *
74      * Note: Both data and extended_data will always be set, but for planar
75      * audio with more channels that can fit in data, extended_data must be used
76      * in order to access all channels.
77      */
78     uint8_t **extended_data;
79     int linesize[8];            ///< number of bytes per line
80
81     /** private data to be used by a custom free function */
82     void *priv;
83     /**
84      * A pointer to the function to deallocate this buffer if the default
85      * function is not sufficient. This could, for example, add the memory
86      * back into a memory pool to be reused later without the overhead of
87      * reallocating it from scratch.
88      */
89     void (*free)(struct AVFilterBuffer *buf);
90
91     int format;                 ///< media format
92     int w, h;                   ///< width and height of the allocated buffer
93     unsigned refcount;          ///< number of references to this buffer
94 } AVFilterBuffer;
95
96 #define AV_PERM_READ     0x01   ///< can read from the buffer
97 #define AV_PERM_WRITE    0x02   ///< can write to the buffer
98 #define AV_PERM_PRESERVE 0x04   ///< nobody else can overwrite the buffer
99 #define AV_PERM_REUSE    0x08   ///< can output the buffer multiple times, with the same contents each time
100 #define AV_PERM_REUSE2   0x10   ///< can output the buffer multiple times, modified each time
101 #define AV_PERM_NEG_LINESIZES 0x20  ///< the buffer requested can have negative linesizes
102 #define AV_PERM_ALIGN    0x40   ///< the buffer must be aligned
103
104 #define AVFILTER_ALIGN 16 //not part of ABI
105
106 /**
107  * Audio specific properties in a reference to an AVFilterBuffer. Since
108  * AVFilterBufferRef is common to different media formats, audio specific
109  * per reference properties must be separated out.
110  */
111 typedef struct AVFilterBufferRefAudioProps {
112     uint64_t channel_layout;    ///< channel layout of audio buffer
113     int nb_samples;             ///< number of audio samples per channel
114     int sample_rate;            ///< audio buffer sample rate
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 sample_aspect_ratio; ///< sample 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     /**
144      * pointers to the data planes/channels.
145      *
146      * For video, this should simply point to data[].
147      *
148      * For planar audio, each channel has a separate data pointer, and
149      * linesize[0] contains the size of each channel buffer.
150      * For packed audio, there is just one data pointer, and linesize[0]
151      * contains the total size of the buffer for all channels.
152      *
153      * Note: Both data and extended_data will always be set, but for planar
154      * audio with more channels that can fit in data, extended_data must be used
155      * in order to access all channels.
156      */
157     uint8_t **extended_data;
158     int linesize[8];            ///< number of bytes per line
159
160     AVFilterBufferRefVideoProps *video; ///< video buffer specific properties
161     AVFilterBufferRefAudioProps *audio; ///< audio buffer specific properties
162
163     /**
164      * presentation timestamp. The time unit may change during
165      * filtering, as it is specified in the link and the filter code
166      * may need to rescale the PTS accordingly.
167      */
168     int64_t pts;
169     int64_t pos;                ///< byte position in stream, -1 if unknown
170
171     int format;                 ///< media format
172
173     int perms;                  ///< permissions, see the AV_PERM_* flags
174
175     enum AVMediaType type;      ///< media type of buffer data
176 } AVFilterBufferRef;
177
178 /**
179  * Copy properties of src to dst, without copying the actual data
180  */
181 void avfilter_copy_buffer_ref_props(AVFilterBufferRef *dst, AVFilterBufferRef *src);
182
183 /**
184  * Add a new reference to a buffer.
185  *
186  * @param ref   an existing reference to the buffer
187  * @param pmask a bitmask containing the allowable permissions in the new
188  *              reference
189  * @return      a new reference to the buffer with the same properties as the
190  *              old, excluding any permissions denied by pmask
191  */
192 AVFilterBufferRef *avfilter_ref_buffer(AVFilterBufferRef *ref, int pmask);
193
194 /**
195  * Remove a reference to a buffer. If this is the last reference to the
196  * buffer, the buffer itself is also automatically freed.
197  *
198  * @param ref reference to the buffer, may be NULL
199  */
200 void avfilter_unref_buffer(AVFilterBufferRef *ref);
201
202 /**
203  * Remove a reference to a buffer and set the pointer to NULL.
204  * If this is the last reference to the buffer, the buffer itself
205  * is also automatically freed.
206  *
207  * @param ref pointer to the buffer reference
208  */
209 void avfilter_unref_bufferp(AVFilterBufferRef **ref);
210
211
212 #if FF_API_AVFILTERPAD_PUBLIC
213 /**
214  * A filter pad used for either input or output.
215  *
216  * See doc/filter_design.txt for details on how to implement the methods.
217  *
218  * @warning this struct might be removed from public API.
219  * users should call avfilter_pad_get_name() and avfilter_pad_get_type()
220  * to access the name and type fields; there should be no need to access
221  * any other fields from outside of libavfilter.
222  */
223 struct AVFilterPad {
224     /**
225      * Pad name. The name is unique among inputs and among outputs, but an
226      * input may have the same name as an output. This may be NULL if this
227      * pad has no need to ever be referenced by name.
228      */
229     const char *name;
230
231     /**
232      * AVFilterPad type.
233      */
234     enum AVMediaType type;
235
236     /**
237      * Minimum required permissions on incoming buffers. Any buffer with
238      * insufficient permissions will be automatically copied by the filter
239      * system to a new buffer which provides the needed access permissions.
240      *
241      * Input pads only.
242      */
243     int min_perms;
244
245     /**
246      * Permissions which are not accepted on incoming buffers. Any buffer
247      * which has any of these permissions set will be automatically copied
248      * by the filter system to a new buffer which does not have those
249      * permissions. This can be used to easily disallow buffers with
250      * AV_PERM_REUSE.
251      *
252      * Input pads only.
253      */
254     int rej_perms;
255
256     /**
257      * Callback called before passing the first slice of a new frame. If
258      * NULL, the filter layer will default to storing a reference to the
259      * picture inside the link structure.
260      *
261      * Input video pads only.
262      */
263     void (*start_frame)(AVFilterLink *link, AVFilterBufferRef *picref);
264
265     /**
266      * Callback function to get a video buffer. If NULL, the filter system will
267      * use avfilter_default_get_video_buffer().
268      *
269      * Input video pads only.
270      */
271     AVFilterBufferRef *(*get_video_buffer)(AVFilterLink *link, int perms, int w, int h);
272
273     /**
274      * Callback function to get an audio buffer. If NULL, the filter system will
275      * use avfilter_default_get_audio_buffer().
276      *
277      * Input audio pads only.
278      */
279     AVFilterBufferRef *(*get_audio_buffer)(AVFilterLink *link, int perms,
280                                            int nb_samples);
281
282     /**
283      * Callback called after the slices of a frame are completely sent. If
284      * NULL, the filter layer will default to releasing the reference stored
285      * in the link structure during start_frame().
286      *
287      * Input video pads only.
288      */
289     void (*end_frame)(AVFilterLink *link);
290
291     /**
292      * Slice drawing callback. This is where a filter receives video data
293      * and should do its processing.
294      *
295      * Input video pads only.
296      */
297     void (*draw_slice)(AVFilterLink *link, int y, int height, int slice_dir);
298
299     /**
300      * Samples filtering callback. This is where a filter receives audio data
301      * and should do its processing.
302      *
303      * Input audio pads only.
304      *
305      * @return >= 0 on success, a negative AVERROR on error. This function
306      * must ensure that samplesref is properly unreferenced on error if it
307      * hasn't been passed on to another filter.
308      */
309     int (*filter_samples)(AVFilterLink *link, AVFilterBufferRef *samplesref);
310
311     /**
312      * Frame poll callback. This returns the number of immediately available
313      * samples. It should return a positive value if the next request_frame()
314      * is guaranteed to return one frame (with no delay).
315      *
316      * Defaults to just calling the source poll_frame() method.
317      *
318      * Output pads only.
319      */
320     int (*poll_frame)(AVFilterLink *link);
321
322     /**
323      * Frame request callback. A call to this should result in at least one
324      * frame being output over the given link. This should return zero on
325      * success, and another value on error.
326      * See ff_request_frame() for the error codes with a specific
327      * meaning.
328      *
329      * Output pads only.
330      */
331     int (*request_frame)(AVFilterLink *link);
332
333     /**
334      * Link configuration callback.
335      *
336      * For output pads, this should set the following link properties:
337      * video: width, height, sample_aspect_ratio, time_base
338      * audio: sample_rate.
339      *
340      * This should NOT set properties such as format, channel_layout, etc which
341      * are negotiated between filters by the filter system using the
342      * query_formats() callback before this function is called.
343      *
344      * For input pads, this should check the properties of the link, and update
345      * the filter's internal state as necessary.
346      *
347      * For both input and output pads, this should return zero on success,
348      * and another value on error.
349      */
350     int (*config_props)(AVFilterLink *link);
351
352     /**
353      * The filter expects a fifo to be inserted on its input link,
354      * typically because it has a delay.
355      *
356      * input pads only.
357      */
358     int needs_fifo;
359 };
360 #endif
361
362 /**
363  * Get the name of an AVFilterPad.
364  *
365  * @param pads an array of AVFilterPads
366  * @param pad_idx index of the pad in the array it; is the caller's
367  *                responsibility to ensure the index is valid
368  *
369  * @return name of the pad_idx'th pad in pads
370  */
371 const char *avfilter_pad_get_name(AVFilterPad *pads, int pad_idx);
372
373 /**
374  * Get the type of an AVFilterPad.
375  *
376  * @param pads an array of AVFilterPads
377  * @param pad_idx index of the pad in the array; it is the caller's
378  *                responsibility to ensure the index is valid
379  *
380  * @return type of the pad_idx'th pad in pads
381  */
382 enum AVMediaType avfilter_pad_get_type(AVFilterPad *pads, int pad_idx);
383
384 /** default handler for end_frame() for video inputs */
385 attribute_deprecated
386 void avfilter_default_end_frame(AVFilterLink *link);
387
388 /**
389  * Filter definition. This defines the pads a filter contains, and all the
390  * callback functions used to interact with the filter.
391  */
392 typedef struct AVFilter {
393     const char *name;         ///< filter name
394
395     /**
396      * A description for the filter. You should use the
397      * NULL_IF_CONFIG_SMALL() macro to define it.
398      */
399     const char *description;
400
401     const AVFilterPad *inputs;  ///< NULL terminated list of inputs. NULL if none
402     const AVFilterPad *outputs; ///< NULL terminated list of outputs. NULL if none
403
404     /*****************************************************************
405      * All fields below this line are not part of the public API. They
406      * may not be used outside of libavfilter and can be changed and
407      * removed at will.
408      * New public fields should be added right above.
409      *****************************************************************
410      */
411
412     /**
413      * Filter initialization function. Args contains the user-supplied
414      * parameters. FIXME: maybe an AVOption-based system would be better?
415      */
416     int (*init)(AVFilterContext *ctx, const char *args);
417
418     /**
419      * Filter uninitialization function. Should deallocate any memory held
420      * by the filter, release any buffer references, etc. This does not need
421      * to deallocate the AVFilterContext->priv memory itself.
422      */
423     void (*uninit)(AVFilterContext *ctx);
424
425     /**
426      * Queries formats/layouts supported by the filter and its pads, and sets
427      * the in_formats/in_chlayouts for links connected to its output pads,
428      * and out_formats/out_chlayouts for links connected to its input pads.
429      *
430      * @return zero on success, a negative value corresponding to an
431      * AVERROR code otherwise
432      */
433     int (*query_formats)(AVFilterContext *);
434
435     int priv_size;      ///< size of private data to allocate for the filter
436
437     /**
438      * Make the filter instance process a command.
439      *
440      * @param cmd    the command to process, for handling simplicity all commands must be alphanumeric only
441      * @param arg    the argument for the command
442      * @param res    a buffer with size res_size where the filter(s) can return a response. This must not change when the command is not supported.
443      * @param flags  if AVFILTER_CMD_FLAG_FAST is set and the command would be
444      *               time consuming then a filter should treat it like an unsupported command
445      *
446      * @returns >=0 on success otherwise an error code.
447      *          AVERROR(ENOSYS) on unsupported commands
448      */
449     int (*process_command)(AVFilterContext *, const char *cmd, const char *arg, char *res, int res_len, int flags);
450
451     /**
452      * Filter initialization function, alternative to the init()
453      * callback. Args contains the user-supplied parameters, opaque is
454      * used for providing binary data.
455      */
456     int (*init_opaque)(AVFilterContext *ctx, const char *args, void *opaque);
457 } AVFilter;
458
459 /** An instance of a filter */
460 struct AVFilterContext {
461     const AVClass *av_class;        ///< needed for av_log()
462
463     AVFilter *filter;               ///< the AVFilter of which this is an instance
464
465     char *name;                     ///< name of this filter instance
466
467     AVFilterPad   *input_pads;      ///< array of input pads
468     AVFilterLink **inputs;          ///< array of pointers to input links
469 #if FF_API_FOO_COUNT
470     unsigned input_count;           ///< @deprecated use nb_inputs
471 #endif
472     unsigned    nb_inputs;          ///< number of input pads
473
474     AVFilterPad   *output_pads;     ///< array of output pads
475     AVFilterLink **outputs;         ///< array of pointers to output links
476 #if FF_API_FOO_COUNT
477     unsigned output_count;          ///< @deprecated use nb_outputs
478 #endif
479     unsigned    nb_outputs;         ///< number of output pads
480
481     void *priv;                     ///< private data for use by the filter
482
483     struct AVFilterCommand *command_queue;
484 };
485
486 /**
487  * A link between two filters. This contains pointers to the source and
488  * destination filters between which this link exists, and the indexes of
489  * the pads involved. In addition, this link also contains the parameters
490  * which have been negotiated and agreed upon between the filter, such as
491  * image dimensions, format, etc.
492  */
493 struct AVFilterLink {
494     AVFilterContext *src;       ///< source filter
495     AVFilterPad *srcpad;        ///< output pad on the source filter
496
497     AVFilterContext *dst;       ///< dest filter
498     AVFilterPad *dstpad;        ///< input pad on the dest filter
499
500     enum AVMediaType type;      ///< filter media type
501
502     /* These parameters apply only to video */
503     int w;                      ///< agreed upon image width
504     int h;                      ///< agreed upon image height
505     AVRational sample_aspect_ratio; ///< agreed upon sample aspect ratio
506     /* These parameters apply only to audio */
507     uint64_t channel_layout;    ///< channel layout of current buffer (see libavutil/audioconvert.h)
508     int sample_rate;            ///< samples per second
509
510     int format;                 ///< agreed upon media format
511
512     /**
513      * Define the time base used by the PTS of the frames/samples
514      * which will pass through this link.
515      * During the configuration stage, each filter is supposed to
516      * change only the output timebase, while the timebase of the
517      * input link is assumed to be an unchangeable property.
518      */
519     AVRational time_base;
520
521     /*****************************************************************
522      * All fields below this line are not part of the public API. They
523      * may not be used outside of libavfilter and can be changed and
524      * removed at will.
525      * New public fields should be added right above.
526      *****************************************************************
527      */
528     /**
529      * Lists of formats and channel layouts supported by the input and output
530      * filters respectively. These lists are used for negotiating the format
531      * to actually be used, which will be loaded into the format and
532      * channel_layout members, above, when chosen.
533      *
534      */
535     AVFilterFormats *in_formats;
536     AVFilterFormats *out_formats;
537
538     /**
539      * Lists of channel layouts and sample rates used for automatic
540      * negotiation.
541      */
542     AVFilterFormats  *in_samplerates;
543     AVFilterFormats *out_samplerates;
544     struct AVFilterChannelLayouts  *in_channel_layouts;
545     struct AVFilterChannelLayouts *out_channel_layouts;
546
547     /**
548      * Audio only, the destination filter sets this to a non-zero value to
549      * request that buffers with the given number of samples should be sent to
550      * it. AVFilterPad.needs_fifo must also be set on the corresponding input
551      * pad.
552      * Last buffer before EOF will be padded with silence.
553      */
554     int request_samples;
555
556     /** stage of the initialization of the link properties (dimensions, etc) */
557     enum {
558         AVLINK_UNINIT = 0,      ///< not started
559         AVLINK_STARTINIT,       ///< started, but incomplete
560         AVLINK_INIT             ///< complete
561     } init_state;
562
563     /**
564      * The buffer reference currently being sent across the link by the source
565      * filter. This is used internally by the filter system to allow
566      * automatic copying of buffers which do not have sufficient permissions
567      * for the destination. This should not be accessed directly by the
568      * filters.
569      */
570     AVFilterBufferRef *src_buf;
571
572     AVFilterBufferRef *cur_buf;
573     AVFilterBufferRef *out_buf;
574
575     struct AVFilterPool *pool;
576
577     /**
578      * Graph the filter belongs to.
579      */
580     struct AVFilterGraph *graph;
581
582     /**
583      * Current timestamp of the link, as defined by the most recent
584      * frame(s), in AV_TIME_BASE units.
585      */
586     int64_t current_pts;
587
588     /**
589      * Index in the age array.
590      */
591     int age_index;
592
593     /**
594      * Frame rate of the stream on the link, or 1/0 if unknown;
595      * if left to 0/0, will be automatically be copied from the first input
596      * of the source filter if it exists.
597      *
598      * Sources should set it to the best estimation of the real frame rate.
599      * Filters should update it if necessary depending on their function.
600      * Sinks can use it to set a default output frame rate.
601      * It is similar to the r_frae_rate field in AVStream.
602      */
603     AVRational frame_rate;
604
605     /**
606      * Buffer partially filled with samples to achieve a fixed/minimum size.
607      */
608     AVFilterBufferRef *partial_buf;
609
610     /**
611      * Size of the partial buffer to allocate.
612      * Must be between min_samples and max_samples.
613      */
614     int partial_buf_size;
615
616     /**
617      * Minimum number of samples to filter at once. If filter_samples() is
618      * called with fewer samples, it will accumulate them in partial_buf.
619      * This field and the related ones must not be changed after filtering
620      * has started.
621      * If 0, all related fields are ignored.
622      */
623     int min_samples;
624
625     /**
626      * Maximum number of samples to filter at once. If filter_samples() is
627      * called with more samples, it will split them.
628      */
629     int max_samples;
630 };
631
632 /**
633  * Link two filters together.
634  *
635  * @param src    the source filter
636  * @param srcpad index of the output pad on the source filter
637  * @param dst    the destination filter
638  * @param dstpad index of the input pad on the destination filter
639  * @return       zero on success
640  */
641 int avfilter_link(AVFilterContext *src, unsigned srcpad,
642                   AVFilterContext *dst, unsigned dstpad);
643
644 /**
645  * Free the link in *link, and set its pointer to NULL.
646  */
647 void avfilter_link_free(AVFilterLink **link);
648
649 /**
650  * Negotiate the media format, dimensions, etc of all inputs to a filter.
651  *
652  * @param filter the filter to negotiate the properties for its inputs
653  * @return       zero on successful negotiation
654  */
655 int avfilter_config_links(AVFilterContext *filter);
656
657 /**
658  * Create a buffer reference wrapped around an already allocated image
659  * buffer.
660  *
661  * @param data pointers to the planes of the image to reference
662  * @param linesize linesizes for the planes of the image to reference
663  * @param perms the required access permissions
664  * @param w the width of the image specified by the data and linesize arrays
665  * @param h the height of the image specified by the data and linesize arrays
666  * @param format the pixel format of the image specified by the data and linesize arrays
667  */
668 AVFilterBufferRef *
669 avfilter_get_video_buffer_ref_from_arrays(uint8_t * const data[4], const int linesize[4], int perms,
670                                           int w, int h, enum PixelFormat format);
671
672 /**
673  * Create an audio buffer reference wrapped around an already
674  * allocated samples buffer.
675  *
676  * @param data           pointers to the samples plane buffers
677  * @param linesize       linesize for the samples plane buffers
678  * @param perms          the required access permissions
679  * @param nb_samples     number of samples per channel
680  * @param sample_fmt     the format of each sample in the buffer to allocate
681  * @param channel_layout the channel layout of the buffer
682  */
683 AVFilterBufferRef *avfilter_get_audio_buffer_ref_from_arrays(uint8_t **data,
684                                                              int linesize,
685                                                              int perms,
686                                                              int nb_samples,
687                                                              enum AVSampleFormat sample_fmt,
688                                                              uint64_t channel_layout);
689
690
691 #define AVFILTER_CMD_FLAG_ONE   1 ///< Stop once a filter understood the command (for target=all for example), fast filters are favored automatically
692 #define AVFILTER_CMD_FLAG_FAST  2 ///< Only execute command when its fast (like a video out that supports contrast adjustment in hw)
693
694 /**
695  * Make the filter instance process a command.
696  * It is recommended to use avfilter_graph_send_command().
697  */
698 int avfilter_process_command(AVFilterContext *filter, const char *cmd, const char *arg, char *res, int res_len, int flags);
699
700 /** Initialize the filter system. Register all builtin filters. */
701 void avfilter_register_all(void);
702
703 /** Uninitialize the filter system. Unregister all filters. */
704 void avfilter_uninit(void);
705
706 /**
707  * Register a filter. This is only needed if you plan to use
708  * avfilter_get_by_name later to lookup the AVFilter structure by name. A
709  * filter can still by instantiated with avfilter_open even if it is not
710  * registered.
711  *
712  * @param filter the filter to register
713  * @return 0 if the registration was successful, a negative value
714  * otherwise
715  */
716 int avfilter_register(AVFilter *filter);
717
718 /**
719  * Get a filter definition matching the given name.
720  *
721  * @param name the filter name to find
722  * @return     the filter definition, if any matching one is registered.
723  *             NULL if none found.
724  */
725 AVFilter *avfilter_get_by_name(const char *name);
726
727 /**
728  * If filter is NULL, returns a pointer to the first registered filter pointer,
729  * if filter is non-NULL, returns the next pointer after filter.
730  * If the returned pointer points to NULL, the last registered filter
731  * was already reached.
732  */
733 AVFilter **av_filter_next(AVFilter **filter);
734
735 /**
736  * Create a filter instance.
737  *
738  * @param filter_ctx put here a pointer to the created filter context
739  * on success, NULL on failure
740  * @param filter    the filter to create an instance of
741  * @param inst_name Name to give to the new instance. Can be NULL for none.
742  * @return >= 0 in case of success, a negative error code otherwise
743  */
744 int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name);
745
746 /**
747  * Initialize a filter.
748  *
749  * @param filter the filter to initialize
750  * @param args   A string of parameters to use when initializing the filter.
751  *               The format and meaning of this string varies by filter.
752  * @param opaque Any extra non-string data needed by the filter. The meaning
753  *               of this parameter varies by filter.
754  * @return       zero on success
755  */
756 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
757
758 /**
759  * Free a filter context.
760  *
761  * @param filter the filter to free
762  */
763 void avfilter_free(AVFilterContext *filter);
764
765 /**
766  * Insert a filter in the middle of an existing link.
767  *
768  * @param link the link into which the filter should be inserted
769  * @param filt the filter to be inserted
770  * @param filt_srcpad_idx the input pad on the filter to connect
771  * @param filt_dstpad_idx the output pad on the filter to connect
772  * @return     zero on success
773  */
774 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
775                            unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
776
777 #endif /* AVFILTER_AVFILTER_H */