comparison ra144enc.c @ 12024:fdafbcef52f5 libavcodec

Fix grammar errors in documentation
author mru
date Wed, 30 Jun 2010 15:38:06 +0000
parents a3152c2776c4
children e59926e2c50c
comparison
equal deleted inserted replaced
12023:c7455450364d 12024:fdafbcef52f5
57 return 0; 57 return 0;
58 } 58 }
59 59
60 60
61 /** 61 /**
62 * Quantizes a value by searching a sorted table for the element with the 62 * Quantize a value by searching a sorted table for the element with the
63 * nearest value 63 * nearest value
64 * 64 *
65 * @param value value to quantize 65 * @param value value to quantize
66 * @param table array containing the quantization table 66 * @param table array containing the quantization table
67 * @param size size of the quantization table 67 * @param size size of the quantization table
86 } 86 }
87 } 87 }
88 88
89 89
90 /** 90 /**
91 * Orthogonalizes a vector to another vector 91 * Orthogonalize a vector to another vector
92 * 92 *
93 * @param v vector to orthogonalize 93 * @param v vector to orthogonalize
94 * @param u vector against which orthogonalization is performed 94 * @param u vector against which orthogonalization is performed
95 */ 95 */
96 static void orthogonalize(float *v, const float *u) 96 static void orthogonalize(float *v, const float *u)
107 v[i] -= num * u[i]; 107 v[i] -= num * u[i];
108 } 108 }
109 109
110 110
111 /** 111 /**
112 * Calculates match score and gain of an LPC-filtered vector with respect to 112 * Calculate match score and gain of an LPC-filtered vector with respect to
113 * input data, possibly othogonalizing it to up to 2 other vectors 113 * input data, possibly othogonalizing it to up to 2 other vectors
114 * 114 *
115 * @param work array used to calculate the filtered vector 115 * @param work array used to calculate the filtered vector
116 * @param coefs coefficients of the LPC filter 116 * @param coefs coefficients of the LPC filter
117 * @param vect original vector 117 * @param vect original vector
146 *score = *gain * c; 146 *score = *gain * c;
147 } 147 }
148 148
149 149
150 /** 150 /**
151 * Creates a vector from the adaptive codebook at a given lag value 151 * Create a vector from the adaptive codebook at a given lag value
152 * 152 *
153 * @param vect array where vector is stored 153 * @param vect array where vector is stored
154 * @param cb adaptive codebook 154 * @param cb adaptive codebook
155 * @param lag lag value 155 * @param lag lag value
156 */ 156 */
166 vect[lag + i] = cb[i]; 166 vect[lag + i] = cb[i];
167 } 167 }
168 168
169 169
170 /** 170 /**
171 * Searches the adaptive codebook for the best entry and gain and removes its 171 * Search the adaptive codebook for the best entry and gain and remove its
172 * contribution from input data 172 * contribution from input data
173 * 173 *
174 * @param adapt_cb array from which the adaptive codebook is extracted 174 * @param adapt_cb array from which the adaptive codebook is extracted
175 * @param work array used to calculate LPC-filtered vectors 175 * @param work array used to calculate LPC-filtered vectors
176 * @param coefs coefficients of the LPC filter 176 * @param coefs coefficients of the LPC filter
208 return (best_vect - BLOCKSIZE / 2 + 1); 208 return (best_vect - BLOCKSIZE / 2 + 1);
209 } 209 }
210 210
211 211
212 /** 212 /**
213 * Finds the best vector of a fixed codebook by applying an LPC filter to 213 * Find the best vector of a fixed codebook by applying an LPC filter to
214 * codebook entries, possibly othogonalizing them to up to 2 other vectors and 214 * codebook entries, possibly othogonalizing them to up to 2 other vectors and
215 * matching the results with input data 215 * matching the results with input data
216 * 216 *
217 * @param work array used to calculate the filtered vectors 217 * @param work array used to calculate the filtered vectors
218 * @param coefs coefficients of the LPC filter 218 * @param coefs coefficients of the LPC filter
247 } 247 }
248 } 248 }
249 249
250 250
251 /** 251 /**
252 * Searches the two fixed codebooks for the best entry and gain 252 * Search the two fixed codebooks for the best entry and gain
253 * 253 *
254 * @param work array used to calculate LPC-filtered vectors 254 * @param work array used to calculate LPC-filtered vectors
255 * @param coefs coefficients of the LPC filter 255 * @param coefs coefficients of the LPC filter
256 * @param data input data 256 * @param data input data
257 * @param cba_idx index of the best entry of the adaptive codebook 257 * @param cba_idx index of the best entry of the adaptive codebook
299 ortho_cb1 ? cb1_vect : NULL, data, cb2_idx, &gain); 299 ortho_cb1 ? cb1_vect : NULL, data, cb2_idx, &gain);
300 } 300 }
301 301
302 302
303 /** 303 /**
304 * Encodes a subblock of the current frame 304 * Encode a subblock of the current frame
305 * 305 *
306 * @param ractx encoder context 306 * @param ractx encoder context
307 * @param sblock_data input data of the subblock 307 * @param sblock_data input data of the subblock
308 * @param lpc_coefs coefficients of the LPC filter 308 * @param lpc_coefs coefficients of the LPC filter
309 * @param rms RMS of the reflection coefficients 309 * @param rms RMS of the reflection coefficients