diff options
| author | Michael Niedermayer <michael@niedermayer.cc> | 2018-09-22 15:18:17 +0200 |
|---|---|---|
| committer | Michael Niedermayer <michael@niedermayer.cc> | 2018-10-28 02:22:42 +0200 |
| commit | 0cbd4fb9955e1cb3ff2427b1a7dbf1b0da4d57d8 (patch) | |
| tree | 2b7945f00238c10aad19fae31626341371be611f | |
| parent | 848726afc642fbe8aea7773594506bfb495bd8ab (diff) | |
| download | ffmpeg-0cbd4fb9955e1cb3ff2427b1a7dbf1b0da4d57d8.tar.gz | |
avcodec/unary: Improve get_unary() docs
Found-by: kierank
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
(cherry picked from commit ad89e203bfedf25df00e2a6ed9196170d772f25b)
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
| -rw-r--r-- | libavcodec/unary.h | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/libavcodec/unary.h b/libavcodec/unary.h index 908dc93507..d57f9f70c5 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) { |