[FFmpeg-devel] [PATCH 1/6] lavu/channel_layout: document the semantic of layouts.

[Nicolas George]

Signed-off-by: Nicolas George <nicolas.george at normalesup.org>
---
 libavutil/channel_layout.h |    8 ++++++++
 1 file changed, 8 insertions(+)


Note: this is not a change in the API, just a clarification about what has
been until now assumed by various parts of the code.


diff --git a/libavutil/channel_layout.h b/libavutil/channel_layout.h
index e1a6d28..9368992 100644
--- a/libavutil/channel_layout.h
+++ b/libavutil/channel_layout.h
@@ -36,6 +36,14 @@
 
 /**
  * @defgroup channel_masks Audio channel masks
+ *
+ * A channel layout is a 64-bits integer with a bit set for every channel.
+ * The number of bit sets must be equal to the number of channels.
+ * The value 0 means that the channel layout is not known.
+ * @note this data structure is not powerful enough to handle channels
+ * combinations that have the same channel multiple times, such as
+ * dual-mono.
+ *
  * @{
  */
 #define AV_CH_FRONT_LEFT             0x00000001
-- 
1.7.10.4