aboutsummaryrefslogtreecommitdiffstats
path: root/libavcodec/get_bits.h
diff options
context:
space:
mode:
authorMichael Niedermayer <michael@niedermayer.cc>2018-01-28 02:29:01 +0100
committerMichael Niedermayer <michael@niedermayer.cc>2018-01-30 22:50:23 +0100
commitcd478122b0a05abaf82d96da2c9eb2d00635f72e (patch)
tree8f09740852463cd8f22116be9a9961003effcff2 /libavcodec/get_bits.h
parent6723a436095f76f6d1edec4de21b2a0b47954067 (diff)
downloadffmpeg-cd478122b0a05abaf82d96da2c9eb2d00635f72e.tar.gz
avcodec/get_bits: Document the return code of get_vlc2()
Found-by: kierank Reviewed-by: Kieran Kunhya <kieran618@googlemail.com> Signed-off-by: Michael Niedermayer <michael@niedermayer.cc> (cherry picked from commit 4a94ff4ccd4f2329c599e37cabe4152dae60359e) Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
Diffstat (limited to 'libavcodec/get_bits.h')
-rw-r--r--libavcodec/get_bits.h1
1 files changed, 1 insertions, 0 deletions
diff --git a/libavcodec/get_bits.h b/libavcodec/get_bits.h
index c530015169..0c7f5ff0c6 100644
--- a/libavcodec/get_bits.h
+++ b/libavcodec/get_bits.h
@@ -550,6 +550,7 @@ static inline const uint8_t *align_get_bits(GetBitContext *s)
* @param max_depth is the number of times bits bits must be read to completely
* read the longest vlc code
* = (max_vlc_length + bits - 1) / bits
+ * @returns the code parsed or -1 if no vlc matches
*/
static av_always_inline int get_vlc2(GetBitContext *s, VLC_TYPE (*table)[2],
int bits, int max_depth)