From 22a478dcb52dfcebe5ec4f3886410ef570de1065 Mon Sep 17 00:00:00 2001 From: Ralph Giles Date: Sat, 30 Jul 2005 23:43:51 +0000 Subject: Rename the libogg api doc directory to doc/libogg for greater clarity. git-svn-id: http://svn.xiph.org/trunk/ogg@9667 0101bb08-14d6-0310-b084-bc0e0c8e3800 --- doc/libogg/.cvsignore | 2 + doc/libogg/Makefile.am | 28 +++++++ doc/libogg/bitpacking.html | 99 ++++++++++++++++++++++++ doc/libogg/datastructures.html | 59 +++++++++++++++ doc/libogg/decoding.html | 100 ++++++++++++++++++++++++ doc/libogg/encoding.html | 64 ++++++++++++++++ doc/libogg/general.html | 105 ++++++++++++++++++++++++++ doc/libogg/index.html | 39 ++++++++++ doc/libogg/ogg_packet.html | 75 ++++++++++++++++++ doc/libogg/ogg_packet_clear.html | 62 +++++++++++++++ doc/libogg/ogg_page.html | 74 ++++++++++++++++++ doc/libogg/ogg_page_bos.html | 65 ++++++++++++++++ doc/libogg/ogg_page_checksum_set.html | 62 +++++++++++++++ doc/libogg/ogg_page_continued.html | 64 ++++++++++++++++ doc/libogg/ogg_page_eos.html | 65 ++++++++++++++++ doc/libogg/ogg_page_granulepos.html | 65 ++++++++++++++++ doc/libogg/ogg_page_packets.html | 75 ++++++++++++++++++ doc/libogg/ogg_page_pageno.html | 63 ++++++++++++++++ doc/libogg/ogg_page_serialno.html | 63 ++++++++++++++++ doc/libogg/ogg_page_version.html | 63 ++++++++++++++++ doc/libogg/ogg_stream_clear.html | 61 +++++++++++++++ doc/libogg/ogg_stream_destroy.html | 62 +++++++++++++++ doc/libogg/ogg_stream_eos.html | 62 +++++++++++++++ doc/libogg/ogg_stream_flush.html | 67 +++++++++++++++++ doc/libogg/ogg_stream_init.html | 66 ++++++++++++++++ doc/libogg/ogg_stream_packetin.html | 65 ++++++++++++++++ doc/libogg/ogg_stream_packetout.html | 71 ++++++++++++++++++ doc/libogg/ogg_stream_packetpeek.html | 85 +++++++++++++++++++++ doc/libogg/ogg_stream_pagein.html | 67 +++++++++++++++++ doc/libogg/ogg_stream_pageout.html | 66 ++++++++++++++++ doc/libogg/ogg_stream_reset.html | 61 +++++++++++++++ doc/libogg/ogg_stream_reset_serialno.html | 67 +++++++++++++++++ doc/libogg/ogg_stream_state.html | 121 ++++++++++++++++++++++++++++++ doc/libogg/ogg_sync_buffer.html | 67 +++++++++++++++++ doc/libogg/ogg_sync_clear.html | 62 +++++++++++++++ doc/libogg/ogg_sync_destroy.html | 62 +++++++++++++++ doc/libogg/ogg_sync_init.html | 63 ++++++++++++++++ doc/libogg/ogg_sync_pageout.html | 79 +++++++++++++++++++ doc/libogg/ogg_sync_pageseek.html | 68 +++++++++++++++++ doc/libogg/ogg_sync_reset.html | 63 ++++++++++++++++ doc/libogg/ogg_sync_state.html | 67 +++++++++++++++++ doc/libogg/ogg_sync_wrote.html | 73 ++++++++++++++++++ doc/libogg/oggpack_adv.html | 64 ++++++++++++++++ doc/libogg/oggpack_adv1.html | 62 +++++++++++++++ doc/libogg/oggpack_bits.html | 62 +++++++++++++++ doc/libogg/oggpack_buffer.html | 66 ++++++++++++++++ doc/libogg/oggpack_bytes.html | 62 +++++++++++++++ doc/libogg/oggpack_get_buffer.html | 62 +++++++++++++++ doc/libogg/oggpack_look.html | 66 ++++++++++++++++ doc/libogg/oggpack_look1.html | 63 ++++++++++++++++ doc/libogg/oggpack_read.html | 65 ++++++++++++++++ doc/libogg/oggpack_read1.html | 63 ++++++++++++++++ doc/libogg/oggpack_readinit.html | 64 ++++++++++++++++ doc/libogg/oggpack_reset.html | 62 +++++++++++++++ doc/libogg/oggpack_write.html | 68 +++++++++++++++++ doc/libogg/oggpack_writealign.html | 65 ++++++++++++++++ doc/libogg/oggpack_writeclear.html | 62 +++++++++++++++ doc/libogg/oggpack_writecopy.html | 69 +++++++++++++++++ doc/libogg/oggpack_writeinit.html | 62 +++++++++++++++ doc/libogg/oggpack_writetrunc.html | 65 ++++++++++++++++ doc/libogg/overview.html | 44 +++++++++++ doc/libogg/reference.html | 93 +++++++++++++++++++++++ doc/libogg/style.css | 7 ++ doc/libogg/vorbis_comment.html | 70 +++++++++++++++++ doc/libogg/vorbis_info.html | 80 ++++++++++++++++++++ 65 files changed, 4263 insertions(+) create mode 100644 doc/libogg/.cvsignore create mode 100644 doc/libogg/Makefile.am create mode 100644 doc/libogg/bitpacking.html create mode 100644 doc/libogg/datastructures.html create mode 100644 doc/libogg/decoding.html create mode 100644 doc/libogg/encoding.html create mode 100644 doc/libogg/general.html create mode 100644 doc/libogg/index.html create mode 100644 doc/libogg/ogg_packet.html create mode 100644 doc/libogg/ogg_packet_clear.html create mode 100644 doc/libogg/ogg_page.html create mode 100644 doc/libogg/ogg_page_bos.html create mode 100644 doc/libogg/ogg_page_checksum_set.html create mode 100644 doc/libogg/ogg_page_continued.html create mode 100644 doc/libogg/ogg_page_eos.html create mode 100644 doc/libogg/ogg_page_granulepos.html create mode 100644 doc/libogg/ogg_page_packets.html create mode 100644 doc/libogg/ogg_page_pageno.html create mode 100644 doc/libogg/ogg_page_serialno.html create mode 100644 doc/libogg/ogg_page_version.html create mode 100644 doc/libogg/ogg_stream_clear.html create mode 100644 doc/libogg/ogg_stream_destroy.html create mode 100644 doc/libogg/ogg_stream_eos.html create mode 100644 doc/libogg/ogg_stream_flush.html create mode 100644 doc/libogg/ogg_stream_init.html create mode 100644 doc/libogg/ogg_stream_packetin.html create mode 100644 doc/libogg/ogg_stream_packetout.html create mode 100644 doc/libogg/ogg_stream_packetpeek.html create mode 100644 doc/libogg/ogg_stream_pagein.html create mode 100644 doc/libogg/ogg_stream_pageout.html create mode 100644 doc/libogg/ogg_stream_reset.html create mode 100644 doc/libogg/ogg_stream_reset_serialno.html create mode 100644 doc/libogg/ogg_stream_state.html create mode 100644 doc/libogg/ogg_sync_buffer.html create mode 100644 doc/libogg/ogg_sync_clear.html create mode 100644 doc/libogg/ogg_sync_destroy.html create mode 100644 doc/libogg/ogg_sync_init.html create mode 100644 doc/libogg/ogg_sync_pageout.html create mode 100644 doc/libogg/ogg_sync_pageseek.html create mode 100644 doc/libogg/ogg_sync_reset.html create mode 100644 doc/libogg/ogg_sync_state.html create mode 100644 doc/libogg/ogg_sync_wrote.html create mode 100644 doc/libogg/oggpack_adv.html create mode 100644 doc/libogg/oggpack_adv1.html create mode 100644 doc/libogg/oggpack_bits.html create mode 100644 doc/libogg/oggpack_buffer.html create mode 100644 doc/libogg/oggpack_bytes.html create mode 100644 doc/libogg/oggpack_get_buffer.html create mode 100644 doc/libogg/oggpack_look.html create mode 100644 doc/libogg/oggpack_look1.html create mode 100644 doc/libogg/oggpack_read.html create mode 100644 doc/libogg/oggpack_read1.html create mode 100644 doc/libogg/oggpack_readinit.html create mode 100644 doc/libogg/oggpack_reset.html create mode 100644 doc/libogg/oggpack_write.html create mode 100644 doc/libogg/oggpack_writealign.html create mode 100644 doc/libogg/oggpack_writeclear.html create mode 100644 doc/libogg/oggpack_writecopy.html create mode 100644 doc/libogg/oggpack_writeinit.html create mode 100644 doc/libogg/oggpack_writetrunc.html create mode 100644 doc/libogg/overview.html create mode 100644 doc/libogg/reference.html create mode 100644 doc/libogg/style.css create mode 100644 doc/libogg/vorbis_comment.html create mode 100644 doc/libogg/vorbis_info.html (limited to 'doc/libogg') diff --git a/doc/libogg/.cvsignore b/doc/libogg/.cvsignore new file mode 100644 index 0000000..282522d --- /dev/null +++ b/doc/libogg/.cvsignore @@ -0,0 +1,2 @@ +Makefile +Makefile.in diff --git a/doc/libogg/Makefile.am b/doc/libogg/Makefile.am new file mode 100644 index 0000000..8a51188 --- /dev/null +++ b/doc/libogg/Makefile.am @@ -0,0 +1,28 @@ +## Process this file with automake to produce Makefile.in + +docdir = $(datadir)/doc/$(PACKAGE)-$(VERSION)/ogg + +doc_DATA = bitpacking.html datastructures.html decoding.html encoding.html\ + general.html index.html ogg_packet.html ogg_packet_clear.html\ + ogg_page.html ogg_page_bos.html ogg_page_checksum_set.html\ + ogg_page_continued.html ogg_page_eos.html ogg_page_granulepos.html\ + ogg_page_packets.html ogg_page_pageno.html ogg_page_serialno.html\ + ogg_page_version.html ogg_stream_clear.html ogg_stream_destroy.html\ + ogg_stream_eos.html ogg_stream_flush.html ogg_stream_init.html\ + ogg_stream_packetin.html ogg_stream_packetout.html\ + ogg_stream_packetpeek.html ogg_stream_pagein.html\ + ogg_stream_pageout.html ogg_stream_reset.html\ + ogg_stream_reset_serialno.html ogg_stream_state.html\ + ogg_sync_buffer.html ogg_sync_clear.html ogg_sync_destroy.html\ + ogg_sync_init.html ogg_sync_pageout.html ogg_sync_pageseek.html\ + ogg_sync_reset.html ogg_sync_state.html ogg_sync_wrote.html\ + oggpack_adv.html oggpack_adv1.html oggpack_bits.html\ + oggpack_buffer.html oggpack_bytes.html oggpack_get_buffer.html\ + oggpack_look.html oggpack_look1.html oggpack_read.html\ + oggpack_read1.html oggpack_readinit.html oggpack_reset.html\ + oggpack_write.html oggpack_writealign.html oggpack_writeclear.html\ + oggpack_writecopy.html oggpack_writeinit.html oggpack_writetrunc.html\ + overview.html reference.html style.css vorbis_comment.html\ + vorbis_info.html + +EXTRA_DIST = $(doc_DATA) diff --git a/doc/libogg/bitpacking.html b/doc/libogg/bitpacking.html new file mode 100644 index 0000000..57ff78a --- /dev/null +++ b/doc/libogg/bitpacking.html @@ -0,0 +1,99 @@ + + + +libogg - Bitpacking Functions + + + + + + + + + +

libogg documentation

libogg release 1.0 - 20000615

+ +

Bitpacking Functions

+

Libogg contains a basic bitpacking library that is useful for manipulating data within a buffer. +

+All the libogg specific functions are declared in "ogg/ogg.h". +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
functionpurpose
oggpack_writeinitInitializes a buffer for writing using this bitpacking library.
oggpack_resetClears and resets the buffer to the initial position.
oggpack_writeclearFrees the memory used by the buffer.
oggpack_readinitInitializes a buffer for reading using this bitpacking library.
oggpack_writeWrites bytes to the specified location within the buffer.
oggpack_lookLook at a specified number of bits, <=32, without advancing the location pointer.
oggpack_look1Looks at one bit without advancing the location pointer.
oggpack_advAdvances the location pointer by a specified number of bits.
oggpack_adv1Advances the location pointer by one bit.
oggpack_readReads a specified number of bits from the buffer.
oggpack_read1Reads one bit from the buffer.
oggpack_bytesReturns the total number of bytes contained within the buffer.
oggpack_bitsReturns the total number of bits contained within the buffer.
oggpack_get_bufferReturns a pointer to the buffer encapsulated within the oggpack_buffer struct.
+ +

+

+ + + + + + + + +

copyright © 2000 xiph.org

Ogg Vorbis
team@xiph.org

libogg documentation

libogg release 1.0 - 20000615

+ + + + diff --git a/doc/libogg/datastructures.html b/doc/libogg/datastructures.html new file mode 100644 index 0000000..13fee95 --- /dev/null +++ b/doc/libogg/datastructures.html @@ -0,0 +1,59 @@ + + + +libogg - Base Data Structures + + + + + + + + + +

libogg documentation

libogg release 1.0 - 20000615

+ +

Base Data Structures

+

Libogg uses several data structures to hold data and state information. +

+All the libogg specific data structures are declared in "ogg/ogg.h". +

+ + + + + + + + + + + + + + + + + + + + + + +
datatypepurpose
ogg_pageThis structure encapsulates data into one ogg bitstream page.
ogg_stream_stateThis structure contains current encode/decode data for a logical bitstream.
ogg_packetThis structure encapsulates the data and metadata for a single raw Ogg Vorbis packet.
ogg_sync_stateContains bitstream synchronization information.
+ +

+

+ + + + + + + + +

copyright © 2000 xiph.org

Ogg Vorbis
team@xiph.org

libogg documentation

libogg release 1.0 - 20000615

+ + + + diff --git a/doc/libogg/decoding.html b/doc/libogg/decoding.html new file mode 100644 index 0000000..2cd576e --- /dev/null +++ b/doc/libogg/decoding.html @@ -0,0 +1,100 @@ + + + +libogg - Decoding + + + + + + + + + +

libogg documentation

libogg release 1.0 - 20000615

+ +

Decoding

+

Libogg contains a set of functions used in the decoding process. +

+All the libogg specific functions are declared in "ogg/ogg.h". +

+

Decoding is based around the ogg synchronization layer. The ogg_sync_state 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. +

Decoding through the Ogg layer follows a specific logical sequence. A read loop follows these logical steps: +

+

In practice, streams are more complex, and Ogg also must handle headers, incomplete or dropped pages, and other errors in input. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
functionpurpose
ogg_sync_initInitializes an Ogg bitstream.
ogg_sync_clearClears the status information from the synchronization struct. +
ogg_sync_resetResets the synchronization status to initial values.
ogg_sync_destroyFrees the synchronization struct.
ogg_sync_bufferExposes a buffer from the synchronization layer in order to read data.
ogg_sync_wroteTells the synchronization layer how many bytes were written into the buffer.
ogg_sync_pageseekFinds the borders of pages and resynchronizes the stream.
ogg_sync_pageoutOutputs a page from the synchronization layer.
ogg_stream_pageinSubmits a complete page to the stream layer.
ogg_stream_packetoutOutputs a packet to the codec-specific decoding engine.
ogg_stream_packetpeekProvides access to the next packet in the bitstream without +advancing decoding.
+ +

+

+ + + + + + + + +

copyright © 2000 xiph.org

Ogg Vorbis
team@xiph.org

libogg documentation

libogg release 1.0 - 20000615

+ + + + diff --git a/doc/libogg/encoding.html b/doc/libogg/encoding.html new file mode 100644 index 0000000..372ea80 --- /dev/null +++ b/doc/libogg/encoding.html @@ -0,0 +1,64 @@ + + + +libogg - Encoding + + + + + + + + + +

libogg documentation

libogg release 1.0 - 20000615

+ +

Encoding

+

Libogg contains a set of functions used in the encoding process. +

+All the libogg specific functions are declared in "ogg/ogg.h". +

+

When encoding, the encoding engine will output raw packets which must be placed into an Ogg bitstream. +

Raw packets are inserted into the stream, and an ogg_page 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. +

There are a couple of basic steps: +

+

+ + + + + + + + + + + + + + + + +
functionpurpose
ogg_stream_packetinSubmits a raw packet to the streaming layer, so that it can be formed into a page.
ogg_stream_pageoutOutputs a completed page if the stream contains enough packets to form a full page. +
ogg_stream_flushForces any remaining packets in the stream to be returned as a page of any size. +
+ +

+
+ + + + + + + + +

copyright © 2000 xiph.org

Ogg Vorbis
team@xiph.org

libogg documentation

libogg release 1.0 - 20000615

+ + + + diff --git a/doc/libogg/general.html b/doc/libogg/general.html new file mode 100644 index 0000000..f8c92e9 --- /dev/null +++ b/doc/libogg/general.html @@ -0,0 +1,105 @@ + + + +libogg - General Functions + + + + + + + + + +

libogg documentation

libogg release 1.0 - 20000615

+ +

General Functions

+

Libogg contains several functions which are generally useful when using Ogg streaming, whether encoding or decoding. +

+All the libogg specific functions are declared in "ogg/ogg.h". +

+

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. +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
functionpurpose
ogg_stream_initInitializes an Ogg bitstream.
ogg_stream_clearClears the storage within the Ogg stream, but does not free the stream itself. +
ogg_stream_resetResets the stream status to its initial position.
ogg_stream_destroyFrees the entire Ogg stream.
ogg_stream_eosIndicates whether we are at the end of the stream.
ogg_page_versionReturns the version of ogg_page that this stream/page uses
ogg_page_continuedIndicates if the current page contains a continued packet from the last page.
ogg_page_packetsIndicates the number of packets contained in a page.
ogg_page_bosIndicates if the current page is the beginning of the stream.
ogg_page_eosIndicates if the current page is the end of the stream.
ogg_page_granuleposReturns the precise playback location of this page.
ogg_page_serialnoReturns the unique serial number of the logical bitstream associated with this page.
ogg_page_pagenoReturns the sequential page number for this page.
ogg_packet_clear + Clears the ogg_packet structure.
ogg_page_checksum_setChecksums an ogg_page.
+ +

+

+ + + + + + + + +

copyright © 2000 xiph.org

Ogg Vorbis
team@xiph.org

libogg documentation

libogg release 1.0 - 20000615

+ + + + diff --git a/doc/libogg/index.html b/doc/libogg/index.html new file mode 100644 index 0000000..123d965 --- /dev/null +++ b/doc/libogg/index.html @@ -0,0 +1,39 @@ + + + +libogg - Documentation + + + + + + + + + +

libogg documentation

libogg release 1.0 - 20000615

+ +

Libogg Documentation

+ +

+Libogg contains necessary functionality to create, decode, and work with Ogg bitstreams. +

This document explains how to use the libogg API in detail. +

+libogg api overview
+libogg api reference
+ +

+

+ + + + + + + + +

copyright © 2000 xiph.org

Ogg Vorbis
team@vorbis.org

libogg documentation

libogg release 1.0 - 20000615

+ + + + diff --git a/doc/libogg/ogg_packet.html b/doc/libogg/ogg_packet.html new file mode 100644 index 0000000..0dab54e --- /dev/null +++ b/doc/libogg/ogg_packet.html @@ -0,0 +1,75 @@ + + + +libogg - datatype - ogg_packet + + + + + + + + + +

libogg documentation

libogg - 20011015

+ +

ogg_packet

+ +

declared in "ogg/ogg.h"

+ +

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

+ + + + + +
+

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

Relevant Struct Members

+
+
packet
+
Pointer to the packet's data. This is treated as an opaque type by the ogg layer.
+
bytes
+
Indicates the size of the packet data in bytes. Packets can be of arbitrary size.
+
b_o_s
+
Flag indicating whether this packet begins a logical bitstream. 1 indicates this is the first packet, 0 indicates any other position in the stream.
+
e_o_s
+
Flag indicating whether this packet ends a bitstream. 1 indicates the last packet, 0 indicates any other position in the stream.
+
granulepos
+
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.
+
packetno
+
Sequential number of this packet in the ogg bitstream.
+
+ + +

+
+ + + + + + + + +

copyright © 2001 xiph.org foundation

Ogg Vorbis
team@xiph.org

libogg documentation

libogg - 20011015

+ + + + diff --git a/doc/libogg/ogg_packet_clear.html b/doc/libogg/ogg_packet_clear.html new file mode 100644 index 0000000..5e0bdf3 --- /dev/null +++ b/doc/libogg/ogg_packet_clear.html @@ -0,0 +1,62 @@ + + + +libogg - function - ogg_packet_clear + + + + + + + + + +

libogg documentation

libogg - 20011218

+ +

ogg_packet_clear

+ +

declared in "ogg/ogg.h";

+ +

This function clears the memory used by the ogg_packet struct, and frees the internal allocated memory, but does not free +the structure itself. +

+ + + + +
+

+int ogg_packet_clear(ogg_packet *op);
+
+
+ +

Parameters

+
+
os
+
Pointer to the ogg_packet struct to be cleared.
+
+ + +

Return Values

+
+
  • +None.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2001 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg - 20011218

    + + + + + diff --git a/doc/libogg/ogg_page.html b/doc/libogg/ogg_page.html new file mode 100644 index 0000000..8fdccc2 --- /dev/null +++ b/doc/libogg/ogg_page.html @@ -0,0 +1,74 @@ + + + +libogg - datatype - ogg_page + + + + + + + + + +

    libogg documentation

    libogg - 200011015

    + +

    ogg_page

    + +

    declared in "ogg/ogg.h"

    + +

    +The ogg_page struct encapsulates the data for an Ogg page. +

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

    +

    For a complete description of ogg pages and headers, please refer to the framing document. + + + + + +
    +
    
+typedef struct {
+  unsigned char *header;
+  long           header_len;
+  unsigned char *body;
+  long           body_len;
+} ogg_page;
+
    +
    + +

    Relevant Struct Members

    +
    +
    header
    +
    Pointer to the page header for this page. The exact contents of this header are defined in the framing spec document.
    +
    header_len
    +
    Length of the page header in bytes. +
    body
    +
    Pointer to the data for this page.
    +
    body_len
    +
    Length of the body data in bytes.
    +
    + + +

    +
    + + + + + + + + +

    copyright © 2001 xiph.org foundation

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg version - 20011015

    + + + + diff --git a/doc/libogg/ogg_page_bos.html b/doc/libogg/ogg_page_bos.html new file mode 100644 index 0000000..9e1462f --- /dev/null +++ b/doc/libogg/ogg_page_bos.html @@ -0,0 +1,65 @@ + + + +libogg - function - ogg_page_bos + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_page_bos

    + +

    declared in "ogg/ogg.h";

    + +

    Indicates whether this page is at the beginning of the logical bitstream. +

    +

    + + + + +
    +
    
+int ogg_page_bos(ogg_page *og);
+
+
    +
    + +

    Parameters

    +
    +
    og
    +
    Pointer to the current ogg_page struct.
    +
    + + +

    Return Values

    +
    +
  • +greater than 0 if this page is the beginning of a bitstream.
    • +
  • +0 if this page is from any other location in the stream.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_page_checksum_set.html b/doc/libogg/ogg_page_checksum_set.html new file mode 100644 index 0000000..72780d0 --- /dev/null +++ b/doc/libogg/ogg_page_checksum_set.html @@ -0,0 +1,62 @@ + + + +libogg - function - ogg_page_checksum_set + + + + + + + + + +

    libogg documentation

    libogg - 20011218

    + +

    ogg_page_checksum_set

    + +

    declared in "ogg/ogg.h";

    + +

    Checksums an ogg_page. +

    +

    + + + + +
    +
    
+int ogg_page_checksum_set(ogg_page *og);
+
+
    +
    + +

    Parameters

    +
    +
    og
    +
    Pointer to an ogg_page struct.
    +
    + + +

    Return Values

    +
    +None. +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2001 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg - 20011218

    + + + + + diff --git a/doc/libogg/ogg_page_continued.html b/doc/libogg/ogg_page_continued.html new file mode 100644 index 0000000..36adc09 --- /dev/null +++ b/doc/libogg/ogg_page_continued.html @@ -0,0 +1,64 @@ + + + +libogg - function - ogg_page_version + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_page_continued

    + +

    declared in "ogg/ogg.h";

    + +

    Indicates whether this page contains packet data which has been continued from the previous page. +

    + + + + +
    +
    
+int ogg_page_continued(ogg_page *og);
+
+
    +
    + +

    Parameters

    +
    +
    og
    +
    Pointer to the current ogg_page struct.
    +
    + + +

    Return Values

    +
    +
  • +1 if this page contains packet data continued from the last page.
    • +
  • +0 if this page does not contain continued data.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_page_eos.html b/doc/libogg/ogg_page_eos.html new file mode 100644 index 0000000..13747b5 --- /dev/null +++ b/doc/libogg/ogg_page_eos.html @@ -0,0 +1,65 @@ + + + +libogg - function - ogg_page_eos + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_page_eos

    + +

    declared in "ogg/ogg.h";

    + +

    Indicates whether this page is at the end of the logical bitstream. +

    +

    + + + + +
    +
    
+int ogg_page_eos(ogg_page *og);
+
+
    +
    + +

    Parameters

    +
    +
    og
    +
    Pointer to the current ogg_page struct.
    +
    + + +

    Return Values

    +
    +
  • +greater than zero if this page contains the end of a bitstream.
    • +
  • +0 if this page is from any other location in the stream.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_page_granulepos.html b/doc/libogg/ogg_page_granulepos.html new file mode 100644 index 0000000..50c5e45 --- /dev/null +++ b/doc/libogg/ogg_page_granulepos.html @@ -0,0 +1,65 @@ + + + +libogg - function - ogg_page_granulepos + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_page_granulepos

    + +

    declared in "ogg/ogg.h";

    + +

    Returns the exact granular position of the packet data contained at the end of this page. +

    This is useful for tracking location when seeking or decoding. +

    For example, in audio codecs this position is the pcm sample number and in video this is the frame number. +

    +

    + + + + +
    +
    
+int ogg_page_granulepos(ogg_page *og);
+
+
    +
    + +

    Parameters

    +
    +
    og
    +
    Pointer to the current ogg_page struct.
    +
    + + +

    Return Values

    +
    +
  • +n is the specific last granular position of the decoded data contained in the page.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_page_packets.html b/doc/libogg/ogg_page_packets.html new file mode 100644 index 0000000..e88724c --- /dev/null +++ b/doc/libogg/ogg_page_packets.html @@ -0,0 +1,75 @@ + + + +libogg - function - ogg_page_packets + + + + + + + + + +

    libogg documentation

    libogg - 20011218

    + +

    ogg_page_packets

    + +

    declared in "ogg/ogg.h";

    + +

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

    +

    + + + + +
    +
    
+int ogg_page_packets(ogg_page *og);
+
+
    +
    + +

    Parameters

    +
    +
    og
    +
    Pointer to the current ogg_page struct.
    +
    + + +

    Return Values

    +
    +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:
    +
    +ogg_page_packets(page) will return 1,
    +ogg_page_continued(paged) will return non-zero.
    +

    +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:
    +
    +ogg_page_packets(page) will return 0,
    +ogg_page_continued(page) will return non-zero.
    +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2001 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg - 20011218

    + + + + + diff --git a/doc/libogg/ogg_page_pageno.html b/doc/libogg/ogg_page_pageno.html new file mode 100644 index 0000000..0eca7af --- /dev/null +++ b/doc/libogg/ogg_page_pageno.html @@ -0,0 +1,63 @@ + + + +libogg - function - ogg_page_pageno + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_page_pageno

    + +

    declared in "ogg/ogg.h";

    + +

    Returns the sequential page number. +

    This is useful for ordering pages or determining when pages have been lost. +

    + + + + +
    +
    
+int ogg_page_pageno(ogg_page *og);
+
+
    +
    + +

    Parameters

    +
    +
    og
    +
    Pointer to the current ogg_page struct.
    +
    + + +

    Return Values

    +
    +
  • +n is the page number for this page.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_page_serialno.html b/doc/libogg/ogg_page_serialno.html new file mode 100644 index 0000000..60305a9 --- /dev/null +++ b/doc/libogg/ogg_page_serialno.html @@ -0,0 +1,63 @@ + + + +libogg - function - ogg_page_serialno + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_page_serialno

    + +

    declared in "ogg/ogg.h";

    + +

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

    +

    + + + + +
    +
    
+int ogg_page_serialno(ogg_page *og);
+
+
    +
    + +

    Parameters

    +
    +
    og
    +
    Pointer to the current ogg_page struct.
    +
    + + +

    Return Values

    +
    +
  • +n is the serial number for this page.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_page_version.html b/doc/libogg/ogg_page_version.html new file mode 100644 index 0000000..9f3c383 --- /dev/null +++ b/doc/libogg/ogg_page_version.html @@ -0,0 +1,63 @@ + + + +libogg - function - ogg_page_version + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_page_version

    + +

    declared in "ogg/ogg.h";

    + +

    This function returns the version of ogg_page used in this page. +

    In current versions of libogg, all ogg_page structs have the same version, so 0 should always be returned. +

    + + + + +
    +
    
+int ogg_page_version(ogg_page *og);
+
+
    +
    + +

    Parameters

    +
    +
    og
    +
    Pointer to the current ogg_page struct.
    +
    + + +

    Return Values

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

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_stream_clear.html b/doc/libogg/ogg_stream_clear.html new file mode 100644 index 0000000..a261a5d --- /dev/null +++ b/doc/libogg/ogg_stream_clear.html @@ -0,0 +1,61 @@ + + + +libogg - function - ogg_stream_clear + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_stream_clear

    + +

    declared in "ogg/ogg.h";

    + +

    This function clears the memory used by the ogg_stream_state struct, but does not free it. +

    + + + + +
    +
    
+int ogg_stream_clear(ogg_stream_state *os);
+
    +
    + +

    Parameters

    +
    +
    os
    +
    Pointer to the ogg_stream_state struct to be cleared.
    +
    + + +

    Return Values

    +
    +
  • +0 is always returned.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_stream_destroy.html b/doc/libogg/ogg_stream_destroy.html new file mode 100644 index 0000000..ebe7a24 --- /dev/null +++ b/doc/libogg/ogg_stream_destroy.html @@ -0,0 +1,62 @@ + + + +libogg - function - ogg_stream_destroy + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_stream_destroy

    + +

    declared in "ogg/ogg.h";

    + +

    This function frees the memory used by the ogg_stream_state struct. +

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

    + + + + +
    +
    
+int ogg_stream_destroy(ogg_stream_state *os);
+
    +
    + +

    Parameters

    +
    +
    os
    +
    Pointer to the ogg_stream_state struct to be destroyed.
    +
    + + +

    Return Values

    +
    +
  • +0 is always returned.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_stream_eos.html b/doc/libogg/ogg_stream_eos.html new file mode 100644 index 0000000..40e577e --- /dev/null +++ b/doc/libogg/ogg_stream_eos.html @@ -0,0 +1,62 @@ + + + +libogg - function - ogg_stream_eos + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_stream_eos

    + +

    declared in "ogg/ogg.h";

    + +

    This function indicates whether we have reached the end of the stream or not. +

    + + + + +
    +
    
+int ogg_stream_eos(ogg_stream_state *os);
+
    +
    + +

    Parameters

    +
    +
    os
    +
    Pointer to the current ogg_stream_state struct.
    +
    + + +

    Return Values

    +
    +
  • 1 if we are at the end of the stream.
    • +
  • +0 if we have not yet reached the end of the stream.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_stream_flush.html b/doc/libogg/ogg_stream_flush.html new file mode 100644 index 0000000..05d75fb --- /dev/null +++ b/doc/libogg/ogg_stream_flush.html @@ -0,0 +1,67 @@ + + + +libogg - function - ogg_stream_flush + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_stream_flush

    + +

    declared in "ogg/ogg.h";

    + +

    This function checks for remaining packets inside the stream and forces remaining packets into a page, regardless of the size of the page. +

    This should only be used when you want to flush an undersized page from the middle of the stream. Otherwise, ogg_stream_pageout should always be used. +

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

    + + + + +
    +
    
+int ogg_stream_flush(ogg_stream_state *os, ogg_page *og);
+
    +
    + +

    Parameters

    +
    +
    os
    +
    Pointer to a previously declared ogg_stream_state struct, which represents the current logical bitstream.
    +
    og
    +
    Pointer to a page of data. The remaining packets in the stream will be placed into this page, if any remain. +
    + + +

    Return Values

    +
    +
  • 0 means that all packet data has already been flushed into pages, and there are no packets to put into the page.
    • +
  • +Nonzero means that remaining packets have successfully been flushed into the page.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_stream_init.html b/doc/libogg/ogg_stream_init.html new file mode 100644 index 0000000..4f600ff --- /dev/null +++ b/doc/libogg/ogg_stream_init.html @@ -0,0 +1,66 @@ + + + +libogg - function - ogg_stream_init + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_stream_init

    + +

    declared in "ogg/ogg.h";

    + +

    This function is used to initialize an ogg_stream_state struct and allocates appropriate memory in preparation for encoding or decoding. +

    It also assigns the stream a given serial number. +

    + + + + +
    +
    
+int ogg_stream_init(ogg_stream_state *os,int serialno);
+
    +
    + +

    Parameters

    +
    +
    os
    +
    Pointer to the ogg_stream_state struct that we will be initializing.
    +
    serialno
    +
    Serial number that we will attach to this stream.
    +
    + + +

    Return Values

    +
    +
  • +0 if successful
    • +
  • +-1 if unsuccessful. If this fails, the ogg_stream_state was not properly declared before calling this function.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_stream_packetin.html b/doc/libogg/ogg_stream_packetin.html new file mode 100644 index 0000000..c1018dc --- /dev/null +++ b/doc/libogg/ogg_stream_packetin.html @@ -0,0 +1,65 @@ + + + +libogg - function - ogg_stream_packetin + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_stream_packetin

    + +

    declared in "ogg/ogg.h";

    + +

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

    In a typical decoding situation, this should be used after filling a packet with data + +

    + + + + +
    +
    
+int ogg_stream_packetin(ogg_stream_state *os,ogg_packet *op);
+
    +
    + +

    Parameters

    +
    +
    os
    +
    Pointer to a previously declared ogg_stream_state struct.
    +
    op
    +
    Pointer to the packet we are putting into the bitstream. +
    + + +

    Return Values

    +
    +
  • +0 is always returned.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_stream_packetout.html b/doc/libogg/ogg_stream_packetout.html new file mode 100644 index 0000000..bc57e85 --- /dev/null +++ b/doc/libogg/ogg_stream_packetout.html @@ -0,0 +1,71 @@ + + + +libogg - function - ogg_stream_packetout + + + + + + + + + +

    libogg documentation

    libogg release 1.1.3 - 20040927

    + +

    ogg_stream_packetout

    + +

    declared in "ogg/ogg.h";

    + +

    This function assembles a raw data packet for output to the codec decoding engine. The data is already in the stream and broken into packet segments. Each successive call returns the next complete packet built from those segments.

    +

    In a typical decoding situation, this should be used after calling ogg_stream_pagein() to submit a page of data to the bitstream. If the function returns 0, more data is needed and another page should be submitted. A non-zero return value indicates successful return of a packet.

    + +

    + + + + +
    +
    
+int ogg_stream_packetout(ogg_stream_state *os,ogg_packet *op);
+
    +
    + +

    Parameters

    +
    +
    os
    +
    Pointer to a previously declared ogg_stream_state struct. Before this function is called, an ogg_page should be submitted to the stream using ogg_stream_pagein().
    +
    op
    +
    Pointer to the packet to be filled in with pointers to the new data. +This will typically be submitted to a codec for decode after this +function is called.
    +
    + + +

    Return Values

    +
    + +
    + +

    + +
    + + + + + + + + + +

    copyright © 2004 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.1.3 - 20040927

    + + + + diff --git a/doc/libogg/ogg_stream_packetpeek.html b/doc/libogg/ogg_stream_packetpeek.html new file mode 100644 index 0000000..892977b --- /dev/null +++ b/doc/libogg/ogg_stream_packetpeek.html @@ -0,0 +1,85 @@ + + + +libogg - function - ogg_stream_packetpeek + + + + + + + + + +

    libogg documentation

    libogg version 1.26 - 20010527

    + +

    ogg_stream_packetout

    + +

    declared in "ogg/ogg.h";

    + +

    This function attempts to assemble a raw data packet and returns +it without advancing decoding.

    + +

    In a typical situation, this would be called +speculatively after ogg_stream_pagein() 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 +ogg_stream_packetout().

    + +

    + + + + + +
    +
    
+int ogg_stream_packetpeek(ogg_stream_state *os,ogg_packet *op);
+
    +
    + +

    Parameters

    +
    +
    os
    +
    Pointer to a previously declared +ogg_stream_state struct. Before this +function is called, an ogg_page should be +submitted to the stream using +ogg_stream_pagein().
    +
    op
    +
    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.
    +
    + + +

    Return Values

    +
    + +
    + + +

    + +
    + + + + + + + + + +

    copyright © 2001 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg version 1.26 - 20010527

    + + + + + diff --git a/doc/libogg/ogg_stream_pagein.html b/doc/libogg/ogg_stream_pagein.html new file mode 100644 index 0000000..b884169 --- /dev/null +++ b/doc/libogg/ogg_stream_pagein.html @@ -0,0 +1,67 @@ + + + +libogg - function - ogg_stream_pagein + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_stream_pagein

    + +

    declared in "ogg/ogg.h";

    + +

    This function adds a complete page to the bitstream. +

    In a typical decoding situation, this function would be called after using ogg_sync_pageout to create a valid ogg_page struct. +

    Internally, this function breaks the page into packet segments in preparation for outputting a valid packet to the codec decoding layer. + +

    + + + + +
    +
    
+int ogg_stream_pagein(ogg_stream_state *os, ogg_page *og);
+
    +
    + +

    Parameters

    +
    +
    os
    +
    Pointer to a previously declared ogg_stream struct, which represents the current logical bitstream.
    +
    og
    +
    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. +
    + + +

    Return Values

    +
    +
  • -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.
    • +
  • +0 means that the page was successfully submitted to the bitstream.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_stream_pageout.html b/doc/libogg/ogg_stream_pageout.html new file mode 100644 index 0000000..c703382 --- /dev/null +++ b/doc/libogg/ogg_stream_pageout.html @@ -0,0 +1,66 @@ + + + +libogg - function - ogg_stream_pageout + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_stream_pageout

    + +

    declared in "ogg/ogg.h";

    + +

    This function forms packets into pages. If +

    In a typical encoding situation, this would be called after using ogg_stream_packetin to submit data packets to the bitstream. +

    Internally, this function breaks the page into packet segments in preparation for outputting a valid packet to the codec decoding layer. + +

    + + + + +
    +
    
+int ogg_stream_pageout(ogg_stream_state *os, ogg_page *og);
+
    +
    + +

    Parameters

    +
    +
    os
    +
    Pointer to a previously declared ogg_stream struct, which represents the current logical bitstream.
    +
    og
    +
    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. +
    + + +

    Return Values

    +
    +
  • Zero means that insufficient data has accumulated to fill a page.
    • +
  • Non-zero means that a page has been completed and flushed.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_stream_reset.html b/doc/libogg/ogg_stream_reset.html new file mode 100644 index 0000000..19634d4 --- /dev/null +++ b/doc/libogg/ogg_stream_reset.html @@ -0,0 +1,61 @@ + + + +libogg - function - ogg_stream_reset + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_stream_reset

    + +

    declared in "ogg/ogg.h";

    + +

    This function sets values in the ogg_stream_state struct back to initial values. +

    + + + + +
    +
    
+int ogg_stream_reset(ogg_stream_state *os);
+
    +
    + +

    Parameters

    +
    +
    os
    +
    Pointer to the ogg_stream_state struct to be cleared.
    +
    + + +

    Return Values

    +
    +
  • +0 is always returned.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_stream_reset_serialno.html b/doc/libogg/ogg_stream_reset_serialno.html new file mode 100644 index 0000000..d75fdb3 --- /dev/null +++ b/doc/libogg/ogg_stream_reset_serialno.html @@ -0,0 +1,67 @@ + + + +libogg - function - ogg_stream_reset_serialno + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20020719

    + +

    ogg_stream_reset

    + +

    declared in "ogg/ogg.h";

    + +

    This function reinitializes the values in the +ogg_stream_state, +just like ogg_stream_reset(). +Additionally, it sets the stream serial number to the given value.

    + +

    + + + + +
    +
    
+int ogg_stream_reset_serialno(ogg_stream_state *os, int serialno);
+
    +
    + +

    Parameters

    +
    +
    os
    +
    Pointer to the ogg_stream_state struct to be cleared.
    +
    serialno
    +
    New stream serial number to use
    +
    + + +

    Return Values

    +
    +
  • +0 is always returned.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2002 Xiph.org Foundation

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20020719

    + + + + + diff --git a/doc/libogg/ogg_stream_state.html b/doc/libogg/ogg_stream_state.html new file mode 100644 index 0000000..7f41737 --- /dev/null +++ b/doc/libogg/ogg_stream_state.html @@ -0,0 +1,121 @@ + + + +libogg - datatype - ogg_stream_state + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_stream_state

    + +

    declared in "ogg/ogg.h"

    + +

    +The ogg_stream_state struct tracks the current encode/decode state of the current logical bitstream. +

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

    Relevant Struct Members

    +
    +
    body_data
    +
    Pointer to data from packet bodies.
    +
    body_storage
    +
    Storage allocated for bodies in bytes (filled or unfilled).
    +
    body_fill
    +
    Amount of storage filled with stored packet bodies.
    +
    body_returned
    +
    Number of elements returned from storage.
    +
    lacing_vals
    +
    String of lacing values for the packet segments within the current page. Each value is a byte, indicating packet segment length.
    +
    granule_vals
    +
    Pointer to the lacing values for the packet segments within the current page.
    +
    lacing_storage
    +
    Total amount of storage (in bytes) allocated for storing lacing values.
    +
    lacing_fill
    +
    Fill marker for the current vs. total allocated storage of lacing values for the page.
    +
    lacing_packet
    +
    Lacing value for current packet segment.
    +
    lacing_returned
    +
    Number of lacing values returned from lacing_storage.
    +
    header
    +
    Temporary storage for page header during encode process, while the header is being created.
    +
    header_fill
    +
    Fill marker for header storage allocation. Used during the header creation process.
    +
    e_o_s
    +
    Marker set when the last packet of the logical bitstream has been buffered.
    +
    b_o_s
    +
    Marker set after we have written the first page in the logical bitstream.
    +
    serialno
    +
    Serial number of this logical bitstream.
    +
    pageno
    +
    Number of the current page within the stream.
    +
    packetno
    +
    Number of the current packet.
    +
    granulepos
    +
    Exact position of decoding/encoding process.
    +
    + + +

    +
    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + diff --git a/doc/libogg/ogg_sync_buffer.html b/doc/libogg/ogg_sync_buffer.html new file mode 100644 index 0000000..4c84694 --- /dev/null +++ b/doc/libogg/ogg_sync_buffer.html @@ -0,0 +1,67 @@ + + + +libogg - function - ogg_sync_buffer + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_sync_buffer

    + +

    declared in "ogg/ogg.h";

    + +

    This function is used to provide a properly-sized buffer for writing. +

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

    The buffer exposed by this function is empty internal storage from the ogg_sync_state struct, beginning at the fill mark within the struct. +

    A pointer to this buffer is returned to be used by the calling application. + +

    + + + + +
    +
    
+char *ogg_sync_buffer(ogg_sync_state *oy, long size);
+
    +
    + +

    Parameters

    +
    +
    oy
    +
    Pointer to a previously declared ogg_sync_state struct.
    +
    size
    +
    Size of the desired buffer. The actual size of the buffer returned will be this size plus some extra bytes (currently 4096). +
    + + +

    Return Values

    +
    +
  • +Returns a pointer to the newly allocated buffer.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_sync_clear.html b/doc/libogg/ogg_sync_clear.html new file mode 100644 index 0000000..325e856 --- /dev/null +++ b/doc/libogg/ogg_sync_clear.html @@ -0,0 +1,62 @@ + + + +libogg - function - ogg_sync_clear + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_sync_clear

    + +

    declared in "ogg/ogg.h";

    + +

    This function is used to free the internal storage of an ogg_sync_state struct and resets the struct to the initial state. To free the entire struct, ogg_sync_destroy should be used instead. In situations where the struct needs to be reset but the internal storage does not need to be freed, ogg_sync_reset should be used. + +

    + + + + +
    +
    
+int ogg_sync_clear(ogg_sync_state *oy);
+
    +
    + +

    Parameters

    +
    +
    oy
    +
    Pointer to a previously declared ogg_sync_state struct.
    +
    + + +

    Return Values

    +
    +
  • +0 is always returned.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_sync_destroy.html b/doc/libogg/ogg_sync_destroy.html new file mode 100644 index 0000000..d2f9ae8 --- /dev/null +++ b/doc/libogg/ogg_sync_destroy.html @@ -0,0 +1,62 @@ + + + +libogg - function - ogg_sync_destroy + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_sync_destroy

    + +

    declared in "ogg/ogg.h";

    + +

    This function is used to destroy an ogg_sync_state struct and free all memory used. + +

    + + + + +
    +
    
+int ogg_sync_destroy(ogg_sync_state *oy);
+
    +
    + +

    Parameters

    +
    +
    oy
    +
    Pointer to a previously declared ogg_sync_state struct.
    +
    + + +

    Return Values

    +
    +
  • +0 is always returned.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_sync_init.html b/doc/libogg/ogg_sync_init.html new file mode 100644 index 0000000..f42c81d --- /dev/null +++ b/doc/libogg/ogg_sync_init.html @@ -0,0 +1,63 @@ + + + +libogg - function - ogg_sync_init + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_sync_init

    + +

    declared in "ogg/ogg.h";

    + +

    This function is used to initialize an ogg_sync_state struct to a known initial value in preparation for manipulation of an Ogg bitstream. +

    The ogg_sync struct is important when decoding, as it synchronizes retrieval and return of data. + +

    + + + + +
    +
    
+int ogg_sync_init(ogg_sync_state *oy);
+
    +
    + +

    Parameters

    +
    +
    oy
    +
    Pointer to a previously declared ogg_sync_state struct. After this function call, this struct has been initialized.
    +
    + + +

    Return Values

    +
    +
  • +0 is always returned.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_sync_pageout.html b/doc/libogg/ogg_sync_pageout.html new file mode 100644 index 0000000..4fcdb17 --- /dev/null +++ b/doc/libogg/ogg_sync_pageout.html @@ -0,0 +1,79 @@ + + + +libogg - function - ogg_sync_pageout + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_sync_pageout

    + +

    declared in "ogg/ogg.h";

    + +

    This function takes the data stored in the buffer of the ogg_sync_state struct and inserts them into an ogg_page. + +

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

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

    + + + + +
    +
    
+int ogg_sync_pageout(ogg_sync_state *oy, ogg_page *og);
+
    +
    + +

    Parameters

    +
    +
    oy
    +
    Pointer to a previously declared ogg_sync_state struct. Normally, the internal storage of this struct should be filled with newly read data and verified using ogg_sync_wrote.
    +
    og
    +
    Pointer to page struct filled by this function. +
    + + +

    Return Values

    +
    +
  • -1 if we were not properly synced and had to skip some bytes.
    • +
  • +0 if we need more data to verify a page.
    • +
  • +1 if we have a page.
    • +
    +

    + +

    Example Usage

    +
    +if (ogg_sync_pageout(&oy, &og) != 1) {
+	buffer = ogg_sync_buffer(&oy, 8192);
+	bytes = fread(buffer, 1, 8192, stdin);
+	ogg_sync_wrote(&oy, bytes);
+}
+
    + +

    +
    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_sync_pageseek.html b/doc/libogg/ogg_sync_pageseek.html new file mode 100644 index 0000000..7371b82 --- /dev/null +++ b/doc/libogg/ogg_sync_pageseek.html @@ -0,0 +1,68 @@ + + + +libogg - function - ogg_sync_pageseek + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_sync_pageseek

    + +

    declared in "ogg/ogg.h";

    + +

    This function synchronizes the ogg_sync_state struct to the next ogg_page. +

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

    + + + + +
    +
    
+int ogg_sync_pageseek(ogg_sync_state *oy, ogg_page *og);
+
    +
    + +

    Parameters

    +
    +
    oy
    +
    Pointer to a previously declared ogg_sync_state struct.
    +
    og
    +
    Pointer to a page (or an incomplete page) of data. This is the page we are attempting to sync. +
    + + +

    Return Values

    +
    +
  • -n means that we skipped n bytes within the bitstream.
    • +
  • +0 means that the page isn't ready and we need more data. No bytes have been skipped.
    • +
  • +n means that the page was synced at the current location, with a page length of n bytes. +
    • +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_sync_reset.html b/doc/libogg/ogg_sync_reset.html new file mode 100644 index 0000000..d27efbd --- /dev/null +++ b/doc/libogg/ogg_sync_reset.html @@ -0,0 +1,63 @@ + + + +libogg - function - ogg_sync_reset + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_sync_reset

    + +

    declared in "ogg/ogg.h";

    + +

    This function is used to reset the internal counters of the ogg_sync_state struct to initial values. +

    It is a good idea to call this before seeking within a bitstream. + +

    + + + + +
    +
    
+int ogg_sync_reset(ogg_sync_state *oy);
+
    +
    + +

    Parameters

    +
    +
    oy
    +
    Pointer to a previously declared ogg_sync_state struct.
    +
    + + +

    Return Values

    +
    +
  • +0 is always returned.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/ogg_sync_state.html b/doc/libogg/ogg_sync_state.html new file mode 100644 index 0000000..15a7e3c --- /dev/null +++ b/doc/libogg/ogg_sync_state.html @@ -0,0 +1,67 @@ + + + +libogg - datatype - ogg_sync_state + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_sync_state

    + +

    declared in "ogg/ogg.h"

    + +

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

    It is used during decoding to track the status of data as it is read in and +

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

    Relevant Struct Members

    +
    +
    data
    +
    Pointer to data from packet bodies.
    +
    storage
    +
    Pointer to data from packet bodies.
    +
    + + +

    +
    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + diff --git a/doc/libogg/ogg_sync_wrote.html b/doc/libogg/ogg_sync_wrote.html new file mode 100644 index 0000000..06318ab --- /dev/null +++ b/doc/libogg/ogg_sync_wrote.html @@ -0,0 +1,73 @@ + + + +libogg - function - ogg_sync_wrote + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    ogg_sync_wrote

    + +

    declared in "ogg/ogg.h";

    + +

    This function is used to tell the ogg_sync_state struct how many bytes we wrote into the buffer. + +

    +The general proceedure is to request a pointer into an internal +ogg_sync_state buffer by calling +ogg_sync_buffer(). The buffer +is then filled up to the requested size with new input, and +ogg_sync_wrote() is called to advance the fill pointer by however +much data was actually available.

    + +
    + + + + +
    +
    
+int ogg_sync_wrote(ogg_sync_state *oy, long bytes);
+
    +
    + +

    Parameters

    +
    +
    oy
    +
    Pointer to a previously declared ogg_sync_state struct.
    +
    bytes
    +
    Number of bytes of new data written.
    +
    + + +

    Return Values

    +
    +
  • -1 if the number of bytes written overflows the internal storage of the ogg_sync_state struct. +
  • +0 in all other cases.
    • +
    + + +

    +
    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/oggpack_adv.html b/doc/libogg/oggpack_adv.html new file mode 100644 index 0000000..66140ec --- /dev/null +++ b/doc/libogg/oggpack_adv.html @@ -0,0 +1,64 @@ + + + +libogg - function - oggpack_adv + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    oggpack_adv

    + +

    declared in "ogg/ogg.h";

    + +

    This function advances the location pointer by the specified number of bits without reading any data. + +

    + + + + +
    +
    
+void  oggpack_adv(oggpack_buffer *b,int bits);
+
    +
    + +

    Parameters

    +
    +
    b
    +
    Pointer to the current oggpack_buffer.
    +
    bits
    +
    Number of bits to advance.
    +
    + + +

    Return Values

    +
    +
  • +No values are returned.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2002 Xiph.org Foundation

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20020719

    + + + + + diff --git a/doc/libogg/oggpack_adv1.html b/doc/libogg/oggpack_adv1.html new file mode 100644 index 0000000..d02ae43 --- /dev/null +++ b/doc/libogg/oggpack_adv1.html @@ -0,0 +1,62 @@ + + + +libogg - function - oggpack_adv1 + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    oggpack_adv1

    + +

    declared in "ogg/ogg.h";

    + +

    This function advances the location pointer by one bit without reading any data. + +

    + + + + +
    +
    
+void  oggpack_adv1(oggpack_buffer *b);
+
    +
    + +

    Parameters

    +
    +
    b
    +
    Pointer to the current oggpack_buffer.
    +
    + + +

    Return Values

    +
    +
  • No values are returned. +
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/oggpack_bits.html b/doc/libogg/oggpack_bits.html new file mode 100644 index 0000000..b1bdc39 --- /dev/null +++ b/doc/libogg/oggpack_bits.html @@ -0,0 +1,62 @@ + + + +libogg - function - oggpack_bits + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    oggpack_bits

    + +

    declared in "ogg/ogg.h";

    + +

    This function returns the total number of bits currently in the oggpack_buffer's internal buffer. + +

    + + + + +
    +
    
+long oggpack_bits(oggpack_buffer *b);
+
    +
    + +

    Parameters

    +
    +
    b
    +
    oggpack_buffer struct to be .
    +
    + + +

    Return Values

    +
    +
  • +n is the total number of bits within the current buffer.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/oggpack_buffer.html b/doc/libogg/oggpack_buffer.html new file mode 100644 index 0000000..42f21ec --- /dev/null +++ b/doc/libogg/oggpack_buffer.html @@ -0,0 +1,66 @@ + + + +libogg - datatype - oggpack_buffer + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    oggpack_buffer

    + +

    declared in "ogg/ogg.h"

    + +

    +The oggpack_buffer struct is used with libogg's bitpacking functions. You should never need to directly access anything in this structure. +

    + + + + + +
    +
    
+typedef struct {
+  long endbyte;
+  int  endbit;
+
+  unsigned char *buffer;
+  unsigned char *ptr;
+  long storage;
+} oggpack_buffer;
+
    +
    + +

    Relevant Struct Members

    +
    +
    buffer
    +
    Pointer to data being manipulated.
    +
    ptr
    +
    Location pointer to mark which data has been read.
    +
    storage
    +
    Size of buffer. +
    + + +

    +
    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + diff --git a/doc/libogg/oggpack_bytes.html b/doc/libogg/oggpack_bytes.html new file mode 100644 index 0000000..5e0382d --- /dev/null +++ b/doc/libogg/oggpack_bytes.html @@ -0,0 +1,62 @@ + + + +libogg - function - oggpack_bytes + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20020719

    + +

    oggpack_bytes

    + +

    declared in "ogg/ogg.h";

    + +

    This function returns the total number of bytes currently in the oggpack_buffer's internal buffer. +

    The return value is the number of complete bytes in the buffer. There may be extra (<8) bits. +

    + + + + +
    +
    
+long oggpack_bytes(oggpack_buffer *b);
+
    +
    + +

    Parameters

    +
    +
    b
    +
    oggpack_buffer struct to be checked.
    +
    + + +

    Return Values

    +
    +
  • +n is the total number of bytes within the current buffer.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20020719

    + + + + + diff --git a/doc/libogg/oggpack_get_buffer.html b/doc/libogg/oggpack_get_buffer.html new file mode 100644 index 0000000..9d2c143 --- /dev/null +++ b/doc/libogg/oggpack_get_buffer.html @@ -0,0 +1,62 @@ + + + +libogg - function - oggpack_get_buffer + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    oggpack_get_buffer

    + +

    declared in "ogg/ogg.h";

    + +

    This function returns a pointer to the data buffer within the given oggpack_buffer struct. + +

    + + + + +
    +
    
+unsigned char *oggpack_get_buffer(oggpack_buffer *b);
+
    +
    + +

    Parameters

    +
    +
    b
    +
    Pointer to the current oggpack_buffer.
    +
    + + +

    Return Values

    +
    +
  • +No values are returned.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/oggpack_look.html b/doc/libogg/oggpack_look.html new file mode 100644 index 0000000..3386d0b --- /dev/null +++ b/doc/libogg/oggpack_look.html @@ -0,0 +1,66 @@ + + + +libogg - function - oggpack_look + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    oggpack_look

    + +

    declared in "ogg/ogg.h";

    + +

    This function looks at a specified number of bits inside the buffer without advancing the location pointer. +

    The specified number of bits are read, starting from the location pointer. +

    This function can be used to read 32 or fewer bits. + +

    + + + + +
    +
    
+long  oggpack_look(oggpack_buffer *b,int bits);
+
    +
    + +

    Parameters

    +
    +
    b
    +
    Pointer to oggpack_buffer to be read.
    +
    bits
    +
    Number of bits to look at. For this function, must be 32 or fewer.
    +
    + + +

    Return Values

    +
    +
  • +n represents the requested bits.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/oggpack_look1.html b/doc/libogg/oggpack_look1.html new file mode 100644 index 0000000..4b9cfe7 --- /dev/null +++ b/doc/libogg/oggpack_look1.html @@ -0,0 +1,63 @@ + + + +libogg - function - oggpack_look1 + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    oggpack_look1

    + +

    declared in "ogg/ogg.h";

    + +

    This function looks at the next bit without advancing the location pointer. +

    The next bit is read starting from the location pointer. + +

    + + + + +
    +
    
+long  oggpack_look1(oggpack_buffer *b);
+
    +
    + +

    Parameters

    +
    +
    b
    +
    Pointer to an oggpack_buffer struct containing our buffer.
    +
    + + +

    Return Values

    +
    +
  • +n represents the value of the next bit after the location pointer.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/oggpack_read.html b/doc/libogg/oggpack_read.html new file mode 100644 index 0000000..faf3eb7 --- /dev/null +++ b/doc/libogg/oggpack_read.html @@ -0,0 +1,65 @@ + + + +libogg - function - oggpack_read + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    oggpack_read

    + +

    declared in "ogg/ogg.h";

    + +

    This function reads the requested number of bits from the buffer and advances the location pointer. +

    Before reading, the buffer should be initialized using oggpack_readinit. + +

    + + + + +
    +
    
+long oggpack_read(oggpack_buffer *b,int bits);
+
    +
    + +

    Parameters

    +
    +
    b
    +
    Pointer to an oggpack_buffer struct containing buffered data to be read.
    +
    bits
    +
    Number of bits to read.
    +
    + + +

    Return Values

    +
    +
  • +n represents the requested bits.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/oggpack_read1.html b/doc/libogg/oggpack_read1.html new file mode 100644 index 0000000..e697a60 --- /dev/null +++ b/doc/libogg/oggpack_read1.html @@ -0,0 +1,63 @@ + + + +libogg - function - oggpack_read1 + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    oggpack_read1

    + +

    declared in "ogg/ogg.h";

    + +

    This function reads one bit from the oggpack_buffer data buffer and advances the location pointer. +

    Before reading, the buffer should be initialized using oggpack_readinit. + +

    + + + + +
    +
    
+long  oggpack_read1(oggpack_buffer *b);
+
    +
    + +

    Parameters

    +
    +
    b
    +
    Pointer to an oggpack_buffer struct containing buffered data to be read.
    +
    + + +

    Return Values

    +
    +
  • +n is the bit read by this function.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/oggpack_readinit.html b/doc/libogg/oggpack_readinit.html new file mode 100644 index 0000000..6d537a3 --- /dev/null +++ b/doc/libogg/oggpack_readinit.html @@ -0,0 +1,64 @@ + + + +libogg - function - oggpack_readinit + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    oggpack_readinit

    + +

    declared in "ogg/ogg.h";

    + +

    This function takes an ordinary buffer and prepares an oggpack_buffer for reading using the Ogg bitpacking functions. + +

    + + + + +
    +
    
+void oggpack_readinit(oggpack_buffer *b,unsigned char *buf,int bytes);
+
    +
    + +

    Parameters

    +
    +
    b
    +
    Pointer to oggpack_buffer to be initialized with some extra markers to ease bit navigation and manipulation.
    +
    buf
    +
    Original data buffer, to be inserted into the oggpack_buffer so that it can be read using bitpacking functions. +
    + + +

    Return Values

    +
    +
  • +No values are returned.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/oggpack_reset.html b/doc/libogg/oggpack_reset.html new file mode 100644 index 0000000..9002310 --- /dev/null +++ b/doc/libogg/oggpack_reset.html @@ -0,0 +1,62 @@ + + + +libogg - function - oggpack_reset + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    oggpack_reset

    + +

    declared in "ogg/ogg.h";

    + +

    This function resets the contents of an oggpack_buffer to their original state but does not free the memory used. + +

    + + + + +
    +
    
+void  oggpack_reset(oggpack_buffer *b);
+
    +
    + +

    Parameters

    +
    +
    b
    +
    oggpack_buffer to be reset.
    +
    + + +

    Return Values

    +
    +
  • +No values are returned.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/oggpack_write.html b/doc/libogg/oggpack_write.html new file mode 100644 index 0000000..33d8788 --- /dev/null +++ b/doc/libogg/oggpack_write.html @@ -0,0 +1,68 @@ + + + +libogg - function - oggpack_write + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    oggpack_write

    + +

    declared in "ogg/ogg.h";

    + +

    This function writes bits into an oggpack_buffer. +

    The oggpack_buffer must already be initialized for writing using oggpack_writeinit. +

    Only 32 bits can be written at a time. + +

    + + + + +
    +
    
+void  oggpack_write(oggpack_buffer *b,unsigned long value,int bits);
+
    +
    + +

    Parameters

    +
    +
    b
    +
    Buffer to be used for writing.
    +
    value
    +
    The data to be written into the buffer. This must be 32 bits or fewer.
    +
    bits
    +
    The number of bits being written into the buffer.
    +
    + + +

    Return Values

    +
    +
  • +No values are returned.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/oggpack_writealign.html b/doc/libogg/oggpack_writealign.html new file mode 100644 index 0000000..0137e61 --- /dev/null +++ b/doc/libogg/oggpack_writealign.html @@ -0,0 +1,65 @@ + + + +libogg - function - oggpack_writealign + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20020719

    + +

    oggpack_writealign

    + +

    declared in "ogg/ogg.h";

    + +

    This function pads the oggpack_buffer with zeros out to the +next byte boundary.

    +

    The oggpack_buffer must already be initialized for writing using oggpack_writeinit. +

    Only 32 bits can be written at a time.

    + +

    + + + + +
    +
    
+void  oggpack_writetrunc(oggpack_buffer *b);
+
    +
    + +

    Parameters

    +
    +
    b
    +
    Buffer to be used for writing.
    +
    + + +

    Return Values

    +
    +
  • +No values are returned.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2002 Xiph.org Foundation

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20020719

    + + + + + diff --git a/doc/libogg/oggpack_writeclear.html b/doc/libogg/oggpack_writeclear.html new file mode 100644 index 0000000..a554eed --- /dev/null +++ b/doc/libogg/oggpack_writeclear.html @@ -0,0 +1,62 @@ + + + +libogg - function - oggpack_reset + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    oggpack_writeclear

    + +

    declared in "ogg/ogg.h";

    + +

    This function clears the buffer after writing and frees the memory used by the oggpack_buffer. + +

    + + + + +
    +
    
+void oggpack_writeclear(oggpack_buffer *b);
+
    +
    + +

    Parameters

    +
    +
    b
    +
    Our oggpack_buffer. This is an ordinary data buffer with some extra markers to ease bit navigation and manipulation.
    +
    + + +

    Return Values

    +
    +
  • +No values are returned.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/oggpack_writecopy.html b/doc/libogg/oggpack_writecopy.html new file mode 100644 index 0000000..18f599a --- /dev/null +++ b/doc/libogg/oggpack_writecopy.html @@ -0,0 +1,69 @@ + + + +libogg - function - oggpack_writecopy + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20020719

    + +

    oggpack_writecopy

    + +

    declared in "ogg/ogg.h";

    + +

    This function copies a sequence of bits from a source buffer into an +oggpack_buffer.

    +

    The oggpack_buffer must already be initialized for writing using oggpack_writeinit.

    +

    Only 32 bits can be written at a time.

    + +

    + + + + +
    +
    
+void  oggpack_writecopy(oggpack_buffer *b, void *source, long bits);
+
    +
    + +

    Parameters

    +
    +
    b
    +
    Buffer to be used for writing.
    +
    source
    +
    A pointer to the data to be written into the buffer.
    +
    bits
    +
    The number of bits to be copied into the buffer.
    +
    + + +

    Return Values

    +
    +
  • +No values are returned.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2002 Xiph.org Foundation

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20020719

    + + + + + diff --git a/doc/libogg/oggpack_writeinit.html b/doc/libogg/oggpack_writeinit.html new file mode 100644 index 0000000..1da1f17 --- /dev/null +++ b/doc/libogg/oggpack_writeinit.html @@ -0,0 +1,62 @@ + + + +libogg - function - oggpack_writeinit + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    oggpack_writeinit

    + +

    declared in "ogg/ogg.h";

    + +

    This function initializes an oggpack_buffer for writing using the Ogg bitpacking functions. + +

    + + + + +
    +
    
+void  oggpack_writeinit(oggpack_buffer *b);
+
    +
    + +

    Parameters

    +
    +
    b
    +
    Buffer to be used for writing. This is an ordinary data buffer with some extra markers to ease bit navigation and manipulation.
    +
    + + +

    Return Values

    +
    +
  • +No values are returned.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + + diff --git a/doc/libogg/oggpack_writetrunc.html b/doc/libogg/oggpack_writetrunc.html new file mode 100644 index 0000000..7e8750c --- /dev/null +++ b/doc/libogg/oggpack_writetrunc.html @@ -0,0 +1,65 @@ + + + +libogg - function - oggpack_writetrunc + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20020719

    + +

    oggpack_write

    + +

    declared in "ogg/ogg.h";

    + +

    This function truncates an already written-to oggpack_buffer.

    +

    The oggpack_buffer must already be initialized for writing using oggpack_writeinit.

    + +

    + + + + +
    +
    
+void  oggpack_writetrunc(oggpack_buffer *b, long bits);
+
    +
    + +

    Parameters

    +
    +
    b
    +
    Buffer to be truncated.
    +
    bits
    +
    Number of bits to keep in the buffer (size after truncation)
    +
    + + +

    Return Values

    +
    +
  • +No values are returned.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2002 Xiph.org Foundation

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20020719

    + + + + + diff --git a/doc/libogg/overview.html b/doc/libogg/overview.html new file mode 100644 index 0000000..f21cf4b --- /dev/null +++ b/doc/libogg/overview.html @@ -0,0 +1,44 @@ + + + +libogg - API Overview + + + + + + + + + +

    libogg documentation

    libogg release 1.0 - 20000615

    + +

    Libogg API Overview

    + +

    +The libogg API consists of the following functional categories: +

    +

    + +

    +
    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@xiph.org

    libogg documentation

    libogg release 1.0 - 20000615

    + + + + diff --git a/doc/libogg/reference.html b/doc/libogg/reference.html new file mode 100644 index 0000000..eddb2af --- /dev/null +++ b/doc/libogg/reference.html @@ -0,0 +1,93 @@ + + + +Libogg API Reference + + + + + + + + + +

    libogg documentation

    libogg - 20020719

    + +

    Libogg API Reference

    + +

    +Data Structures
    +oggpack_buffer
    +ogg_page
    +ogg_stream_state
    +ogg_packet
    +ogg_sync_state
    +
    +Bitpacking
    +oggpack_writeinit()
    +oggpack_reset()
    +oggpack_writetrunc()
    +oggpack_writealign()
    +oggpack_writecopy()
    +oggpack_writeclear()
    +oggpack_readinit()
    +oggpack_write()
    +oggpack_look()
    +oggpack_look1()
    +oggpack_adv()
    +oggpack_adv1()
    +oggpack_read()
    +oggpack_read1()
    +oggpack_bytes()
    +oggpack_bits()
    +oggpack_get_buffer()
    +
    +Decoding-Related
    +ogg_sync_init()
    +ogg_sync_clear()
    +ogg_sync_destroy()
    +ogg_sync_reset()
    +ogg_sync_buffer()
    +ogg_sync_wrote()
    +ogg_sync_pageseek()
    +ogg_sync_pageout()
    +ogg_stream_pagein()
    +ogg_stream_packetout()
    +ogg_stream_packetpeek()
    +
    +Encoding-Related
    +ogg_stream_packetin()
    +ogg_stream_pageout()
    +ogg_stream_flush()
    +
    +General
    +ogg_stream_init()
    +ogg_stream_clear()
    +ogg_stream_reset()
    +ogg_stream_reset_serialno()
    +ogg_stream_destroy()
    +ogg_page_version()
    +ogg_page_continued()
    +ogg_page_packets()
    +ogg_page_bos()
    +ogg_page_eos()
    +ogg_page_granulepos()
    +ogg_page_serialno()
    +ogg_page_pageno()
    +ogg_packet_clear()
    +ogg_page_checksum_set()
    +

    +

    + + + + + + + + +

    copyright © 2002 Xiph.org Foundation

    Ogg Vorbis
    team@vorbis.org

    libogg documentation

    libogg - 20020719

    + + + + diff --git a/doc/libogg/style.css b/doc/libogg/style.css new file mode 100644 index 0000000..81cf417 --- /dev/null +++ b/doc/libogg/style.css @@ -0,0 +1,7 @@ +BODY { font-family: Helvetica, sans-serif } +TD { font-family: Helvetica, sans-serif } +P { font-family: Helvetica, sans-serif } +H1 { font-family: Helvetica, sans-serif } +H2 { font-family: Helvetica, sans-serif } +H4 { font-family: Helvetica, sans-serif } +P.tiny { font-size: 8pt } diff --git a/doc/libogg/vorbis_comment.html b/doc/libogg/vorbis_comment.html new file mode 100644 index 0000000..a7b076b --- /dev/null +++ b/doc/libogg/vorbis_comment.html @@ -0,0 +1,70 @@ + + + +Vorbisfile - datatype - vorbis_comment + + + + + + + + + +

    Vorbisfile documentation

    libVorbisfile version 1.65 - 20020702

    + +

    vorbis_comment

    + +

    declared in "vorbis/codec.h"

    + +

    +The vorbis_comment structure defines an Ogg Vorbis comment. +

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

    + + + + + +
    +
    typedef struct vorbis_comment{
+  /* unlimited user comment fields. */
+  char **user_comments;
+  int  *comment_lengths;
+  int   comments;
+  char *vendor;
+
+} vorbis_comment;
    +
    + +

    Parameters

    +
    +
    user_comments
    +
    Unlimited user comment array. The individual strings in the array are 8 bit clean, by the Vorbis specification, and as such the comment_lengths 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).
    +
    comment_lengths
    +
    An array that stores the length of each comment string
    +
    comments
    +
    number of user comments in user_comments field.
    +
    vendor
    +
    Information about the creator of the file. Stored in a standard C 0-terminated string.
    +
    + + +

    +
    + + + + + + + + +

    copyright © 2002 Xiph.org Foundation

    Ogg Vorbis

    Vorbisfile documentation

    libVorbisfile version 1.65 - 20020719

    + + + + diff --git a/doc/libogg/vorbis_info.html b/doc/libogg/vorbis_info.html new file mode 100644 index 0000000..893e453 --- /dev/null +++ b/doc/libogg/vorbis_info.html @@ -0,0 +1,80 @@ + + + +Vorbisfile - datatype - vorbis_info + + + + + + + + + +

    Vorbisfile documentation

    libVorbisfile version 1.65 - 20020702

    + +

    vorbis_info

    + +

    declared in "vorbis/codec.h"

    + +

    +The vorbis_info structure contains basic information about the audio in a vorbis bitstream. +

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

    Relevant Struct Members

    +
    +
    version
    +
    Vorbis encoder version used to create this bitstream.
    +
    channels
    +
    Int signifying number of channels in bitstream.
    +
    rate
    +
    Sampling rate of the bitstream.
    +
    bitrate_upper
    +
    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.
    +
    bitrate_nominal
    +
    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.
    +
    bitrate_lower
    +
    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.
    +
    bitrate_window
    +
    Currently unset.
    + +
    codec_setup
    +
    Internal structure that contains the detailed/unpacked configuration for decoding the current Vorbis bitstream.
    +
    + + +

    +
    + + + + + + + + +

    copyright © 2002 Xiph.org

    Ogg Vorbis

    Vorbisfile documentation

    libVorbisfile version 1.65 - 20020702

    + + + + -- cgit v1.2.1