[FFmpeg-cvslog] r19794 - trunk/libavcodec/get_bits.h

[reimar]

Author: reimar
Date: Tue Sep  8 10:30:56 2009
New Revision: 19794

Log:
Try to clarify that anyone using get_bits must check for buffer overrun
themselves, get_bits does not do anything in that regard.

Modified:
   trunk/libavcodec/get_bits.h

Modified: trunk/libavcodec/get_bits.h
==============================================================================
--- trunk/libavcodec/get_bits.h	Tue Sep  8 00:42:51 2009	(r19793)
+++ trunk/libavcodec/get_bits.h	Tue Sep  8 10:30:56 2009	(r19794)
@@ -489,6 +489,9 @@ static inline int check_marker(GetBitCon
  * @param buffer bitstream buffer, must be FF_INPUT_BUFFER_PADDING_SIZE bytes larger then the actual read bits
  * because some optimized bitstream readers read 32 or 64 bit at once and could read over the end
  * @param bit_size the size of the buffer in bits
+ *
+ * While GetBitContext stores the buffer size, for performance reasons you are
+ * responsible for checking for the buffer end yourself (take advantage of the padding)!
  */
 static inline void init_get_bits(GetBitContext *s,
                    const uint8_t *buffer, int bit_size)