Chris@1: Chris@1: Chris@1: Chris@1: libogg - function - ogg_stream_packetout 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_packetout

Chris@1: Chris@1:

declared in "ogg/ogg.h";

Chris@1: Chris@1:

This function assembles a data packet for output to the codec Chris@1: decoding engine. The data has already been submitted to the Chris@1: ogg_stream_state and broken Chris@1: into segments. Each successive call returns the next complete packet Chris@1: built from those segments.

Chris@1: Chris@1:

In a typical decoding situation, this should be used after calling Chris@1: ogg_stream_pagein() to submit a Chris@1: page of data to the bitstream. If the function returns 0, more data is Chris@1: needed and another page should be submitted. A non-zero return value Chris@1: indicates successful return of a packet.

Chris@1: Chris@1:

The op is filled in with pointers to memory managed by Chris@1: the stream state and is only valid until the next call. The client Chris@1: must copy the packet data if a longer lifetime is required.

Chris@1: Chris@1:

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

Chris@1:


Chris@1: int ogg_stream_packetout(ogg_stream_state *os,ogg_packet *op);
Chris@1:

Chris@1:

Chris@1: Chris@1:

Parameters

Chris@1:

os: Pointer to a previously declared ogg_stream_state struct. Before this function is called, an ogg_page should be submitted to the stream using ogg_stream_pagein().
op: Pointer to the packet to be filled in with pointers to the new data. Chris@1: This will typically be submitted to a codec for decode after this Chris@1: function is called. The pointers are only valid until the next call Chris@1: on this stream state.

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

Return Values

Chris@1:

Chris@1:
Chris@1:
-1 if we are out of sync and there is a gap in the data. This is usually a recoverable error and subsequent calls to ogg_stream_packetout are likely to succeed. op has not been updated.
Chris@1:
0 if there is insufficient data available to complete a packet, or on unrecoverable internal error occurred. op has not been updated. Chris@1:
1 if a packet was assembled normally. op contains the next packet from the stream.
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: 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: