lpc: Document the use_lpc parameter to ff_lpc_calc_coefs().

Patch by Patrik Kullman (patrik A yes D nu). Originally committed as revision 17216 to svn://svn.ffmpeg.org/ffmpeg/trunk
16 years ago · 83f63ffb22
parent 3c90870a2f
commit 83f63ffb22
1 changed files with 5 additions and 0 deletions
--- a/libavcodec/lpc.c
+++ b/libavcodec/lpc.c
@ -94,6 +94,11 @@ static int estimate_best_order(double *ref, int min_order, int max_order)

 /**
 * Calculate LPC coefficients for multiple orders
+ *
+ * @param use_lpc LPC method for determining coefficients
+ * 0  = LPC with fixed pre-defined coeffs
+ * 1  = LPC with coeffs determined by Levinson-Durbin recursion
+ * 2+ = LPC with coeffs determined by Cholesky factorization using (use_lpc-1) passes.
 */
 int ff_lpc_calc_coefs(DSPContext *s,
                      const int32_t *samples, int blocksize, int min_order,