diff options
author | Stefano Sabatini <stefasab@gmail.com> | 2012-12-08 22:47:52 +0100 |
---|---|---|
committer | Stefano Sabatini <stefasab@gmail.com> | 2012-12-09 21:55:46 +0100 |
commit | 461b5bf4abf70f8b8baba01812682c77512d079c (patch) | |
tree | e0ec57719ab4075e96c2beb4479704387bff1aa3 /libavcodec/avcodec.h | |
parent | ad47ac20ae3e8ac52fa23f6fa520a3124cc515cd (diff) | |
download | ffmpeg-streaming-461b5bf4abf70f8b8baba01812682c77512d079c.zip ffmpeg-streaming-461b5bf4abf70f8b8baba01812682c77512d079c.tar.gz |
lavc/avcodec: extend/clarify/fix documentation for avcodec_fill_audio_frame()
Diffstat (limited to 'libavcodec/avcodec.h')
-rw-r--r-- | libavcodec/avcodec.h | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h index dde4253..e432040 100644 --- a/libavcodec/avcodec.h +++ b/libavcodec/avcodec.h @@ -4774,7 +4774,12 @@ int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, //FIXME func typedef /** - * Fill audio frame data and linesize. + * Fill AVFrame audio data and linesize pointers. + * + * The buffer buf must be a preallocated buffer with a size big enough + * to contain the specified samples amount. The filled AVFrame data + * pointers will point to this buffer. + * * AVFrame extended_data channel pointers are allocated if necessary for * planar audio. * @@ -4788,8 +4793,8 @@ int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, * @param buf_size size of buffer * @param align plane size sample alignment (0 = default) * @return >=0 on success, negative error code on failure - * @todo return the size of the allocated frame size in case of - * success, at the next libavutil bump + * @todo return the size in bytes required to store the samples in + * case of success, at the next libavutil bump */ int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels, enum AVSampleFormat sample_fmt, const uint8_t *buf, |