From 2a97c5915b8f7ef8048c934b2047912873719568 Mon Sep 17 00:00:00 2001 From: Michael Bradshaw Date: Fri, 8 Mar 2013 22:48:43 -0700 Subject: [PATCH] Make audio FIFO read/write contracts more strict Signed-off-by: Michael Bradshaw Signed-off-by: Michael Niedermayer --- libavutil/audio_fifo.h | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/libavutil/audio_fifo.h b/libavutil/audio_fifo.h index 8c76388255..55a538e78f 100644 --- a/libavutil/audio_fifo.h +++ b/libavutil/audio_fifo.h @@ -85,7 +85,8 @@ int av_audio_fifo_realloc(AVAudioFifo *af, int nb_samples); * @param data audio data plane pointers * @param nb_samples number of samples to write * @return number of samples actually written, or negative AVERROR - * code on failure. + * code on failure. If successful, the number of samples + * actually written will always be nb_samples. */ int av_audio_fifo_write(AVAudioFifo *af, void **data, int nb_samples); @@ -99,7 +100,9 @@ int av_audio_fifo_write(AVAudioFifo *af, void **data, int nb_samples); * @param data audio data plane pointers * @param nb_samples number of samples to read * @return number of samples actually read, or negative AVERROR code - * on failure. + * on failure. The number of samples actually read will not + * be greater than nb_samples, and will only be less than + * nb_samples if av_audio_fifo_size is less than nb_samples. */ int av_audio_fifo_read(AVAudioFifo *af, void **data, int nb_samples);