[xiph-commits] r13959 - trunk/speex/doc

[jm at svn.xiph.org]

Author: jm
Date: 2007-10-11 17:06:07 -0700 (Thu, 11 Oct 2007)
New Revision: 13959

Modified:
   trunk/speex/doc/manual.lyx
Log:
manual update


Modified: trunk/speex/doc/manual.lyx
===================================================================
--- trunk/speex/doc/manual.lyx	2007-10-11 23:33:29 UTC (rev 13958)
+++ trunk/speex/doc/manual.lyx	2007-10-12 00:06:07 UTC (rev 13959)
@@ -897,8 +897,24 @@
 
 \end_layout
 
+\begin_layout Section
+Resampler
+\end_layout
+
 \begin_layout Standard
+In some cases, it may be useful to convert audio from one sampling rate
+ to another.
+ There are many reasons for that.
+ It can be for mixing streams that have different sampling rates, for supporting
+ sampling rates that the soundcard doesn't support, for transcoding, etc.
+ That's why there is now a resampler that is part of the Speex project.
+ This resampler can be used to convert between any two arbitrary rates (the
+ ratio must only be a rational number) and there is control over the quality/com
+plexity tradeoff.
+\end_layout
 
+\begin_layout Standard
+
 \newpage
 
 \end_layout
@@ -2026,7 +2042,8 @@
 \begin_inset Formula $\dagger$
 \end_inset
 
- normally only used internally
+ If you can't understand from the source code what this does, you should
+ not be using it in the first place
 \end_layout
 
 \begin_layout Subsection
@@ -3384,10 +3401,6 @@
 
 \begin_layout Standard
 
-\end_layout
-
-\begin_layout Standard
-
 \newpage
 
 \end_layout