diff mbox

[FFmpeg-devel] avcodec/unary: Improve get_unary() docs

Message ID 20180922131817.19989-1-michael@niedermayer.cc
State Accepted
Commit ad89e203bfedf25df00e2a6ed9196170d772f25b
Headers show

Commit Message

Michael Niedermayer Sept. 22, 2018, 1:18 p.m. UTC
Found-by: kierank
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
---
 libavcodec/unary.h | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

Comments

Michael Niedermayer Oct. 6, 2018, 8:06 p.m. UTC | #1
On Sat, Sep 22, 2018 at 03:18:17PM +0200, Michael Niedermayer wrote:
> Found-by: kierank
> Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
> ---
>  libavcodec/unary.h | 15 ++++++++++++++-
>  1 file changed, 14 insertions(+), 1 deletion(-)

will apply

[...]
diff mbox

Patch

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)
 {