cannam@86: cannam@86: cannam@86: cannam@86: libogg - Encoding cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:

libogg documentation

libogg release 1.3.0 - 20110804

cannam@86: cannam@86:

Encoding

cannam@86:

Libogg contains a set of functions used in the encoding process. cannam@86:

cannam@86: All the libogg specific functions are declared in "ogg/ogg.h". cannam@86:

cannam@86:

When encoding, the encoding engine will output raw packets which must be placed into an Ogg bitstream. cannam@86:

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. cannam@86:

There are a couple of basic steps: cannam@86:

Use the encoding engine to produce a raw packet of data. cannam@86:
Call ogg_stream_packetin to submit a raw packet to the stream. cannam@86:
Use ogg_stream_pageout to output a page, if enough data has been submitted. Otherwise, continue submitting data. cannam@86:

cannam@86:

cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:

function	purpose
ogg_stream_packetin	Submits a raw packet to the streaming layer, so that it can be formed into a page.
ogg_stream_iovecin	iovec version of ogg_stream_packetin() above.
ogg_stream_pageout	Outputs a completed page if the stream contains enough packets to form a full page.	cannam@86:
ogg_stream_pageout_fill	Similar to ogg_stream_pageout(), but specifies a page spill threshold in bytes. cannam@86:
ogg_stream_flush	Forces any remaining packets in the stream to be returned as a page of any size.	cannam@86:
ogg_stream_flush_fill	Similar to ogg_stream_flush(), but specifies a page spill threshold in bytes.	cannam@86:

cannam@86: cannam@86:

cannam@86:

cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:

copyright © 2000-2011 Xiph.Org	Ogg Container Format
libogg documentation	libogg release 1.3.0 - 20110804

cannam@86: cannam@86: cannam@86: cannam@86: