lavr: document upper bound on number of output samples.

Signed-off-by: Anton Khirnov <anton@khirnov.net>
This commit is contained in:
Anton Khirnov 2012-10-28 22:52:55 +01:00
parent 01b760190d
commit dc5793062e
1 changed files with 4 additions and 0 deletions

View 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