e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-16 22:31:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.1.3 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:38:16 +02:00
committed by Stephen Sinclair
parent 503ed3cc9f
commit e11bff2fe8
275 changed files with 1190 additions and 1228 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
doc/html/classWvIn.html
View File

@@ -8,7 +8,7 @@
<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="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.3.6 -->
<!-- Generated by Doxygen 1.3.4 -->
<h1>WvIn Class Reference</h1>STK audio data input base class.
<a href="#_details">More...</a>
<p>
@@ -29,16 +29,16 @@
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a0">WvIn</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a1">WvIn</a> (const char *fileName, bool raw=FALSE, bool doNormalize=TRUE)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a1">WvIn</a> (const char *fileName, bool raw=FALSE, bool doNormalize=TRUE)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overloaded constructor for file input. <a href="#a1"></a><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overloaded constructor for file input. </em> <a href="#a1"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="WvIn::~WvIn" ></a>
virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a2">~WvIn</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a3">openFile</a> (const char *fileName, bool raw=FALSE, bool doNormalize=TRUE)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a3">openFile</a> (const char *fileName, bool raw=FALSE, bool doNormalize=TRUE)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Open the specified file and load its data. <a href="#a3"></a><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Open the specified file and load its data. </em> <a href="#a3"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="WvIn::closeFile" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a4">closeFile</a> (void)</td></tr>
@@ -49,10 +49,10 @@ void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classW
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clear outputs and reset time (file pointer) to zero. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a6">normalize</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Normalize data to a maximum of +-1.0. <a href="#a6"></a><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Normalize data to a maximum of +-1.0. </em> <a href="#a6"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a7">normalize</a> (MY_FLOAT peak)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Normalize data to a maximum of <em>+-peak</em>. <a href="#a7"></a><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Normalize data to a maximum of <em>+-peak</em>. </em> <a href="#a7"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="WvIn::getSize" ></a>
unsigned long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a8">getSize</a> (void) const </td></tr>
@@ -63,41 +63,41 @@ unsigned int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of audio channels in the file. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a10">getFileRate</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the input file sample rate in Hz (not the data read rate). <a href="#a10"></a><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the input file sample rate in Hz (not the data read rate). </em> <a href="#a10"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a11" doxytag="WvIn::isFinished" ></a>
bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a11">isFinished</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Query whether reading is complete. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a12">setRate</a> (MY_FLOAT aRate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the data read rate in samples. The rate can be negative. <a href="#a12"></a><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the data read rate in samples. The rate can be negative. </em> <a href="#a12"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a13" doxytag="WvIn::addTime" ></a>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a13">addTime</a> (MY_FLOAT aTime)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Increment the read pointer by <em>aTime</em> samples. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a14">setInterpolate</a> (bool doInterpolate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Turn linear interpolation on/off. <a href="#a14"></a><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Turn linear interpolation on/off. </em> <a href="#a14"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a15" doxytag="WvIn::lastOut" ></a>
virtual MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a15">lastOut</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the average across the last output sample frame. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a16">tick</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read out the average across one sample frame of data. <a href="#a16"></a><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read out the average across one sample frame of data. </em> <a href="#a16"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a17">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read out vectorSize averaged sample frames of data in <em>vector</em>. <a href="#a17"></a><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read out vectorSize averaged sample frames of data in <em>vector</em>. </em> <a href="#a17"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a18" doxytag="WvIn::lastFrame" ></a>
virtual const MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a18">lastFrame</a> (void) const </td></tr>
virtual const MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a18">lastFrame</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a pointer to the last output sample frame. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a19">tickFrame</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a19">tickFrame</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a pointer to the next sample frame of data. <a href="#a19"></a><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a pointer to the next sample frame of data. </em> <a href="#a19"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a20">tickFrame</a> (MY_FLOAT *frameVector, unsigned int frames)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read out sample <em>frames</em> of data to <em>frameVector</em>. <a href="#a20"></a><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read out sample <em>frames</em> of data to <em>frameVector</em>. </em> <a href="#a20"></a><em><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK audio data input base class.
@@ -124,13 +124,13 @@ Definition at line <a class="el" href="WvIn_8h-source.html#l00052">52</a> of fil
<td class="mdname" nowrap> <em>fileName</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td></td>
<td class="md" nowrap>bool&nbsp;</td>
<td class="mdname" nowrap> <em>raw</em> = FALSE, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td></td>
<td class="md" nowrap>bool&nbsp;</td>
<td class="mdname" nowrap> <em>doNormalize</em> = TRUE</td>
@@ -171,13 +171,13 @@ An <a class="el" href="classStkError.html">StkError</a> will be thrown if the fi
<td class="mdname" nowrap> <em>fileName</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td></td>
<td class="md" nowrap>bool&nbsp;</td>
<td class="mdname" nowrap> <em>raw</em> = FALSE, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td></td>
<td class="md" nowrap>bool&nbsp;</td>
<td class="mdname" nowrap> <em>doNormalize</em> = TRUE</td>
@@ -405,7 +405,7 @@ Reimplemented in <a class="el" href="classRtWvIn.html#a5">RtWvIn</a>, and <a cla
<td class="mdname" nowrap> <em>vector</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>vectorSize</em></td>
@@ -480,7 +480,7 @@ Reimplemented in <a class="el" href="classRtWvIn.html#a8">RtWvIn</a>, <a class="
<td class="mdname" nowrap> <em>frameVector</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>frames</em></td>