[xiph-commits] r15099 - trunk/vorbis/doc/xml

[giles at svn.xiph.org]

Author: giles
Date: 2008-07-06 11:02:04 -0700 (Sun, 06 Jul 2008)
New Revision: 15099

Modified:
   trunk/vorbis/doc/xml/05-comment.xml
Log:
Document explicitly that the comment header uses little endian integers
for the the benefit of those reading the comment spec in isolation.


Modified: trunk/vorbis/doc/xml/05-comment.xml
===================================================================
--- trunk/vorbis/doc/xml/05-comment.xml	2008-07-05 16:30:07 UTC (rev 15098)
+++ trunk/vorbis/doc/xml/05-comment.xml	2008-07-06 18:02:04 UTC (rev 15099)
@@ -50,6 +50,12 @@
 length encoded in 32 bits). For example, the 1.0 release of libvorbis 
 set the vendor string to "Xiph.Org libVorbis I 20020717".</para>
 
+<para>
+The vector lengths and number of vectors are stored lsb first, according 
+to the bit packing conventions of the vorbis codec. However, since data 
+in the comment header is octet-aligned, they can simply be read as 
+unaligned 32 bit little endian unsigned integers.
+ 
 <para>The comment header is decoded as follows:
 
 <programlisting>