From f758ea6e99af6ebd24bbe222898a921c222e5593 Mon Sep 17 00:00:00 2001 From: Anton Khirnov Date: Tue, 21 May 2013 20:30:36 +0200 Subject: [PATCH] buffersink: document special error codes returned from av_buffersink_get_frame --- libavfilter/buffersink.h | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/libavfilter/buffersink.h b/libavfilter/buffersink.h index 75cea35b77..f12db88d04 100644 --- a/libavfilter/buffersink.h +++ b/libavfilter/buffersink.h @@ -70,8 +70,12 @@ int av_buffersink_read_samples(AVFilterContext *ctx, AVFilterBufferRef **buf, * @param frame pointer to an allocated frame that will be filled with data. * The data must be freed using av_frame_unref() / av_frame_free() * - * @return >= 0 in case of success, a negative AVERROR code in case of - * failure. + * @return + * - >= 0 if a frame was successfully returned. + * - AVERROR(EAGAIN) if no frames are available at this point; more + * input frames must be added to the filtergraph to get more output. + * - AVERROR_EOF if there will be no more output frames on this sink. + * - A different negative AVERROR code in other failure cases. */ int av_buffersink_get_frame(AVFilterContext *ctx, AVFrame *frame); @@ -86,6 +90,9 @@ int av_buffersink_get_frame(AVFilterContext *ctx, AVFrame *frame); * frame will contain exactly nb_samples audio samples, except at * the end of stream, when it can contain less than nb_samples. * + * @return The return codes have the same meaning as for + * av_buffersink_get_samples(). + * * @warning do not mix this function with av_buffersink_get_frame(). Use only one or * the other with a single sink, not both. */