Mercurial > hg > sv-dependency-builds

annotate src/libogg-1.3.0/doc/libogg/ogg_stream_state.html @ 86:98c1576536ae

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Bring in flac, ogg, vorbis
author Chris Cannam <cannam@all-day-breakfast.com>
date Tue, 19 Mar 2013 17:37:49 +0000
parents
children
rev   line source
cannam@86 1 <html>
cannam@86 2
cannam@86 3 <head>
cannam@86 4 <title>libogg - datatype - ogg_stream_state</title>
cannam@86 5 <link rel=stylesheet href="style.css" type="text/css">
cannam@86 6 </head>
cannam@86 7
cannam@86 8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
cannam@86 9 <table border=0 width=100%>
cannam@86 10 <tr>
cannam@86 11 <td><p class=tiny>libogg documentation</p></td>
cannam@86 12 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
cannam@86 13 </tr>
cannam@86 14 </table>
cannam@86 15
cannam@86 16 <h1>ogg_stream_state</h1>
cannam@86 17
cannam@86 18 <p><i>declared in "ogg/ogg.h"</i></p>
cannam@86 19
cannam@86 20 <p>
cannam@86 21 The ogg_stream_state struct tracks the current encode/decode state of the current logical bitstream.
cannam@86 22 <p>
cannam@86 23
cannam@86 24 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
cannam@86 25 <tr bgcolor=#cccccc>
cannam@86 26 <td>
cannam@86 27 <pre><b>
cannam@86 28 typedef struct {
cannam@86 29 unsigned char *body_data; /* bytes from packet bodies */
cannam@86 30 long body_storage; /* storage elements allocated */
cannam@86 31 long body_fill; /* elements stored; fill mark */
cannam@86 32 long body_returned; /* elements of fill returned */
cannam@86 33
cannam@86 34
cannam@86 35 int *lacing_vals; /* The values that will go to the segment table */
cannam@86 36 ogg_int64_t *granule_vals; /* granulepos values for headers. Not compact
cannam@86 37 this way, but it is simple coupled to the
cannam@86 38 lacing fifo */
cannam@86 39 long lacing_storage;
cannam@86 40 long lacing_fill;
cannam@86 41 long lacing_packet;
cannam@86 42 long lacing_returned;
cannam@86 43
cannam@86 44 unsigned char header[282]; /* working space for header encode */
cannam@86 45 int header_fill;
cannam@86 46
cannam@86 47 int e_o_s; /* set when we have buffered the last packet in the
cannam@86 48 logical bitstream */
cannam@86 49 int b_o_s; /* set after we've written the initial page
cannam@86 50 of a logical bitstream */
cannam@86 51 long serialno;
cannam@86 52 int pageno;
cannam@86 53 ogg_int64_t packetno; /* sequence number for decode; the framing
cannam@86 54 knows where there's a hole in the data,
cannam@86 55 but we need coupling so that the codec
cannam@86 56 (which is in a seperate abstraction
cannam@86 57 layer) also knows about the gap */
cannam@86 58 ogg_int64_t granulepos;
cannam@86 59
cannam@86 60 } ogg_stream_state;
cannam@86 61 </b></pre>
cannam@86 62 </td>
cannam@86 63 </tr>
cannam@86 64 </table>
cannam@86 65
cannam@86 66 <h3>Relevant Struct Members</h3>
cannam@86 67 <dl>
cannam@86 68 <dt><i>body_data</i></dt>
cannam@86 69 <dd>Pointer to data from packet bodies.</dd>
cannam@86 70 <dt><i>body_storage</i></dt>
cannam@86 71 <dd>Storage allocated for bodies in bytes (filled or unfilled).</dd>
cannam@86 72 <dt><i>body_fill</i></dt>
cannam@86 73 <dd>Amount of storage filled with stored packet bodies.</dd>
cannam@86 74 <dt><i>body_returned</i></dt>
cannam@86 75 <dd>Number of elements returned from storage.</dd>
cannam@86 76 <dt><i>lacing_vals</i></dt>
cannam@86 77 <dd>String of lacing values for the packet segments within the current page. Each value is a byte, indicating packet segment length.</dd>
cannam@86 78 <dt><i>granule_vals</i></dt>
cannam@86 79 <dd>Pointer to the lacing values for the packet segments within the current page.</dd>
cannam@86 80 <dt><i>lacing_storage</i></dt>
cannam@86 81 <dd>Total amount of storage (in bytes) allocated for storing lacing values.</dd>
cannam@86 82 <dt><i>lacing_fill</i></dt>
cannam@86 83 <dd>Fill marker for the current vs. total allocated storage of lacing values for the page.</dd>
cannam@86 84 <dt><i>lacing_packet</i></dt>
cannam@86 85 <dd>Lacing value for current packet segment.</dd>
cannam@86 86 <dt><i>lacing_returned</i></dt>
cannam@86 87 <dd>Number of lacing values returned from lacing_storage.</dd>
cannam@86 88 <dt><i>header</i></dt>
cannam@86 89 <dd>Temporary storage for page header during encode process, while the header is being created.</dd>
cannam@86 90 <dt><i>header_fill</i></dt>
cannam@86 91 <dd>Fill marker for header storage allocation. Used during the header creation process.</dd>
cannam@86 92 <dt><i>e_o_s</i></dt>
cannam@86 93 <dd>Marker set when the last packet of the logical bitstream has been buffered.</dd>
cannam@86 94 <dt><i>b_o_s</i></dt>
cannam@86 95 <dd>Marker set after we have written the first page in the logical bitstream.</dd>
cannam@86 96 <dt><i>serialno</i></dt>
cannam@86 97 <dd>Serial number of this logical bitstream.</dd>
cannam@86 98 <dt><i>pageno</i></dt>
cannam@86 99 <dd>Number of the current page within the stream.</dd>
cannam@86 100 <dt><i>packetno</i></dt>
cannam@86 101 <dd>Number of the current packet.</dd>
cannam@86 102 <dt><i>granulepos</i></dt>
cannam@86 103 <dd>Exact position of decoding/encoding process.</dd>
cannam@86 104 </dl>
cannam@86 105
cannam@86 106
cannam@86 107 <br><br>
cannam@86 108 <hr noshade>
cannam@86 109 <table border=0 width=100%>
cannam@86 110 <tr valign=top>
cannam@86 111 <td><p class=tiny>copyright &copy; 2000-2011 Xiph.Org</p></td>
cannam@86 112 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
cannam@86 113 </tr><tr>
cannam@86 114 <td><p class=tiny>libogg documentation</p></td>
cannam@86 115 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
cannam@86 116 </tr>
cannam@86 117 </table>
cannam@86 118
cannam@86 119 </body>
cannam@86 120
cannam@86 121 </html>