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_BUFFERSINK_H
20 #define AVFILTER_BUFFERSINK_H
24 * memory buffer sink API for audio and video
30 * Struct to use for initializing a buffersink context.
33 const enum AVPixelFormat *pixel_fmts; ///< list of allowed pixel formats, terminated by AV_PIX_FMT_NONE
37 * Create an AVBufferSinkParams structure.
39 * Must be freed with av_free().
41 AVBufferSinkParams *av_buffersink_params_alloc(void);
44 * Struct to use for initializing an abuffersink context.
47 const enum AVSampleFormat *sample_fmts; ///< list of allowed sample formats, terminated by AV_SAMPLE_FMT_NONE
48 const int64_t *channel_layouts; ///< list of allowed channel layouts, terminated by -1
49 } AVABufferSinkParams;
52 * Create an AVABufferSinkParams structure.
54 * Must be freed with av_free().
56 AVABufferSinkParams *av_abuffersink_params_alloc(void);
59 * Set the frame size for an audio buffer sink.
61 * All calls to av_buffersink_get_buffer_ref will return a buffer with
62 * exactly the specified number of samples, or AVERROR(EAGAIN) if there is
63 * not enough. The last buffer at EOF will be padded with 0.
65 void av_buffersink_set_frame_size(AVFilterContext *ctx, unsigned frame_size);
68 * Tell av_buffersink_get_buffer_ref() to read video/samples buffer
69 * reference, but not remove it from the buffer. This is useful if you
70 * need only to read a video/samples buffer, without to fetch it.
72 #define AV_BUFFERSINK_FLAG_PEEK 1
75 * Tell av_buffersink_get_buffer_ref() not to request a frame from its input.
76 * If a frame is already buffered, it is read (and removed from the buffer),
77 * but if no frame is present, return AVERROR(EAGAIN).
79 #define AV_BUFFERSINK_FLAG_NO_REQUEST 2
82 * Get an audio/video buffer data from buffer_sink and put it in bufref.
84 * This function works with both audio and video buffer sinks.
86 * @param buffer_sink pointer to a buffersink or abuffersink context
87 * @param flags a combination of AV_BUFFERSINK_FLAG_* flags
88 * @return >= 0 in case of success, a negative AVERROR code in case of
91 int av_buffersink_get_buffer_ref(AVFilterContext *buffer_sink,
92 AVFilterBufferRef **bufref, int flags);
96 * Get the number of immediately available frames.
98 int av_buffersink_poll_frame(AVFilterContext *ctx);
101 * Get the frame rate of the input.
103 AVRational av_buffersink_get_frame_rate(AVFilterContext *ctx);
106 * @defgroup libav_api Libav API
111 * Get a buffer with filtered data from sink and put it in buf.
113 * @param ctx pointer to a context of a buffersink or abuffersink AVFilter.
114 * @param buf pointer to the buffer will be written here if buf is non-NULL. buf
115 * must be freed by the caller using avfilter_unref_buffer().
116 * Buf may also be NULL to query whether a buffer is ready to be
119 * @return >= 0 in case of success, a negative AVERROR code in case of
122 int av_buffersink_read(AVFilterContext *ctx, AVFilterBufferRef **buf);
125 * Same as av_buffersink_read, but with the ability to specify the number of
126 * samples read. This function is less efficient than av_buffersink_read(),
127 * because it copies the data around.
129 * @param ctx pointer to a context of the abuffersink AVFilter.
130 * @param buf pointer to the buffer will be written here if buf is non-NULL. buf
131 * must be freed by the caller using avfilter_unref_buffer(). buf
132 * will contain exactly nb_samples audio samples, except at the end
133 * of stream, when it can contain less than nb_samples.
134 * Buf may also be NULL to query whether a buffer is ready to be
137 * @warning do not mix this function with av_buffersink_read(). Use only one or
138 * the other with a single sink, not both.
140 int av_buffersink_read_samples(AVFilterContext *ctx, AVFilterBufferRef **buf,
147 #endif /* AVFILTER_BUFFERSINK_H */