<!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: AsyncAudioValve.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_d583404e3b046262ade615a4e7154c3b.html">include</a>
</div>
</div>
<div class="contents">
<h1>AsyncAudioValve.h</h1><a href="AsyncAudioValve_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef ASYNC_AUDIO_VALVE_INCLUDED</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define ASYNC_AUDIO_VALVE_INCLUDED</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="comment">/****************************************************************************</span>
<a name="l00033"></a>00033 <span class="comment"> *</span>
<a name="l00034"></a>00034 <span class="comment"> * System Includes</span>
<a name="l00035"></a>00035 <span class="comment"> *</span>
<a name="l00036"></a>00036 <span class="comment"> ****************************************************************************/</span>
<a name="l00037"></a>00037
<a name="l00038"></a>00038
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="comment">/****************************************************************************</span>
<a name="l00041"></a>00041 <span class="comment"> *</span>
<a name="l00042"></a>00042 <span class="comment"> * Project Includes</span>
<a name="l00043"></a>00043 <span class="comment"> *</span>
<a name="l00044"></a>00044 <span class="comment"> ****************************************************************************/</span>
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="preprocessor">#include <<a class="code" href="AsyncAudioSink_8h.html" title="This file contains the base class for an audio sink.">AsyncAudioSink.h</a>></span>
<a name="l00047"></a>00047 <span class="preprocessor">#include <<a class="code" href="AsyncAudioSource_8h.html" title="This file contains the base class for an audio source.">AsyncAudioSource.h</a>></span>
<a name="l00048"></a>00048
<a name="l00049"></a>00049
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="comment">/****************************************************************************</span>
<a name="l00052"></a>00052 <span class="comment"> *</span>
<a name="l00053"></a>00053 <span class="comment"> * Local Includes</span>
<a name="l00054"></a>00054 <span class="comment"> *</span>
<a name="l00055"></a>00055 <span class="comment"> ****************************************************************************/</span>
<a name="l00056"></a>00056
<a name="l00057"></a>00057
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="comment">/****************************************************************************</span>
<a name="l00060"></a>00060 <span class="comment"> *</span>
<a name="l00061"></a>00061 <span class="comment"> * Forward declarations</span>
<a name="l00062"></a>00062 <span class="comment"> *</span>
<a name="l00063"></a>00063 <span class="comment"> ****************************************************************************/</span>
<a name="l00064"></a>00064
<a name="l00065"></a>00065
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="comment">/****************************************************************************</span>
<a name="l00068"></a>00068 <span class="comment"> *</span>
<a name="l00069"></a>00069 <span class="comment"> * Namespace</span>
<a name="l00070"></a>00070 <span class="comment"> *</span>
<a name="l00071"></a>00071 <span class="comment"> ****************************************************************************/</span>
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="keyword">namespace </span>Async
<a name="l00074"></a>00074 {
<a name="l00075"></a>00075
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="comment">/****************************************************************************</span>
<a name="l00078"></a>00078 <span class="comment"> *</span>
<a name="l00079"></a>00079 <span class="comment"> * Forward declarations of classes inside of the declared namespace</span>
<a name="l00080"></a>00080 <span class="comment"> *</span>
<a name="l00081"></a>00081 <span class="comment"> ****************************************************************************/</span>
<a name="l00082"></a>00082
<a name="l00083"></a>00083
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="comment">/****************************************************************************</span>
<a name="l00086"></a>00086 <span class="comment"> *</span>
<a name="l00087"></a>00087 <span class="comment"> * Defines & typedefs</span>
<a name="l00088"></a>00088 <span class="comment"> *</span>
<a name="l00089"></a>00089 <span class="comment"> ****************************************************************************/</span>
<a name="l00090"></a>00090
<a name="l00091"></a>00091
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="comment">/****************************************************************************</span>
<a name="l00094"></a>00094 <span class="comment"> *</span>
<a name="l00095"></a>00095 <span class="comment"> * Exported Global Variables</span>
<a name="l00096"></a>00096 <span class="comment"> *</span>
<a name="l00097"></a>00097 <span class="comment"> ****************************************************************************/</span>
<a name="l00098"></a>00098
<a name="l00099"></a>00099
<a name="l00100"></a>00100
<a name="l00101"></a>00101 <span class="comment">/****************************************************************************</span>
<a name="l00102"></a>00102 <span class="comment"> *</span>
<a name="l00103"></a>00103 <span class="comment"> * Class definitions</span>
<a name="l00104"></a>00104 <span class="comment"> *</span>
<a name="l00105"></a>00105 <span class="comment"> ****************************************************************************/</span>
<a name="l00106"></a>00106
<a name="l00116"></a><a class="code" href="classAsync_1_1AudioValve.html">00116</a> <span class="keyword">class </span><a class="code" href="classAsync_1_1AudioValve.html" title="Implements a &quot;valve&quot; for audio.">AudioValve</a> : <span class="keyword">public</span> Async::<a class="code" href="classAsync_1_1AudioSink.html" title="The base class for an audio sink.">AudioSink</a>, <span class="keyword">public</span> Async::<a class="code" href="classAsync_1_1AudioSource.html" title="The base class for an audio source.">AudioSource</a>
<a name="l00117"></a>00117 {
<a name="l00118"></a>00118 <span class="keyword">public</span>:
<a name="l00122"></a><a class="code" href="classAsync_1_1AudioValve.html#aa67dd3ca1a28bbd33b6c6d6a035f1d24">00122</a> <span class="keyword">explicit</span> <a class="code" href="classAsync_1_1AudioValve.html#aa67dd3ca1a28bbd33b6c6d6a035f1d24" title="Default constuctor.">AudioValve</a>(<span class="keywordtype">void</span>)
<a name="l00123"></a>00123 : block_when_closed(false), is_open(true),
<a name="l00124"></a>00124 is_idle(true), is_flushing(false), input_stopped(false)
<a name="l00125"></a>00125 {
<a name="l00126"></a>00126 }
<a name="l00127"></a>00127
<a name="l00131"></a><a class="code" href="classAsync_1_1AudioValve.html#abed070587739097e21acd8faa685957f">00131</a> <a class="code" href="classAsync_1_1AudioValve.html#abed070587739097e21acd8faa685957f" title="Destructor.">~AudioValve</a>(<span class="keywordtype">void</span>) {}
<a name="l00132"></a>00132
<a name="l00142"></a><a class="code" href="classAsync_1_1AudioValve.html#a6c9cc481493f4a8fa68aebba1f545bce">00142</a> <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioValve.html#a6c9cc481493f4a8fa68aebba1f545bce" title="Open or close the valve.">setOpen</a>(<span class="keywordtype">bool</span> do_open)
<a name="l00143"></a>00143 {
<a name="l00144"></a>00144 <span class="keywordflow">if</span> (is_open == do_open)
<a name="l00145"></a>00145 {
<a name="l00146"></a>00146 <span class="keywordflow">return</span>;
<a name="l00147"></a>00147 }
<a name="l00148"></a>00148
<a name="l00149"></a>00149 is_open = do_open;
<a name="l00150"></a>00150
<a name="l00151"></a>00151 <span class="keywordflow">if</span> (do_open)
<a name="l00152"></a>00152 {
<a name="l00153"></a>00153 <span class="keywordflow">if</span> (input_stopped)
<a name="l00154"></a>00154 {
<a name="l00155"></a>00155 input_stopped = <span class="keyword">false</span>;
<a name="l00156"></a>00156 <a class="code" href="classAsync_1_1AudioSink.html#a4c16d7b78aade12abc0b57ec1db95f62" title="Tell the source that we are ready to accept more samples.">sourceResumeOutput</a>();
<a name="l00157"></a>00157 }
<a name="l00158"></a>00158 }
<a name="l00159"></a>00159 <span class="keywordflow">else</span>
<a name="l00160"></a>00160 {
<a name="l00161"></a>00161 <span class="keywordflow">if</span> (!is_idle && !is_flushing)
<a name="l00162"></a>00162 {
<a name="l00163"></a>00163 <a class="code" href="classAsync_1_1AudioSource.html#a5837ec95fef7d668d1c5241cee54646c">sinkFlushSamples</a>();
<a name="l00164"></a>00164 }
<a name="l00165"></a>00165 <span class="keywordflow">if</span> (!block_when_closed && input_stopped)
<a name="l00166"></a>00166 {
<a name="l00167"></a>00167 input_stopped = <span class="keyword">false</span>;
<a name="l00168"></a>00168 <a class="code" href="classAsync_1_1AudioSink.html#a4c16d7b78aade12abc0b57ec1db95f62" title="Tell the source that we are ready to accept more samples.">sourceResumeOutput</a>();
<a name="l00169"></a>00169 }
<a name="l00170"></a>00170 <span class="keywordflow">if</span> (is_flushing)
<a name="l00171"></a>00171 {
<a name="l00172"></a>00172 is_idle = <span class="keyword">true</span>;
<a name="l00173"></a>00173 is_flushing = <span class="keyword">false</span>;
<a name="l00174"></a>00174 <a class="code" href="classAsync_1_1AudioSink.html#a2548622eb5c52ef80f3bd297f290be3c" title="Tell the source that all samples have been flushed.">sourceAllSamplesFlushed</a>();
<a name="l00175"></a>00175 }
<a name="l00176"></a>00176 }
<a name="l00177"></a>00177 }
<a name="l00178"></a>00178
<a name="l00188"></a><a class="code" href="classAsync_1_1AudioValve.html#abe5276018ad9a0d5db336e1c03b55554">00188</a> <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioValve.html#abe5276018ad9a0d5db336e1c03b55554" title="Setup audio stream blocking when valve is closed.">setBlockWhenClosed</a>(<span class="keywordtype">bool</span> block_when_closed)
<a name="l00189"></a>00189 {
<a name="l00190"></a>00190 <span class="keywordflow">if</span> (block_when_closed == this->block_when_closed)
<a name="l00191"></a>00191 {
<a name="l00192"></a>00192 <span class="keywordflow">return</span>;
<a name="l00193"></a>00193 }
<a name="l00194"></a>00194
<a name="l00195"></a>00195 this->block_when_closed = block_when_closed;
<a name="l00196"></a>00196
<a name="l00197"></a>00197 <span class="keywordflow">if</span> (!block_when_closed && input_stopped)
<a name="l00198"></a>00198 {
<a name="l00199"></a>00199 input_stopped = <span class="keyword">false</span>;
<a name="l00200"></a>00200 <a class="code" href="classAsync_1_1AudioSink.html#a4c16d7b78aade12abc0b57ec1db95f62" title="Tell the source that we are ready to accept more samples.">sourceResumeOutput</a>();
<a name="l00201"></a>00201 }
<a name="l00202"></a>00202 }
<a name="l00203"></a>00203
<a name="l00208"></a><a class="code" href="classAsync_1_1AudioValve.html#a68949805d8e385dfa521f8ba1245a12d">00208</a> <span class="keywordtype">bool</span> <a class="code" href="classAsync_1_1AudioValve.html#a68949805d8e385dfa521f8ba1245a12d" title="Check if the valve is open.">isOpen</a>(<span class="keywordtype">void</span>)<span class="keyword"> const</span>
<a name="l00209"></a>00209 <span class="keyword"> </span>{
<a name="l00210"></a>00210 <span class="keywordflow">return</span> is_open;
<a name="l00211"></a>00211 }
<a name="l00212"></a>00212
<a name="l00217"></a><a class="code" href="classAsync_1_1AudioValve.html#a5d5989016129eab94c82df44570ab6d9">00217</a> <span class="keywordtype">bool</span> <a class="code" href="classAsync_1_1AudioValve.html#a5d5989016129eab94c82df44570ab6d9" title="Check if the valve is idle.">isIdle</a>(<span class="keywordtype">void</span>)<span class="keyword"> const</span>
<a name="l00218"></a>00218 <span class="keyword"> </span>{
<a name="l00219"></a>00219 <span class="keywordflow">return</span> is_idle;
<a name="l00220"></a>00220 }
<a name="l00221"></a>00221
<a name="l00233"></a><a class="code" href="classAsync_1_1AudioValve.html#ad0d94a0a09f1d0a04935651b9962228a">00233</a> <span class="keywordtype">int</span> <a class="code" href="classAsync_1_1AudioValve.html#ad0d94a0a09f1d0a04935651b9962228a" title="Write samples into the valve.">writeSamples</a>(<span class="keyword">const</span> <span class="keywordtype">float</span> *samples, <span class="keywordtype">int</span> count)
<a name="l00234"></a>00234 {
<a name="l00235"></a>00235 <span class="keywordtype">int</span> ret = 0;
<a name="l00236"></a>00236 is_idle = <span class="keyword">false</span>;
<a name="l00237"></a>00237 is_flushing = <span class="keyword">false</span>;
<a name="l00238"></a>00238 <span class="keywordflow">if</span> (is_open)
<a name="l00239"></a>00239 {
<a name="l00240"></a>00240 ret = <a class="code" href="classAsync_1_1AudioSource.html#ad23a249abf0f8fd39d364301364740a6">sinkWriteSamples</a>(samples, count);
<a name="l00241"></a>00241 }
<a name="l00242"></a>00242 <span class="keywordflow">else</span>
<a name="l00243"></a>00243 {
<a name="l00244"></a>00244 ret = (block_when_closed ? 0 : count);
<a name="l00245"></a>00245 }
<a name="l00246"></a>00246
<a name="l00247"></a>00247 <span class="keywordflow">if</span> (ret == 0)
<a name="l00248"></a>00248 {
<a name="l00249"></a>00249 input_stopped = <span class="keyword">true</span>;
<a name="l00250"></a>00250 }
<a name="l00251"></a>00251
<a name="l00252"></a>00252 <span class="keywordflow">return</span> ret;
<a name="l00253"></a>00253 }
<a name="l00254"></a>00254
<a name="l00263"></a><a class="code" href="classAsync_1_1AudioValve.html#ad82dfbcf4f44765b4fa54ea62bc2cac6">00263</a> <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioValve.html#ad82dfbcf4f44765b4fa54ea62bc2cac6" title="Tell the valve to flush the previously written samples.">flushSamples</a>(<span class="keywordtype">void</span>)
<a name="l00264"></a>00264 {
<a name="l00265"></a>00265 <span class="keywordflow">if</span> (is_open)
<a name="l00266"></a>00266 {
<a name="l00267"></a>00267 is_flushing = <span class="keyword">true</span>;
<a name="l00268"></a>00268 <a class="code" href="classAsync_1_1AudioSource.html#a5837ec95fef7d668d1c5241cee54646c">sinkFlushSamples</a>();
<a name="l00269"></a>00269 }
<a name="l00270"></a>00270 <span class="keywordflow">else</span>
<a name="l00271"></a>00271 {
<a name="l00272"></a>00272 is_flushing = <span class="keyword">false</span>;
<a name="l00273"></a>00273 is_idle = <span class="keyword">true</span>;
<a name="l00274"></a>00274 <a class="code" href="classAsync_1_1AudioSink.html#a2548622eb5c52ef80f3bd297f290be3c" title="Tell the source that all samples have been flushed.">sourceAllSamplesFlushed</a>();
<a name="l00275"></a>00275 }
<a name="l00276"></a>00276 }
<a name="l00277"></a>00277
<a name="l00286"></a><a class="code" href="classAsync_1_1AudioValve.html#a3557e4f4c65077ebc7471e6c72027166">00286</a> <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioValve.html#a3557e4f4c65077ebc7471e6c72027166" title="Resume audio output to the sink.">resumeOutput</a>(<span class="keywordtype">void</span>)
<a name="l00287"></a>00287 {
<a name="l00288"></a>00288 <span class="keywordflow">if</span> (is_open)
<a name="l00289"></a>00289 {
<a name="l00290"></a>00290 <span class="keywordflow">if</span> (input_stopped)
<a name="l00291"></a>00291 {
<a name="l00292"></a>00292 input_stopped = <span class="keyword">false</span>;
<a name="l00293"></a>00293 <a class="code" href="classAsync_1_1AudioSink.html#a4c16d7b78aade12abc0b57ec1db95f62" title="Tell the source that we are ready to accept more samples.">sourceResumeOutput</a>();
<a name="l00294"></a>00294 }
<a name="l00295"></a>00295 }
<a name="l00296"></a>00296 }
<a name="l00297"></a>00297
<a name="l00305"></a><a class="code" href="classAsync_1_1AudioValve.html#a3066a711624eec1c9838fb0e2b5bb365">00305</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioValve.html#a3066a711624eec1c9838fb0e2b5bb365" title="The registered sink has flushed all samples.">allSamplesFlushed</a>(<span class="keywordtype">void</span>)
<a name="l00306"></a>00306 {
<a name="l00307"></a>00307 <span class="keywordtype">bool</span> was_flushing = is_flushing;
<a name="l00308"></a>00308 is_flushing = <span class="keyword">false</span>;
<a name="l00309"></a>00309 is_idle = <span class="keyword">true</span>;
<a name="l00310"></a>00310 <span class="keywordflow">if</span> (is_open && was_flushing)
<a name="l00311"></a>00311 {
<a name="l00312"></a>00312 <a class="code" href="classAsync_1_1AudioSink.html#a2548622eb5c52ef80f3bd297f290be3c" title="Tell the source that all samples have been flushed.">sourceAllSamplesFlushed</a>();
<a name="l00313"></a>00313 }
<a name="l00314"></a>00314 }
<a name="l00315"></a>00315
<a name="l00316"></a>00316
<a name="l00317"></a>00317 <span class="keyword">protected</span>:
<a name="l00318"></a>00318
<a name="l00319"></a>00319 <span class="keyword">private</span>:
<a name="l00320"></a>00320 <a class="code" href="classAsync_1_1AudioValve.html#aa67dd3ca1a28bbd33b6c6d6a035f1d24" title="Default constuctor.">AudioValve</a>(<span class="keyword">const</span> <a class="code" href="classAsync_1_1AudioValve.html" title="Implements a &quot;valve&quot; for audio.">AudioValve</a>&);
<a name="l00321"></a>00321 <a class="code" href="classAsync_1_1AudioValve.html" title="Implements a &quot;valve&quot; for audio.">AudioValve</a>& operator=(<span class="keyword">const</span> <a class="code" href="classAsync_1_1AudioValve.html" title="Implements a &quot;valve&quot; for audio.">AudioValve</a>&);
<a name="l00322"></a>00322
<a name="l00323"></a>00323 <span class="keywordtype">bool</span> block_when_closed;
<a name="l00324"></a>00324 <span class="keywordtype">bool</span> is_open;
<a name="l00325"></a>00325 <span class="keywordtype">bool</span> is_idle;
<a name="l00326"></a>00326 <span class="keywordtype">bool</span> is_flushing;
<a name="l00327"></a>00327 <span class="keywordtype">bool</span> input_stopped;
<a name="l00328"></a>00328
<a name="l00329"></a>00329 }; <span class="comment">/* class AudioValve */</span>
<a name="l00330"></a>00330
<a name="l00331"></a>00331
<a name="l00332"></a>00332 } <span class="comment">/* namespace */</span>
<a name="l00333"></a>00333
<a name="l00334"></a>00334 <span class="preprocessor">#endif </span><span class="comment">/* ASYNC_AUDIO_VALVE_INCLUDED */</span>
<a name="l00335"></a>00335
<a name="l00336"></a>00336
<a name="l00337"></a>00337
<a name="l00338"></a>00338 <span class="comment">/*</span>
<a name="l00339"></a>00339 <span class="comment"> * This file has not been truncated</span>
<a name="l00340"></a>00340 <span class="comment"> */</span>
<a name="l00341"></a>00341
</pre></div></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
>
97
