Merge commit '12b14382861fbf19378afcddaa19cd9a949a86a3'
[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 #include "libavcodec/avcodec.h"
35
36 typedef struct AVFilterCommand {
37     double time;                ///< time expressed in seconds
38     char *command;              ///< command
39     char *arg;                  ///< optional argument for the command
40     int flags;
41     struct AVFilterCommand *next;
42 } AVFilterCommand;
43
44 /**
45  * Update the position of a link in the age heap.
46  */
47 void ff_avfilter_graph_update_heap(AVFilterGraph *graph, AVFilterLink *link);
48
49 /**
50  * A filter pad used for either input or output.
51  */
52 struct AVFilterPad {
53     /**
54      * Pad name. The name is unique among inputs and among outputs, but an
55      * input may have the same name as an output. This may be NULL if this
56      * pad has no need to ever be referenced by name.
57      */
58     const char *name;
59
60     /**
61      * AVFilterPad type.
62      */
63     enum AVMediaType type;
64
65     /**
66      * Callback function to get a video buffer. If NULL, the filter system will
67      * use ff_default_get_video_buffer().
68      *
69      * Input video pads only.
70      */
71     AVFrame *(*get_video_buffer)(AVFilterLink *link, int w, int h);
72
73     /**
74      * Callback function to get an audio buffer. If NULL, the filter system will
75      * use ff_default_get_audio_buffer().
76      *
77      * Input audio pads only.
78      */
79     AVFrame *(*get_audio_buffer)(AVFilterLink *link, int nb_samples);
80
81     /**
82      * Filtering callback. This is where a filter receives a frame with
83      * audio/video data and should do its processing.
84      *
85      * Input pads only.
86      *
87      * @return >= 0 on success, a negative AVERROR on error. This function
88      * must ensure that samplesref is properly unreferenced on error if it
89      * hasn't been passed on to another filter.
90      */
91     int (*filter_frame)(AVFilterLink *link, AVFrame *frame);
92
93     /**
94      * Frame poll callback. This returns the number of immediately available
95      * samples. It should return a positive value if the next request_frame()
96      * is guaranteed to return one frame (with no delay).
97      *
98      * Defaults to just calling the source poll_frame() method.
99      *
100      * Output pads only.
101      */
102     int (*poll_frame)(AVFilterLink *link);
103
104     /**
105      * Frame request callback. A call to this should result in some progress
106      * towards producing output over the given link. This should return zero
107      * on success, and another value on error.
108      *
109      * Output pads only.
110      */
111     int (*request_frame)(AVFilterLink *link);
112
113     /**
114      * Link configuration callback.
115      *
116      * For output pads, this should set the link properties such as
117      * width/height. This should NOT set the format property - that is
118      * negotiated between filters by the filter system using the
119      * query_formats() callback before this function is called.
120      *
121      * For input pads, this should check the properties of the link, and update
122      * the filter's internal state as necessary.
123      *
124      * For both input and output filters, this should return zero on success,
125      * and another value on error.
126      */
127     int (*config_props)(AVFilterLink *link);
128
129     /**
130      * The filter expects a fifo to be inserted on its input link,
131      * typically because it has a delay.
132      *
133      * input pads only.
134      */
135     int needs_fifo;
136
137     /**
138      * The filter expects writable frames from its input link,
139      * duplicating data buffers if needed.
140      *
141      * input pads only.
142      */
143     int needs_writable;
144 };
145
146 struct AVFilterGraphInternal {
147     void *thread;
148     avfilter_execute_func *thread_execute;
149 };
150
151 struct AVFilterInternal {
152     avfilter_execute_func *execute;
153 };
154
155 /**
156  * Tell if an integer is contained in the provided -1-terminated list of integers.
157  * This is useful for determining (for instance) if an AVPixelFormat is in an
158  * array of supported formats.
159  *
160  * @param fmt provided format
161  * @param fmts -1-terminated list of formats
162  * @return 1 if present, 0 if absent
163  */
164 int ff_fmt_is_in(int fmt, const int *fmts);
165
166 /* Functions to parse audio format arguments */
167
168 /**
169  * Parse a pixel format.
170  *
171  * @param ret pixel format pointer to where the value should be written
172  * @param arg string to parse
173  * @param log_ctx log context
174  * @return >= 0 in case of success, a negative AVERROR code on error
175  */
176 av_warn_unused_result
177 int ff_parse_pixel_format(enum AVPixelFormat *ret, const char *arg, void *log_ctx);
178
179 /**
180  * Parse a sample rate.
181  *
182  * @param ret unsigned integer pointer to where the value should be written
183  * @param arg string to parse
184  * @param log_ctx log context
185  * @return >= 0 in case of success, a negative AVERROR code on error
186  */
187 av_warn_unused_result
188 int ff_parse_sample_rate(int *ret, const char *arg, void *log_ctx);
189
190 /**
191  * Parse a time base.
192  *
193  * @param ret unsigned AVRational 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 av_warn_unused_result
199 int ff_parse_time_base(AVRational *ret, const char *arg, void *log_ctx);
200
201 /**
202  * Parse a sample format name or a corresponding integer representation.
203  *
204  * @param ret integer pointer to where the value should be written
205  * @param arg string to parse
206  * @param log_ctx log context
207  * @return >= 0 in case of success, a negative AVERROR code on error
208  */
209 av_warn_unused_result
210 int ff_parse_sample_format(int *ret, const char *arg, void *log_ctx);
211
212 /**
213  * Parse a channel layout or a corresponding integer representation.
214  *
215  * @param ret 64bit integer pointer to where the value should be written.
216  * @param nret integer pointer to the number of channels;
217  *             if not NULL, then unknown channel layouts are accepted
218  * @param arg string to parse
219  * @param log_ctx log context
220  * @return >= 0 in case of success, a negative AVERROR code on error
221  */
222 av_warn_unused_result
223 int ff_parse_channel_layout(int64_t *ret, int *nret, const char *arg,
224                             void *log_ctx);
225
226 void ff_update_link_current_pts(AVFilterLink *link, int64_t pts);
227
228 void ff_command_queue_pop(AVFilterContext *filter);
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  * @return >= 0 in case of success, a negative AVERROR code on error
261  */
262 int ff_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
263                    AVFilterPad **pads, AVFilterLink ***links,
264                    AVFilterPad *newpad);
265
266 /** Insert a new input pad for the filter. */
267 static inline int ff_insert_inpad(AVFilterContext *f, unsigned index,
268                                    AVFilterPad *p)
269 {
270     return ff_insert_pad(index, &f->nb_inputs, offsetof(AVFilterLink, dstpad),
271                   &f->input_pads, &f->inputs, p);
272 }
273
274 /** Insert a new output pad for the filter. */
275 static inline int ff_insert_outpad(AVFilterContext *f, unsigned index,
276                                     AVFilterPad *p)
277 {
278     return ff_insert_pad(index, &f->nb_outputs, offsetof(AVFilterLink, srcpad),
279                   &f->output_pads, &f->outputs, p);
280 }
281
282 /**
283  * Poll a frame from the filter chain.
284  *
285  * @param  link the input link
286  * @return the number of immediately available frames, a negative
287  * number in case of error
288  */
289 int ff_poll_frame(AVFilterLink *link);
290
291 /**
292  * Request an input frame from the filter at the other end of the link.
293  *
294  * The input filter may pass the request on to its inputs, fulfill the
295  * request from an internal buffer or any other means specific to its function.
296  *
297  * When the end of a stream is reached AVERROR_EOF is returned and no further
298  * frames are returned after that.
299  *
300  * When a filter is unable to output a frame for example due to its sources
301  * being unable to do so or because it depends on external means pushing data
302  * into it then AVERROR(EAGAIN) is returned.
303  * It is important that a AVERROR(EAGAIN) return is returned all the way to the
304  * caller (generally eventually a user application) as this step may (but does
305  * not have to be) necessary to provide the input with the next frame.
306  *
307  * If a request is successful then some progress has been made towards
308  * providing a frame on the link (through ff_filter_frame()). A filter that
309  * needs several frames to produce one is allowed to return success if one
310  * more frame has been processed but no output has been produced yet. A
311  * filter is also allowed to simply forward a success return value.
312  *
313  * @param link the input link
314  * @return     zero on success
315  *             AVERROR_EOF on end of file
316  *             AVERROR(EAGAIN) if the previous filter cannot output a frame
317  *             currently and can neither guarantee that EOF has been reached.
318  */
319 int ff_request_frame(AVFilterLink *link);
320
321 #define AVFILTER_DEFINE_CLASS(fname)            \
322     static const AVClass fname##_class = {      \
323         .class_name = #fname,                   \
324         .item_name  = av_default_item_name,     \
325         .option     = fname##_options,          \
326         .version    = LIBAVUTIL_VERSION_INT,    \
327         .category   = AV_CLASS_CATEGORY_FILTER, \
328     }
329
330 /**
331  * Find the index of a link.
332  *
333  * I.e. find i such that link == ctx->(in|out)puts[i]
334  */
335 #define FF_INLINK_IDX(link)  ((int)((link)->dstpad - (link)->dst->input_pads))
336 #define FF_OUTLINK_IDX(link) ((int)((link)->srcpad - (link)->src->output_pads))
337
338 /**
339  * Send a frame of data to the next filter.
340  *
341  * @param link   the output link over which the data is being sent
342  * @param frame a reference to the buffer of data being sent. The
343  *              receiving filter will free this reference when it no longer
344  *              needs it or pass it on to the next filter.
345  *
346  * @return >= 0 on success, a negative AVERROR on error. The receiving filter
347  * is responsible for unreferencing frame in case of error.
348  */
349 int ff_filter_frame(AVFilterLink *link, AVFrame *frame);
350
351 /**
352  * Allocate a new filter context and return it.
353  *
354  * @param filter what filter to create an instance of
355  * @param inst_name name to give to the new filter context
356  *
357  * @return newly created filter context or NULL on failure
358  */
359 AVFilterContext *ff_filter_alloc(const AVFilter *filter, const char *inst_name);
360
361 /**
362  * Remove a filter from a graph;
363  */
364 void ff_filter_graph_remove_filter(AVFilterGraph *graph, AVFilterContext *filter);
365
366 /**
367  * Normalize the qscale factor
368  * FIXME the H264 qscale is a log based scale, mpeg1/2 is not, the code below
369  *       cannot be optimal
370  */
371 static inline int ff_norm_qscale(int qscale, int type)
372 {
373     switch (type) {
374     case FF_QSCALE_TYPE_MPEG1: return qscale;
375     case FF_QSCALE_TYPE_MPEG2: return qscale >> 1;
376     case FF_QSCALE_TYPE_H264:  return qscale >> 2;
377     case FF_QSCALE_TYPE_VP56:  return (63 - qscale + 2) >> 2;
378     }
379     return qscale;
380 }
381
382 #endif /* AVFILTER_INTERNAL_H */