Mercurial > hg > sv-dependency-builds
comparison src/libvorbis-1.3.3/doc/libvorbis/vorbis_analysis_headerout.html @ 1:05aa0afa9217
Bring in flac, ogg, vorbis
| author | Chris Cannam |
|---|---|
| date | Tue, 19 Mar 2013 17:37:49 +0000 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 0:c7265573341e | 1:05aa0afa9217 |
|---|---|
| 1 <html> | |
| 2 | |
| 3 <head> | |
| 4 <title>libvorbis - function - vorbis_analysis_headerout</title> | |
| 5 <link rel=stylesheet href="style.css" type="text/css"> | |
| 6 </head> | |
| 7 | |
| 8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> | |
| 9 <table border=0 width=100%> | |
| 10 <tr> | |
| 11 <td><p class=tiny>libvorbis documentation</p></td> | |
| 12 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> | |
| 13 </tr> | |
| 14 </table> | |
| 15 | |
| 16 <h1>vorbis_analysis_headerout</h1> | |
| 17 | |
| 18 <p><i>declared in "vorbis/codec.h";</i></p> | |
| 19 | |
| 20 <p>This function creates and returns the three header packets needed | |
| 21 to configure a decoder to accept compressed data. I should be called | |
| 22 after all encoder initialization and configuration is complete. The | |
| 23 output packets should be placed in order at the start of the compressed | |
| 24 vorbis stream, prior to the first data packet. | |
| 25 </p> | |
| 26 | |
| 27 <table border=0 color=black cellspacing=0 cellpadding=7> | |
| 28 <tr bgcolor=#cccccc> | |
| 29 <td> | |
| 30 <pre><b> | |
| 31 extern int vorbis_analysis_headerout(vorbis_dsp_state *v, | |
| 32 vorbis_comment *vc, | |
| 33 ogg_packet *op, | |
| 34 ogg_packet *op_comm, | |
| 35 ogg_packet *op_code); | |
| 36 </b></pre> | |
| 37 </td> | |
| 38 </tr> | |
| 39 </table> | |
| 40 | |
| 41 <h3>Parameters</h3> | |
| 42 <dl> | |
| 43 <dt><i>v</i></dt> | |
| 44 <dd>Pointer to an initialized vorbis_dsp_state which holds the encoder configuration.</dd> | |
| 45 <dt><i>vc</i></dt> | |
| 46 <dd>Pointer to an initialized vorbis_comment structure which holds the metadata associated with the stream being encoded.</dd> | |
| 47 <dt><i>op</i></dt> | |
| 48 <dd>Pointer to an ogg_packet structure to be filled out with the stream identification header.</dd> | |
| 49 <dt><i>op_comm</i></dt> | |
| 50 <dd>Pointer to an ogg_packet structure to be filled out with the serialied vorbis_comment data.</dd> | |
| 51 <dt><i>op_code</i></dt> | |
| 52 <dd>Pointer to an ogg_packet structure to be filled out with the codebooks, mode descriptions, etc. which will be used encoding the stream.</dd> | |
| 53 </dl> | |
| 54 | |
| 55 | |
| 56 <h3>Return Values</h3> | |
| 57 <ul> | |
| 58 <li>0 for success</li> | |
| 59 <li>negative values for failure: | |
| 60 <ul> | |
| 61 <li>OV_EFAULT - Internal fault; indicates a bug or memory corruption.</li> | |
| 62 <li>OV_EIMPL - Unimplemented; not supported by this version of the library.</li> | |
| 63 </ul> | |
| 64 </li> | |
| 65 </ul> | |
| 66 <p> | |
| 67 | |
| 68 <br><br> | |
| 69 <hr noshade> | |
| 70 <table border=0 width=100%> | |
| 71 <tr valign=top> | |
| 72 <td><p class=tiny>copyright © 2010 Xiph.Org</p></td> | |
| 73 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> | |
| 74 </tr><tr> | |
| 75 <td><p class=tiny>libvorbis documentation</p></td> | |
| 76 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> | |
| 77 </tr> | |
| 78 </table> | |
| 79 | |
| 80 | |
| 81 </body> | |
| 82 | |
| 83 </html> |