EVOLUTION-MANAGER
Edit File: oggz__deprecated_8h.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.5"/> <title>liboggz: oggz_deprecated.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">liboggz  <span id="projectnumber">1.1.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d87111fb9e25a5f2a11bf853c53bb708.html">oggz</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#define-members">Macros</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">oggz_deprecated.h File Reference</div> </div> </div><!--header--> <div class="contents"> <p>Deprecated interfaces. <a href="#details">More...</a></p> <p><a href="oggz__deprecated_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> <tr class="memitem:aaa24ef96507165b2c5e1ac4108d59288"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__deprecated_8h.html#aaa24ef96507165b2c5e1ac4108d59288">OGGZ_ERR_USER_STOPPED</a>   <a class="el" href="oggz__constants_8h.html#a68ad49468cba9eb61380abd603b0f83ea5f9bde92dc6e7cc407e52e5dd61fdbf4">OGGZ_ERR_STOP_OK</a></td></tr> <tr class="memdesc:aaa24ef96507165b2c5e1ac4108d59288"><td class="mdescLeft"> </td><td class="mdescRight">DEPRECATED CONSTANT. <a href="#aaa24ef96507165b2c5e1ac4108d59288">More...</a><br/></td></tr> <tr class="separator:aaa24ef96507165b2c5e1ac4108d59288"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0d9b4d212038e72fb45d751fe750d3cf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__deprecated_8h.html#a0d9b4d212038e72fb45d751fe750d3cf">OGGZ_ERR_READ_STOP_OK</a>   <a class="el" href="oggz__constants_8h.html#a68ad49468cba9eb61380abd603b0f83ea5f9bde92dc6e7cc407e52e5dd61fdbf4">OGGZ_ERR_STOP_OK</a></td></tr> <tr class="memdesc:a0d9b4d212038e72fb45d751fe750d3cf"><td class="mdescLeft"> </td><td class="mdescRight">DEPRECATED CONSTANT. <a href="#a0d9b4d212038e72fb45d751fe750d3cf">More...</a><br/></td></tr> <tr class="separator:a0d9b4d212038e72fb45d751fe750d3cf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7fb3e5030a672e6ecfd8e8e6bf57fdfa"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__deprecated_8h.html#a7fb3e5030a672e6ecfd8e8e6bf57fdfa">OGGZ_ERR_READ_STOP_ERR</a>   <a class="el" href="oggz__constants_8h.html#a68ad49468cba9eb61380abd603b0f83ea59dffeb8be96b2ac026735f7e5bb8a2a">OGGZ_ERR_STOP_ERR</a></td></tr> <tr class="memdesc:a7fb3e5030a672e6ecfd8e8e6bf57fdfa"><td class="mdescLeft"> </td><td class="mdescRight">DEPRECATED CONSTANT. <a href="#a7fb3e5030a672e6ecfd8e8e6bf57fdfa">More...</a><br/></td></tr> <tr class="separator:a7fb3e5030a672e6ecfd8e8e6bf57fdfa"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:a12f232bca448853e66a1226ddccff7e0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__deprecated_8h.html#a12f232bca448853e66a1226ddccff7e0">oggz_set_metric_linear</a> (<a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz, long serialno, ogg_int64_t granule_rate_numerator, ogg_int64_t granule_rate_denominator)</td></tr> <tr class="memdesc:a12f232bca448853e66a1226ddccff7e0"><td class="mdescLeft"> </td><td class="mdescRight">DEPRECATED FUNCTION This function has been replaced with the more clearly named <a class="el" href="group__metric.html#gaa2a86ec590161bc2295a2c8e91cefa49" title="Specify the granulerate of a logical bitstream. ">oggz_set_granulerate()</a>. <a href="#a12f232bca448853e66a1226ddccff7e0">More...</a><br/></td></tr> <tr class="separator:a12f232bca448853e66a1226ddccff7e0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aab908fe161372aceb99f98a3be54ead5"><td class="memItemLeft" align="right" valign="top">ogg_packet * </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__deprecated_8h.html#aab908fe161372aceb99f98a3be54ead5">oggz_comment_generate</a> (<a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz, long serialno, <a class="el" href="oggz__constants_8h.html#ab20058e3d54fc5540aa719a99e1e9598">OggzStreamContent</a> packet_type, int FLAC_final_metadata_block)</td></tr> <tr class="memdesc:aab908fe161372aceb99f98a3be54ead5"><td class="mdescLeft"> </td><td class="mdescRight">DEPRECATED FUNCTION This function has been replaced with <a class="el" href="oggz__comments_8h.html#a1ee69481fa517d80e63db962a23d53ae" title="Output a comment packet for the specified stream. ">oggz_comments_generate()</a>, which does not require the packet_type argument. <a href="#aab908fe161372aceb99f98a3be54ead5">More...</a><br/></td></tr> <tr class="separator:aab908fe161372aceb99f98a3be54ead5"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Deprecated interfaces. </p> </div><h2 class="groupheader">Macro Definition Documentation</h2> <a class="anchor" id="a7fb3e5030a672e6ecfd8e8e6bf57fdfa"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define OGGZ_ERR_READ_STOP_ERR   <a class="el" href="oggz__constants_8h.html#a68ad49468cba9eb61380abd603b0f83ea59dffeb8be96b2ac026735f7e5bb8a2a">OGGZ_ERR_STOP_ERR</a></td> </tr> </table> </div><div class="memdoc"> <p>DEPRECATED CONSTANT. </p> <p>OGGZ_ERR_READ_STOP_OK, OGGZ_ERR_READ_STOP_ERR were introduced to allow the user to differentiate between a cancelled oggz_read_*() returning due to error or an ok condition. From 0.9.4 similar functionality was added for oggz_write_*(), hence this constant was renamed. </p> </div> </div> <a class="anchor" id="a0d9b4d212038e72fb45d751fe750d3cf"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define OGGZ_ERR_READ_STOP_OK   <a class="el" href="oggz__constants_8h.html#a68ad49468cba9eb61380abd603b0f83ea5f9bde92dc6e7cc407e52e5dd61fdbf4">OGGZ_ERR_STOP_OK</a></td> </tr> </table> </div><div class="memdoc"> <p>DEPRECATED CONSTANT. </p> <p>OGGZ_ERR_READ_STOP_OK, OGGZ_ERR_READ_STOP_ERR were introduced to allow the user to differentiate between a cancelled oggz_read_*() returning due to error or an ok condition. From 0.9.4 similar functionality was added for oggz_write_*(), hence this constant was renamed. </p> </div> </div> <a class="anchor" id="aaa24ef96507165b2c5e1ac4108d59288"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define OGGZ_ERR_USER_STOPPED   <a class="el" href="oggz__constants_8h.html#a68ad49468cba9eb61380abd603b0f83ea5f9bde92dc6e7cc407e52e5dd61fdbf4">OGGZ_ERR_STOP_OK</a></td> </tr> </table> </div><div class="memdoc"> <p>DEPRECATED CONSTANT. </p> <p>OGGZ_ERR_USER_STOPPED was introduced during development (post 0.8.3), and is similar in functionality to and numerically equal to (ie. ABI compatible with) OGGZ_ERR_STOP_OK in <<a class="el" href="oggz__constants_8h.html" title="General constants used by liboggz. ">oggz/oggz_constants.h</a>>. It was badly named, as the preferred functionality distinguishes between a user's OggzReadCallback returning OGGZ_STOP_OK or OGGZ_STOP_ERR; your code should distinguish between these two too :-) Hence, don't use this (unreleased) name in new code. </p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="aab908fe161372aceb99f98a3be54ead5"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ogg_packet* oggz_comment_generate </td> <td>(</td> <td class="paramtype"><a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * </td> <td class="paramname"><em>oggz</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">long </td> <td class="paramname"><em>serialno</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="oggz__constants_8h.html#ab20058e3d54fc5540aa719a99e1e9598">OggzStreamContent</a> </td> <td class="paramname"><em>packet_type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>FLAC_final_metadata_block</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>DEPRECATED FUNCTION This function has been replaced with <a class="el" href="oggz__comments_8h.html#a1ee69481fa517d80e63db962a23d53ae" title="Output a comment packet for the specified stream. ">oggz_comments_generate()</a>, which does not require the packet_type argument. </p> <p>Instead, the packet type is determined by the content type of the stream, which was discovered when the bos packet was passed to oggz_write_feed.</p> <p>Output a comment packet for the specified stream. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">oggz</td><td>A OGGZ* handle (created with OGGZ_WRITE) </td></tr> <tr><td class="paramname">serialno</td><td>Identify a logical bitstream within <em>oggz</em> </td></tr> <tr><td class="paramname">packet_type</td><td>Type of comment packet to generate, FLAC, OggPCM, Speex, Theora and Vorbis are supported </td></tr> <tr><td class="paramname">FLAC_final_metadata_block</td><td>Set this to zero unless the packet_type is FLAC, and there are no further metadata blocks to follow. See note below for details. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A comment packet for the stream. When no longer needed it should be freed with <a class="el" href="oggz__comments_8h.html#a9301332e99b0397cff54c3593595b809" title="Free a packet and its payload. ">oggz_packet_destroy()</a>. </dd></dl> <dl class="retval"><dt>Return values</dt><dd> <table class="retval"> <tr><td class="paramname">NULL</td><td>content type does not support comments, not enough memory or comment was too long for FLAC </td></tr> </table> </dd> </dl> <dl class="section note"><dt>Note</dt><dd>FLAC streams may contain multiple metadata blocks of different types. When encapsulated in Ogg the first of these must be a Vorbis comment packet but PADDING, APPLICATION, SEEKTABLE, CUESHEET and PICTURE may follow. The last metadata block must have its first bit set to 1. Since liboggz does not know whether you will supply more metadata blocks you must tell it if this is the last (or only) metadata block by setting FLAC_final_metadata_block to 1. <br/> As FLAC metadata blocks are limited in size to 16MB minus 1 byte, this function will refuse to produce longer comment packets for FLAC. <br/> See <a href="http://flac.sourceforge.net/format.html">http://flac.sourceforge.net/format.html</a> for more details. </dd></dl> </div> </div> <a class="anchor" id="a12f232bca448853e66a1226ddccff7e0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int oggz_set_metric_linear </td> <td>(</td> <td class="paramtype"><a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * </td> <td class="paramname"><em>oggz</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">long </td> <td class="paramname"><em>serialno</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">ogg_int64_t </td> <td class="paramname"><em>granule_rate_numerator</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">ogg_int64_t </td> <td class="paramname"><em>granule_rate_denominator</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>DEPRECATED FUNCTION This function has been replaced with the more clearly named <a class="el" href="group__metric.html#gaa2a86ec590161bc2295a2c8e91cefa49" title="Specify the granulerate of a logical bitstream. ">oggz_set_granulerate()</a>. </p> <p>Specify that a logical bitstream has a linear metric </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">oggz</td><td>An OGGZ handle </td></tr> <tr><td class="paramname">serialno</td><td>Identify the logical bitstream in <em>oggz</em> to attach this linear metric to. A value of -1 indicates that the metric should be attached to all unattached logical bitstreams in <em>oggz</em>. </td></tr> <tr><td class="paramname">granule_rate_numerator</td><td>The numerator of the granule rate </td></tr> <tr><td class="paramname">granule_rate_denominator</td><td>The denominator of the granule rate </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>0 Success </dd></dl> <dl class="retval"><dt>Return values</dt><dd> <table class="retval"> <tr><td class="paramname">OGGZ_ERR_BAD_SERIALNO</td><td><em>serialno</em> does not identify an existing logical bitstream in <em>oggz</em>. </td></tr> <tr><td class="paramname">OGGZ_ERR_BAD_OGGZ</td><td><em>oggz</em> does not refer to an existing OGGZ </td></tr> </table> </dd> </dl> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>