<!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 Source File</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="headertitle">
<div class="title">phasevoc.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="phasevoc_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> Copyright (C) 2003-2013 Paul Brossier <piem@aubio.org></span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"></span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> This file is part of aubio.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> aubio is free software: you can redistribute it and/or modify</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> it under the terms of the GNU General Public License as published by</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> the Free Software Foundation, either version 3 of the License, or</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> (at your option) any later version.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> aubio is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> GNU General Public License for more details.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> You should have received a copy of the GNU General Public License</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> along with aubio. If not, see <http://www.gnu.org/licenses/>.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">*/</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">/** \file</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> Phase vocoder object</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> This object implements a phase vocoder. The spectral frames are computed</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> using a HanningZ window and a swapped version of the signal to simplify the</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> phase relationships across frames. The window sizes and overlap are specified</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> at creation time.</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> \example spectral/test-phasevoc.c</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">*/</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#ifndef _AUBIO_PHASEVOC_H</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#define _AUBIO_PHASEVOC_H</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"></span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">/** phasevocoder object */</span></div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5"> 42</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>_aubio_pvoc_t <a class="code" href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5">aubio_pvoc_t</a>;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"></span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">/** create phase vocoder object</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> \param win_s size of analysis buffer (and length the FFT transform)</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> \param hop_s step size between two consecutive analysis</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"></span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">*/</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <a class="code" href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5">aubio_pvoc_t</a> * <a class="code" href="phasevoc_8h.html#aff037315bd1ae2caca67ee95e735c31b">new_aubio_pvoc</a> (<a class="code" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> win_s, <a class="code" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> hop_s);<span class="comment"></span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">/** delete phase vocoder object</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"></span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> \param pv phase vocoder object as returned by new_aubio_pvoc</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"></span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">*/</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="keywordtype">void</span> <a class="code" href="phasevoc_8h.html#ae3d86b769a4076986ea3435be740c1d0">del_aubio_pvoc</a>(<a class="code" href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5">aubio_pvoc_t</a> *pv);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"></span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">/** compute spectral frame</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> </span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> This function accepts an input vector of size [hop_s]. The</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> analysis buffer is rotated and filled with the new data. After windowing of</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> this signal window, the Fourier transform is computed and returned in</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> fftgrain as two vectors, magnitude and phase.</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"></span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> \param pv phase vocoder object as returned by new_aubio_pvoc</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> \param in new input signal (hop_s long) </span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> \param fftgrain output spectral frame</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"></span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">*/</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keywordtype">void</span> <a class="code" href="phasevoc_8h.html#a0ebb6ba0e58c4b929af069ebc005a064">aubio_pvoc_do</a>(<a class="code" href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5">aubio_pvoc_t</a> *pv, <a class="code" href="structfvec__t.html">fvec_t</a> *in, <a class="code" href="structcvec__t.html">cvec_t</a> * fftgrain);<span class="comment"></span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">/** compute signal from spectral frame</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"></span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> This function takes an input spectral frame fftgrain of size</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> [buf_s] and computes its inverse Fourier transform. Overlap-add</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> synthesis is then computed using the previously synthetised frames, and the</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> output stored in out.</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> </span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> \param pv phase vocoder object as returned by new_aubio_pvoc</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> \param fftgrain input spectral frame</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> \param out output signal (hop_s long) </span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"></span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">*/</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="keywordtype">void</span> <a class="code" href="phasevoc_8h.html#ad5ec51e7ea8f250951ab4a16bd51a57c">aubio_pvoc_rdo</a>(<a class="code" href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5">aubio_pvoc_t</a> *pv, <a class="code" href="structcvec__t.html">cvec_t</a> * fftgrain, <a class="code" href="structfvec__t.html">fvec_t</a> *out);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"></span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">/** get window size</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"></span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> \param pv phase vocoder to get the window size from</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"></span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">*/</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <a class="code" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> <a class="code" href="phasevoc_8h.html#aced148c00ea8e5c7e8f3f027511632e5">aubio_pvoc_get_win</a>(<a class="code" href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5">aubio_pvoc_t</a>* pv);<span class="comment"></span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">/** get hop size</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"></span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> \param pv phase vocoder to get the hop size from</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"></span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment">*/</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <a class="code" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> <a class="code" href="phasevoc_8h.html#afd86f2572964ee66790174fde8f1c2e1">aubio_pvoc_get_hop</a>(<a class="code" href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5">aubio_pvoc_t</a>* pv);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> }</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="preprocessor">#endif </span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="preprocessor">#endif </span><span class="comment">/* _AUBIO_PHASEVOC_H */</span><span class="preprocessor"></span></div><div class="ttc" id="phasevoc_8h_html_a0ebb6ba0e58c4b929af069ebc005a064"><div class="ttname"><a href="phasevoc_8h.html#a0ebb6ba0e58c4b929af069ebc005a064">aubio_pvoc_do</a></div><div class="ttdeci">void aubio_pvoc_do(aubio_pvoc_t *pv, fvec_t *in, cvec_t *fftgrain)</div><div class="ttdoc">compute spectral frame </div></div>
<div class="ttc" id="phasevoc_8h_html_ae3d86b769a4076986ea3435be740c1d0"><div class="ttname"><a href="phasevoc_8h.html#ae3d86b769a4076986ea3435be740c1d0">del_aubio_pvoc</a></div><div class="ttdeci">void del_aubio_pvoc(aubio_pvoc_t *pv)</div><div class="ttdoc">delete phase vocoder object </div></div>
<div class="ttc" id="phasevoc_8h_html_afd86f2572964ee66790174fde8f1c2e1"><div class="ttname"><a href="phasevoc_8h.html#afd86f2572964ee66790174fde8f1c2e1">aubio_pvoc_get_hop</a></div><div class="ttdeci">uint_t aubio_pvoc_get_hop(aubio_pvoc_t *pv)</div><div class="ttdoc">get hop size </div></div>
<div class="ttc" id="phasevoc_8h_html_aced148c00ea8e5c7e8f3f027511632e5"><div class="ttname"><a href="phasevoc_8h.html#aced148c00ea8e5c7e8f3f027511632e5">aubio_pvoc_get_win</a></div><div class="ttdeci">uint_t aubio_pvoc_get_win(aubio_pvoc_t *pv)</div><div class="ttdoc">get window size </div></div>
<div class="ttc" id="phasevoc_8h_html_aff037315bd1ae2caca67ee95e735c31b"><div class="ttname"><a href="phasevoc_8h.html#aff037315bd1ae2caca67ee95e735c31b">new_aubio_pvoc</a></div><div class="ttdeci">aubio_pvoc_t * new_aubio_pvoc(uint_t win_s, uint_t hop_s)</div><div class="ttdoc">create phase vocoder object </div></div>
<div class="ttc" id="structfvec__t_html"><div class="ttname"><a href="structfvec__t.html">fvec_t</a></div><div class="ttdoc">Buffer for real data. </div><div class="ttdef"><b>Definition:</b> <a href="fvec_8h_source.html#l00067">fvec.h:67</a></div></div>
<div class="ttc" id="structcvec__t_html"><div class="ttname"><a href="structcvec__t.html">cvec_t</a></div><div class="ttdoc">Vector of real-valued phase and spectrum data. </div><div class="ttdef"><b>Definition:</b> <a href="cvec_8h_source.html#l00063">cvec.h:63</a></div></div>
<div class="ttc" id="types_8h_html_a12a1e9b3ce141648783a82445d02b58d"><div class="ttname"><a href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a></div><div class="ttdeci">unsigned int uint_t</div><div class="ttdoc">unsigned integer </div><div class="ttdef"><b>Definition:</b> <a href="types_8h_source.html#l00060">types.h:60</a></div></div>
<div class="ttc" id="phasevoc_8h_html_a0ab307b4e3ade23af88ccebbe81900e5"><div class="ttname"><a href="phasevoc_8h.html#a0ab307b4e3ade23af88ccebbe81900e5">aubio_pvoc_t</a></div><div class="ttdeci">struct _aubio_pvoc_t aubio_pvoc_t</div><div class="ttdoc">phasevocoder object </div><div class="ttdef"><b>Definition:</b> <a href="phasevoc_8h_source.html#l00042">phasevoc.h:42</a></div></div>
<div class="ttc" id="phasevoc_8h_html_ad5ec51e7ea8f250951ab4a16bd51a57c"><div class="ttname"><a href="phasevoc_8h.html#ad5ec51e7ea8f250951ab4a16bd51a57c">aubio_pvoc_rdo</a></div><div class="ttdeci">void aubio_pvoc_rdo(aubio_pvoc_t *pv, cvec_t *fftgrain, fvec_t *out)</div><div class="ttdoc">compute signal from spectral frame </div></div>
</div><!-- fragment --></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>
