doc/v-comment.html

   1 <HTML><HEAD><TITLE>xiph.org: Ogg Vorbis documentation</TITLE>
   2 <BODY bgcolor="#ffffff" text="#202020" link="#006666" vlink="#000000">
   3 <nobr><img src="white-ogg.png"><img src="vorbisword2.png"></nobr><p>
   4
   5
   6 <h1><font color=#000070>
   7 Ogg Vorbis comment field specification
   8 </font></h1>
   9
  10 <em>Last update to this document: January 19, 2001</em><p>
  11
  12 The text comment header is the second (of three) header packets that
  13 begin a Vorbis bitstream. It is meant for short, text comments,
  14 not arbitrary metadata; arbitrary metadata belongs in a
  15 metadata stream (usually an XML stream type).<p>
  16
  17 <h2>Comment use rationale</h2>
  18
  19 The comment field is meant to be used much like someone jotting a
  20 quick note on the bottom of a CDR. It should be a little information to
  21 remember the disc by and explain it to others; a short, to-the-point
  22 text note that need not only be a couple words, but isn't going to be
  23 more than a short paragraph.  The essentials, in other words, whatever
  24 they turn out to be, eg:
  25
  26 <blockquote>
  27 "Honest Bob and the Factory-to-Dealer-Incentives, _I'm Still Around_,
  28 opening for Moxy Fruvous, 1997"
  29 </blockquote>
  30
  31 <h2>Structure</h2>
  32
  33 The comment header logically is a list of eight-bit-clean vectors; the
  34 number of vectors is bounded to 2^32-1 and the length of each vector
  35 is limited to 2^32-1 bytes. The vector length is encoded; the vector
  36 is not null terminated. In addition to the vector list, there is a
  37 single vector for vendor name (also 8 bit clean, length encoded in 32
  38 bits). Libvorbis currently sets the vendor string to "Xiphophorus
  39 libVorbis I 20010119".<p>
  40
  41 The comment vectors are structured similarly to a UNIX environment.
  42 That is, comment fields consist of a field name and a field value and
  43 look like:
  44
  45 <pre>
  46 comment[0]="ARTIST=me";
  47 comment[1]="TITLE=the sound of vorbis";
  48 </pre>
  49
  50 <h2>Content vector format</h2>
  51
  52 <ul>
  53 <li>A case-insensitive field name that may consist of ASCII 0x20 through
  54 0x7D, 0x3D ('=') excluded. ASCII 0x41 through 0x5A inclusive (A-Z) is
  55 to be considered equivalent to ASCII 0x61 through 0x7A inclusive
  56 (a-z).
  57
  58 <li>The field name is immediately followed by ASCII 0x3D ('='); this
  59 equals sign is used to terminate the field name.
  60
  61 <li>0x3D is followed by 8 bit clean UTF-8 field contents to the end of
  62 the field.
  63 </ul>
  64
  65 <h3>Field names</h3>
  66
  67 Below is a proposed, minimal list of standard filed names with a
  68 description of intended use.  No single or group of field names is
  69 mandatory; a comment header may contain one, all or none of the names
  70 in this list.
  71 <dl>
  72 <dt>TITLE<dd>Track name
  73
  74 <dt>VERSION<dd>The version field may be used to differentiate multiple
  75 version of the same track title in a single collection. (e.g. remix info)
  76
  77 <dt>ALBUM<dd>The collection name to which this track belongs
  78
  79 <dt>TRACKNUMBER<dd>The track number of this piece if part of a specific larger collection or album
  80
  81 <dt>ARTIST<dd>Track performer
  82
  83 <dt>ORGANIZATION<dd>Name of the organization producing the track (i.e.
  84 the 'record label')
  85
  86 <dt>DESCRIPTION<dd>A short text description of the contents
  87
  88 <dt>GENRE<dd>A short text indication of music genre
  89
  90 <dt>DATE<dd>Date the track was recorded
  91
  92 <dt>LOCATION<dd>Location where track was recorded
  93
  94 <dt>COPYRIGHT<dd>Copyright information
  95 </dl>
  96
  97 <h3>Implications</h3>
  98 <ul>
  99 <li>
 100 Field names should not be 'internationalized'; this is a
 101 concession to simplicity not an attempt to exclude the majority of
 102 the world that doesn't speak English. Field *contents*, however,
 103 are represented in UTF-8 to allow easy representation of any language.
 104 <li>
 105 We have the length of the entirety of the field and restrictions on
 106 the field name so that the field name is bounded in a known way. Thus
 107 we also have the length of the field contents.
 108 <li>
 109 Individual 'vendors' may use non-standard field names within
 110 reason. The proper use of comment fields should be clear through
 111 context at this point.  Abuse will be discouraged.
 112 <li>
 113 There is no vendor-specific prefix to 'nonstandard' field names.
 114 Vendors should make some effort to avoid arbitrarily polluting the
 115 common namespace.
 116 <li>
 117 Field names are not required to be unique (occur once) within a
 118 comment header.  As an example, assume a track was recorded by three
 119 well know artists; the following is permissible, and encouraged:
 120 <pre>
 121               ARTIST=Dizzy Gillespie
 122               ARTIST=Sonny Rollins
 123               ARTIST=Sonny Stitt
 124 </pre>
 125
 126 </ul>
 127
 128 <h2>Encoding</h2>
 129
 130 The comment header comprises the entirety of the second bitstream
 131 header packet.  Unlike the first bitstream header packet, it is not
 132 generally the only packet on the second page and may not be restricted
 133 to within the second bitstream page.  The length of the comment header
 134 packet is [practically] unbounded.  The comment header packet is not
 135 optional; it must be present in the bitstream even if it is
 136 effectively empty.<p>
 137
 138 The comment header is encoded as follows (as per Ogg's standard
 139 bitstream mapping which renders least-significant-bit of the word to be
 140 coded into the least significant available bit of the current
 141 bitstream octet first):
 142
 143 <ol>
 144 <li>
 145 Vendor string length (32 bit unsigned quantity specifying number of octets)
 146
 147 <li>
 148 Vendor string ([vendor string length] octets coded from beginning of string to end of string, not null terminated)
 149
 150 <li>Number of comment fields (32 bit unsigned quantity specifying number of fields)
 151
 152 <li>Comment field 0 length (if [Number of comment fields]>0; 32 bit unsigned quantity specifying number of octets)
 153
 154 <li>
 155 Comment field 0 ([Comment field 0 length] octets coded from beginning of string to end of string, not null terminated)
 156
 157 <li>Comment field 1 length (if [Number of comment fields]>1...)...
 158 </ol>
 159
 160 This is actually somewhat easier to describe in code; implementation of the above can be found in vorbis/lib/info.c:_vorbis_pack_comment(),_vorbis_unpack_comment()
 161
 162 <hr>
 163 <a href="http://www.xiph.org/">
 164 <img src="white-xifish.png" align=left border=0>
 165 </a>
 166 <font size=-2 color=#505050>
 167
 168 Ogg is a <a href="http://www.xiph.org">Xiphophorus</a> effort to
 169 protect essential tenets of Internet multimedia from corporate
 170 hostage-taking; Open Source is the net's greatest tool to keep
 171 everyone honest. See <a href="http://www.xiph.org/about.html">About
 172 Xiphophorus</a> for details.
 173 <p>
 174
 175 Ogg Vorbis is the first Ogg audio CODEC.  Anyone may
 176 freely use and distribute the Ogg and Vorbis specification,
 177 whether in a private, public or corporate capacity.  However,
 178 Xiphophorus and the Ogg project (xiph.org) reserve the right to set
 179 the Ogg/Vorbis specification and certify specification compliance.<p>
 180
 181 Xiphophorus's Vorbis software CODEC implementation is distributed
 182 under the Lesser/Library GNU Public License.  This does not restrict
 183 third parties from distributing independent implementations of Vorbis
 184 software under other licenses.<p>
 185
 186 OggSquish, Vorbis, Xiphophorus and their logos are trademarks (tm) of
 187 <a href="http://www.xiph.org/">Xiphophorus</a>.  These pages are
 188 copyright (C) 1994-2000 Xiphophorus. All rights reserved.<p>
 189
 190 </body>
 191