From 8e94244f86e657e4113e35438e59cf5771882b25 Mon Sep 17 00:00:00 2001 From: Aki Date: Sun, 3 Mar 2024 12:51:03 +0100 Subject: libogg and libvorbis are no longer part of this source tree --- contrib/ogg/doc/libogg/Makefile.am | 39 ------- contrib/ogg/doc/libogg/bitpacking.html | 103 ------------------ contrib/ogg/doc/libogg/datastructures.html | 59 ---------- contrib/ogg/doc/libogg/decoding.html | 104 ------------------ contrib/ogg/doc/libogg/encoding.html | 76 ------------- contrib/ogg/doc/libogg/general.html | 109 ------------------- contrib/ogg/doc/libogg/index.html | 39 ------- contrib/ogg/doc/libogg/ogg_iovec_t.html | 62 ----------- contrib/ogg/doc/libogg/ogg_packet.html | 75 ------------- contrib/ogg/doc/libogg/ogg_packet_clear.html | 64 ----------- contrib/ogg/doc/libogg/ogg_page.html | 75 ------------- contrib/ogg/doc/libogg/ogg_page_bos.html | 65 ----------- contrib/ogg/doc/libogg/ogg_page_checksum_set.html | 62 ----------- contrib/ogg/doc/libogg/ogg_page_continued.html | 64 ----------- contrib/ogg/doc/libogg/ogg_page_eos.html | 65 ----------- contrib/ogg/doc/libogg/ogg_page_granulepos.html | 65 ----------- contrib/ogg/doc/libogg/ogg_page_packets.html | 75 ------------- contrib/ogg/doc/libogg/ogg_page_pageno.html | 63 ----------- contrib/ogg/doc/libogg/ogg_page_serialno.html | 63 ----------- contrib/ogg/doc/libogg/ogg_page_version.html | 63 ----------- contrib/ogg/doc/libogg/ogg_stream_check.html | 71 ------------ contrib/ogg/doc/libogg/ogg_stream_clear.html | 61 ----------- contrib/ogg/doc/libogg/ogg_stream_destroy.html | 71 ------------ contrib/ogg/doc/libogg/ogg_stream_eos.html | 62 ----------- contrib/ogg/doc/libogg/ogg_stream_flush.html | 67 ------------ contrib/ogg/doc/libogg/ogg_stream_flush_fill.html | 74 ------------- contrib/ogg/doc/libogg/ogg_stream_init.html | 66 ----------- contrib/ogg/doc/libogg/ogg_stream_iovecin.html | 80 -------------- contrib/ogg/doc/libogg/ogg_stream_packetin.html | 72 ------------ contrib/ogg/doc/libogg/ogg_stream_packetout.html | 85 --------------- contrib/ogg/doc/libogg/ogg_stream_packetpeek.html | 85 --------------- contrib/ogg/doc/libogg/ogg_stream_pagein.html | 67 ------------ contrib/ogg/doc/libogg/ogg_stream_pageout.html | 84 -------------- .../ogg/doc/libogg/ogg_stream_pageout_fill.html | 89 --------------- contrib/ogg/doc/libogg/ogg_stream_reset.html | 61 ----------- .../ogg/doc/libogg/ogg_stream_reset_serialno.html | 67 ------------ contrib/ogg/doc/libogg/ogg_stream_state.html | 121 --------------------- contrib/ogg/doc/libogg/ogg_sync_buffer.html | 67 ------------ contrib/ogg/doc/libogg/ogg_sync_check.html | 71 ------------ contrib/ogg/doc/libogg/ogg_sync_clear.html | 62 ----------- contrib/ogg/doc/libogg/ogg_sync_destroy.html | 68 ------------ contrib/ogg/doc/libogg/ogg_sync_init.html | 63 ----------- contrib/ogg/doc/libogg/ogg_sync_pageout.html | 77 ------------- contrib/ogg/doc/libogg/ogg_sync_pageseek.html | 68 ------------ contrib/ogg/doc/libogg/ogg_sync_reset.html | 63 ----------- contrib/ogg/doc/libogg/ogg_sync_state.html | 77 ------------- contrib/ogg/doc/libogg/ogg_sync_wrote.html | 73 ------------- contrib/ogg/doc/libogg/oggpack_adv.html | 64 ----------- contrib/ogg/doc/libogg/oggpack_adv1.html | 62 ----------- contrib/ogg/doc/libogg/oggpack_bits.html | 62 ----------- contrib/ogg/doc/libogg/oggpack_buffer.html | 66 ----------- contrib/ogg/doc/libogg/oggpack_bytes.html | 67 ------------ contrib/ogg/doc/libogg/oggpack_get_buffer.html | 62 ----------- contrib/ogg/doc/libogg/oggpack_look.html | 66 ----------- contrib/ogg/doc/libogg/oggpack_look1.html | 63 ----------- contrib/ogg/doc/libogg/oggpack_read.html | 65 ----------- contrib/ogg/doc/libogg/oggpack_read1.html | 63 ----------- contrib/ogg/doc/libogg/oggpack_readinit.html | 64 ----------- contrib/ogg/doc/libogg/oggpack_reset.html | 62 ----------- contrib/ogg/doc/libogg/oggpack_write.html | 68 ------------ contrib/ogg/doc/libogg/oggpack_writealign.html | 65 ----------- contrib/ogg/doc/libogg/oggpack_writecheck.html | 81 -------------- contrib/ogg/doc/libogg/oggpack_writeclear.html | 62 ----------- contrib/ogg/doc/libogg/oggpack_writecopy.html | 69 ------------ contrib/ogg/doc/libogg/oggpack_writeinit.html | 62 ----------- contrib/ogg/doc/libogg/oggpack_writetrunc.html | 65 ----------- contrib/ogg/doc/libogg/overview.html | 44 -------- contrib/ogg/doc/libogg/reference.html | 98 ----------------- contrib/ogg/doc/libogg/style.css | 7 -- 69 files changed, 4749 deletions(-) delete mode 100644 contrib/ogg/doc/libogg/Makefile.am delete mode 100644 contrib/ogg/doc/libogg/bitpacking.html delete mode 100644 contrib/ogg/doc/libogg/datastructures.html delete mode 100644 contrib/ogg/doc/libogg/decoding.html delete mode 100644 contrib/ogg/doc/libogg/encoding.html delete mode 100644 contrib/ogg/doc/libogg/general.html delete mode 100644 contrib/ogg/doc/libogg/index.html delete mode 100644 contrib/ogg/doc/libogg/ogg_iovec_t.html delete mode 100644 contrib/ogg/doc/libogg/ogg_packet.html delete mode 100644 contrib/ogg/doc/libogg/ogg_packet_clear.html delete mode 100644 contrib/ogg/doc/libogg/ogg_page.html delete mode 100644 contrib/ogg/doc/libogg/ogg_page_bos.html delete mode 100644 contrib/ogg/doc/libogg/ogg_page_checksum_set.html delete mode 100644 contrib/ogg/doc/libogg/ogg_page_continued.html delete mode 100644 contrib/ogg/doc/libogg/ogg_page_eos.html delete mode 100644 contrib/ogg/doc/libogg/ogg_page_granulepos.html delete mode 100644 contrib/ogg/doc/libogg/ogg_page_packets.html delete mode 100644 contrib/ogg/doc/libogg/ogg_page_pageno.html delete mode 100644 contrib/ogg/doc/libogg/ogg_page_serialno.html delete mode 100644 contrib/ogg/doc/libogg/ogg_page_version.html delete mode 100644 contrib/ogg/doc/libogg/ogg_stream_check.html delete mode 100644 contrib/ogg/doc/libogg/ogg_stream_clear.html delete mode 100644 contrib/ogg/doc/libogg/ogg_stream_destroy.html delete mode 100644 contrib/ogg/doc/libogg/ogg_stream_eos.html delete mode 100644 contrib/ogg/doc/libogg/ogg_stream_flush.html delete mode 100644 contrib/ogg/doc/libogg/ogg_stream_flush_fill.html delete mode 100644 contrib/ogg/doc/libogg/ogg_stream_init.html delete mode 100644 contrib/ogg/doc/libogg/ogg_stream_iovecin.html delete mode 100644 contrib/ogg/doc/libogg/ogg_stream_packetin.html delete mode 100644 contrib/ogg/doc/libogg/ogg_stream_packetout.html delete mode 100644 contrib/ogg/doc/libogg/ogg_stream_packetpeek.html delete mode 100644 contrib/ogg/doc/libogg/ogg_stream_pagein.html delete mode 100644 contrib/ogg/doc/libogg/ogg_stream_pageout.html delete mode 100644 contrib/ogg/doc/libogg/ogg_stream_pageout_fill.html delete mode 100644 contrib/ogg/doc/libogg/ogg_stream_reset.html delete mode 100644 contrib/ogg/doc/libogg/ogg_stream_reset_serialno.html delete mode 100644 contrib/ogg/doc/libogg/ogg_stream_state.html delete mode 100644 contrib/ogg/doc/libogg/ogg_sync_buffer.html delete mode 100644 contrib/ogg/doc/libogg/ogg_sync_check.html delete mode 100644 contrib/ogg/doc/libogg/ogg_sync_clear.html delete mode 100644 contrib/ogg/doc/libogg/ogg_sync_destroy.html delete mode 100644 contrib/ogg/doc/libogg/ogg_sync_init.html delete mode 100644 contrib/ogg/doc/libogg/ogg_sync_pageout.html delete mode 100644 contrib/ogg/doc/libogg/ogg_sync_pageseek.html delete mode 100644 contrib/ogg/doc/libogg/ogg_sync_reset.html delete mode 100644 contrib/ogg/doc/libogg/ogg_sync_state.html delete mode 100644 contrib/ogg/doc/libogg/ogg_sync_wrote.html delete mode 100644 contrib/ogg/doc/libogg/oggpack_adv.html delete mode 100644 contrib/ogg/doc/libogg/oggpack_adv1.html delete mode 100644 contrib/ogg/doc/libogg/oggpack_bits.html delete mode 100644 contrib/ogg/doc/libogg/oggpack_buffer.html delete mode 100644 contrib/ogg/doc/libogg/oggpack_bytes.html delete mode 100644 contrib/ogg/doc/libogg/oggpack_get_buffer.html delete mode 100644 contrib/ogg/doc/libogg/oggpack_look.html delete mode 100644 contrib/ogg/doc/libogg/oggpack_look1.html delete mode 100644 contrib/ogg/doc/libogg/oggpack_read.html delete mode 100644 contrib/ogg/doc/libogg/oggpack_read1.html delete mode 100644 contrib/ogg/doc/libogg/oggpack_readinit.html delete mode 100644 contrib/ogg/doc/libogg/oggpack_reset.html delete mode 100644 contrib/ogg/doc/libogg/oggpack_write.html delete mode 100644 contrib/ogg/doc/libogg/oggpack_writealign.html delete mode 100644 contrib/ogg/doc/libogg/oggpack_writecheck.html delete mode 100644 contrib/ogg/doc/libogg/oggpack_writeclear.html delete mode 100644 contrib/ogg/doc/libogg/oggpack_writecopy.html delete mode 100644 contrib/ogg/doc/libogg/oggpack_writeinit.html delete mode 100644 contrib/ogg/doc/libogg/oggpack_writetrunc.html delete mode 100644 contrib/ogg/doc/libogg/overview.html delete mode 100644 contrib/ogg/doc/libogg/reference.html delete mode 100644 contrib/ogg/doc/libogg/style.css (limited to 'contrib/ogg/doc/libogg') diff --git a/contrib/ogg/doc/libogg/Makefile.am b/contrib/ogg/doc/libogg/Makefile.am deleted file mode 100644 index 4007907..0000000 --- a/contrib/ogg/doc/libogg/Makefile.am +++ /dev/null @@ -1,39 +0,0 @@ -## Process this file with automake to produce Makefile.in - -apidocdir = $(htmldir)/libogg - -dist_apidoc_DATA = bitpacking.html datastructures.html decoding.html encoding.html\ - general.html index.html ogg_iovec_t.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_check.html ogg_stream_clear.html ogg_stream_destroy.html\ - ogg_stream_eos.html ogg_stream_flush.html ogg_stream_flush_fill.html ogg_stream_init.html\ - ogg_stream_iovecin.html ogg_stream_packetin.html ogg_stream_packetout.html\ - ogg_stream_packetpeek.html ogg_stream_pagein.html\ - ogg_stream_pageout.html ogg_stream_pageout_fill.html ogg_stream_reset.html\ - ogg_stream_reset_serialno.html ogg_stream_state.html\ - ogg_sync_buffer.html ogg_sync_check.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_writecheck.html oggpack_writeclear.html\ - oggpack_writecopy.html oggpack_writeinit.html oggpack_writetrunc.html\ - overview.html reference.html style.css - -update-doc-version: - @YEAR=$$(date +%Y); DAY=$$(date +%Y%m%d); \ - for f in $(srcdir)/*.html; do \ - sed -e "s/2000-[0-9]\{4\} Xiph.Org/2000-$$YEAR Xiph.Org/g" \ - -e "s/libogg release [0-9. -]\+/libogg release $(VERSION) - $$DAY/g"\ - < $$f > $$f.tmp; \ - if diff -q $$f $$f.tmp > /dev/null; then \ - rm $$f.tmp; \ - else \ - mv $$f.tmp $$f; \ - fi; \ - done; - diff --git a/contrib/ogg/doc/libogg/bitpacking.html b/contrib/ogg/doc/libogg/bitpacking.html deleted file mode 100644 index cc76015..0000000 --- a/contrib/ogg/doc/libogg/bitpacking.html +++ /dev/null @@ -1,103 +0,0 @@ - - - -libogg - Bitpacking Functions - - - - - - - - - -

libogg documentation

libogg release 1.3.2 - 20140527

- -

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_writecheckAsynchronously checks error status of bitpacker write buffer.
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-2014 Xiph.Org

Ogg Container Format

libogg documentation

libogg release 1.3.2 - 20140527

- - - - diff --git a/contrib/ogg/doc/libogg/datastructures.html b/contrib/ogg/doc/libogg/datastructures.html deleted file mode 100644 index 0f56102..0000000 --- a/contrib/ogg/doc/libogg/datastructures.html +++ /dev/null @@ -1,59 +0,0 @@ - - - -libogg - Base Data Structures - - - - - - - - - -

libogg documentation

libogg release 1.3.2 - 20140527

- -

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 Ogg packet.
ogg_sync_stateContains bitstream synchronization information.
- -

-

- - - - - - - - -

copyright © 2000-2014 Xiph.Org

Ogg Container Format

libogg documentation

libogg release 1.3.2 - 20140527

- - - - diff --git a/contrib/ogg/doc/libogg/decoding.html b/contrib/ogg/doc/libogg/decoding.html deleted file mode 100644 index f393a07..0000000 --- a/contrib/ogg/doc/libogg/decoding.html +++ /dev/null @@ -1,104 +0,0 @@ - - - -libogg - Decoding - - - - - - - - - -

libogg documentation

libogg release 1.3.2 - 20140527

- -

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_checkCheck for asynchronous errors.
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-2014 Xiph.Org

Ogg Container Format

libogg documentation

libogg release 1.3.2 - 20140527

- - - - diff --git a/contrib/ogg/doc/libogg/encoding.html b/contrib/ogg/doc/libogg/encoding.html deleted file mode 100644 index 6aa8470..0000000 --- a/contrib/ogg/doc/libogg/encoding.html +++ /dev/null @@ -1,76 +0,0 @@ - - - -libogg - Encoding - - - - - - - - - -

libogg documentation

libogg release 1.3.2 - 20140527

- -

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_ioveciniovec version of ogg_stream_packetin() above.
ogg_stream_pageoutOutputs a completed page if the stream contains enough packets to form a full page. -
ogg_stream_pageout_fillSimilar to ogg_stream_pageout(), but specifies a page spill threshold in bytes. -
ogg_stream_flushForces any remaining packets in the stream to be returned as a page of any size. -
ogg_stream_flush_fillSimilar to ogg_stream_flush(), but specifies a page spill threshold in bytes. -
- -

-
- - - - - - - - -

copyright © 2000-2014 Xiph.Org

Ogg Container Format

libogg documentation

libogg release 1.3.2 - 20140527

- - - - diff --git a/contrib/ogg/doc/libogg/general.html b/contrib/ogg/doc/libogg/general.html deleted file mode 100644 index d892dd3..0000000 --- a/contrib/ogg/doc/libogg/general.html +++ /dev/null @@ -1,109 +0,0 @@ - - - -libogg - General Functions - - - - - - - - - -

libogg documentation

libogg release 1.3.2 - 20140527

- -

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_checkCheck for asyncronous errors.
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_clearClears the ogg_packet structure.
ogg_page_checksum_setChecksums an ogg_page.
- -

-

- - - - - - - - -

copyright © 2000-2014 Xiph.Org

Ogg Container Format

libogg documentation

libogg release 1.3.2 - 20140527

- - - - diff --git a/contrib/ogg/doc/libogg/index.html b/contrib/ogg/doc/libogg/index.html deleted file mode 100644 index 6d3feab..0000000 --- a/contrib/ogg/doc/libogg/index.html +++ /dev/null @@ -1,39 +0,0 @@ - - - -libogg - Documentation - - - - - - - - - -

libogg documentation

libogg release 1.3.2 - 20140527

- -

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-2014 Xiph.Org

Ogg Container Format

libogg documentation

libogg release 1.3.2 - 20140527

- - - - diff --git a/contrib/ogg/doc/libogg/ogg_iovec_t.html b/contrib/ogg/doc/libogg/ogg_iovec_t.html deleted file mode 100644 index 2cf7e8b..0000000 --- a/contrib/ogg/doc/libogg/ogg_iovec_t.html +++ /dev/null @@ -1,62 +0,0 @@ - - - -libogg - datatype - ogg_iovec_t - - - - - - - - - -

libogg documentation

libogg release 1.3.2 - 20140527

- -

ogg_iovec_t

- -

declared in "ogg/ogg.h"

- -

-The ogg_iovec_t struct encapsulates a length-encoded buffer. An array -of ogg_iovec_t is used to pass a list of buffers to functions that -accept data in ogg_iovec_t* form. -

- - - - - -
-

-typedef struct {
-  void *iov_base;
-  size_t iov_len;
-} ogg_iovec_t;
-
-
- -

Relevant Struct Members

-
-
iov_base
-
Pointer to the buffer data.
-
iov_len
-
Length of buffer data in bytes.
-
- - -

-
- - - - - - - - -

copyright © 2000-2014 Xiph.Org

Ogg Container Format

libogg documentation

libogg release 1.3.2 - 20140527

- - - - diff --git a/contrib/ogg/doc/libogg/ogg_packet.html b/contrib/ogg/doc/libogg/ogg_packet.html deleted file mode 100644 index 5672eba..0000000 --- a/contrib/ogg/doc/libogg/ogg_packet.html +++ /dev/null @@ -1,75 +0,0 @@ - - - -libogg - datatype - ogg_packet - - - - - - - - - -

libogg documentation

libogg release 1.3.2 - 20140527

- -

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 © 2000-2014 Xiph.Org

Ogg Container Format

libogg documentation

libogg release 1.3.2 - 20140527

- - - - diff --git a/contrib/ogg/doc/libogg/ogg_packet_clear.html b/contrib/ogg/doc/libogg/ogg_packet_clear.html deleted file mode 100644 index 87dadea..0000000 --- a/contrib/ogg/doc/libogg/ogg_packet_clear.html +++ /dev/null @@ -1,64 +0,0 @@ - - - -libogg - function - ogg_packet_clear - - - - - - - - - -

libogg documentation

libogg release 1.3.2 - 20140527

- -

ogg_packet_clear

- -

declared in "ogg/ogg.h";

- -

This function clears the memory used by the ogg_packet struct, -but does not free the structure itself. -It unconditionally frees the packet data buffer, -then it zeros all structure members. -

- - - - -
-

-void ogg_packet_clear(ogg_packet *op);
-
-
- -

Parameters

-
-
op
-
Pointer to the ogg_packet struct to be cleared.
-
- - -

Return Values

-
-
  • -None.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2000-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_page.html b/contrib/ogg/doc/libogg/ogg_page.html deleted file mode 100644 index ac1a994..0000000 --- a/contrib/ogg/doc/libogg/ogg_page.html +++ /dev/null @@ -1,75 +0,0 @@ - - - -libogg - datatype - ogg_page - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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 many -applications will not completely fill all pages because they flush the -accumulated packets periodically order to bound latency more tightly. -

    -

    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 © 2000-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - diff --git a/contrib/ogg/doc/libogg/ogg_page_bos.html b/contrib/ogg/doc/libogg/ogg_page_bos.html deleted file mode 100644 index 9286e1a..0000000 --- a/contrib/ogg/doc/libogg/ogg_page_bos.html +++ /dev/null @@ -1,65 +0,0 @@ - - - -libogg - function - ogg_page_bos - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_page_checksum_set.html b/contrib/ogg/doc/libogg/ogg_page_checksum_set.html deleted file mode 100644 index 9af7d4e..0000000 --- a/contrib/ogg/doc/libogg/ogg_page_checksum_set.html +++ /dev/null @@ -1,62 +0,0 @@ - - - -libogg - function - ogg_page_checksum_set - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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 © 2000-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_page_continued.html b/contrib/ogg/doc/libogg/ogg_page_continued.html deleted file mode 100644 index 20b4ede..0000000 --- a/contrib/ogg/doc/libogg/ogg_page_continued.html +++ /dev/null @@ -1,64 +0,0 @@ - - - -libogg - function - ogg_page_version - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_page_eos.html b/contrib/ogg/doc/libogg/ogg_page_eos.html deleted file mode 100644 index d81ebae..0000000 --- a/contrib/ogg/doc/libogg/ogg_page_eos.html +++ /dev/null @@ -1,65 +0,0 @@ - - - -libogg - function - ogg_page_eos - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_page_granulepos.html b/contrib/ogg/doc/libogg/ogg_page_granulepos.html deleted file mode 100644 index 826b48e..0000000 --- a/contrib/ogg/doc/libogg/ogg_page_granulepos.html +++ /dev/null @@ -1,65 +0,0 @@ - - - -libogg - function - ogg_page_granulepos - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

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

    -

    - - - - -
    -
    
-ogg_in64_t 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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

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

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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 © 2000-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

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

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

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

    - - - - -
    -
    
-long 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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_page_serialno.html b/contrib/ogg/doc/libogg/ogg_page_serialno.html deleted file mode 100644 index 12ff580..0000000 --- a/contrib/ogg/doc/libogg/ogg_page_serialno.html +++ /dev/null @@ -1,63 +0,0 @@ - - - -libogg - function - ogg_page_serialno - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_page_version.html b/contrib/ogg/doc/libogg/ogg_page_version.html deleted file mode 100644 index 01062ff..0000000 --- a/contrib/ogg/doc/libogg/ogg_page_version.html +++ /dev/null @@ -1,63 +0,0 @@ - - - -libogg - function - ogg_page_version - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_stream_check.html b/contrib/ogg/doc/libogg/ogg_stream_check.html deleted file mode 100644 index 64d171f..0000000 --- a/contrib/ogg/doc/libogg/ogg_stream_check.html +++ /dev/null @@ -1,71 +0,0 @@ - - - -libogg - function - ogg_stream_check - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    ogg_stream_check

    - -

    declared in "ogg/ogg.h";

    - -

    This function is used to check the error or readiness condition of an ogg_stream_state structure. -

    It is safe practice to ignore unrecoverable errors (such as an internal error caused by a malloc() failure) returned by ogg stream synchronization calls. Should an -internal error occur, the ogg_stream_state structure will be cleared (equivalent to a -call to -ogg_stream_clear) and subsequent calls -using this ogg_stream_state will be -noops. Error detection is then handled via a single call to -ogg_stream_check at the end of the operational block.

    - -

    - - - - -
    -
    
-int ogg_stream_check(ogg_stream_state *os);
-
    -
    - -

    Parameters

    -
    -
    os
    -
    Pointer to a previously declared ogg_stream_state struct.
    -
    - - -

    Return Values

    -
    -
  • -0 is returned if the ogg_stream_state structure is initialized and ready.
    • -
  • -nonzero is returned if the structure was never initialized, or if an unrecoverable internal error occurred in a previous call using the passed in ogg_stream_state struct.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2000-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_stream_clear.html b/contrib/ogg/doc/libogg/ogg_stream_clear.html deleted file mode 100644 index 83149e0..0000000 --- a/contrib/ogg/doc/libogg/ogg_stream_clear.html +++ /dev/null @@ -1,61 +0,0 @@ - - - -libogg - function - ogg_stream_clear - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    ogg_stream_clear

    - -

    declared in "ogg/ogg.h";

    - -

    This function clears and frees the internal memory used by the ogg_stream_state struct, but does not free the structure itself. It is safe to call ogg_stream_clear on the same structure more than once. -

    - - - - -
    -
    
-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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_stream_destroy.html b/contrib/ogg/doc/libogg/ogg_stream_destroy.html deleted file mode 100644 index 5eee7f0..0000000 --- a/contrib/ogg/doc/libogg/ogg_stream_destroy.html +++ /dev/null @@ -1,71 +0,0 @@ - - - -libogg - function - ogg_stream_destroy - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    ogg_stream_destroy

    - -

    declared in "ogg/ogg.h";

    - -

    This function frees the internal memory used by -the ogg_stream_state struct as -well as the structure itself. - -

    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.

    - -

    It calls free() on its argument, so if the ogg_stream_state -is not malloc()'d or will otherwise be freed by your own code, use -ogg_stream_clear instead.

    - -

    - - - - -
    -
    
-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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_stream_eos.html b/contrib/ogg/doc/libogg/ogg_stream_eos.html deleted file mode 100644 index 519e618..0000000 --- a/contrib/ogg/doc/libogg/ogg_stream_eos.html +++ /dev/null @@ -1,62 +0,0 @@ - - - -libogg - function - ogg_stream_eos - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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 or an internal error occurred.
    • -
  • -0 if we have not yet reached the end of the stream.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2000-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_stream_flush.html b/contrib/ogg/doc/libogg/ogg_stream_flush.html deleted file mode 100644 index 317f442..0000000 --- a/contrib/ogg/doc/libogg/ogg_stream_flush.html +++ /dev/null @@ -1,67 +0,0 @@ - - - -libogg - function - ogg_stream_flush - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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 or ogg_stream_pageout_fill should always be used. -

    This function can also be used to verify that all packets have been flushed. If the return value is 0, all packets have been placed into a page. Like ogg_stream_pageout, it should generally be called in a loop until available packet data has been flushes, since even a single packet may span multiple pages. - -

    - - - - -
    -
    
-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. 0 is also returned in the case of an ogg_stream_state that has been cleared explicitly or implicitly due to an internal error.
    • -
  • -Nonzero means that remaining packets have successfully been flushed into the page.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2000-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_stream_flush_fill.html b/contrib/ogg/doc/libogg/ogg_stream_flush_fill.html deleted file mode 100644 index 62aa11a..0000000 --- a/contrib/ogg/doc/libogg/ogg_stream_flush_fill.html +++ /dev/null @@ -1,74 +0,0 @@ - - - -libogg - function - ogg_stream_flush_fill - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    ogg_stream_flush_fill

    - -

    declared in "ogg/ogg.h";

    - -

    This function flushes available packets into pages, similar to -ogg_stream_flush(), but -allows applications to explicitly request a specific page spill -size.

    - -

    This function checks for remaining packets inside the stream and forces remaining packets into pages of approximately the requested size. -This should be used when you want to flush all remaining data from a stream. ogg_stream_flush may be used instead if a particular page size isn't important. -

    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. Generally speaking, it should be called in a loop until all packets are flushed, since even a single packet may span multiple pages. - -

    - - - - -
    -
    
-int ogg_stream_flush_fill(ogg_stream_state *os, ogg_page *og, int fillbytes);
-
    -
    - -

    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. -
    fillbytes
    -
    Packet data watermark in bytes.
    -
    - - -

    Return Values

    -
    -
  • 0 means that all packet data has already been flushed into pages, and there are no packets to put into the page. 0 is also returned in the case of an ogg_stream_state that has been cleared explicitly or implicitly due to an internal error.
    • -
  • -Nonzero means that remaining packets have successfully been flushed into the page.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2000-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_stream_init.html b/contrib/ogg/doc/libogg/ogg_stream_init.html deleted file mode 100644 index 4459ee9..0000000 --- a/contrib/ogg/doc/libogg/ogg_stream_init.html +++ /dev/null @@ -1,66 +0,0 @@ - - - -libogg - function - ogg_stream_init - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

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

    - -

    -

    - - - - - - - - -

    copyright © 2000-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_stream_iovecin.html b/contrib/ogg/doc/libogg/ogg_stream_iovecin.html deleted file mode 100644 index b7cfe67..0000000 --- a/contrib/ogg/doc/libogg/ogg_stream_iovecin.html +++ /dev/null @@ -1,80 +0,0 @@ - - - -libogg - function - ogg_stream_iovecin - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    ogg_stream_iovecin

    - -

    declared in "ogg/ogg.h";

    - -

    This function submits packet data (in the form of -an array of ogg_iovec_t, rather than using -an ogg_packet structure) to the -bitstream for page encapsulation. After this is called, more packets -can be submitted, or pages can be written out.

    - -

    In a typical encoding situation, this should be used after filling a -packet with data. -The data in the packet is copied into the internal storage managed by -the ogg_stream_state, so the caller -is free to alter the contents of os after this call has returned. - -

    - - - - -
    -
    
-int ogg_stream_iovecin(ogg_stream_state *os, ogg_iovec_t *iov, int count, long e_o_s, ogg_int64_t granulepos);
-
    -
    - -

    Parameters

    -
    -
    os
    -
    Pointer to a previously declared ogg_stream_state struct.
    -
    iov
    -
    Length-encoded buffers held in an array of ogg_iovec_t. -
    count
    -
    Length of the iov array. -
    e_o_s
    -
    End of stream flag, analagous to the e_o_s field in an ogg_packet. -
    granulepos
    -
    Granule position value, analagous to the granpos field in an ogg_packet. -
    - - -

    Return Values

    -
    -
  • -0 returned on success. -1 returned in the event of internal error.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2000-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_stream_packetin.html b/contrib/ogg/doc/libogg/ogg_stream_packetin.html deleted file mode 100644 index bc05f52..0000000 --- a/contrib/ogg/doc/libogg/ogg_stream_packetin.html +++ /dev/null @@ -1,72 +0,0 @@ - - - -libogg - function - ogg_stream_packetin - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    ogg_stream_packetin

    - -

    declared in "ogg/ogg.h";

    - -

    This function submits a packet to the bitstream for page -encapsulation. After this is called, more packets can be submitted, -or pages can be written out.

    - -

    In a typical encoding situation, this should be used after filling a -packet with data. -The data in the packet is copied into the internal storage managed by -the ogg_stream_state, so the caller -is free to alter the contents of op after this call has returned. - -

    - - - - -
    -
    
-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 returned on success. -1 returned in the event of internal error.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2000-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_stream_packetout.html b/contrib/ogg/doc/libogg/ogg_stream_packetout.html deleted file mode 100644 index 148f782..0000000 --- a/contrib/ogg/doc/libogg/ogg_stream_packetout.html +++ /dev/null @@ -1,85 +0,0 @@ - - - -libogg - function - ogg_stream_packetout - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    ogg_stream_packetout

    - -

    declared in "ogg/ogg.h";

    - -

    This function assembles a data packet for output to the codec -decoding engine. The data has already been submitted to the -ogg_stream_state and broken -into 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.

    - -

    The op is filled in with pointers to memory managed by -the stream state and is only valid until the next call. The client -must copy the packet data if a longer lifetime is required.

    - -

    - - - - -
    -
    
-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. The pointers are only valid until the next call -on this stream state.
    -
    - - -

    Return Values

    -
    - -
    - -

    - -
    - - - - - - - - - -

    copyright © 2000-2010 xiph.org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

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

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    ogg_stream_packetpeek

    - -

    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 © 2000-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

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

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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_state 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, the page version was incorrect, or an internal error occurred.
    • -
  • -0 means that the page was successfully submitted to the bitstream.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2000-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_stream_pageout.html b/contrib/ogg/doc/libogg/ogg_stream_pageout.html deleted file mode 100644 index 66139e3..0000000 --- a/contrib/ogg/doc/libogg/ogg_stream_pageout.html +++ /dev/null @@ -1,84 +0,0 @@ - - - -libogg - function - ogg_stream_pageout - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    ogg_stream_pageout

    - -

    declared in "ogg/ogg.h";

    - -

    This function forms packets into pages.

    - -

    In a typical encoding situation, this would be called after using ogg_stream_packetin() to submit -data packets to the bitstream. Internally, this function assembles -the accumulated packet bodies into an Ogg page suitable for writing -to a stream. The function is typically called in a loop until there -are no more pages ready for output.

    - -

    This function will only return a page when a "reasonable" amount of -packet data is available. Normally this is appropriate since it -limits the overhead of the Ogg page headers in the bitstream, and so -calling ogg_stream_pageout() after ogg_stream_packetin() should be the -common case. Call ogg_stream_flush() -if immediate page generation is desired. This may be occasionally -necessary, for example, to limit the temporal latency of a variable -bitrate stream.

    - -

    - - - - -
    -
    
-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 an ogg_page structure to fill -in. Data pointed to is owned by libogg. The structure is valid until the -next call to ogg_stream_pageout(), ogg_stream_packetin(), or -ogg_stream_flush().
    -
    - - -

    Return Values

    -
    -
  • Zero means that insufficient data has accumulated to fill a page, or an internal error occurred. In -this case og is not modified.
    • -
  • Non-zero means that a page has been completed and returned.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2000-2010 xiph.org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_stream_pageout_fill.html b/contrib/ogg/doc/libogg/ogg_stream_pageout_fill.html deleted file mode 100644 index af95531..0000000 --- a/contrib/ogg/doc/libogg/ogg_stream_pageout_fill.html +++ /dev/null @@ -1,89 +0,0 @@ - - - -libogg - function - ogg_stream_pageout_fill - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    ogg_stream_pageout_fill

    - -

    declared in "ogg/ogg.h";

    - -

    This function forms packets into pages, similar -to ogg_stream_pageout(), but -allows applications to explicitly request a specific page spill -size.

    - -

    In a typical encoding situation, this would be called after using ogg_stream_packetin() to submit -data packets to the bitstream. Internally, this function assembles -the accumulated packet bodies into an Ogg page suitable for writing -to a stream. The function is typically called in a loop until there -are no more pages ready for output.

    - -

    This function will return a page when at least four packets have -been accumulated and accumulated packet data meets or exceeds the -specified number of bytes, and/or when the accumulated packet -data meets/exceeds the maximum page size regardless of accumulated -packet count. -Call ogg_stream_flush() or -ogg_stream_flush_fill() if -immediate page generation is desired regardless of accumulated data.

    - -

    - - - - -
    -
    
-int ogg_stream_pageout_fill(ogg_stream_state *os, ogg_page *og, int fillbytes);
-
    -
    - -

    Parameters

    -
    -
    os
    -
    Pointer to a previously declared ogg_stream struct, which represents the current logical bitstream.
    -
    og
    -
    Pointer to an ogg_page structure to fill -in. Data pointed to is owned by libogg. The structure is valid until the -next call to ogg_stream_pageout(), ogg_stream_packetin(), or -ogg_stream_flush().
    -
    fillbytes
    -
    Packet data watermark in bytes.
    -
    - - -

    Return Values

    -
    -
  • Zero means that insufficient data has accumulated to fill a page, or an internal error occurred. In -this case og is not modified.
    • -
  • Non-zero means that a page has been completed and returned.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2000-2010 xiph.org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_stream_reset.html b/contrib/ogg/doc/libogg/ogg_stream_reset.html deleted file mode 100644 index eb7ee36..0000000 --- a/contrib/ogg/doc/libogg/ogg_stream_reset.html +++ /dev/null @@ -1,61 +0,0 @@ - - - -libogg - function - ogg_stream_reset - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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 indicates success. nonzero is returned on internal error.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2000-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

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

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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 indicates success. nonzero is returned on internal error.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2000-2014 Xiph.Org Foundation

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_stream_state.html b/contrib/ogg/doc/libogg/ogg_stream_state.html deleted file mode 100644 index 6f42faf..0000000 --- a/contrib/ogg/doc/libogg/ogg_stream_state.html +++ /dev/null @@ -1,121 +0,0 @@ - - - -libogg - datatype - ogg_stream_state - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - diff --git a/contrib/ogg/doc/libogg/ogg_sync_buffer.html b/contrib/ogg/doc/libogg/ogg_sync_buffer.html deleted file mode 100644 index be7915a..0000000 --- a/contrib/ogg/doc/libogg/ogg_sync_buffer.html +++ /dev/null @@ -1,67 +0,0 @@ - - - -libogg - function - ogg_sync_buffer - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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 or NULL on error
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2000-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_sync_check.html b/contrib/ogg/doc/libogg/ogg_sync_check.html deleted file mode 100644 index daac330..0000000 --- a/contrib/ogg/doc/libogg/ogg_sync_check.html +++ /dev/null @@ -1,71 +0,0 @@ - - - -libogg - function - ogg_sync_check - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    ogg_sync_check

    - -

    declared in "ogg/ogg.h";

    - -

    This function is used to check the error or readiness condition of an ogg_sync_state structure. -

    It is safe practice to ignore unrecoverable errors (such as an internal error caused by a malloc() failure) returned by ogg stream synchronization calls. Should an -internal error occur, the ogg_sync_state structure will be cleared (equivalent to a -call to -ogg_sync_clear) and subsequent calls -using this ogg_sync_state will be -noops. Error detection is then handled via a single call to -ogg_sync_check at the end of the operational block.

    - -

    - - - - -
    -
    
-int ogg_sync_check(ogg_sync_state *oy);
-
    -
    - -

    Parameters

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

    Return Values

    -
    -
  • -0 is returned if the ogg_sync_state structure is initialized and ready.
    • -
  • -nonzero is returned if the structure was never initialized, or if an unrecoverable internal error occurred in a previous call using the passed in ogg_sync_state struct.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2000-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_sync_clear.html b/contrib/ogg/doc/libogg/ogg_sync_clear.html deleted file mode 100644 index 209317b..0000000 --- a/contrib/ogg/doc/libogg/ogg_sync_clear.html +++ /dev/null @@ -1,62 +0,0 @@ - - - -libogg - function - ogg_sync_clear - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_sync_destroy.html b/contrib/ogg/doc/libogg/ogg_sync_destroy.html deleted file mode 100644 index 333faf3..0000000 --- a/contrib/ogg/doc/libogg/ogg_sync_destroy.html +++ /dev/null @@ -1,68 +0,0 @@ - - - -libogg - function - ogg_sync_destroy - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    ogg_sync_destroy

    - -

    declared in "ogg/ogg.h";

    - -

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

    - -

    Note this calls free() on its argument so you should only use this -function if you've allocated the ogg_sync_state on the heap. If it is -allocated on the stack, or it will otherwise be freed by your -own code, use ogg_sync_clear instead -to release just the internal memory.

    - -

    - - - - -
    -
    
-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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_sync_init.html b/contrib/ogg/doc/libogg/ogg_sync_init.html deleted file mode 100644 index 590edc8..0000000 --- a/contrib/ogg/doc/libogg/ogg_sync_init.html +++ /dev/null @@ -1,63 +0,0 @@ - - - -libogg - function - ogg_sync_init - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_sync_pageout.html b/contrib/ogg/doc/libogg/ogg_sync_pageout.html deleted file mode 100644 index 5f3f24c..0000000 --- a/contrib/ogg/doc/libogg/ogg_sync_pageout.html +++ /dev/null @@ -1,77 +0,0 @@ - - - -libogg - function - ogg_sync_pageout - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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 returned if stream has not yet captured sync (bytes were skipped).
    • -
  • 0 returned if more data needed or an internal error occurred.
    • -
  • 1 indicated a page was synced and returned.
    • -
    -

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_sync_pageseek.html b/contrib/ogg/doc/libogg/ogg_sync_pageseek.html deleted file mode 100644 index b2efe89..0000000 --- a/contrib/ogg/doc/libogg/ogg_sync_pageseek.html +++ /dev/null @@ -1,68 +0,0 @@ - - - -libogg - function - ogg_sync_pageseek - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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, or than an internal error occurred. 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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_sync_reset.html b/contrib/ogg/doc/libogg/ogg_sync_reset.html deleted file mode 100644 index 12cd6c1..0000000 --- a/contrib/ogg/doc/libogg/ogg_sync_reset.html +++ /dev/null @@ -1,63 +0,0 @@ - - - -libogg - function - ogg_sync_reset - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/ogg_sync_state.html b/contrib/ogg/doc/libogg/ogg_sync_state.html deleted file mode 100644 index 78f8388..0000000 --- a/contrib/ogg/doc/libogg/ogg_sync_state.html +++ /dev/null @@ -1,77 +0,0 @@ - - - -libogg - datatype - ogg_sync_state - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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, synchronized, verified, and parsed into pages belonging to the various logical bistreams in the current physical bitstream link. -

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

    -
    - - - - - - - - -

    copyright © 2000-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - diff --git a/contrib/ogg/doc/libogg/ogg_sync_wrote.html b/contrib/ogg/doc/libogg/ogg_sync_wrote.html deleted file mode 100644 index 1825185..0000000 --- a/contrib/ogg/doc/libogg/ogg_sync_wrote.html +++ /dev/null @@ -1,73 +0,0 @@ - - - -libogg - function - ogg_sync_wrote - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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 or an internal error occurred. -
  • -0 in all other cases.
    • -
    - - -

    -
    - - - - - - - - -

    copyright © 2000-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/oggpack_adv.html b/contrib/ogg/doc/libogg/oggpack_adv.html deleted file mode 100644 index 0e67b93..0000000 --- a/contrib/ogg/doc/libogg/oggpack_adv.html +++ /dev/null @@ -1,64 +0,0 @@ - - - -libogg - function - oggpack_adv - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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 © 2000-2014 Xiph.Org Foundation

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

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

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

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

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/oggpack_buffer.html b/contrib/ogg/doc/libogg/oggpack_buffer.html deleted file mode 100644 index 906cbf9..0000000 --- a/contrib/ogg/doc/libogg/oggpack_buffer.html +++ /dev/null @@ -1,66 +0,0 @@ - - - -libogg - datatype - oggpack_buffer - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - diff --git a/contrib/ogg/doc/libogg/oggpack_bytes.html b/contrib/ogg/doc/libogg/oggpack_bytes.html deleted file mode 100644 index 4eb48fe..0000000 --- a/contrib/ogg/doc/libogg/oggpack_bytes.html +++ /dev/null @@ -1,67 +0,0 @@ - - - -libogg - function - oggpack_bytes - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    oggpack_bytes

    - -

    declared in "ogg/ogg.h";

    - -

    This function returns the total number of bytes behind the current -access point in the oggpack_buffer. -For write-initialized buffers, this is the number of complete bytes -written so far. For read-initialized buffers, it is the number of -complete bytes that have been read so far. -

    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-2010 xiph.org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/oggpack_get_buffer.html b/contrib/ogg/doc/libogg/oggpack_get_buffer.html deleted file mode 100644 index a4bfad2..0000000 --- a/contrib/ogg/doc/libogg/oggpack_get_buffer.html +++ /dev/null @@ -1,62 +0,0 @@ - - - -libogg - function - oggpack_get_buffer - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/oggpack_look.html b/contrib/ogg/doc/libogg/oggpack_look.html deleted file mode 100644 index 076eff3..0000000 --- a/contrib/ogg/doc/libogg/oggpack_look.html +++ /dev/null @@ -1,66 +0,0 @@ - - - -libogg - function - oggpack_look - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/oggpack_look1.html b/contrib/ogg/doc/libogg/oggpack_look1.html deleted file mode 100644 index 5361164..0000000 --- a/contrib/ogg/doc/libogg/oggpack_look1.html +++ /dev/null @@ -1,63 +0,0 @@ - - - -libogg - function - oggpack_look1 - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

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

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/oggpack_read1.html b/contrib/ogg/doc/libogg/oggpack_read1.html deleted file mode 100644 index 9a7e1cb..0000000 --- a/contrib/ogg/doc/libogg/oggpack_read1.html +++ /dev/null @@ -1,63 +0,0 @@ - - - -libogg - function - oggpack_read1 - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

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

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

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

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/oggpack_write.html b/contrib/ogg/doc/libogg/oggpack_write.html deleted file mode 100644 index ad1d7ee..0000000 --- a/contrib/ogg/doc/libogg/oggpack_write.html +++ /dev/null @@ -1,68 +0,0 @@ - - - -libogg - function - oggpack_write - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/oggpack_writealign.html b/contrib/ogg/doc/libogg/oggpack_writealign.html deleted file mode 100644 index acedc2c..0000000 --- a/contrib/ogg/doc/libogg/oggpack_writealign.html +++ /dev/null @@ -1,65 +0,0 @@ - - - -libogg - function - oggpack_writealign - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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 © 2000-2014 Xiph.Org Foundation

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/oggpack_writecheck.html b/contrib/ogg/doc/libogg/oggpack_writecheck.html deleted file mode 100644 index e23131b..0000000 --- a/contrib/ogg/doc/libogg/oggpack_writecheck.html +++ /dev/null @@ -1,81 +0,0 @@ - - - -libogg - function - oggpack_writecheck - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    oggpack_writecheck

    - -

    declared in "ogg/ogg.h";

    - -

    This function checks the readiness status of -an oggpack_buffer previously -initialized for writing using the -Ogg bitpacking functions. A write -buffer that encounters an error (such as a failed malloc) will clear -its internal state and release any in-use memory, flagging itself as -'not ready'. Subsequent attempts to write using the buffer will -silently fail. This error state may be detected at any later time by -using oggpack_writecheck(). It is safe but not necessary to -call oggpack_writeclear() on a buffer that -has flagged an error and released its resources. - -

    Important note to developers: Although libogg checks the -results of memory allocations, these checks are only useful on a -narrow range of embedded platforms. Allocation checks perform no -useful service on a general purpose desktop OS where pages are -routinely overallocated and all allocations succeed whether memory is -available or not. The only way to detect an out of memory condition -on the vast majority of OSes is to watch for and capture segmentation -faults. This function is useful only to embedded developers. - -

    - - - - -
    -
    
-int  oggpack_writecheck(oggpack_buffer *b);
-
    -
    - -

    Parameters

    -
    -
    b
    -
    An oggpack_buffer previously initialized for writing.
    -
    - - -

    Return Values

    -
    -
  • zero: buffer is ready for writing
    • -
  • nonzero: buffer is not ready or encountered an error
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2000-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/oggpack_writeclear.html b/contrib/ogg/doc/libogg/oggpack_writeclear.html deleted file mode 100644 index 5dadaa9..0000000 --- a/contrib/ogg/doc/libogg/oggpack_writeclear.html +++ /dev/null @@ -1,62 +0,0 @@ - - - -libogg - function - oggpack_reset - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/oggpack_writecopy.html b/contrib/ogg/doc/libogg/oggpack_writecopy.html deleted file mode 100644 index 94d3124..0000000 --- a/contrib/ogg/doc/libogg/oggpack_writecopy.html +++ /dev/null @@ -1,69 +0,0 @@ - - - -libogg - function - oggpack_writecopy - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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 © 2000-2014 Xiph.Org Foundation

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/oggpack_writeinit.html b/contrib/ogg/doc/libogg/oggpack_writeinit.html deleted file mode 100644 index 7999b9c..0000000 --- a/contrib/ogg/doc/libogg/oggpack_writeinit.html +++ /dev/null @@ -1,62 +0,0 @@ - - - -libogg - function - oggpack_writeinit - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    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-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/oggpack_writetrunc.html b/contrib/ogg/doc/libogg/oggpack_writetrunc.html deleted file mode 100644 index bf23b2e..0000000 --- a/contrib/ogg/doc/libogg/oggpack_writetrunc.html +++ /dev/null @@ -1,65 +0,0 @@ - - - -libogg - function - oggpack_writetrunc - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    oggpack_writetrunc

    - -

    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 © 2000-2014 Xiph.Org Foundation

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - - diff --git a/contrib/ogg/doc/libogg/overview.html b/contrib/ogg/doc/libogg/overview.html deleted file mode 100644 index 347ebeb..0000000 --- a/contrib/ogg/doc/libogg/overview.html +++ /dev/null @@ -1,44 +0,0 @@ - - - -libogg - API Overview - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    Libogg API Overview

    - -

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

    -

    - -

    -
    - - - - - - - - -

    copyright © 2000-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - diff --git a/contrib/ogg/doc/libogg/reference.html b/contrib/ogg/doc/libogg/reference.html deleted file mode 100644 index cfe1608..0000000 --- a/contrib/ogg/doc/libogg/reference.html +++ /dev/null @@ -1,98 +0,0 @@ - - - -Libogg API Reference - - - - - - - - - -

    libogg documentation

    libogg release 1.3.2 - 20140527

    - -

    Libogg API Reference

    - -

    -Data Structures
    -oggpack_buffer
    -ogg_page
    -ogg_stream_state
    -ogg_packet
    -ogg_sync_state
    -
    -Bitpacking
    -oggpack_writeinit()
    -oggpack_writecheck()
    -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_check()
    -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_pageout_fill()
    -ogg_stream_flush()
    -ogg_stream_flush_fill()
    -
    -General
    -ogg_stream_init()
    -ogg_stream_check()
    -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 © 2000-2014 Xiph.Org Foundation

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    - - - - diff --git a/contrib/ogg/doc/libogg/style.css b/contrib/ogg/doc/libogg/style.css deleted file mode 100644 index 81cf417..0000000 --- a/contrib/ogg/doc/libogg/style.css +++ /dev/null @@ -1,7 +0,0 @@ -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 } -- cgit v1.1