[FFmpeg-devel] [PATCH 6/6] lavc/flacdsp: document limitations of the LPC encoder

[James Darnley]

---
 libavcodec/flacdsp.h |    7 +++++++
 1 files changed, 7 insertions(+), 0 deletions(-)

diff --git a/libavcodec/flacdsp.h b/libavcodec/flacdsp.h
index 272cf2a..36cd904 100644
--- a/libavcodec/flacdsp.h
+++ b/libavcodec/flacdsp.h
@@ -27,6 +27,13 @@ typedef struct FLACDSPContext {
                            int len, int shift);
     void (*lpc)(int32_t *samples, const int coeffs[32], int order,
                 int qlevel, int len);
+    /**
+     * This function has some limitations with various configurations:
+     * - when CONFIG_SMALL is 0 there is an unrolled loop which assumes the
+     *   maximum value of order is 32.
+     * - when SSE4 (or newer) is available on x86 there is an unrolled copy
+     *   which also assumes the maximum value of order is 0.
+     */
     void (*lpc_encode)(int32_t *res, const int32_t *smp, int len, int order,
                        const int32_t *coefs, int shift);
 } FLACDSPContext;
-- 
1.7.9