<!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"/>
<title>liboggz: Using OggzMetric</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Using OggzMetric</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef ogg_int64_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__metric.html#ga8803bb406015a32f5172902e3e4e76e8">OggzMetric</a> )(<a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz, long serialno, ogg_int64_t granulepos, void *user_data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is the signature of a function to correlate Ogg streams. <a href="#ga8803bb406015a32f5172902e3e4e76e8"></a><br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__metric.html#gab411ab113d5f0f67bf77506724c25633">oggz_get_preroll</a> (<a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz, long serialno)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the preroll of a logical bitstream. <a href="#gab411ab113d5f0f67bf77506724c25633"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__metric.html#gaa2b4ab5be298a11b5b91147b76996c83">oggz_set_preroll</a> (<a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz, long serialno, int preroll)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Specify the preroll of a logical bitstream. <a href="#gaa2b4ab5be298a11b5b91147b76996c83"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__metric.html#gad9b55e525a6e0b994a133314fd78e2c0">oggz_get_granuleshift</a> (<a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz, long serialno)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the granuleshift of a logical bitstream. <a href="#gad9b55e525a6e0b994a133314fd78e2c0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__metric.html#ga7ca67e0344580bf1541b9fbde39d481b">oggz_set_granuleshift</a> (<a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz, long serialno, int granuleshift)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Specify the granuleshift of a logical bitstream. <a href="#ga7ca67e0344580bf1541b9fbde39d481b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__metric.html#ga72a9a24e6f8483986859d7697fa611b6">oggz_get_granulerate</a> (<a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz, long serialno, ogg_int64_t *granulerate_n, ogg_int64_t *granulerate_d)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the granulerate of a logical bitstream. <a href="#ga72a9a24e6f8483986859d7697fa611b6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__metric.html#gaa2a86ec590161bc2295a2c8e91cefa49">oggz_set_granulerate</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><td class="mdescLeft"> </td><td class="mdescRight">Specify the granulerate of a logical bitstream. <a href="#gaa2a86ec590161bc2295a2c8e91cefa49"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__metric.html#ga5a630e8dcd04e1dd6601d8f56f0af3f6">oggz_set_metric</a> (<a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz, long serialno, <a class="el" href="group__metric.html#ga8803bb406015a32f5172902e3e4e76e8">OggzMetric</a> metric, void *user_data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the OggzMetric to use for an OGGZ handle. <a href="#ga5a630e8dcd04e1dd6601d8f56f0af3f6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__metric.html#gaaec9a54e9b231797d245042ce23b619a">oggz_set_data_start</a> (<a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz, oggz_off_t offset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell Oggz to remember the given offset as the start of data. <a href="#gaaec9a54e9b231797d245042ce23b619a"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h2><a class="anchor" id="metric_intro">
Introduction</a></h2>
<p>An OggzMetric is a helper function for Oggz's seeking mechanism.</p>
<p>If every position in an Ogg stream can be described by a metric such as time, then it is possible to define a function that, given a serialno and granulepos, returns a measurement in units such as milliseconds. Oggz will use this function repeatedly while seeking in order to navigate through the Ogg stream.</p>
<p>The meaning of the units is arbitrary, but must be consistent across all logical bitstreams. This allows Oggz to seek accurately through Ogg bitstreams containing multiple logical bitstreams such as tracks of media.</p>
<h2><a class="anchor" id="setting">
How to set metrics</a></h2>
<p>You don't need to set metrics for Speex, Vorbis, FLAC, Theora, CMML or Annodex. These can be handled <a class="el" href="group__seek__api.html">automatically </a> by Oggz.</p>
<p>For most others it is simply a matter of providing a "granulerate": a frame or sampling rate, if each packet's granulepos represents a sample number.</p>
<ul>
<li>Set the <em>granule_rate_numerator</em> and <em>granule_rate_denominator</em> appropriately using <a class="el" href="group__metric.html#gaa2a86ec590161bc2295a2c8e91cefa49" title="Specify the granulerate of a logical bitstream.">oggz_set_granulerate()</a></li>
</ul>
<p>Some codecs use a "granuleshift" to divide a granulepos into two halves; the first describing a dependency on a previous packet, the second giving the offset since that packet. This is used to mark keyframes and intermediate frames.</p>
<ul>
<li>Set the <em>granuleshift</em> appropriately using <a class="el" href="group__metric.html#ga7ca67e0344580bf1541b9fbde39d481b" title="Specify the granuleshift of a logical bitstream.">oggz_set_granuleshift()</a></li>
</ul>
<h3><a class="anchor" id="custom">
Custom Metrics</a></h3>
<p>For streams with non-linear granulepos, you need to set a custom metric:</p>
<ul>
<li>Implement an OggzMetric callback</li>
<li>Set the OggzMetric callback using <a class="el" href="group__metric.html#ga5a630e8dcd04e1dd6601d8f56f0af3f6" title="Set the OggzMetric to use for an OGGZ handle.">oggz_set_metric()</a></li>
</ul>
<h2><a class="anchor" id="using">
Seeking with OggzMetrics</a></h2>
<p>To seek, use <a class="el" href="group__seek__api.html#ga60bac88ef3695629efacec43a21927e5" title="Seek to an offset in milliseconds, or custom units as specified by a Metric function...">oggz_seek_units()</a>. Oggz will perform a ratio search through the Ogg bitstream, using the OggzMetric callback to determine its position relative to the desired unit.</p>
<dl class="note"><dt><b>Note:</b></dt><dd></dd></dl>
<p>Many data streams begin with headers describing such things as codec setup parameters. One of the assumptions Monty makes is:</p>
<ul>
<li>Given pre-cached decode headers, a player may seek into a stream at any point and begin decode.</li>
</ul>
<p>Thus, the first action taken by applications dealing with such data is to read in and cache the decode headers; thereafter the application can safely seek to arbitrary points in the data.</p>
<p>This impacts seeking because the portion of the bitstream containing decode headers should not be considered part of the metric space. To inform Oggz not to seek earlier than the end of the decode headers, use <a class="el" href="group__metric.html#gaaec9a54e9b231797d245042ce23b619a" title="Tell Oggz to remember the given offset as the start of data.">oggz_set_data_start()</a>. </p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="ga8803bb406015a32f5172902e3e4e76e8"></a><!-- doxytag: member="oggz_seek.h::OggzMetric" ref="ga8803bb406015a32f5172902e3e4e76e8" args=")(OGGZ *oggz, long serialno, ogg_int64_t granulepos, void *user_data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef ogg_int64_t(* <a class="el" href="group__metric.html#ga8803bb406015a32f5172902e3e4e76e8">OggzMetric</a>)(<a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz, long serialno, ogg_int64_t granulepos, void *user_data)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is the signature of a function to correlate Ogg streams. </p>
<p>If every position in an Ogg stream can be described by a metric (eg. time) then define this function that returns some arbitrary unit value. This is the normal use of Oggz for media streams. The meaning of units is arbitrary, but must be consistent across all logical bitstreams; for example a conversion of the time offset of a given packet into nanoseconds or a similar stream-specific subdivision may be appropriate.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>oggz</em> </td><td>An OGGZ handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>serialno</em> </td><td>Identifies a logical bitstream within <em>oggz</em> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>granulepos</em> </td><td>A granulepos within the logical bitstream identified by <em>serialno</em> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>user_data</em> </td><td>Arbitrary data you wish to pass to your callback </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A conversion of the (serialno, granulepos) pair into a measure in units which is consistent across all logical bitstreams within <em>oggz</em> </dd></dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga72a9a24e6f8483986859d7697fa611b6"></a><!-- doxytag: member="oggz_seek.h::oggz_get_granulerate" ref="ga72a9a24e6f8483986859d7697fa611b6" args="(OGGZ *oggz, long serialno, ogg_int64_t *granulerate_n, ogg_int64_t *granulerate_d)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oggz_get_granulerate </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>granulerate_n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ogg_int64_t * </td>
<td class="paramname"> <em>granulerate_d</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the granulerate of a logical bitstream. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>oggz</em> </td><td>An OGGZ handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>serialno</em> </td><td>Identify the logical bitstream in <em>oggz</em> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>granulerate_n</em> </td><td>Return location for the granulerate numerator </td></tr>
<tr><td valign="top"></td><td valign="top"><em>granulerate_d</em> </td><td>Return location for the granulerate denominator </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 Success </dd></dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_BAD_SERIALNO</em> </td><td><em>serialno</em> does not identify an existing logical bitstream in <em>oggz</em>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_BAD_OGGZ</em> </td><td><em>oggz</em> does not refer to an existing OGGZ </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gad9b55e525a6e0b994a133314fd78e2c0"></a><!-- doxytag: member="oggz_seek.h::oggz_get_granuleshift" ref="gad9b55e525a6e0b994a133314fd78e2c0" args="(OGGZ *oggz, long serialno)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oggz_get_granuleshift </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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the granuleshift of a logical bitstream. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>oggz</em> </td><td>An OGGZ handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>serialno</em> </td><td>Identify the logical bitstream in <em>oggz</em> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The granuleshift of the specified logical bitstream. </dd></dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_BAD_SERIALNO</em> </td><td><em>serialno</em> does not identify an existing logical bitstream in <em>oggz</em>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_BAD_OGGZ</em> </td><td><em>oggz</em> does not refer to an existing OGGZ </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gab411ab113d5f0f67bf77506724c25633"></a><!-- doxytag: member="oggz_seek.h::oggz_get_preroll" ref="gab411ab113d5f0f67bf77506724c25633" args="(OGGZ *oggz, long serialno)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oggz_get_preroll </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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the preroll of a logical bitstream. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>oggz</em> </td><td>An OGGZ handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>serialno</em> </td><td>Identify the logical bitstream in <em>oggz</em> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The preroll of the specified logical bitstream. </dd></dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_BAD_SERIALNO</em> </td><td><em>serialno</em> does not identify an existing logical bitstream in <em>oggz</em>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_BAD_OGGZ</em> </td><td><em>oggz</em> does not refer to an existing OGGZ </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaaec9a54e9b231797d245042ce23b619a"></a><!-- doxytag: member="oggz_seek.h::oggz_set_data_start" ref="gaaec9a54e9b231797d245042ce23b619a" args="(OGGZ *oggz, oggz_off_t offset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oggz_set_data_start </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">oggz_off_t </td>
<td class="paramname"> <em>offset</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tell Oggz to remember the given offset as the start of data. </p>
<p>This informs the seeking mechanism that when seeking back to unit 0, go to the given offset, not to the start of the file, which is usually codec headers. The usual usage is: </p>
<pre>
oggz_set_data_start (oggz, oggz_tell (oggz));
</pre> <dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>oggz</em> </td><td>An OGGZ handle previously opened for reading </td></tr>
<tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>The offset of the start of data </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, -1 on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="gaa2a86ec590161bc2295a2c8e91cefa49"></a><!-- doxytag: member="oggz_seek.h::oggz_set_granulerate" ref="gaa2a86ec590161bc2295a2c8e91cefa49" args="(OGGZ *oggz, long serialno, ogg_int64_t granule_rate_numerator, ogg_int64_t granule_rate_denominator)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oggz_set_granulerate </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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Specify the granulerate of a logical bitstream. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>oggz</em> </td><td>An OGGZ handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>serialno</em> </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 valign="top"></td><td valign="top"><em>granule_rate_numerator</em> </td><td>The numerator of the granule rate </td></tr>
<tr><td valign="top"></td><td valign="top"><em>granule_rate_denominator</em> </td><td>The denominator of the granule rate </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 Success </dd></dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_BAD_SERIALNO</em> </td><td><em>serialno</em> does not identify an existing logical bitstream in <em>oggz</em>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_BAD_OGGZ</em> </td><td><em>oggz</em> does not refer to an existing OGGZ </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga7ca67e0344580bf1541b9fbde39d481b"></a><!-- doxytag: member="oggz_seek.h::oggz_set_granuleshift" ref="ga7ca67e0344580bf1541b9fbde39d481b" args="(OGGZ *oggz, long serialno, int granuleshift)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oggz_set_granuleshift </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">int </td>
<td class="paramname"> <em>granuleshift</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Specify the granuleshift of a logical bitstream. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>oggz</em> </td><td>An OGGZ handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>serialno</em> </td><td>Identify the logical bitstream in <em>oggz</em> to attach this granuleshift 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 valign="top"></td><td valign="top"><em>granuleshift</em> </td><td>The granuleshift </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 Success </dd></dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_BAD_SERIALNO</em> </td><td><em>serialno</em> does not identify an existing logical bitstream in <em>oggz</em>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_BAD_OGGZ</em> </td><td><em>oggz</em> does not refer to an existing OGGZ </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga5a630e8dcd04e1dd6601d8f56f0af3f6"></a><!-- doxytag: member="oggz_seek.h::oggz_set_metric" ref="ga5a630e8dcd04e1dd6601d8f56f0af3f6" args="(OGGZ *oggz, long serialno, OggzMetric metric, void *user_data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oggz_set_metric </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="group__metric.html#ga8803bb406015a32f5172902e3e4e76e8">OggzMetric</a> </td>
<td class="paramname"> <em>metric</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>user_data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the OggzMetric to use for an OGGZ handle. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>oggz</em> </td><td>An OGGZ handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>serialno</em> </td><td>Identify the logical bitstream in <em>oggz</em> to attach this metric to. A value of -1 indicates that this metric should be attached to all unattached logical bitstreams in <em>oggz</em>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>metric</em> </td><td>An OggzMetric callback </td></tr>
<tr><td valign="top"></td><td valign="top"><em>user_data</em> </td><td>arbitrary data to pass to the metric callback</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 Success </dd></dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_BAD_SERIALNO</em> </td><td><em>serialno</em> does not identify an existing logical bitstream in <em>oggz</em>, and is not -1 </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_BAD_OGGZ</em> </td><td><em>oggz</em> does not refer to an existing OGGZ</td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Specifying values of <em>serialno</em> other than -1 allows you to pass logical bitstream specific user_data to the same metric. </dd>
<dd>
Alternatively, you may use a different <em>metric</em> for each <em>serialno</em>, but all metrics used must return mutually consistent unit measurements. </dd></dl>
</div>
</div>
<a class="anchor" id="gaa2b4ab5be298a11b5b91147b76996c83"></a><!-- doxytag: member="oggz_seek.h::oggz_set_preroll" ref="gaa2b4ab5be298a11b5b91147b76996c83" args="(OGGZ *oggz, long serialno, int preroll)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oggz_set_preroll </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">int </td>
<td class="paramname"> <em>preroll</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Specify the preroll of a logical bitstream. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>oggz</em> </td><td>An OGGZ handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>serialno</em> </td><td>Identify the logical bitstream in <em>oggz</em> to attach this preroll to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>preroll</em> </td><td>The preroll </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 Success </dd></dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_BAD_SERIALNO</em> </td><td><em>serialno</em> does not identify an existing logical bitstream in <em>oggz</em>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_BAD_OGGZ</em> </td><td><em>oggz</em> does not refer to an existing OGGZ </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Apr 24 09:13:55 2010 for liboggz by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>