[xiph-commits] r12458 - trunk/speex/include/speex

[jm at svn.xiph.org]

Author: jm
Date: 2007-02-12 07:22:26 -0800 (Mon, 12 Feb 2007)
New Revision: 12458

Modified:
   trunk/speex/include/speex/speex_resampler.h
Log:
more doc


Modified: trunk/speex/include/speex/speex_resampler.h
===================================================================
--- trunk/speex/include/speex/speex_resampler.h	2007-02-12 15:16:22 UTC (rev 12457)
+++ trunk/speex/include/speex/speex_resampler.h	2007-02-12 15:22:26 UTC (rev 12458)
@@ -220,7 +220,11 @@
                                       int stride);
 
 /** Make sure that the first samples to go out of the resamplers don't have 
- * leading zeros. This is only useful before starting to use a newly created resampler.
+ * leading zeros. This is only useful before starting to use a newly created 
+ * resampler. It is recommended to use that when resampling an audio file, as
+ * it will generate a file with the same length. For real-time processing,
+ * it is probably easier not to use this call (so that the output duration
+ * is the same for the first frame).
  * @param st Resampler state
  */
 void speex_resampler_skip_zeros(SpeexResamplerState *st);