<!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.8"/>
<title>SphinxBase: include/sphinxbase/yin.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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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">SphinxBase
 <span id="projectnumber">0.6</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('yin_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">yin.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Implementation of pitch estimation.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <sphinxbase/sphinxbase_export.h></code><br />
<code>#include <<a class="el" href="prim__type_8h_source.html">sphinxbase/prim_type.h</a>></code><br />
</div>
<p><a href="yin_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="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a69a22f00f601c099b232e01b94704c2c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a69a22f00f601c099b232e01b94704c2c"></a>
typedef struct <a class="el" href="structyin__s.html">yin_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="yin_8h.html#a69a22f00f601c099b232e01b94704c2c">yin_t</a></td></tr>
<tr class="memdesc:a69a22f00f601c099b232e01b94704c2c"><td class="mdescLeft"> </td><td class="mdescRight">Frame-based moving-window pitch estimator. <br /></td></tr>
<tr class="separator:a69a22f00f601c099b232e01b94704c2c"><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:afc3a955f8d2215ed3d660737643c4f32"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afc3a955f8d2215ed3d660737643c4f32"></a>
SPHINXBASE_EXPORT <a class="el" href="yin_8h.html#a69a22f00f601c099b232e01b94704c2c">yin_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="yin_8h.html#afc3a955f8d2215ed3d660737643c4f32">yin_init</a> (int frame_size, float search_threshold, float search_range, int smooth_window)</td></tr>
<tr class="memdesc:afc3a955f8d2215ed3d660737643c4f32"><td class="mdescLeft"> </td><td class="mdescRight">Initialize moving-window pitch estimation. <br /></td></tr>
<tr class="separator:afc3a955f8d2215ed3d660737643c4f32"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae587e0d984966c482f21ee4cb0952dd0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae587e0d984966c482f21ee4cb0952dd0"></a>
SPHINXBASE_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="yin_8h.html#ae587e0d984966c482f21ee4cb0952dd0">yin_free</a> (<a class="el" href="yin_8h.html#a69a22f00f601c099b232e01b94704c2c">yin_t</a> *pe)</td></tr>
<tr class="memdesc:ae587e0d984966c482f21ee4cb0952dd0"><td class="mdescLeft"> </td><td class="mdescRight">Free a moving-window pitch estimator. <br /></td></tr>
<tr class="separator:ae587e0d984966c482f21ee4cb0952dd0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9a93d7c0fd3eb97d8ea735a76683ff4d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a93d7c0fd3eb97d8ea735a76683ff4d"></a>
SPHINXBASE_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="yin_8h.html#a9a93d7c0fd3eb97d8ea735a76683ff4d">yin_start</a> (<a class="el" href="yin_8h.html#a69a22f00f601c099b232e01b94704c2c">yin_t</a> *pe)</td></tr>
<tr class="memdesc:a9a93d7c0fd3eb97d8ea735a76683ff4d"><td class="mdescLeft"> </td><td class="mdescRight">Start processing an utterance. <br /></td></tr>
<tr class="separator:a9a93d7c0fd3eb97d8ea735a76683ff4d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9182cabf44e517c2db3b67edacebece9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9182cabf44e517c2db3b67edacebece9"></a>
SPHINXBASE_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="yin_8h.html#a9182cabf44e517c2db3b67edacebece9">yin_end</a> (<a class="el" href="yin_8h.html#a69a22f00f601c099b232e01b94704c2c">yin_t</a> *pe)</td></tr>
<tr class="memdesc:a9182cabf44e517c2db3b67edacebece9"><td class="mdescLeft"> </td><td class="mdescRight">Mark the end of an utterance. <br /></td></tr>
<tr class="separator:a9182cabf44e517c2db3b67edacebece9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac316a9b80593ad996df71b0f6df54d6c"><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="yin_8h.html#ac316a9b80593ad996df71b0f6df54d6c">yin_write</a> (<a class="el" href="yin_8h.html#a69a22f00f601c099b232e01b94704c2c">yin_t</a> *pe, int16 const *frame)</td></tr>
<tr class="memdesc:ac316a9b80593ad996df71b0f6df54d6c"><td class="mdescLeft"> </td><td class="mdescRight">Feed a frame of data to the pitch estimator. <a href="#ac316a9b80593ad996df71b0f6df54d6c">More...</a><br /></td></tr>
<tr class="separator:ac316a9b80593ad996df71b0f6df54d6c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a0ae5d5a543b9e71b34c9b4a285bdbf"><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="yin_8h.html#a3a0ae5d5a543b9e71b34c9b4a285bdbf">yin_read</a> (<a class="el" href="yin_8h.html#a69a22f00f601c099b232e01b94704c2c">yin_t</a> *pe, uint16 *out_period, uint16 *out_bestdiff)</td></tr>
<tr class="memdesc:a3a0ae5d5a543b9e71b34c9b4a285bdbf"><td class="mdescLeft"> </td><td class="mdescRight">Read a raw estimated pitch value from the pitch estimator. <a href="#a3a0ae5d5a543b9e71b34c9b4a285bdbf">More...</a><br /></td></tr>
<tr class="separator:a3a0ae5d5a543b9e71b34c9b4a285bdbf"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Implementation of pitch estimation. </p>
<dl class="section author"><dt>Author</dt><dd>David Huggins-Daines <a href="#" onclick="location.href='mai'+'lto:'+'dhu'+'gg'+'ins'+'@c'+'s.c'+'mu'+'.ed'+'u'; return false;">dhugg<span style="display: none;">.nosp@m.</span>ins@<span style="display: none;">.nosp@m.</span>cs.cm<span style="display: none;">.nosp@m.</span>u.ed<span style="display: none;">.nosp@m.</span>u</a></dd></dl>
<p>This implements part of the YIN algorithm:</p>
<p>"YIN, a fundamental frequency estimator for speech and music". Alain de Cheveigné and Hideki Kawahara. Journal of the Acoustical Society of America, 111 (4), April 2002. </p>
<p>Definition in file <a class="el" href="yin_8h_source.html">yin.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a3a0ae5d5a543b9e71b34c9b4a285bdbf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT int yin_read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="yin_8h.html#a69a22f00f601c099b232e01b94704c2c">yin_t</a> * </td>
<td class="paramname"><em>pe</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16 * </td>
<td class="paramname"><em>out_period</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16 * </td>
<td class="paramname"><em>out_bestdiff</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read a raw estimated pitch value from the pitch estimator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pe</td><td>Pitch estimator. </td></tr>
<tr><td class="paramname">out_period</td><td>Output: an estimate of the period (<em>not</em> the pitch) of the signal in samples. </td></tr>
<tr><td class="paramname">out_bestdiff</td><td>Output: the minimum normalized difference value associated with <code>*out_pitch</code>, in Q15 format (i.e. scaled by 32768). This can be interpreted as one minus the probability of voicing. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Non-zero if enough data was avaliable to return a pitch estimate, zero otherwise. </dd></dl>
<p>Definition at line <a class="el" href="yin_8c_source.html#l00221">221</a> of file <a class="el" href="yin_8c_source.html">yin.c</a>.</p>
<p>References <a class="el" href="yin_8c_source.html#l00061">yin_s::diff_window</a>, <a class="el" href="yin_8c_source.html#l00059">yin_s::endut</a>, <a class="el" href="yin_8c_source.html#l00054">yin_s::nfr</a>, <a class="el" href="yin_8c_source.html#l00062">yin_s::period_window</a>, <a class="el" href="yin_8c_source.html#l00053">yin_s::search_range</a>, <a class="el" href="yin_8c_source.html#l00052">yin_s::search_threshold</a>, <a class="el" href="yin_8c_source.html#l00058">yin_s::wcur</a>, <a class="el" href="yin_8c_source.html#l00056">yin_s::wsize</a>, and <a class="el" href="yin_8c_source.html#l00057">yin_s::wstart</a>.</p>
</div>
</div>
<a class="anchor" id="ac316a9b80593ad996df71b0f6df54d6c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT void yin_write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="yin_8h.html#a69a22f00f601c099b232e01b94704c2c">yin_t</a> * </td>
<td class="paramname"><em>pe</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int16 const * </td>
<td class="paramname"><em>frame</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Feed a frame of data to the pitch estimator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pe</td><td>Pitch estimator. </td></tr>
<tr><td class="paramname">frame</td><td>Frame of <code>frame_size</code> (see <a class="el" href="yin_8h.html#afc3a955f8d2215ed3d660737643c4f32" title="Initialize moving-window pitch estimation. ">yin_init()</a>) samples of audio data. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="yin_8c_source.html#l00194">194</a> of file <a class="el" href="yin_8c_source.html">yin.c</a>.</p>
<p>References <a class="el" href="yin_8c_source.html#l00061">yin_s::diff_window</a>, <a class="el" href="yin_8c_source.html#l00054">yin_s::nfr</a>, <a class="el" href="yin_8c_source.html#l00062">yin_s::period_window</a>, <a class="el" href="yin_8c_source.html#l00052">yin_s::search_threshold</a>, <a class="el" href="yin_8c_source.html#l00056">yin_s::wsize</a>, and <a class="el" href="yin_8c_source.html#l00057">yin_s::wstart</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_e3d154c296a8e9be2797a4f81e9375b2.html">sphinxbase</a></li><li class="navelem"><a class="el" href="yin_8h.html">yin.h</a></li>
<li class="footer">Generated on Sat Oct 18 2014 15:21:17 for SphinxBase by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li>
</ul>
</div>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-release
>
by-pkgid
>
b56c9eed3fa0f00740b6f09a2460a97f
>
files
>
614
