lpc: Document the use_lpc parameter to ff_lpc_calc_coefs().
authorPatrik Kullman <patrik@yes.nu>
Fri, 13 Feb 2009 22:01:46 +0000 (22:01 +0000)
committerJustin Ruggles <justin.ruggles@gmail.com>
Fri, 13 Feb 2009 22:01:46 +0000 (22:01 +0000)
Patch by Patrik Kullman (patrik A yes D nu).

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

libavcodec/lpc.c

index dd145ca..7f951b4 100644 (file)
@@ -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,