aboutsummaryrefslogtreecommitdiffstats
path: root/libavresample/avresample.h
diff options
context:
space:
mode:
authorAnton Khirnov <anton@khirnov.net>2012-10-28 22:52:55 +0100
committerAnton Khirnov <anton@khirnov.net>2012-10-29 20:05:47 +0100
commitdc5793062e7a0f6d195fc403d7ce242729b4ea4a (patch)
tree6296078cd41eec9267390cccaa5ee841fc5783ef /libavresample/avresample.h
parent01b760190d32550683d7c790309acadea3fe0820 (diff)
downloadffmpeg-dc5793062e7a0f6d195fc403d7ce242729b4ea4a.tar.gz
lavr: document upper bound on number of output samples.
Signed-off-by: Anton Khirnov <anton@khirnov.net>
Diffstat (limited to 'libavresample/avresample.h')
-rw-r--r--libavresample/avresample.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/libavresample/avresample.h b/libavresample/avresample.h
index 87134b3916..b0a9e247e8 100644
--- a/libavresample/avresample.h
+++ b/libavresample/avresample.h
@@ -265,6 +265,10 @@ int avresample_set_compensation(AVAudioResampleContext *avr, int sample_delta,
/**
* Convert input samples and write them to the output FIFO.
*
+ * The upper bound on the number of output samples is given by
+ * avresample_available() + (avresample_get_delay() + number of input samples) *
+ * output sample rate / input sample rate.
+ *
* The output data can be NULL or have fewer allocated samples than required.
* In this case, any remaining samples not written to the output will be added
* to an internal FIFO buffer, to be returned at the next call to this function