swr-doxy: elaborate on swr_get_delay() and the timebase
authorMichael Niedermayer <michaelni@gmx.at>
Tue, 20 Nov 2012 19:05:08 +0000 (20:05 +0100)
committerMichael Niedermayer <michaelni@gmx.at>
Tue, 20 Nov 2012 19:05:08 +0000 (20:05 +0100)
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
libswresample/swresample.h

index 071db42..ff79f39 100644 (file)
@@ -256,6 +256,10 @@ int swr_inject_silence(struct SwrContext *s, int count);
  * Swresample can buffer data if more input has been provided than available
  * output space, also converting between sample rates needs a delay.
  * This function returns the sum of all such delays.
+ * The exact delay is not neccessarily an integer value in either input or
+ * output sample rate. Especially when downsampling by a large value, the
+ * output sample rate may be a poor choice to represent the delay, similarly
+ * for upsampling and the input sample rate.
  *
  * @param s     swr context
  * @param base  timebase in which the returned delay will be