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