diff options
| author | claude-bot <[email protected]> | 2026-07-13 12:40:00 +0000 |
|---|---|---|
| committer | claude-bot <[email protected]> | 2026-07-13 12:40:00 +0000 |
| commit | 740291cf2ae7f360b4ab119746da9ac2ef6611e4 (patch) | |
| tree | 2fd7c57651516fbef1d0716e3276c24b8f71ed52 /doc/libogg/ogg_page.html | |
| download | ogg-master.tar.gz ogg-master.zip | |
Snapshot for re3/reVC vendoring, per @lzcnt.
Source: https://github.com/xiph/ogg (36f969bb37559345ee03796ed625a9abd42c6db9).
Diffstat (limited to 'doc/libogg/ogg_page.html')
| -rw-r--r-- | doc/libogg/ogg_page.html | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/doc/libogg/ogg_page.html b/doc/libogg/ogg_page.html new file mode 100644 index 0000000..1a47bd3 --- /dev/null +++ b/doc/libogg/ogg_page.html @@ -0,0 +1,75 @@ +<html> + +<head> +<title>libogg - datatype - ogg_page</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.4 - 20190830</p></td> +</tr> +</table> + +<h1>ogg_page</h1> + +<p><i>declared in "ogg/ogg.h"</i></p> + +<p> +The ogg_page struct encapsulates the data for an Ogg page. +<p> +Ogg pages are the fundamental unit of framing and interleave in an ogg bitstream. +They are made up of packet segments of 255 bytes each. There can be as many as +255 packet segments per page, for a maximum page size of a little under 64 kB. +This is not a practical limitation as the segments can be joined across +page boundaries allowing packets of arbitrary size. In practice many +applications will not completely fill all pages because they flush the +accumulated packets periodically order to bound latency more tightly. +<p> +<p>For a complete description of ogg pages and headers, please refer to the <a href="../framing.html">framing document</a>. + +<table border=0 width=100% color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +typedef struct { + unsigned char *header; + long header_len; + unsigned char *body; + long body_len; +} ogg_page; +</b></pre> + </td> +</tr> +</table> + +<h3>Relevant Struct Members</h3> +<dl> +<dt><i>header</i></dt> +<dd>Pointer to the page header for this page. The exact contents of this header are defined in the framing spec document.</dd> +<dt><i>header_len</i></dt> +<dd>Length of the page header in bytes.</a> +<dt><i>body</i></dt> +<dd>Pointer to the data for this page.</dd> +<dt><i>body_len</i></dt> +<dd>Length of the body data in bytes.</dd> +</dl> + + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000-2019 Xiph.Org Foundation</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.4 - 20190830</p></td> +</tr> +</table> + +</body> + +</html> |