cannam@86: cannam@86: cannam@86: cannam@86: libvorbis - function - vorbis_analysis_headerout cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:

libvorbis documentation

libvorbis version 1.3.2 - 20101101

cannam@86: cannam@86:

vorbis_analysis_headerout

cannam@86: cannam@86:

declared in "vorbis/codec.h";

cannam@86: cannam@86:

This function creates and returns the three header packets needed cannam@86: to configure a decoder to accept compressed data. I should be called cannam@86: after all encoder initialization and configuration is complete. The cannam@86: output packets should be placed in order at the start of the compressed cannam@86: vorbis stream, prior to the first data packet. cannam@86:

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

cannam@86:


cannam@86: extern int      vorbis_analysis_headerout(vorbis_dsp_state *v,
cannam@86:                                           vorbis_comment *vc,
cannam@86:                                           ogg_packet *op,
cannam@86:                                           ogg_packet *op_comm,
cannam@86:                                           ogg_packet *op_code);
cannam@86:

cannam@86:

cannam@86: cannam@86:

Parameters

cannam@86:

v: Pointer to an initialized vorbis_dsp_state which holds the encoder configuration.
vc: Pointer to an initialized vorbis_comment structure which holds the metadata associated with the stream being encoded.
op: Pointer to an ogg_packet structure to be filled out with the stream identification header.
op_comm: Pointer to an ogg_packet structure to be filled out with the serialied vorbis_comment data.
op_code: Pointer to an ogg_packet structure to be filled out with the codebooks, mode descriptions, etc. which will be used encoding the stream.

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

Return Values

cannam@86:

0 for success
negative values for failure: cannam@86:
- OV_EFAULT - Internal fault; indicates a bug or memory corruption.
- OV_EIMPL - Unimplemented; not supported by this version of the library.
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 © 2010 Xiph.Org	Ogg Vorbis
libvorbis documentation	libvorbis version 1.3.2 - 20101101

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