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

jm at svn.xiph.org jm at svn.xiph.org
Sun Oct 14 06:56:11 PDT 2007 

Author: jm
Date: 2007-10-14 06:56:10 -0700 (Sun, 14 Oct 2007)
New Revision: 13977

Modified:
   trunk/speex/doc/manual.lyx
Log:
reorganising sections in the manual


Modified: trunk/speex/doc/manual.lyx
===================================================================
--- trunk/speex/doc/manual.lyx	2007-10-14 11:48:32 UTC (rev 13976)
+++ trunk/speex/doc/manual.lyx	2007-10-14 13:56:10 UTC (rev 13977)
@@ -1389,29 +1389,7 @@
 \end_layout
 
 \begin_layout Chapter
-Programming with Speex
-\begin_inset LatexCommand label
-name "sec:Programming-with-Speex"
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-This section explains how to use the Speex API.
- Examples of code can also be found in Appendix 
-\begin_inset LatexCommand ref
-reference "sec:Sample-code"
-
-\end_inset
-
- and the complete API documentation is included in the Documentation section
- of the Speex website (http://www.speex.org/).
-\end_layout
-
-\begin_layout Section
-Codec API (
+Using the Speex Codec API (
 \emph on
 libspeex
 \emph default
@@ -1422,6 +1400,12 @@
 \end_inset
 
 )
+\begin_inset LatexCommand label
+name "sec:Programming-with-Speex"
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Standard
@@ -1446,9 +1430,17 @@
 calls using the same state from multiple threads must be protected by mutexes
 \series default
 .
+ Examples of code can also be found in Appendix 
+\begin_inset LatexCommand ref
+reference "sec:Sample-code"
+
+\end_inset
+
+ and the complete API documentation is included in the Documentation section
+ of the Speex website (http://www.speex.org/).
 \end_layout
 
-\begin_layout Subsection
+\begin_layout Section
 Encoding
 \begin_inset LatexCommand label
 name "sub:Encoding"
@@ -1718,7 +1710,7 @@
  
 \end_layout
 
-\begin_layout Subsection
+\begin_layout Section
 Decoding
 \begin_inset LatexCommand label
 name "sub:Decoding"
@@ -1929,7 +1921,7 @@
 
 \end_layout
 
-\begin_layout Subsection
+\begin_layout Section
 Codec Options (speex_*_ctl)
 \begin_inset LatexCommand label
 name "sub:Codec-Options"
@@ -2214,7 +2206,7 @@
  not be using it in the first place
 \end_layout
 
-\begin_layout Subsection
+\begin_layout Section
 Mode queries
 \begin_inset LatexCommand label
 name "sub:Mode-queries"
@@ -2263,7 +2255,7 @@
  
 \end_layout
 
-\begin_layout Subsection
+\begin_layout Section
 Packing and in-band signalling
 \begin_inset LatexCommand index
 name "in-band signalling"
@@ -2904,9 +2896,11 @@
 Finally, applications may define custom in-band messages using mode 13.
  The size of the message in bytes is encoded with 5 bits, so that the decoder
  can skip it if it doesn't know how to interpret it.
+\newpage
+
 \end_layout
 
-\begin_layout Section
+\begin_layout Chapter
 Speech Processing API (
 \emph on
 libspeexdsp
@@ -2940,7 +2934,7 @@
 .
 \end_layout
 
-\begin_layout Subsection
+\begin_layout Section
 Preprocessor
 \begin_inset LatexCommand label
 name "sub:Preprocessor"
@@ -2951,6 +2945,7 @@
 \end_layout
 
 \begin_layout Standard
+\noindent
 In order to use the Speex preprocessor
 \begin_inset LatexCommand index
 name "preprocessor"
@@ -2958,9 +2953,6 @@
 \end_inset
 
 , you first need to:
-\end_layout
-
-\begin_layout Standard
 \begin_inset listings
 inline false
 status open
@@ -2976,10 +2968,8 @@
 \end_layout
 
 \begin_layout Standard
+\noindent
 Then, a preprocessor state can be created as:
-\end_layout
-
-\begin_layout Standard
 \begin_inset listings
 inline false
 status open
@@ -2996,7 +2986,8 @@
 \end_layout
 
 \begin_layout Standard
-It is recommended to use the same value for 
+\noindent
+and it is recommended to use the same value for 
 \family typewriter
 frame_size
 \family default
@@ -3027,15 +3018,13 @@
 \end_layout
 
 \begin_layout Standard
+\noindent
 where 
 \family typewriter
 audio_frame
 \family default
  is used both as input and output.
-\end_layout
-
-\begin_layout Standard
-In cases where the output audio is not useful for a certain frame, it is
+ In cases where the output audio is not useful for a certain frame, it is
  possible to use instead:
 \end_layout
 
@@ -3055,6 +3044,7 @@
 \end_layout
 
 \begin_layout Standard
+\noindent
 This call will update all the preprocessor internal state variables without
  computing the output audio, thus saving some CPU cycles.
 \end_layout
@@ -3079,8 +3069,15 @@
 \end_layout
 
 \begin_layout Standard
+\noindent
 which is used in the same way as the encoder and decoder equivalent.
- Options are listed in Section .
+ Options are listed in Section 
+\begin_inset LatexCommand ref
+reference "sub:Preprocessor-options"
+
+\end_inset
+
+.
 \end_layout
 
 \begin_layout Standard
@@ -3102,7 +3099,7 @@
 
 \end_layout
 
-\begin_layout Subsubsection
+\begin_layout Subsection
 Preprocessor options
 \begin_inset LatexCommand label
 name "sub:Preprocessor-options"
@@ -3112,6 +3109,12 @@
 
 \end_layout
 
+\begin_layout Standard
+As with the codec, the preprocessor also has options that can be controlled
+ using an ioctl()-like call.
+ The available options are:
+\end_layout
+
 \begin_layout Description
 SPEEX_PREPROCESS_SET_DENOISE Turns denoising on(1) or off(2) (integer)
 \end_layout
@@ -3226,7 +3229,7 @@
 SPEEX_PREPROCESS_GET_ECHO_STATE Get the associated echo canceller
 \end_layout
 
-\begin_layout Subsection
+\begin_layout Section
 Echo Cancellation
 \begin_inset LatexCommand label
 name "sub:Echo-Cancellation"
@@ -3547,7 +3550,7 @@
 
 \end_layout
 
-\begin_layout Subsubsection
+\begin_layout Subsection
 Troubleshooting
 \end_layout
 
@@ -3559,8 +3562,11 @@
 \end_layout
 
 \begin_layout Itemize
-Using a different soundcard to do the capture and plaback will *not* work,
- regardless of what you may think.
+Using a different soundcard to do the capture and plaback will 
+\series bold
+not
+\series default
+ work, regardless of what you may think.
  The only exception to that is if the two cards can be made to have their
  sampling clock 
 \begin_inset Quotes eld
@@ -3571,6 +3577,8 @@
 \end_inset
 
  on the same clock source.
+ If not, the clocks will always have a small amount of drift, which will
+ prevent the echo canceller from adapting.
 \end_layout
 
 \begin_layout Itemize
@@ -3670,7 +3678,7 @@
  problem with the playback or recording process.
 \end_layout
 
-\begin_layout Subsection
+\begin_layout Section
 Jitter Buffer
 \end_layout
 
@@ -3896,7 +3904,7 @@
  
 \end_layout
 
-\begin_layout Subsection
+\begin_layout Section
 Resampler
 \end_layout

More information about the commits mailing list