lavr: document upper bound on number of output samples.
authorAnton Khirnov <anton@khirnov.net>
Sun, 28 Oct 2012 21:52:55 +0000 (22:52 +0100)
committerAnton Khirnov <anton@khirnov.net>
Mon, 29 Oct 2012 19:05:47 +0000 (20:05 +0100)
Signed-off-by: Anton Khirnov <anton@khirnov.net>
libavresample/avresample.h

index 87134b3..b0a9e24 100644 (file)
@@ -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