[FFmpeg-cvslog] r13581 - trunk/libavcodec/ra144.c

[vitor]

Author: vitor
Date: Sat May 31 17:37:41 2008
New Revision: 13581

Log:
Add doxy comments to eq() and do_voice()

Modified:
   trunk/libavcodec/ra144.c

Modified: trunk/libavcodec/ra144.c
==============================================================================
--- trunk/libavcodec/ra144.c	(original)
+++ trunk/libavcodec/ra144.c	Sat May 31 17:37:41 2008
@@ -71,7 +71,10 @@ static int t_sqrt(unsigned int x)
     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 @@ static int dec1(int16_t *decsp, const in
     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;