2 * This file is part of FFmpeg.
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.
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.
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
19 #ifndef AVFILTER_INTERNAL_H
20 #define AVFILTER_INTERNAL_H
24 * internal API functions
27 #include "libavutil/internal.h"
29 #include "avfiltergraph.h"
34 #include "libavcodec/avcodec.h"
36 #if FF_API_AVFILTERBUFFER
38 typedef struct AVFilterPool {
39 AVFilterBufferRef *pic[POOL_SIZE];
46 typedef struct AVFilterCommand {
47 double time; ///< time expressed in seconds
48 char *command; ///< command
49 char *arg; ///< optional argument for the command
51 struct AVFilterCommand *next;
55 * Update the position of a link in the age heap.
57 void ff_avfilter_graph_update_heap(AVFilterGraph *graph, AVFilterLink *link);
60 * A filter pad used for either input or output.
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.
73 enum AVMediaType type;
76 * Callback function to get a video buffer. If NULL, the filter system will
77 * use ff_default_get_video_buffer().
79 * Input video pads only.
81 AVFrame *(*get_video_buffer)(AVFilterLink *link, int w, int h);
84 * Callback function to get an audio buffer. If NULL, the filter system will
85 * use ff_default_get_audio_buffer().
87 * Input audio pads only.
89 AVFrame *(*get_audio_buffer)(AVFilterLink *link, int nb_samples);
92 * Filtering callback. This is where a filter receives a frame with
93 * audio/video data and should do its processing.
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.
101 int (*filter_frame)(AVFilterLink *link, AVFrame *frame);
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).
108 * Defaults to just calling the source poll_frame() method.
112 int (*poll_frame)(AVFilterLink *link);
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.
121 int (*request_frame)(AVFilterLink *link);
124 * Link configuration callback.
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.
131 * For input pads, this should check the properties of the link, and update
132 * the filter's internal state as necessary.
134 * For both input and output filters, this should return zero on success,
135 * and another value on error.
137 int (*config_props)(AVFilterLink *link);
140 * The filter expects a fifo to be inserted on its input link,
141 * typically because it has a delay.
148 * The filter expects writable frames from its input link,
149 * duplicating data buffers if needed.
156 struct AVFilterGraphInternal {
158 avfilter_execute_func *thread_execute;
161 struct AVFilterInternal {
162 avfilter_execute_func *execute;
165 #if FF_API_AVFILTERBUFFER
166 /** default handler for freeing audio/video buffer when there are no references left */
167 void ff_avfilter_default_free_buffer(AVFilterBuffer *buf);
170 /** Tell is a format is contained in the provided list terminated by -1. */
171 int ff_fmt_is_in(int fmt, const int *fmts);
173 /* Functions to parse audio format arguments */
176 * Parse a pixel format.
178 * @param ret pixel format pointer to where the value should be written
179 * @param arg string to parse
180 * @param log_ctx log context
181 * @return >= 0 in case of success, a negative AVERROR code on error
183 int ff_parse_pixel_format(enum AVPixelFormat *ret, const char *arg, void *log_ctx);
186 * Parse a sample rate.
188 * @param ret unsigned integer pointer to where the value should be written
189 * @param arg string to parse
190 * @param log_ctx log context
191 * @return >= 0 in case of success, a negative AVERROR code on error
193 int ff_parse_sample_rate(int *ret, const char *arg, void *log_ctx);
198 * @param ret unsigned AVRational pointer to where the value should be written
199 * @param arg string to parse
200 * @param log_ctx log context
201 * @return >= 0 in case of success, a negative AVERROR code on error
203 int ff_parse_time_base(AVRational *ret, const char *arg, void *log_ctx);
206 * Parse a sample format name or a corresponding integer representation.
208 * @param ret integer pointer to where the value should be written
209 * @param arg string to parse
210 * @param log_ctx log context
211 * @return >= 0 in case of success, a negative AVERROR code on error
213 int ff_parse_sample_format(int *ret, const char *arg, void *log_ctx);
216 * Parse a channel layout or a corresponding integer representation.
218 * @param ret 64bit integer pointer to where the value should be written.
219 * @param nret integer pointer to the number of channels;
220 * if not NULL, then unknown channel layouts are accepted
221 * @param arg string to parse
222 * @param log_ctx log context
223 * @return >= 0 in case of success, a negative AVERROR code on error
225 int ff_parse_channel_layout(int64_t *ret, int *nret, const char *arg,
228 void ff_update_link_current_pts(AVFilterLink *link, int64_t pts);
230 void ff_command_queue_pop(AVFilterContext *filter);
232 /* misc trace functions */
234 /* #define FF_AVFILTER_TRACE */
236 #ifdef FF_AVFILTER_TRACE
237 # define ff_tlog(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
239 # define ff_tlog(pctx, ...) do { if (0) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)
242 #define FF_TPRINTF_START(ctx, func) ff_tlog(NULL, "%-16s: ", #func)
244 char *ff_get_ref_perms_string(char *buf, size_t buf_size, int perms);
246 void ff_tlog_ref(void *ctx, AVFrame *ref, int end);
248 void ff_tlog_link(void *ctx, AVFilterLink *link, int end);
253 * @param idx Insertion point. Pad is inserted at the end if this point
254 * is beyond the end of the list of pads.
255 * @param count Pointer to the number of pads in the list
256 * @param padidx_off Offset within an AVFilterLink structure to the element
257 * to increment when inserting a new pad causes link
258 * numbering to change
259 * @param pads Pointer to the pointer to the beginning of the list of pads
260 * @param links Pointer to the pointer to the beginning of the list of links
261 * @param newpad The new pad to add. A copy is made when adding.
262 * @return >= 0 in case of success, a negative AVERROR code on error
264 int ff_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
265 AVFilterPad **pads, AVFilterLink ***links,
266 AVFilterPad *newpad);
268 /** Insert a new input pad for the filter. */
269 static inline int ff_insert_inpad(AVFilterContext *f, unsigned index,
272 int ret = ff_insert_pad(index, &f->nb_inputs, offsetof(AVFilterLink, dstpad),
273 &f->input_pads, &f->inputs, p);
275 FF_DISABLE_DEPRECATION_WARNINGS
276 f->input_count = f->nb_inputs;
277 FF_ENABLE_DEPRECATION_WARNINGS
282 /** Insert a new output pad for the filter. */
283 static inline int ff_insert_outpad(AVFilterContext *f, unsigned index,
286 int ret = ff_insert_pad(index, &f->nb_outputs, offsetof(AVFilterLink, srcpad),
287 &f->output_pads, &f->outputs, p);
289 FF_DISABLE_DEPRECATION_WARNINGS
290 f->output_count = f->nb_outputs;
291 FF_ENABLE_DEPRECATION_WARNINGS
297 * Poll a frame from the filter chain.
299 * @param link the input link
300 * @return the number of immediately available frames, a negative
301 * number in case of error
303 int ff_poll_frame(AVFilterLink *link);
306 * Request an input frame from the filter at the other end of the link.
308 * The input filter may pass the request on to its inputs, fulfill the
309 * request from an internal buffer or any other means specific to its function.
311 * When the end of a stream is reached AVERROR_EOF is returned and no further
312 * frames are returned after that.
314 * When a filter is unable to output a frame for example due to its sources
315 * being unable to do so or because it depends on external means pushing data
316 * into it then AVERROR(EAGAIN) is returned.
317 * It is important that a AVERROR(EAGAIN) return is returned all the way to the
318 * caller (generally eventually a user application) as this step may (but does
319 * not have to be) necessary to provide the input with the next frame.
321 * If a request is successful then the filter_frame() function will be called
322 * at least once before ff_request_frame() returns
324 * @param link the input link
325 * @return zero on success
326 * AVERROR_EOF on end of file
327 * AVERROR(EAGAIN) if the previous filter cannot output a frame
328 * currently and can neither guarantee that EOF has been reached.
330 int ff_request_frame(AVFilterLink *link);
332 #define AVFILTER_DEFINE_CLASS(fname) \
333 static const AVClass fname##_class = { \
334 .class_name = #fname, \
335 .item_name = av_default_item_name, \
336 .option = fname##_options, \
337 .version = LIBAVUTIL_VERSION_INT, \
338 .category = AV_CLASS_CATEGORY_FILTER, \
342 * Find the index of a link.
344 * I.e. find i such that link == ctx->(in|out)puts[i]
346 #define FF_INLINK_IDX(link) ((int)((link)->dstpad - (link)->dst->input_pads))
347 #define FF_OUTLINK_IDX(link) ((int)((link)->srcpad - (link)->src->output_pads))
350 * Send a frame of data to the next filter.
352 * @param link the output link over which the data is being sent
353 * @param frame a reference to the buffer of data being sent. The
354 * receiving filter will free this reference when it no longer
355 * needs it or pass it on to the next filter.
357 * @return >= 0 on success, a negative AVERROR on error. The receiving filter
358 * is responsible for unreferencing frame in case of error.
360 int ff_filter_frame(AVFilterLink *link, AVFrame *frame);
363 * Flags for AVFilterLink.flags.
368 * Frame requests may need to loop in order to be fulfilled.
369 * A filter must set this flags on an output link if it may return 0 in
370 * request_frame() without filtering a frame.
372 FF_LINK_FLAG_REQUEST_LOOP = 1,
377 * Allocate a new filter context and return it.
379 * @param filter what filter to create an instance of
380 * @param inst_name name to give to the new filter context
382 * @return newly created filter context or NULL on failure
384 AVFilterContext *ff_filter_alloc(const AVFilter *filter, const char *inst_name);
387 * Remove a filter from a graph;
389 void ff_filter_graph_remove_filter(AVFilterGraph *graph, AVFilterContext *filter);
392 * Normalize the qscale factor
393 * FIXME the H264 qscale is a log based scale, mpeg1/2 is not, the code below
396 static inline int ff_norm_qscale(int qscale, int type)
399 case FF_QSCALE_TYPE_MPEG1: return qscale;
400 case FF_QSCALE_TYPE_MPEG2: return qscale >> 1;
401 case FF_QSCALE_TYPE_H264: return qscale >> 2;
402 case FF_QSCALE_TYPE_VP56: return (63 - qscale + 2) >> 2;
407 #endif /* AVFILTER_INTERNAL_H */