Browse code

Add doxy comments to eq() and do_voice()

Originally committed as revision 13581 to svn://svn.ffmpeg.org/ffmpeg/trunk

Vitor Sessak authored on 2008/06/01 00:37:41
Showing 1 changed files
... ...
@@ -71,7 +71,10 @@ static int t_sqrt(unsigned int x)
71 71
     return (ff_sqrt(x << 20) << s) << 2;
72 72
 }
73 73
 
74
-/* do 'voice' */
74
+/**
75
+ * Evaluate the LPC filter coefficients from the reflection coefficients.
76
+ * Does the inverse of the eq() function.
77
+ */
75 78
 static void do_voice(const int *a1, int *a2)
76 79
 {
77 80
     int buffer[10];
... ...
@@ -246,6 +249,13 @@ static int dec1(int16_t *decsp, const int *data, const int *inp, int f)
246 246
     return rms(data, f);
247 247
 }
248 248
 
249
+/**
250
+ * Evaluate the reflection coefficients from the filter coefficients.
251
+ * Does the inverse of the do_voice() function.
252
+ *
253
+ * @return 1 if one of the reflection coefficients is of magnitude greater than
254
+ *         4095, 0 if not.
255
+ */
249 256
 static int eq(const int16_t *in, int *target)
250 257
 {
251 258
     int retval = 0;