summaryrefslogtreecommitdiff
path: root/libavutil/samplefmt.h
diff options
context:
space:
mode:
authorStefano Sabatini <stefano.sabatini-lala@poste.it>2011-03-22 13:29:28 +0100
committerStefano Sabatini <stefano.sabatini-lala@poste.it>2011-06-06 10:11:48 +0200
commite1c74148128ebed7c7bc9d36c776f24898267174 (patch)
tree1e07e3cbbd966c1f636e517837b3af2de4143f53 /libavutil/samplefmt.h
parent580817df048fb114529cdb4a82885f551bf62c0c (diff)
samplefmt: change layout for arrays created by av_samples_alloc() and _fill_arrays()
The new layout is consistent with that of the av_image_() API, and simplifies understanding and copy operations, it also preserves alignment information which was lost with the previous layout. This breaks API/ABI, but since the function was never referenced in the code (and it isn't unlikely already used by someone) then this should not be a problem.
Diffstat (limited to 'libavutil/samplefmt.h')
-rw-r--r--libavutil/samplefmt.h9
1 files changed, 7 insertions, 2 deletions
diff --git a/libavutil/samplefmt.h b/libavutil/samplefmt.h
index 9b9c0d49a9..a091721d96 100644
--- a/libavutil/samplefmt.h
+++ b/libavutil/samplefmt.h
@@ -74,8 +74,13 @@ int av_get_bits_per_sample_fmt(enum AVSampleFormat sample_fmt);
* format sample_fmt.
*
* The pointers array is filled with the pointers to the samples data:
- * data[c] points to the first sample of channel c.
- * data[c] + linesize[0] points to the second sample of channel c
+ * for planar, set the start point of each plane'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 samples
+ * plane, that is linesize[i] will contain the linesize of the plane i,
+ * and will be zero for all the unused planes. All linesize values are
+ * equal.
*
* @param pointers array to be filled with the pointer for each plane, may be NULL
* @param linesizes array to be filled with the linesize, may be NULL