[FFmpeg-cvslog] lavu/samplefmt: add note regarding buf validity in av_samples_fill_arrays() doxy

[Stefano Sabatini]

ffmpeg | branch: master | Stefano Sabatini <stefasab at gmail.com> | Sat Sep  8 01:19:37 2012 +0200| [3634441452f4261a0f60043a234233de6a2c18ef] | committer: Stefano Sabatini

lavu/samplefmt: add note regarding buf validity in av_samples_fill_arrays() doxy

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

 libavutil/samplefmt.h |    4 ++++
 1 file changed, 4 insertions(+)

diff --git a/libavutil/samplefmt.h b/libavutil/samplefmt.h
index 681e521..d802810 100644
--- a/libavutil/samplefmt.h
+++ b/libavutil/samplefmt.h
@@ -169,6 +169,10 @@ int av_samples_get_buffer_size(int *linesize, int nb_channels, int nb_samples,
  * buffer for planar layout, or the aligned size of the buffer for all channels
  * for packed layout.
  *
+ * The buffer in buf must be big enough to contain all the samples
+ * (use av_samples_get_buffer_size() to compute its minimum size),
+ * otherwise the audio_data pointers will point to invalid data.
+ *
  * @see enum AVSampleFormat
  * The documentation for AVSampleFormat describes the data layout.
  *