summaryrefslogtreecommitdiff
path: root/libavutil
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2012-09-08 01:19:37 +0200
committerStefano Sabatini <stefasab@gmail.com>2012-09-09 11:21:45 +0200
commit3634441452f4261a0f60043a234233de6a2c18ef (patch)
treeeec269f4bb5105b258a0a803ed7bf694b3b68d5e /libavutil
parenta4cb0af94582aa7598db95bba4bc92f1b349dfe3 (diff)
lavu/samplefmt: add note regarding buf validity in av_samples_fill_arrays() doxy
Diffstat (limited to 'libavutil')
-rw-r--r--libavutil/samplefmt.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/libavutil/samplefmt.h b/libavutil/samplefmt.h
index 681e521c69..d8028104bc 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.
*