[FFmpeg-cvslog] avcodec/v210: document the requirement for sample_factor

[James Darnley]

ffmpeg | branch: master | James Darnley <james.darnley at gmail.com> | Fri Jan 15 19:53:28 2016 +0100| [4c430738d9cc8a5712e681236aff4f36991fd48f] | committer: James Darnley

avcodec/v210: document the requirement for sample_factor

The sample factor must be the same for both 8- and 10-bit functions chosen
otherwise the output will be incorrect.

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=4c430738d9cc8a5712e681236aff4f36991fd48f
---

 libavcodec/v210enc.h |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/libavcodec/v210enc.h b/libavcodec/v210enc.h
index 85f84f1..899a7d9 100644
--- a/libavcodec/v210enc.h
+++ b/libavcodec/v210enc.h
@@ -28,7 +28,8 @@ typedef struct V210EncContext {
                         const uint8_t *v, uint8_t *dst, ptrdiff_t width);
     void (*pack_line_10)(const uint16_t *y, const uint16_t *u,
                          const uint16_t *v, uint8_t *dst, ptrdiff_t width);
-    int sample_factor;
+    int sample_factor; /* This value must be the same for both 8-and 10-bit
+                          functions otherwise the output will be incorrect. */
 } V210EncContext;
 
 void ff_v210enc_init(V210EncContext *s);