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
28 #include "avfiltergraph.h"
33 typedef struct AVFilterPool {
34 AVFilterBufferRef *pic[POOL_SIZE];
40 typedef struct AVFilterCommand {
41 double time; ///< time expressed in seconds
42 char *command; ///< command
43 char *arg; ///< optional argument for the command
45 struct AVFilterCommand *next;
49 * Update the position of a link in the age heap.
51 void ff_avfilter_graph_update_heap(AVFilterGraph *graph, AVFilterLink *link);
53 #if !FF_API_AVFILTERPAD_PUBLIC
55 * A filter pad used for either input or output.
59 * Pad name. The name is unique among inputs and among outputs, but an
60 * input may have the same name as an output. This may be NULL if this
61 * pad has no need to ever be referenced by name.
68 enum AVMediaType type;
71 * Callback function to get a video buffer. If NULL, the filter system will
72 * use ff_default_get_video_buffer().
74 * Input video pads only.
76 AVFrame *(*get_video_buffer)(AVFilterLink *link, int w, int h);
79 * Callback function to get an audio buffer. If NULL, the filter system will
80 * use ff_default_get_audio_buffer().
82 * Input audio pads only.
84 AVFrame *(*get_audio_buffer)(AVFilterLink *link, int nb_samples);
87 * Filtering callback. This is where a filter receives a frame with
88 * audio/video data and should do its processing.
92 * @return >= 0 on success, a negative AVERROR on error. This function
93 * must ensure that samplesref is properly unreferenced on error if it
94 * hasn't been passed on to another filter.
96 int (*filter_frame)(AVFilterLink *link, AVFrame *frame);
99 * Frame poll callback. This returns the number of immediately available
100 * samples. It should return a positive value if the next request_frame()
101 * is guaranteed to return one frame (with no delay).
103 * Defaults to just calling the source poll_frame() method.
107 int (*poll_frame)(AVFilterLink *link);
110 * Frame request callback. A call to this should result in at least one
111 * frame being output over the given link. This should return zero on
112 * success, and another value on error.
116 int (*request_frame)(AVFilterLink *link);
119 * Link configuration callback.
121 * For output pads, this should set the link properties such as
122 * width/height. This should NOT set the format property - that is
123 * negotiated between filters by the filter system using the
124 * query_formats() callback before this function is called.
126 * For input pads, this should check the properties of the link, and update
127 * the filter's internal state as necessary.
129 * For both input and output filters, this should return zero on success,
130 * and another value on error.
132 int (*config_props)(AVFilterLink *link);
135 * The filter expects a fifo to be inserted on its input link,
136 * typically because it has a delay.
144 /** default handler for freeing audio/video buffer when there are no references left */
145 void ff_avfilter_default_free_buffer(AVFilterBuffer *buf);
147 /** Tell is a format is contained in the provided list terminated by -1. */
148 int ff_fmt_is_in(int fmt, const int *fmts);
151 * Return a copy of a list of integers terminated by -1, or NULL in
152 * case of copy failure.
154 int *ff_copy_int_list(const int * const list);
157 * Return a copy of a list of 64-bit integers, or NULL in case of
160 int64_t *ff_copy_int64_list(const int64_t * const list);
162 /* Functions to parse audio format arguments */
165 * Parse a pixel format.
167 * @param ret pixel format pointer to where the value should be written
168 * @param arg string to parse
169 * @param log_ctx log context
170 * @return 0 in case of success, a negative AVERROR code on error
172 int ff_parse_pixel_format(enum AVPixelFormat *ret, const char *arg, void *log_ctx);
175 * Parse a sample rate.
177 * @param ret unsigned integer pointer to where the value should be written
178 * @param arg string to parse
179 * @param log_ctx log context
180 * @return 0 in case of success, a negative AVERROR code on error
182 int ff_parse_sample_rate(int *ret, const char *arg, void *log_ctx);
187 * @param ret unsigned AVRational pointer to where the value should be written
188 * @param arg string to parse
189 * @param log_ctx log context
190 * @return 0 in case of success, a negative AVERROR code on error
192 int ff_parse_time_base(AVRational *ret, const char *arg, void *log_ctx);
195 * Parse a sample format name or a corresponding integer representation.
197 * @param ret integer pointer to where the value should be written
198 * @param arg string to parse
199 * @param log_ctx log context
200 * @return 0 in case of success, a negative AVERROR code on error
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 arg string to parse
209 * @param log_ctx log context
210 * @return 0 in case of success, a negative AVERROR code on error
212 int ff_parse_channel_layout(int64_t *ret, const char *arg, void *log_ctx);
214 void ff_update_link_current_pts(AVFilterLink *link, int64_t pts);
216 void ff_command_queue_pop(AVFilterContext *filter);
218 /* misc trace functions */
220 /* #define FF_AVFILTER_TRACE */
222 #ifdef FF_AVFILTER_TRACE
223 # define ff_tlog(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
225 # define ff_tlog(pctx, ...) do { if (0) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)
228 #define FF_TPRINTF_START(ctx, func) ff_tlog(NULL, "%-16s: ", #func)
230 char *ff_get_ref_perms_string(char *buf, size_t buf_size, int perms);
232 void ff_tlog_ref(void *ctx, AVFrame *ref, int end);
234 void ff_tlog_link(void *ctx, AVFilterLink *link, int end);
239 * @param idx Insertion point. Pad is inserted at the end if this point
240 * is beyond the end of the list of pads.
241 * @param count Pointer to the number of pads in the list
242 * @param padidx_off Offset within an AVFilterLink structure to the element
243 * to increment when inserting a new pad causes link
244 * numbering to change
245 * @param pads Pointer to the pointer to the beginning of the list of pads
246 * @param links Pointer to the pointer to the beginning of the list of links
247 * @param newpad The new pad to add. A copy is made when adding.
249 void ff_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
250 AVFilterPad **pads, AVFilterLink ***links,
251 AVFilterPad *newpad);
253 /** Insert a new input pad for the filter. */
254 static inline void ff_insert_inpad(AVFilterContext *f, unsigned index,
257 ff_insert_pad(index, &f->nb_inputs, offsetof(AVFilterLink, dstpad),
258 &f->input_pads, &f->inputs, p);
260 f->input_count = f->nb_inputs;
264 /** Insert a new output pad for the filter. */
265 static inline void ff_insert_outpad(AVFilterContext *f, unsigned index,
268 ff_insert_pad(index, &f->nb_outputs, offsetof(AVFilterLink, srcpad),
269 &f->output_pads, &f->outputs, p);
271 f->output_count = f->nb_outputs;
276 * Poll a frame from the filter chain.
278 * @param link the input link
279 * @return the number of immediately available frames, a negative
280 * number in case of error
282 int ff_poll_frame(AVFilterLink *link);
285 * Request an input frame from the filter at the other end of the link.
287 * @param link the input link
288 * @return zero on success
290 int ff_request_frame(AVFilterLink *link);
292 #define AVFILTER_DEFINE_CLASS(fname) \
293 static const AVClass fname##_class = { \
294 .class_name = #fname, \
295 .item_name = av_default_item_name, \
296 .option = fname##_options, \
297 .version = LIBAVUTIL_VERSION_INT, \
298 .category = AV_CLASS_CATEGORY_FILTER, \
301 AVFilterBufferRef *ff_copy_buffer_ref(AVFilterLink *outlink,
302 AVFilterBufferRef *ref);
305 * Find the index of a link.
307 * I.e. find i such that link == ctx->(in|out)puts[i]
309 #define FF_INLINK_IDX(link) ((int)((link)->dstpad - (link)->dst->input_pads))
310 #define FF_OUTLINK_IDX(link) ((int)((link)->srcpad - (link)->src->output_pads))
312 int ff_buffersink_read_compat(AVFilterContext *ctx, AVFilterBufferRef **buf);
313 int ff_buffersink_read_samples_compat(AVFilterContext *ctx, AVFilterBufferRef **pbuf,
316 * Send a frame of data to the next filter.
318 * @param link the output link over which the data is being sent
319 * @param frame a reference to the buffer of data being sent. The
320 * receiving filter will free this reference when it no longer
321 * needs it or pass it on to the next filter.
323 * @return >= 0 on success, a negative AVERROR on error. The receiving filter
324 * is responsible for unreferencing frame in case of error.
326 int ff_filter_frame(AVFilterLink *link, AVFrame *frame);
328 #endif /* AVFILTER_INTERNAL_H */