blob: e33dd65924e6d97c24b7e98170e35e00461dec9e [file] [log] [blame]
<title>libogg - datatype - ogg_stream_state</title>
<link rel=stylesheet href="style.css" type="text/css">
<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
<table border=0 width=100%>
<td><p class=tiny>libogg documentation</p></td>
<td align=right><p class=tiny>libogg release 1.3.3 - 20171107</p></td>
<p><i>declared in "ogg/ogg.h"</i></p>
The ogg_stream_state struct tracks the current encode/decode state of the current logical bitstream.
<table border=0 width=100% color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
typedef struct {
unsigned char *body_data; /* bytes from packet bodies */
long body_storage; /* storage elements allocated */
long body_fill; /* elements stored; fill mark */
long body_returned; /* elements of fill returned */
int *lacing_vals; /* The values that will go to the segment table */
ogg_int64_t *granule_vals; /* granulepos values for headers. Not compact
this way, but it is simple coupled to the
lacing fifo */
long lacing_storage;
long lacing_fill;
long lacing_packet;
long lacing_returned;
unsigned char header[282]; /* working space for header encode */
int header_fill;
int e_o_s; /* set when we have buffered the last packet in the
logical bitstream */
int b_o_s; /* set after we've written the initial page
of a logical bitstream */
long serialno;
int pageno;
ogg_int64_t packetno; /* sequence number for decode; the framing
knows where there's a hole in the data,
but we need coupling so that the codec
(which is in a seperate abstraction
layer) also knows about the gap */
ogg_int64_t granulepos;
} ogg_stream_state;
<h3>Relevant Struct Members</h3>
<dd>Pointer to data from packet bodies.</dd>
<dd>Storage allocated for bodies in bytes (filled or unfilled).</dd>
<dd>Amount of storage filled with stored packet bodies.</dd>
<dd>Number of elements returned from storage.</dd>
<dd>String of lacing values for the packet segments within the current page. Each value is a byte, indicating packet segment length.</dd>
<dd>Pointer to the lacing values for the packet segments within the current page.</dd>
<dd>Total amount of storage (in bytes) allocated for storing lacing values.</dd>
<dd>Fill marker for the current vs. total allocated storage of lacing values for the page.</dd>
<dd>Lacing value for current packet segment.</dd>
<dd>Number of lacing values returned from lacing_storage.</dd>
<dd>Temporary storage for page header during encode process, while the header is being created.</dd>
<dd>Fill marker for header storage allocation. Used during the header creation process.</dd>
<dd>Marker set when the last packet of the logical bitstream has been buffered.</dd>
<dd>Marker set after we have written the first page in the logical bitstream.</dd>
<dd>Serial number of this logical bitstream.</dd>
<dd>Number of the current page within the stream.</dd>
<dd>Number of the current packet.</dd>
<dd>Exact position of decoding/encoding process.</dd>
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
<td><p class=tiny>copyright &copy; 2000-2017 Xiph.Org Foundation</p></td>
<td align=right><p class=tiny><a href="">Ogg Container Format</a></p></td>
<td><p class=tiny>libogg documentation</p></td>
<td align=right><p class=tiny>libogg release 1.3.3 - 20171107</p></td>