<!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::AudioClipper 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_1AudioClipper.html">AudioClipper</a>
</div>
</div>
<div class="contents">
<h1>Async::AudioClipper Class Reference</h1><!-- doxytag: class="Async::AudioClipper" --><!-- doxytag: inherits="Async::AudioProcessor" -->
<p>An audio pipe class to clip audio to a given maximum level.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="AsyncAudioClipper_8h_source.html">AsyncAudioClipper.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Async::AudioClipper:</div>
<div class="dynsection">
<div class="center">
<img src="classAsync_1_1AudioClipper.png" usemap="#Async::AudioClipper_map" alt=""/>
<map id="Async::AudioClipper_map" name="Async::AudioClipper_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_1AudioClipper-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classAsync_1_1AudioClipper.html#a020772bdd3cfb93235fc1273a239e9a8">AudioClipper</a> (float clip_level=1.0)
<dl class="el"><dd class="mdescRight">Default constuctor. <a href="#a020772bdd3cfb93235fc1273a239e9a8"></a><br/></dl><li><a class="el" href="classAsync_1_1AudioClipper.html#a78c588b032199a532ad2b70fb9ed8773">~AudioClipper</a> (void)
<dl class="el"><dd class="mdescRight">Destructor. <a href="#a78c588b032199a532ad2b70fb9ed8773"></a><br/></dl><li>void <a class="el" href="classAsync_1_1AudioClipper.html#a9fb2f72a884c1810ab4b285335568626">setClipLevel</a> (float level)
<dl class="el"><dd class="mdescRight">Set the clip level. <a href="#a9fb2f72a884c1810ab4b285335568626"></a><br/></dl></ul>
<h2>Protected Member Functions</h2>
<ul>
<li>virtual void <a class="el" href="classAsync_1_1AudioClipper.html#ad864388377d3690b39b4e17687d2bf9e">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="#ad864388377d3690b39b4e17687d2bf9e"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An audio pipe class to clip audio to a given maximum level. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Tobias Blomberg / SM0SVX </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>2005-08-01</dd></dl>
<p>This is an audio pipe class that is used to clip an audio stream to a given maximum level. </p>
<p>Definition at line <a class="el" href="AsyncAudioClipper_8h_source.html#l00113">113</a> of file <a class="el" href="AsyncAudioClipper_8h_source.html">AsyncAudioClipper.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a020772bdd3cfb93235fc1273a239e9a8"></a><!-- doxytag: member="Async::AudioClipper::AudioClipper" ref="a020772bdd3cfb93235fc1273a239e9a8" args="(float clip_level=1.0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Async::AudioClipper::AudioClipper </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>clip_level</em> = <code>1.0</code></td>
<td> ) </td>
<td><code> [inline, explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default 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>clip_level</em> </td><td>The level to clip at (1.0 is default) </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="AsyncAudioClipper_8h_source.html#l00120">120</a> of file <a class="el" href="AsyncAudioClipper_8h_source.html">AsyncAudioClipper.h</a>.</p>
</div>
</div>
<a class="anchor" id="a78c588b032199a532ad2b70fb9ed8773"></a><!-- doxytag: member="Async::AudioClipper::~AudioClipper" ref="a78c588b032199a532ad2b70fb9ed8773" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Async::AudioClipper::~AudioClipper </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="AsyncAudioClipper_8h_source.html#l00125">125</a> of file <a class="el" href="AsyncAudioClipper_8h_source.html">AsyncAudioClipper.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad864388377d3690b39b4e17687d2bf9e"></a><!-- doxytag: member="Async::AudioClipper::processSamples" ref="ad864388377d3690b39b4e17687d2bf9e" args="(float *dest, const float *src, int count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Async::AudioClipper::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> [inline, 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 should be reimplemented by the inheriting 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>
<p>Definition at line <a class="el" href="AsyncAudioClipper_8h_source.html#l00135">135</a> of file <a class="el" href="AsyncAudioClipper_8h_source.html">AsyncAudioClipper.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9fb2f72a884c1810ab4b285335568626"></a><!-- doxytag: member="Async::AudioClipper::setClipLevel" ref="a9fb2f72a884c1810ab4b285335568626" args="(float level)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Async::AudioClipper::setClipLevel </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>level</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the clip level. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>level</em> </td><td>The level to set </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="AsyncAudioClipper_8h_source.html#l00131">131</a> of file <a class="el" href="AsyncAudioClipper_8h_source.html">AsyncAudioClipper.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="AsyncAudioClipper_8h_source.html">AsyncAudioClipper.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
>
139
