diff mbox

[FFmpeg-devel,3/3] avcodec/rangecoder: Document ff_rac_terminate()

Message ID 20181219014020.16299-3-michael@niedermayer.cc
State Accepted
Commit 20b10ba83c46d1f2b381b0b3e70ce44195473815
Headers show

Commit Message

Michael Niedermayer Dec. 19, 2018, 1:40 a.m. UTC 
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
---
 libavcodec/rangecoder.h | 8 ++++++++
 1 file changed, 8 insertions(+)
diff mbox

Patch

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)