diff options
| author | Aki <please@ignore.pl> | 2021-09-29 22:52:15 +0200 |
|---|---|---|
| committer | Aki <please@ignore.pl> | 2021-09-29 22:52:15 +0200 |
| commit | 8f3471999e929bb99116fac52b94d572c42ba15e (patch) | |
| tree | 44b482bc682cd6f58d9263af7ed88c03f400fb15 /doc/libogg/ogg_sync_state.html | |
| download | starshatter-8f3471999e929bb99116fac52b94d572c42ba15e.zip starshatter-8f3471999e929bb99116fac52b94d572c42ba15e.tar.gz starshatter-8f3471999e929bb99116fac52b94d572c42ba15e.tar.bz2 | |
Squashed 'ogg/' content from commit 4380566a4
git-subtree-dir: ogg
git-subtree-split: 4380566a44b8d5e85ad511c9c17eb04197863ec5
Diffstat (limited to 'doc/libogg/ogg_sync_state.html')
| -rw-r--r-- | doc/libogg/ogg_sync_state.html | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/doc/libogg/ogg_sync_state.html b/doc/libogg/ogg_sync_state.html new file mode 100644 index 0000000..78f8388 --- /dev/null +++ b/doc/libogg/ogg_sync_state.html @@ -0,0 +1,77 @@ +<html> + +<head> +<title>libogg - datatype - ogg_sync_state</title> +<link rel=stylesheet href="style.css" type="text/css"> +</head> + +<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> +<table border=0 width=100%> +<tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.3.2 - 20140527</p></td> +</tr> +</table> + +<h1>ogg_sync_state</h1> + +<p><i>declared in "ogg/ogg.h"</i></p> + +<p> +The ogg_sync_state struct tracks the synchronization of the current page. +<p>It is used during decoding to track the status of data as it is read in, synchronized, verified, and parsed into pages belonging to the various logical bistreams in the current physical bitstream link. +<p> + +<table border=0 width=100% color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +typedef struct { + unsigned char *data; + int storage; + int fill; + int returned; + + int unsynced; + int headerbytes; + int bodybytes; +} ogg_sync_state; +</b></pre> + </td> +</tr> +</table> + +<h3>Relevant Struct Members</h3> +<dl> +<dt><i>data</i></dt> +<dd>Pointer to buffered stream data.</dd> +<dt><i>storage</i></dt> +<dd>Current allocated size of the stream buffer held in <tt>*data</tt>.</dd> +<dt><i>fill</i></dt> +<dd>The number of valid bytes currently held in <tt>*data</tt>; functions as the buffer head pointer.</dd> +<dt><i>returned</i></dt> +<dd>The number of bytes at the head of <tt>*data</tt> that have already been returned as pages; functions as the buffer tail pointer.</dd> +<dt><i>unsynced</i></dt> +<dd>Synchronization state flag; nonzero if sync has not yet been attained or has been lost.</dd> +<dt><i>headerbytes</i></dt> +<dd>If synced, the number of bytes used by the synced page's header.</dd> +<dt><i>bodybytes</i></dt> +<dd>If synced, the number of bytes used by the synced page's body.</dd> +</dl> + + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000-2014 Xiph.Org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.3.2 - 20140527</p></td> +</tr> +</table> + +</body> + +</html> |