avcodec/unary: Improve get_unary() docs

Found-by: kierank
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
pull/299/head
Michael Niedermayer 6 years ago
parent c98ffa086c
commit ad89e203bf
  1. 15
      libavcodec/unary.h

@ -28,7 +28,20 @@
* @param gb GetBitContext * @param gb GetBitContext
* @param[in] stop The bitstop value (unary code of 1's or 0's) * @param[in] stop The bitstop value (unary code of 1's or 0's)
* @param[in] len Maximum length * @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) static inline int get_unary(GetBitContext *gb, int stop, int len)
{ {

Loading…
Cancel
Save