summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Niedermayer <michael@niedermayer.cc>2018-03-23 18:58:33 +0100
committerMichael Niedermayer <michael@niedermayer.cc>2018-04-07 19:16:37 +0200
commit6261ef425128093609af2a0ce7505f72492e45bf (patch)
tree01bce41e3325b9906364de223eee78f4594cff2d
parent9703b7d05fc7ab0378808b8d372a9c4a96e97488 (diff)
downloadffmpeg-6261ef425128093609af2a0ce7505f72492e45bf.tar.gz
avcodec/get_bits: Document skip_bits_long()
Found-by: Kieran Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
-rw-r--r--libavcodec/get_bits.h7
1 files changed, 7 insertions, 0 deletions
diff --git a/libavcodec/get_bits.h b/libavcodec/get_bits.h
index d7cf286378..56ef5f0cbe 100644
--- 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