Mercurial > libavcodec.hg
changeset 1249:7ac0a77e5973 libavcodec
100l (document buffer padding requirements)
| author | michaelni |
|---|---|
| date | Mon, 12 May 2003 23:03:00 +0000 |
| parents | 25fb0364c4bb |
| children | fa181d095027 |
| files | common.c utils.c |
| diffstat | 2 files changed, 15 insertions(+), 3 deletions(-) [+] |
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) {
--- 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)