The Vorbis text comment header is the second (of three) headerpackets that begin a Vorbis bitstream. It is meant for short, textcomments, not arbitrary metadata; arbitrary metadata belongs in aseparate logical bitstream (usually an XML stream type) that providesgreater structure and machine parseability.
The comment field is meant to be used much like someone jotting aquick note on the bottom of a CDR. It should be a little information toremember the disc by and explain it to others; a short, to-the-pointtext note that need not only be a couple words, but isn't going to bemore than a short paragraph. The essentials, in other words, whateverthey turn out to be, eg:
"Honest Bob and the Factory-to-Dealer-Incentives, _I'm Still Around_,opening for Moxy Früvous, 1997"
The comment header logically is a list of eight-bit-clean vectors; thenumber of vectors is bounded to 2^32-1 and the length of each vectoris limited to 2^32-1 bytes. The vector length is encoded; the vectorcontents themselves are not null terminated. In addition to the vectorlist, there is a single vector for vendor name (also 8 bit clean,length encoded in 32 bits). For example, the 1.0 release of libvorbis set the vendor string to "Xiph.Org libVorbis I 20020717".
The comment header is decoded as follows:
1) [vendor_length] = read an unsigned integer of 32 bits 2) [vendor_string] = read a UTF-8 vector as [vendor_length] octets 3) [user_comment_list_length] = read an unsigned integer of 32 bits 4) iterate [user_comment_list_length] times { 5) [length] = read an unsigned integer of 32 bits 6) this iteration's user comment = read a UTF-8 vector as [length] octets } 7) [framing_bit] = read a single bit as boolean 8) if ( [framing_bit] unset or end of packet ) then ERROR 9) done.The comment vectors are structured similarly to a UNIX environment variable.That is, comment fields consist of a field name and a corresponding value andlook like:
comment[0]="ARTIST=me"; comment[1]="TITLE=the sound of Vorbis";
Below is a proposed, minimal list of standard field names with adescription of intended use. No single or group of field names ismandatory; a comment header may contain one, all or none of the namesin this list.
ARTIST=Dizzy Gillespie ARTIST=Sonny Rollins ARTIST=Sonny Stitt
The comment header comprises the entirety of the second bitstreamheader packet. Unlike the first bitstream header packet, it is notgenerally the only packet on the second page and may not be restrictedto within the second bitstream page. The length of the comment headerpacket is (practically) unbounded. The comment header packet is notoptional; it must be present in the bitstream even if it iseffectively empty.
The comment header is encoded as follows (as per Ogg's standardbitstream mapping which renders least-significant-bit of the word to becoded into the least significant available bit of the currentbitstream octet first):
This is actually somewhat easier to describe in code; implementation of the abovecan be found in vorbis/lib/info.c:_vorbis_pack_comment(),_vorbis_unpack_comment()