From 4b1630e1ec1fe5cbecc013a3e1487d9f43fcdd2f Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@duempel.org>
Date: Mon, 26 Oct 2015 23:55:17 +0100
Subject: AudioFormat: define that channel order follows the FLAC convention

Basic definition to solve http://bugs.musicpd.org/view.php?id=3147 and
http://bugs.musicpd.org/view.php?id=3255
---
 src/AudioFormat.hxx | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

(limited to 'src')

diff --git a/src/AudioFormat.hxx b/src/AudioFormat.hxx
index a00e761a8..e30e575a3 100644
--- a/src/AudioFormat.hxx
+++ b/src/AudioFormat.hxx
@@ -82,8 +82,19 @@ struct AudioFormat {
 	SampleFormat format;
 
 	/**
-	 * The number of channels.  Only mono (1) and stereo (2) are
-	 * fully supported currently.
+	 * The number of channels.
+	 *
+	 * Channel order follows the FLAC convention
+	 * (https://xiph.org/flac/format.html):
+	 *
+	 * - 1 channel: mono
+	 * - 2 channels: left, right
+	 * - 3 channels: left, right, center
+	 * - 4 channels: front left, front right, back left, back right
+	 * - 5 channels: front left, front right, front center, back/surround left, back/surround right
+	 * - 6 channels: front left, front right, front center, LFE, back/surround left, back/surround right
+	 * - 7 channels: front left, front right, front center, LFE, back center, side left, side right
+	 * - 8 channels: front left, front right, front center, LFE, back left, back right, side left, side right
 	 */
 	uint8_t channels;
 
-- 
cgit v1.2.3