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

cannam@86: cannam@86:

declared in "ogg/ogg.h";

cannam@86: cannam@86:

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

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 return a page when at least four packets have cannam@86: been accumulated and accumulated packet data meets or exceeds the cannam@86: specified number of bytes, and/or when the accumulated packet cannam@86: data meets/exceeds the maximum page size regardless of accumulated cannam@86: packet count. cannam@86: Call ogg_stream_flush() or cannam@86: ogg_stream_flush_fill() if cannam@86: immediate page generation is desired regardless of accumulated data.

cannam@86: cannam@86:

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

cannam@86: int ogg_stream_pageout_fill(ogg_stream_state *os, ogg_page *og, int fillbytes);
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:
fillbytes
cannam@86:
Packet data watermark in bytes.
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: