<!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: ConvolverSound 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="classConvolverSound-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ConvolverSound Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class represents a sound that can be modified depending on a given impulse response.
<a href="classConvolverSound.html#details">More...</a></p>
<p><code>#include <<a class="el" href="ConvolverSound_8h_source.html">ConvolverSound.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ConvolverSound:</div>
<div class="dyncontent">
<div class="center"><img src="classConvolverSound__inherit__graph.png" border="0" usemap="#ConvolverSound_inherit__map" alt="Inheritance graph"/></div>
<map name="ConvolverSound_inherit__map" id="ConvolverSound_inherit__map">
<area shape="rect" title="This class represents a sound that can be modified depending on a given impulse response." alt="" coords="5,80,128,107"/>
<area shape="rect" href="classISound.html" title="This class represents a type of sound source and saves the necessary values for it." alt="" coords="34,5,99,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:ac78ace01d0e5968e4e05d82ccb8e18ce"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classConvolverSound.html#ac78ace01d0e5968e4e05d82ccb8e18ce">ConvolverSound</a> (std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > sound, std::shared_ptr< <a class="el" href="classImpulseResponse.html">ImpulseResponse</a> > impulseResponse, std::shared_ptr< <a class="el" href="classThreadPool.html">ThreadPool</a> > threadPool, std::shared_ptr< <a class="el" href="classFFTPlan.html">FFTPlan</a> > plan)</td></tr>
<tr class="memdesc:ac78ace01d0e5968e4e05d82ccb8e18ce"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classConvolverSound.html" title="This class represents a sound that can be modified depending on a given impulse response.">ConvolverSound</a>. <a href="#ac78ace01d0e5968e4e05d82ccb8e18ce">More...</a><br /></td></tr>
<tr class="separator:ac78ace01d0e5968e4e05d82ccb8e18ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a995c69902b48e843249fb32161b1cf2c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classConvolverSound.html#a995c69902b48e843249fb32161b1cf2c">ConvolverSound</a> (std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > sound, std::shared_ptr< <a class="el" href="classImpulseResponse.html">ImpulseResponse</a> > impulseResponse, std::shared_ptr< <a class="el" href="classThreadPool.html">ThreadPool</a> > threadPool)</td></tr>
<tr class="memdesc:a995c69902b48e843249fb32161b1cf2c"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classConvolverSound.html" title="This class represents a sound that can be modified depending on a given impulse response.">ConvolverSound</a>. <a href="#a995c69902b48e843249fb32161b1cf2c">More...</a><br /></td></tr>
<tr class="separator:a995c69902b48e843249fb32161b1cf2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5da2a1b34e37336ee9342e8da376ba3e"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="classIReader.html">IReader</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classConvolverSound.html#a5da2a1b34e37336ee9342e8da376ba3e">createReader</a> ()</td></tr>
<tr class="memdesc:a5da2a1b34e37336ee9342e8da376ba3e"><td class="mdescLeft"> </td><td class="mdescRight">Creates a reader for playback of the sound source. <a href="#a5da2a1b34e37336ee9342e8da376ba3e">More...</a><br /></td></tr>
<tr class="separator:a5da2a1b34e37336ee9342e8da376ba3e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa3e134d35b2e3bba629b8dbe05b69ced"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classImpulseResponse.html">ImpulseResponse</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classConvolverSound.html#aa3e134d35b2e3bba629b8dbe05b69ced">getImpulseResponse</a> ()</td></tr>
<tr class="memdesc:aa3e134d35b2e3bba629b8dbe05b69ced"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the impulse response sound being used. <a href="#aa3e134d35b2e3bba629b8dbe05b69ced">More...</a><br /></td></tr>
<tr class="separator:aa3e134d35b2e3bba629b8dbe05b69ced"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a82adb7ff53dc16fd3bf7fc50f7c7b383"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classConvolverSound.html#a82adb7ff53dc16fd3bf7fc50f7c7b383">setImpulseResponse</a> (std::shared_ptr< <a class="el" href="classImpulseResponse.html">ImpulseResponse</a> > impulseResponse)</td></tr>
<tr class="memdesc:a82adb7ff53dc16fd3bf7fc50f7c7b383"><td class="mdescLeft"> </td><td class="mdescRight">Changes the inpulse response used for convolution, it'll only affect newly created readers. <a href="#a82adb7ff53dc16fd3bf7fc50f7c7b383">More...</a><br /></td></tr>
<tr class="separator:a82adb7ff53dc16fd3bf7fc50f7c7b383"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classISound"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classISound')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classISound.html">ISound</a></td></tr>
<tr class="memitem:ad968d59f5fdb16f050b3c74108c693b5 inherit pub_methods_classISound"><td class="memItemLeft" align="right" valign="top"><a id="ad968d59f5fdb16f050b3c74108c693b5"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classISound.html#ad968d59f5fdb16f050b3c74108c693b5">~ISound</a> ()</td></tr>
<tr class="memdesc:ad968d59f5fdb16f050b3c74108c693b5 inherit pub_methods_classISound"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the sound. <br /></td></tr>
<tr class="separator:ad968d59f5fdb16f050b3c74108c693b5 inherit pub_methods_classISound"><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 a sound that can be modified depending on a given impulse response. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ac78ace01d0e5968e4e05d82ccb8e18ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac78ace01d0e5968e4e05d82ccb8e18ce">◆ </a></span>ConvolverSound() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ConvolverSound::ConvolverSound </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > </td>
<td class="paramname"><em>sound</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classImpulseResponse.html">ImpulseResponse</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="classThreadPool.html">ThreadPool</a> > </td>
<td class="paramname"><em>threadPool</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="classConvolverSound.html" title="This class represents a sound that can be modified depending on a given impulse response.">ConvolverSound</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sound</td><td>The sound that will be convolved. </td></tr>
<tr><td class="paramname">impulseResponse</td><td>The impulse response sound. </td></tr>
<tr><td class="paramname">threadPool</td><td>A shared pointer to a <a class="el" href="classThreadPool.html" title="This represents pool of threads.">ThreadPool</a> object with 1 or more threads. </td></tr>
<tr><td class="paramname">plan</td><td>A shared pointer to a <a class="el" href="classFFTPlan.html" title="Thas class represents an plan object that allows to calculate FFTs and IFFTs.">FFTPlan</a> object that will be used for convolution. </td></tr>
</table>
</dd>
</dl>
<dl class="section warning"><dt>Warning</dt><dd>The same <a class="el" href="classFFTPlan.html" title="Thas class represents an plan object that allows to calculate FFTs and IFFTs.">FFTPlan</a> object must be used to construct both this and the <a class="el" href="classImpulseResponse.html" title="This class represents an impulse response that can be used in convolution.">ImpulseResponse</a> object provided. </dd></dl>
</div>
</div>
<a id="a995c69902b48e843249fb32161b1cf2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a995c69902b48e843249fb32161b1cf2c">◆ </a></span>ConvolverSound() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ConvolverSound::ConvolverSound </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > </td>
<td class="paramname"><em>sound</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classImpulseResponse.html">ImpulseResponse</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="classThreadPool.html">ThreadPool</a> > </td>
<td class="paramname"><em>threadPool</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="classConvolverSound.html" title="This class represents a sound that can be modified depending on a given impulse response.">ConvolverSound</a>. </p>
<p>A default FFT plan will be created. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sound</td><td>The sound that will be convolved. </td></tr>
<tr><td class="paramname">impulseResponse</td><td>The impulse response sound. </td></tr>
<tr><td class="paramname">threadPool</td><td>A shared pointer to a <a class="el" href="classThreadPool.html" title="This represents pool of threads.">ThreadPool</a> object with 1 or more threads. </td></tr>
</table>
</dd>
</dl>
<dl class="section warning"><dt>Warning</dt><dd>To use this constructor no <a class="el" href="classFFTPlan.html" title="Thas class represents an plan object that allows to calculate FFTs and IFFTs.">FFTPlan</a> object must have been provided to the inpulseResponse. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a5da2a1b34e37336ee9342e8da376ba3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5da2a1b34e37336ee9342e8da376ba3e">◆ </a></span>createReader()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::shared_ptr<<a class="el" href="classIReader.html">IReader</a>> ConvolverSound::createReader </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a reader for playback of the sound source. </p>
<dl class="section return"><dt>Returns</dt><dd>A pointer to an <a class="el" href="classIReader.html" title="This class represents a sound source as stream or as buffer which can be read for example by another ...">IReader</a> object or nullptr if there has been an error. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classException.html" title="The Exception class is the general exception base class.">Exception</a></td><td>An exception may be thrown if there has been a more unexpected error during reader creation. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classISound.html#a194d09ea3b22f1cb0a49b89cfcf02d63">ISound</a>.</p>
</div>
</div>
<a id="aa3e134d35b2e3bba629b8dbe05b69ced"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3e134d35b2e3bba629b8dbe05b69ced">◆ </a></span>getImpulseResponse()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr<<a class="el" href="classImpulseResponse.html">ImpulseResponse</a>> ConvolverSound::getImpulseResponse </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the impulse response sound being used. </p>
<dl class="section return"><dt>Returns</dt><dd>A shared pointer to the current impulse response being used. </dd></dl>
</div>
</div>
<a id="a82adb7ff53dc16fd3bf7fc50f7c7b383"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82adb7ff53dc16fd3bf7fc50f7c7b383">◆ </a></span>setImpulseResponse()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ConvolverSound::setImpulseResponse </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classImpulseResponse.html">ImpulseResponse</a> > </td>
<td class="paramname"><em>impulseResponse</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Changes the inpulse response used for convolution, it'll only affect newly created readers. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">impulseResponse</td><td>A shared pointer to the new impulse response sound. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>fx/<a class="el" href="ConvolverSound_8h_source.html">ConvolverSound.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
>
899
