buffersink: document special error codes returned from av_buffersink_get_frame
[ffmpeg.git] / libavfilter / buffersink.h
1 /*
2  * This file is part of Libav.
3  *
4  * Libav 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  * Libav 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 Libav; 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
25  */
26
27 #include "avfilter.h"
28
29 #if FF_API_AVFILTERBUFFER
30 /**
31  * Get a buffer with filtered data from sink and put it in buf.
32  *
33  * @param ctx pointer to a context of a buffersink or abuffersink AVFilter.
34  * @param buf pointer to the buffer will be written here if buf is non-NULL. buf
35  *            must be freed by the caller using avfilter_unref_buffer().
36  *            Buf may also be NULL to query whether a buffer is ready to be
37  *            output.
38  *
39  * @return >= 0 in case of success, a negative AVERROR code in case of
40  *         failure.
41  */
42 attribute_deprecated
43 int av_buffersink_read(AVFilterContext *ctx, AVFilterBufferRef **buf);
44
45 /**
46  * Same as av_buffersink_read, but with the ability to specify the number of
47  * samples read. This function is less efficient than av_buffersink_read(),
48  * because it copies the data around.
49  *
50  * @param ctx pointer to a context of the abuffersink AVFilter.
51  * @param buf pointer to the buffer will be written here if buf is non-NULL. buf
52  *            must be freed by the caller using avfilter_unref_buffer(). buf
53  *            will contain exactly nb_samples audio samples, except at the end
54  *            of stream, when it can contain less than nb_samples.
55  *            Buf may also be NULL to query whether a buffer is ready to be
56  *            output.
57  *
58  * @warning do not mix this function with av_buffersink_read(). Use only one or
59  * the other with a single sink, not both.
60  */
61 attribute_deprecated
62 int av_buffersink_read_samples(AVFilterContext *ctx, AVFilterBufferRef **buf,
63                                int nb_samples);
64 #endif
65
66 /**
67  * Get a frame with filtered data from sink and put it in frame.
68  *
69  * @param ctx pointer to a context of a buffersink or abuffersink AVFilter.
70  * @param frame pointer to an allocated frame that will be filled with data.
71  *              The data must be freed using av_frame_unref() / av_frame_free()
72  *
73  * @return
74  *         - >= 0 if a frame was successfully returned.
75  *         - AVERROR(EAGAIN) if no frames are available at this point; more
76  *           input frames must be added to the filtergraph to get more output.
77  *         - AVERROR_EOF if there will be no more output frames on this sink.
78  *         - A different negative AVERROR code in other failure cases.
79  */
80 int av_buffersink_get_frame(AVFilterContext *ctx, AVFrame *frame);
81
82 /**
83  * Same as av_buffersink_get_frame(), but with the ability to specify the number
84  * of samples read. This function is less efficient than
85  * av_buffersink_get_frame(), because it copies the data around.
86  *
87  * @param ctx pointer to a context of the abuffersink AVFilter.
88  * @param frame pointer to an allocated frame that will be filled with data.
89  *              The data must be freed using av_frame_unref() / av_frame_free()
90  *              frame will contain exactly nb_samples audio samples, except at
91  *              the end of stream, when it can contain less than nb_samples.
92  *
93  * @return The return codes have the same meaning as for
94  *         av_buffersink_get_samples().
95  *
96  * @warning do not mix this function with av_buffersink_get_frame(). Use only one or
97  * the other with a single sink, not both.
98  */
99 int av_buffersink_get_samples(AVFilterContext *ctx, AVFrame *frame, int nb_samples);
100
101 #endif /* AVFILTER_BUFFERSINK_H */