From 95f5495e7ff8e1f56c5d36332da95a7851acf1c4 Mon Sep 17 00:00:00 2001
From: Monty <xiphmont@xiph.org>
Date: Tue, 26 Jan 2010 02:40:41 +0000
Subject: [PATCH] Commit channel ordering clarifications to libvorbisfile doc

svn path=/trunk/vorbis/; revision=16805
---
 doc/vorbisfile/ov_read.html       | 27 ++++++++++++++++++++++++---
 doc/vorbisfile/ov_read_float.html |  2 +-
 2 files changed, 25 insertions(+), 4 deletions(-)

diff --git a/doc/vorbisfile/ov_read.html b/doc/vorbisfile/ov_read.html
index 08aab81..8144af4 100644
--- a/doc/vorbisfile/ov_read.html
+++ b/doc/vorbisfile/ov_read.html
@@ -25,9 +25,30 @@
    If the passed in buffer is large, <tt>ov_read()</tt> will not fill
    it; the passed in buffer size is treated as a <em>limit</em> and
    not a request.
-<p>
-   
-Note that up to this point, the Vorbisfile API could more or less hide the
+
+<p>The output channels are in stream order and not remapped. Vorbis I
+defines channel order as follows:
+
+<ul>
+<li>one channel - the stream is monophonic
+<li>two channels - the stream is stereo.  channel order: left, right
+<li>three channels - the stream is a 1d-surround encoding.  channel order: left,
+center, right
+<li>four channels - the stream is quadraphonic surround.  channel order: front left,
+front right, rear left, rear right
+<li>five channels - the stream is five-channel surround.  channel order: front left,
+center, front right, rear left, rear right
+<li>six channels - the stream is 5.1 surround.  channel order: front left, center, 
+front right, rear left, rear right, LFE
+<li>seven channels - the stream is 6.1 surround.  channel order: front left, center, 
+front right, side left, side right, rear center, LFE
+<li>eight channels - the stream is 7.1 surround.  channel order: front left, center, 
+front right, side left, side right, rear left, rear right, 
+LFE
+<li>greater than eight channels - channel use and order is undefined
+</ul>
+
+<p>Note that up to this point, the Vorbisfile API could more or less hide the
    multiple logical bitstream nature of chaining from the toplevel
    application if the toplevel application didn't particularly care.
    However, when reading audio back, the application must be aware
diff --git a/doc/vorbisfile/ov_read_float.html b/doc/vorbisfile/ov_read_float.html
index 2462151..4138ebf 100644
--- a/doc/vorbisfile/ov_read_float.html
+++ b/doc/vorbisfile/ov_read_float.html
@@ -21,7 +21,7 @@
    This is the function used to decode a Vorbis file within a loop, but
    returns samples in native float format instead of in integer formats.
 </p><p>
-   For more information on how ov_read_float() deals with the complex issues 
+   For information on channel ordering and how ov_read_float() deals with the complex issues 
    of chaining, etc, refer to the documentation for <a href="ov_read.html">ov_read()</a>.
 </p>
 
-- 
2.7.4