Browse code

lavr: document upper bound on number of output samples.

Signed-off-by: Anton Khirnov <anton@khirnov.net>

Anton Khirnov authored on 2012/10/29 06:52:55
Showing 1 changed files
... ...
@@ -265,6 +265,10 @@ int avresample_set_compensation(AVAudioResampleContext *avr, int sample_delta,
265 265
 /**
266 266
  * Convert input samples and write them to the output FIFO.
267 267
  *
268
+ * The upper bound on the number of output samples is given by
269
+ * avresample_available() + (avresample_get_delay() + number of input samples) *
270
+ * output sample rate / input sample rate.
271
+ *
268 272
  * The output data can be NULL or have fewer allocated samples than required.
269 273
  * In this case, any remaining samples not written to the output will be added
270 274
  * to an internal FIFO buffer, to be returned at the next call to this function