summaryrefslogtreecommitdiffstats
path: root/libavcodec/unary.h
diff options
context:
space:
mode:
authorMichael Niedermayer <michael@niedermayer.cc>2018-09-22 15:18:17 +0200
committerMichael Niedermayer <michael@niedermayer.cc>2018-10-07 03:03:09 +0200
commitad89e203bfedf25df00e2a6ed9196170d772f25b (patch)
tree6e611055dce7ece80f8b444c55a5dd0e88fe29f7 /libavcodec/unary.h
parentc98ffa086c5d3c30256744ce568a3b76cd5a72b0 (diff)
downloadffmpeg-streaming-ad89e203bfedf25df00e2a6ed9196170d772f25b.zip
ffmpeg-streaming-ad89e203bfedf25df00e2a6ed9196170d772f25b.tar.gz
avcodec/unary: Improve get_unary() docs
Found-by: kierank Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
Diffstat (limited to 'libavcodec/unary.h')
-rw-r--r--libavcodec/unary.h15
1 files changed, 14 insertions, 1 deletions
diff --git a/libavcodec/unary.h b/libavcodec/unary.h
index 908dc93..d57f9f7 100644
--- a/libavcodec/unary.h
+++ b/libavcodec/unary.h
@@ -28,7 +28,20 @@
* @param gb GetBitContext
* @param[in] stop The bitstop value (unary code of 1's or 0's)
* @param[in] len Maximum length
- * @return Unary length/index
+ * @return unary 0 based code index. This is also the length in bits of the
+ * code excluding the stop bit.
+ * (in case len=1)
+ * 1 0
+ * 0 1
+ * (in case len=2)
+ * 1 0
+ * 01 1
+ * 00 2
+ * (in case len=3)
+ * 1 0
+ * 01 1
+ * 001 2
+ * 000 3
*/
static inline int get_unary(GetBitContext *gb, int stop, int len)
{
OpenPOWER on IntegriCloud