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