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