[FFmpeg-cvslog] lavc/avcodec: extend/clarify/fix documentation for avcodec_fill_audio_frame ()

[Stefano Sabatini]

ffmpeg | branch: master | Stefano Sabatini <stefasab at gmail.com> | Sat Dec  8 22:47:52 2012 +0100| [461b5bf4abf70f8b8baba01812682c77512d079c] | committer: Stefano Sabatini

lavc/avcodec: extend/clarify/fix documentation for avcodec_fill_audio_frame()

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=461b5bf4abf70f8b8baba01812682c77512d079c
---

 libavcodec/avcodec.h |   11 ++++++++---
 1 file 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,