Chris@1: Chris@1: Chris@1: Chris@1: libogg - function - ogg_stream_pageout Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:

libogg documentation

libogg release 1.3.0 - 20110804

Chris@1: Chris@1:

ogg_stream_pageout

Chris@1: Chris@1:

declared in "ogg/ogg.h";

Chris@1: Chris@1:

This function forms packets into pages.

Chris@1: Chris@1:

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

Chris@1: Chris@1:

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

Chris@1: Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: 

Chris@1: int ogg_stream_pageout(ogg_stream_state *os, ogg_page *og);
Chris@1:
Chris@1:
Chris@1: Chris@1:

Parameters

Chris@1:
Chris@1:
os
Chris@1:
Pointer to a previously declared ogg_stream struct, which represents the current logical bitstream.
Chris@1:
og
Chris@1:
Pointer to an ogg_page structure to fill Chris@1: in. Data pointed to is owned by libogg. The structure is valid until the Chris@1: next call to ogg_stream_pageout(), ogg_stream_packetin(), or Chris@1: ogg_stream_flush().
Chris@1:
Chris@1: Chris@1: Chris@1:

Return Values

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

    Chris@1: Chris@1:

    Chris@1:

    Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:

    copyright © 2000-2010 xiph.org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.0 - 20110804

    Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: