<!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: Accumulator 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="#pub-static-methods">Static Public Member Functions</a> |
<a href="classAccumulator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Accumulator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This sound creates an accumulator reader.
<a href="classAccumulator.html#details">More...</a></p>
<p><code>#include <<a class="el" href="Accumulator_8h_source.html">Accumulator.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Accumulator:</div>
<div class="dyncontent">
<div class="center"><img src="classAccumulator__inherit__graph.png" border="0" usemap="#Accumulator_inherit__map" alt="Inheritance graph"/></div>
<map name="Accumulator_inherit__map" id="Accumulator_inherit__map">
<area shape="rect" title="This sound creates an accumulator reader." alt="" coords="5,155,104,181"/>
<area shape="rect" href="classEffect.html" title="This sound is a base class for all effect factories that take one other sound as input." alt="" coords="26,80,83,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="22,5,87,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:a683b8e025dee9022d6ed92360ba7689f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccumulator.html#a683b8e025dee9022d6ed92360ba7689f">Accumulator</a> (std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > sound, bool additive=false)</td></tr>
<tr class="memdesc:a683b8e025dee9022d6ed92360ba7689f"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new accumulator sound. <a href="#a683b8e025dee9022d6ed92360ba7689f">More...</a><br /></td></tr>
<tr class="separator:a683b8e025dee9022d6ed92360ba7689f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a36fd582893278e436d2163b59af8626a"><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="classAccumulator.html#a36fd582893278e436d2163b59af8626a">createReader</a> ()</td></tr>
<tr class="memdesc:a36fd582893278e436d2163b59af8626a"><td class="mdescLeft"> </td><td class="mdescRight">Creates a reader for playback of the sound source. <a href="#a36fd582893278e436d2163b59af8626a">More...</a><br /></td></tr>
<tr class="separator:a36fd582893278e436d2163b59af8626a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classEffect"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classEffect')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classEffect.html">Effect</a></td></tr>
<tr class="memitem:ad8de39127487ac7e110026805043077a inherit pub_methods_classEffect"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEffect.html#ad8de39127487ac7e110026805043077a">Effect</a> (std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > sound)</td></tr>
<tr class="memdesc:ad8de39127487ac7e110026805043077a inherit pub_methods_classEffect"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new sound. <a href="classEffect.html#ad8de39127487ac7e110026805043077a">More...</a><br /></td></tr>
<tr class="separator:ad8de39127487ac7e110026805043077a inherit pub_methods_classEffect"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab0f471df484d3ef351b704fef39a7072 inherit pub_methods_classEffect"><td class="memItemLeft" align="right" valign="top"><a id="ab0f471df484d3ef351b704fef39a7072"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classEffect.html#ab0f471df484d3ef351b704fef39a7072">~Effect</a> ()</td></tr>
<tr class="memdesc:ab0f471df484d3ef351b704fef39a7072 inherit pub_methods_classEffect"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the sound. <br /></td></tr>
<tr class="separator:ab0f471df484d3ef351b704fef39a7072 inherit pub_methods_classEffect"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad513f63dd87ce3d5023b276e8290a2fd inherit pub_methods_classEffect"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classEffect.html#ad513f63dd87ce3d5023b276e8290a2fd">getSound</a> () const</td></tr>
<tr class="memdesc:ad513f63dd87ce3d5023b276e8290a2fd inherit pub_methods_classEffect"><td class="mdescLeft"> </td><td class="mdescRight">Returns the saved sound. <a href="classEffect.html#ad513f63dd87ce3d5023b276e8290a2fd">More...</a><br /></td></tr>
<tr class="separator:ad513f63dd87ce3d5023b276e8290a2fd inherit pub_methods_classEffect"><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><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a5339b2684f79d96e016be1ac6b90adbc"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="Audaspace_8h.html#aa0798f7ea0975b143a1d9deac8c05d43">sample_t</a> <a class="el" href="Audaspace_8h.html#acd0b288d4edf8e15c0221b416faa79c6">AUD_LOCAL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccumulator.html#a5339b2684f79d96e016be1ac6b90adbc">accumulatorFilterAdditive</a> (<a class="el" href="classCallbackIIRFilterReader.html">CallbackIIRFilterReader</a> *reader, void *useless)</td></tr>
<tr class="memdesc:a5339b2684f79d96e016be1ac6b90adbc"><td class="mdescLeft"> </td><td class="mdescRight">The accumulatorFilterAdditive function implements the doFilterIIR callback for the additive accumulator filter. <a href="#a5339b2684f79d96e016be1ac6b90adbc">More...</a><br /></td></tr>
<tr class="separator:a5339b2684f79d96e016be1ac6b90adbc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1fcab5e201eaf6a39abefee41016c9ae"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="Audaspace_8h.html#aa0798f7ea0975b143a1d9deac8c05d43">sample_t</a> <a class="el" href="Audaspace_8h.html#acd0b288d4edf8e15c0221b416faa79c6">AUD_LOCAL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAccumulator.html#a1fcab5e201eaf6a39abefee41016c9ae">accumulatorFilter</a> (<a class="el" href="classCallbackIIRFilterReader.html">CallbackIIRFilterReader</a> *reader, void *useless)</td></tr>
<tr class="memdesc:a1fcab5e201eaf6a39abefee41016c9ae"><td class="mdescLeft"> </td><td class="mdescRight">The accumulatorFilter function implements the doFilterIIR callback for the non-additive accumulator filter. <a href="#a1fcab5e201eaf6a39abefee41016c9ae">More...</a><br /></td></tr>
<tr class="separator:a1fcab5e201eaf6a39abefee41016c9ae"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classEffect"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classEffect')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classEffect.html">Effect</a></td></tr>
<tr class="memitem:acbc6e32d24b20c2f753b9b3fc7026a2d inherit pro_methods_classEffect"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classIReader.html">IReader</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classEffect.html#acbc6e32d24b20c2f753b9b3fc7026a2d">getReader</a> () const</td></tr>
<tr class="memdesc:acbc6e32d24b20c2f753b9b3fc7026a2d inherit pro_methods_classEffect"><td class="mdescLeft"> </td><td class="mdescRight">Returns the reader created out of the sound. <a href="classEffect.html#acbc6e32d24b20c2f753b9b3fc7026a2d">More...</a><br /></td></tr>
<tr class="separator:acbc6e32d24b20c2f753b9b3fc7026a2d inherit pro_methods_classEffect"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_attribs_classEffect"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classEffect')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classEffect.html">Effect</a></td></tr>
<tr class="memitem:acc48a8fc2f5e83e74deb81b3d220451c inherit pro_attribs_classEffect"><td class="memItemLeft" align="right" valign="top"><a id="acc48a8fc2f5e83e74deb81b3d220451c"></a>
std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classEffect.html#acc48a8fc2f5e83e74deb81b3d220451c">m_sound</a></td></tr>
<tr class="memdesc:acc48a8fc2f5e83e74deb81b3d220451c inherit pro_attribs_classEffect"><td class="mdescLeft"> </td><td class="mdescRight">If there is no reader it is created out of this sound. <br /></td></tr>
<tr class="separator:acc48a8fc2f5e83e74deb81b3d220451c inherit pro_attribs_classEffect"><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 sound creates an accumulator reader. </p>
<p>The accumulator adds the difference at the input to the last output in case it's positive. In additive mode it additionaly adds the difference always. So in case the difference is positive, it's added twice. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a683b8e025dee9022d6ed92360ba7689f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a683b8e025dee9022d6ed92360ba7689f">◆ </a></span>Accumulator()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Accumulator::Accumulator </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">bool </td>
<td class="paramname"><em>additive</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new accumulator sound. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sound</td><td>The input sound. </td></tr>
<tr><td class="paramname">additive</td><td>Whether the accumulator is additive. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1fcab5e201eaf6a39abefee41016c9ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1fcab5e201eaf6a39abefee41016c9ae">◆ </a></span>accumulatorFilter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="Audaspace_8h.html#aa0798f7ea0975b143a1d9deac8c05d43">sample_t</a> <a class="el" href="Audaspace_8h.html#acd0b288d4edf8e15c0221b416faa79c6">AUD_LOCAL</a> Accumulator::accumulatorFilter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCallbackIIRFilterReader.html">CallbackIIRFilterReader</a> * </td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>useless</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The accumulatorFilter function implements the doFilterIIR callback for the non-additive accumulator filter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>The <a class="el" href="classCallbackIIRFilterReader.html" title="This class provides an interface for infinite impulse response filters via a callback filter function...">CallbackIIRFilterReader</a> that executes the callback. </td></tr>
<tr><td class="paramname">useless</td><td>A user defined pointer that is not needed for this filter. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The filtered sample. </dd></dl>
</div>
</div>
<a id="a5339b2684f79d96e016be1ac6b90adbc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5339b2684f79d96e016be1ac6b90adbc">◆ </a></span>accumulatorFilterAdditive()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="Audaspace_8h.html#aa0798f7ea0975b143a1d9deac8c05d43">sample_t</a> <a class="el" href="Audaspace_8h.html#acd0b288d4edf8e15c0221b416faa79c6">AUD_LOCAL</a> Accumulator::accumulatorFilterAdditive </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCallbackIIRFilterReader.html">CallbackIIRFilterReader</a> * </td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>useless</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The accumulatorFilterAdditive function implements the doFilterIIR callback for the additive accumulator filter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>The <a class="el" href="classCallbackIIRFilterReader.html" title="This class provides an interface for infinite impulse response filters via a callback filter function...">CallbackIIRFilterReader</a> that executes the callback. </td></tr>
<tr><td class="paramname">useless</td><td>A user defined pointer that is not needed for this filter. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The filtered sample. </dd></dl>
</div>
</div>
<a id="a36fd582893278e436d2163b59af8626a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36fd582893278e436d2163b59af8626a">◆ </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>> Accumulator::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>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>fx/<a class="el" href="Accumulator_8h_source.html">Accumulator.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
>
820
