forked from LosaDev/ls-2019-source
LosaDev source snapshot 2019
This commit is contained in:
LosaDev committed
commit
c198676e97
20588 files changed
+8812878
No files matched your search
@@ -0,0 +1,11 @@
|
||||
## Process this with automake to create Makefile.in
|
||||
|
||||
AUTOMAKE_OPTIONS = foreign
|
||||
|
||||
SUBDIRS = ogg
|
||||
|
||||
docdir = $(datadir)/doc/$(PACKAGE)-$(VERSION)
|
||||
|
||||
doc_DATA = index.html framing.html oggstream.html white-xifish.png stream.png white-ogg.png
|
||||
|
||||
EXTRA_DIST = $(doc_DATA)
|
||||
@@ -0,0 +1,395 @@
|
||||
<HTML><HEAD><TITLE>xiph.org: Ogg Vorbis documentation</TITLE>
|
||||
<BODY bgcolor="#ffffff" text="#202020" link="#006666" vlink="#000000">
|
||||
<nobr><a href="http://www.xiph.org/ogg/index.html"><img src="white-ogg.png" border=0><img
|
||||
src="vorbisword2.png" border=0></a></nobr><p>
|
||||
|
||||
<h1><font color=#000070>
|
||||
Ogg logical bitstream framing
|
||||
</font></h1>
|
||||
|
||||
<em>Last update to this document: July 14, 2002</em><br>
|
||||
|
||||
<h2>Ogg bitstreams</h2>
|
||||
|
||||
The Ogg transport bitstream is designed to provide framing, error
|
||||
protection and seeking structure for higher-level codec streams that
|
||||
consist of raw, unencapsulated data packets, such as the Vorbis audio
|
||||
codec or Tarkin video codec.
|
||||
|
||||
<h2>Application example: Vorbis</h2>
|
||||
Vorbis encodes short-time blocks of PCM data into raw packets of
|
||||
bit-packed data. These raw packets may be used directly by transport
|
||||
mechanisms that provide their own framing and packet-separation
|
||||
mechanisms (such as UDP datagrams). For stream based storage (such as
|
||||
files) and transport (such as TCP streams or pipes), Vorbis uses the
|
||||
Ogg bitstream format to provide framing/sync, sync recapture
|
||||
after error, landmarks during seeking, and enough information to
|
||||
properly separate data back into packets at the original packet
|
||||
boundaries without relying on decoding to find packet boundaries.<p>
|
||||
|
||||
<h2>Design constraints for Ogg bitstreams</h2>
|
||||
|
||||
<ol><li>True streaming; we must not need to seek to build a 100%
|
||||
complete bitstream.
|
||||
|
||||
<li> Use no more than approximately 1-2% of bitstream bandwidth for
|
||||
packet boundary marking, high-level framing, sync and seeking.
|
||||
|
||||
<li> Specification of absolute position within the original sample
|
||||
stream.
|
||||
|
||||
<li> Simple mechanism to ease limited editing, such as a simplified
|
||||
concatenation mechanism.
|
||||
|
||||
<li> Detection of corruption, recapture after error and direct, random
|
||||
access to data at arbitrary positions in the bitstream.
|
||||
</ol>
|
||||
|
||||
<h2>Logical and Physical Bitstreams</h2>
|
||||
|
||||
A <em>logical</em> Ogg bitstream is a contiguous stream of
|
||||
sequential pages belonging only to the logical bitstream. A
|
||||
<em>physical</em> Ogg bitstream is constructed from one or more
|
||||
than one logical Ogg bitstream (the simplest physical bitstream
|
||||
is simply a single logical bitstream). We describe below the exact
|
||||
formatting of an Ogg logical bitstream. Combining logical
|
||||
bitstreams into more complex physical bitstreams is described in the
|
||||
<a href="oggstream.html">Ogg bitstream overview</a>. The exact
|
||||
mapping of raw Vorbis packets into a valid Ogg Vorbis physical
|
||||
bitstream is described in <a href="vorbis-stream.html">Vorbis
|
||||
bitstream mapping</a>.
|
||||
|
||||
<h2>Bitstream structure</h2>
|
||||
|
||||
An Ogg stream is structured by dividing incoming packets into
|
||||
segments of up to 255 bytes and then wrapping a group of contiguous
|
||||
packet segments into a variable length page preceded by a page
|
||||
header. Both the header size and page size are variable; the page
|
||||
header contains sizing information and checksum data to determine
|
||||
header/page size and data integrity.<p>
|
||||
|
||||
The bitstream is captured (or recaptured) by looking for the beginning
|
||||
of a page, specifically the capture pattern. Once the capture pattern
|
||||
is found, the decoder verifies page sync and integrity by computing
|
||||
and comparing the checksum. At that point, the decoder can extract the
|
||||
packets themselves.<p>
|
||||
|
||||
<h3>Packet segmentation</h3>
|
||||
|
||||
Packets are logically divided into multiple segments before encoding
|
||||
into a page. Note that the segmentation and fragmentation process is a
|
||||
logical one; it's used to compute page header values and the original
|
||||
page data need not be disturbed, even when a packet spans page
|
||||
boundaries.<p>
|
||||
|
||||
The raw packet is logically divided into [n] 255 byte segments and a
|
||||
last fractional segment of < 255 bytes. A packet size may well
|
||||
consist only of the trailing fractional segment, and a fractional
|
||||
segment may be zero length. These values, called "lacing values" are
|
||||
then saved and placed into the header segment table.<p>
|
||||
|
||||
An example should make the basic concept clear:<p>
|
||||
|
||||
<pre>
|
||||
<tt>
|
||||
raw packet:
|
||||
___________________________________________
|
||||
|______________packet data__________________| 753 bytes
|
||||
|
||||
lacing values for page header segment table: 255,255,243
|
||||
</tt>
|
||||
</pre>
|
||||
|
||||
We simply add the lacing values for the total size; the last lacing
|
||||
value for a packet is always the value that is less than 255. Note
|
||||
that this encoding both avoids imposing a maximum packet size as well
|
||||
as imposing minimum overhead on small packets (as opposed to, eg,
|
||||
simply using two bytes at the head of every packet and having a max
|
||||
packet size of 32k. Small packets (<255, the typical case) are
|
||||
penalized with twice the segmentation overhead). Using the lacing
|
||||
values as suggested, small packets see the minimum possible
|
||||
byte-aligned overheade (1 byte) and large packets, over 512 bytes or
|
||||
so, see a fairly constant ~.5% overhead on encoding space.<p>
|
||||
|
||||
Note that a lacing value of 255 implies that a second lacing value
|
||||
follows in the packet, and a value of < 255 marks the end of the
|
||||
packet after that many additional bytes. A packet of 255 bytes (or a
|
||||
multiple of 255 bytes) is terminated by a lacing value of 0:<p>
|
||||
|
||||
<pre><tt>
|
||||
raw packet:
|
||||
_______________________________
|
||||
|________packet data____________| 255 bytes
|
||||
|
||||
lacing values: 255, 0
|
||||
</tt></pre>
|
||||
|
||||
Note also that a 'nil' (zero length) packet is not an error; it
|
||||
consists of nothing more than a lacing value of zero in the header.<p>
|
||||
|
||||
<h3>Packets spanning pages</h3>
|
||||
|
||||
Packets are not restricted to beginning and ending within a page,
|
||||
although individual segments are, by definition, required to do so.
|
||||
Packets are not restricted to a maximum size, although excessively
|
||||
large packets in the data stream are discouraged; the Ogg
|
||||
bitstream specification strongly recommends nominal page size of
|
||||
approximately 4-8kB (large packets are foreseen as being useful for
|
||||
initialization data at the beginning of a logical bitstream).<p>
|
||||
|
||||
After segmenting a packet, the encoder may decide not to place all the
|
||||
resulting segments into the current page; to do so, the encoder places
|
||||
the lacing values of the segments it wishes to belong to the current
|
||||
page into the current segment table, then finishes the page. The next
|
||||
page is begun with the first value in the segment table belonging to
|
||||
the next packet segment, thus continuing the packet (data in the
|
||||
packet body must also correspond properly to the lacing values in the
|
||||
spanned pages. The segment data in the first packet corresponding to
|
||||
the lacing values of the first page belong in that page; packet
|
||||
segments listed in the segment table of the following page must begin
|
||||
the page body of the subsequent page).<p>
|
||||
|
||||
The last mechanic to spanning a page boundary is to set the header
|
||||
flag in the new page to indicate that the first lacing value in the
|
||||
segment table continues rather than begins a packet; a header flag of
|
||||
0x01 is set to indicate a continued packet. Although mandatory, it
|
||||
is not actually algorithmically necessary; one could inspect the
|
||||
preceding segment table to determine if the packet is new or
|
||||
continued. Adding the information to the packet_header flag allows a
|
||||
simpler design (with no overhead) that needs only inspect the current
|
||||
page header after frame capture. This also allows faster error
|
||||
recovery in the event that the packet originates in a corrupt
|
||||
preceding page, implying that the previous page's segment table
|
||||
cannot be trusted.<p>
|
||||
|
||||
Note that a packet can span an arbitrary number of pages; the above
|
||||
spanning process is repeated for each spanned page boundary. Also a
|
||||
'zero termination' on a packet size that is an even multiple of 255
|
||||
must appear even if the lacing value appears in the next page as a
|
||||
zero-length continuation of the current packet. The header flag
|
||||
should be set to 0x01 to indicate that the packet spanned, even though
|
||||
the span is a nil case as far as data is concerned.<p>
|
||||
|
||||
The encoding looks odd, but is properly optimized for speed and the
|
||||
expected case of the majority of packets being between 50 and 200
|
||||
bytes (note that it is designed such that packets of wildly different
|
||||
sizes can be handled within the model; placing packet size
|
||||
restrictions on the encoder would have only slightly simplified design
|
||||
in page generation and increased overall encoder complexity).<p>
|
||||
|
||||
The main point behind tracking individual packets (and packet
|
||||
segments) is to allow more flexible encoding tricks that requiring
|
||||
explicit knowledge of packet size. An example is simple bandwidth
|
||||
limiting, implemented by simply truncating packets in the nominal case
|
||||
if the packet is arranged so that the least sensitive portion of the
|
||||
data comes last.<p>
|
||||
|
||||
<h3>Page header</h3>
|
||||
|
||||
The headering mechanism is designed to avoid copying and re-assembly
|
||||
of the packet data (ie, making the packet segmentation process a
|
||||
logical one); the header can be generated directly from incoming
|
||||
packet data. The encoder buffers packet data until it finishes a
|
||||
complete page at which point it writes the header followed by the
|
||||
buffered packet segments.<p>
|
||||
|
||||
<h4>capture_pattern</h4>
|
||||
|
||||
A header begins with a capture pattern that simplifies identifying
|
||||
pages; once the decoder has found the capture pattern it can do a more
|
||||
intensive job of verifying that it has in fact found a page boundary
|
||||
(as opposed to an inadvertent coincidence in the byte stream).<p>
|
||||
|
||||
<pre><tt>
|
||||
byte value
|
||||
|
||||
0 0x4f 'O'
|
||||
1 0x67 'g'
|
||||
2 0x67 'g'
|
||||
3 0x53 'S'
|
||||
</tt></pre>
|
||||
|
||||
<h4>stream_structure_version</h4>
|
||||
|
||||
The capture pattern is followed by the stream structure revision:
|
||||
|
||||
<pre><tt>
|
||||
byte value
|
||||
|
||||
4 0x00
|
||||
</tt></pre>
|
||||
|
||||
<h4>header_type_flag</h4>
|
||||
|
||||
The header type flag identifies this page's context in the bitstream:
|
||||
|
||||
<pre><tt>
|
||||
byte value
|
||||
|
||||
5 bitflags: 0x01: unset = fresh packet
|
||||
set = continued packet
|
||||
0x02: unset = not first page of logical bitstream
|
||||
set = first page of logical bitstream (bos)
|
||||
0x04: unset = not last page of logical bitstream
|
||||
set = last page of logical bitstream (eos)
|
||||
</tt></pre>
|
||||
|
||||
<h4>absolute granule position</h4>
|
||||
|
||||
(This is packed in the same way the rest of Ogg data is packed; LSb
|
||||
of LSB first. Note that the 'position' data specifies a 'sample'
|
||||
number (eg, in a CD quality sample is four octets, 16 bits for left
|
||||
and 16 bits for right; in video it would likely be the frame number.
|
||||
It is up to the specific codec in use to define the semantic meaning
|
||||
of the granule position value). The position specified is the total
|
||||
samples encoded after including all packets finished on this page
|
||||
(packets begun on this page but continuing on to the next page do not
|
||||
count). The rationale here is that the position specified in the
|
||||
frame header of the last page tells how long the data coded by the
|
||||
bitstream is. A truncated stream will still return the proper number
|
||||
of samples that can be decoded fully.
|
||||
<p>
|
||||
A special value of '-1' (in two's complement) indicates that no packets
|
||||
finish on this page.
|
||||
|
||||
<pre><tt>
|
||||
byte value
|
||||
|
||||
6 0xXX LSB
|
||||
7 0xXX
|
||||
8 0xXX
|
||||
9 0xXX
|
||||
10 0xXX
|
||||
11 0xXX
|
||||
12 0xXX
|
||||
13 0xXX MSB
|
||||
</tt></pre>
|
||||
|
||||
<h4>stream serial number</h4>
|
||||
|
||||
Ogg allows for separate logical bitstreams to be mixed at page
|
||||
granularity in a physical bitstream. The most common case would be
|
||||
sequential arrangement, but it is possible to interleave pages for
|
||||
two separate bitstreams to be decoded concurrently. The serial
|
||||
number is the means by which pages physical pages are associated with
|
||||
a particular logical stream. Each logical stream must have a unique
|
||||
serial number within a physical stream:
|
||||
|
||||
<pre><tt>
|
||||
byte value
|
||||
|
||||
14 0xXX LSB
|
||||
15 0xXX
|
||||
16 0xXX
|
||||
17 0xXX MSB
|
||||
</tt></pre>
|
||||
|
||||
<h4>page sequence no</h4>
|
||||
|
||||
Page counter; lets us know if a page is lost (useful where packets
|
||||
span page boundaries).
|
||||
|
||||
<pre><tt>
|
||||
byte value
|
||||
|
||||
18 0xXX LSB
|
||||
19 0xXX
|
||||
20 0xXX
|
||||
21 0xXX MSB
|
||||
</tt></pre>
|
||||
|
||||
<h4>page checksum</h4>
|
||||
|
||||
32 bit CRC value (direct algorithm, initial val and final XOR = 0,
|
||||
generator polynomial=0x04c11db7). The value is computed over the
|
||||
entire header (with the CRC field in the header set to zero) and then
|
||||
continued over the page. The CRC field is then filled with the
|
||||
computed value.<p>
|
||||
|
||||
(A thorough discussion of CRC algorithms can be found in <a
|
||||
href="ftp://ftp.rocksoft.com/clients/rocksoft/papers/crc_v3.txt">"A
|
||||
Painless Guide to CRC Error Detection Algorithms"</a> by Ross
|
||||
Williams <a
|
||||
href="mailto:[email protected]">[email protected]</a>.)
|
||||
|
||||
<pre><tt>
|
||||
byte value
|
||||
|
||||
22 0xXX LSB
|
||||
23 0xXX
|
||||
24 0xXX
|
||||
25 0xXX MSB
|
||||
</tt></pre>
|
||||
|
||||
<h4>page_segments</h4>
|
||||
|
||||
The number of segment entries to appear in the segment table. The
|
||||
maximum number of 255 segments (255 bytes each) sets the maximum
|
||||
possible physical page size at 65307 bytes or just under 64kB (thus
|
||||
we know that a header corrupted so as destroy sizing/alignment
|
||||
information will not cause a runaway bitstream. We'll read in the
|
||||
page according to the corrupted size information that's guaranteed to
|
||||
be a reasonable size regardless, notice the checksum mismatch, drop
|
||||
sync and then look for recapture).<p>
|
||||
|
||||
<pre><tt>
|
||||
byte value
|
||||
|
||||
26 0x00-0xff (0-255)
|
||||
</tt></pre>
|
||||
|
||||
<h4>segment_table (containing packet lacing values)</h4>
|
||||
|
||||
The lacing values for each packet segment physically appearing in
|
||||
this page are listed in contiguous order.
|
||||
|
||||
<pre><tt>
|
||||
byte value
|
||||
|
||||
27 0x00-0xff (0-255)
|
||||
[...]
|
||||
n 0x00-0xff (0-255, n=page_segments+26)
|
||||
</tt></pre>
|
||||
|
||||
Total page size is calculated directly from the known header size and
|
||||
lacing values in the segment table. Packet data segments follow
|
||||
immediately after the header.<p>
|
||||
|
||||
Page headers typically impose a flat .25-.5% space overhead assuming
|
||||
nominal ~8k page sizes. The segmentation table needed for exact
|
||||
packet recovery in the streaming layer adds approximately .5-1%
|
||||
nominal assuming expected encoder behavior in the 44.1kHz, 128kbps
|
||||
stereo encodings.<p>
|
||||
|
||||
<hr>
|
||||
<a href="http://www.xiph.org/">
|
||||
<img src="white-xifish.png" align=left border=0>
|
||||
</a>
|
||||
<font size=-2 color=#505050>
|
||||
|
||||
Ogg is a <a href="http://www.xiph.org">Xiph.org Foundation</a> effort
|
||||
to protect essential tenets of Internet multimedia from corporate
|
||||
hostage-taking; Open Source is the net's greatest tool to keep
|
||||
everyone honest. See <a href="http://www.xiph.org/about.html">About
|
||||
the Xiph.org Foundation</a> for details.
|
||||
<p>
|
||||
|
||||
Ogg Vorbis is the first Ogg audio CODEC. Anyone may freely use and
|
||||
distribute the Ogg and Vorbis specification, whether in a private,
|
||||
public or corporate capacity. However, the Xiph.org Foundation and
|
||||
the Ogg project (xiph.org) reserve the right to set the Ogg Vorbis
|
||||
specification and certify specification compliance.<p>
|
||||
|
||||
Xiph.org's Vorbis software CODEC implementation is distributed under a
|
||||
BSD-like license. This does not restrict third parties from
|
||||
distributing independent implementations of Vorbis software under
|
||||
other licenses.<p>
|
||||
|
||||
Ogg, Vorbis, Xiph.org Foundation and their logos are trademarks (tm)
|
||||
of the <a href="http://www.xiph.org/">Xiph.org Foundation</a>. These
|
||||
pages are copyright (C) 1994-2002 Xiph.org Foundation. All rights
|
||||
reserved.<p>
|
||||
|
||||
</body>
|
||||
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
<a href="oggstream.html">Ogg logical and physical bitstream overview</a><br>
|
||||
<a href="framing.html">Ogg logical bitstream framing</a><br>
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
## Process this file with automake to produce Makefile.in
|
||||
|
||||
AUTOMAKE_OPTIONS = foreign
|
||||
|
||||
docdir = $(datadir)/doc/$(PACKAGE)-$(VERSION)/ogg
|
||||
|
||||
doc_DATA = bitpacking.html datastructures.html decoding.html encoding.html\
|
||||
general.html index.html ogg_packet.html ogg_page.html\
|
||||
ogg_page_bos.html ogg_page_continued.html ogg_page_eos.html\
|
||||
ogg_page_granulepos.html ogg_page_pageno.html ogg_page_serialno.html\
|
||||
ogg_page_version.html ogg_stream_clear.html ogg_stream_destroy.html\
|
||||
ogg_page_packets.html ogg_stream_eos.html ogg_stream_flush.html\
|
||||
ogg_stream_init.html ogg_stream_packetin.html ogg_stream_packetout.html\
|
||||
ogg_stream_pagein.html ogg_stream_pageout.html ogg_stream_reset.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_writeclear.html oggpack_writeinit.html\
|
||||
overview.html reference.html style.css vorbis_comment.html\
|
||||
vorbis_info.html ogg_packet_clear.html ogg_page_checksum_set.html
|
||||
|
||||
EXTRA_DIST = $(doc_DATA)
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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_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_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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -0,0 +1,68 @@
|
||||
<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.0 - 20000615</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.</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.</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 that will be submitted to the decoding layer 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.</li>
|
||||
<li>1 in all other cases.</li>
|
||||
</ul>
|
||||
</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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -0,0 +1,67 @@
|
||||
<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>0 means that there is not enough data yet to form a page.</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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -0,0 +1,67 @@
|
||||
<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 - 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(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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -0,0 +1,63 @@
|
||||
<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.
|
||||
|
||||
<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>-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>
|
||||
<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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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:[email protected]">[email protected]</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>
|
||||
@@ -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 }
|
||||
@@ -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>
|
||||
@@ -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>
|
||||
@@ -0,0 +1,196 @@
|
||||
<HTML><HEAD><TITLE>xiph.org: Ogg Vorbis documentation</TITLE>
|
||||
<BODY bgcolor="#ffffff" text="#202020" link="#006666" vlink="#000000">
|
||||
<nobr><a href="http://www.xiph.org/ogg/index.html"><img src="white-ogg.png" border=0><img
|
||||
src="vorbisword2.png" border=0></a></nobr><p>
|
||||
|
||||
|
||||
<h1><font color=#000070>
|
||||
Ogg logical and physical bitstream overview
|
||||
</font></h1>
|
||||
|
||||
<em>Last update to this document: July 14, 2002</em><br>
|
||||
|
||||
<h2>Ogg bitstreams</h2>
|
||||
|
||||
Ogg codecs use octet vectors of raw, compressed data
|
||||
(<em>packets</em>). These compressed packets do not have any
|
||||
high-level structure or boundary information; strung together, they
|
||||
appear to be streams of random bytes with no landmarks.<p>
|
||||
|
||||
Raw packets may be used directly by transport mechanisms that provide
|
||||
their own framing and packet-separation mechanisms (such as UDP
|
||||
datagrams). For stream based storage (such as files) and transport
|
||||
(such as TCP streams or pipes), Vorbis and other future Ogg codecs use
|
||||
the Ogg bitstream format to provide framing/sync, sync recapture
|
||||
after error, landmarks during seeking, and enough information to
|
||||
properly separate data back into packets at the original packet
|
||||
boundaries without relying on decoding to find packet boundaries.<p>
|
||||
|
||||
<h2>Logical and physical bitstreams</h2>
|
||||
|
||||
Raw packets are grouped and encoded into contiguous pages of
|
||||
structured bitstream data called <em>logical bitstreams</em>. A
|
||||
logical bitstream consists of pages, in order, belonging to a single
|
||||
codec instance. Each page is a self contained entity (although it is
|
||||
possible that a packet may be split and encoded across one or more
|
||||
pages); that is, the page decode mechanism is designed to recognize,
|
||||
verify and handle single pages at a time from the overall bitstream.<p>
|
||||
|
||||
Multiple logical bitstreams can be combined (with restrictions) into a
|
||||
single <em>physical bitstream</em>. A physical bitstream consists of
|
||||
multiple logical bitstreams multiplexed at the page level and may
|
||||
include a 'meta-header' at the beginning of the multiplexed logical
|
||||
stream that serves as identification magic. Whole pages are taken in
|
||||
order from multiple logical bitstreams and combined into a single
|
||||
physical stream of pages. The decoder reconstructs the original
|
||||
logical bitstreams from the physical bitstream by taking the pages in
|
||||
order from the physical bitstream and redirecting them into the
|
||||
appropriate logical decoding entity. The simplest physical bitstream
|
||||
is a single, unmultiplexed logical bitstream with no meta-header; this
|
||||
is referred to as a 'degenerate stream'. <p>
|
||||
|
||||
<a href=framing.html>Ogg Logical Bitstream Framing</a> discusses
|
||||
the page format of an Ogg bitstream, the packet coding process
|
||||
and logical bitstreams in detail. The remainder of this document
|
||||
specifies requirements for constructing finished, physical Ogg
|
||||
bitstreams.<p>
|
||||
|
||||
<h2>Mapping Restrictions</h2>
|
||||
|
||||
Logical bitstreams may not be mapped/multiplexed into physical
|
||||
bitstreams without restriction. Here we discuss design restrictions
|
||||
on Ogg physical bitstreams in general, mostly to introduce
|
||||
design rationale. Each 'media' format defines its own (generally more
|
||||
restrictive) mapping. An '<a href="vorbis-ogg.html">Ogg Vorbis
|
||||
Audio Bitstream</a>', for example, has a <a
|
||||
href="vorbis-ogg.html">specific physical bitstream structure</a>.
|
||||
An 'Ogg A/V' bitstream (not currently specified) will also mandate a
|
||||
specific, restricted physical bitstream format.<p>
|
||||
|
||||
<h3>additional end-to-end structure</h3>
|
||||
|
||||
The <a href="framing.html">framing specification</a> defines
|
||||
'beginning of stream' and 'end of stream' page markers via a header
|
||||
flag (it is possible for a stream to consist of a single page). A
|
||||
stream always consists of an integer number of pages, an easy
|
||||
requirement given the variable size nature of pages.<p>
|
||||
|
||||
In addition to the header flag marking the first and last pages of a
|
||||
logical bitstream, the first page of an Ogg bitstream obeys
|
||||
additional restrictions. Each individual media mapping specifies its
|
||||
own implementation details regarding these restrictions.<p>
|
||||
|
||||
The first page of a logical Ogg bitstream consists of a single,
|
||||
small 'initial header' packet that includes sufficient information to
|
||||
identify the exact CODEC type and media requirements of the logical
|
||||
bitstream. The intent of this restriction is to simplify identifying
|
||||
the bitstream type and content; for a given media type (or across all
|
||||
Ogg media types) we can know that we only need a small, fixed
|
||||
amount of data to uniquely identify the bitstream type.<p>
|
||||
|
||||
As an example, Ogg Vorbis places the name and revision of the Vorbis
|
||||
CODEC, the audio rate and the audio quality into this initial header,
|
||||
thus simplifying vastly the certain identification of an Ogg Vorbis
|
||||
audio bitstream.<p>
|
||||
|
||||
<h3>sequential multiplexing (chaining)</h3>
|
||||
|
||||
The simplest form of logical bitstream multiplexing is concatenation
|
||||
(<em>chaining</em>). Complete logical bitstreams are strung
|
||||
one-after-another in order. The bitstreams do not overlap; the final
|
||||
page of a given logical bitstream is immediately followed by the
|
||||
initial page of the next. Chaining is the only logical->physical
|
||||
mapping allowed by Ogg Vorbis.<p>
|
||||
|
||||
Each chained logical bitstream must have a unique serial number within
|
||||
the scope of the physical bitstream.<p>
|
||||
|
||||
<h3>concurrent multiplexing (grouping)</h3>
|
||||
|
||||
Logical bitstreams may also be multiplexed 'in parallel'
|
||||
(<em>grouped</em>). An example of grouping would be to allow
|
||||
streaming of separate audio and video streams, using different codecs
|
||||
and different logical bitstreams, in the same physical bitstream.
|
||||
Whole pages from multiple logical bitstreams are mixed together.<p>
|
||||
|
||||
The initial pages of each logical bitstream must appear first; the
|
||||
media mapping specifies the order of the initial pages. For example,
|
||||
Ogg A/V will eventually specify an Ogg video bitstream with
|
||||
audio. The mapping may specify that the physical bitstream must begin
|
||||
with the initial page of a logical video bitstream, followed by the
|
||||
initial page of an audio stream. Unlike initial pages, terminal pages
|
||||
for the logical bitstreams need not all occur contiguously (although a
|
||||
specific media mapping may require this; it is not mandated by the
|
||||
generic Ogg stream spec). Terminal pages may be 'nil' pages,
|
||||
that is, pages containing no content but simply a page header with
|
||||
position information and the 'last page of bitstream' flag set in the
|
||||
page header.<p>
|
||||
|
||||
Each grouped bitstream must have a unique serial number within the
|
||||
scope of the physical bitstream.<p>
|
||||
|
||||
<h3>sequential and concurrent multiplexing</h3>
|
||||
|
||||
Groups of concurrently multiplexed bitstreams may be chained
|
||||
consecutively. Such a physical bitstream obeys all the rules of both
|
||||
grouped and chained multiplexed streams; the groups, when unchained ,
|
||||
must stand on their own as a valid concurrently multiplexed
|
||||
bitstream.<p>
|
||||
|
||||
<h3>multiplexing example</h3>
|
||||
|
||||
Below, we present an example of a grouped and chained bitstream:<p>
|
||||
|
||||
<img src=stream.png><p>
|
||||
|
||||
In this example, we see pages from five total logical bitstreams
|
||||
multiplexed into a physical bitstream. Note the following
|
||||
characteristics:
|
||||
|
||||
<ol><li>Grouped bitstreams begin together; all of the initial pages
|
||||
must appear before any data pages. When concurrently multiplexed
|
||||
groups are chained, the new group does not begin until all the
|
||||
bitstreams in the previous group have terminated.<p>
|
||||
|
||||
<li>The pages of concurrently multiplexed bitstreams need not conform
|
||||
to a regular order; the only requirement is that page <tt>n</tt> of a
|
||||
logical bitstream follow page <tt>n-1</tt> in the physical bitstream.
|
||||
There are no restrictions on intervening pages belonging to other
|
||||
logical bitstreams. (Tying page appearance to bitrate demands is one
|
||||
logical strategy, ie, the page appears at the chronological point
|
||||
where decode requires more information).
|
||||
|
||||
</ol>
|
||||
|
||||
<hr>
|
||||
<a href="http://www.xiph.org/">
|
||||
<img src="white-xifish.png" align=left border=0>
|
||||
</a>
|
||||
<font size=-2 color=#505050>
|
||||
|
||||
Ogg is a <a href="http://www.xiph.org">Xiph.org Foundation</a> effort
|
||||
to protect essential tenets of Internet multimedia from corporate
|
||||
hostage-taking; Open Source is the net's greatest tool to keep
|
||||
everyone honest. See <a href="http://www.xiph.org/about.html">About
|
||||
the Xiph.org Foundation</a> for details.
|
||||
<p>
|
||||
|
||||
Ogg Vorbis is the first Ogg audio CODEC. Anyone may freely use and
|
||||
distribute the Ogg and Vorbis specification, whether in a private,
|
||||
public or corporate capacity. However, the Xiph.org Foundation and
|
||||
the Ogg project (xiph.org) reserve the right to set the Ogg Vorbis
|
||||
specification and certify specification compliance.<p>
|
||||
|
||||
Xiph.org's Vorbis software CODEC implementation is distributed under a
|
||||
BSD-like license. This does not restrict third parties from
|
||||
distributing independent implementations of Vorbis software under
|
||||
other licenses.<p>
|
||||
|
||||
Ogg, Vorbis, Xiph.org Foundation and their logos are trademarks (tm)
|
||||
of the <a href="http://www.xiph.org/">Xiph.org Foundation</a>. These
|
||||
pages are copyright (C) 1994-2002 Xiph.org Foundation. All rights
|
||||
reserved.<p>
|
||||
|
||||
</body>
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 2.3 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.4 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 2.6 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 965 B |
Reference in new issue
Block a user