lavfi: add a function for counting elements in AVFilterPad arrays.
[ffmpeg.git] / libavfilter / avfilter.h
1 /*
2  * filter layer
3  * Copyright (c) 2007 Bobby Bingham
4  *
5  * This file is part of Libav.
6  *
7  * Libav is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * Libav is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #ifndef AVFILTER_AVFILTER_H
23 #define AVFILTER_AVFILTER_H
24
25 #include "libavutil/avutil.h"
26 #include "libavutil/frame.h"
27 #include "libavutil/log.h"
28 #include "libavutil/samplefmt.h"
29 #include "libavutil/pixfmt.h"
30 #include "libavutil/rational.h"
31 #include "libavcodec/avcodec.h"
32
33 #include <stddef.h>
34
35 #include "libavfilter/version.h"
36
37 /**
38  * Return the LIBAVFILTER_VERSION_INT constant.
39  */
40 unsigned avfilter_version(void);
41
42 /**
43  * Return the libavfilter build-time configuration.
44  */
45 const char *avfilter_configuration(void);
46
47 /**
48  * Return the libavfilter license.
49  */
50 const char *avfilter_license(void);
51
52
53 typedef struct AVFilterContext AVFilterContext;
54 typedef struct AVFilterLink    AVFilterLink;
55 typedef struct AVFilterPad     AVFilterPad;
56 typedef struct AVFilterFormats AVFilterFormats;
57
58 #if FF_API_AVFILTERBUFFER
59 /**
60  * A reference-counted buffer data type used by the filter system. Filters
61  * should not store pointers to this structure directly, but instead use the
62  * AVFilterBufferRef structure below.
63  */
64 typedef struct AVFilterBuffer {
65     uint8_t *data[8];           ///< buffer data for each plane/channel
66
67     /**
68      * pointers to the data planes/channels.
69      *
70      * For video, this should simply point to data[].
71      *
72      * For planar audio, each channel has a separate data pointer, and
73      * linesize[0] contains the size of each channel buffer.
74      * For packed audio, there is just one data pointer, and linesize[0]
75      * contains the total size of the buffer for all channels.
76      *
77      * Note: Both data and extended_data will always be set, but for planar
78      * audio with more channels that can fit in data, extended_data must be used
79      * in order to access all channels.
80      */
81     uint8_t **extended_data;
82     int linesize[8];            ///< number of bytes per line
83
84     /** private data to be used by a custom free function */
85     void *priv;
86     /**
87      * A pointer to the function to deallocate this buffer if the default
88      * function is not sufficient. This could, for example, add the memory
89      * back into a memory pool to be reused later without the overhead of
90      * reallocating it from scratch.
91      */
92     void (*free)(struct AVFilterBuffer *buf);
93
94     int format;                 ///< media format
95     int w, h;                   ///< width and height of the allocated buffer
96     unsigned refcount;          ///< number of references to this buffer
97 } AVFilterBuffer;
98
99 #define AV_PERM_READ     0x01   ///< can read from the buffer
100 #define AV_PERM_WRITE    0x02   ///< can write to the buffer
101 #define AV_PERM_PRESERVE 0x04   ///< nobody else can overwrite the buffer
102 #define AV_PERM_REUSE    0x08   ///< can output the buffer multiple times, with the same contents each time
103 #define AV_PERM_REUSE2   0x10   ///< can output the buffer multiple times, modified each time
104 #define AV_PERM_NEG_LINESIZES 0x20  ///< the buffer requested can have negative linesizes
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
114     int sample_rate;            ///< audio buffer sample rate
115     int planar;                 ///< audio buffer - planar or packed
116 } AVFilterBufferRefAudioProps;
117
118 /**
119  * Video specific properties in a reference to an AVFilterBuffer. Since
120  * AVFilterBufferRef is common to different media formats, video specific
121  * per reference properties must be separated out.
122  */
123 typedef struct AVFilterBufferRefVideoProps {
124     int w;                      ///< image width
125     int h;                      ///< image height
126     AVRational pixel_aspect;    ///< pixel aspect ratio
127     int interlaced;             ///< is frame interlaced
128     int top_field_first;        ///< field order
129     enum AVPictureType pict_type; ///< picture type of the frame
130     int key_frame;              ///< 1 -> keyframe, 0-> not
131 } AVFilterBufferRefVideoProps;
132
133 /**
134  * A reference to an AVFilterBuffer. Since filters can manipulate the origin of
135  * a buffer to, for example, crop image without any memcpy, the buffer origin
136  * and dimensions are per-reference properties. Linesize is also useful for
137  * image flipping, frame to field filters, etc, and so is also per-reference.
138  *
139  * TODO: add anything necessary for frame reordering
140  */
141 typedef struct AVFilterBufferRef {
142     AVFilterBuffer *buf;        ///< the buffer that this is a reference to
143     uint8_t *data[8];           ///< picture/audio data for each plane
144     /**
145      * pointers to the data planes/channels.
146      *
147      * For video, this should simply point to data[].
148      *
149      * For planar audio, each channel has a separate data pointer, and
150      * linesize[0] contains the size of each channel buffer.
151      * For packed audio, there is just one data pointer, and linesize[0]
152      * contains the total size of the buffer for all channels.
153      *
154      * Note: Both data and extended_data will always be set, but for planar
155      * audio with more channels that can fit in data, extended_data must be used
156      * in order to access all channels.
157      */
158     uint8_t **extended_data;
159     int linesize[8];            ///< number of bytes per line
160
161     AVFilterBufferRefVideoProps *video; ///< video buffer specific properties
162     AVFilterBufferRefAudioProps *audio; ///< audio buffer specific properties
163
164     /**
165      * presentation timestamp. The time unit may change during
166      * filtering, as it is specified in the link and the filter code
167      * may need to rescale the PTS accordingly.
168      */
169     int64_t pts;
170     int64_t pos;                ///< byte position in stream, -1 if unknown
171
172     int format;                 ///< media format
173
174     int perms;                  ///< permissions, see the AV_PERM_* flags
175
176     enum AVMediaType type;      ///< media type of buffer data
177 } AVFilterBufferRef;
178
179 /**
180  * Copy properties of src to dst, without copying the actual data
181  */
182 attribute_deprecated
183 void avfilter_copy_buffer_ref_props(AVFilterBufferRef *dst, AVFilterBufferRef *src);
184
185 /**
186  * Add a new reference to a buffer.
187  *
188  * @param ref   an existing reference to the buffer
189  * @param pmask a bitmask containing the allowable permissions in the new
190  *              reference
191  * @return      a new reference to the buffer with the same properties as the
192  *              old, excluding any permissions denied by pmask
193  */
194 attribute_deprecated
195 AVFilterBufferRef *avfilter_ref_buffer(AVFilterBufferRef *ref, int pmask);
196
197 /**
198  * Remove a reference to a buffer. If this is the last reference to the
199  * buffer, the buffer itself is also automatically freed.
200  *
201  * @param ref reference to the buffer, may be NULL
202  *
203  * @note it is recommended to use avfilter_unref_bufferp() instead of this
204  * function
205  */
206 attribute_deprecated
207 void avfilter_unref_buffer(AVFilterBufferRef *ref);
208
209 /**
210  * Remove a reference to a buffer and set the pointer to NULL.
211  * If this is the last reference to the buffer, the buffer itself
212  * is also automatically freed.
213  *
214  * @param ref pointer to the buffer reference
215  */
216 attribute_deprecated
217 void avfilter_unref_bufferp(AVFilterBufferRef **ref);
218 #endif
219
220 #if FF_API_AVFILTERPAD_PUBLIC
221 /**
222  * A filter pad used for either input or output.
223  *
224  * @warning this struct will be removed from public API.
225  * users should call avfilter_pad_get_name() and avfilter_pad_get_type()
226  * to access the name and type fields; there should be no need to access
227  * any other fields from outside of libavfilter.
228  */
229 struct AVFilterPad {
230     /**
231      * Pad name. The name is unique among inputs and among outputs, but an
232      * input may have the same name as an output. This may be NULL if this
233      * pad has no need to ever be referenced by name.
234      */
235     const char *name;
236
237     /**
238      * AVFilterPad type.
239      */
240     enum AVMediaType type;
241
242     /**
243      * Minimum required permissions on incoming buffers. Any buffer with
244      * insufficient permissions will be automatically copied by the filter
245      * system to a new buffer which provides the needed access permissions.
246      *
247      * Input pads only.
248      */
249     attribute_deprecated int min_perms;
250
251     /**
252      * Permissions which are not accepted on incoming buffers. Any buffer
253      * which has any of these permissions set will be automatically copied
254      * by the filter system to a new buffer which does not have those
255      * permissions. This can be used to easily disallow buffers with
256      * AV_PERM_REUSE.
257      *
258      * Input pads only.
259      */
260     attribute_deprecated int rej_perms;
261
262     /**
263      * @deprecated unused
264      */
265     int (*start_frame)(AVFilterLink *link, AVFilterBufferRef *picref);
266
267     /**
268      * Callback function to get a video buffer. If NULL, the filter system will
269      * use avfilter_default_get_video_buffer().
270      *
271      * Input video pads only.
272      */
273     AVFrame *(*get_video_buffer)(AVFilterLink *link, int w, int h);
274
275     /**
276      * Callback function to get an audio buffer. If NULL, the filter system will
277      * use avfilter_default_get_audio_buffer().
278      *
279      * Input audio pads only.
280      */
281     AVFrame *(*get_audio_buffer)(AVFilterLink *link, int nb_samples);
282
283     /**
284      * @deprecated unused
285      */
286     int (*end_frame)(AVFilterLink *link);
287
288     /**
289      * @deprecated unused
290      */
291     int (*draw_slice)(AVFilterLink *link, int y, int height, int slice_dir);
292
293     /**
294      * Filtering callback. This is where a filter receives a frame with
295      * audio/video data and should do its processing.
296      *
297      * Input pads only.
298      *
299      * @return >= 0 on success, a negative AVERROR on error. This function
300      * must ensure that samplesref is properly unreferenced on error if it
301      * hasn't been passed on to another filter.
302      */
303     int (*filter_frame)(AVFilterLink *link, AVFrame *frame);
304
305     /**
306      * Frame poll callback. This returns the number of immediately available
307      * samples. It should return a positive value if the next request_frame()
308      * is guaranteed to return one frame (with no delay).
309      *
310      * Defaults to just calling the source poll_frame() method.
311      *
312      * Output pads only.
313      */
314     int (*poll_frame)(AVFilterLink *link);
315
316     /**
317      * Frame request callback. A call to this should result in at least one
318      * frame being output over the given link. This should return zero on
319      * success, and another value on error.
320      *
321      * Output pads only.
322      */
323     int (*request_frame)(AVFilterLink *link);
324
325     /**
326      * Link configuration callback.
327      *
328      * For output pads, this should set the link properties such as
329      * width/height. This should NOT set the format property - that is
330      * negotiated between filters by the filter system using the
331      * query_formats() callback before this function is called.
332      *
333      * For input pads, this should check the properties of the link, and update
334      * the filter's internal state as necessary.
335      *
336      * For both input and output filters, this should return zero on success,
337      * and another value on error.
338      */
339     int (*config_props)(AVFilterLink *link);
340
341     /**
342      * The filter expects a fifo to be inserted on its input link,
343      * typically because it has a delay.
344      *
345      * input pads only.
346      */
347     int needs_fifo;
348
349     int needs_writable;
350 };
351 #endif
352
353 /**
354  * Get the number of elements in a NULL-terminated array of AVFilterPads (e.g.
355  * AVFilter.inputs/outputs).
356  */
357 int avfilter_pad_count(const AVFilterPad *pads);
358
359 /**
360  * Get the name of an AVFilterPad.
361  *
362  * @param pads an array of AVFilterPads
363  * @param pad_idx index of the pad in the array it; is the caller's
364  *                responsibility to ensure the index is valid
365  *
366  * @return name of the pad_idx'th pad in pads
367  */
368 const char *avfilter_pad_get_name(const AVFilterPad *pads, int pad_idx);
369
370 /**
371  * Get the type of an AVFilterPad.
372  *
373  * @param pads an array of AVFilterPads
374  * @param pad_idx index of the pad in the array; it is the caller's
375  *                responsibility to ensure the index is valid
376  *
377  * @return type of the pad_idx'th pad in pads
378  */
379 enum AVMediaType avfilter_pad_get_type(const AVFilterPad *pads, int pad_idx);
380
381 /**
382  * The number of the filter inputs is not determined just by AVFilter.inputs.
383  * The filter might add additional inputs during initialization depending on the
384  * options supplied to it.
385  */
386 #define AVFILTER_FLAG_DYNAMIC_INPUTS        (1 << 0)
387 /**
388  * The number of the filter outputs is not determined just by AVFilter.outputs.
389  * The filter might add additional outputs during initialization depending on
390  * the options supplied to it.
391  */
392 #define AVFILTER_FLAG_DYNAMIC_OUTPUTS       (1 << 1)
393
394 /**
395  * Filter definition. This defines the pads a filter contains, and all the
396  * callback functions used to interact with the filter.
397  */
398 typedef struct AVFilter {
399     const char *name;         ///< filter name
400
401     /**
402      * A description for the filter. You should use the
403      * NULL_IF_CONFIG_SMALL() macro to define it.
404      */
405     const char *description;
406
407     const AVFilterPad *inputs;  ///< NULL terminated list of inputs. NULL if none
408     const AVFilterPad *outputs; ///< NULL terminated list of outputs. NULL if none
409
410     /**
411      * A class for the private data, used to access filter private
412      * AVOptions.
413      */
414     const AVClass *priv_class;
415
416     /**
417      * A combination of AVFILTER_FLAG_*
418      */
419     int flags;
420
421     /*****************************************************************
422      * All fields below this line are not part of the public API. They
423      * may not be used outside of libavfilter and can be changed and
424      * removed at will.
425      * New public fields should be added right above.
426      *****************************************************************
427      */
428
429     /**
430      * Filter initialization function. Called when all the options have been
431      * set.
432      */
433     int (*init)(AVFilterContext *ctx);
434
435     /**
436      * Should be set instead of init by the filters that want to pass a
437      * dictionary of AVOptions to nested contexts that are allocated in
438      * init.
439      */
440     int (*init_dict)(AVFilterContext *ctx, AVDictionary **options);
441
442     /**
443      * Filter uninitialization function. Should deallocate any memory held
444      * by the filter, release any buffer references, etc. This does not need
445      * to deallocate the AVFilterContext->priv memory itself.
446      */
447     void (*uninit)(AVFilterContext *ctx);
448
449     /**
450      * Queries formats supported by the filter and its pads, and sets the
451      * in_formats for links connected to its output pads, and out_formats
452      * for links connected to its input pads.
453      *
454      * @return zero on success, a negative value corresponding to an
455      * AVERROR code otherwise
456      */
457     int (*query_formats)(AVFilterContext *);
458
459     int priv_size;      ///< size of private data to allocate for the filter
460 } AVFilter;
461
462 /** An instance of a filter */
463 struct AVFilterContext {
464     const AVClass *av_class;              ///< needed for av_log()
465
466     const AVFilter *filter;         ///< the AVFilter of which this is an instance
467
468     char *name;                     ///< name of this filter instance
469
470     AVFilterPad   *input_pads;      ///< array of input pads
471     AVFilterLink **inputs;          ///< array of pointers to input links
472 #if FF_API_FOO_COUNT
473     unsigned input_count;           ///< @deprecated use nb_inputs
474 #endif
475     unsigned    nb_inputs;          ///< number of input pads
476
477     AVFilterPad   *output_pads;     ///< array of output pads
478     AVFilterLink **outputs;         ///< array of pointers to output links
479 #if FF_API_FOO_COUNT
480     unsigned output_count;          ///< @deprecated use nb_outputs
481 #endif
482     unsigned    nb_outputs;         ///< number of output pads
483
484     void *priv;                     ///< private data for use by the filter
485
486     struct AVFilterGraph *graph;    ///< filtergraph this filter belongs to
487 };
488
489 /**
490  * A link between two filters. This contains pointers to the source and
491  * destination filters between which this link exists, and the indexes of
492  * the pads involved. In addition, this link also contains the parameters
493  * which have been negotiated and agreed upon between the filter, such as
494  * image dimensions, format, etc.
495  */
496 struct AVFilterLink {
497     AVFilterContext *src;       ///< source filter
498     AVFilterPad *srcpad;        ///< output pad on the source filter
499
500     AVFilterContext *dst;       ///< dest filter
501     AVFilterPad *dstpad;        ///< input pad on the dest filter
502
503     enum AVMediaType type;      ///< filter media type
504
505     /* These parameters apply only to video */
506     int w;                      ///< agreed upon image width
507     int h;                      ///< agreed upon image height
508     AVRational sample_aspect_ratio; ///< agreed upon sample aspect ratio
509     /* These two parameters apply only to audio */
510     uint64_t channel_layout;    ///< channel layout of current buffer (see libavutil/channel_layout.h)
511     int sample_rate;            ///< samples per second
512
513     int format;                 ///< agreed upon media format
514
515     /**
516      * Define the time base used by the PTS of the frames/samples
517      * which will pass through this link.
518      * During the configuration stage, each filter is supposed to
519      * change only the output timebase, while the timebase of the
520      * input link is assumed to be an unchangeable property.
521      */
522     AVRational time_base;
523
524     /*****************************************************************
525      * All fields below this line are not part of the public API. They
526      * may not be used outside of libavfilter and can be changed and
527      * removed at will.
528      * New public fields should be added right above.
529      *****************************************************************
530      */
531     /**
532      * Lists of formats supported by the input and output filters respectively.
533      * These lists are used for negotiating the format to actually be used,
534      * which will be loaded into the format member, above, when chosen.
535      */
536     AVFilterFormats *in_formats;
537     AVFilterFormats *out_formats;
538
539     /**
540      * Lists of channel layouts and sample rates used for automatic
541      * negotiation.
542      */
543     AVFilterFormats  *in_samplerates;
544     AVFilterFormats *out_samplerates;
545     struct AVFilterChannelLayouts  *in_channel_layouts;
546     struct AVFilterChannelLayouts *out_channel_layouts;
547
548     /**
549      * Audio only, the destination filter sets this to a non-zero value to
550      * request that buffers with the given number of samples should be sent to
551      * it. AVFilterPad.needs_fifo must also be set on the corresponding input
552      * pad.
553      * Last buffer before EOF will be padded with silence.
554      */
555     int request_samples;
556
557     /** stage of the initialization of the link properties (dimensions, etc) */
558     enum {
559         AVLINK_UNINIT = 0,      ///< not started
560         AVLINK_STARTINIT,       ///< started, but incomplete
561         AVLINK_INIT             ///< complete
562     } init_state;
563 };
564
565 /**
566  * Link two filters together.
567  *
568  * @param src    the source filter
569  * @param srcpad index of the output pad on the source filter
570  * @param dst    the destination filter
571  * @param dstpad index of the input pad on the destination filter
572  * @return       zero on success
573  */
574 int avfilter_link(AVFilterContext *src, unsigned srcpad,
575                   AVFilterContext *dst, unsigned dstpad);
576
577 /**
578  * Negotiate the media format, dimensions, etc of all inputs to a filter.
579  *
580  * @param filter the filter to negotiate the properties for its inputs
581  * @return       zero on successful negotiation
582  */
583 int avfilter_config_links(AVFilterContext *filter);
584
585 #if FF_API_AVFILTERBUFFER
586 /**
587  * Create a buffer reference wrapped around an already allocated image
588  * buffer.
589  *
590  * @param data pointers to the planes of the image to reference
591  * @param linesize linesizes for the planes of the image to reference
592  * @param perms the required access permissions
593  * @param w the width of the image specified by the data and linesize arrays
594  * @param h the height of the image specified by the data and linesize arrays
595  * @param format the pixel format of the image specified by the data and linesize arrays
596  */
597 attribute_deprecated
598 AVFilterBufferRef *
599 avfilter_get_video_buffer_ref_from_arrays(uint8_t *data[4], int linesize[4], int perms,
600                                           int w, int h, enum AVPixelFormat format);
601
602 /**
603  * Create an audio buffer reference wrapped around an already
604  * allocated samples buffer.
605  *
606  * @param data           pointers to the samples plane buffers
607  * @param linesize       linesize for the samples plane buffers
608  * @param perms          the required access permissions
609  * @param nb_samples     number of samples per channel
610  * @param sample_fmt     the format of each sample in the buffer to allocate
611  * @param channel_layout the channel layout of the buffer
612  */
613 attribute_deprecated
614 AVFilterBufferRef *avfilter_get_audio_buffer_ref_from_arrays(uint8_t **data,
615                                                              int linesize,
616                                                              int perms,
617                                                              int nb_samples,
618                                                              enum AVSampleFormat sample_fmt,
619                                                              uint64_t channel_layout);
620 #endif
621
622 /** Initialize the filter system. Register all builtin filters. */
623 void avfilter_register_all(void);
624
625 /** Uninitialize the filter system. Unregister all filters. */
626 void avfilter_uninit(void);
627
628 /**
629  * Register a filter. This is only needed if you plan to use
630  * avfilter_get_by_name later to lookup the AVFilter structure by name. A
631  * filter can still by instantiated with avfilter_graph_alloc_filter even if it
632  * is not registered.
633  *
634  * @param filter the filter to register
635  * @return 0 if the registration was succesfull, a negative value
636  * otherwise
637  */
638 int avfilter_register(AVFilter *filter);
639
640 /**
641  * Get a filter definition matching the given name.
642  *
643  * @param name the filter name to find
644  * @return     the filter definition, if any matching one is registered.
645  *             NULL if none found.
646  */
647 AVFilter *avfilter_get_by_name(const char *name);
648
649 /**
650  * If filter is NULL, returns a pointer to the first registered filter pointer,
651  * if filter is non-NULL, returns the next pointer after filter.
652  * If the returned pointer points to NULL, the last registered filter
653  * was already reached.
654  */
655 AVFilter **av_filter_next(AVFilter **filter);
656
657 #if FF_API_AVFILTER_OPEN
658 /**
659  * Create a filter instance.
660  *
661  * @param filter_ctx put here a pointer to the created filter context
662  * on success, NULL on failure
663  * @param filter    the filter to create an instance of
664  * @param inst_name Name to give to the new instance. Can be NULL for none.
665  * @return >= 0 in case of success, a negative error code otherwise
666  * @deprecated use avfilter_graph_alloc_filter() instead
667  */
668 attribute_deprecated
669 int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name);
670 #endif
671
672
673 #if FF_API_AVFILTER_INIT_FILTER
674 /**
675  * Initialize a filter.
676  *
677  * @param filter the filter to initialize
678  * @param args   A string of parameters to use when initializing the filter.
679  *               The format and meaning of this string varies by filter.
680  * @param opaque Any extra non-string data needed by the filter. The meaning
681  *               of this parameter varies by filter.
682  * @return       zero on success
683  */
684 attribute_deprecated
685 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
686 #endif
687
688 /**
689  * Initialize a filter with the supplied parameters.
690  *
691  * @param ctx  uninitialized filter context to initialize
692  * @param args Options to initialize the filter with. This must be a
693  *             ':'-separated list of options in the 'key=value' form.
694  *             May be NULL if the options have been set directly using the
695  *             AVOptions API or there are no options that need to be set.
696  * @return 0 on success, a negative AVERROR on failure
697  */
698 int avfilter_init_str(AVFilterContext *ctx, const char *args);
699
700 /**
701  * Initialize a filter with the supplied dictionary of options.
702  *
703  * @param ctx     uninitialized filter context to initialize
704  * @param options An AVDictionary filled with options for this filter. On
705  *                return this parameter will be destroyed and replaced with
706  *                a dict containing options that were not found. This dictionary
707  *                must be freed by the caller.
708  *                May be NULL, then this function is equivalent to
709  *                avfilter_init_str() with the second parameter set to NULL.
710  * @return 0 on success, a negative AVERROR on failure
711  *
712  * @note This function and avfilter_init_str() do essentially the same thing,
713  * the difference is in manner in which the options are passed. It is up to the
714  * calling code to choose whichever is more preferable. The two functions also
715  * behave differently when some of the provided options are not declared as
716  * supported by the filter. In such a case, avfilter_init_str() will fail, but
717  * this function will leave those extra options in the options AVDictionary and
718  * continue as usual.
719  */
720 int avfilter_init_dict(AVFilterContext *ctx, AVDictionary **options);
721
722 /**
723  * Free a filter context. This will also remove the filter from its
724  * filtergraph's list of filters.
725  *
726  * @param filter the filter to free
727  */
728 void avfilter_free(AVFilterContext *filter);
729
730 /**
731  * Insert a filter in the middle of an existing link.
732  *
733  * @param link the link into which the filter should be inserted
734  * @param filt the filter to be inserted
735  * @param filt_srcpad_idx the input pad on the filter to connect
736  * @param filt_dstpad_idx the output pad on the filter to connect
737  * @return     zero on success
738  */
739 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
740                            unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
741
742 #if FF_API_AVFILTERBUFFER
743 /**
744  * Copy the frame properties of src to dst, without copying the actual
745  * image data.
746  *
747  * @return 0 on success, a negative number on error.
748  */
749 attribute_deprecated
750 int avfilter_copy_frame_props(AVFilterBufferRef *dst, const AVFrame *src);
751
752 /**
753  * Copy the frame properties and data pointers of src to dst, without copying
754  * the actual data.
755  *
756  * @return 0 on success, a negative number on error.
757  */
758 attribute_deprecated
759 int avfilter_copy_buf_props(AVFrame *dst, const AVFilterBufferRef *src);
760 #endif
761
762 /**
763  * @return AVClass for AVFilterContext.
764  *
765  * @see av_opt_find().
766  */
767 const AVClass *avfilter_get_class(void);
768
769 typedef struct AVFilterGraph {
770     const AVClass *av_class;
771 #if FF_API_FOO_COUNT
772     attribute_deprecated
773     unsigned filter_count;
774 #endif
775     AVFilterContext **filters;
776 #if !FF_API_FOO_COUNT
777     unsigned nb_filters;
778 #endif
779
780     char *scale_sws_opts; ///< sws options to use for the auto-inserted scale filters
781     char *resample_lavr_opts;   ///< libavresample options to use for the auto-inserted resample filters
782 #if FF_API_FOO_COUNT
783     unsigned nb_filters;
784 #endif
785 } AVFilterGraph;
786
787 /**
788  * Allocate a filter graph.
789  */
790 AVFilterGraph *avfilter_graph_alloc(void);
791
792 /**
793  * Create a new filter instance in a filter graph.
794  *
795  * @param graph graph in which the new filter will be used
796  * @param filter the filter to create an instance of
797  * @param name Name to give to the new instance (will be copied to
798  *             AVFilterContext.name). This may be used by the caller to identify
799  *             different filters, libavfilter itself assigns no semantics to
800  *             this parameter. May be NULL.
801  *
802  * @return the context of the newly created filter instance (note that it is
803  *         also retrievable directly through AVFilterGraph.filters or with
804  *         avfilter_graph_get_filter()) on success or NULL or failure.
805  */
806 AVFilterContext *avfilter_graph_alloc_filter(AVFilterGraph *graph,
807                                              const AVFilter *filter,
808                                              const char *name);
809
810 /**
811  * Get a filter instance with name name from graph.
812  *
813  * @return the pointer to the found filter instance or NULL if it
814  * cannot be found.
815  */
816 AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, char *name);
817
818 #if FF_API_AVFILTER_OPEN
819 /**
820  * Add an existing filter instance to a filter graph.
821  *
822  * @param graphctx  the filter graph
823  * @param filter the filter to be added
824  *
825  * @deprecated use avfilter_graph_alloc_filter() to allocate a filter in a
826  * filter graph
827  */
828 attribute_deprecated
829 int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter);
830 #endif
831
832 /**
833  * Create and add a filter instance into an existing graph.
834  * The filter instance is created from the filter filt and inited
835  * with the parameters args and opaque.
836  *
837  * In case of success put in *filt_ctx the pointer to the created
838  * filter instance, otherwise set *filt_ctx to NULL.
839  *
840  * @param name the instance name to give to the created filter instance
841  * @param graph_ctx the filter graph
842  * @return a negative AVERROR error code in case of failure, a non
843  * negative value otherwise
844  */
845 int avfilter_graph_create_filter(AVFilterContext **filt_ctx, AVFilter *filt,
846                                  const char *name, const char *args, void *opaque,
847                                  AVFilterGraph *graph_ctx);
848
849 /**
850  * Check validity and configure all the links and formats in the graph.
851  *
852  * @param graphctx the filter graph
853  * @param log_ctx context used for logging
854  * @return 0 in case of success, a negative AVERROR code otherwise
855  */
856 int avfilter_graph_config(AVFilterGraph *graphctx, void *log_ctx);
857
858 /**
859  * Free a graph, destroy its links, and set *graph to NULL.
860  * If *graph is NULL, do nothing.
861  */
862 void avfilter_graph_free(AVFilterGraph **graph);
863
864 /**
865  * A linked-list of the inputs/outputs of the filter chain.
866  *
867  * This is mainly useful for avfilter_graph_parse() / avfilter_graph_parse2(),
868  * where it is used to communicate open (unlinked) inputs and outputs from and
869  * to the caller.
870  * This struct specifies, per each not connected pad contained in the graph, the
871  * filter context and the pad index required for establishing a link.
872  */
873 typedef struct AVFilterInOut {
874     /** unique name for this input/output in the list */
875     char *name;
876
877     /** filter context associated to this input/output */
878     AVFilterContext *filter_ctx;
879
880     /** index of the filt_ctx pad to use for linking */
881     int pad_idx;
882
883     /** next input/input in the list, NULL if this is the last */
884     struct AVFilterInOut *next;
885 } AVFilterInOut;
886
887 /**
888  * Allocate a single AVFilterInOut entry.
889  * Must be freed with avfilter_inout_free().
890  * @return allocated AVFilterInOut on success, NULL on failure.
891  */
892 AVFilterInOut *avfilter_inout_alloc(void);
893
894 /**
895  * Free the supplied list of AVFilterInOut and set *inout to NULL.
896  * If *inout is NULL, do nothing.
897  */
898 void avfilter_inout_free(AVFilterInOut **inout);
899
900 /**
901  * Add a graph described by a string to a graph.
902  *
903  * @param graph   the filter graph where to link the parsed graph context
904  * @param filters string to be parsed
905  * @param inputs  linked list to the inputs of the graph
906  * @param outputs linked list to the outputs of the graph
907  * @return zero on success, a negative AVERROR code on error
908  */
909 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
910                          AVFilterInOut *inputs, AVFilterInOut *outputs,
911                          void *log_ctx);
912
913 /**
914  * Add a graph described by a string to a graph.
915  *
916  * @param[in]  graph   the filter graph where to link the parsed graph context
917  * @param[in]  filters string to be parsed
918  * @param[out] inputs  a linked list of all free (unlinked) inputs of the
919  *                     parsed graph will be returned here. It is to be freed
920  *                     by the caller using avfilter_inout_free().
921  * @param[out] outputs a linked list of all free (unlinked) outputs of the
922  *                     parsed graph will be returned here. It is to be freed by the
923  *                     caller using avfilter_inout_free().
924  * @return zero on success, a negative AVERROR code on error
925  *
926  * @note the difference between avfilter_graph_parse2() and
927  * avfilter_graph_parse() is that in avfilter_graph_parse(), the caller provides
928  * the lists of inputs and outputs, which therefore must be known before calling
929  * the function. On the other hand, avfilter_graph_parse2() \em returns the
930  * inputs and outputs that are left unlinked after parsing the graph and the
931  * caller then deals with them. Another difference is that in
932  * avfilter_graph_parse(), the inputs parameter describes inputs of the
933  * <em>already existing</em> part of the graph; i.e. from the point of view of
934  * the newly created part, they are outputs. Similarly the outputs parameter
935  * describes outputs of the already existing filters, which are provided as
936  * inputs to the parsed filters.
937  * avfilter_graph_parse2() takes the opposite approach -- it makes no reference
938  * whatsoever to already existing parts of the graph and the inputs parameter
939  * will on return contain inputs of the newly parsed part of the graph.
940  * Analogously the outputs parameter will contain outputs of the newly created
941  * filters.
942  */
943 int avfilter_graph_parse2(AVFilterGraph *graph, const char *filters,
944                           AVFilterInOut **inputs,
945                           AVFilterInOut **outputs);
946
947 #endif /* AVFILTER_AVFILTER_H */