Example Applications: examples/sfexamples/oggvorbiscodec/src/libogg/doc/ogg/ogg_stream

00001 <html>
00002 
00003 <head>
00004 <title>libogg - datatype - ogg_stream_state</title>
00005 <link rel=stylesheet href="style.css" type="text/css">
00006 </head>
00007 
00008 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
00009 <table border=0 width=100%>
00010 <tr>
00011 <td><p class=tiny>libogg documentation</p></td>
00012 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
00013 </tr>
00014 </table>
00015 
00016 <h1>ogg_stream_state</h1>
00017 
00018 <p><i>declared in "ogg/ogg.h"</i></p>
00019 
00020 <p>
00021 The ogg_stream_state struct tracks the current encode/decode state of the current logical bitstream.
00022 <p>
00023 
00024 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
00025 <tr bgcolor=#cccccc>
00026         <td>
00027 <pre><b>
00028 typedef struct {
00029   unsigned char   *body_data;    /* bytes from packet bodies */
00030   long    body_storage;          /* storage elements allocated */
00031   long    body_fill;             /* elements stored; fill mark */
00032   long    body_returned;         /* elements of fill returned */
00033 
00034 
00035   int     *lacing_vals;    /* The values that will go to the segment table */
00036   ogg_int64_t *granule_vals;      /* granulepos values for headers. Not compact
00037                              this way, but it is simple coupled to the
00038                              lacing fifo */
00039   long    lacing_storage;
00040   long    lacing_fill;
00041   long    lacing_packet;
00042   long    lacing_returned;
00043 
00044   unsigned char    header[282];      /* working space for header encode */
00045   int              header_fill;
00046 
00047   int     e_o_s;          /* set when we have buffered the last packet in the
00048                              logical bitstream */
00049   int     b_o_s;          /* set after we've written the initial page
00050                              of a logical bitstream */
00051   long     serialno;
00052   int      pageno;
00053   ogg_int64_t  packetno;      /* sequence number for decode; the framing
00054                              knows where there's a hole in the data,
00055                              but we need coupling so that the codec
00056                              (which is in a seperate abstraction
00057                              layer) also knows about the gap */
00058   ogg_int64_t   granulepos;
00059 
00060 } ogg_stream_state;
00061 </b></pre>
00062         </td>
00063 </tr>
00064 </table>
00065 
00066 <h3>Relevant Struct Members</h3>
00067 <dl>
00068 <dt><i>body_data</i></dt>
00069 <dd>Pointer to data from packet bodies.</dd>
00070 <dt><i>body_storage</i></dt>
00071 <dd>Storage allocated for bodies in bytes (filled or unfilled).</dd>
00072 <dt><i>body_fill</i></dt>
00073 <dd>Amount of storage filled with stored packet bodies.</dd>
00074 <dt><i>body_returned</i></dt>
00075 <dd>Number of elements returned from storage.</dd>
00076 <dt><i>lacing_vals</i></dt>
00077 <dd>String of lacing values for the packet segments within the current page.  Each value is a byte, indicating packet segment length.</dd>
00078 <dt><i>granule_vals</i></dt>
00079 <dd>Pointer to the lacing values for the packet segments within the current page.</dd>
00080 <dt><i>lacing_storage</i></dt>
00081 <dd>Total amount of storage (in bytes) allocated for storing lacing values.</dd>
00082 <dt><i>lacing_fill</i></dt>
00083 <dd>Fill marker for the current vs. total allocated storage of lacing values for the page.</dd>
00084 <dt><i>lacing_packet</i></dt>
00085 <dd>Lacing value for current packet segment.</dd>
00086 <dt><i>lacing_returned</i></dt>
00087 <dd>Number of lacing values returned from lacing_storage.</dd>
00088 <dt><i>header</i></dt>
00089 <dd>Temporary storage for page header during encode process, while the header is being created.</dd>
00090 <dt><i>header_fill</i></dt>
00091 <dd>Fill marker for header storage allocation.  Used during the header creation process.</dd>
00092 <dt><i>e_o_s</i></dt>
00093 <dd>Marker set when the last packet of the logical bitstream has been buffered.</dd>
00094 <dt><i>b_o_s</i></dt>
00095 <dd>Marker set after we have written the first page in the logical bitstream.</dd>
00096 <dt><i>serialno</i></dt>
00097 <dd>Serial number of this logical bitstream.</dd>
00098 <dt><i>pageno</i></dt>
00099 <dd>Number of the current page within the stream.</dd>
00100 <dt><i>packetno</i></dt>
00101 <dd>Number of the current packet.</dd>
00102 <dt><i>granulepos</i></dt>
00103 <dd>Exact position of decoding/encoding process.</dd>
00104 </dl>
00105 
00106 
00107 <br><br>
00108 <hr noshade>
00109 <table border=0 width=100%>
00110 <tr valign=top>
00111 <td><p class=tiny>copyright &copy; 2000 xiph.org</p></td>
00112 <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>
00113 </tr><tr>
00114 <td><p class=tiny>libogg documentation</p></td>
00115 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
00116 </tr>
00117 </table>
00118 
00119 </body>
00120 
00121 </html>
examples/sfexamples/oggvorbiscodec/src/libogg/doc/ogg/ogg_stream_state.html
