<!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: AsyncAudioSource.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>AsyncAudioSource.h</h1><a href="AsyncAudioSource_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_SOURCE_INCLUDED</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define ASYNC_AUDIO_SOURCE_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 <span class="preprocessor">#include <cassert></span>
<a name="l00039"></a>00039
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="comment">/****************************************************************************</span>
<a name="l00042"></a>00042 <span class="comment"> *</span>
<a name="l00043"></a>00043 <span class="comment"> * Project Includes</span>
<a name="l00044"></a>00044 <span class="comment"> *</span>
<a name="l00045"></a>00045 <span class="comment"> ****************************************************************************/</span>
<a name="l00046"></a>00046
<a name="l00047"></a>00047
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="comment">/****************************************************************************</span>
<a name="l00050"></a>00050 <span class="comment"> *</span>
<a name="l00051"></a>00051 <span class="comment"> * Local Includes</span>
<a name="l00052"></a>00052 <span class="comment"> *</span>
<a name="l00053"></a>00053 <span class="comment"> ****************************************************************************/</span>
<a name="l00054"></a>00054
<a name="l00055"></a>00055
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="comment">/****************************************************************************</span>
<a name="l00058"></a>00058 <span class="comment"> *</span>
<a name="l00059"></a>00059 <span class="comment"> * Forward declarations</span>
<a name="l00060"></a>00060 <span class="comment"> *</span>
<a name="l00061"></a>00061 <span class="comment"> ****************************************************************************/</span>
<a name="l00062"></a>00062
<a name="l00063"></a>00063
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="comment">/****************************************************************************</span>
<a name="l00066"></a>00066 <span class="comment"> *</span>
<a name="l00067"></a>00067 <span class="comment"> * Namespace</span>
<a name="l00068"></a>00068 <span class="comment"> *</span>
<a name="l00069"></a>00069 <span class="comment"> ****************************************************************************/</span>
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <span class="keyword">namespace </span>Async
<a name="l00072"></a>00072 {
<a name="l00073"></a>00073
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="comment">/****************************************************************************</span>
<a name="l00076"></a>00076 <span class="comment"> *</span>
<a name="l00077"></a>00077 <span class="comment"> * Forward declarations of classes inside of the declared namespace</span>
<a name="l00078"></a>00078 <span class="comment"> *</span>
<a name="l00079"></a>00079 <span class="comment"> ****************************************************************************/</span>
<a name="l00080"></a>00080
<a name="l00081"></a>00081 <span class="keyword">class </span>AudioSink;
<a name="l00082"></a>00082
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="comment">/****************************************************************************</span>
<a name="l00085"></a>00085 <span class="comment"> *</span>
<a name="l00086"></a>00086 <span class="comment"> * Defines & typedefs</span>
<a name="l00087"></a>00087 <span class="comment"> *</span>
<a name="l00088"></a>00088 <span class="comment"> ****************************************************************************/</span>
<a name="l00089"></a>00089
<a name="l00090"></a>00090
<a name="l00091"></a>00091
<a name="l00092"></a>00092 <span class="comment">/****************************************************************************</span>
<a name="l00093"></a>00093 <span class="comment"> *</span>
<a name="l00094"></a>00094 <span class="comment"> * Exported Global Variables</span>
<a name="l00095"></a>00095 <span class="comment"> *</span>
<a name="l00096"></a>00096 <span class="comment"> ****************************************************************************/</span>
<a name="l00097"></a>00097
<a name="l00098"></a>00098
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="comment">/****************************************************************************</span>
<a name="l00101"></a>00101 <span class="comment"> *</span>
<a name="l00102"></a>00102 <span class="comment"> * Class definitions</span>
<a name="l00103"></a>00103 <span class="comment"> *</span>
<a name="l00104"></a>00104 <span class="comment"> ****************************************************************************/</span>
<a name="l00105"></a>00105
<a name="l00114"></a><a class="code" href="classAsync_1_1AudioSource.html">00114</a> <span class="keyword">class </span><a class="code" href="classAsync_1_1AudioSource.html" title="The base class for an audio source.">AudioSource</a>
<a name="l00115"></a>00115 {
<a name="l00116"></a>00116 <span class="keyword">public</span>:
<a name="l00120"></a><a class="code" href="classAsync_1_1AudioSource.html#a9058cdeb8aa465ab5dcf49112b40df8b">00120</a> <a class="code" href="classAsync_1_1AudioSource.html#a9058cdeb8aa465ab5dcf49112b40df8b" title="Default constuctor.">AudioSource</a>(<span class="keywordtype">void</span>)
<a name="l00121"></a>00121 : m_sink(0), m_sink_managed(false), m_handler(0), is_flushing(false)
<a name="l00122"></a>00122 {
<a name="l00123"></a>00123 }
<a name="l00124"></a>00124
<a name="l00128"></a>00128 <span class="keyword">virtual</span> <a class="code" href="classAsync_1_1AudioSource.html#a65c6adda8ff99609f3020b34a998afdc" title="Destructor.">~AudioSource</a>(<span class="keywordtype">void</span>);
<a name="l00129"></a>00129
<a name="l00137"></a>00137 <span class="keywordtype">bool</span> <a class="code" href="classAsync_1_1AudioSource.html#a2254f2e73c5033ee28a569bd205ed345" title="Register an audio sink to provide samples to.">registerSink</a>(<a class="code" href="classAsync_1_1AudioSink.html" title="The base class for an audio sink.">AudioSink</a> *<a class="code" href="classAsync_1_1AudioSource.html#a3272e7519e762bcb26b33413db082eac" title="Get the registered audio sink.">sink</a>, <span class="keywordtype">bool</span> managed=<span class="keyword">false</span>);
<a name="l00138"></a>00138
<a name="l00142"></a>00142 <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioSource.html#a898aada74ec99cad0cb2edb1b7f534e4" title="Unregister the previously registered audio sink.">unregisterSink</a>(<span class="keywordtype">void</span>);
<a name="l00143"></a>00143
<a name="l00148"></a><a class="code" href="classAsync_1_1AudioSource.html#af105f7f34588e197f331d52fd274eb6e">00148</a> <span class="keywordtype">bool</span> <a class="code" href="classAsync_1_1AudioSource.html#af105f7f34588e197f331d52fd274eb6e" title="Check if an audio sink has been registered.">isRegistered</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_sink != 0; }
<a name="l00149"></a>00149
<a name="l00155"></a><a class="code" href="classAsync_1_1AudioSource.html#a3272e7519e762bcb26b33413db082eac">00155</a> <a class="code" href="classAsync_1_1AudioSink.html" title="The base class for an audio sink.">AudioSink</a> *<a class="code" href="classAsync_1_1AudioSource.html#a3272e7519e762bcb26b33413db082eac" title="Get the registered audio sink.">sink</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_sink; }
<a name="l00156"></a>00156
<a name="l00165"></a><a class="code" href="classAsync_1_1AudioSource.html#a451d8b376851c54a4e0780dcea9a9739">00165</a> <span class="keywordtype">bool</span> <a class="code" href="classAsync_1_1AudioSource.html#a451d8b376851c54a4e0780dcea9a9739" title="Check if the sink is managed or not.">sinkManaged</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_sink_managed; }
<a name="l00166"></a>00166
<a name="l00174"></a><a class="code" href="classAsync_1_1AudioSource.html#a7b0e8399dad546407614f43dc6fe71c6">00174</a> <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioSource.html#a7b0e8399dad546407614f43dc6fe71c6" title="The registered sink has flushed all samples.">handleAllSamplesFlushed</a>(<span class="keywordtype">void</span>)
<a name="l00175"></a>00175 {
<a name="l00176"></a>00176 is_flushing = <span class="keyword">false</span>;
<a name="l00177"></a>00177 <a class="code" href="classAsync_1_1AudioSource.html#a563adf6411eddbd056abf206a12354b6" title="The registered sink has flushed all samples.">allSamplesFlushed</a>();
<a name="l00178"></a>00178 }
<a name="l00179"></a>00179
<a name="l00188"></a><a class="code" href="classAsync_1_1AudioSource.html#ac187f89a6094ec066dab5b4fd3108754">00188</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioSource.html#ac187f89a6094ec066dab5b4fd3108754" title="Resume audio output to the sink.">resumeOutput</a>(<span class="keywordtype">void</span>)
<a name="l00189"></a>00189 {
<a name="l00190"></a>00190 assert(m_handler != 0);
<a name="l00191"></a>00191 m_handler-><a class="code" href="classAsync_1_1AudioSource.html#ac187f89a6094ec066dab5b4fd3108754" title="Resume audio output to the sink.">resumeOutput</a>();
<a name="l00192"></a>00192 }
<a name="l00193"></a>00193
<a name="l00194"></a>00194
<a name="l00195"></a>00195 <span class="keyword">protected</span>:
<a name="l00205"></a><a class="code" href="classAsync_1_1AudioSource.html#a563adf6411eddbd056abf206a12354b6">00205</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioSource.html#a563adf6411eddbd056abf206a12354b6" title="The registered sink has flushed all samples.">allSamplesFlushed</a>(<span class="keywordtype">void</span>)
<a name="l00206"></a>00206 {
<a name="l00207"></a>00207 assert(m_handler != 0);
<a name="l00208"></a>00208 m_handler-><a class="code" href="classAsync_1_1AudioSource.html#a7b0e8399dad546407614f43dc6fe71c6" title="The registered sink has flushed all samples.">handleAllSamplesFlushed</a>();
<a name="l00209"></a>00209 }
<a name="l00210"></a>00210
<a name="l00211"></a>00211 <span class="comment">/*</span>
<a name="l00212"></a>00212 <span class="comment"> * @brief Write samples to the connected sink</span>
<a name="l00213"></a>00213 <span class="comment"> * @param samples The buffer containing the samples to write</span>
<a name="l00214"></a>00214 <span class="comment"> * @param len The number of samples in the buffer</span>
<a name="l00215"></a>00215 <span class="comment"> * @return Return the number of samples that was taken care of</span>
<a name="l00216"></a>00216 <span class="comment"> *</span>
<a name="l00217"></a>00217 <span class="comment"> * This function is used by the inheriting class to write samples to</span>
<a name="l00218"></a>00218 <span class="comment"> * the connected sink, if any. If there is no connected sink, the samples</span>
<a name="l00219"></a>00219 <span class="comment"> * will be thrown away. This function will return the number of samples</span>
<a name="l00220"></a>00220 <span class="comment"> * that was taken care of. Samples that was not taken care of should</span>
<a name="l00221"></a>00221 <span class="comment"> * normally be written again to the sink.</span>
<a name="l00222"></a>00222 <span class="comment"> */</span>
<a name="l00223"></a>00223 <span class="keywordtype">int</span> <a class="code" href="classAsync_1_1AudioSource.html#ad23a249abf0f8fd39d364301364740a6">sinkWriteSamples</a>(<span class="keyword">const</span> <span class="keywordtype">float</span> *samples, <span class="keywordtype">int</span> len);
<a name="l00224"></a>00224
<a name="l00225"></a>00225 <span class="comment">/*</span>
<a name="l00226"></a>00226 <span class="comment"> * @brief Tell the sink to flush any buffered samples</span>
<a name="l00227"></a>00227 <span class="comment"> *</span>
<a name="l00228"></a>00228 <span class="comment"> * This function is used by the inheriting class to tell the connected</span>
<a name="l00229"></a>00229 <span class="comment"> * sink to flush its buffered samples. When the sink have flushed all its</span>
<a name="l00230"></a>00230 <span class="comment"> * samples it will call the allSamplesFlushed function in this class.</span>
<a name="l00231"></a>00231 <span class="comment"> * If there is no registered sink the allSamplesFlushed function will be</span>
<a name="l00232"></a>00232 <span class="comment"> * called right away.</span>
<a name="l00233"></a>00233 <span class="comment"> */</span>
<a name="l00234"></a>00234 <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioSource.html#a5837ec95fef7d668d1c5241cee54646c">sinkFlushSamples</a>(<span class="keywordtype">void</span>);
<a name="l00235"></a>00235
<a name="l00245"></a>00245 <span class="keywordtype">bool</span> <a class="code" href="classAsync_1_1AudioSource.html#a1afec59d8ed442fd7f292a817a6098dd" title="Setup another source to handle the outgoing audio.">setHandler</a>(<a class="code" href="classAsync_1_1AudioSource.html" title="The base class for an audio source.">AudioSource</a> *<a class="code" href="classAsync_1_1AudioSource.html#ad674c3ab16ed170e8d9da029c0c019cd">handler</a>);
<a name="l00246"></a>00246
<a name="l00247"></a>00247 <span class="comment">/*</span>
<a name="l00248"></a>00248 <span class="comment"> * @brief Return the handler</span>
<a name="l00249"></a>00249 <span class="comment"> * @return Returns the handler previously set with setHandler or 0</span>
<a name="l00250"></a>00250 <span class="comment"> * if none have been set</span>
<a name="l00251"></a>00251 <span class="comment"> */</span>
<a name="l00252"></a><a class="code" href="classAsync_1_1AudioSource.html#ad674c3ab16ed170e8d9da029c0c019cd">00252</a> <a class="code" href="classAsync_1_1AudioSource.html" title="The base class for an audio source.">AudioSource</a> *<a class="code" href="classAsync_1_1AudioSource.html#ad674c3ab16ed170e8d9da029c0c019cd">handler</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_handler; }
<a name="l00253"></a>00253
<a name="l00257"></a>00257 <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioSource.html#a70bb05d58da6fbb471f893381cdb0107" title="Clear a handler that was previously setup with setHandler.">clearHandler</a>(<span class="keywordtype">void</span>);
<a name="l00258"></a>00258
<a name="l00259"></a>00259
<a name="l00260"></a>00260 <span class="keyword">private</span>:
<a name="l00261"></a>00261 <a class="code" href="classAsync_1_1AudioSink.html" title="The base class for an audio sink.">AudioSink</a> *m_sink;
<a name="l00262"></a>00262 <span class="keywordtype">bool</span> m_sink_managed;
<a name="l00263"></a>00263 <a class="code" href="classAsync_1_1AudioSource.html" title="The base class for an audio source.">AudioSource</a> *m_handler;
<a name="l00264"></a>00264 <span class="keywordtype">bool</span> m_auto_unreg_source;
<a name="l00265"></a>00265 <span class="keywordtype">bool</span> is_flushing;
<a name="l00266"></a>00266
<a name="l00267"></a>00267 <span class="keywordtype">bool</span> registerSinkInternal(<a class="code" href="classAsync_1_1AudioSink.html" title="The base class for an audio sink.">AudioSink</a> *<a class="code" href="classAsync_1_1AudioSource.html#a3272e7519e762bcb26b33413db082eac" title="Get the registered audio sink.">sink</a>, <span class="keywordtype">bool</span> managed, <span class="keywordtype">bool</span> reg);
<a name="l00268"></a>00268 <span class="keywordtype">void</span> unregisterSinkInternal(<span class="keywordtype">bool</span> is_being_destroyed);
<a name="l00269"></a>00269
<a name="l00270"></a>00270 }; <span class="comment">/* class AudioSource */</span>
<a name="l00271"></a>00271
<a name="l00272"></a>00272
<a name="l00273"></a>00273 } <span class="comment">/* namespace */</span>
<a name="l00274"></a>00274
<a name="l00275"></a>00275 <span class="preprocessor">#endif </span><span class="comment">/* ASYNC_AUDIO_SOURCE_INCLUDED */</span>
<a name="l00276"></a>00276
<a name="l00277"></a>00277
<a name="l00278"></a>00278
<a name="l00279"></a>00279 <span class="comment">/*</span>
<a name="l00280"></a>00280 <span class="comment"> * This file has not been truncated</span>
<a name="l00281"></a>00281 <span class="comment"> */</span>
<a name="l00282"></a>00282
</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
>
91
