doc/framing.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   2 <html>
   3 <head>
   4
   5 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-15"/>
   6 <title>Ogg Vorbis Documentation</title>
   7
   8 <style type="text/css">
   9 body {
  10   margin: 0 18px 0 18px;
  11   padding-bottom: 30px;
  12   font-family: Verdana, Arial, Helvetica, sans-serif;
  13   color: #333333;
  14   font-size: .8em;
  15 }
  16
  17 a {
  18   color: #3366cc;
  19 }
  20
  21 img {
  22   border: 0;
  23 }
  24
  25 #xiphlogo {
  26   margin: 30px 0 16px 0;
  27 }
  28
  29 #content p {
  30   line-height: 1.4;
  31 }
  32
  33 h1, h1 a, h2, h2 a, h3, h3 a {
  34   font-weight: bold;
  35   color: #ff9900;
  36   margin: 1.3em 0 8px 0;
  37 }
  38
  39 h1 {
  40   font-size: 1.3em;
  41 }
  42
  43 h2 {
  44   font-size: 1.2em;
  45 }
  46
  47 h3 {
  48   font-size: 1.1em;
  49 }
  50
  51 li {
  52   line-height: 1.4;
  53 }
  54
  55 #copyright {
  56   margin-top: 30px;
  57   line-height: 1.5em;
  58   text-align: center;
  59   font-size: .8em;
  60   color: #888888;
  61   clear: both;
  62 }
  63 </style>
  64
  65 </head>
  66
  67 <body>
  68
  69 <div id="xiphlogo">
  70   <a href="http://www.xiph.org/"><img src="fish_xiph_org.png" alt="Fish Logo and Xiph.org"/></a>
  71 </div>
  72
  73 <h1>Ogg logical bitstream framing</h1>
  74
  75 <h2>Ogg bitstreams</h2>
  76
  77 <p>The Ogg transport bitstream is designed to provide framing, error
  78 protection and seeking structure for higher-level codec streams that
  79 consist of raw, unencapsulated data packets, such as the Vorbis audio
  80 codec or Tarkin video codec.</p>
  81
  82 <h2>Application example: Vorbis</h2>
  83
  84 <p>Vorbis encodes short-time blocks of PCM data into raw packets of
  85 bit-packed data. These raw packets may be used directly by transport
  86 mechanisms that provide their own framing and packet-separation
  87 mechanisms (such as UDP datagrams). For stream based storage (such as
  88 files) and transport (such as TCP streams or pipes), Vorbis uses the
  89 Ogg bitstream format to provide framing/sync, sync recapture
  90 after error, landmarks during seeking, and enough information to
  91 properly separate data back into packets at the original packet
  92 boundaries without relying on decoding to find packet boundaries.</p>
  93
  94 <h2>Design constraints for Ogg bitstreams</h2>
  95
  96 <ol>
  97 <li>True streaming; we must not need to seek to build a 100%
  98   complete bitstream.</li>
  99 <li>Use no more than approximately 1-2% of bitstream bandwidth for
 100   packet boundary marking, high-level framing, sync and seeking.</li>
 101 <li>Specification of absolute position within the original sample
 102   stream.</li>
 103 <li>Simple mechanism to ease limited editing, such as a simplified
 104   concatenation mechanism.</li>
 105 <li>Detection of corruption, recapture after error and direct, random
 106   access to data at arbitrary positions in the bitstream.</li>
 107 </ol>
 108
 109 <h2>Logical and Physical Bitstreams</h2>
 110
 111 <p>A <em>logical</em> Ogg bitstream is a contiguous stream of
 112 sequential pages belonging only to the logical bitstream. A
 113 <em>physical</em> Ogg bitstream is constructed from one or more
 114 than one logical Ogg bitstream (the simplest physical bitstream
 115 is simply a single logical bitstream). We describe below the exact
 116 formatting of an Ogg logical bitstream. Combining logical
 117 bitstreams into more complex physical bitstreams is described in the
 118 <a href="oggstream.html">Ogg bitstream overview</a>. The exact
 119 mapping of raw Vorbis packets into a valid Ogg Vorbis physical
 120 bitstream is described in <a href="vorbis-stream.html">Vorbis
 121 bitstream mapping</a>.</p>
 122
 123 <h2>Bitstream structure</h2>
 124
 125 <p>An Ogg stream is structured by dividing incoming packets into
 126 segments of up to 255 bytes and then wrapping a group of contiguous
 127 packet segments into a variable length page preceded by a page
 128 header. Both the header size and page size are variable; the page
 129 header contains sizing information and checksum data to determine
 130 header/page size and data integrity.</p>
 131
 132 <p>The bitstream is captured (or recaptured) by looking for the beginning
 133 of a page, specifically the capture pattern. Once the capture pattern
 134 is found, the decoder verifies page sync and integrity by computing
 135 and comparing the checksum. At that point, the decoder can extract the
 136 packets themselves.</p>
 137
 138 <h3>Packet segmentation</h3>
 139
 140 <p>Packets are logically divided into multiple segments before encoding
 141 into a page. Note that the segmentation and fragmentation process is a
 142 logical one; it's used to compute page header values and the original
 143 page data need not be disturbed, even when a packet spans page
 144 boundaries.</p>
 145
 146 <p>The raw packet is logically divided into [n] 255 byte segments and a
 147 last fractional segment of &lt; 255 bytes. A packet size may well
 148 consist only of the trailing fractional segment, and a fractional
 149 segment may be zero length. These values, called "lacing values" are
 150 then saved and placed into the header segment table.</p>
 151
 152 <p>An example should make the basic concept clear:</p>
 153
 154 <pre>
 155 <tt>
 156 raw packet:
 157   ___________________________________________
 158  |______________packet data__________________| 753 bytes
 159
 160 lacing values for page header segment table: 255,255,243
 161 </tt>
 162 </pre>
 163
 164 <p>We simply add the lacing values for the total size; the last lacing
 165 value for a packet is always the value that is less than 255. Note
 166 that this encoding both avoids imposing a maximum packet size as well
 167 as imposing minimum overhead on small packets (as opposed to, eg,
 168 simply using two bytes at the head of every packet and having a max
 169 packet size of 32k. Small packets (&lt;255, the typical case) are
 170 penalized with twice the segmentation overhead). Using the lacing
 171 values as suggested, small packets see the minimum possible
 172 byte-aligned overheade (1 byte) and large packets, over 512 bytes or
 173 so, see a fairly constant ~.5% overhead on encoding space.</p>
 174
 175 <p>Note that a lacing value of 255 implies that a second lacing value
 176 follows in the packet, and a value of &lt; 255 marks the end of the
 177 packet after that many additional bytes. A packet of 255 bytes (or a
 178 multiple of 255 bytes) is terminated by a lacing value of 0:</p>
 179
 180 <pre><tt>
 181 raw packet:
 182   _______________________________
 183  |________packet data____________|          255 bytes
 184
 185 lacing values: 255, 0
 186 </tt></pre>
 187
 188 <p>Note also that a 'nil' (zero length) packet is not an error; it
 189 consists of nothing more than a lacing value of zero in the header.</p>
 190
 191 <h3>Packets spanning pages</h3>
 192
 193 <p>Packets are not restricted to beginning and ending within a page,
 194 although individual segments are, by definition, required to do so.
 195 Packets are not restricted to a maximum size, although excessively
 196 large packets in the data stream are discouraged; the Ogg
 197 bitstream specification strongly recommends nominal page size of
 198 approximately 4-8kB (large packets are foreseen as being useful for
 199 initialization data at the beginning of a logical bitstream).</p>
 200
 201 <p>After segmenting a packet, the encoder may decide not to place all the
 202 resulting segments into the current page; to do so, the encoder places
 203 the lacing values of the segments it wishes to belong to the current
 204 page into the current segment table, then finishes the page. The next
 205 page is begun with the first value in the segment table belonging to
 206 the next packet segment, thus continuing the packet (data in the
 207 packet body must also correspond properly to the lacing values in the
 208 spanned pages. The segment data in the first packet corresponding to
 209 the lacing values of the first page belong in that page; packet
 210 segments listed in the segment table of the following page must begin
 211 the page body of the subsequent page).</p>
 212
 213 <p>The last mechanic to spanning a page boundary is to set the header
 214 flag in the new page to indicate that the first lacing value in the
 215 segment table continues rather than begins a packet; a header flag of
 216 0x01 is set to indicate a continued packet. Although mandatory, it
 217 is not actually algorithmically necessary; one could inspect the
 218 preceding segment table to determine if the packet is new or
 219 continued. Adding the information to the packet_header flag allows a
 220 simpler design (with no overhead) that needs only inspect the current
 221 page header after frame capture. This also allows faster error
 222 recovery in the event that the packet originates in a corrupt
 223 preceding page, implying that the previous page's segment table
 224 cannot be trusted.</p>
 225
 226 <p>Note that a packet can span an arbitrary number of pages; the above
 227 spanning process is repeated for each spanned page boundary. Also a
 228 'zero termination' on a packet size that is an even multiple of 255
 229 must appear even if the lacing value appears in the next page as a
 230 zero-length continuation of the current packet. The header flag
 231 should be set to 0x01 to indicate that the packet spanned, even though
 232 the span is a nil case as far as data is concerned.</p>
 233
 234 <p>The encoding looks odd, but is properly optimized for speed and the
 235 expected case of the majority of packets being between 50 and 200
 236 bytes (note that it is designed such that packets of wildly different
 237 sizes can be handled within the model; placing packet size
 238 restrictions on the encoder would have only slightly simplified design
 239 in page generation and increased overall encoder complexity).</p>
 240
 241 <p>The main point behind tracking individual packets (and packet
 242 segments) is to allow more flexible encoding tricks that requiring
 243 explicit knowledge of packet size. An example is simple bandwidth
 244 limiting, implemented by simply truncating packets in the nominal case
 245 if the packet is arranged so that the least sensitive portion of the
 246 data comes last.</p>
 247
 248 <h3>Page header</h3>
 249
 250 <p>The headering mechanism is designed to avoid copying and re-assembly
 251 of the packet data (ie, making the packet segmentation process a
 252 logical one); the header can be generated directly from incoming
 253 packet data. The encoder buffers packet data until it finishes a
 254 complete page at which point it writes the header followed by the
 255 buffered packet segments.</p>
 256
 257 <h4>capture_pattern</h4>
 258
 259 <p>A header begins with a capture pattern that simplifies identifying
 260 pages; once the decoder has found the capture pattern it can do a more
 261 intensive job of verifying that it has in fact found a page boundary
 262 (as opposed to an inadvertent coincidence in the byte stream).</p>
 263
 264 <pre><tt>
 265  byte value
 266
 267   0  0x4f 'O'
 268   1  0x67 'g'
 269   2  0x67 'g'
 270   3  0x53 'S'
 271 </tt></pre>
 272
 273 <h4>stream_structure_version</h4>
 274
 275 <p>The capture pattern is followed by the stream structure revision:</p>
 276
 277 <pre><tt>
 278  byte value
 279
 280   4  0x00
 281 </tt></pre>
 282
 283 <h4>header_type_flag</h4>
 284
 285 <p>The header type flag identifies this page's context in the bitstream:</p>
 286
 287 <pre><tt>
 288  byte value
 289
 290   5  bitflags: 0x01: unset = fresh packet
 291                        set = continued packet
 292                0x02: unset = not first page of logical bitstream
 293                        set = first page of logical bitstream (bos)
 294                0x04: unset = not last page of logical bitstream
 295                        set = last page of logical bitstream (eos)
 296 </tt></pre>
 297
 298 <h4>absolute granule position</h4>
 299
 300 <p>(This is packed in the same way the rest of Ogg data is packed; LSb
 301 of LSB first. Note that the 'position' data specifies a 'sample'
 302 number (eg, in a CD quality sample is four octets, 16 bits for left
 303 and 16 bits for right; in video it would likely be the frame number.
 304 It is up to the specific codec in use to define the semantic meaning
 305 of the granule position value). The position specified is the total
 306 samples encoded after including all packets finished on this page
 307 (packets begun on this page but continuing on to the next page do not
 308 count). The rationale here is that the position specified in the
 309 frame header of the last page tells how long the data coded by the
 310 bitstream is. A truncated stream will still return the proper number
 311 of samples that can be decoded fully.</p>
 312
 313 <p>A special value of '-1' (in two's complement) indicates that no packets
 314 finish on this page.</p>
 315
 316 <pre><tt>
 317  byte value
 318
 319   6  0xXX LSB
 320   7  0xXX
 321   8  0xXX
 322   9  0xXX
 323  10  0xXX
 324  11  0xXX
 325  12  0xXX
 326  13  0xXX MSB
 327 </tt></pre>
 328
 329 <h4>stream serial number</h4>
 330
 331 <p>Ogg allows for separate logical bitstreams to be mixed at page
 332 granularity in a physical bitstream. The most common case would be
 333 sequential arrangement, but it is possible to interleave pages for
 334 two separate bitstreams to be decoded concurrently. The serial
 335 number is the means by which pages physical pages are associated with
 336 a particular logical stream. Each logical stream must have a unique
 337 serial number within a physical stream:</p>
 338
 339 <pre><tt>
 340  byte value
 341
 342  14  0xXX LSB
 343  15  0xXX
 344  16  0xXX
 345  17  0xXX MSB
 346 </tt></pre>
 347
 348 <h4>page sequence no</h4>
 349
 350 <p>Page counter; lets us know if a page is lost (useful where packets
 351 span page boundaries).</p>
 352
 353 <pre><tt>
 354  byte value
 355
 356  18  0xXX LSB
 357  19  0xXX
 358  20  0xXX
 359  21  0xXX MSB
 360 </tt></pre>
 361
 362 <h4>page checksum</h4>
 363
 364 <p>32 bit CRC value (direct algorithm, initial val and final XOR = 0,
 365 generator polynomial=0x04c11db7). The value is computed over the
 366 entire header (with the CRC field in the header set to zero) and then
 367 continued over the page. The CRC field is then filled with the
 368 computed value.</p>
 369
 370 <p>(A thorough discussion of CRC algorithms can be found in <a
 371 href="ftp://ftp.rocksoft.com/papers/crc_v3.txt">"A
 372 Painless Guide to CRC Error Detection Algorithms"</a> by Ross
 373 Williams <a
 374 href="mailto:ross@guest.adelaide.edu.au">ross@guest.adelaide.edu.au</a>.)</p>
 375
 376 <pre><tt>
 377  byte value
 378
 379  22  0xXX LSB
 380  23  0xXX
 381  24  0xXX
 382  25  0xXX MSB
 383 </tt></pre>
 384
 385 <h4>page_segments</h4>
 386
 387 <p>The number of segment entries to appear in the segment table. The
 388 maximum number of 255 segments (255 bytes each) sets the maximum
 389 possible physical page size at 65307 bytes or just under 64kB (thus
 390 we know that a header corrupted so as destroy sizing/alignment
 391 information will not cause a runaway bitstream. We'll read in the
 392 page according to the corrupted size information that's guaranteed to
 393 be a reasonable size regardless, notice the checksum mismatch, drop
 394 sync and then look for recapture).</p>
 395
 396 <pre><tt>
 397  byte value
 398
 399  26 0x00-0xff (0-255)
 400 </tt></pre>
 401
 402 <h4>segment_table (containing packet lacing values)</h4>
 403
 404 <p>The lacing values for each packet segment physically appearing in
 405 this page are listed in contiguous order.</p>
 406
 407 <pre><tt>
 408  byte value
 409
 410  27 0x00-0xff (0-255)
 411  [...]
 412  n  0x00-0xff (0-255, n=page_segments+26)
 413 </tt></pre>
 414
 415 <p>Total page size is calculated directly from the known header size and
 416 lacing values in the segment table. Packet data segments follow
 417 immediately after the header.</p>
 418
 419 <p>Page headers typically impose a flat .25-.5% space overhead assuming
 420 nominal ~8k page sizes. The segmentation table needed for exact
 421 packet recovery in the streaming layer adds approximately .5-1%
 422 nominal assuming expected encoder behavior in the 44.1kHz, 128kbps
 423 stereo encodings.</p>
 424
 425 <div id="copyright">
 426   The Xiph Fish Logo is a
 427   trademark (&trade;) of Xiph.Org.<br/>
 428
 429   These pages &copy; 1994 - 2005 Xiph.Org. All rights reserved.
 430 </div>
 431
 432 </body>
 433 </html>