Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > os > by-pkgid > 9c481c872fb0ae0cbadccdc2f4a18ab6 > files > 66

libasync-devel-0.17.0-5.fc14.x86_64.rpm

<!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: AsyncAudioFifo.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&nbsp;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&nbsp;List</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="dir_d583404e3b046262ade615a4e7154c3b.html">include</a>
  </div>
</div>
<div class="contents">
<h1>AsyncAudioFifo.h</h1><a href="AsyncAudioFifo_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 
<a name="l00030"></a>00030 <span class="preprocessor">#ifndef ASYNC_AUDIO_FIFO_INCLUDED</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#define ASYNC_AUDIO_FIFO_INCLUDED</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00033"></a>00033 
<a name="l00034"></a>00034 <span class="comment">/****************************************************************************</span>
<a name="l00035"></a>00035 <span class="comment"> *</span>
<a name="l00036"></a>00036 <span class="comment"> * System Includes</span>
<a name="l00037"></a>00037 <span class="comment"> *</span>
<a name="l00038"></a>00038 <span class="comment"> ****************************************************************************/</span>
<a name="l00039"></a>00039 
<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 <span class="preprocessor">#include &lt;<a class="code" href="AsyncAudioSink_8h.html" title="This file contains the base class for an audio sink.">AsyncAudioSink.h</a>&gt;</span>
<a name="l00049"></a>00049 <span class="preprocessor">#include &lt;<a class="code" href="AsyncAudioSource_8h.html" title="This file contains the base class for an audio source.">AsyncAudioSource.h</a>&gt;</span>
<a name="l00050"></a>00050 
<a name="l00051"></a>00051 
<a name="l00052"></a>00052 <span class="comment">/****************************************************************************</span>
<a name="l00053"></a>00053 <span class="comment"> *</span>
<a name="l00054"></a>00054 <span class="comment"> * Local Includes</span>
<a name="l00055"></a>00055 <span class="comment"> *</span>
<a name="l00056"></a>00056 <span class="comment"> ****************************************************************************/</span>
<a name="l00057"></a>00057 
<a name="l00058"></a>00058 
<a name="l00059"></a>00059 
<a name="l00060"></a>00060 <span class="comment">/****************************************************************************</span>
<a name="l00061"></a>00061 <span class="comment"> *</span>
<a name="l00062"></a>00062 <span class="comment"> * Forward declarations</span>
<a name="l00063"></a>00063 <span class="comment"> *</span>
<a name="l00064"></a>00064 <span class="comment"> ****************************************************************************/</span>
<a name="l00065"></a>00065 
<a name="l00066"></a>00066 
<a name="l00067"></a>00067 
<a name="l00068"></a>00068 <span class="comment">/****************************************************************************</span>
<a name="l00069"></a>00069 <span class="comment"> *</span>
<a name="l00070"></a>00070 <span class="comment"> * Namespace</span>
<a name="l00071"></a>00071 <span class="comment"> *</span>
<a name="l00072"></a>00072 <span class="comment"> ****************************************************************************/</span>
<a name="l00073"></a>00073 
<a name="l00074"></a>00074 <span class="keyword">namespace </span>Async
<a name="l00075"></a>00075 {
<a name="l00076"></a>00076 
<a name="l00077"></a>00077 
<a name="l00078"></a>00078 <span class="comment">/****************************************************************************</span>
<a name="l00079"></a>00079 <span class="comment"> *</span>
<a name="l00080"></a>00080 <span class="comment"> * Forward declarations of classes inside of the declared namespace</span>
<a name="l00081"></a>00081 <span class="comment"> *</span>
<a name="l00082"></a>00082 <span class="comment"> ****************************************************************************/</span>
<a name="l00083"></a>00083 
<a name="l00084"></a>00084   
<a name="l00085"></a>00085 
<a name="l00086"></a>00086 <span class="comment">/****************************************************************************</span>
<a name="l00087"></a>00087 <span class="comment"> *</span>
<a name="l00088"></a>00088 <span class="comment"> * Defines &amp; typedefs</span>
<a name="l00089"></a>00089 <span class="comment"> *</span>
<a name="l00090"></a>00090 <span class="comment"> ****************************************************************************/</span>
<a name="l00091"></a>00091 
<a name="l00092"></a>00092 
<a name="l00093"></a>00093 
<a name="l00094"></a>00094 <span class="comment">/****************************************************************************</span>
<a name="l00095"></a>00095 <span class="comment"> *</span>
<a name="l00096"></a>00096 <span class="comment"> * Exported Global Variables</span>
<a name="l00097"></a>00097 <span class="comment"> *</span>
<a name="l00098"></a>00098 <span class="comment"> ****************************************************************************/</span>
<a name="l00099"></a>00099 
<a name="l00100"></a>00100 
<a name="l00101"></a>00101 
<a name="l00102"></a>00102 <span class="comment">/****************************************************************************</span>
<a name="l00103"></a>00103 <span class="comment"> *</span>
<a name="l00104"></a>00104 <span class="comment"> * Class definitions</span>
<a name="l00105"></a>00105 <span class="comment"> *</span>
<a name="l00106"></a>00106 <span class="comment"> ****************************************************************************/</span>
<a name="l00107"></a>00107 
<a name="l00119"></a><a class="code" href="classAsync_1_1AudioFifo.html">00119</a> <span class="keyword">class </span><a class="code" href="classAsync_1_1AudioFifo.html" title="A FIFO class for handling audio samples.">AudioFifo</a> : <span class="keyword">public</span> <a class="code" href="classAsync_1_1AudioSink.html" title="The base class for an audio sink.">AudioSink</a>, <span class="keyword">public</span> <a class="code" href="classAsync_1_1AudioSource.html" title="The base class for an audio source.">AudioSource</a>
<a name="l00120"></a>00120 {
<a name="l00121"></a>00121   <span class="keyword">public</span>:
<a name="l00127"></a>00127     <span class="keyword">explicit</span> <a class="code" href="classAsync_1_1AudioFifo.html#a47158be7cbe4b369676a5769651d5802" title="Constuctor.">AudioFifo</a>(<span class="keywordtype">unsigned</span> fifo_size);
<a name="l00128"></a>00128   
<a name="l00132"></a>00132     <span class="keyword">virtual</span> <a class="code" href="classAsync_1_1AudioFifo.html#af804b015a42ee61e38a5b952f44c518e" title="Destructor.">~AudioFifo</a>(<span class="keywordtype">void</span>);
<a name="l00133"></a>00133   
<a name="l00138"></a><a class="code" href="classAsync_1_1AudioFifo.html#afc5765cf3638971e44b270a12680e61d">00138</a>     <span class="keywordtype">bool</span> <a class="code" href="classAsync_1_1AudioFifo.html#afc5765cf3638971e44b270a12680e61d" title="Check if the FIFO is empty.">empty</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !is_full &amp;&amp; (tail == head); }
<a name="l00139"></a>00139     
<a name="l00148"></a><a class="code" href="classAsync_1_1AudioFifo.html#a5f9f6c9fceb19c1d6bbded29b3e9537f">00148</a>     <span class="keywordtype">bool</span> <a class="code" href="classAsync_1_1AudioFifo.html#a5f9f6c9fceb19c1d6bbded29b3e9537f" title="Check if the FIFO is full.">full</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> is_full; }
<a name="l00149"></a>00149     
<a name="l00156"></a>00156     <span class="keywordtype">unsigned</span> <a class="code" href="classAsync_1_1AudioFifo.html#ad37313f2808501ac57a4db8b45e07579" title="Find out how many samples there are in the FIFO.">samplesInFifo</a>(<span class="keywordtype">bool</span> ignore_prebuf=<span class="keyword">false</span>) <span class="keyword">const</span>;
<a name="l00157"></a>00157     
<a name="l00169"></a><a class="code" href="classAsync_1_1AudioFifo.html#a88e0968f0438e3eda0374b35497f5d21">00169</a>     <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioFifo.html#a88e0968f0438e3eda0374b35497f5d21" title="Set the overwrite mode.">setOverwrite</a>(<span class="keywordtype">bool</span> <a class="code" href="classAsync_1_1AudioFifo.html#a2b2f0bdb439a2ab4269292274c514c82" title="Check the overwrite mode.">overwrite</a>) { do_overwrite = overwrite; }
<a name="l00170"></a>00170     
<a name="l00183"></a><a class="code" href="classAsync_1_1AudioFifo.html#a2b2f0bdb439a2ab4269292274c514c82">00183</a>     <span class="keywordtype">bool</span> <a class="code" href="classAsync_1_1AudioFifo.html#a2b2f0bdb439a2ab4269292274c514c82" title="Check the overwrite mode.">overwrite</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> do_overwrite; }
<a name="l00184"></a>00184     
<a name="l00191"></a>00191     <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioFifo.html#a0a315268c60c1f3611c554be52a14fe3" title="Clear all samples from the FIFO.">clear</a>(<span class="keywordtype">void</span>);
<a name="l00192"></a>00192 
<a name="l00198"></a>00198     <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioFifo.html#ac6311c5ef4ce06c09dab94b41abd914f" title="Set the number of samples that must be in the fifo before any samples are written...">setPrebufSamples</a>(<span class="keywordtype">unsigned</span> prebuf_samples);
<a name="l00199"></a>00199     
<a name="l00211"></a>00211     <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioFifo.html#aa89651ec97be3a1585b9cf5f6d452e3c" title="Enable/disable the fifo buffer.">enableBuffering</a>(<span class="keywordtype">bool</span> enable);
<a name="l00212"></a>00212     
<a name="l00217"></a><a class="code" href="classAsync_1_1AudioFifo.html#af7906c2c52f9131010d01d8465496863">00217</a>     <span class="keywordtype">bool</span> <a class="code" href="classAsync_1_1AudioFifo.html#af7906c2c52f9131010d01d8465496863" title="Check if buffering is enabled or disabled.">bufferingEnabled</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> buffering_enabled; }
<a name="l00218"></a>00218     
<a name="l00230"></a>00230     <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classAsync_1_1AudioFifo.html#a9749091f636ef3f7baf99cfea494721c" title="Write samples into the FIFO.">writeSamples</a>(<span class="keyword">const</span> <span class="keywordtype">float</span> *samples, <span class="keywordtype">int</span> count);
<a name="l00231"></a>00231     
<a name="l00239"></a>00239     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioFifo.html#abbc0d2527dd6fd47938da51686c7ed16" title="Tell the FIFO to flush the previously written samples.">flushSamples</a>(<span class="keywordtype">void</span>);
<a name="l00240"></a>00240     
<a name="l00248"></a>00248     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioFifo.html#a9d0e1c7aa52ace7ce4499087230c4292" title="Resume audio output to the connected sink.">resumeOutput</a>(<span class="keywordtype">void</span>);
<a name="l00249"></a>00249     
<a name="l00250"></a>00250     
<a name="l00251"></a>00251   <span class="keyword">protected</span>:
<a name="l00259"></a>00259     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classAsync_1_1AudioFifo.html#ac7128e91c69306da64979268b61adbba" title="The registered sink has flushed all samples.">allSamplesFlushed</a>(<span class="keywordtype">void</span>);
<a name="l00260"></a>00260     
<a name="l00261"></a>00261     
<a name="l00262"></a>00262   <span class="keyword">private</span>:    
<a name="l00263"></a>00263     <span class="keywordtype">float</span>       *fifo;
<a name="l00264"></a>00264     <span class="keywordtype">unsigned</span>    fifo_size;
<a name="l00265"></a>00265     <span class="keywordtype">unsigned</span>    head, tail;
<a name="l00266"></a>00266     <span class="keywordtype">bool</span>        do_overwrite;
<a name="l00267"></a>00267     <span class="keywordtype">bool</span>        output_stopped;
<a name="l00268"></a>00268     <span class="keywordtype">unsigned</span>    prebuf_samples;
<a name="l00269"></a>00269     <span class="keywordtype">bool</span>        prebuf;
<a name="l00270"></a>00270     <span class="keywordtype">bool</span>        is_flushing;
<a name="l00271"></a>00271     <span class="keywordtype">bool</span>        is_full;
<a name="l00272"></a>00272     <span class="keywordtype">bool</span>        buffering_enabled;
<a name="l00273"></a>00273     <span class="keywordtype">bool</span>        disable_buffering_when_flushed;
<a name="l00274"></a>00274     <span class="keywordtype">bool</span>        is_idle;
<a name="l00275"></a>00275     <span class="keywordtype">bool</span>        input_stopped;
<a name="l00276"></a>00276     
<a name="l00277"></a>00277     <span class="keywordtype">void</span> writeSamplesFromFifo(<span class="keywordtype">void</span>);
<a name="l00278"></a>00278 
<a name="l00279"></a>00279 };  <span class="comment">/* class AudioFifo */</span>
<a name="l00280"></a>00280 
<a name="l00281"></a>00281 
<a name="l00282"></a>00282 } <span class="comment">/* namespace */</span>
<a name="l00283"></a>00283 
<a name="l00284"></a>00284 <span class="preprocessor">#endif </span><span class="comment">/* ASYNC_AUDIO_FIFO_INCLUDED */</span>
<a name="l00285"></a>00285 
<a name="l00286"></a>00286 
<a name="l00287"></a>00287 <span class="comment">/*</span>
<a name="l00288"></a>00288 <span class="comment"> * This file has not been truncated</span>
<a name="l00289"></a>00289 <span class="comment"> */</span>
<a name="l00290"></a>00290 
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by&nbsp;
<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>