# HG changeset patch
# User vitor
# Date 1212248261 0
# Node ID 51708e7f3274555365a35b958646948f2f9367a7
# Parent  4c1b8b50313ca7434ef18e05be7527a4a2d01e74
Add doxy comments to eq() and do_voice()

diff -r 4c1b8b50313c -r 51708e7f3274 ra144.c
--- a/ra144.c	Sat May 31 15:31:57 2008 +0000
+++ b/ra144.c	Sat May 31 15:37:41 2008 +0000
@@ -71,7 +71,10 @@
     return (ff_sqrt(x << 20) << s) << 2;
 }
 
-/* do 'voice' */
+/**
+ * Evaluate the LPC filter coefficients from the reflection coefficients.
+ * Does the inverse of the eq() function.
+ */
 static void do_voice(const int *a1, int *a2)
 {
     int buffer[10];
@@ -246,6 +249,13 @@
     return rms(data, f);
 }
 
+/**
+ * Evaluate the reflection coefficients from the filter coefficients.
+ * Does the inverse of the do_voice() function.
+ *
+ * @return 1 if one of the reflection coefficients is of magnitude greater than
+ *         4095, 0 if not.
+ */
 static int eq(const int16_t *in, int *target)
 {
     int retval = 0;