Merge commit '7e350379f87e7f74420b4813170fe808e2313911'
[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 #if FF_API_AVFILTERBUFFER
30 /**
31  * Struct to use for initializing a buffersink context.
32  */
33 typedef struct {
34     const enum AVPixelFormat *pixel_fmts; ///< list of allowed pixel formats, terminated by AV_PIX_FMT_NONE
35 } AVBufferSinkParams;
36
37 /**
38  * Create an AVBufferSinkParams structure.
39  *
40  * Must be freed with av_free().
41  */
42 AVBufferSinkParams *av_buffersink_params_alloc(void);
43
44 /**
45  * Struct to use for initializing an abuffersink context.
46  */
47 typedef struct {
48     const enum AVSampleFormat *sample_fmts; ///< list of allowed sample formats, terminated by AV_SAMPLE_FMT_NONE
49     const int64_t *channel_layouts;         ///< list of allowed channel layouts, terminated by -1
50     const int *channel_counts;              ///< list of allowed channel counts, terminated by -1
51     int all_channel_counts;                 ///< if not 0, accept any channel count or layout
52     int *sample_rates;                      ///< list of allowed sample rates, terminated by -1
53 } AVABufferSinkParams;
54
55 /**
56  * Create an AVABufferSinkParams structure.
57  *
58  * Must be freed with av_free().
59  */
60 AVABufferSinkParams *av_abuffersink_params_alloc(void);
61
62 /**
63  * Set the frame size for an audio buffer sink.
64  *
65  * All calls to av_buffersink_get_buffer_ref will return a buffer with
66  * exactly the specified number of samples, or AVERROR(EAGAIN) if there is
67  * not enough. The last buffer at EOF will be padded with 0.
68  */
69 void av_buffersink_set_frame_size(AVFilterContext *ctx, unsigned frame_size);
70
71 /**
72  * Tell av_buffersink_get_buffer_ref() to read video/samples buffer
73  * reference, but not remove it from the buffer. This is useful if you
74  * need only to read a video/samples buffer, without to fetch it.
75  */
76 #define AV_BUFFERSINK_FLAG_PEEK 1
77
78 /**
79  * Tell av_buffersink_get_buffer_ref() not to request a frame from its input.
80  * If a frame is already buffered, it is read (and removed from the buffer),
81  * but if no frame is present, return AVERROR(EAGAIN).
82  */
83 #define AV_BUFFERSINK_FLAG_NO_REQUEST 2
84
85 /**
86  * Get an audio/video buffer data from buffer_sink and put it in bufref.
87  *
88  * This function works with both audio and video buffer sinks.
89  *
90  * @param buffer_sink pointer to a buffersink or abuffersink context
91  * @param flags a combination of AV_BUFFERSINK_FLAG_* flags
92  * @return >= 0 in case of success, a negative AVERROR code in case of
93  * failure
94  */
95 int av_buffersink_get_buffer_ref(AVFilterContext *buffer_sink,
96                                  AVFilterBufferRef **bufref, int flags);
97
98 /* TODO */
99 int av_buffersink_get_frame_flags(AVFilterContext *ctx, AVFrame *frame, int flags);
100
101 /**
102  * Get the number of immediately available frames.
103  */
104 int av_buffersink_poll_frame(AVFilterContext *ctx);
105
106 /**
107  * Get the frame rate of the input.
108  */
109 AVRational av_buffersink_get_frame_rate(AVFilterContext *ctx);
110
111 /**
112  * @defgroup libav_api Libav API
113  * @{
114  */
115
116 /**
117  * Get a buffer with filtered data from sink and put it in buf.
118  *
119  * @param ctx pointer to a context of a buffersink or abuffersink AVFilter.
120  * @param buf pointer to the buffer will be written here if buf is non-NULL. buf
121  *            must be freed by the caller using avfilter_unref_buffer().
122  *            Buf may also be NULL to query whether a buffer is ready to be
123  *            output.
124  *
125  * @return >= 0 in case of success, a negative AVERROR code in case of
126  *         failure.
127  */
128 attribute_deprecated
129 int av_buffersink_read(AVFilterContext *ctx, AVFilterBufferRef **buf);
130
131 /**
132  * Same as av_buffersink_read, but with the ability to specify the number of
133  * samples read. This function is less efficient than av_buffersink_read(),
134  * because it copies the data around.
135  *
136  * @param ctx pointer to a context of the abuffersink AVFilter.
137  * @param buf pointer to the buffer will be written here if buf is non-NULL. buf
138  *            must be freed by the caller using avfilter_unref_buffer(). buf
139  *            will contain exactly nb_samples audio samples, except at the end
140  *            of stream, when it can contain less than nb_samples.
141  *            Buf may also be NULL to query whether a buffer is ready to be
142  *            output.
143  *
144  * @warning do not mix this function with av_buffersink_read(). Use only one or
145  * the other with a single sink, not both.
146  */
147 attribute_deprecated
148 int av_buffersink_read_samples(AVFilterContext *ctx, AVFilterBufferRef **buf,
149                                int nb_samples);
150 #endif
151
152 /**
153  * Get a frame with filtered data from sink and put it in frame.
154  *
155  * @param ctx pointer to a context of a buffersink or abuffersink AVFilter.
156  * @param frame pointer to an allocated frame that will be filled with data.
157  *              The data must be freed using av_frame_unref() / av_frame_free()
158  *
159  * @return >= 0 in case of success, a negative AVERROR code in case of
160  *         failure.
161  */
162 int av_buffersink_get_frame(AVFilterContext *ctx, AVFrame *frame);
163
164 /**
165  * Same as av_buffersink_get_frame(), but with the ability to specify the number
166  * of samples read. This function is less efficient than
167  * av_buffersink_get_frame(), because it copies the data around.
168  *
169  * @param ctx pointer to a context of the abuffersink AVFilter.
170  * @param frame pointer to an allocated frame that will be filled with data.
171  *              The data must be freed using av_frame_unref() / av_frame_free()
172  *              frame will contain exactly nb_samples audio samples, except at
173  *              the end of stream, when it can contain less than nb_samples.
174  *
175  * @warning do not mix this function with av_buffersink_get_frame(). Use only one or
176  * the other with a single sink, not both.
177  */
178 int av_buffersink_get_samples(AVFilterContext *ctx, AVFrame *frame, int nb_samples);
179
180 /**
181  * @}
182  */
183
184 #endif /* AVFILTER_BUFFERSINK_H */