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

diff --git a/libavutil/samplefmt.h b/libavutil/samplefmt.h
index 681e521c695a3d17b9952a8bc1e4399adb2b7bdf..d8028104bc81483335caca90603f14c0027a8f97 100644 (file)
--- 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.
  *