diff options
| author | Ralph Giles <giles@xiph.org> | 2005-07-30 23:43:51 +0000 |
|---|---|---|
| committer | Ralph Giles <giles@xiph.org> | 2005-07-30 23:43:51 +0000 |
| commit | 6e275ac670397fa0d54fe2897ac3d058cb3055dd (patch) | |
| tree | 8755b26c9991c1c158115531a5d76e12c4714ceb /doc/libogg | |
| parent | d0acdd7d7ea78127d1e2f0e57164c20104c6bb69 (diff) | |
| download | ogg-git-6e275ac670397fa0d54fe2897ac3d058cb3055dd.tar.gz | |
Rename the libogg api doc directory to doc/libogg for greater clarity.
svn path=/trunk/ogg/; revision=9667
Diffstat (limited to 'doc/libogg')
65 files changed, 4263 insertions, 0 deletions
diff --git a/doc/libogg/.cvsignore b/doc/libogg/.cvsignore new file mode 100644 index 0000000..282522d --- /dev/null +++ b/doc/libogg/.cvsignore @@ -0,0 +1,2 @@ +Makefile +Makefile.in diff --git a/doc/libogg/Makefile.am b/doc/libogg/Makefile.am new file mode 100644 index 0000000..8a51188 --- /dev/null +++ b/doc/libogg/Makefile.am @@ -0,0 +1,28 @@ +## Process this file with automake to produce Makefile.in + +docdir = $(datadir)/doc/$(PACKAGE)-$(VERSION)/ogg + +doc_DATA = bitpacking.html datastructures.html decoding.html encoding.html\ + general.html index.html ogg_packet.html ogg_packet_clear.html\ + ogg_page.html ogg_page_bos.html ogg_page_checksum_set.html\ + ogg_page_continued.html ogg_page_eos.html ogg_page_granulepos.html\ + ogg_page_packets.html ogg_page_pageno.html ogg_page_serialno.html\ + ogg_page_version.html ogg_stream_clear.html ogg_stream_destroy.html\ + ogg_stream_eos.html ogg_stream_flush.html ogg_stream_init.html\ + ogg_stream_packetin.html ogg_stream_packetout.html\ + ogg_stream_packetpeek.html ogg_stream_pagein.html\ + ogg_stream_pageout.html ogg_stream_reset.html\ + ogg_stream_reset_serialno.html ogg_stream_state.html\ + ogg_sync_buffer.html ogg_sync_clear.html ogg_sync_destroy.html\ + ogg_sync_init.html ogg_sync_pageout.html ogg_sync_pageseek.html\ + ogg_sync_reset.html ogg_sync_state.html ogg_sync_wrote.html\ + oggpack_adv.html oggpack_adv1.html oggpack_bits.html\ + oggpack_buffer.html oggpack_bytes.html oggpack_get_buffer.html\ + oggpack_look.html oggpack_look1.html oggpack_read.html\ + oggpack_read1.html oggpack_readinit.html oggpack_reset.html\ + oggpack_write.html oggpack_writealign.html oggpack_writeclear.html\ + oggpack_writecopy.html oggpack_writeinit.html oggpack_writetrunc.html\ + overview.html reference.html style.css vorbis_comment.html\ + vorbis_info.html + +EXTRA_DIST = $(doc_DATA) diff --git a/doc/libogg/bitpacking.html b/doc/libogg/bitpacking.html new file mode 100644 index 0000000..57ff78a --- /dev/null +++ b/doc/libogg/bitpacking.html @@ -0,0 +1,99 @@ +<html> + +<head> +<title>libogg - Bitpacking Functions</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>Bitpacking Functions</h1> +<p>Libogg contains a basic bitpacking library that is useful for manipulating data within a buffer. +<p> +All the <b>libogg</b> specific functions are declared in "ogg/ogg.h". +<p> + +<table border=1 color=black width=50% cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td><b>function</b></td> + <td><b>purpose</b></td> +</tr> +<tr valign=top> +<td><a href="oggpack_writeinit.html">oggpack_writeinit</a></td> + <td>Initializes a buffer for writing using this bitpacking library.</td> +</tr> +<tr valign=top> +<td><a href="oggpack_reset.html">oggpack_reset</a></td> + <td>Clears and resets the buffer to the initial position.</td> +</tr> +<tr valign=top> +<td><a href="oggpack_writeclear.html">oggpack_writeclear</a></td> + <td>Frees the memory used by the buffer.</td> +</tr> +<tr valign=top> +<td><a href="oggpack_readinit.html">oggpack_readinit</a></td> + <td>Initializes a buffer for reading using this bitpacking library.</td> +</tr> +<tr valign=top> +<td><a href="oggpack_write.html">oggpack_write</a></td> + <td>Writes bytes to the specified location within the buffer.</td> +</tr> +<tr valign=top> +<td><a href="oggpack_look.html">oggpack_look</a></td> + <td>Look at a specified number of bits, <=32, without advancing the location pointer.</td> +</tr> +<tr valign=top> +<td><a href="oggpack_look1.html">oggpack_look1</a></td> + <td>Looks at one bit without advancing the location pointer.</td> +</tr> +<tr valign=top> +<td><a href="oggpack_adv.html">oggpack_adv</a></td> + <td>Advances the location pointer by a specified number of bits.</td> +</tr> +<tr valign=top> +<td><a href="oggpack_adv1.html">oggpack_adv1</a></td> + <td>Advances the location pointer by one bit.</td> +</tr> +<tr valign=top> +<td><a href="oggpack_read.html">oggpack_read</a></td> + <td>Reads a specified number of bits from the buffer.</td> +</tr> +<tr valign=top> +<td><a href="oggpack_read1.html">oggpack_read1</a></td> + <td>Reads one bit from the buffer.</td> +</tr> +<tr valign=top> +<td><a href="oggpack_bytes.html">oggpack_bytes</a></td> + <td>Returns the total number of bytes contained within the buffer.</td> +</tr> +<tr valign=top> +<td><a href="oggpack_bits.html">oggpack_bits</a></td> + <td>Returns the total number of bits contained within the buffer.</td> +</tr> +<tr valign=top> +<td><a href="oggpack_get_buffer.html">oggpack_get_buffer</a></td> + <td>Returns a pointer to the buffer encapsulated within the <a href="oggpack_buffer.html">oggpack_buffer</a> struct.</td> +</tr> +</table> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + +</body> + +</html> diff --git a/doc/libogg/datastructures.html b/doc/libogg/datastructures.html new file mode 100644 index 0000000..13fee95 --- /dev/null +++ b/doc/libogg/datastructures.html @@ -0,0 +1,59 @@ +<html> + +<head> +<title>libogg - Base Data Structures</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>Base Data Structures</h1> +<p>Libogg uses several data structures to hold data and state information. +<p> +All the <b>libogg</b> specific data structures are declared in "ogg/ogg.h". +<p> + +<table border=1 color=black width=50% cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td><b>datatype</b></td> + <td><b>purpose</b></td> +</tr> +<tr valign=top> +<td><a href="ogg_page.html">ogg_page</a></td> + <td>This structure encapsulates data into one ogg bitstream page.</td> +</tr> +<tr valign=top> +<td><a href="ogg_stream_state.html">ogg_stream_state</a></td> + <td>This structure contains current encode/decode data for a logical bitstream.</td> +</tr> +<tr valign=top> +<td><a href="ogg_packet.html">ogg_packet</a></td> + <td>This structure encapsulates the data and metadata for a single raw Ogg Vorbis packet.</td> +</tr> +<tr valign=top> +<td><a href="ogg_sync_state.html">ogg_sync_state</a></td> + <td>Contains bitstream synchronization information.</td> +</tr> +</table> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + +</body> + +</html> diff --git a/doc/libogg/decoding.html b/doc/libogg/decoding.html new file mode 100644 index 0000000..2cd576e --- /dev/null +++ b/doc/libogg/decoding.html @@ -0,0 +1,100 @@ +<html> + +<head> +<title>libogg - Decoding</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>Decoding</h1> +<p>Libogg contains a set of functions used in the decoding process. +<p> +All the <b>libogg</b> specific functions are declared in "ogg/ogg.h". +<p> +<p>Decoding is based around the ogg synchronization layer. The <a href="ogg_sync_state.html">ogg_sync_state</a> struct coordinates between incoming data and the decoder. We read data into the synchronization layer, submit the data to the stream, and output raw packets to the decoder. +<p>Decoding through the Ogg layer follows a specific logical sequence. A read loop follows these logical steps: +<ul> +<li>Expose a buffer using <a href="ogg_sync_buffer.html">ogg_sync_buffer()</a>. +<li>Read data into the buffer, using fread() or a similar function. +<li>Call <a href="ogg_sync_wrote.html">ogg_sync_wrote()</a> to tell the synchronization layer how many bytes you wrote into the buffer. +<li>Write out the data using <a href="ogg_sync_pageout.html">ogg_sync_pageout</a>. +<li>Submit the completed page to the streaming layer with <a href="ogg_stream_pagein.html">ogg_stream_pagein</a>. +<li>Output a packet of data to the codec-specific decoding layer using <a href="ogg_stream_packetout.html">ogg_stream_packetout</a>. +</ul> +<p>In practice, streams are more complex, and Ogg also must handle headers, incomplete or dropped pages, and other errors in input. +<br><br> + +<table border=1 color=black width=50% cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td><b>function</b></td> + <td><b>purpose</b></td> +</tr> +<tr valign=top> +<td><a href="ogg_sync_init.html">ogg_sync_init</a></td> + <td>Initializes an Ogg bitstream.</td> +</tr> +<tr valign=top> +<td><a href="ogg_sync_clear.html">ogg_sync_clear</a></td> + <td>Clears the status information from the synchronization struct.<td> +</tr> +<tr valign=top> +<td><a href="ogg_sync_reset.html">ogg_sync_reset</a></td> + <td>Resets the synchronization status to initial values.</td> +</tr> +<tr valign=top> +<td><a href="ogg_sync_destroy.html">ogg_sync_destroy</a></td> + <td>Frees the synchronization struct.</td> +</tr> +<tr valign=top> +<td><a href="ogg_sync_buffer.html">ogg_sync_buffer</a></td> + <td>Exposes a buffer from the synchronization layer in order to read data.</td> +</tr> +<tr valign=top> +<td><a href="ogg_sync_wrote.html">ogg_sync_wrote</a></td> + <td>Tells the synchronization layer how many bytes were written into the buffer.</td> +</tr> +<tr valign=top> +<td><a href="ogg_sync_pageseek.html">ogg_sync_pageseek</a></td> + <td>Finds the borders of pages and resynchronizes the stream.</td> +</tr> +<tr valign=top> +<td><a href="ogg_sync_pageout.html">ogg_sync_pageout</a></td> + <td>Outputs a page from the synchronization layer.</td> +</tr> +<tr valign=top> +<td><a href="ogg_stream_pagein.html">ogg_stream_pagein</a></td> + <td>Submits a complete page to the stream layer.</td> +</tr> +<tr valign=top> +<td><a href="ogg_stream_packetout.html">ogg_stream_packetout</a></td> + <td>Outputs a packet to the codec-specific decoding engine.</td> +</tr> +<tr valign=top> +<td><a href="ogg_stream_packetpeek.html">ogg_stream_packetpeek</a></td> + <td>Provides access to the next packet in the bitstream without +advancing decoding.</td> +</tr> +</table> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + +</body> + +</html> diff --git a/doc/libogg/encoding.html b/doc/libogg/encoding.html new file mode 100644 index 0000000..372ea80 --- /dev/null +++ b/doc/libogg/encoding.html @@ -0,0 +1,64 @@ +<html> + +<head> +<title>libogg - Encoding</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>Encoding</h1> +<p>Libogg contains a set of functions used in the encoding process. +<p> +All the <b>libogg</b> specific functions are declared in "ogg/ogg.h". +<p> +<p>When encoding, the encoding engine will output raw packets which must be placed into an Ogg bitstream. +<p>Raw packets are inserted into the stream, and an <a href="ogg_page.html">ogg_page</a> is output when enough packets have been written to create a full page. The pages output are pointers to buffered packet segments, and can then be written out and saved as an ogg stream. +<p>There are a couple of basic steps: +<ul> +<li>Use the encoding engine to produce a raw packet of data. +<li>Call <a href="ogg_stream_packetin.html">ogg_stream_packetin</a> to submit a raw packet to the stream. +<li>Use <a href="ogg_stream_pageout.html">ogg_stream_pageout</a> to output a page, if enough data has been submitted. Otherwise, continue submitting data. +</ul> +<br><br> + +<table border=1 color=black width=50% cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td><b>function</b></td> + <td><b>purpose</b></td> +</tr> +<tr valign=top> +<td><a href="ogg_stream_packetin.html">ogg_stream_packetin</a></td> + <td>Submits a raw packet to the streaming layer, so that it can be formed into a page.</td> +</tr> +<tr valign=top> +<td><a href="ogg_stream_pageout.html">ogg_stream_pageout</a></td> + <td>Outputs a completed page if the stream contains enough packets to form a full page.<td> +</tr> +<tr valign=top> +<td><a href="ogg_stream_flush.html">ogg_stream_flush</a></td> + <td>Forces any remaining packets in the stream to be returned as a page of any size.<td> +</tr> +</table> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + +</body> + +</html> diff --git a/doc/libogg/general.html b/doc/libogg/general.html new file mode 100644 index 0000000..f8c92e9 --- /dev/null +++ b/doc/libogg/general.html @@ -0,0 +1,105 @@ +<html> + +<head> +<title>libogg - General Functions</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>General Functions</h1> +<p>Libogg contains several functions which are generally useful when using Ogg streaming, whether encoding or decoding. +<p> +All the <b>libogg</b> specific functions are declared in "ogg/ogg.h". +<p> +<p>These functions can be used to manipulate some of the basic elements of Ogg - streams and pages. Streams and pages are important during both the encode and decode process. +<br> + +<table border=1 color=black width=50% cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td><b>function</b></td> + <td><b>purpose</b></td> +</tr> +<tr valign=top> +<td><a href="ogg_stream_init.html">ogg_stream_init</a></td> + <td>Initializes an Ogg bitstream.</td> +</tr> +<tr valign=top> +<td><a href="ogg_stream_clear.html">ogg_stream_clear</a></td> + <td>Clears the storage within the Ogg stream, but does not free the stream itself.<td> +</tr> +<tr valign=top> +<td><a href="ogg_stream_reset.html">ogg_stream_reset</a></td> + <td>Resets the stream status to its initial position.</td> +</tr> +<tr valign=top> +<td><a href="ogg_stream_destroy.html">ogg_stream_destroy</a></td> + <td>Frees the entire Ogg stream.</td> +</tr> +<tr valign=top> +<td><a href="ogg_stream_eos.html">ogg_stream_eos</a></td> + <td>Indicates whether we are at the end of the stream.</td> +</tr> +<tr valign=top> +<td><a href="ogg_page_version.html">ogg_page_version</a></td> + <td>Returns the version of ogg_page that this stream/page uses</td> +</tr> +<tr valign=top> +<td><a href="ogg_page_continued.html">ogg_page_continued</a></td> + <td>Indicates if the current page contains a continued packet from the last page.</td> +</tr> +<tr valign=top> +<td><a href="ogg_page_packets.html">ogg_page_packets</a></td> + <td>Indicates the number of packets contained in a page.</td> +</tr> +<tr valign=top> +<td><a href="ogg_page_bos.html">ogg_page_bos</a></td> + <td>Indicates if the current page is the beginning of the stream.</td> +</tr> +<tr valign=top> +<td><a href="ogg_page_eos.html">ogg_page_eos</a></td> + <td>Indicates if the current page is the end of the stream.</td> +</tr> +<tr valign=top> +<td><a href="ogg_page_granulepos.html">ogg_page_granulepos</a></td> + <td>Returns the precise playback location of this page.</td> +</tr> +<tr valign=top> +<td><a href="ogg_page_serialno.html">ogg_page_serialno</a></td> + <td>Returns the unique serial number of the logical bitstream associated with this page.</td> +</tr> +<tr valign=top> +<td><a href="ogg_page_pageno.html">ogg_page_pageno</a></td> + <td>Returns the sequential page number for this page.</td> +</tr> +<tr valign=top> +<td><a href="ogg_packet_clear.html">ogg_packet_clear</a><td> + <td>Clears the ogg_packet structure.</td> +</tr> +<tr valign=top> +<td><a href="ogg_page_checksum_set.html">ogg_page_checksum_set</a></td> + <td>Checksums an ogg_page.</td> +</tr> +</table> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + +</body> + +</html> diff --git a/doc/libogg/index.html b/doc/libogg/index.html new file mode 100644 index 0000000..123d965 --- /dev/null +++ b/doc/libogg/index.html @@ -0,0 +1,39 @@ +<html> + +<head> +<title>libogg - Documentation</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>Libogg Documentation</h1> + +<p> +Libogg contains necessary functionality to create, decode, and work with Ogg bitstreams. +<p>This document explains how to use the libogg API in detail. +<p> +<a href="overview.html">libogg api overview</a><br> +<a href="reference.html">libogg api reference</a><br> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + +</body> + +</html> diff --git a/doc/libogg/ogg_packet.html b/doc/libogg/ogg_packet.html new file mode 100644 index 0000000..0dab54e --- /dev/null +++ b/doc/libogg/ogg_packet.html @@ -0,0 +1,75 @@ +<html> + +<head> +<title>libogg - datatype - ogg_packet</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 - 20011015</p></td> +</tr> +</table> + +<h1>ogg_packet</h1> + +<p><i>declared in "ogg/ogg.h"</i></p> + +<p> +The ogg_packet struct encapsulates the data for a single raw packet of data +and is used to transfer data between the ogg framing layer and the handling codec. +<p> + +<table border=0 width=100% color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +typedef struct { + unsigned char *packet; + long bytes; + long b_o_s; + long e_o_s; + + ogg_int64_t granulepos; + ogg_int64_t packetno; + +} ogg_packet; +</b></pre> + </td> +</tr> +</table> + +<h3>Relevant Struct Members</h3> +<dl> +<dt><i>packet</i></dt> +<dd>Pointer to the packet's data. This is treated as an opaque type by the ogg layer.</dd> +<dt><i>bytes</i></dt> +<dd>Indicates the size of the packet data in bytes. Packets can be of arbitrary size.</dd> +<dt><i>b_o_s</i></dt> +<dd>Flag indicating whether this packet begins a logical bitstream. <tt>1</tt> indicates this is the first packet, <tt>0</tt> indicates any other position in the stream.</dd> +<dt><i>e_o_s</i></dt> +<dd>Flag indicating whether this packet ends a bitstream. <tt>1</tt> indicates the last packet, <tt>0</tt> indicates any other position in the stream.</dd> +<dt><i>granulepos</i></dt> +<dd>A number indicating the position of this packet in the decoded data. This is the last sample, frame or other unit of information ('granule') that can be completely decoded from this packet.</dd> +<dt><i>packetno</i></dt> +<dd>Sequential number of this packet in the ogg bitstream.<dd> +</dl> + + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2001 xiph.org foundation</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg - 20011015</p></td> +</tr> +</table> + +</body> + +</html> diff --git a/doc/libogg/ogg_packet_clear.html b/doc/libogg/ogg_packet_clear.html new file mode 100644 index 0000000..5e0bdf3 --- /dev/null +++ b/doc/libogg/ogg_packet_clear.html @@ -0,0 +1,62 @@ +<html> + +<head> +<title>libogg - function - ogg_packet_clear</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 - 20011218</p></td> +</tr> +</table> + +<h1>ogg_packet_clear</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function clears the memory used by the <a href="ogg_packet.html">ogg_packet</a> struct, and frees the internal allocated memory, but does not free +the structure itself. +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_packet_clear(ogg_packet *op); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>os</i></dt> +<dd>Pointer to the ogg_packet struct to be cleared.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +None.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2001 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg - 20011218</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_page.html b/doc/libogg/ogg_page.html new file mode 100644 index 0000000..8fdccc2 --- /dev/null +++ b/doc/libogg/ogg_page.html @@ -0,0 +1,74 @@ +<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 - 200011015</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 pages are +usually around 4 kB. +<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 © 2001 xiph.org foundation</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg version - 20011015</p></td> +</tr> +</table> + +</body> + +</html> diff --git a/doc/libogg/ogg_page_bos.html b/doc/libogg/ogg_page_bos.html new file mode 100644 index 0000000..9e1462f --- /dev/null +++ b/doc/libogg/ogg_page_bos.html @@ -0,0 +1,65 @@ +<html> + +<head> +<title>libogg - function - ogg_page_bos</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_page_bos</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>Indicates whether this page is at the beginning of the logical bitstream. +<p> +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_page_bos(ogg_page *og); + +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>og</i></dt> +<dd>Pointer to the current ogg_page struct.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +greater than 0 if this page is the beginning of a bitstream.</li> +<li> +0 if this page is from any other location in the stream.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_page_checksum_set.html b/doc/libogg/ogg_page_checksum_set.html new file mode 100644 index 0000000..72780d0 --- /dev/null +++ b/doc/libogg/ogg_page_checksum_set.html @@ -0,0 +1,62 @@ +<html> + +<head> +<title>libogg - function - ogg_page_checksum_set</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 - 20011218</p></td> +</tr> +</table> + +<h1>ogg_page_checksum_set</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>Checksums an ogg_page. +<p> +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_page_checksum_set(ogg_page *og); + +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>og</i></dt> +<dd>Pointer to an ogg_page struct.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +None. +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2001 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg - 20011218</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_page_continued.html b/doc/libogg/ogg_page_continued.html new file mode 100644 index 0000000..36adc09 --- /dev/null +++ b/doc/libogg/ogg_page_continued.html @@ -0,0 +1,64 @@ +<html> + +<head> +<title>libogg - function - ogg_page_version</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_page_continued</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>Indicates whether this page contains packet data which has been continued from the previous page. +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_page_continued(ogg_page *og); + +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>og</i></dt> +<dd>Pointer to the current ogg_page struct.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +1 if this page contains packet data continued from the last page.</li> +<li> +0 if this page does not contain continued data.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_page_eos.html b/doc/libogg/ogg_page_eos.html new file mode 100644 index 0000000..13747b5 --- /dev/null +++ b/doc/libogg/ogg_page_eos.html @@ -0,0 +1,65 @@ +<html> + +<head> +<title>libogg - function - ogg_page_eos</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_page_eos</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>Indicates whether this page is at the end of the logical bitstream. +<p> +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_page_eos(ogg_page *og); + +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>og</i></dt> +<dd>Pointer to the current ogg_page struct.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +greater than zero if this page contains the end of a bitstream.</li> +<li> +0 if this page is from any other location in the stream.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_page_granulepos.html b/doc/libogg/ogg_page_granulepos.html new file mode 100644 index 0000000..50c5e45 --- /dev/null +++ b/doc/libogg/ogg_page_granulepos.html @@ -0,0 +1,65 @@ +<html> + +<head> +<title>libogg - function - ogg_page_granulepos</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_page_granulepos</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>Returns the exact granular position of the packet data contained at the end of this page. +<p>This is useful for tracking location when seeking or decoding. +<p>For example, in audio codecs this position is the pcm sample number and in video this is the frame number. +<p> +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_page_granulepos(ogg_page *og); + +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>og</i></dt> +<dd>Pointer to the current ogg_page struct.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +<i>n</i> is the specific last granular position of the decoded data contained in the page.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_page_packets.html b/doc/libogg/ogg_page_packets.html new file mode 100644 index 0000000..e88724c --- /dev/null +++ b/doc/libogg/ogg_page_packets.html @@ -0,0 +1,75 @@ +<html> + +<head> +<title>libogg - function - ogg_page_packets</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 - 20011218</p></td> +</tr> +</table> + +<h1>ogg_page_packets</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>Returns the number of packets that are completed on this page. If the +leading packet is begun on a previous page, but ends on this page, it's +counted. +<p> +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_page_packets(ogg_page *og); + +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>og</i></dt> +<dd>Pointer to the current ogg_page struct.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +If a page consists of a packet begun on a previous page, and a new packet +begun (but not completed) on this page, the return will be:<br> +<br> +ogg_page_packets(page) will return 1,<br> +ogg_page_continued(paged) will return non-zero.<br> +<br><br> +If a page happens to be a single packet that was begun on a previous page, and +spans to the next page (in the case of a three or more page packet), the +return will be:<br> +<br> +ogg_page_packets(page) will return 0,<br> +ogg_page_continued(page) will return non-zero.<br> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2001 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg - 20011218</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_page_pageno.html b/doc/libogg/ogg_page_pageno.html new file mode 100644 index 0000000..0eca7af --- /dev/null +++ b/doc/libogg/ogg_page_pageno.html @@ -0,0 +1,63 @@ +<html> + +<head> +<title>libogg - function - ogg_page_pageno</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_page_pageno</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>Returns the sequential page number. +<p>This is useful for ordering pages or determining when pages have been lost. +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_page_pageno(ogg_page *og); + +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>og</i></dt> +<dd>Pointer to the current ogg_page struct.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +<i>n</i> is the page number for this page.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_page_serialno.html b/doc/libogg/ogg_page_serialno.html new file mode 100644 index 0000000..60305a9 --- /dev/null +++ b/doc/libogg/ogg_page_serialno.html @@ -0,0 +1,63 @@ +<html> + +<head> +<title>libogg - function - ogg_page_serialno</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_page_serialno</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>Returns the unique serial number for the logical bitstream of this page. Each page contains the serial number for the logical bitstream that it belongs to. +<p> +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_page_serialno(ogg_page *og); + +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>og</i></dt> +<dd>Pointer to the current ogg_page struct.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +<i>n</i> is the serial number for this page.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_page_version.html b/doc/libogg/ogg_page_version.html new file mode 100644 index 0000000..9f3c383 --- /dev/null +++ b/doc/libogg/ogg_page_version.html @@ -0,0 +1,63 @@ +<html> + +<head> +<title>libogg - function - ogg_page_version</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_page_version</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function returns the version of ogg_page used in this page. +<p>In current versions of libogg, all ogg_page structs have the same version, so 0 should always be returned. +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_page_version(ogg_page *og); + +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>og</i></dt> +<dd>Pointer to the current ogg_page struct.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +<i>n</i> is the version number. In the current version of Ogg, the version number is always 0. Nonzero return values indicate an error in page encoding.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_stream_clear.html b/doc/libogg/ogg_stream_clear.html new file mode 100644 index 0000000..a261a5d --- /dev/null +++ b/doc/libogg/ogg_stream_clear.html @@ -0,0 +1,61 @@ +<html> + +<head> +<title>libogg - function - ogg_stream_clear</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_stream_clear</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function clears the memory used by the <a href="ogg_sync_state.html">ogg_stream_state</a> struct, but does not free it. +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_stream_clear(ogg_stream_state *os); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>os</i></dt> +<dd>Pointer to the ogg_stream_state struct to be cleared.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +0 is always returned.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_stream_destroy.html b/doc/libogg/ogg_stream_destroy.html new file mode 100644 index 0000000..ebe7a24 --- /dev/null +++ b/doc/libogg/ogg_stream_destroy.html @@ -0,0 +1,62 @@ +<html> + +<head> +<title>libogg - function - ogg_stream_destroy</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_stream_destroy</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function frees the memory used by the <a href="ogg_stream_state.html">ogg_stream_state</a> struct. +<p>This should be called when you are done working with an ogg stream. It can also be called to make sure that the struct does not exist. +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_stream_destroy(ogg_stream_state *os); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>os</i></dt> +<dd>Pointer to the ogg_stream_state struct to be destroyed.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +0 is always returned.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_stream_eos.html b/doc/libogg/ogg_stream_eos.html new file mode 100644 index 0000000..40e577e --- /dev/null +++ b/doc/libogg/ogg_stream_eos.html @@ -0,0 +1,62 @@ +<html> + +<head> +<title>libogg - function - ogg_stream_eos</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_stream_eos</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function indicates whether we have reached the end of the stream or not. +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_stream_eos(ogg_stream_state *os); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>os</i></dt> +<dd>Pointer to the current ogg_stream_state struct.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li>1 if we are at the end of the stream.</li> +<li> +0 if we have not yet reached the end of the stream.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_stream_flush.html b/doc/libogg/ogg_stream_flush.html new file mode 100644 index 0000000..05d75fb --- /dev/null +++ b/doc/libogg/ogg_stream_flush.html @@ -0,0 +1,67 @@ +<html> + +<head> +<title>libogg - function - ogg_stream_flush</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_stream_flush</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function checks for remaining packets inside the stream and forces remaining packets into a page, regardless of the size of the page. +<p>This should only be used when you want to flush an undersized page from the middle of the stream. Otherwise, <a href="ogg_stream_pageout.html">ogg_stream_pageout</a> should always be used. +<p>This function can be used to verify that all packets have been flushed. If the return value is 0, all packets have been placed into a page. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_stream_flush(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <a href="ogg_page.html">ogg_page</a> *og); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>os</i></dt> +<dd>Pointer to a previously declared <a href="ogg_stream_state.html">ogg_stream_state</a> struct, which represents the current logical bitstream.</dd> +<dt><i>og</i></dt> +<dd>Pointer to a page of data. The remaining packets in the stream will be placed into this page, if any remain. +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li>0 means that all packet data has already been flushed into pages, and there are no packets to put into the page.</li> +<li> +Nonzero means that remaining packets have successfully been flushed into the page.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_stream_init.html b/doc/libogg/ogg_stream_init.html new file mode 100644 index 0000000..4f600ff --- /dev/null +++ b/doc/libogg/ogg_stream_init.html @@ -0,0 +1,66 @@ +<html> + +<head> +<title>libogg - function - ogg_stream_init</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_stream_init</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function is used to initialize an <a href="ogg_sync_state.html">ogg_stream_state</a> struct and allocates appropriate memory in preparation for encoding or decoding. +<p>It also assigns the stream a given serial number. +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_stream_init(<a href="ogg_stream_state.html">ogg_stream_state</a> *os,int serialno); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>os</i></dt> +<dd>Pointer to the ogg_stream_state struct that we will be initializing.</dd> +<dt><i>serialno</i></dt> +<dd>Serial number that we will attach to this stream.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +0 if successful</li> +<li> +-1 if unsuccessful. If this fails, the ogg_stream_state was not properly declared before calling this function.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_stream_packetin.html b/doc/libogg/ogg_stream_packetin.html new file mode 100644 index 0000000..c1018dc --- /dev/null +++ b/doc/libogg/ogg_stream_packetin.html @@ -0,0 +1,65 @@ +<html> + +<head> +<title>libogg - function - ogg_stream_packetin</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_stream_packetin</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function takes a packet and submits it to the bitstream. After this is called, we can continue submitting packets, or we can write out pages. +<p>In a typical decoding situation, this should be used after filling a packet with data + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_stream_packetin(ogg_stream_state *os,ogg_packet *op); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>os</i></dt> +<dd>Pointer to a previously declared <a href="ogg_stream_state.html">ogg_stream_state</a> struct.</dd> +<dt><i>op</i></dt> +<dd>Pointer to the packet we are putting into the bitstream. +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +0 is always returned.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_stream_packetout.html b/doc/libogg/ogg_stream_packetout.html new file mode 100644 index 0000000..bc57e85 --- /dev/null +++ b/doc/libogg/ogg_stream_packetout.html @@ -0,0 +1,71 @@ +<html> + +<head> +<title>libogg - function - ogg_stream_packetout</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.1.3 - 20040927</p></td> +</tr> +</table> + +<h1>ogg_stream_packetout</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function assembles a raw data packet for output to the codec decoding engine. The data is already in the stream and broken into packet segments. Each successive call returns the next complete packet built from those segments.</p> +<p>In a typical decoding situation, this should be used after calling <a href="ogg_stream_pagein.html">ogg_stream_pagein()</a> to submit a page of data to the bitstream. If the function returns 0, more data is needed and another page should be submitted. A non-zero return value indicates successful return of a packet.</p> + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_stream_packetout(ogg_stream_state *os,ogg_packet *op); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>os</i></dt> +<dd>Pointer to a previously declared <a +href="ogg_stream_state.html">ogg_stream_state</a> struct. Before this function is called, an <a href="ogg_page.html">ogg_page</a> should be submitted to the stream using <a href="ogg_stream_pagein.html">ogg_stream_pagein()</a>.</dd> +<dt><i>op</i></dt> +<dd>Pointer to the packet to be filled in with pointers to the new data. +This will typically be submitted to a codec for decode after this +function is called.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<ul> +<li>-1 if we are out of sync and there is a gap in the data. Usually this will not be a fatal error. <i>op</i> contains a the first packet decodable after the hole.</li> +<li>0 if there is insufficient data available to complete a packet. <i>op</i> has not been updated. +<li>1 if a packet was assembled normally. <i>op</i> contains the next packet from the stream.</li> +</ul> +</blockquote> + +<br><br> + +<hr noshade> + +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2004 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.1.3 - 20040927</p></td> +</tr> +</table> + +</body> + +</html> diff --git a/doc/libogg/ogg_stream_packetpeek.html b/doc/libogg/ogg_stream_packetpeek.html new file mode 100644 index 0000000..892977b --- /dev/null +++ b/doc/libogg/ogg_stream_packetpeek.html @@ -0,0 +1,85 @@ +<html> + +<head> +<title>libogg - function - ogg_stream_packetpeek</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 version 1.26 - 20010527</p></td> +</tr> +</table> + +<h1>ogg_stream_packetout</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function attempts to assemble a raw data packet and returns +it without advancing decoding.</p> + +<p>In a typical situation, this would be called +speculatively after <a +href="ogg_stream_pagein.html">ogg_stream_pagein()</a> to check +the packet contents before handing it off to a codec for +decompression. To advance page decoding and remove +the packet from the sync structure, call +<a href="ogg_stream_packetout.html">ogg_stream_packetout()</a>.</p> + +<br><br> + +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_stream_packetpeek(ogg_stream_state *os,ogg_packet *op); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>os</i></dt> +<dd>Pointer to a previously declared +<a href="ogg_stream_state.html">ogg_stream_state</a> struct. Before this +function is called, an <a href="ogg_page.html">ogg_page</a> should be +submitted to the stream using +<a href="ogg_stream_pagein.html">ogg_stream_pagein()</a>.</dd> +<dt><i>op</i></dt> +<dd>Pointer to the next packet available in the bitstream, if +any. A NULL value may be passed in the case of a simple "is there a +packet?" check.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<ul> +<li>-1 if there's no packet available due to lost sync or a hole +in the data.</li> +<li>1 if a packet is available.</li> +</ul> +</blockquote> + + +<br><br> + +<hr noshade> + +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2001 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg version 1.26 - 20010527</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_stream_pagein.html b/doc/libogg/ogg_stream_pagein.html new file mode 100644 index 0000000..b884169 --- /dev/null +++ b/doc/libogg/ogg_stream_pagein.html @@ -0,0 +1,67 @@ +<html> + +<head> +<title>libogg - function - ogg_stream_pagein</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_stream_pagein</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function adds a complete page to the bitstream. + <p>In a typical decoding situation, this function would be called after using <a href="ogg_sync_pageout.html">ogg_sync_pageout</a> to create a valid <a href="ogg_page.html">ogg_page</a> struct. +<p>Internally, this function breaks the page into packet segments in preparation for outputting a valid packet to the codec decoding layer. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_stream_pagein(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <a href="ogg_page.html">ogg_page</a> *og); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>os</i></dt> +<dd>Pointer to a previously declared <a href="ogg_stream.html">ogg_stream</a> struct, which represents the current logical bitstream.</dd> +<dt><i>og</i></dt> +<dd>Pointer to a page of data. The data inside this page is being submitted to the streaming layer in order to be allocated into packets. +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li>-1 indicates failure. This means that the serial number of the page did not match the serial number of the bitstream, or that the page version was incorrect.</li> +<li> +0 means that the page was successfully submitted to the bitstream.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_stream_pageout.html b/doc/libogg/ogg_stream_pageout.html new file mode 100644 index 0000000..c703382 --- /dev/null +++ b/doc/libogg/ogg_stream_pageout.html @@ -0,0 +1,66 @@ +<html> + +<head> +<title>libogg - function - ogg_stream_pageout</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_stream_pageout</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function forms packets into pages. If + <p>In a typical encoding situation, this would be called after using <a href="ogg_stream_packetin.html">ogg_stream_packetin</a> to submit data packets to the bitstream. +<p>Internally, this function breaks the page into packet segments in preparation for outputting a valid packet to the codec decoding layer. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_stream_pageout(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <a href="ogg_page.html">ogg_page</a> *og); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>os</i></dt> +<dd>Pointer to a previously declared <a href="ogg_stream.html">ogg_stream</a> struct, which represents the current logical bitstream.</dd> +<dt><i>og</i></dt> +<dd>Pointer to a page of data. The data inside this page is being submitted to the streaming layer in order to be allocated into packets. +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li>Zero means that insufficient data has accumulated to fill a page.</li> +<li>Non-zero means that a page has been completed and flushed.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_stream_reset.html b/doc/libogg/ogg_stream_reset.html new file mode 100644 index 0000000..19634d4 --- /dev/null +++ b/doc/libogg/ogg_stream_reset.html @@ -0,0 +1,61 @@ +<html> + +<head> +<title>libogg - function - ogg_stream_reset</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_stream_reset</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function sets values in the <a href="ogg_sync_state.html">ogg_stream_state</a> struct back to initial values. +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_stream_reset(ogg_stream_state *os); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>os</i></dt> +<dd>Pointer to the ogg_stream_state struct to be cleared.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +0 is always returned.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_stream_reset_serialno.html b/doc/libogg/ogg_stream_reset_serialno.html new file mode 100644 index 0000000..d75fdb3 --- /dev/null +++ b/doc/libogg/ogg_stream_reset_serialno.html @@ -0,0 +1,67 @@ +<html> + +<head> +<title>libogg - function - ogg_stream_reset_serialno</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.0 - 20020719</p></td> +</tr> +</table> + +<h1>ogg_stream_reset</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function reinitializes the values in the +<a href="ogg_stream_state.html">ogg_stream_state</a>, +just like <a href="ogg_stream_reset.html">ogg_stream_reset()</a>. +Additionally, it sets the stream serial number to the given value.</p> + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_stream_reset_serialno(ogg_stream_state *os, int serialno); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>os</i></dt> +<dd>Pointer to the ogg_stream_state struct to be cleared.</dd> +<dt><i>serialno</i></dt> +<dd>New stream serial number to use</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +0 is always returned.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2002 Xiph.org Foundation</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20020719</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_stream_state.html b/doc/libogg/ogg_stream_state.html new file mode 100644 index 0000000..7f41737 --- /dev/null +++ b/doc/libogg/ogg_stream_state.html @@ -0,0 +1,121 @@ +<html> + +<head> +<title>libogg - datatype - ogg_stream_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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_stream_state</h1> + +<p><i>declared in "ogg/ogg.h"</i></p> + +<p> +The ogg_stream_state struct tracks the current encode/decode state of the current logical bitstream. +<p> + +<table border=0 width=100% color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +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; +</b></pre> + </td> +</tr> +</table> + +<h3>Relevant Struct Members</h3> +<dl> +<dt><i>body_data</i></dt> +<dd>Pointer to data from packet bodies.</dd> +<dt><i>body_storage</i></dt> +<dd>Storage allocated for bodies in bytes (filled or unfilled).</dd> +<dt><i>body_fill</i></dt> +<dd>Amount of storage filled with stored packet bodies.</dd> +<dt><i>body_returned</i></dt> +<dd>Number of elements returned from storage.</dd> +<dt><i>lacing_vals</i></dt> +<dd>String of lacing values for the packet segments within the current page. Each value is a byte, indicating packet segment length.</dd> +<dt><i>granule_vals</i></dt> +<dd>Pointer to the lacing values for the packet segments within the current page.</dd> +<dt><i>lacing_storage</i></dt> +<dd>Total amount of storage (in bytes) allocated for storing lacing values.</dd> +<dt><i>lacing_fill</i></dt> +<dd>Fill marker for the current vs. total allocated storage of lacing values for the page.</dd> +<dt><i>lacing_packet</i></dt> +<dd>Lacing value for current packet segment.</dd> +<dt><i>lacing_returned</i></dt> +<dd>Number of lacing values returned from lacing_storage.</dd> +<dt><i>header</i></dt> +<dd>Temporary storage for page header during encode process, while the header is being created.</dd> +<dt><i>header_fill</i></dt> +<dd>Fill marker for header storage allocation. Used during the header creation process.</dd> +<dt><i>e_o_s</i></dt> +<dd>Marker set when the last packet of the logical bitstream has been buffered.</dd> +<dt><i>b_o_s</i></dt> +<dd>Marker set after we have written the first page in the logical bitstream.</dd> +<dt><i>serialno</i></dt> +<dd>Serial number of this logical bitstream.</dd> +<dt><i>pageno</i></dt> +<dd>Number of the current page within the stream.</dd> +<dt><i>packetno</i></dt> +<dd>Number of the current packet.</dd> +<dt><i>granulepos</i></dt> +<dd>Exact position of decoding/encoding process.</dd> +</dl> + + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + +</body> + +</html> diff --git a/doc/libogg/ogg_sync_buffer.html b/doc/libogg/ogg_sync_buffer.html new file mode 100644 index 0000000..4c84694 --- /dev/null +++ b/doc/libogg/ogg_sync_buffer.html @@ -0,0 +1,67 @@ +<html> + +<head> +<title>libogg - function - ogg_sync_buffer</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_sync_buffer</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function is used to provide a properly-sized buffer for writing. +<p>Buffer space which has already been returned is cleared, and the buffer is extended as necessary by the size plus some additional bytes. Within the current implementation, an extra 4096 bytes are allocated, but applications should not rely on this additional buffer space. +<p>The buffer exposed by this function is empty internal storage from the <a href="ogg_sync_state.html">ogg_sync_state</a> struct, beginning at the fill mark within the struct. +<p>A pointer to this buffer is returned to be used by the calling application. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +char *ogg_sync_buffer(ogg_sync_state *oy, long size); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>oy</i></dt> +<dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd> +<dt><i>size</i></dt> +<dd>Size of the desired buffer. The actual size of the buffer returned will be this size plus some extra bytes (currently 4096). +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +Returns a pointer to the newly allocated buffer.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_sync_clear.html b/doc/libogg/ogg_sync_clear.html new file mode 100644 index 0000000..325e856 --- /dev/null +++ b/doc/libogg/ogg_sync_clear.html @@ -0,0 +1,62 @@ +<html> + +<head> +<title>libogg - function - ogg_sync_clear</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_sync_clear</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function is used to free the internal storage of an <a href="ogg_sync_state.html">ogg_sync_state</a> struct and resets the struct to the initial state. To free the entire struct, <a href="ogg_sync_destroy.html">ogg_sync_destroy</a> should be used instead. In situations where the struct needs to be reset but the internal storage does not need to be freed, <a href="ogg_sync_reset.html">ogg_sync_reset</a> should be used. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_sync_clear(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>oy</i></dt> +<dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +0 is always returned.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_sync_destroy.html b/doc/libogg/ogg_sync_destroy.html new file mode 100644 index 0000000..d2f9ae8 --- /dev/null +++ b/doc/libogg/ogg_sync_destroy.html @@ -0,0 +1,62 @@ +<html> + +<head> +<title>libogg - function - ogg_sync_destroy</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_sync_destroy</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function is used to destroy an <a href="ogg_sync_state.html">ogg_sync_state</a> struct and free all memory used. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_sync_destroy(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>oy</i></dt> +<dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +0 is always returned.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_sync_init.html b/doc/libogg/ogg_sync_init.html new file mode 100644 index 0000000..f42c81d --- /dev/null +++ b/doc/libogg/ogg_sync_init.html @@ -0,0 +1,63 @@ +<html> + +<head> +<title>libogg - function - ogg_sync_init</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_sync_init</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function is used to initialize an <a href="ogg_sync_state.html">ogg_sync_state</a> struct to a known initial value in preparation for manipulation of an Ogg bitstream. +<p>The ogg_sync struct is important when decoding, as it synchronizes retrieval and return of data. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_sync_init(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>oy</i></dt> +<dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct. After this function call, this struct has been initialized.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +0 is always returned.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_sync_pageout.html b/doc/libogg/ogg_sync_pageout.html new file mode 100644 index 0000000..4fcdb17 --- /dev/null +++ b/doc/libogg/ogg_sync_pageout.html @@ -0,0 +1,79 @@ +<html> + +<head> +<title>libogg - function - ogg_sync_pageout</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_sync_pageout</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function takes the data stored in the buffer of the <a href="ogg_sync_state.html">ogg_sync_state</a> struct and inserts them into an <a href="ogg_page.html">ogg_page</a>. + +<p>In an actual decoding loop, this function should be called first to ensure that the buffer is cleared. The example code below illustrates a clean reading loop which will fill and output pages. +<p><b>Caution:</b>This function should be called before reading into the buffer to ensure that data does not remain in the ogg_sync_state struct. Failing to do so may result in a memory leak. See the example code below for details. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_sync_pageout(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy, <a href="ogg_page.html">ogg_page</a> *og); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>oy</i></dt> +<dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct. Normally, the internal storage of this struct should be filled with newly read data and verified using <a href="ogg_sync_wrote.html">ogg_sync_wrote</a>.</dd> +<dt><i>og</i></dt> +<dd>Pointer to page struct filled by this function. +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li>-1 if we were not properly synced and had to skip some bytes.</li> +<li> +0 if we need more data to verify a page.</li> +<li> +1 if we have a page.</li> +</blockquote> +<p> + +<h3>Example Usage</h3> +<pre> +if (ogg_sync_pageout(&oy, &og) != 1) { + buffer = ogg_sync_buffer(&oy, 8192); + bytes = fread(buffer, 1, 8192, stdin); + ogg_sync_wrote(&oy, bytes); +} +</pre> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_sync_pageseek.html b/doc/libogg/ogg_sync_pageseek.html new file mode 100644 index 0000000..7371b82 --- /dev/null +++ b/doc/libogg/ogg_sync_pageseek.html @@ -0,0 +1,68 @@ +<html> + +<head> +<title>libogg - function - ogg_sync_pageseek</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_sync_pageseek</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function synchronizes the ogg_sync_state struct to the next ogg_page. + <p>This is useful when seeking within a bitstream. ogg_sync_pageseek will synchronize to the next page in the bitstream and return information about how many bytes we advanced or skipped in order to do so. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_sync_pageseek(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy, <a href="ogg_page.html">ogg_page</a> *og); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>oy</i></dt> +<dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd> +<dt><i>og</i></dt> +<dd>Pointer to a page (or an incomplete page) of data. This is the page we are attempting to sync. +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li>-n means that we skipped n bytes within the bitstream.</li> +<li> +0 means that the page isn't ready and we need more data. No bytes have been skipped.</li> +<li> +n means that the page was synced at the current location, with a page length of n bytes. +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_sync_reset.html b/doc/libogg/ogg_sync_reset.html new file mode 100644 index 0000000..d27efbd --- /dev/null +++ b/doc/libogg/ogg_sync_reset.html @@ -0,0 +1,63 @@ +<html> + +<head> +<title>libogg - function - ogg_sync_reset</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_sync_reset</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function is used to reset the internal counters of the <a href="ogg_sync_state.html">ogg_sync_state</a> struct to initial values. +<p>It is a good idea to call this before seeking within a bitstream. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_sync_reset(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>oy</i></dt> +<dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +0 is always returned.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/ogg_sync_state.html b/doc/libogg/ogg_sync_state.html new file mode 100644 index 0000000..15a7e3c --- /dev/null +++ b/doc/libogg/ogg_sync_state.html @@ -0,0 +1,67 @@ +<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.0 - 20000615</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 and +<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 data from packet bodies.</dd> +<dt><i>storage</i></dt> +<dd>Pointer to data from packet bodies.</dd> +</dl> + + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + +</body> + +</html> diff --git a/doc/libogg/ogg_sync_wrote.html b/doc/libogg/ogg_sync_wrote.html new file mode 100644 index 0000000..06318ab --- /dev/null +++ b/doc/libogg/ogg_sync_wrote.html @@ -0,0 +1,73 @@ +<html> + +<head> +<title>libogg - function - ogg_sync_wrote</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>ogg_sync_wrote</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function is used to tell the <a href="ogg_sync_state.html">ogg_sync_state</a> struct how many bytes we wrote into the buffer. + +<p> +The general proceedure is to request a pointer into an internal +<a href="ogg_sync_state.html">ogg_sync_state</a> buffer by calling +<a href="ogg_sync_buffer.html">ogg_sync_buffer()</a>. The buffer +is then filled up to the requested size with new input, and +ogg_sync_wrote() is called to advance the fill pointer by however +much data was actually available.</p> + +<br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_sync_wrote(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy, long bytes); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>oy</i></dt> +<dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd> +<dt><i>bytes</i></dt> +<dd>Number of bytes of new data written.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li>-1 if the number of bytes written overflows the internal storage of the <a href="ogg_sync_state.html">ogg_sync_state</a> struct. +<li> +0 in all other cases.</li> +</blockquote> + + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/oggpack_adv.html b/doc/libogg/oggpack_adv.html new file mode 100644 index 0000000..66140ec --- /dev/null +++ b/doc/libogg/oggpack_adv.html @@ -0,0 +1,64 @@ +<html> + +<head> +<title>libogg - function - oggpack_adv</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>oggpack_adv</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function advances the location pointer by the specified number of bits without reading any data. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +void oggpack_adv(oggpack_buffer *b,int bits); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>b</i></dt> +<dd>Pointer to the current oggpack_buffer.</dd> +<dt><i>bits</i></dt> +<dd>Number of bits to advance.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +No values are returned.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2002 Xiph.org Foundation</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20020719</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/oggpack_adv1.html b/doc/libogg/oggpack_adv1.html new file mode 100644 index 0000000..d02ae43 --- /dev/null +++ b/doc/libogg/oggpack_adv1.html @@ -0,0 +1,62 @@ +<html> + +<head> +<title>libogg - function - oggpack_adv1</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>oggpack_adv1</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function advances the location pointer by one bit without reading any data. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +void oggpack_adv1(oggpack_buffer *b); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>b</i></dt> +<dd>Pointer to the current oggpack_buffer.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li>No values are returned. +</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/oggpack_bits.html b/doc/libogg/oggpack_bits.html new file mode 100644 index 0000000..b1bdc39 --- /dev/null +++ b/doc/libogg/oggpack_bits.html @@ -0,0 +1,62 @@ +<html> + +<head> +<title>libogg - function - oggpack_bits</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>oggpack_bits</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function returns the total number of bits currently in the <a href="oggpack_buffer.html">oggpack_buffer</a>'s internal buffer. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +long oggpack_bits(<a href="oggpack_buffer.html">oggpack_buffer</a> *b); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>b</i></dt> +<dd><a href="oggpack_buffer.html">oggpack_buffer</a> struct to be .</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +<i>n</i> is the total number of bits within the current buffer.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/oggpack_buffer.html b/doc/libogg/oggpack_buffer.html new file mode 100644 index 0000000..42f21ec --- /dev/null +++ b/doc/libogg/oggpack_buffer.html @@ -0,0 +1,66 @@ +<html> + +<head> +<title>libogg - datatype - oggpack_buffer</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>oggpack_buffer</h1> + +<p><i>declared in "ogg/ogg.h"</i></p> + +<p> +The oggpack_buffer struct is used with libogg's bitpacking functions. You should never need to directly access anything in this structure. +<p> + +<table border=0 width=100% color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +typedef struct { + long endbyte; + int endbit; + + unsigned char *buffer; + unsigned char *ptr; + long storage; +} oggpack_buffer; +</b></pre> + </td> +</tr> +</table> + +<h3>Relevant Struct Members</h3> +<dl> +<dt><i>buffer</i></dt> +<dd>Pointer to data being manipulated.</dd> +<dt><i>ptr</i></dt> +<dd>Location pointer to mark which data has been read.</dd> +<dt><i>storage</i></dt> +<dd>Size of buffer.</i></dt> +</dl> + + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + +</body> + +</html> diff --git a/doc/libogg/oggpack_bytes.html b/doc/libogg/oggpack_bytes.html new file mode 100644 index 0000000..5e0382d --- /dev/null +++ b/doc/libogg/oggpack_bytes.html @@ -0,0 +1,62 @@ +<html> + +<head> +<title>libogg - function - oggpack_bytes</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.0 - 20020719</p></td> +</tr> +</table> + +<h1>oggpack_bytes</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function returns the total number of bytes currently in the <a href="oggpack_buffer.html">oggpack_buffer</a>'s internal buffer. +<p>The return value is the number of <b>complete</b> bytes in the buffer. There may be extra (<8) bits. +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +long oggpack_bytes(<a href="oggpack_buffer.html">oggpack_buffer</a> *b); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>b</i></dt> +<dd><a href="oggpack_buffer.html">oggpack_buffer</a> struct to be checked.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +<i>n</i> is the total number of bytes within the current buffer.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20020719</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/oggpack_get_buffer.html b/doc/libogg/oggpack_get_buffer.html new file mode 100644 index 0000000..9d2c143 --- /dev/null +++ b/doc/libogg/oggpack_get_buffer.html @@ -0,0 +1,62 @@ +<html> + +<head> +<title>libogg - function - oggpack_get_buffer</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>oggpack_get_buffer</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function returns a pointer to the data buffer within the given <a href="oggpack_buffer.html">oggpack_buffer</a> struct. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +unsigned char *oggpack_get_buffer(<a href="oggpack_buffer.html">oggpack_buffer</a> *b); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>b</i></dt> +<dd>Pointer to the current <a href="oggpack_buffer.html">oggpack_buffer</a>.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +No values are returned.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/oggpack_look.html b/doc/libogg/oggpack_look.html new file mode 100644 index 0000000..3386d0b --- /dev/null +++ b/doc/libogg/oggpack_look.html @@ -0,0 +1,66 @@ +<html> + +<head> +<title>libogg - function - oggpack_look</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>oggpack_look</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function looks at a specified number of bits inside the buffer without advancing the location pointer. +<p>The specified number of bits are read, starting from the location pointer. +<p>This function can be used to read 32 or fewer bits. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +long oggpack_look(<a href="oggpack_buffer.html">oggpack_buffer</a> *b,int bits); +</b></pre> +</td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>b</i></dt> +<dd>Pointer to <a href="oggpack_buffer.html">oggpack_buffer</a> to be read.</dd> +<dt><i>bits</i></dt> +<dd>Number of bits to look at. For this function, must be 32 or fewer.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +<i>n</i> represents the requested bits.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/oggpack_look1.html b/doc/libogg/oggpack_look1.html new file mode 100644 index 0000000..4b9cfe7 --- /dev/null +++ b/doc/libogg/oggpack_look1.html @@ -0,0 +1,63 @@ +<html> + +<head> +<title>libogg - function - oggpack_look1</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>oggpack_look1</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function looks at the next bit without advancing the location pointer. +<p>The next bit is read starting from the location pointer. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +long oggpack_look1(oggpack_buffer *b); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>b</i></dt> +<dd>Pointer to an <a href="oggpack_buffer.html">oggpack_buffer</a> struct containing our buffer.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +<i>n</i> represents the value of the next bit after the location pointer.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/oggpack_read.html b/doc/libogg/oggpack_read.html new file mode 100644 index 0000000..faf3eb7 --- /dev/null +++ b/doc/libogg/oggpack_read.html @@ -0,0 +1,65 @@ +<html> + +<head> +<title>libogg - function - oggpack_read</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>oggpack_read</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function reads the requested number of bits from the buffer and advances the location pointer. +<p>Before reading, the buffer should be initialized using <a href="oggpack_readinit.html">oggpack_readinit</a>. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +long oggpack_read(oggpack_buffer *b,int bits); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>b</i></dt> +<dd>Pointer to an <a href="oggpack_buffer.html">oggpack_buffer</a> struct containing buffered data to be read.</dd> +<dt><i>bits</i></dt> +<dd>Number of bits to read.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +<i>n</i> represents the requested bits.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/oggpack_read1.html b/doc/libogg/oggpack_read1.html new file mode 100644 index 0000000..e697a60 --- /dev/null +++ b/doc/libogg/oggpack_read1.html @@ -0,0 +1,63 @@ +<html> + +<head> +<title>libogg - function - oggpack_read1</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>oggpack_read1</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function reads one bit from the <a href="oggpack_buffer.html">oggpack_buffer</a> data buffer and advances the location pointer. +<p>Before reading, the buffer should be initialized using <a href="oggpack_readinit.html">oggpack_readinit</a>. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +long oggpack_read1(oggpack_buffer *b); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>b</i></dt> +<dd>Pointer to an <a href="oggpack_buffer.html">oggpack_buffer</a> struct containing buffered data to be read.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +<i>n</i> is the bit read by this function.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/oggpack_readinit.html b/doc/libogg/oggpack_readinit.html new file mode 100644 index 0000000..6d537a3 --- /dev/null +++ b/doc/libogg/oggpack_readinit.html @@ -0,0 +1,64 @@ +<html> + +<head> +<title>libogg - function - oggpack_readinit</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>oggpack_readinit</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function takes an ordinary buffer and prepares an <a href="oggpack_buffer.html">oggpack_buffer</a> for reading using the Ogg <a href="bitpacking.html">bitpacking</a> functions. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +void oggpack_readinit(oggpack_buffer *b,unsigned char *buf,int bytes); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>b</i></dt> +<dd>Pointer to <a href=oggpack_buffer.html">oggpack_buffer</a> to be initialized with some extra markers to ease bit navigation and manipulation.</dd> +<dt><i>buf</i></dt> +<dd>Original data buffer, to be inserted into the <a href="oggpack_buffer.html">oggpack_buffer</a> so that it can be read using bitpacking functions. +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +No values are returned.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/oggpack_reset.html b/doc/libogg/oggpack_reset.html new file mode 100644 index 0000000..9002310 --- /dev/null +++ b/doc/libogg/oggpack_reset.html @@ -0,0 +1,62 @@ +<html> + +<head> +<title>libogg - function - oggpack_reset</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>oggpack_reset</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function resets the contents of an <a href="oggpack_buffer">oggpack_buffer</a> to their original state but does not free the memory used. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +void oggpack_reset(oggpack_buffer *b); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>b</i></dt> +<dd><a href="oggpack_buffer.html">oggpack_buffer</a> to be reset.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +No values are returned.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/oggpack_write.html b/doc/libogg/oggpack_write.html new file mode 100644 index 0000000..33d8788 --- /dev/null +++ b/doc/libogg/oggpack_write.html @@ -0,0 +1,68 @@ +<html> + +<head> +<title>libogg - function - oggpack_write</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>oggpack_write</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function writes bits into an <a href="oggpack_buffer.html">oggpack_buffer</a>. +<p>The oggpack_buffer must already be initialized for writing using <a href="oggpack_writeinit.html">oggpack_writeinit</a>. +<p>Only 32 bits can be written at a time. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +void oggpack_write(oggpack_buffer *b,unsigned long value,int bits); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>b</i></dt> +<dd>Buffer to be used for writing.</dd> +<dt><i>value</i></dt> +<dd>The data to be written into the buffer. This must be 32 bits or fewer.</dd> +<dt><i>bits</i></dt> +<dd>The number of bits being written into the buffer.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +No values are returned.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/oggpack_writealign.html b/doc/libogg/oggpack_writealign.html new file mode 100644 index 0000000..0137e61 --- /dev/null +++ b/doc/libogg/oggpack_writealign.html @@ -0,0 +1,65 @@ +<html> + +<head> +<title>libogg - function - oggpack_writealign</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.0 - 20020719</p></td> +</tr> +</table> + +<h1>oggpack_writealign</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function pads the <a href="oggpack_buffer.html">oggpack_buffer</a> with zeros out to the +next byte boundary.</p> +<p>The oggpack_buffer must already be initialized for writing using <a href="oggpack_writeinit.html">oggpack_writeinit</a>. +<p>Only 32 bits can be written at a time.</p> + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +void oggpack_writetrunc(oggpack_buffer *b); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>b</i></dt> +<dd>Buffer to be used for writing.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +No values are returned.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2002 Xiph.org Foundation</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20020719</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/oggpack_writeclear.html b/doc/libogg/oggpack_writeclear.html new file mode 100644 index 0000000..a554eed --- /dev/null +++ b/doc/libogg/oggpack_writeclear.html @@ -0,0 +1,62 @@ +<html> + +<head> +<title>libogg - function - oggpack_reset</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>oggpack_writeclear</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function clears the buffer after writing and frees the memory used by the oggpack_buffer. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +void oggpack_writeclear(oggpack_buffer *b); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>b</i></dt> +<dd>Our oggpack_buffer. This is an ordinary data buffer with some extra markers to ease bit navigation and manipulation.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +No values are returned.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/oggpack_writecopy.html b/doc/libogg/oggpack_writecopy.html new file mode 100644 index 0000000..18f599a --- /dev/null +++ b/doc/libogg/oggpack_writecopy.html @@ -0,0 +1,69 @@ +<html> + +<head> +<title>libogg - function - oggpack_writecopy</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.0 - 20020719</p></td> +</tr> +</table> + +<h1>oggpack_writecopy</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function copies a sequence of bits from a source buffer into an +<a href="oggpack_buffer.html">oggpack_buffer</a>.</p> +<p>The oggpack_buffer must already be initialized for writing using <a href="oggpack_writeinit.html">oggpack_writeinit</a>.</p> +<p>Only 32 bits can be written at a time.</p> + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +void oggpack_writecopy(oggpack_buffer *b, void *source, long bits); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>b</i></dt> +<dd>Buffer to be used for writing.</dd> +<dt><i>source</i></dt> +<dd>A pointer to the data to be written into the buffer.</dd> +<dt><i>bits</i></dt> +<dd>The number of bits to be copied into the buffer.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +No values are returned.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2002 Xiph.org Foundation</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20020719</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/oggpack_writeinit.html b/doc/libogg/oggpack_writeinit.html new file mode 100644 index 0000000..1da1f17 --- /dev/null +++ b/doc/libogg/oggpack_writeinit.html @@ -0,0 +1,62 @@ +<html> + +<head> +<title>libogg - function - oggpack_writeinit</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>oggpack_writeinit</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function initializes an <a href="oggpack_buffer.html">oggpack_buffer</a> for writing using the Ogg <a href="bitpacking.html">bitpacking</a> functions. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +void oggpack_writeinit(<a href="oggpack_buffer.html">oggpack_buffer</a> *b); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>b</i></dt> +<dd>Buffer to be used for writing. This is an ordinary data buffer with some extra markers to ease bit navigation and manipulation.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +No values are returned.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/oggpack_writetrunc.html b/doc/libogg/oggpack_writetrunc.html new file mode 100644 index 0000000..7e8750c --- /dev/null +++ b/doc/libogg/oggpack_writetrunc.html @@ -0,0 +1,65 @@ +<html> + +<head> +<title>libogg - function - oggpack_writetrunc</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.0 - 20020719</p></td> +</tr> +</table> + +<h1>oggpack_write</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function truncates an already written-to <a href="oggpack_buffer.html">oggpack_buffer</a>.</p> +<p>The oggpack_buffer must already be initialized for writing using <a href="oggpack_writeinit.html">oggpack_writeinit</a>.</p> + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +void oggpack_writetrunc(oggpack_buffer *b, long bits); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>b</i></dt> +<dd>Buffer to be truncated.</dd> +<dt><i>bits</i></dt> +<dd>Number of bits to keep in the buffer (size after truncation)</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +No values are returned.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2002 Xiph.org Foundation</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20020719</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/libogg/overview.html b/doc/libogg/overview.html new file mode 100644 index 0000000..f21cf4b --- /dev/null +++ b/doc/libogg/overview.html @@ -0,0 +1,44 @@ +<html> + +<head> +<title>libogg - API Overview</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>Libogg API Overview</h1> + +<p> +The libogg API consists of the following functional categories: +<p> +<ul> +<li><p><a href="datastructures.html">Base data structures</a> +<li><p><a href="bitpacking.html">Bitpacking</a> +<li><p><a href="general.html">General</a> +<li><p><a href="encoding.html">Encoding-Related</a> +<li><p><a href="decoding.html">Decoding-Related</a> + +</ul> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +</tr> +</table> + +</body> + +</html> diff --git a/doc/libogg/reference.html b/doc/libogg/reference.html new file mode 100644 index 0000000..eddb2af --- /dev/null +++ b/doc/libogg/reference.html @@ -0,0 +1,93 @@ +<html> + +<head> +<title>Libogg API Reference</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 - 20020719</p></td> +</tr> +</table> + +<h1>Libogg API Reference</h1> + +<p> +<b>Data Structures</b><br> +<a href="oggpack_buffer.html">oggpack_buffer</a><br> +<a href="ogg_page.html">ogg_page</a><br> +<a href="ogg_stream_state.html">ogg_stream_state</a><br> +<a href="ogg_packet.html">ogg_packet</a><br> +<a href="ogg_sync_state.html">ogg_sync_state</a><br> +<br> +<b>Bitpacking</b><br> +<a href="oggpack_writeinit.html">oggpack_writeinit()</a><br> +<a href="oggpack_reset.html">oggpack_reset()</a><br> +<a href="oggpack_writeclear.html">oggpack_writetrunc()</a><br> +<a href="oggpack_writeclear.html">oggpack_writealign()</a><br> +<a href="oggpack_writeclear.html">oggpack_writecopy()</a><br> +<a href="oggpack_writeclear.html">oggpack_writeclear()</a><br> +<a href="oggpack_readinit.html">oggpack_readinit()</a><br> +<a href="oggpack_write.html">oggpack_write()</a><br> +<a href="oggpack_look.html">oggpack_look()</a><br> +<a href="oggpack_look1.html">oggpack_look1()</a><br> +<a href="oggpack_adv.html">oggpack_adv()</a><br> +<a href="oggpack_adv1.html">oggpack_adv1()</a><br> +<a href="oggpack_read.html">oggpack_read()</a><br> +<a href="oggpack_read1.html">oggpack_read1()</a><br> +<a href="oggpack_bytes.html">oggpack_bytes()</a><br> +<a href="oggpack_bits.html">oggpack_bits()</a><br> +<a href="oggpack_get_buffer.html">oggpack_get_buffer()</a><br> +<br> +<b>Decoding-Related</b><br> +<a href="ogg_sync_init.html">ogg_sync_init()</a><br> +<a href="ogg_sync_clear.html">ogg_sync_clear()</a><br> +<a href="ogg_sync_destroy.html">ogg_sync_destroy()</a><br> +<a href="ogg_sync_reset.html">ogg_sync_reset()</a><br> +<a href="ogg_sync_buffer.html">ogg_sync_buffer()</a><br> +<a href="ogg_sync_wrote.html">ogg_sync_wrote()</a><br> +<a href="ogg_sync_pageseek.html">ogg_sync_pageseek()</a><br> +<a href="ogg_sync_pageout.html">ogg_sync_pageout()</a><br> +<a href="ogg_stream_pagein.html">ogg_stream_pagein()</a><br> +<a href="ogg_stream_packetout.html">ogg_stream_packetout()</a><br> +<a href="ogg_stream_packetpeek.html">ogg_stream_packetpeek()</a><br> +<br> +<b>Encoding-Related</b><br> +<a href="ogg_stream_packetin.html">ogg_stream_packetin()</a><br> +<a href="ogg_stream_pageout.html">ogg_stream_pageout()</a><br> +<a href="ogg_stream_flush.html">ogg_stream_flush()</a><br> +<br> +<b>General</b><br> +<a href="ogg_stream_init.html">ogg_stream_init()</a><br> +<a href="ogg_stream_clear.html">ogg_stream_clear()</a><br> +<a href="ogg_stream_reset.html">ogg_stream_reset()</a><br> +<a href="ogg_stream_reset_serialno.html">ogg_stream_reset_serialno()</a><br> +<a href="ogg_stream_destroy.html">ogg_stream_destroy()</a><br> +<a href="ogg_page_version.html">ogg_page_version()</a><br> +<a href="ogg_page_continued.html">ogg_page_continued()</a><br> +<a href="ogg_page_packets.html">ogg_page_packets()</a></br> +<a href="ogg_page_bos.html">ogg_page_bos()</a><br> +<a href="ogg_page_eos.html">ogg_page_eos()</a><br> +<a href="ogg_page_granulepos.html">ogg_page_granulepos()</a><br> +<a href="ogg_page_serialno.html">ogg_page_serialno()</a><br> +<a href="ogg_page_pageno.html">ogg_page_pageno()</a><br> +<a href="ogg_packet_clear.html">ogg_packet_clear()</a><br> +<a href="ogg_page_checksum_set.html">ogg_page_checksum_set()</a><br> +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2002 Xiph.org Foundation</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg - 20020719</p></td> +</tr> +</table> + +</body> + +</html> diff --git a/doc/libogg/style.css b/doc/libogg/style.css new file mode 100644 index 0000000..81cf417 --- /dev/null +++ b/doc/libogg/style.css @@ -0,0 +1,7 @@ +BODY { font-family: Helvetica, sans-serif } +TD { font-family: Helvetica, sans-serif } +P { font-family: Helvetica, sans-serif } +H1 { font-family: Helvetica, sans-serif } +H2 { font-family: Helvetica, sans-serif } +H4 { font-family: Helvetica, sans-serif } +P.tiny { font-size: 8pt } diff --git a/doc/libogg/vorbis_comment.html b/doc/libogg/vorbis_comment.html new file mode 100644 index 0000000..a7b076b --- /dev/null +++ b/doc/libogg/vorbis_comment.html @@ -0,0 +1,70 @@ +<html> + +<head> +<title>Vorbisfile - datatype - vorbis_comment</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>Vorbisfile documentation</p></td> +<td align=right><p class=tiny>libVorbisfile version 1.65 - 20020702</p></td> +</tr> +</table> + +<h1>vorbis_comment</h1> + +<p><i>declared in "vorbis/codec.h"</i></p> + +<p> +The vorbis_comment structure defines an Ogg Vorbis comment. +<p> +Only the fields the program needs must be defined. If a field isn't +defined by the application, it will either be blank (if it's a string value) +or set to some reasonable default (usually 0). +<p> + +<table border=0 width=100% color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b>typedef struct vorbis_comment{ + /* unlimited user comment fields. */ + char **user_comments; + int *comment_lengths; + int comments; + char *vendor; + +} vorbis_comment;</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>user_comments</i></dt> +<dd>Unlimited user comment array. The individual strings in the array are 8 bit clean, by the Vorbis specification, and as such the <tt>comment_lengths</tt> array should be consulted to determine string length. For convenience, each string is also NULL-terminated by the decode library (although Vorbis comments are not NULL terminated within the bitstream itself).</dd> +<dt><i>comment_lengths</i></dt> +<dd>An array that stores the length of each comment string</dd> +<dt><i>comments</i></dt> +<dd>number of user comments in user_comments field.</dd> +<dt><i>vendor</i></dt> +<dd>Information about the creator of the file. Stored in a standard C 0-terminated string.</dd> +</dl> + + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2002 Xiph.org Foundation</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td> +</tr><tr> +<td><p class=tiny>Vorbisfile documentation</p></td> +<td align=right><p class=tiny>libVorbisfile version 1.65 - 20020719</p></td> +</tr> +</table> + +</body> + +</html> diff --git a/doc/libogg/vorbis_info.html b/doc/libogg/vorbis_info.html new file mode 100644 index 0000000..893e453 --- /dev/null +++ b/doc/libogg/vorbis_info.html @@ -0,0 +1,80 @@ +<html> + +<head> +<title>Vorbisfile - datatype - vorbis_info</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>Vorbisfile documentation</p></td> +<td align=right><p class=tiny>libVorbisfile version 1.65 - 20020702</p></td> +</tr> +</table> + +<h1>vorbis_info</h1> + +<p><i>declared in "vorbis/codec.h"</i></p> + +<p> +The vorbis_info structure contains basic information about the audio in a vorbis bitstream. +<p> + +<table border=0 width=100% color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b>typedef struct vorbis_info{ + int version; + int channels; + long rate; + + long bitrate_upper; + long bitrate_nominal; + long bitrate_lower; + long bitrate_window; + + void *codec_setup; + +} vorbis_info;</b></pre> + </td> +</tr> +</table> + +<h3>Relevant Struct Members</h3> +<dl> +<dt><i>version</i></dt> +<dd>Vorbis encoder version used to create this bitstream.</dd> +<dt><i>channels</i></dt> +<dd>Int signifying number of channels in bitstream.</dd> +<dt><i>rate</i></dt> +<dd>Sampling rate of the bitstream.</dd> +<dt><i>bitrate_upper</i></dt> +<dd>Specifies the upper limit in a VBR bitstream. If the value matches the bitrate_nominal and bitrate_lower parameters, the stream is fixed bitrate. May be unset if no limit exists.</dd> +<dt><i>bitrate_nominal</i></dt> +<dd>Specifies the average bitrate for a VBR bitstream. May be unset. If the bitrate_upper and bitrate_lower parameters match, the stream is fixed bitrate.</dd> +<dt><i>bitrate_lower</i></dt> +<dd>Specifies the lower limit in a VBR bitstream. If the value matches the bitrate_nominal and bitrate_upper parameters, the stream is fixed bitrate. May be unset if no limit exists.</dd> +<dt><i>bitrate_window</i></dt> +<dd>Currently unset.</dd> + +<dt><i>codec_setup</i></dt> +<dd>Internal structure that contains the detailed/unpacked configuration for decoding the current Vorbis bitstream.</dd> +</dl> + + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2002 Xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td> +</tr><tr> +<td><p class=tiny>Vorbisfile documentation</p></td> +<td align=right><p class=tiny>libVorbisfile version 1.65 - 20020702</p></td> +</tr> +</table> + +</body> + +</html> |