mirror of
https://github.com/thestk/stk
synced 2026-01-19 15:41:52 +00:00
Release 4.4.0 tarball
This commit is contained in:
Gary Scavone
committed by
Stephen Sinclair
Stephen Sinclair
parent
3706458166
commit
d2ed001eb5
@@ -8,54 +8,82 @@
|
||||
<img src="princeton.gif"> <img src="ccrma.gif"> <img src="mcgill.gif"><P>
|
||||
<a class="qindex" href="index.html">Home</a> <a class="qindex" href="information.html">Information</a> <a class="qindex" href="classes.html">Classes</a> <a class="qindex" href="download.html">Download</a> <a class="qindex" href="usage.html">Usage</a> <a class="qindex" href="maillist.html">Mail List</a> <a class="qindex" href="system.html">Requirements</a> <a class="qindex" href="links.html">Links</a> <a class="qindex" href="faq.html">FAQ</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
||||
<HR>
|
||||
<!-- Generated by Doxygen 1.4.4 -->
|
||||
<div class="nav">
|
||||
<a class="el" href="dir_000000.html">include</a></div>
|
||||
<h1>RtWvIn.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/***************************************************/</span>
|
||||
<a name="l00019"></a>00019 <span class="comment">/***************************************************/</span>
|
||||
<a name="l00020"></a>00020
|
||||
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef STK_RTWVIN_H</span>
|
||||
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define STK_RTWVIN_H</span>
|
||||
<a name="l00023"></a>00023 <span class="preprocessor"></span>
|
||||
<a name="l00024"></a>00024 <span class="preprocessor">#include "WvIn.h"</span>
|
||||
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="RtAudio_8h.html">RtAudio.h</a>"</span>
|
||||
<a name="l00026"></a>00026
|
||||
<a name="l00027"></a><a class="code" href="classRtWvIn.html">00027</a> <span class="keyword">class </span><a class="code" href="classRtWvIn.html">RtWvIn</a> : <span class="keyword">public</span> <a class="code" href="classWvIn.html">WvIn</a>
|
||||
<a name="l00028"></a>00028 {
|
||||
<a name="l00029"></a>00029 <span class="keyword">public</span>:
|
||||
<a name="l00031"></a>00031
|
||||
<a name="l00042"></a>00042 <a class="code" href="classRtWvIn.html#a0">RtWvIn</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = 1, StkFloat <a class="code" href="classStk.html#e0">sampleRate</a> = <a class="code" href="classStk.html#e0">Stk::sampleRate</a>(), <span class="keywordtype">int</span> device = 0, <span class="keywordtype">int</span> bufferFrames = RT_BUFFER_SIZE, <span class="keywordtype">int</span> nBuffers = 20 );
|
||||
<a name="l00043"></a>00043
|
||||
<a name="l00045"></a>00045 <a class="code" href="classRtWvIn.html#a1">~RtWvIn</a>();
|
||||
<a name="l00046"></a>00046
|
||||
<a name="l00048"></a>00048
|
||||
<a name="l00052"></a>00052 <span class="keywordtype">void</span> <a class="code" href="classRtWvIn.html#a2">start</a>( <span class="keywordtype">void</span> );
|
||||
<a name="l00053"></a>00053
|
||||
<a name="l00055"></a>00055
|
||||
<a name="l00059"></a>00059 <span class="keywordtype">void</span> <a class="code" href="classRtWvIn.html#a3">stop</a>( <span class="keywordtype">void</span> );
|
||||
<a name="l00060"></a>00060
|
||||
<a name="l00061"></a>00061 <span class="comment">// This function is not intended for general use but had to be made</span>
|
||||
<a name="l00062"></a>00062 <span class="comment">// public for access from the audio callback function.</span>
|
||||
<a name="l00063"></a>00063 <span class="keywordtype">void</span> fillBuffer( <span class="keywordtype">void</span> *buffer, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nFrames );
|
||||
<a name="l00064"></a>00064
|
||||
<a name="l00065"></a>00065 <span class="keyword">protected</span>:
|
||||
<a name="l00066"></a>00066
|
||||
<a name="l00067"></a>00067 <span class="keywordtype">void</span> computeFrame( <span class="keywordtype">void</span> );
|
||||
<a name="l00068"></a>00068
|
||||
<a name="l00069"></a>00069 <a class="code" href="classRtAudio.html">RtAudio</a> adc_;
|
||||
<a name="l00070"></a>00070 <span class="keywordtype">bool</span> stopped_;
|
||||
<a name="l00071"></a>00071 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> readIndex_;
|
||||
<a name="l00072"></a>00072 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> writeIndex_;
|
||||
<a name="l00073"></a>00073 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> framesFilled_;
|
||||
<a name="l00074"></a>00074
|
||||
<a name="l00075"></a>00075 };
|
||||
<a name="l00076"></a>00076
|
||||
<a name="l00077"></a>00077 <span class="preprocessor">#endif</span>
|
||||
</pre></div><HR>
|
||||
<!-- Generated by Doxygen 1.5.8 -->
|
||||
<div class="navpath"><a class="el" href="dir_d499f4756a454d8a02faa5ebe57d576f.html">include</a>
|
||||
</div>
|
||||
<div class="contents">
|
||||
<h1>RtWvIn.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef STK_RTWVIN_H</span>
|
||||
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define STK_RTWVIN_H</span>
|
||||
<a name="l00003"></a>00003 <span class="preprocessor"></span>
|
||||
<a name="l00004"></a>00004 <span class="preprocessor">#include "WvIn.h"</span>
|
||||
<a name="l00005"></a>00005 <span class="preprocessor">#include "<a class="code" href="RtAudio_8h.html">RtAudio.h</a>"</span>
|
||||
<a name="l00006"></a>00006 <span class="preprocessor">#include "Mutex.h"</span>
|
||||
<a name="l00007"></a>00007
|
||||
<a name="l00008"></a>00008 <span class="keyword">namespace </span>stk {
|
||||
<a name="l00009"></a>00009
|
||||
<a name="l00010"></a>00010 <span class="comment">/***************************************************/</span>
|
||||
<a name="l00029"></a>00029 <span class="comment">/***************************************************/</span>
|
||||
<a name="l00030"></a>00030
|
||||
<a name="l00031"></a><a class="code" href="classstk_1_1RtWvIn.html">00031</a> <span class="keyword">class </span><a class="code" href="classstk_1_1RtWvIn.html" title="STK realtime audio (blocking) input class.">RtWvIn</a> : <span class="keyword">public</span> <a class="code" href="classstk_1_1WvIn.html" title="STK audio input abstract base class.">WvIn</a>
|
||||
<a name="l00032"></a>00032 {
|
||||
<a name="l00033"></a>00033 <span class="keyword">public</span>:
|
||||
<a name="l00035"></a>00035
|
||||
<a name="l00042"></a>00042 <a class="code" href="classstk_1_1RtWvIn.html#b84c98c568346d1ad86251961f7d1fba" title="Default constructor.">RtWvIn</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = 1, StkFloat <a class="code" href="classstk_1_1Stk.html#5fbe37000a611ce56075ee7d8936472d" title="Static method that returns the current STK sample rate.">sampleRate</a> = <a class="code" href="classstk_1_1Stk.html#5fbe37000a611ce56075ee7d8936472d" title="Static method that returns the current STK sample rate.">Stk::sampleRate</a>(),
|
||||
<a name="l00043"></a>00043 <span class="keywordtype">int</span> device = 0, <span class="keywordtype">int</span> bufferFrames = RT_BUFFER_SIZE, <span class="keywordtype">int</span> nBuffers = 20 );
|
||||
<a name="l00044"></a>00044
|
||||
<a name="l00046"></a>00046 <a class="code" href="classstk_1_1RtWvIn.html#efae2caa7f77522e8baa4908e3157f4d" title="Class destructor.">~RtWvIn</a>();
|
||||
<a name="l00047"></a>00047
|
||||
<a name="l00049"></a>00049
|
||||
<a name="l00053"></a>00053 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1RtWvIn.html#0ae4012cb269fb70536611b9116142fa" title="Start the audio input stream.">start</a>( <span class="keywordtype">void</span> );
|
||||
<a name="l00054"></a>00054
|
||||
<a name="l00056"></a>00056
|
||||
<a name="l00060"></a>00060 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1RtWvIn.html#39d0d9702569ee3afa769309e8b2e152" title="Stop the audio input stream.">stop</a>( <span class="keywordtype">void</span> );
|
||||
<a name="l00061"></a>00061
|
||||
<a name="l00063"></a>00063
|
||||
<a name="l00072"></a>00072 StkFloat <a class="code" href="classstk_1_1RtWvIn.html#3a4f4035fc01fee4c2423791f9e9317e" title="Return the specified channel value of the last computed frame.">lastOut</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 );
|
||||
<a name="l00073"></a>00073
|
||||
<a name="l00075"></a>00075
|
||||
<a name="l00084"></a>00084 StkFloat <a class="code" href="classstk_1_1RtWvIn.html#d2ace75cfe44dd82dd706d2c8dac7901" title="Compute a sample frame and return the specified channel value.">tick</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 );
|
||||
<a name="l00085"></a>00085
|
||||
<a name="l00087"></a>00087
|
||||
<a name="l00094"></a>00094 <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& <a class="code" href="classstk_1_1RtWvIn.html#d2ace75cfe44dd82dd706d2c8dac7901" title="Compute a sample frame and return the specified channel value.">tick</a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& frames );
|
||||
<a name="l00095"></a>00095
|
||||
<a name="l00096"></a>00096 <span class="comment">// This function is not intended for general use but must be</span>
|
||||
<a name="l00097"></a>00097 <span class="comment">// public for access from the audio callback function.</span>
|
||||
<a name="l00098"></a>00098 <span class="keywordtype">void</span> fillBuffer( <span class="keywordtype">void</span> *buffer, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nFrames );
|
||||
<a name="l00099"></a>00099
|
||||
<a name="l00100"></a>00100 <span class="keyword">protected</span>:
|
||||
<a name="l00101"></a>00101
|
||||
<a name="l00102"></a>00102 <a class="code" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> adc_;
|
||||
<a name="l00103"></a>00103 <a class="code" href="classstk_1_1Mutex.html" title="STK mutex class.">Mutex</a> mutex_;
|
||||
<a name="l00104"></a>00104 <span class="keywordtype">bool</span> stopped_;
|
||||
<a name="l00105"></a>00105 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> readIndex_;
|
||||
<a name="l00106"></a>00106 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> writeIndex_;
|
||||
<a name="l00107"></a>00107 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> framesFilled_;
|
||||
<a name="l00108"></a>00108
|
||||
<a name="l00109"></a>00109 };
|
||||
<a name="l00110"></a>00110
|
||||
<a name="l00111"></a><a class="code" href="classstk_1_1RtWvIn.html#3a4f4035fc01fee4c2423791f9e9317e">00111</a> <span class="keyword">inline</span> StkFloat <a class="code" href="classstk_1_1RtWvIn.html#3a4f4035fc01fee4c2423791f9e9317e" title="Return the specified channel value of the last computed frame.">RtWvIn :: lastOut</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel )
|
||||
<a name="l00112"></a>00112 {
|
||||
<a name="l00113"></a>00113 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
|
||||
<a name="l00114"></a>00114 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel >= data_.<a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() ) {
|
||||
<a name="l00115"></a>00115 errorString_ << <span class="stringliteral">"RtWvIn::lastOut(): channel argument and audio stream are incompatible!"</span>;
|
||||
<a name="l00116"></a>00116 <a class="code" href="classstk_1_1Stk.html#48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">handleError</a>( StkError::FUNCTION_ARGUMENT );
|
||||
<a name="l00117"></a>00117 }
|
||||
<a name="l00118"></a>00118 <span class="preprocessor">#endif</span>
|
||||
<a name="l00119"></a>00119 <span class="preprocessor"></span>
|
||||
<a name="l00120"></a>00120 <span class="keywordflow">return</span> lastFrame_[channel];
|
||||
<a name="l00121"></a>00121 }
|
||||
<a name="l00122"></a>00122
|
||||
<a name="l00123"></a>00123 } <span class="comment">// stk namespace</span>
|
||||
<a name="l00124"></a>00124
|
||||
<a name="l00125"></a>00125 <span class="preprocessor">#endif</span>
|
||||
</pre></div></div>
|
||||
<HR>
|
||||
|
||||
<table>
|
||||
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
|
||||
<tr><td>©1995-2007 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
<tr><td>©1995-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
</table>
|
||||
|
||||
</BODY>
|
||||
|
||||
Reference in New Issue
Block a user