<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>aubio: spectral/phasevoc.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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">aubio
 <span id="projectnumber">0.4.2~alpha</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_7672bb780010713f2d2504f90f5cfe22.html">spectral</a></li> </ul>
</div>
</div><!-- top -->
<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">phasevoc.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Phase vocoder object.
<a href="#details">More...</a></p>
<p><a href="phasevoc_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:a0ab307b4e3ade23af88ccebbe81900e5"><td class="memItemLeft" align="right" valign="top"><a id="a0ab307b4e3ade23af88ccebbe81900e5"></a>
typedef struct _aubio_pvoc_t </td><td class="memItemRight" valign="bottom"><a class="el" href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5">aubio_pvoc_t</a></td></tr>
<tr class="memdesc:a0ab307b4e3ade23af88ccebbe81900e5"><td class="mdescLeft"> </td><td class="mdescRight">phasevocoder object <br /></td></tr>
<tr class="separator:a0ab307b4e3ade23af88ccebbe81900e5"><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:aff037315bd1ae2caca67ee95e735c31b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5">aubio_pvoc_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="phasevoc_8h.html#aff037315bd1ae2caca67ee95e735c31b">new_aubio_pvoc</a> (<a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> win_s, <a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> hop_s)</td></tr>
<tr class="memdesc:aff037315bd1ae2caca67ee95e735c31b"><td class="mdescLeft"> </td><td class="mdescRight">create phase vocoder object <a href="#aff037315bd1ae2caca67ee95e735c31b">More...</a><br /></td></tr>
<tr class="separator:aff037315bd1ae2caca67ee95e735c31b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae3d86b769a4076986ea3435be740c1d0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="phasevoc_8h.html#ae3d86b769a4076986ea3435be740c1d0">del_aubio_pvoc</a> (<a class="el" href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5">aubio_pvoc_t</a> *pv)</td></tr>
<tr class="memdesc:ae3d86b769a4076986ea3435be740c1d0"><td class="mdescLeft"> </td><td class="mdescRight">delete phase vocoder object <a href="#ae3d86b769a4076986ea3435be740c1d0">More...</a><br /></td></tr>
<tr class="separator:ae3d86b769a4076986ea3435be740c1d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0ebb6ba0e58c4b929af069ebc005a064"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="phasevoc_8h.html#a0ebb6ba0e58c4b929af069ebc005a064">aubio_pvoc_do</a> (<a class="el" href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5">aubio_pvoc_t</a> *pv, <a class="el" href="structfvec__t.html">fvec_t</a> *in, <a class="el" href="structcvec__t.html">cvec_t</a> *fftgrain)</td></tr>
<tr class="memdesc:a0ebb6ba0e58c4b929af069ebc005a064"><td class="mdescLeft"> </td><td class="mdescRight">compute spectral frame <a href="#a0ebb6ba0e58c4b929af069ebc005a064">More...</a><br /></td></tr>
<tr class="separator:a0ebb6ba0e58c4b929af069ebc005a064"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad5ec51e7ea8f250951ab4a16bd51a57c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="phasevoc_8h.html#ad5ec51e7ea8f250951ab4a16bd51a57c">aubio_pvoc_rdo</a> (<a class="el" href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5">aubio_pvoc_t</a> *pv, <a class="el" href="structcvec__t.html">cvec_t</a> *fftgrain, <a class="el" href="structfvec__t.html">fvec_t</a> *out)</td></tr>
<tr class="memdesc:ad5ec51e7ea8f250951ab4a16bd51a57c"><td class="mdescLeft"> </td><td class="mdescRight">compute signal from spectral frame <a href="#ad5ec51e7ea8f250951ab4a16bd51a57c">More...</a><br /></td></tr>
<tr class="separator:ad5ec51e7ea8f250951ab4a16bd51a57c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aced148c00ea8e5c7e8f3f027511632e5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="phasevoc_8h.html#aced148c00ea8e5c7e8f3f027511632e5">aubio_pvoc_get_win</a> (<a class="el" href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5">aubio_pvoc_t</a> *pv)</td></tr>
<tr class="memdesc:aced148c00ea8e5c7e8f3f027511632e5"><td class="mdescLeft"> </td><td class="mdescRight">get window size <a href="#aced148c00ea8e5c7e8f3f027511632e5">More...</a><br /></td></tr>
<tr class="separator:aced148c00ea8e5c7e8f3f027511632e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd86f2572964ee66790174fde8f1c2e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="phasevoc_8h.html#afd86f2572964ee66790174fde8f1c2e1">aubio_pvoc_get_hop</a> (<a class="el" href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5">aubio_pvoc_t</a> *pv)</td></tr>
<tr class="memdesc:afd86f2572964ee66790174fde8f1c2e1"><td class="mdescLeft"> </td><td class="mdescRight">get hop size <a href="#afd86f2572964ee66790174fde8f1c2e1">More...</a><br /></td></tr>
<tr class="separator:afd86f2572964ee66790174fde8f1c2e1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Phase vocoder object. </p>
<p>This object implements a phase vocoder. The spectral frames are computed using a HanningZ window and a swapped version of the signal to simplify the phase relationships across frames. The window sizes and overlap are specified at creation time. </p>
<p class="definition">Definition in file <a class="el" href="phasevoc_8h_source.html">phasevoc.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a0ebb6ba0e58c4b929af069ebc005a064"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ebb6ba0e58c4b929af069ebc005a064">◆ </a></span>aubio_pvoc_do()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void aubio_pvoc_do </td>
<td>(</td>
<td class="paramtype"><a class="el" href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5">aubio_pvoc_t</a> * </td>
<td class="paramname"><em>pv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structfvec__t.html">fvec_t</a> * </td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structcvec__t.html">cvec_t</a> * </td>
<td class="paramname"><em>fftgrain</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>compute spectral frame </p>
<p>This function accepts an input vector of size [hop_s]. The analysis buffer is rotated and filled with the new data. After windowing of this signal window, the Fourier transform is computed and returned in fftgrain as two vectors, magnitude and phase.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pv</td><td>phase vocoder object as returned by new_aubio_pvoc </td></tr>
<tr><td class="paramname">in</td><td>new input signal (hop_s long) </td></tr>
<tr><td class="paramname">fftgrain</td><td>output spectral frame </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="spectral_2test-phasevoc_8c-example.html#a7">spectral/test-phasevoc.c</a>, and <a class="el" href="spectral_2test-tss_8c-example.html#a6">spectral/test-tss.c</a>.</dd>
</dl>
</div>
</div>
<a id="afd86f2572964ee66790174fde8f1c2e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd86f2572964ee66790174fde8f1c2e1">◆ </a></span>aubio_pvoc_get_hop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> aubio_pvoc_get_hop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5">aubio_pvoc_t</a> * </td>
<td class="paramname"><em>pv</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get hop size </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pv</td><td>phase vocoder to get the hop size from </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aced148c00ea8e5c7e8f3f027511632e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aced148c00ea8e5c7e8f3f027511632e5">◆ </a></span>aubio_pvoc_get_win()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> aubio_pvoc_get_win </td>
<td>(</td>
<td class="paramtype"><a class="el" href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5">aubio_pvoc_t</a> * </td>
<td class="paramname"><em>pv</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get window size </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pv</td><td>phase vocoder to get the window size from </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad5ec51e7ea8f250951ab4a16bd51a57c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5ec51e7ea8f250951ab4a16bd51a57c">◆ </a></span>aubio_pvoc_rdo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void aubio_pvoc_rdo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5">aubio_pvoc_t</a> * </td>
<td class="paramname"><em>pv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structcvec__t.html">cvec_t</a> * </td>
<td class="paramname"><em>fftgrain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structfvec__t.html">fvec_t</a> * </td>
<td class="paramname"><em>out</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>compute signal from spectral frame </p>
<p>This function takes an input spectral frame fftgrain of size [buf_s] and computes its inverse Fourier transform. Overlap-add synthesis is then computed using the previously synthetised frames, and the output stored in out.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pv</td><td>phase vocoder object as returned by new_aubio_pvoc </td></tr>
<tr><td class="paramname">fftgrain</td><td>input spectral frame </td></tr>
<tr><td class="paramname">out</td><td>output signal (hop_s long) </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="spectral_2test-phasevoc_8c-example.html#a9">spectral/test-phasevoc.c</a>, and <a class="el" href="spectral_2test-tss_8c-example.html#a8">spectral/test-tss.c</a>.</dd>
</dl>
</div>
</div>
<a id="ae3d86b769a4076986ea3435be740c1d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3d86b769a4076986ea3435be740c1d0">◆ </a></span>del_aubio_pvoc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void del_aubio_pvoc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5">aubio_pvoc_t</a> * </td>
<td class="paramname"><em>pv</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>delete phase vocoder object </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pv</td><td>phase vocoder object as returned by new_aubio_pvoc </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="spectral_2test-phasevoc_8c-example.html#a12">spectral/test-phasevoc.c</a>, and <a class="el" href="spectral_2test-tss_8c-example.html#a9">spectral/test-tss.c</a>.</dd>
</dl>
</div>
</div>
<a id="aff037315bd1ae2caca67ee95e735c31b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff037315bd1ae2caca67ee95e735c31b">◆ </a></span>new_aubio_pvoc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5">aubio_pvoc_t</a>* new_aubio_pvoc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td>
<td class="paramname"><em>win_s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td>
<td class="paramname"><em>hop_s</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>create phase vocoder object </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">win_s</td><td>size of analysis buffer (and length the FFT transform) </td></tr>
<tr><td class="paramname">hop_s</td><td>step size between two consecutive analysis </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="spectral_2test-phasevoc_8c-example.html#a4">spectral/test-phasevoc.c</a>, and <a class="el" href="spectral_2test-tss_8c-example.html#a4">spectral/test-tss.c</a>.</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.13
</small></address>
</body>
</html>
