diff common.c @ 1249:7ac0a77e5973 libavcodec

100l (document buffer padding requirements)
author michaelni
date Mon, 12 May 2003 23:03:00 +0000
parents e88d3b1fb2a1
children 604661d34c68
line wrap: on
line diff
--- a/common.c	Mon May 12 17:59:26 2003 +0000
+++ b/common.c	Mon May 12 23:03:00 2003 +0000
@@ -123,6 +123,12 @@
 
 #endif //CONFIG_ENCODERS
 
+/**
+ * init GetBitContext.
+ * @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
+ */
 void init_get_bits(GetBitContext *s,
                    const uint8_t *buffer, int bit_size)
 {