avcodec/get_bits: Document skip_bits_long()
authorMichael Niedermayer <michael@niedermayer.cc>
Fri, 23 Mar 2018 17:58:33 +0000 (18:58 +0100)
committerMichael Niedermayer <michael@niedermayer.cc>
Sat, 7 Apr 2018 17:16:37 +0000 (19:16 +0200)
Found-by: Kieran
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
libavcodec/get_bits.h

index d7cf286..56ef5f0 100644 (file)
@@ -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