diff options
author | Stefano Sabatini <stefasab@gmail.com> | 2012-09-08 01:18:09 +0200 |
---|---|---|
committer | Stefano Sabatini <stefasab@gmail.com> | 2012-09-09 11:41:17 +0200 |
commit | eab438eabbefb44b35d2db05f233509bec0c3502 (patch) | |
tree | c20c00f4c7cb3e6e356d87064afcd82c12112c36 /libavutil/samplefmt.h | |
parent | 3634441452f4261a0f60043a234233de6a2c18ef (diff) | |
download | ffmpeg-streaming-eab438eabbefb44b35d2db05f233509bec0c3502.zip ffmpeg-streaming-eab438eabbefb44b35d2db05f233509bec0c3502.tar.gz |
lavu/samplefmt: fix/clarify documentation for av_samples_fill_arrays()
In particular, avoid improper use of the term "channels" in place of
"planes", and fix erroneous documentation for the linesize parameter.
Diffstat (limited to 'libavutil/samplefmt.h')
-rw-r--r-- | libavutil/samplefmt.h | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/libavutil/samplefmt.h b/libavutil/samplefmt.h index d802810..2a7de20 100644 --- a/libavutil/samplefmt.h +++ b/libavutil/samplefmt.h @@ -158,16 +158,16 @@ int av_samples_get_buffer_size(int *linesize, int nb_channels, int nb_samples, enum AVSampleFormat sample_fmt, int align); /** - * Fill channel data pointers and linesize for samples with sample + * Fill plane data pointers and linesize for samples with sample * format sample_fmt. * - * The pointers array is filled with the pointers to the samples data: + * The audio_data array is filled with the pointers to the samples data planes: * for planar, set the start point of each channel's data within the buffer, * for packed, set the start point of the entire buffer only. * - * The linesize array is filled with the aligned size of each channel's data - * buffer for planar layout, or the aligned size of the buffer for all channels - * for packed layout. + * The value pointed to by linesize is set to the aligned size of each + * channel's data buffer for planar layout, or to 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), |