lpc: Document the use_lpc parameter to ff_lpc_calc_coefs().

Patch by Patrik Kullman (patrik A yes D nu).

git-svn-id: file:///var/local/repositories/ffmpeg/trunk@17216 9553f0bf-9b14-0410-a0b8-cfaf0461ba5b

diff --git a/libavcodec/lpc.c b/libavcodec/lpc.c
index dd145ca8756a0e07987f54be4f5d85afe4217be3..7f951b44a1dcd129dc7ab8d94caf36283359dae1 100644 (file)
--- 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,