diff options
| author | Nicolas George | 2012-11-28 12:05:24 +0100 |
|---|---|---|
| committer | Nicolas George | 2012-12-02 18:51:04 +0100 |
| commit | 2cb227f6a2a0aa04da8fbcfd4c7a6069c0cb4c36 (patch) | |
| tree | b9aeb3c5c24b93111f9383bba422f8138b8ce533 /libavutil/channel_layout.h | |
| parent | 5148147b26f55c9e172adcd1acd774240659aa92 (diff) | |
lavu/channel_layout: document the semantic of layouts.
Diffstat (limited to 'libavutil/channel_layout.h')
| -rw-r--r-- | libavutil/channel_layout.h | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/libavutil/channel_layout.h b/libavutil/channel_layout.h index e1a6d28b1f..2906098313 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 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 |