libogg-1.0/doc/ogg/ogg_packet.html

   1 <html>
   2
   3 <head>
   4 <title>libogg - datatype - ogg_packet</title>
   5 <link rel=stylesheet href="style.css" type="text/css">
   6 </head>
   7
   8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
   9 <table border=0 width=100%>
  10 <tr>
  11 <td><p class=tiny>libogg documentation</p></td>
  12 <td align=right><p class=tiny>libogg - 20011015</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>ogg_packet</h1>
  17
  18 <p><i>declared in "ogg/ogg.h"</i></p>
  19
  20 <p>
  21 The ogg_packet struct encapsulates the data for a single raw packet of data
  22 and is used to transfer data between the ogg framing layer and the handling codec.
  23 <p>
  24
  25 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
  26 <tr bgcolor=#cccccc>
  27         <td>
  28 <pre><b>
  29 typedef struct {
  30   unsigned char *packet;
  31   long  bytes;
  32   long  b_o_s;
  33   long  e_o_s;
  34
  35   ogg_int64_t  granulepos;
  36   ogg_int64_t  packetno;
  37
  38 } ogg_packet;
  39 </b></pre>
  40         </td>
  41 </tr>
  42 </table>
  43
  44 <h3>Relevant Struct Members</h3>
  45 <dl>
  46 <dt><i>packet</i></dt>
  47 <dd>Pointer to the packet's data. This is treated as an opaque type by the ogg layer.</dd>
  48 <dt><i>bytes</i></dt>
  49 <dd>Indicates the size of the packet data in bytes.  Packets can be of arbitrary size.</dd>
  50 <dt><i>b_o_s</i></dt>
  51 <dd>Flag indicating whether this packet begins a logical bitstream.  <tt>1</tt> indicates this is the first packet, <tt>0</tt> indicates any other position in the stream.</dd>
  52 <dt><i>e_o_s</i></dt>
  53 <dd>Flag indicating whether this packet ends a bitstream.  <tt>1</tt> indicates the last packet, <tt>0</tt> indicates any other position in the stream.</dd>
  54 <dt><i>granulepos</i></dt>
  55 <dd>A number indicating the position of this packet in the decoded data. This is the last sample, frame or other unit of information ('granule') that can be completely decoded from this packet.</dd>
  56 <dt><i>packetno</i></dt>
  57 <dd>Sequential number of this packet in the ogg bitstream.<dd>
  58 </dl>
  59
  60
  61 <br><br>
  62 <hr noshade>
  63 <table border=0 width=100%>
  64 <tr valign=top>
  65 <td><p class=tiny>copyright &copy; 2001 xiph.org foundation</p></td>
  66 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td>
  67 </tr><tr>
  68 <td><p class=tiny>libogg documentation</p></td>
  69 <td align=right><p class=tiny>libogg - 20011015</p></td>
  70 </tr>
  71 </table>
  72
  73 </body>
  74
  75 </html>