buffersink: group libav API functions.
[ffmpeg.git] / libavfilter / buffersink.h
1 /*
2  * This file is part of FFmpeg.
3  *
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.
8  *
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.
13  *
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
17  */
18
19 #ifndef AVFILTER_BUFFERSINK_H
20 #define AVFILTER_BUFFERSINK_H
21
22 /**
23  * @file
24  * memory buffer sink API for audio and video
25  */
26
27 #include "avfilter.h"
28
29 /**
30  * Struct to use for initializing a buffersink context.
31  */
32 typedef struct {
33     const enum PixelFormat *pixel_fmts; ///< list of allowed pixel formats, terminated by PIX_FMT_NONE
34 } AVBufferSinkParams;
35
36 /**
37  * Create an AVBufferSinkParams structure.
38  *
39  * Must be freed with av_free().
40  */
41 AVBufferSinkParams *av_buffersink_params_alloc(void);
42
43 /**
44  * Struct to use for initializing an abuffersink context.
45  */
46 typedef struct {
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;
50
51 /**
52  * Create an AVABufferSinkParams structure.
53  *
54  * Must be freed with av_free().
55  */
56 AVABufferSinkParams *av_abuffersink_params_alloc(void);
57
58 /**
59  * Tell av_buffersink_get_buffer_ref() to read video/samples buffer
60  * reference, but not remove it from the buffer. This is useful if you
61  * need only to read a video/samples buffer, without to fetch it.
62  */
63 #define AV_BUFFERSINK_FLAG_PEEK 1
64
65 /**
66  * Tell av_buffersink_get_buffer_ref() not to request a frame from its input.
67  * If a frame is already buffered, it is read (and removed from the buffer),
68  * but if no frame is present, return AVERROR(EAGAIN).
69  */
70 #define AV_BUFFERSINK_FLAG_NO_REQUEST 2
71
72 /**
73  * Get an audio/video buffer data from buffer_sink and put it in bufref.
74  *
75  * This function works with both audio and video buffer sinks.
76  *
77  * @param buffer_sink pointer to a buffersink or abuffersink context
78  * @param flags a combination of AV_BUFFERSINK_FLAG_* flags
79  * @return >= 0 in case of success, a negative AVERROR code in case of
80  * failure
81  */
82 int av_buffersink_get_buffer_ref(AVFilterContext *buffer_sink,
83                                  AVFilterBufferRef **bufref, int flags);
84
85
86 /**
87  * Get the number of immediately available frames.
88  */
89 int av_buffersink_poll_frame(AVFilterContext *ctx);
90
91 /**
92  * Get the frame rate of the input.
93  */
94 AVRational av_buffersink_get_frame_rate(AVFilterContext *ctx);
95
96 /**
97  * @defgroup libav_api Libav API
98  * @{
99  */
100
101 /**
102  * Get a buffer with filtered data from sink and put it in buf.
103  *
104  * @param sink pointer to a context of a buffersink or abuffersink AVFilter.
105  * @param buf pointer to the buffer will be written here if buf is non-NULL. buf
106  *            must be freed by the caller using avfilter_unref_buffer().
107  *            Buf may also be NULL to query whether a buffer is ready to be
108  *            output.
109  *
110  * @return >= 0 in case of success, a negative AVERROR code in case of
111  *         failure.
112  */
113 int av_buffersink_read(AVFilterContext *sink, AVFilterBufferRef **buf);
114
115 /**
116  * Same as av_buffersink_read, but with the ability to specify the number of
117  * samples read. This function is less efficient than av_buffersink_read(),
118  * because it copies the data around.
119  *
120  * @param sink pointer to a context of the abuffersink AVFilter.
121  * @param buf pointer to the buffer will be written here if buf is non-NULL. buf
122  *            must be freed by the caller using avfilter_unref_buffer(). buf
123  *            will contain exactly nb_samples audio samples, except at the end
124  *            of stream, when it can contain less than nb_samples.
125  *            Buf may also be NULL to query whether a buffer is ready to be
126  *            output.
127  *
128  * @warning do not mix this function with av_buffersink_read(). Use only one or
129  * the other with a single sink, not both.
130  */
131 int av_buffersink_read_samples(AVFilterContext *ctx, AVFilterBufferRef **buf,
132                                int nb_samples);
133
134 /**
135  * @}
136  */
137
138 #endif /* AVFILTER_BUFFERSINK_H */