FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
internal.h
Go to the documentation of this file.
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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 "avfilter.h"
28 #include "avfiltergraph.h"
29 #include "formats.h"
30 #include "thread.h"
31 #include "video.h"
32 
33 #define POOL_SIZE 32
34 typedef struct AVFilterPool {
35  AVFilterBufferRef *pic[POOL_SIZE];
36  int count;
37  int refcount;
38  int draining;
39 } AVFilterPool;
40 
41 typedef struct AVFilterCommand {
42  double time; ///< time expressed in seconds
43  char *command; ///< command
44  char *arg; ///< optional argument for the command
45  int flags;
48 
49 /**
50  * Update the position of a link in the age heap.
51  */
53 
54 #if !FF_API_AVFILTERPAD_PUBLIC
55 /**
56  * A filter pad used for either input or output.
57  */
58 struct AVFilterPad {
59  /**
60  * Pad name. The name is unique among inputs and among outputs, but an
61  * input may have the same name as an output. This may be NULL if this
62  * pad has no need to ever be referenced by name.
63  */
64  const char *name;
65 
66  /**
67  * AVFilterPad type.
68  */
70 
71  /**
72  * Callback function to get a video buffer. If NULL, the filter system will
73  * use ff_default_get_video_buffer().
74  *
75  * Input video pads only.
76  */
77  AVFrame *(*get_video_buffer)(AVFilterLink *link, int w, int h);
78 
79  /**
80  * Callback function to get an audio buffer. If NULL, the filter system will
81  * use ff_default_get_audio_buffer().
82  *
83  * Input audio pads only.
84  */
85  AVFrame *(*get_audio_buffer)(AVFilterLink *link, int nb_samples);
86 
87  /**
88  * Filtering callback. This is where a filter receives a frame with
89  * audio/video data and should do its processing.
90  *
91  * Input pads only.
92  *
93  * @return >= 0 on success, a negative AVERROR on error. This function
94  * must ensure that samplesref is properly unreferenced on error if it
95  * hasn't been passed on to another filter.
96  */
98 
99  /**
100  * Frame poll callback. This returns the number of immediately available
101  * samples. It should return a positive value if the next request_frame()
102  * is guaranteed to return one frame (with no delay).
103  *
104  * Defaults to just calling the source poll_frame() method.
105  *
106  * Output pads only.
107  */
108  int (*poll_frame)(AVFilterLink *link);
109 
110  /**
111  * Frame request callback. A call to this should result in at least one
112  * frame being output over the given link. This should return zero on
113  * success, and another value on error.
114  *
115  * Output pads only.
116  */
118 
119  /**
120  * Link configuration callback.
121  *
122  * For output pads, this should set the link properties such as
123  * width/height. This should NOT set the format property - that is
124  * negotiated between filters by the filter system using the
125  * query_formats() callback before this function is called.
126  *
127  * For input pads, this should check the properties of the link, and update
128  * the filter's internal state as necessary.
129  *
130  * For both input and output filters, this should return zero on success,
131  * and another value on error.
132  */
133  int (*config_props)(AVFilterLink *link);
134 
135  /**
136  * The filter expects a fifo to be inserted on its input link,
137  * typically because it has a delay.
138  *
139  * input pads only.
140  */
142 };
143 #endif
144 
146  void *thread;
148  int *ret, int nb_jobs);
149 };
150 
153  int *ret, int nb_jobs);
154 };
155 
156 /** default handler for freeing audio/video buffer when there are no references left */
157 void ff_avfilter_default_free_buffer(AVFilterBuffer *buf);
158 
159 /** Tell is a format is contained in the provided list terminated by -1. */
160 int ff_fmt_is_in(int fmt, const int *fmts);
161 
162 /**
163  * Return a copy of a list of integers terminated by -1, or NULL in
164  * case of copy failure.
165  */
166 int *ff_copy_int_list(const int * const list);
167 
168 /**
169  * Return a copy of a list of 64-bit integers, or NULL in case of
170  * copy failure.
171  */
172 int64_t *ff_copy_int64_list(const int64_t * const list);
173 
174 /* Functions to parse audio format arguments */
175 
176 /**
177  * Parse a pixel format.
178  *
179  * @param ret pixel format pointer to where the value should be written
180  * @param arg string to parse
181  * @param log_ctx log context
182  * @return 0 in case of success, a negative AVERROR code on error
183  */
184 int ff_parse_pixel_format(enum AVPixelFormat *ret, const char *arg, void *log_ctx);
185 
186 /**
187  * Parse a sample rate.
188  *
189  * @param ret unsigned integer pointer to where the value should be written
190  * @param arg string to parse
191  * @param log_ctx log context
192  * @return 0 in case of success, a negative AVERROR code on error
193  */
194 int ff_parse_sample_rate(int *ret, const char *arg, void *log_ctx);
195 
196 /**
197  * Parse a time base.
198  *
199  * @param ret unsigned AVRational pointer to where the value should be written
200  * @param arg string to parse
201  * @param log_ctx log context
202  * @return 0 in case of success, a negative AVERROR code on error
203  */
204 int ff_parse_time_base(AVRational *ret, const char *arg, void *log_ctx);
205 
206 /**
207  * Parse a sample format name or a corresponding integer representation.
208  *
209  * @param ret integer pointer to where the value should be written
210  * @param arg string to parse
211  * @param log_ctx log context
212  * @return 0 in case of success, a negative AVERROR code on error
213  */
214 int ff_parse_sample_format(int *ret, const char *arg, void *log_ctx);
215 
216 /**
217  * Parse a channel layout or a corresponding integer representation.
218  *
219  * @param ret 64bit integer pointer to where the value should be written.
220  * @param arg string to parse
221  * @param log_ctx log context
222  * @return 0 in case of success, a negative AVERROR code on error
223  */
224 int ff_parse_channel_layout(int64_t *ret, const char *arg, void *log_ctx);
225 
226 void ff_update_link_current_pts(AVFilterLink *link, int64_t pts);
227 
229 
230 /* misc trace functions */
231 
232 /* #define FF_AVFILTER_TRACE */
233 
234 #ifdef FF_AVFILTER_TRACE
235 # define ff_tlog(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
236 #else
237 # define ff_tlog(pctx, ...) do { if (0) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)
238 #endif
239 
240 #define FF_TPRINTF_START(ctx, func) ff_tlog(NULL, "%-16s: ", #func)
241 
242 char *ff_get_ref_perms_string(char *buf, size_t buf_size, int perms);
243 
244 void ff_tlog_ref(void *ctx, AVFrame *ref, int end);
245 
246 void ff_tlog_link(void *ctx, AVFilterLink *link, int end);
247 
248 /**
249  * Insert a new pad.
250  *
251  * @param idx Insertion point. Pad is inserted at the end if this point
252  * is beyond the end of the list of pads.
253  * @param count Pointer to the number of pads in the list
254  * @param padidx_off Offset within an AVFilterLink structure to the element
255  * to increment when inserting a new pad causes link
256  * numbering to change
257  * @param pads Pointer to the pointer to the beginning of the list of pads
258  * @param links Pointer to the pointer to the beginning of the list of links
259  * @param newpad The new pad to add. A copy is made when adding.
260  */
261 void ff_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
262  AVFilterPad **pads, AVFilterLink ***links,
263  AVFilterPad *newpad);
264 
265 /** Insert a new input pad for the filter. */
266 static inline void ff_insert_inpad(AVFilterContext *f, unsigned index,
267  AVFilterPad *p)
268 {
269  ff_insert_pad(index, &f->nb_inputs, offsetof(AVFilterLink, dstpad),
270  &f->input_pads, &f->inputs, p);
271 #if FF_API_FOO_COUNT
272  f->input_count = f->nb_inputs;
273 #endif
274 }
275 
276 /** Insert a new output pad for the filter. */
277 static inline void ff_insert_outpad(AVFilterContext *f, unsigned index,
278  AVFilterPad *p)
279 {
280  ff_insert_pad(index, &f->nb_outputs, offsetof(AVFilterLink, srcpad),
281  &f->output_pads, &f->outputs, p);
282 #if FF_API_FOO_COUNT
283  f->output_count = f->nb_outputs;
284 #endif
285 }
286 
287 /**
288  * Poll a frame from the filter chain.
289  *
290  * @param link the input link
291  * @return the number of immediately available frames, a negative
292  * number in case of error
293  */
294 int ff_poll_frame(AVFilterLink *link);
295 
296 /**
297  * Request an input frame from the filter at the other end of the link.
298  *
299  * @param link the input link
300  * @return zero on success
301  */
302 int ff_request_frame(AVFilterLink *link);
303 
304 #define AVFILTER_DEFINE_CLASS(fname) \
305  static const AVClass fname##_class = { \
306  .class_name = #fname, \
307  .item_name = av_default_item_name, \
308  .option = fname##_options, \
309  .version = LIBAVUTIL_VERSION_INT, \
310  .category = AV_CLASS_CATEGORY_FILTER, \
311  }
312 
313 AVFilterBufferRef *ff_copy_buffer_ref(AVFilterLink *outlink,
314  AVFilterBufferRef *ref);
315 
316 /**
317  * Find the index of a link.
318  *
319  * I.e. find i such that link == ctx->(in|out)puts[i]
320  */
321 #define FF_INLINK_IDX(link) ((int)((link)->dstpad - (link)->dst->input_pads))
322 #define FF_OUTLINK_IDX(link) ((int)((link)->srcpad - (link)->src->output_pads))
323 
324 int ff_buffersink_read_compat(AVFilterContext *ctx, AVFilterBufferRef **buf);
325 int ff_buffersink_read_samples_compat(AVFilterContext *ctx, AVFilterBufferRef **pbuf,
326  int nb_samples);
327 /**
328  * Send a frame of data to the next filter.
329  *
330  * @param link the output link over which the data is being sent
331  * @param frame a reference to the buffer of data being sent. The
332  * receiving filter will free this reference when it no longer
333  * needs it or pass it on to the next filter.
334  *
335  * @return >= 0 on success, a negative AVERROR on error. The receiving filter
336  * is responsible for unreferencing frame in case of error.
337  */
339 
340 /**
341  * Flags for AVFilterLink.flags.
342  */
343 enum {
344 
345  /**
346  * Frame requests may need to loop in order to be fulfilled.
347  * A filter must set this flags on an output link if it may return 0 in
348  * request_frame() without filtering a frame.
349  */
351 
352 };
353 
354 /**
355  * Allocate a new filter context and return it.
356  *
357  * @param filter what filter to create an instance of
358  * @param inst_name name to give to the new filter context
359  *
360  * @return newly created filter context or NULL on failure
361  */
362 AVFilterContext *ff_filter_alloc(const AVFilter *filter, const char *inst_name);
363 
364 /**
365  * Remove a filter from a graph;
366  */
368 
369 #endif /* AVFILTER_INTERNAL_H */