cannam@86: cannam@86: cannam@86: cannam@86: libogg - datatype - ogg_sync_state cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:

libogg documentation

libogg release 1.3.0 - 20110804

cannam@86: cannam@86:

ogg_sync_state

cannam@86: cannam@86:

declared in "ogg/ogg.h"

cannam@86: cannam@86:

cannam@86: The ogg_sync_state struct tracks the synchronization of the current page. cannam@86:

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. cannam@86:

cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:
cannam@86:

cannam@86: typedef struct {
cannam@86:   unsigned char *data;
cannam@86:   int storage;
cannam@86:   int fill;
cannam@86:   int returned;
cannam@86: 
cannam@86:   int unsynced;
cannam@86:   int headerbytes;
cannam@86:   int bodybytes;
cannam@86: } ogg_sync_state;
cannam@86: 
cannam@86:
cannam@86: cannam@86:

Relevant Struct Members

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

cannam@86:
cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:

copyright © 2000-2011 Xiph.Org

Ogg Container Format

libogg documentation

libogg release 1.3.0 - 20110804

cannam@86: cannam@86: cannam@86: cannam@86: