diff utils.c @ 1249:7ac0a77e5973 libavcodec

100l (document buffer padding requirements)

--- a/utils.c	Mon May 12 17:59:26 2003 +0000
+++ b/utils.c	Mon May 12 23:03:00 2003 +0000
@@ -343,9 +343,15 @@
     return ret;
 }
 
-/* decode a frame. return -1 if error, otherwise return the number of
-   bytes used. If no frame could be decompressed, *got_picture_ptr is
-   zero. Otherwise, it is non zero */
+/** 
+ * decode a frame. 
+ * @param buf bitstream buffer, must be FF_INPUT_BUFFER_PADDING_SIZE larger then the actual read bytes
+ * because some optimized bitstream readers read 32 or 64 bit at once and could read over the end
+ * @param buf_size the size of the buffer in bytes
+ * @param got_picture_ptr zero if no frame could be decompressed, Otherwise, it is non zero
+ * @return -1 if error, otherwise return the number of
+ * bytes used. 
+ */
 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture, 
                          int *got_picture_ptr,
                          uint8_t *buf, int buf_size)