e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-11 20:11:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
d2ed001eb57fbb468bd1a6188a725ec4e001b5a7
stk/doc/html/Stk_8h-source.html
Gary Scavone d2ed001eb5 Release 4.4.0 tarball
2013-09-29 23:44:33 +02:00

366 lines
42 KiB
HTML
Raw Blame History

<HTML>
<HEAD>
<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="faq.html">FAQ</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navpath"><a class="el" href="dir_d499f4756a454d8a02faa5ebe57d576f.html">include</a>
</div>
<div class="contents">
<h1>Stk.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef STK_STK_H</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define STK_STK_H</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00005"></a>00005 <span class="preprocessor">#include &lt;iostream&gt;</span>
<a name="l00006"></a>00006 <span class="preprocessor">#include &lt;sstream&gt;</span>
<a name="l00007"></a>00007 <span class="preprocessor">#include &lt;vector&gt;</span>
<a name="l00008"></a>00008 <span class="preprocessor">#include &lt;stdlib.h&gt;</span>
<a name="l00009"></a>00009
<a name="l00016"></a>00016 <span class="keyword">namespace </span>stk {
<a name="l00017"></a>00017
<a name="l00018"></a>00018 <span class="comment">/***************************************************/</span>
<a name="l00068"></a>00068 <span class="comment">/***************************************************/</span>
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="comment">//#define _STK_DEBUG_</span>
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="comment">// Most data in STK is passed and calculated with the</span>
<a name="l00073"></a>00073 <span class="comment">// following user-definable floating-point type. You</span>
<a name="l00074"></a>00074 <span class="comment">// can change this to "float" if you prefer or perhaps</span>
<a name="l00075"></a>00075 <span class="comment">// a "long double" in the future.</span>
<a name="l00076"></a>00076 <span class="keyword">typedef</span> <span class="keywordtype">double</span> StkFloat;
<a name="l00077"></a>00077
<a name="l00079"></a>00079
<a name="l00084"></a><a class="code" href="classstk_1_1StkError.html">00084</a> <span class="keyword">class </span><a class="code" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a>
<a name="l00085"></a>00085 {
<a name="l00086"></a>00086 <span class="keyword">public</span>:
<a name="l00087"></a>00087 <span class="keyword">enum</span> Type {
<a name="l00088"></a>00088 STATUS,
<a name="l00089"></a>00089 WARNING,
<a name="l00090"></a>00090 DEBUG_WARNING,
<a name="l00091"></a>00091 MEMORY_ALLOCATION,
<a name="l00092"></a>00092 MEMORY_ACCESS,
<a name="l00093"></a>00093 FUNCTION_ARGUMENT,
<a name="l00094"></a>00094 FILE_NOT_FOUND,
<a name="l00095"></a>00095 FILE_UNKNOWN_FORMAT,
<a name="l00096"></a>00096 FILE_ERROR,
<a name="l00097"></a>00097 PROCESS_THREAD,
<a name="l00098"></a>00098 PROCESS_SOCKET,
<a name="l00099"></a>00099 PROCESS_SOCKET_IPADDR,
<a name="l00100"></a>00100 AUDIO_SYSTEM,
<a name="l00101"></a>00101 MIDI_SYSTEM,
<a name="l00102"></a>00102 UNSPECIFIED
<a name="l00103"></a>00103 };
<a name="l00104"></a>00104
<a name="l00105"></a>00105 <span class="keyword">protected</span>:
<a name="l00106"></a>00106 std::string message_;
<a name="l00107"></a>00107 Type type_;
<a name="l00108"></a>00108
<a name="l00109"></a>00109 <span class="keyword">public</span>:
<a name="l00111"></a><a class="code" href="classstk_1_1StkError.html#b6cbc80df11b385b20d244327fb74abb">00111</a> <a class="code" href="classstk_1_1StkError.html#b6cbc80df11b385b20d244327fb74abb" title="The constructor.">StkError</a>(<span class="keyword">const</span> std::string&amp; message, Type type = StkError::UNSPECIFIED)
<a name="l00112"></a>00112 : message_(message), type_(type) {}
<a name="l00113"></a>00113
<a name="l00115"></a><a class="code" href="classstk_1_1StkError.html#b0639b3a9354a0f84a9338d1c9b87464">00115</a> <span class="keyword">virtual</span> <a class="code" href="classstk_1_1StkError.html#b0639b3a9354a0f84a9338d1c9b87464" title="The destructor.">~StkError</a>(<span class="keywordtype">void</span>) {};
<a name="l00116"></a>00116
<a name="l00118"></a><a class="code" href="classstk_1_1StkError.html#337437a729f03d48fc56277037ac6fdc">00118</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1StkError.html#337437a729f03d48fc56277037ac6fdc" title="Prints thrown error message to stderr.">printMessage</a>(<span class="keywordtype">void</span>) { std::cerr &lt;&lt; <span class="charliteral">'\n'</span> &lt;&lt; message_ &lt;&lt; <span class="stringliteral">"\n\n"</span>; }
<a name="l00119"></a>00119
<a name="l00121"></a><a class="code" href="classstk_1_1StkError.html#ae641cf5ed2b756adbf02fc668fac53e">00121</a> <span class="keyword">virtual</span> <span class="keyword">const</span> Type&amp; <a class="code" href="classstk_1_1StkError.html#ae641cf5ed2b756adbf02fc668fac53e" title="Returns the thrown error message type.">getType</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> type_; }
<a name="l00122"></a>00122
<a name="l00124"></a><a class="code" href="classstk_1_1StkError.html#c691cbffe442d9e0760978146df5d9fb">00124</a> <span class="keyword">virtual</span> <span class="keyword">const</span> std::string&amp; <a class="code" href="classstk_1_1StkError.html#c691cbffe442d9e0760978146df5d9fb" title="Returns the thrown error message string.">getMessage</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> message_; }
<a name="l00125"></a>00125
<a name="l00127"></a><a class="code" href="classstk_1_1StkError.html#e802643199c86a797f7adebe109d84bf">00127</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classstk_1_1StkError.html#e802643199c86a797f7adebe109d84bf" title="Returns the thrown error message as a C string.">getMessageCString</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> message_.c_str(); }
<a name="l00128"></a>00128 };
<a name="l00129"></a>00129
<a name="l00130"></a>00130
<a name="l00131"></a><a class="code" href="classstk_1_1Stk.html">00131</a> <span class="keyword">class </span><a class="code" href="classstk_1_1Stk.html" title="STK base class.">Stk</a>
<a name="l00132"></a>00132 {
<a name="l00133"></a>00133 <span class="keyword">public</span>:
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> StkFormat;
<a name="l00136"></a><a class="code" href="classstk_1_1Stk.html#dec863631653693af8f1ed5c0cfc5c4c">00136</a> <span class="keyword">static</span> <span class="keyword">const</span> StkFormat <a class="code" href="classstk_1_1Stk.html#dec863631653693af8f1ed5c0cfc5c4c">STK_SINT8</a>;
<a name="l00137"></a><a class="code" href="classstk_1_1Stk.html#5a807971b7fc3c8985d97823be079a7b">00137</a> <span class="keyword">static</span> <span class="keyword">const</span> StkFormat <a class="code" href="classstk_1_1Stk.html#5a807971b7fc3c8985d97823be079a7b">STK_SINT16</a>;
<a name="l00138"></a><a class="code" href="classstk_1_1Stk.html#fbe8049756ea88bdd8cebad65305dd52">00138</a> <span class="keyword">static</span> <span class="keyword">const</span> StkFormat <a class="code" href="classstk_1_1Stk.html#fbe8049756ea88bdd8cebad65305dd52">STK_SINT24</a>;
<a name="l00139"></a><a class="code" href="classstk_1_1Stk.html#605c96894e1b0f1f08a80214a08012ad">00139</a> <span class="keyword">static</span> <span class="keyword">const</span> StkFormat <a class="code" href="classstk_1_1Stk.html#605c96894e1b0f1f08a80214a08012ad">STK_SINT32</a>;
<a name="l00140"></a><a class="code" href="classstk_1_1Stk.html#079e62be7093d593498e9d2ba4ac20fa">00140</a> <span class="keyword">static</span> <span class="keyword">const</span> StkFormat <a class="code" href="classstk_1_1Stk.html#079e62be7093d593498e9d2ba4ac20fa">STK_FLOAT32</a>;
<a name="l00141"></a><a class="code" href="classstk_1_1Stk.html#57b00150ae559b6f099be117b2e53af4">00141</a> <span class="keyword">static</span> <span class="keyword">const</span> StkFormat <a class="code" href="classstk_1_1Stk.html#57b00150ae559b6f099be117b2e53af4">STK_FLOAT64</a>;
<a name="l00143"></a>00143
<a name="l00144"></a><a class="code" href="classstk_1_1Stk.html#5fbe37000a611ce56075ee7d8936472d">00144</a> <span class="keyword">static</span> StkFloat <a class="code" href="classstk_1_1Stk.html#5fbe37000a611ce56075ee7d8936472d" title="Static method that returns the current STK sample rate.">sampleRate</a>( <span class="keywordtype">void</span> ) { <span class="keywordflow">return</span> srate_; }
<a name="l00145"></a>00145
<a name="l00147"></a>00147
<a name="l00164"></a>00164 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Stk.html#46e2f55e5a92c717c3893fe23dde88a5" title="Static method that sets the STK sample rate.">setSampleRate</a>( StkFloat rate );
<a name="l00165"></a>00165
<a name="l00167"></a>00167
<a name="l00172"></a><a class="code" href="classstk_1_1Stk.html#b8a52e4897bea5c0f5e66adf37a8e39b">00172</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Stk.html#b8a52e4897bea5c0f5e66adf37a8e39b" title="A function to enable/disable the automatic updating of class data when the STK sample...">ignoreSampleRateChange</a>( <span class="keywordtype">bool</span> ignore = <span class="keyword">true</span> ) { ignoreSampleRateChange_ = ignore; };
<a name="l00173"></a>00173
<a name="l00175"></a><a class="code" href="classstk_1_1Stk.html#5f3fd05b709788213549fe2cbaf4a52a">00175</a> <span class="keyword">static</span> std::string <a class="code" href="classstk_1_1Stk.html#5f3fd05b709788213549fe2cbaf4a52a" title="Static method that returns the current rawwave path.">rawwavePath</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> rawwavepath_; }
<a name="l00176"></a>00176
<a name="l00178"></a>00178 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Stk.html#4f641ad194f9d8ce1f9d1ae56af5686b" title="Static method that sets the STK rawwave path.">setRawwavePath</a>( std::string path );
<a name="l00179"></a>00179
<a name="l00181"></a>00181 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Stk.html#b2dc4c9e67317eb0753868a89c8095f6" title="Static method that byte-swaps a 16-bit data type.">swap16</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *ptr );
<a name="l00182"></a>00182
<a name="l00184"></a>00184 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Stk.html#820631139e6f7e23d328d387c0f530fd" title="Static method that byte-swaps a 32-bit data type.">swap32</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *ptr );
<a name="l00185"></a>00185
<a name="l00187"></a>00187 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Stk.html#5f744eadf29ecbfbeddfdf7ceb5853c9" title="Static method that byte-swaps a 64-bit data type.">swap64</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *ptr );
<a name="l00188"></a>00188
<a name="l00190"></a>00190 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Stk.html#d75619ab92a0c19b5a52cb68884511e3" title="Static cross-platform method to sleep for a number of milliseconds.">sleep</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> milliseconds );
<a name="l00191"></a>00191
<a name="l00193"></a>00193 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Stk.html#48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">handleError</a>( <span class="keyword">const</span> <span class="keywordtype">char</span> *message, StkError::Type type );
<a name="l00194"></a>00194
<a name="l00196"></a>00196 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Stk.html#48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">handleError</a>( std::string message, StkError::Type type );
<a name="l00197"></a>00197
<a name="l00199"></a><a class="code" href="classstk_1_1Stk.html#2d8b38b9f808fb7c5e65c228b4b7dbbb">00199</a> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Stk.html#2d8b38b9f808fb7c5e65c228b4b7dbbb" title="Toggle display of WARNING and STATUS messages.">showWarnings</a>( <span class="keywordtype">bool</span> status ) { showWarnings_ = status; }
<a name="l00200"></a>00200
<a name="l00202"></a><a class="code" href="classstk_1_1Stk.html#ffb98f8f1f65ddc9e4af8440056b1504">00202</a> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Stk.html#ffb98f8f1f65ddc9e4af8440056b1504" title="Toggle display of error messages before throwing exceptions.">printErrors</a>( <span class="keywordtype">bool</span> status ) { printErrors_ = status; }
<a name="l00203"></a>00203
<a name="l00204"></a>00204 <span class="keyword">private</span>:
<a name="l00205"></a>00205 <span class="keyword">static</span> StkFloat srate_;
<a name="l00206"></a>00206 <span class="keyword">static</span> std::string rawwavepath_;
<a name="l00207"></a>00207 <span class="keyword">static</span> <span class="keywordtype">bool</span> showWarnings_;
<a name="l00208"></a>00208 <span class="keyword">static</span> <span class="keywordtype">bool</span> printErrors_;
<a name="l00209"></a>00209 <span class="keyword">static</span> std::vector&lt;Stk *&gt; alertList_;
<a name="l00210"></a>00210
<a name="l00211"></a>00211 <span class="keyword">protected</span>:
<a name="l00212"></a>00212
<a name="l00213"></a>00213 std::ostringstream errorString_;
<a name="l00214"></a>00214 <span class="keywordtype">bool</span> ignoreSampleRateChange_;
<a name="l00215"></a>00215
<a name="l00217"></a>00217 <a class="code" href="classstk_1_1Stk.html#9bff83b5a318ff171f94a218ad52226b" title="Default constructor.">Stk</a>( <span class="keywordtype">void</span> );
<a name="l00218"></a>00218
<a name="l00220"></a>00220 <span class="keyword">virtual</span> <a class="code" href="classstk_1_1Stk.html#d0d5c6ab745ad2841a59032addae3905" title="Class destructor.">~Stk</a>( <span class="keywordtype">void</span> );
<a name="l00221"></a>00221
<a name="l00223"></a>00223 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Stk.html#740e872daa4b2ad1c918163e7c5ab56b" title="This function should be implemented in subclasses that depend on the sample rate...">sampleRateChanged</a>( StkFloat newRate, StkFloat oldRate );
<a name="l00224"></a>00224
<a name="l00226"></a>00226 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Stk.html#5ab0e88856708f65887295ad4ad90340" title="Add class pointer to list for sample rate change notification.">addSampleRateAlert</a>( <a class="code" href="classstk_1_1Stk.html" title="STK base class.">Stk</a> *ptr );
<a name="l00227"></a>00227
<a name="l00229"></a>00229 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Stk.html#349865986f712f58087cb72603a6ced8" title="Remove class pointer from list for sample rate change notification.">removeSampleRateAlert</a>( <a class="code" href="classstk_1_1Stk.html" title="STK base class.">Stk</a> *ptr );
<a name="l00230"></a>00230
<a name="l00232"></a>00232 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Stk.html#48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">handleError</a>( StkError::Type type );
<a name="l00233"></a>00233 };
<a name="l00234"></a>00234
<a name="l00235"></a>00235
<a name="l00236"></a>00236 <span class="comment">/***************************************************/</span>
<a name="l00259"></a>00259 <span class="comment">/***************************************************/</span>
<a name="l00260"></a>00260
<a name="l00261"></a><a class="code" href="classstk_1_1StkFrames.html">00261</a> <span class="keyword">class </span><a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>
<a name="l00262"></a>00262 {
<a name="l00263"></a>00263 <span class="keyword">public</span>:
<a name="l00264"></a>00264
<a name="l00266"></a>00266 <a class="code" href="classstk_1_1StkFrames.html#a9ad14889de633ba4269f1330be8bedf" title="The default constructor initializes the frame data structure to size zero.">StkFrames</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nFrames = 0, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = 0 );
<a name="l00267"></a>00267
<a name="l00269"></a>00269 <a class="code" href="classstk_1_1StkFrames.html#a9ad14889de633ba4269f1330be8bedf" title="The default constructor initializes the frame data structure to size zero.">StkFrames</a>( <span class="keyword">const</span> StkFloat&amp; value, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nFrames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels );
<a name="l00270"></a>00270
<a name="l00272"></a>00272 <a class="code" href="classstk_1_1StkFrames.html#3fa9a0a175de2b18e75d9b68a6387895" title="The destructor.">~StkFrames</a>();
<a name="l00273"></a>00273
<a name="l00274"></a>00274 <span class="comment">// A copy constructor.</span>
<a name="l00275"></a>00275 <a class="code" href="classstk_1_1StkFrames.html#a9ad14889de633ba4269f1330be8bedf" title="The default constructor initializes the frame data structure to size zero.">StkFrames</a>( <span class="keyword">const</span> <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>&amp; f );
<a name="l00276"></a>00276
<a name="l00277"></a>00277 <span class="comment">// Assignment operator that returns a reference to self.</span>
<a name="l00278"></a>00278 <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>&amp; operator= ( <span class="keyword">const</span> <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>&amp; f );
<a name="l00279"></a>00279
<a name="l00281"></a>00281
<a name="l00287"></a>00287 StkFloat&amp; <a class="code" href="classstk_1_1StkFrames.html#8ed9cc0a4309f786cfe36da9e901fde9" title="Subscript operator that returns a reference to element n of self.">operator[] </a>( <span class="keywordtype">size_t</span> n );
<a name="l00288"></a>00288
<a name="l00290"></a>00290
<a name="l00294"></a>00294 StkFloat <a class="code" href="classstk_1_1StkFrames.html#8ed9cc0a4309f786cfe36da9e901fde9" title="Subscript operator that returns a reference to element n of self.">operator[] </a>( <span class="keywordtype">size_t</span> n ) <span class="keyword">const</span>;
<a name="l00295"></a>00295
<a name="l00297"></a>00297
<a name="l00302"></a>00302 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1StkFrames.html#0f6a81d36a8905d782b283b9a05893e6" title="Assignment by sum operator into self.">operator+= </a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>&amp; f );
<a name="l00303"></a>00303
<a name="l00305"></a>00305
<a name="l00310"></a>00310 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1StkFrames.html#049cbfd10908f754a7c48c1dd0da21e0" title="Assignment by product operator into self.">operator*= </a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>&amp; f );
<a name="l00311"></a>00311
<a name="l00313"></a>00313
<a name="l00320"></a>00320 StkFloat&amp; <a class="code" href="classstk_1_1StkFrames.html#813632277bf0c432bcf81136ccdbbec1" title="Channel / frame subscript operator that returns a reference.">operator() </a>( <span class="keywordtype">size_t</span> frame, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel );
<a name="l00321"></a>00321
<a name="l00323"></a>00323
<a name="l00328"></a>00328 StkFloat <a class="code" href="classstk_1_1StkFrames.html#813632277bf0c432bcf81136ccdbbec1" title="Channel / frame subscript operator that returns a reference.">operator() </a>( <span class="keywordtype">size_t</span> frame, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel ) <span class="keyword">const</span>;
<a name="l00329"></a>00329
<a name="l00331"></a>00331
<a name="l00337"></a>00337 StkFloat <a class="code" href="classstk_1_1StkFrames.html#4f9402d9be28da418f630b4261b9b386" title="Return an interpolated value at the fractional frame index and channel.">interpolate</a>( StkFloat frame, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 ) <span class="keyword">const</span>;
<a name="l00338"></a>00338
<a name="l00340"></a><a class="code" href="classstk_1_1StkFrames.html#5c41aae98f77487c004085912d1f8f79">00340</a> <span class="keywordtype">size_t</span> <a class="code" href="classstk_1_1StkFrames.html#5c41aae98f77487c004085912d1f8f79" title="Returns the total number of audio samples represented by the object.">size</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> size_; };
<a name="l00341"></a>00341
<a name="l00343"></a>00343 <span class="keywordtype">bool</span> <a class="code" href="classstk_1_1StkFrames.html#c6652950830fe907f9158ee891560253" title="Returns true if the object size is zero and false otherwise.">empty</a>() <span class="keyword">const</span>;
<a name="l00344"></a>00344
<a name="l00346"></a>00346
<a name="l00353"></a>00353 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1StkFrames.html#386e1b86cf48f7a8117313f9e41fc0fe" title="Resize self to represent the specified number of channels and frames.">resize</a>( <span class="keywordtype">size_t</span> nFrames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = 1 );
<a name="l00354"></a>00354
<a name="l00356"></a>00356
<a name="l00363"></a>00363 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1StkFrames.html#386e1b86cf48f7a8117313f9e41fc0fe" title="Resize self to represent the specified number of channels and frames.">resize</a>( <span class="keywordtype">size_t</span> nFrames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels, StkFloat value );
<a name="l00364"></a>00364
<a name="l00366"></a><a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870">00366</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>( <span class="keywordtype">void</span> )<span class="keyword"> const </span>{ <span class="keywordflow">return</span> nChannels_; };
<a name="l00367"></a>00367
<a name="l00369"></a><a class="code" href="classstk_1_1StkFrames.html#05b1ab6fa750a8221a7d65c30e0cdab9">00369</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classstk_1_1StkFrames.html#05b1ab6fa750a8221a7d65c30e0cdab9" title="Return the number of sample frames represented by the data.">frames</a>( <span class="keywordtype">void</span> )<span class="keyword"> const </span>{ <span class="keywordflow">return</span> nFrames_; };
<a name="l00370"></a>00370
<a name="l00372"></a>00372
<a name="l00376"></a><a class="code" href="classstk_1_1StkFrames.html#d528b1c8ea2866570e7d9c2bac0e8b40">00376</a> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1StkFrames.html#d528b1c8ea2866570e7d9c2bac0e8b40" title="Set the sample rate associated with the StkFrames data.">setDataRate</a>( StkFloat rate ) { dataRate_ = rate; };
<a name="l00377"></a>00377
<a name="l00379"></a>00379
<a name="l00383"></a><a class="code" href="classstk_1_1StkFrames.html#4dbbcbdc8db39a803e0861976f7f3522">00383</a> StkFloat <a class="code" href="classstk_1_1StkFrames.html#4dbbcbdc8db39a803e0861976f7f3522" title="Return the sample rate associated with the StkFrames data.">dataRate</a>( <span class="keywordtype">void</span> )<span class="keyword"> const </span>{ <span class="keywordflow">return</span> dataRate_; };
<a name="l00384"></a>00384
<a name="l00385"></a>00385 <span class="keyword">private</span>:
<a name="l00386"></a>00386
<a name="l00387"></a>00387 StkFloat *data_;
<a name="l00388"></a>00388 StkFloat dataRate_;
<a name="l00389"></a>00389 <span class="keywordtype">size_t</span> nFrames_;
<a name="l00390"></a>00390 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels_;
<a name="l00391"></a>00391 <span class="keywordtype">size_t</span> size_;
<a name="l00392"></a>00392 <span class="keywordtype">size_t</span> bufferSize_;
<a name="l00393"></a>00393
<a name="l00394"></a>00394 };
<a name="l00395"></a>00395
<a name="l00396"></a><a class="code" href="classstk_1_1StkFrames.html#c6652950830fe907f9158ee891560253">00396</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classstk_1_1StkFrames.html#c6652950830fe907f9158ee891560253" title="Returns true if the object size is zero and false otherwise.">StkFrames :: empty</a>()<span class="keyword"> const</span>
<a name="l00397"></a>00397 <span class="keyword"></span>{
<a name="l00398"></a>00398 <span class="keywordflow">if</span> ( size_ &gt; 0 ) <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00399"></a>00399 <span class="keywordflow">else</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00400"></a>00400 }
<a name="l00401"></a>00401
<a name="l00402"></a><a class="code" href="classstk_1_1StkFrames.html#8ed9cc0a4309f786cfe36da9e901fde9">00402</a> <span class="keyword">inline</span> StkFloat&amp; <a class="code" href="classstk_1_1StkFrames.html#8ed9cc0a4309f786cfe36da9e901fde9" title="Subscript operator that returns a reference to element n of self.">StkFrames :: operator[] </a>( <span class="keywordtype">size_t</span> n )
<a name="l00403"></a>00403 {
<a name="l00404"></a>00404 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00405"></a>00405 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( n &gt;= size_ ) {
<a name="l00406"></a>00406 std::ostringstream error;
<a name="l00407"></a>00407 error &lt;&lt; <span class="stringliteral">"StkFrames::operator[]: invalid index ("</span> &lt;&lt; n &lt;&lt; <span class="stringliteral">") value!"</span>;
<a name="l00408"></a>00408 <a class="code" href="classstk_1_1Stk.html#48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">Stk::handleError</a>( error.str(), StkError::MEMORY_ACCESS );
<a name="l00409"></a>00409 }
<a name="l00410"></a>00410 <span class="preprocessor">#endif</span>
<a name="l00411"></a>00411 <span class="preprocessor"></span>
<a name="l00412"></a>00412 <span class="keywordflow">return</span> data_[n];
<a name="l00413"></a>00413 }
<a name="l00414"></a>00414
<a name="l00415"></a><a class="code" href="classstk_1_1StkFrames.html#2d1c8a2b32725ca72e0f3256f9cd8cb6">00415</a> <span class="keyword">inline</span> StkFloat <a class="code" href="classstk_1_1StkFrames.html#8ed9cc0a4309f786cfe36da9e901fde9" title="Subscript operator that returns a reference to element n of self.">StkFrames :: operator[] </a>( <span class="keywordtype">size_t</span> n )<span class="keyword"> const</span>
<a name="l00416"></a>00416 <span class="keyword"></span>{
<a name="l00417"></a>00417 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00418"></a>00418 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( n &gt;= size_ ) {
<a name="l00419"></a>00419 std::ostringstream error;
<a name="l00420"></a>00420 error &lt;&lt; <span class="stringliteral">"StkFrames::operator[]: invalid index ("</span> &lt;&lt; n &lt;&lt; <span class="stringliteral">") value!"</span>;
<a name="l00421"></a>00421 <a class="code" href="classstk_1_1Stk.html#48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">Stk::handleError</a>( error.str(), StkError::MEMORY_ACCESS );
<a name="l00422"></a>00422 }
<a name="l00423"></a>00423 <span class="preprocessor">#endif</span>
<a name="l00424"></a>00424 <span class="preprocessor"></span>
<a name="l00425"></a>00425 <span class="keywordflow">return</span> data_[n];
<a name="l00426"></a>00426 }
<a name="l00427"></a>00427
<a name="l00428"></a><a class="code" href="classstk_1_1StkFrames.html#813632277bf0c432bcf81136ccdbbec1">00428</a> <span class="keyword">inline</span> StkFloat&amp; <a class="code" href="classstk_1_1StkFrames.html#813632277bf0c432bcf81136ccdbbec1" title="Channel / frame subscript operator that returns a reference.">StkFrames :: operator() </a>( <span class="keywordtype">size_t</span> frame, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel )
<a name="l00429"></a>00429 {
<a name="l00430"></a>00430 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00431"></a>00431 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( frame &gt;= nFrames_ || channel &gt;= nChannels_ ) {
<a name="l00432"></a>00432 std::ostringstream error;
<a name="l00433"></a>00433 error &lt;&lt; <span class="stringliteral">"StkFrames::operator(): invalid frame ("</span> &lt;&lt; frame &lt;&lt; <span class="stringliteral">") or channel ("</span> &lt;&lt; channel &lt;&lt; <span class="stringliteral">") value!"</span>;
<a name="l00434"></a>00434 <a class="code" href="classstk_1_1Stk.html#48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">Stk::handleError</a>( error.str(), StkError::MEMORY_ACCESS );
<a name="l00435"></a>00435 }
<a name="l00436"></a>00436 <span class="preprocessor">#endif</span>
<a name="l00437"></a>00437 <span class="preprocessor"></span>
<a name="l00438"></a>00438 <span class="keywordflow">return</span> data_[ frame * nChannels_ + channel ];
<a name="l00439"></a>00439 }
<a name="l00440"></a>00440
<a name="l00441"></a><a class="code" href="classstk_1_1StkFrames.html#93e7e4c30affc29d0cdc98e7514188de">00441</a> <span class="keyword">inline</span> StkFloat <a class="code" href="classstk_1_1StkFrames.html#813632277bf0c432bcf81136ccdbbec1" title="Channel / frame subscript operator that returns a reference.">StkFrames :: operator() </a>( <span class="keywordtype">size_t</span> frame, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel )<span class="keyword"> const</span>
<a name="l00442"></a>00442 <span class="keyword"></span>{
<a name="l00443"></a>00443 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00444"></a>00444 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( frame &gt;= nFrames_ || channel &gt;= nChannels_ ) {
<a name="l00445"></a>00445 std::ostringstream error;
<a name="l00446"></a>00446 error &lt;&lt; <span class="stringliteral">"StkFrames::operator(): invalid frame ("</span> &lt;&lt; frame &lt;&lt; <span class="stringliteral">") or channel ("</span> &lt;&lt; channel &lt;&lt; <span class="stringliteral">") value!"</span>;
<a name="l00447"></a>00447 <a class="code" href="classstk_1_1Stk.html#48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">Stk::handleError</a>( error.str(), StkError::MEMORY_ACCESS );
<a name="l00448"></a>00448 }
<a name="l00449"></a>00449 <span class="preprocessor">#endif</span>
<a name="l00450"></a>00450 <span class="preprocessor"></span>
<a name="l00451"></a>00451 <span class="keywordflow">return</span> data_[ frame * nChannels_ + channel ];
<a name="l00452"></a>00452 }
<a name="l00453"></a>00453
<a name="l00454"></a><a class="code" href="classstk_1_1StkFrames.html#0f6a81d36a8905d782b283b9a05893e6">00454</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1StkFrames.html#0f6a81d36a8905d782b283b9a05893e6" title="Assignment by sum operator into self.">StkFrames :: operator+= </a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>&amp; f )
<a name="l00455"></a>00455 {
<a name="l00456"></a>00456 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00457"></a>00457 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( f.<a class="code" href="classstk_1_1StkFrames.html#05b1ab6fa750a8221a7d65c30e0cdab9" title="Return the number of sample frames represented by the data.">frames</a>() != nFrames_ || f.<a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() != nChannels_ ) {
<a name="l00458"></a>00458 std::ostringstream error;
<a name="l00459"></a>00459 error &lt;&lt; <span class="stringliteral">"StkFrames::operator+=: frames argument must be of equal dimensions!"</span>;
<a name="l00460"></a>00460 <a class="code" href="classstk_1_1Stk.html#48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">Stk::handleError</a>( error.str(), StkError::MEMORY_ACCESS );
<a name="l00461"></a>00461 }
<a name="l00462"></a>00462 <span class="preprocessor">#endif</span>
<a name="l00463"></a>00463 <span class="preprocessor"></span>
<a name="l00464"></a>00464 StkFloat *fptr = &amp;f[0];
<a name="l00465"></a>00465 StkFloat *dptr = data_;
<a name="l00466"></a>00466 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i&lt;size_; i++ )
<a name="l00467"></a>00467 *dptr++ += *fptr++;
<a name="l00468"></a>00468 }
<a name="l00469"></a>00469
<a name="l00470"></a><a class="code" href="classstk_1_1StkFrames.html#049cbfd10908f754a7c48c1dd0da21e0">00470</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classstk_1_1StkFrames.html#049cbfd10908f754a7c48c1dd0da21e0" title="Assignment by product operator into self.">StkFrames :: operator*= </a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>&amp; f )
<a name="l00471"></a>00471 {
<a name="l00472"></a>00472 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00473"></a>00473 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( f.<a class="code" href="classstk_1_1StkFrames.html#05b1ab6fa750a8221a7d65c30e0cdab9" title="Return the number of sample frames represented by the data.">frames</a>() != nFrames_ || f.<a class="code" href="classstk_1_1StkFrames.html#ec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() != nChannels_ ) {
<a name="l00474"></a>00474 std::ostringstream error;
<a name="l00475"></a>00475 error &lt;&lt; <span class="stringliteral">"StkFrames::operator*=: frames argument must be of equal dimensions!"</span>;
<a name="l00476"></a>00476 <a class="code" href="classstk_1_1Stk.html#48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">Stk::handleError</a>( error.str(), StkError::MEMORY_ACCESS );
<a name="l00477"></a>00477 }
<a name="l00478"></a>00478 <span class="preprocessor">#endif</span>
<a name="l00479"></a>00479 <span class="preprocessor"></span>
<a name="l00480"></a>00480 StkFloat *fptr = &amp;f[0];
<a name="l00481"></a>00481 StkFloat *dptr = data_;
<a name="l00482"></a>00482 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i&lt;size_; i++ )
<a name="l00483"></a>00483 *dptr++ *= *fptr++;
<a name="l00484"></a>00484 }
<a name="l00485"></a>00485
<a name="l00486"></a>00486 <span class="comment">// Here are a few other useful typedefs.</span>
<a name="l00487"></a>00487 <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> UINT16;
<a name="l00488"></a>00488 <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> UINT32;
<a name="l00489"></a>00489 <span class="keyword">typedef</span> <span class="keywordtype">signed</span> <span class="keywordtype">short</span> SINT16;
<a name="l00490"></a>00490 <span class="keyword">typedef</span> <span class="keywordtype">signed</span> <span class="keywordtype">int</span> SINT32;
<a name="l00491"></a>00491 <span class="keyword">typedef</span> <span class="keywordtype">float</span> FLOAT32;
<a name="l00492"></a>00492 <span class="keyword">typedef</span> <span class="keywordtype">double</span> FLOAT64;
<a name="l00493"></a>00493
<a name="l00494"></a>00494 <span class="comment">// The default sampling rate.</span>
<a name="l00495"></a>00495 <span class="keyword">const</span> StkFloat SRATE = 44100.0;
<a name="l00496"></a>00496
<a name="l00497"></a>00497 <span class="comment">// The default real-time audio input and output buffer size. If</span>
<a name="l00498"></a>00498 <span class="comment">// clicks are occuring in the input and/or output sound stream, a</span>
<a name="l00499"></a>00499 <span class="comment">// larger buffer size may help. Larger buffer sizes, however, produce</span>
<a name="l00500"></a>00500 <span class="comment">// more latency.</span>
<a name="l00501"></a>00501 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> RT_BUFFER_SIZE = 512;
<a name="l00502"></a>00502
<a name="l00503"></a>00503 <span class="comment">// The default rawwave path value is set with the preprocessor</span>
<a name="l00504"></a>00504 <span class="comment">// definition RAWWAVE_PATH. This can be specified as an argument to</span>
<a name="l00505"></a>00505 <span class="comment">// the configure script, in an integrated development environment, or</span>
<a name="l00506"></a>00506 <span class="comment">// below. The global STK rawwave path variable can be dynamically set</span>
<a name="l00507"></a>00507 <span class="comment">// with the Stk::setRawwavePath() function. This value is</span>
<a name="l00508"></a>00508 <span class="comment">// concatenated to the beginning of all references to rawwave files in</span>
<a name="l00509"></a>00509 <span class="comment">// the various STK core classes (ex. Clarinet.cpp). If you wish to</span>
<a name="l00510"></a>00510 <span class="comment">// move the rawwaves directory to a different location in your file</span>
<a name="l00511"></a>00511 <span class="comment">// system, you will need to set this path definition appropriately.</span>
<a name="l00512"></a>00512 <span class="preprocessor">#if !defined(RAWWAVE_PATH)</span>
<a name="l00513"></a>00513 <span class="preprocessor"></span><span class="preprocessor"> #define RAWWAVE_PATH "../../rawwaves/"</span>
<a name="l00514"></a>00514 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00515"></a>00515 <span class="preprocessor"></span>
<a name="l00516"></a>00516 <span class="keyword">const</span> StkFloat PI = 3.14159265358979;
<a name="l00517"></a>00517 <span class="keyword">const</span> StkFloat TWO_PI = 2 * PI;
<a name="l00518"></a>00518 <span class="keyword">const</span> StkFloat ONE_OVER_128 = 0.0078125;
<a name="l00519"></a>00519
<a name="l00520"></a>00520 <span class="preprocessor">#if defined(__WINDOWS_DS__) || defined(__WINDOWS_ASIO__) || defined(__WINDOWS_MM__)</span>
<a name="l00521"></a>00521 <span class="preprocessor"></span><span class="preprocessor"> #define __OS_WINDOWS__</span>
<a name="l00522"></a>00522 <span class="preprocessor"></span><span class="preprocessor"> #define __STK_REALTIME__</span>
<a name="l00523"></a>00523 <span class="preprocessor"></span><span class="preprocessor">#elif defined(__LINUX_OSS__) || defined(__LINUX_ALSA__) || defined(__UNIX_JACK__)</span>
<a name="l00524"></a>00524 <span class="preprocessor"></span><span class="preprocessor"> #define __OS_LINUX__</span>
<a name="l00525"></a>00525 <span class="preprocessor"></span><span class="preprocessor"> #define __STK_REALTIME__</span>
<a name="l00526"></a>00526 <span class="preprocessor"></span><span class="preprocessor">#elif defined(__IRIX_AL__)</span>
<a name="l00527"></a>00527 <span class="preprocessor"></span><span class="preprocessor"> #define __OS_IRIX__</span>
<a name="l00528"></a>00528 <span class="preprocessor"></span><span class="preprocessor">#elif defined(__MACOSX_CORE__) || defined(__UNIX_JACK__)</span>
<a name="l00529"></a>00529 <span class="preprocessor"></span><span class="preprocessor"> #define __OS_MACOSX__</span>
<a name="l00530"></a>00530 <span class="preprocessor"></span><span class="preprocessor"> #define __STK_REALTIME__</span>
<a name="l00531"></a>00531 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00532"></a>00532 <span class="preprocessor"></span>
<a name="l00533"></a>00533 } <span class="comment">// stk namespace</span>
<a name="l00534"></a>00534
<a name="l00535"></a>00535 <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>&copy;1995-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink