From 8f3471999e929bb99116fac52b94d572c42ba15e Mon Sep 17 00:00:00 2001 From: Aki Date: Wed, 29 Sep 2021 22:52:15 +0200 Subject: Squashed 'ogg/' content from commit 4380566a4 git-subtree-dir: ogg git-subtree-split: 4380566a44b8d5e85ad511c9c17eb04197863ec5 --- doc/libogg/ogg_sync_state.html | 77 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 doc/libogg/ogg_sync_state.html (limited to 'doc/libogg/ogg_sync_state.html') 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 @@ + + + +libogg - datatype - ogg_sync_state + + + + + + + + + +

libogg documentation

libogg release 1.3.2 - 20140527

+ +

ogg_sync_state

+ +

declared in "ogg/ogg.h"

+ +

+The ogg_sync_state struct tracks the synchronization of the current page. +

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. +

+ + + + + +
+

+typedef struct {
+  unsigned char *data;
+  int storage;
+  int fill;
+  int returned;
+
+  int unsynced;
+  int headerbytes;
+  int bodybytes;
+} ogg_sync_state;
+
+
+ +

Relevant Struct Members

+
+
data
+
Pointer to buffered stream data.
+
storage
+
Current allocated size of the stream buffer held in *data.
+
fill
+
The number of valid bytes currently held in *data; functions as the buffer head pointer.
+
returned
+
The number of bytes at the head of *data that have already been returned as pages; functions as the buffer tail pointer.
+
unsynced
+
Synchronization state flag; nonzero if sync has not yet been attained or has been lost.
+
headerbytes
+
If synced, the number of bytes used by the synced page's header.
+
bodybytes
+
If synced, the number of bytes used by the synced page's body.
+
+ + +

+
+ + + + + + + + +

copyright © 2000-2014 Xiph.Org

Ogg Container Format

libogg documentation

libogg release 1.3.2 - 20140527

+ + + + -- cgit v1.1