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