lavu/channel_layout: document the semantic of layouts.
authorNicolas George <nicolas.george@normalesup.org>
Wed, 28 Nov 2012 11:05:24 +0000 (12:05 +0100)
committerNicolas George <nicolas.george@normalesup.org>
Sun, 2 Dec 2012 17:51:04 +0000 (18:51 +0100)
libavutil/channel_layout.h

index e1a6d28..2906098 100644 (file)
 
 /**
  * @defgroup channel_masks Audio channel masks
+ *
+ * A channel layout is a 64-bits integer with a bit set for every channel.
+ * The number of bits set 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