Chris@1: Chris@1: Chris@1: Chris@1: libogg - function - ogg_stream_pageout_fill 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_fill

Chris@1: Chris@1:

declared in "ogg/ogg.h";

Chris@1: Chris@1:

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

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

Chris@1: Chris@1:

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

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