Minor documentation fixes from Alexander Chemeris
authorjm <jm@0101bb08-14d6-0310-b084-bc0e0c8e3800>
Tue, 9 Oct 2007 11:08:15 +0000 (11:08 +0000)
committerjm <jm@0101bb08-14d6-0310-b084-bc0e0c8e3800>
Tue, 9 Oct 2007 11:08:15 +0000 (11:08 +0000)
git-svn-id: http://svn.xiph.org/trunk/speex@13943 0101bb08-14d6-0310-b084-bc0e0c8e3800

include/speex/speex_echo.h
libspeex/mdf.c
libspeex/preprocess.c

index f2440ba..77a7846 100644 (file)
@@ -77,7 +77,7 @@ void speex_echo_state_destroy(SpeexEchoState *st);
  * to playback in this form)
  *
  * @param st Echo canceller state
- * @param rec signal from the microphone (near end + far end echo)
+ * @param rec Signal from the microphone (near end + far end echo)
  * @param play Signal played to the speaker (received from far end)
  * @param out Returns near-end signal with echo removed
  */
@@ -89,7 +89,7 @@ void speex_echo_cancel(SpeexEchoState *st, const spx_int16_t *rec, const spx_int
 /** Perform echo cancellation using internal playback buffer, which is delayed by two frames
  * to account for the delay introduced by most soundcards (but it could be off!)
  * @param st Echo canceller state
- * @param rec signal from the microphone (near end + far end echo)
+ * @param rec Signal from the microphone (near end + far end echo)
  * @param out Returns near-end signal with echo removed
 */
 void speex_echo_capture(SpeexEchoState *st, const spx_int16_t *rec, spx_int16_t *out);
index 2545272..5a6fa2f 100644 (file)
@@ -635,13 +635,13 @@ void speex_echo_playback(SpeexEchoState *st, const spx_int16_t *play)
    }
 }
 
-/** Performs echo cancellation on a frame */
+/** Performs echo cancellation on a frame (deprecated, last arg now ignored) */
 void speex_echo_cancel(SpeexEchoState *st, const spx_int16_t *in, const spx_int16_t *far_end, spx_int16_t *out, spx_int32_t *Yout)
 {
    speex_echo_cancellation(st, in, far_end, out);
 }
 
-/** Performs echo cancellation on a frame (deprecated, last arg now ignored) */
+/** Performs echo cancellation on a frame */
 void speex_echo_cancellation(SpeexEchoState *st, const spx_int16_t *in, const spx_int16_t *far_end, spx_int16_t *out)
 {
    int i,j;
index b5caf4b..c10f478 100644 (file)
@@ -215,7 +215,7 @@ struct SpeexPreprocessState_ {
    spx_word32_t *S;          /**< Smoothed power spectrum */
    spx_word32_t *Smin;       /**< See Cohen paper */
    spx_word32_t *Stmp;       /**< See Cohen paper */
-   int *update_prob;       /**< Propability of speech presence for noise update */
+   int *update_prob;         /**< Probability of speech presence for noise update */
 
    spx_word16_t *zeta;       /**< Smoothed a priori SNR */
    spx_word32_t *echo_noise;