<!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"/>
<title>Async: Async::AudioFilter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceAsync.html">Async</a>::<a class="el" href="classAsync_1_1AudioFilter.html">AudioFilter</a>
</div>
</div>
<div class="contents">
<h1>Async::AudioFilter Class Reference</h1><!-- doxytag: class="Async::AudioFilter" --><!-- doxytag: inherits="Async::AudioProcessor" -->
<p>A class for creating a wide range of audio filters.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="AsyncAudioFilter_8h_source.html">AsyncAudioFilter.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Async::AudioFilter:</div>
<div class="dynsection">
<div class="center">
<img src="classAsync_1_1AudioFilter.png" usemap="#Async::AudioFilter_map" alt=""/>
<map id="Async::AudioFilter_map" name="Async::AudioFilter_map">
<area href="classAsync_1_1AudioProcessor.html" alt="Async::AudioProcessor" shape="rect" coords="77,56,222,80"/>
<area href="classAsync_1_1AudioSink.html" alt="Async::AudioSink" shape="rect" coords="0,0,145,24"/>
<area href="classAsync_1_1AudioSource.html" alt="Async::AudioSource" shape="rect" coords="155,0,300,24"/>
</map>
</div>
</div>
<p><a href="classAsync_1_1AudioFilter-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classAsync_1_1AudioFilter.html#a6fc8794391d92c20e1d9e566e76bc81c">AudioFilter</a> (const std::string &filter_spec, int sample_rate=INTERNAL_SAMPLE_RATE)
<dl class="el"><dd class="mdescRight">Constuctor. <a href="#a6fc8794391d92c20e1d9e566e76bc81c"></a><br/></dl><li><a class="el" href="classAsync_1_1AudioFilter.html#a5a2106a3937db9f46eca970074278724">~AudioFilter</a> (void)
<dl class="el"><dd class="mdescRight">Destructor. <a href="#a5a2106a3937db9f46eca970074278724"></a><br/></dl><li>void <a class="el" href="classAsync_1_1AudioFilter.html#a8da14a3fa06e85398b6ddde93068fd90">setOutputGain</a> (float gain)
<dl class="el"><dd class="mdescRight">Set the output gain of the filter. <a href="#a8da14a3fa06e85398b6ddde93068fd90"></a><br/></dl><li>void <a class="el" href="classAsync_1_1AudioFilter.html#a6a7779bef72e25f7ac63f7e80af3e1f9">reset</a> (void)
<dl class="el"><dd class="mdescRight">Reset the filter state. <a href="#a6a7779bef72e25f7ac63f7e80af3e1f9"></a><br/></dl></ul>
<h2>Protected Member Functions</h2>
<ul>
<li>void <a class="el" href="classAsync_1_1AudioFilter.html#aea2b9e87a961540507641bf443df731b">processSamples</a> (float *dest, const float *src, int count)
<dl class="el"><dd class="mdescRight">Process incoming samples and put them into the output buffer. <a href="#aea2b9e87a961540507641bf443df731b"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A class for creating a wide range of audio filters. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Tobias Blomberg / SM0SVX </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>2006-04-23 </dd></dl>
<p>Definition at line <a class="el" href="AsyncAudioFilter_8h_source.html#l00113">113</a> of file <a class="el" href="AsyncAudioFilter_8h_source.html">AsyncAudioFilter.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a6fc8794391d92c20e1d9e566e76bc81c"></a><!-- doxytag: member="Async::AudioFilter::AudioFilter" ref="a6fc8794391d92c20e1d9e566e76bc81c" args="(const std::string &filter_spec, int sample_rate=INTERNAL_SAMPLE_RATE)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Async::AudioFilter::AudioFilter </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>filter_spec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>sample_rate</em> = <code>INTERNAL_SAMPLE_RATE</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constuctor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filter_spec</em> </td><td>The filter specification </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sample_rate</em> </td><td>The sampling rate </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5a2106a3937db9f46eca970074278724"></a><!-- doxytag: member="Async::AudioFilter::~AudioFilter" ref="a5a2106a3937db9f46eca970074278724" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Async::AudioFilter::~AudioFilter </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aea2b9e87a961540507641bf443df731b"></a><!-- doxytag: member="Async::AudioFilter::processSamples" ref="aea2b9e87a961540507641bf443df731b" args="(float *dest, const float *src, int count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Async::AudioFilter::processSamples </td>
<td>(</td>
<td class="paramtype">float * </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const float * </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Process incoming samples and put them into the output buffer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>Destination buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>Source buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>Number of samples in the source buffer</td></tr>
</table>
</dd>
</dl>
<p>This function is called from the base class to do the actual processing of the incoming samples. All samples must be processed, otherwise they are lost and the output buffer will contain garbage. </p>
<p>Implements <a class="el" href="classAsync_1_1AudioProcessor.html#a2d7e4ec25a7bd6a9c5c20ae35c1adee3">Async::AudioProcessor</a>.</p>
</div>
</div>
<a class="anchor" id="a6a7779bef72e25f7ac63f7e80af3e1f9"></a><!-- doxytag: member="Async::AudioFilter::reset" ref="a6a7779bef72e25f7ac63f7e80af3e1f9" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Async::AudioFilter::reset </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reset the filter state. </p>
</div>
</div>
<a class="anchor" id="a8da14a3fa06e85398b6ddde93068fd90"></a><!-- doxytag: member="Async::AudioFilter::setOutputGain" ref="a8da14a3fa06e85398b6ddde93068fd90" args="(float gain)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Async::AudioFilter::setOutputGain </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>gain</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the output gain of the filter. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>gain</em> </td><td>The gain to set </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="AsyncAudioFilter_8h_source.html#l00133">133</a> of file <a class="el" href="AsyncAudioFilter_8h_source.html">AsyncAudioFilter.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="AsyncAudioFilter_8h_source.html">AsyncAudioFilter.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
os
>
by-pkgid
>
9c481c872fb0ae0cbadccdc2f4a18ab6
>
files
>
163
