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"
30 #include "framepool.h"
31 #include "framequeue.h"
35 #include "libavcodec/avcodec.h"
36 #include "libavcodec/internal.h"
38 typedef struct AVFilterCommand {
39 double time; ///< time expressed in seconds
40 char *command; ///< command
41 char *arg; ///< optional argument for the command
43 struct AVFilterCommand *next;
47 * Update the position of a link in the age heap.
49 void ff_avfilter_graph_update_heap(AVFilterGraph *graph, AVFilterLink *link);
52 * A filter pad used for either input or output.
56 * Pad name. The name is unique among inputs and among outputs, but an
57 * input may have the same name as an output. This may be NULL if this
58 * pad has no need to ever be referenced by name.
65 enum AVMediaType type;
68 * Callback function to get a video buffer. If NULL, the filter system will
69 * use ff_default_get_video_buffer().
71 * Input video pads only.
73 AVFrame *(*get_video_buffer)(AVFilterLink *link, int w, int h);
76 * Callback function to get an audio buffer. If NULL, the filter system will
77 * use ff_default_get_audio_buffer().
79 * Input audio pads only.
81 AVFrame *(*get_audio_buffer)(AVFilterLink *link, int nb_samples);
84 * Filtering callback. This is where a filter receives a frame with
85 * audio/video data and should do its processing.
89 * @return >= 0 on success, a negative AVERROR on error. This function
90 * must ensure that frame is properly unreferenced on error if it
91 * hasn't been passed on to another filter.
93 int (*filter_frame)(AVFilterLink *link, AVFrame *frame);
96 * Frame request callback. A call to this should result in some progress
97 * towards producing output over the given link. This should return zero
98 * on success, and another value on error.
102 int (*request_frame)(AVFilterLink *link);
105 * Link configuration callback.
107 * For output pads, this should set the link properties such as
108 * width/height. This should NOT set the format property - that is
109 * negotiated between filters by the filter system using the
110 * query_formats() callback before this function is called.
112 * For input pads, this should check the properties of the link, and update
113 * the filter's internal state as necessary.
115 * For both input and output filters, this should return zero on success,
116 * and another value on error.
118 int (*config_props)(AVFilterLink *link);
121 * The filter expects a fifo to be inserted on its input link,
122 * typically because it has a delay.
129 * The filter expects writable frames from its input link,
130 * duplicating data buffers if needed.
137 struct AVFilterGraphInternal {
139 avfilter_execute_func *thread_execute;
140 FFFrameQueueGlobal frame_queues;
143 struct AVFilterInternal {
144 avfilter_execute_func *execute;
148 * Tell if an integer is contained in the provided -1-terminated list of integers.
149 * This is useful for determining (for instance) if an AVPixelFormat is in an
150 * array of supported formats.
152 * @param fmt provided format
153 * @param fmts -1-terminated list of formats
154 * @return 1 if present, 0 if absent
156 int ff_fmt_is_in(int fmt, const int *fmts);
158 /* Functions to parse audio format arguments */
161 * Parse a pixel format.
163 * @param ret pixel format pointer to where the value should be written
164 * @param arg string to parse
165 * @param log_ctx log context
166 * @return >= 0 in case of success, a negative AVERROR code on error
168 av_warn_unused_result
169 int ff_parse_pixel_format(enum AVPixelFormat *ret, const char *arg, void *log_ctx);
172 * Parse a sample rate.
174 * @param ret unsigned integer pointer to where the value should be written
175 * @param arg string to parse
176 * @param log_ctx log context
177 * @return >= 0 in case of success, a negative AVERROR code on error
179 av_warn_unused_result
180 int ff_parse_sample_rate(int *ret, const char *arg, void *log_ctx);
185 * @param ret unsigned AVRational pointer to where the value should be written
186 * @param arg string to parse
187 * @param log_ctx log context
188 * @return >= 0 in case of success, a negative AVERROR code on error
190 av_warn_unused_result
191 int ff_parse_time_base(AVRational *ret, const char *arg, void *log_ctx);
194 * Parse a sample format name or a corresponding integer representation.
196 * @param ret integer pointer to where the value should be written
197 * @param arg string to parse
198 * @param log_ctx log context
199 * @return >= 0 in case of success, a negative AVERROR code on error
201 av_warn_unused_result
202 int ff_parse_sample_format(int *ret, const char *arg, void *log_ctx);
205 * Parse a channel layout or a corresponding integer representation.
207 * @param ret 64bit integer pointer to where the value should be written.
208 * @param nret integer pointer to the number of channels;
209 * if not NULL, then unknown channel layouts are accepted
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
214 av_warn_unused_result
215 int ff_parse_channel_layout(int64_t *ret, int *nret, const char *arg,
218 void ff_update_link_current_pts(AVFilterLink *link, int64_t pts);
221 * Set the status field of a link from the source filter.
222 * The pts should reflect the timestamp of the status change,
223 * in link time base and relative to the frames timeline.
224 * In particular, for AVERROR_EOF, it should reflect the
225 * end time of the last frame.
227 void ff_avfilter_link_set_in_status(AVFilterLink *link, int status, int64_t pts);
230 * Set the status field of a link from the destination filter.
231 * The pts should probably be left unset (AV_NOPTS_VALUE).
233 void ff_avfilter_link_set_out_status(AVFilterLink *link, int status, int64_t pts);
235 void ff_command_queue_pop(AVFilterContext *filter);
237 #define D2TS(d) (isnan(d) ? AV_NOPTS_VALUE : (int64_t)(d))
238 #define TS2D(ts) ((ts) == AV_NOPTS_VALUE ? NAN : (double)(ts))
239 #define TS2T(ts, tb) ((ts) == AV_NOPTS_VALUE ? NAN : (double)(ts) * av_q2d(tb))
241 /* misc trace functions */
243 #define FF_TPRINTF_START(ctx, func) ff_tlog(NULL, "%-16s: ", #func)
245 char *ff_get_ref_perms_string(char *buf, size_t buf_size, int perms);
247 void ff_tlog_ref(void *ctx, AVFrame *ref, int end);
249 void ff_tlog_link(void *ctx, AVFilterLink *link, int end);
254 * @param idx Insertion point. Pad is inserted at the end if this point
255 * is beyond the end of the list of pads.
256 * @param count Pointer to the number of pads in the list
257 * @param padidx_off Offset within an AVFilterLink structure to the element
258 * to increment when inserting a new pad causes link
259 * numbering to change
260 * @param pads Pointer to the pointer to the beginning of the list of pads
261 * @param links Pointer to the pointer to the beginning of the list of links
262 * @param newpad The new pad to add. A copy is made when adding.
263 * @return >= 0 in case of success, a negative AVERROR code on error
265 int ff_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
266 AVFilterPad **pads, AVFilterLink ***links,
267 AVFilterPad *newpad);
269 /** Insert a new input pad for the filter. */
270 static inline int ff_insert_inpad(AVFilterContext *f, unsigned index,
273 return ff_insert_pad(index, &f->nb_inputs, offsetof(AVFilterLink, dstpad),
274 &f->input_pads, &f->inputs, p);
277 /** Insert a new output pad for the filter. */
278 static inline int ff_insert_outpad(AVFilterContext *f, unsigned index,
281 return ff_insert_pad(index, &f->nb_outputs, offsetof(AVFilterLink, srcpad),
282 &f->output_pads, &f->outputs, p);
286 * Request an input frame from the filter at the other end of the link.
288 * This function must not be used by filters using the activate callback,
289 * use ff_link_set_frame_wanted() instead.
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.
294 * When the end of a stream is reached AVERROR_EOF is returned and no further
295 * frames are returned after that.
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.
304 * If a request is successful then some progress has been made towards
305 * providing a frame on the link (through ff_filter_frame()). A filter that
306 * needs several frames to produce one is allowed to return success if one
307 * more frame has been processed but no output has been produced yet. A
308 * filter is also allowed to simply forward a success return value.
310 * @param link the input link
311 * @return zero on success
312 * AVERROR_EOF on end of file
313 * AVERROR(EAGAIN) if the previous filter cannot output a frame
314 * currently and can neither guarantee that EOF has been reached.
316 int ff_request_frame(AVFilterLink *link);
318 #define AVFILTER_DEFINE_CLASS(fname) \
319 static const AVClass fname##_class = { \
320 .class_name = #fname, \
321 .item_name = av_default_item_name, \
322 .option = fname##_options, \
323 .version = LIBAVUTIL_VERSION_INT, \
324 .category = AV_CLASS_CATEGORY_FILTER, \
328 * Find the index of a link.
330 * I.e. find i such that link == ctx->(in|out)puts[i]
332 #define FF_INLINK_IDX(link) ((int)((link)->dstpad - (link)->dst->input_pads))
333 #define FF_OUTLINK_IDX(link) ((int)((link)->srcpad - (link)->src->output_pads))
336 * Send a frame of data to the next filter.
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.
343 * @return >= 0 on success, a negative AVERROR on error. The receiving filter
344 * is responsible for unreferencing frame in case of error.
346 int ff_filter_frame(AVFilterLink *link, AVFrame *frame);
349 * Allocate a new filter context and return it.
351 * @param filter what filter to create an instance of
352 * @param inst_name name to give to the new filter context
354 * @return newly created filter context or NULL on failure
356 AVFilterContext *ff_filter_alloc(const AVFilter *filter, const char *inst_name);
358 int ff_filter_activate(AVFilterContext *filter);
361 * Remove a filter from a graph;
363 void ff_filter_graph_remove_filter(AVFilterGraph *graph, AVFilterContext *filter);
366 * The filter is aware of hardware frames, and any hardware frame context
367 * should not be automatically propagated through it.
369 #define FF_FILTER_FLAG_HWFRAME_AWARE (1 << 0)
372 * Run one round of processing on a filter graph.
374 int ff_filter_graph_run_once(AVFilterGraph *graph);
377 * Normalize the qscale factor
378 * FIXME the H264 qscale is a log based scale, mpeg1/2 is not, the code below
381 static inline int ff_norm_qscale(int qscale, int type)
384 case FF_QSCALE_TYPE_MPEG1: return qscale;
385 case FF_QSCALE_TYPE_MPEG2: return qscale >> 1;
386 case FF_QSCALE_TYPE_H264: return qscale >> 2;
387 case FF_QSCALE_TYPE_VP56: return (63 - qscale + 2) >> 2;
393 * Get number of threads for current filter instance.
394 * This number is always same or less than graph->nb_threads.
396 int ff_filter_get_nb_threads(AVFilterContext *ctx);
399 * Generic processing of user supplied commands that are set
400 * in the same way as the filter options.
402 int ff_filter_process_command(AVFilterContext *ctx, const char *cmd,
403 const char *arg, char *res, int res_len, int flags);
406 * Perform any additional setup required for hardware frames.
408 * link->hw_frames_ctx must be set before calling this function.
409 * Inside link->hw_frames_ctx, the fields format, sw_format, width and
410 * height must be set. If dynamically allocated pools are not supported,
411 * then initial_pool_size must also be set, to the minimum hardware frame
412 * pool size necessary for the filter to work (taking into account any
413 * frames which need to stored for use in operations as appropriate). If
414 * default_pool_size is nonzero, then it will be used as the pool size if
415 * no other modification takes place (this can be used to preserve
418 int ff_filter_init_hw_frames(AVFilterContext *avctx, AVFilterLink *link,
419 int default_pool_size);
421 #endif /* AVFILTER_INTERNAL_H */