avcodec/get_bits: Document skip_bits_long()

Found-by: Kieran Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
7 years ago · 6261ef4251
parent 9703b7d05f
commit 6261ef4251
1 changed files with 7 additions and 0 deletions
--- a/libavcodec/get_bits.h
+++ b/libavcodec/get_bits.h
@ -202,6 +202,13 @@ static inline int get_bits_count(const GetBitContext *s)
    return s->index;
 }

+/**
+ * Skips the specified number of bits.
+ * @param n the number of bits to skip,
+ *          For the UNCHECKED_BITSTREAM_READER this must not cause the distance
+ *          from the start to overflow int32_t. Staying within the bitstream + padding
+ *          is sufficient, too.
+ */
 static inline void skip_bits_long(GetBitContext *s, int n)
 {
 #if UNCHECKED_BITSTREAM_READER