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_VSINK_BUFFER_H
20 #define AVFILTER_VSINK_BUFFER_H
24 * memory buffer sink API for audio and video
30 * Struct to use for initializing a buffersink context.
33 const enum PixelFormat *pixel_fmts; ///< list of allowed pixel formats, terminated by 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 const int *packing_fmts; ///< list of allowed packing formats
50 } AVABufferSinkParams;
53 * Create an AVABufferSinkParams structure.
55 * Must be freed with av_free().
57 AVABufferSinkParams *av_abuffersink_params_alloc(void);
60 * Tell av_buffersink_get_buffer_ref() to read video/samples buffer
61 * reference, but not remove it from the buffer. This is useful if you
62 * need only to read a video/samples buffer, without to fetch it.
64 #define AV_BUFFERSINK_FLAG_PEEK 1
67 * Get an audio/video buffer data from buffer_sink and put it in bufref.
69 * This function works with both audio and video buffer sinks.
71 * @param buffer_sink pointer to a buffersink or abuffersink context
72 * @param flags a combination of AV_BUFFERSINK_FLAG_* flags
73 * @return >= 0 in case of success, a negative AVERROR code in case of
76 int av_buffersink_get_buffer_ref(AVFilterContext *buffer_sink,
77 AVFilterBufferRef **bufref, int flags);
79 #if FF_API_OLD_VSINK_API
81 * @deprecated Use av_buffersink_get_buffer_ref() instead.
84 int av_vsink_buffer_get_video_buffer_ref(AVFilterContext *buffer_sink,
85 AVFilterBufferRef **picref, int flags);
88 #endif /* AVFILTER_VSINK_BUFFER_H */