12655bc3e608bedc6de85a2537ef7e19f4f12274
[ffmpeg.git] / libavfilter / internal.h
1 /*
2  * This file is part of Libav.
3  *
4  * Libav is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * Libav is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with Libav; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 #ifndef AVFILTER_INTERNAL_H
20 #define AVFILTER_INTERNAL_H
21
22 /**
23  * @file
24  * internal API functions
25  */
26
27 #include "libavutil/internal.h"
28 #include "avfilter.h"
29 #include "thread.h"
30 #include "version.h"
31
32 #if !FF_API_AVFILTERPAD_PUBLIC
33 /**
34  * A filter pad used for either input or output.
35  */
36 struct AVFilterPad {
37     /**
38      * Pad name. The name is unique among inputs and among outputs, but an
39      * input may have the same name as an output. This may be NULL if this
40      * pad has no need to ever be referenced by name.
41      */
42     const char *name;
43
44     /**
45      * AVFilterPad type.
46      */
47     enum AVMediaType type;
48
49     /**
50      * Callback function to get a video buffer. If NULL, the filter system will
51      * use avfilter_default_get_video_buffer().
52      *
53      * Input video pads only.
54      */
55     AVFrame *(*get_video_buffer)(AVFilterLink *link, int w, int h);
56
57     /**
58      * Callback function to get an audio buffer. If NULL, the filter system will
59      * use avfilter_default_get_audio_buffer().
60      *
61      * Input audio pads only.
62      */
63     AVFrame *(*get_audio_buffer)(AVFilterLink *link, int nb_samples);
64
65     /**
66      * Filtering callback. This is where a filter receives a frame with
67      * audio/video data and should do its processing.
68      *
69      * Input pads only.
70      *
71      * @return >= 0 on success, a negative AVERROR on error. This function
72      * must ensure that samplesref is properly unreferenced on error if it
73      * hasn't been passed on to another filter.
74      */
75     int (*filter_frame)(AVFilterLink *link, AVFrame *frame);
76
77     /**
78      * Frame poll callback. This returns the number of immediately available
79      * samples. It should return a positive value if the next request_frame()
80      * is guaranteed to return one frame (with no delay).
81      *
82      * Defaults to just calling the source poll_frame() method.
83      *
84      * Output pads only.
85      */
86     int (*poll_frame)(AVFilterLink *link);
87
88     /**
89      * Frame request callback. A call to this should result in at least one
90      * frame being output over the given link. This should return zero on
91      * success, and another value on error.
92      *
93      * Output pads only.
94      */
95     int (*request_frame)(AVFilterLink *link);
96
97     /**
98      * Link configuration callback.
99      *
100      * For output pads, this should set the link properties such as
101      * width/height. This should NOT set the format property - that is
102      * negotiated between filters by the filter system using the
103      * query_formats() callback before this function is called.
104      *
105      * For input pads, this should check the properties of the link, and update
106      * the filter's internal state as necessary.
107      *
108      * For both input and output filters, this should return zero on success,
109      * and another value on error.
110      */
111     int (*config_props)(AVFilterLink *link);
112
113     /**
114      * The filter expects a fifo to be inserted on its input link,
115      * typically because it has a delay.
116      *
117      * input pads only.
118      */
119     int needs_fifo;
120 };
121 #endif
122
123 struct AVFilterGraphInternal {
124     void *thread;
125     int (*thread_execute)(AVFilterContext *ctx, action_func *func, void *arg,
126                           int *ret, int nb_jobs);
127 };
128
129 struct AVFilterInternal {
130     int (*execute)(AVFilterContext *ctx, action_func *func, void *arg,
131                    int *ret, int nb_jobs);
132 };
133
134 #if FF_API_AVFILTERBUFFER
135 /** default handler for freeing audio/video buffer when there are no references left */
136 void ff_avfilter_default_free_buffer(AVFilterBuffer *buf);
137 #endif
138
139 /** Tell is a format is contained in the provided list terminated by -1. */
140 int ff_fmt_is_in(int fmt, const int *fmts);
141
142 #define FF_DPRINTF_START(ctx, func) av_dlog(NULL, "%-16s: ", #func)
143
144 void ff_dlog_link(void *ctx, AVFilterLink *link, int end);
145
146 /**
147  * Insert a new pad.
148  *
149  * @param idx Insertion point. Pad is inserted at the end if this point
150  *            is beyond the end of the list of pads.
151  * @param count Pointer to the number of pads in the list
152  * @param padidx_off Offset within an AVFilterLink structure to the element
153  *                   to increment when inserting a new pad causes link
154  *                   numbering to change
155  * @param pads Pointer to the pointer to the beginning of the list of pads
156  * @param links Pointer to the pointer to the beginning of the list of links
157  * @param newpad The new pad to add. A copy is made when adding.
158  */
159 void ff_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
160                    AVFilterPad **pads, AVFilterLink ***links,
161                    AVFilterPad *newpad);
162
163 /** Insert a new input pad for the filter. */
164 static inline void ff_insert_inpad(AVFilterContext *f, unsigned index,
165                                    AVFilterPad *p)
166 {
167     ff_insert_pad(index, &f->nb_inputs, offsetof(AVFilterLink, dstpad),
168                   &f->input_pads, &f->inputs, p);
169 #if FF_API_FOO_COUNT
170 FF_DISABLE_DEPRECATION_WARNINGS
171     f->input_count = f->nb_inputs;
172 FF_ENABLE_DEPRECATION_WARNINGS
173 #endif
174 }
175
176 /** Insert a new output pad for the filter. */
177 static inline void ff_insert_outpad(AVFilterContext *f, unsigned index,
178                                     AVFilterPad *p)
179 {
180     ff_insert_pad(index, &f->nb_outputs, offsetof(AVFilterLink, srcpad),
181                   &f->output_pads, &f->outputs, p);
182 #if FF_API_FOO_COUNT
183 FF_DISABLE_DEPRECATION_WARNINGS
184     f->output_count = f->nb_outputs;
185 FF_ENABLE_DEPRECATION_WARNINGS
186 #endif
187 }
188
189 /**
190  * Poll a frame from the filter chain.
191  *
192  * @param  link the input link
193  * @return the number of immediately available frames, a negative
194  * number in case of error
195  */
196 int ff_poll_frame(AVFilterLink *link);
197
198 /**
199  * Request an input frame from the filter at the other end of the link.
200  *
201  * @param link the input link
202  * @return     zero on success
203  */
204 int ff_request_frame(AVFilterLink *link);
205
206 /**
207  * Send a frame of data to the next filter.
208  *
209  * @param link   the output link over which the data is being sent
210  * @param frame a reference to the buffer of data being sent. The
211  *              receiving filter will free this reference when it no longer
212  *              needs it or pass it on to the next filter.
213  *
214  * @return >= 0 on success, a negative AVERROR on error. The receiving filter
215  * is responsible for unreferencing frame in case of error.
216  */
217 int ff_filter_frame(AVFilterLink *link, AVFrame *frame);
218
219 /**
220  * Allocate a new filter context and return it.
221  *
222  * @param filter what filter to create an instance of
223  * @param inst_name name to give to the new filter context
224  *
225  * @return newly created filter context or NULL on failure
226  */
227 AVFilterContext *ff_filter_alloc(const AVFilter *filter, const char *inst_name);
228
229 /**
230  * Remove a filter from a graph;
231  */
232 void ff_filter_graph_remove_filter(AVFilterGraph *graph, AVFilterContext *filter);
233
234 #endif /* AVFILTER_INTERNAL_H */