<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Audaspace: ImpulseResponse Class 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>
<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">Audaspace
 <span id="projectnumber">1.3.0</span>
</div>
<div id="projectbrief">A high level audio library.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classImpulseResponse-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ImpulseResponse Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class represents an impulse response that can be used in convolution.
<a href="classImpulseResponse.html#details">More...</a></p>
<p><code>#include <<a class="el" href="ImpulseResponse_8h_source.html">ImpulseResponse.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1fee8bfedf70c4aaad7f15d67493a68c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImpulseResponse.html#a1fee8bfedf70c4aaad7f15d67493a68c">ImpulseResponse</a> (std::shared_ptr< <a class="el" href="classStreamBuffer.html">StreamBuffer</a> > impulseResponse, std::shared_ptr< <a class="el" href="classFFTPlan.html">FFTPlan</a> > plan)</td></tr>
<tr class="memdesc:a1fee8bfedf70c4aaad7f15d67493a68c"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classImpulseResponse.html" title="This class represents an impulse response that can be used in convolution.">ImpulseResponse</a> object. <a href="#a1fee8bfedf70c4aaad7f15d67493a68c">More...</a><br /></td></tr>
<tr class="separator:a1fee8bfedf70c4aaad7f15d67493a68c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a71da41c2ae5fc67cfad04efcc39007bf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImpulseResponse.html#a71da41c2ae5fc67cfad04efcc39007bf">ImpulseResponse</a> (std::shared_ptr< <a class="el" href="classStreamBuffer.html">StreamBuffer</a> > impulseResponse)</td></tr>
<tr class="memdesc:a71da41c2ae5fc67cfad04efcc39007bf"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classImpulseResponse.html" title="This class represents an impulse response that can be used in convolution.">ImpulseResponse</a> object. <a href="#a71da41c2ae5fc67cfad04efcc39007bf">More...</a><br /></td></tr>
<tr class="separator:a71da41c2ae5fc67cfad04efcc39007bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac9850651ecf09e039d242ecb23ee8407"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structSpecs.html">Specs</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImpulseResponse.html#ac9850651ecf09e039d242ecb23ee8407">getSpecs</a> ()</td></tr>
<tr class="memdesc:ac9850651ecf09e039d242ecb23ee8407"><td class="mdescLeft"> </td><td class="mdescRight">Returns the specification of the impulse response. <a href="#ac9850651ecf09e039d242ecb23ee8407">More...</a><br /></td></tr>
<tr class="separator:ac9850651ecf09e039d242ecb23ee8407"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a76c4bd22cdca0e3bb5be696ae300679c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classImpulseResponse.html#a76c4bd22cdca0e3bb5be696ae300679c">getLength</a> ()</td></tr>
<tr class="memdesc:a76c4bd22cdca0e3bb5be696ae300679c"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the length of the impulse response. <a href="#a76c4bd22cdca0e3bb5be696ae300679c">More...</a><br /></td></tr>
<tr class="separator:a76c4bd22cdca0e3bb5be696ae300679c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a886b184c722b0351582d073e81936aa2"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< std::vector< std::shared_ptr< std::vector< std::complex< <a class="el" href="Audaspace_8h.html#aa0798f7ea0975b143a1d9deac8c05d43">sample_t</a> > > > > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classImpulseResponse.html#a886b184c722b0351582d073e81936aa2">getChannel</a> (int n)</td></tr>
<tr class="memdesc:a886b184c722b0351582d073e81936aa2"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves one channel of the impulse response. <a href="#a886b184c722b0351582d073e81936aa2">More...</a><br /></td></tr>
<tr class="separator:a886b184c722b0351582d073e81936aa2"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class represents an impulse response that can be used in convolution. </p>
<p>When this class is instanced, the impulse response is divided in channels and those channels are divided in parts of N/2 samples (N being the size of the FFT plan used). The main objetive of this class is to allow the reutilization of an impulse response in various sounds without having to process it more than one time. </p><dl class="section warning"><dt>Warning</dt><dd>The size of the <a class="el" href="classFFTPlan.html" title="Thas class represents an plan object that allows to calculate FFTs and IFFTs.">FFTPlan</a> used to process the impulse response must be the same as the one used in the convolver classes. </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a1fee8bfedf70c4aaad7f15d67493a68c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1fee8bfedf70c4aaad7f15d67493a68c">◆ </a></span>ImpulseResponse() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ImpulseResponse::ImpulseResponse </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classStreamBuffer.html">StreamBuffer</a> > </td>
<td class="paramname"><em>impulseResponse</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classFFTPlan.html">FFTPlan</a> > </td>
<td class="paramname"><em>plan</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new <a class="el" href="classImpulseResponse.html" title="This class represents an impulse response that can be used in convolution.">ImpulseResponse</a> object. </p>
<p>The impulse response will be split and transformed to the frequency domain. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">impulseResponse</td><td>The impulse response sound. </td></tr>
<tr><td class="paramname">plan</td><td>A shared pointer to a FFT plan used to transform the impulse response. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a71da41c2ae5fc67cfad04efcc39007bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71da41c2ae5fc67cfad04efcc39007bf">◆ </a></span>ImpulseResponse() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ImpulseResponse::ImpulseResponse </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classStreamBuffer.html">StreamBuffer</a> > </td>
<td class="paramname"><em>impulseResponse</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new <a class="el" href="classImpulseResponse.html" title="This class represents an impulse response that can be used in convolution.">ImpulseResponse</a> object. </p>
<p>This overload instances its own <a class="el" href="classFFTPlan.html" title="Thas class represents an plan object that allows to calculate FFTs and IFFTs.">FFTPlan</a> with default size. The impulse response will be split and transformed to the frequency domain. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">impulseResponse</td><td>The impulse response sound. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a886b184c722b0351582d073e81936aa2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a886b184c722b0351582d073e81936aa2">◆ </a></span>getChannel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr<std::vector<std::shared_ptr<std::vector<std::complex<<a class="el" href="Audaspace_8h.html#aa0798f7ea0975b143a1d9deac8c05d43">sample_t</a>> > > > > ImpulseResponse::getChannel </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>n</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves one channel of the impulse response. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">n</td><td>The desired channel number (from 0 to channels-1). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The desired channel of the impulse response. </dd></dl>
</div>
</div>
<a id="a76c4bd22cdca0e3bb5be696ae300679c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76c4bd22cdca0e3bb5be696ae300679c">◆ </a></span>getLength()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ImpulseResponse::getLength </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the length of the impulse response. </p>
<dl class="section return"><dt>Returns</dt><dd>The length of the impulse response. </dd></dl>
</div>
</div>
<a id="ac9850651ecf09e039d242ecb23ee8407"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9850651ecf09e039d242ecb23ee8407">◆ </a></span>getSpecs()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structSpecs.html">Specs</a> ImpulseResponse::getSpecs </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the specification of the impulse response. </p>
<dl class="section return"><dt>Returns</dt><dd>The specification of the impulse response. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>fx/<a class="el" href="ImpulseResponse_8h_source.html">ImpulseResponse.h</a></li>
</ul>
</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.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
4f48f620eaa1d8b8f904a92a0540d40f
>
files
>
1097
