<!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: AsyncAudioSink.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>AsyncAudioSink.h</h1><a href="AsyncAudioSink_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_SINK_INCLUDED</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define ASYNC_AUDIO_SINK_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 <span class="preprocessor">#include <cassert></span>
<a name="l00040"></a>00040
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <span class="comment">/****************************************************************************</span>
<a name="l00043"></a>00043 <span class="comment"> *</span>
<a name="l00044"></a>00044 <span class="comment"> * Project Includes</span>
<a name="l00045"></a>00045 <span class="comment"> *</span>
<a name="l00046"></a>00046 <span class="comment"> ****************************************************************************/</span>
<a name="l00047"></a>00047
<a name="l00048"></a>00048
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="comment">/****************************************************************************</span>
<a name="l00051"></a>00051 <span class="comment"> *</span>
<a name="l00052"></a>00052 <span class="comment"> * Local Includes</span>
<a name="l00053"></a>00053 <span class="comment"> *</span>
<a name="l00054"></a>00054 <span class="comment"> ****************************************************************************/</span>
<a name="l00055"></a>00055
<a name="l00056"></a>00056
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="comment">/****************************************************************************</span>
<a name="l00059"></a>00059 <span class="comment"> *</span>
<a name="l00060"></a>00060 <span class="comment"> * Forward declarations</span>
<a name="l00061"></a>00061 <span class="comment"> *</span>
<a name="l00062"></a>00062 <span class="comment"> ****************************************************************************/</span>
<a name="l00063"></a>00063
<a name="l00064"></a>00064
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="comment">/****************************************************************************</span>
<a name="l00067"></a>00067 <span class="comment"> *</span>
<a name="l00068"></a>00068 <span class="comment"> * Namespace</span>
<a name="l00069"></a>00069 <span class="comment"> *</span>
<a name="l00070"></a>00070 <span class="comment"> ****************************************************************************/</span>
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="keyword">namespace </span>Async
<a name="l00073"></a>00073 {
<a name="l00074"></a>00074
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="comment">/****************************************************************************</span>
<a name="l00077"></a>00077 <span class="comment"> *</span>
<a name="l00078"></a>00078 <span class="comment"> * Forward declarations of classes inside of the declared namespace</span>
<a name="l00079"></a>00079 <span class="comment"> *</span>
<a name="l00080"></a>00080 <span class="comment"> ****************************************************************************/</span>
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="keyword">class </span>AudioSource;
<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="l00115"></a><a class="code" href="classAsync_1_1AudioSink.html">00115</a> <span class="keyword">class </span><a class="code" href="classAsync_1_1AudioSink.html" title="The base class for an audio sink.">AudioSink</a>
<a name="l00116"></a>00116 {
<a name="l00117"></a>00117 <span class="keyword">public</span>:
<a name="l00121"></a><a class="code" href="classAsync_1_1AudioSink.html#ae0223d429bd789498549ccc7017f914c">00121</a> <a class="code" href="classAsync_1_1AudioSink.html#ae0223d429bd789498549ccc7017f914c" title="Default constuctor.">AudioSink</a>(<span class="keywordtype">void</span>) : m_source(0), m_handler(0) {}
<a name="l00122"></a>00122
<a name="l00126"></a>00126 <span class="keyword">virtual</span> <a class="code" href="classAsync_1_1AudioSink.html#af4e2da6c82a4a811722115513ab36d94" title="Destructor.">~AudioSink</a>(<span class="keywordtype">void</span>);
<a name="l00127"></a>00127
<a name="l00133"></a>00133 <span class="keywordtype">bool</span> <a class="code" href="classAsync_1_1AudioSink.html#a355c87f3f763af97de92f5b9ac4b6327" title="Register an audio source to provide samples to this sink.">registerSource</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_1AudioSink.html#a19ed4eda15dd3f6718362092f223612a" title="Get the registered audio source.">source</a>);
<a name="l00134"></a>00134
<a name="l00138"></a>00138 <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioSink.html#a4096137dbc22fe2568b8a2f0095dd2e9" title="Unregister the previously registered audio source.">unregisterSource</a>(<span class="keywordtype">void</span>);
<a name="l00139"></a>00139
<a name="l00144"></a><a class="code" href="classAsync_1_1AudioSink.html#ad6d84028464b76a1d2714c85825d5b97">00144</a> <span class="keywordtype">bool</span> <a class="code" href="classAsync_1_1AudioSink.html#ad6d84028464b76a1d2714c85825d5b97" title="Check if an audio source has been registered.">isRegistered</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_source != 0; }
<a name="l00145"></a>00145
<a name="l00151"></a><a class="code" href="classAsync_1_1AudioSink.html#a19ed4eda15dd3f6718362092f223612a">00151</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_1AudioSink.html#a19ed4eda15dd3f6718362092f223612a" title="Get the registered audio source.">source</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_source; }
<a name="l00152"></a>00152
<a name="l00164"></a><a class="code" href="classAsync_1_1AudioSink.html#a490aa6380d6b0069fc501f0d9f62e236">00164</a> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classAsync_1_1AudioSink.html#a490aa6380d6b0069fc501f0d9f62e236" title="Write samples into this audio sink.">writeSamples</a>(<span class="keyword">const</span> <span class="keywordtype">float</span> *samples, <span class="keywordtype">int</span> count)
<a name="l00165"></a>00165 {
<a name="l00166"></a>00166 assert(m_handler != 0);
<a name="l00167"></a>00167 <span class="keywordflow">return</span> m_handler-><a class="code" href="classAsync_1_1AudioSink.html#a490aa6380d6b0069fc501f0d9f62e236" title="Write samples into this audio sink.">writeSamples</a>(samples, count);
<a name="l00168"></a>00168 }
<a name="l00169"></a>00169
<a name="l00178"></a><a class="code" href="classAsync_1_1AudioSink.html#adde14468248671c6c5c85eb47234e0fa">00178</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioSink.html#adde14468248671c6c5c85eb47234e0fa" title="Tell the sink to flush the previously written samples.">flushSamples</a>(<span class="keywordtype">void</span>)
<a name="l00179"></a>00179 {
<a name="l00180"></a>00180 assert(m_handler != 0);
<a name="l00181"></a>00181 m_handler-><a class="code" href="classAsync_1_1AudioSink.html#adde14468248671c6c5c85eb47234e0fa" title="Tell the sink to flush the previously written samples.">flushSamples</a>();
<a name="l00182"></a>00182 }
<a name="l00183"></a>00183
<a name="l00184"></a>00184
<a name="l00185"></a>00185 <span class="keyword">protected</span>:
<a name="l00189"></a>00189 <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioSink.html#a4c16d7b78aade12abc0b57ec1db95f62" title="Tell the source that we are ready to accept more samples.">sourceResumeOutput</a>(<span class="keywordtype">void</span>);
<a name="l00190"></a>00190
<a name="l00199"></a>00199 <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioSink.html#a2548622eb5c52ef80f3bd297f290be3c" title="Tell the source that all samples have been flushed.">sourceAllSamplesFlushed</a>(<span class="keywordtype">void</span>);
<a name="l00200"></a>00200
<a name="l00210"></a>00210 <span class="keywordtype">bool</span> <a class="code" href="classAsync_1_1AudioSink.html#af29f830e9b6ea167cf8f4e9e3ae1be3a" title="Setup another sink to handle the incoming audio.">setHandler</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_1AudioSink.html#afa9ccd2a1d0f39aabde37bf6e14566c0">handler</a>);
<a name="l00211"></a>00211
<a name="l00215"></a>00215 <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioSink.html#a11df81d747facec35563e9359520b522" title="Clear a handler that was previously setup with setHandler.">clearHandler</a>(<span class="keywordtype">void</span>);
<a name="l00216"></a>00216
<a name="l00217"></a>00217 <span class="comment">/*</span>
<a name="l00218"></a>00218 <span class="comment"> * @brief Return the handler</span>
<a name="l00219"></a>00219 <span class="comment"> * @return Returns the handler previously set with setHandler or 0</span>
<a name="l00220"></a>00220 <span class="comment"> * if none have been set</span>
<a name="l00221"></a>00221 <span class="comment"> */</span>
<a name="l00222"></a><a class="code" href="classAsync_1_1AudioSink.html#afa9ccd2a1d0f39aabde37bf6e14566c0">00222</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_1AudioSink.html#afa9ccd2a1d0f39aabde37bf6e14566c0">handler</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_handler; }
<a name="l00223"></a>00223
<a name="l00224"></a>00224
<a name="l00225"></a>00225 <span class="keyword">private</span>:
<a name="l00226"></a>00226 <a class="code" href="classAsync_1_1AudioSource.html" title="The base class for an audio source.">AudioSource</a> *m_source;
<a name="l00227"></a>00227 <a class="code" href="classAsync_1_1AudioSink.html" title="The base class for an audio sink.">AudioSink</a> *m_handler;
<a name="l00228"></a>00228 <span class="keywordtype">bool</span> m_auto_unreg_sink;
<a name="l00229"></a>00229
<a name="l00230"></a>00230 <span class="keywordtype">bool</span> registerSourceInternal(<a class="code" href="classAsync_1_1AudioSource.html" title="The base class for an audio source.">AudioSource</a> *<a class="code" href="classAsync_1_1AudioSink.html#a19ed4eda15dd3f6718362092f223612a" title="Get the registered audio source.">source</a>, <span class="keywordtype">bool</span> reg_sink);
<a name="l00231"></a>00231
<a name="l00232"></a>00232 }; <span class="comment">/* class AudioSink */</span>
<a name="l00233"></a>00233
<a name="l00234"></a>00234
<a name="l00235"></a>00235 } <span class="comment">/* namespace */</span>
<a name="l00236"></a>00236
<a name="l00237"></a>00237 <span class="preprocessor">#endif </span><span class="comment">/* ASYNC_AUDIO_SINK_INCLUDED */</span>
<a name="l00238"></a>00238
<a name="l00239"></a>00239
<a name="l00240"></a>00240
<a name="l00241"></a>00241 <span class="comment">/*</span>
<a name="l00242"></a>00242 <span class="comment"> * This file has not been truncated</span>
<a name="l00243"></a>00243 <span class="comment"> */</span>
<a name="l00244"></a>00244
</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
>
89
