[FFmpeg-cvslog] avcodec/rangecoder: Document ff_rac_terminate()

[Michael Niedermayer]

ffmpeg | branch: master | Michael Niedermayer <michael at niedermayer.cc> | Wed Dec 19 02:40:20 2018 +0100| [20b10ba83c46d1f2b381b0b3e70ce44195473815] | committer: Michael Niedermayer

avcodec/rangecoder: Document ff_rac_terminate()

Signed-off-by: Michael Niedermayer <michael at niedermayer.cc>

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

 libavcodec/rangecoder.h | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/libavcodec/rangecoder.h b/libavcodec/rangecoder.h
index e5c7a3cc71..4495f6df1a 100644
--- a/libavcodec/rangecoder.h
+++ b/libavcodec/rangecoder.h
@@ -48,7 +48,15 @@ typedef struct RangeCoder {
 
 void ff_init_range_encoder(RangeCoder *c, uint8_t *buf, int buf_size);
 void ff_init_range_decoder(RangeCoder *c, const uint8_t *buf, int buf_size);
+
+/**
+ * Terminates the range coder
+ * @param version version 0 requires the decoder to know the data size in bytes
+ *                version 1 needs about 1 bit more space but does not need to
+ *                          carry the size from encoder to decoder
+ */
 int ff_rac_terminate(RangeCoder *c, int version);
+
 void ff_build_rac_states(RangeCoder *c, int factor, int max_p);
 
 static inline void renorm_encoder(RangeCoder *c)