cannam@86: cannam@86: cannam@86: cannam@86: libogg - function - ogg_stream_pageout 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:

ogg_stream_pageout

cannam@86: cannam@86:

declared in "ogg/ogg.h";

cannam@86: cannam@86:

This function forms packets into pages.

cannam@86: cannam@86:

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

cannam@86: cannam@86:

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

cannam@86: cannam@86:

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

cannam@86: int ogg_stream_pageout(ogg_stream_state *os, ogg_page *og);
cannam@86:
cannam@86:
cannam@86: cannam@86:

Parameters

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

Return Values

cannam@86:
cannam@86:
  • Zero means that insufficient data has accumulated to fill a page, or an internal error occurred. In cannam@86: this case og is not modified.
    • cannam@86:
  • Non-zero means that a page has been completed and returned.
    • 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:

    copyright © 2000-2010 xiph.org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.0 - 20110804

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