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

cannam@86: cannam@86:

declared in "ogg/ogg.h";

cannam@86: cannam@86:

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

cannam@86: cannam@86:

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

cannam@86: cannam@86:

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

cannam@86: cannam@86:

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

cannam@86:


cannam@86: int ogg_stream_packetout(ogg_stream_state *os,ogg_packet *op);
cannam@86:

cannam@86:

cannam@86: cannam@86:

Parameters

cannam@86:

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. cannam@86: This will typically be submitted to a codec for decode after this cannam@86: function is called. The pointers are only valid until the next call cannam@86: on this stream state.

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

Return Values

cannam@86:

cannam@86:
cannam@86:
-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.
cannam@86:
0 if there is insufficient data available to complete a packet, or on unrecoverable internal error occurred. op has not been updated. cannam@86:
1 if a packet was assembled normally. op contains the next packet from the stream.
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: 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: