e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-14 21:41:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.2.0 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:39:37 +02:00
committed by Stephen Sinclair
parent fe20fe92a2
commit de344668dd
347 changed files with 16972 additions and 8538 deletions
Download Patch File Download Diff File Expand all files Collapse all files

185
doc/html/classWvIn.html
View File

@@ -9,10 +9,7 @@
<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.4 -->
<h1>WvIn Class Reference</h1>STK audio data input base class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="WvIn_8h-source.html">WvIn.h</a>&gt;</code>
<h1>WvIn Class Reference</h1><code>#include &lt;<a class="el" href="WvIn_8h-source.html">WvIn.h</a>&gt;</code>
<p>
<p>Inheritance diagram for WvIn:
<p><center><img src="classWvIn.png" usemap="#WvIn_map" border="0" alt=""></center>
@@ -22,21 +19,34 @@
<area href="classTcpWvIn.html" alt="TcpWvIn" shape="rect" coords="82,112,154,136">
<area href="classWaveLoop.html" alt="WaveLoop" shape="rect" coords="164,112,236,136">
</map>
<a href="classWvIn-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<a href="classWvIn-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
STK audio data input base class.
<p>
This class provides input support for various audio file formats. It also serves as a base class for "realtime" streaming subclasses.<p>
WvIn loads the contents of an audio file for subsequent output. Linear interpolation is used for fractional "read rates".<p>
WvIn supports multi-channel data in interleaved format. It is important to distinguish the <a class="el" href="classWvIn.html#a16">tick()</a> methods, which return samples produced by averaging across sample frames, from the <a class="el" href="classWvIn.html#a20">tickFrame()</a> methods, which return pointers to multi-channel sample frames. For single-channel data, these methods return equivalent values.<p>
Small files are completely read into local memory during instantiation. Large files are read incrementally from disk. The file size threshold and the increment size values are defined in <a class="el" href="WvIn_8h.html">WvIn.h</a>.<p>
When the end of a file is reached, subsequent calls to the <a class="el" href="classWvIn.html#a16">tick()</a> functions return the data values at the end of the file.<p>
WvIn currently supports WAV, AIFF, SND (AU), MAT-file (Matlab), and STK RAW file formats. Signed integer (8-, 16-, and 32-bit) and floating- point (32- and 64-bit) data types are supported. Compressed data types are not supported. If using MAT-files, data should be saved in an array with each data channel filling a matrix row. The sample rate for MAT-files is assumed to be 44100 Hz.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
<p>
<p>
Definition at line <a class="el" href="WvIn_8h-source.html#l00057">57</a> of file <a class="el" href="WvIn_8h-source.html">WvIn.h</a>.<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a0" doxytag="WvIn::WvIn" ></a>
&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> (std::string fileName, bool raw=false, bool doNormalize=true)</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> (std::string 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. </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>
@@ -50,7 +60,7 @@ void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classW
<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. </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="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a7">normalize</a> (StkFloat peak)</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>
@@ -61,57 +71,51 @@ unsigned long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" hre
unsigned int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a9">getChannels</a> (void) const </td></tr>
<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="memItemLeft" nowrap align=right valign=top>StkFloat&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). </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="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a12">setRate</a> (StkFloat aRate)</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>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a13">addTime</a> (StkFloat 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. </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>
virtual StkFloat&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="memItemLeft" nowrap align=right valign=top>virtual StkFloat&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. </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="memItemLeft" nowrap align=right valign=top>virtual StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a17">tick</a> (StkFloat *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>. </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>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a18">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with averaged sample frames. </em> <a href="#a18"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a19" doxytag="WvIn::lastFrame" ></a>
virtual const StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a19">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 StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a20">tickFrame</a> (void)</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">Return a pointer to the next sample frame of data. </em> <a href="#a20"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a21">tickFrame</a> (StkFloat *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>. </em> <a href="#a20"></a><em><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="#a21"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvIn.html#a22">tickFrame</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &amp;frames)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fill the <a class="el" href="classStkFrames.html">StkFrames</a> object with sample frames of data and return the same reference. </em> <a href="#a22"></a><em><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK audio data input base class.
<p>
This class provides input support for various audio file formats. It also serves as a base class for "realtime" streaming subclasses.<p>
WvIn loads the contents of an audio file for subsequent output. Linear interpolation is used for fractional "read rates".<p>
WvIn supports multi-channel data in interleaved format. It is important to distinguish the <a class="el" href="classWvIn.html#a16">tick()</a> methods, which return samples produced by averaging across sample frames, from the <a class="el" href="classWvIn.html#a19">tickFrame()</a> methods, which return pointers to multi-channel sample frames. For single-channel data, these methods return equivalent values.<p>
Small files are completely read into local memory during instantiation. Large files are read incrementally from disk. The file size threshold and the increment size values are defined in <a class="el" href="WvIn_8h.html">WvIn.h</a>.<p>
WvIn currently supports WAV, AIFF, SND (AU), MAT-file (Matlab), and STK RAW file formats. Signed integer (8-, 16-, and 32-bit) and floating- point (32- and 64-bit) data types are supported. Uncompressed data types are not supported. If using MAT-files, data should be saved in an array with each data channel filling a matrix row.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<p>
Definition at line <a class="el" href="WvIn_8h-source.html#l00052">52</a> of file <a class="el" href="WvIn_8h-source.html">WvIn.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a1" doxytag="WvIn::WvIn" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
@@ -120,20 +124,20 @@ Definition at line <a class="el" href="WvIn_8h-source.html#l00052">52</a> of fil
<tr>
<td class="md" nowrap valign="top"> WvIn::WvIn </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const char *&nbsp;</td>
<td class="md" nowrap valign="top">std::string&nbsp;</td>
<td class="mdname" nowrap> <em>fileName</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool&nbsp;</td>
<td class="mdname" nowrap> <em>raw</em> = FALSE, </td>
<td class="mdname" nowrap> <em>raw</em> = false, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool&nbsp;</td>
<td class="mdname" nowrap> <em>doNormalize</em> = TRUE</td>
<td class="mdname" nowrap> <em>doNormalize</em> = true</td>
</tr>
<tr>
<td></td>
@@ -167,20 +171,20 @@ An <a class="el" href="classStkError.html">StkError</a> will be thrown if the fi
<tr>
<td class="md" nowrap valign="top"> void WvIn::openFile </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const char *&nbsp;</td>
<td class="md" nowrap valign="top">std::string&nbsp;</td>
<td class="mdname" nowrap> <em>fileName</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool&nbsp;</td>
<td class="mdname" nowrap> <em>raw</em> = FALSE, </td>
<td class="mdname" nowrap> <em>raw</em> = false, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool&nbsp;</td>
<td class="mdname" nowrap> <em>doNormalize</em> = TRUE</td>
<td class="mdname" nowrap> <em>doNormalize</em> = true</td>
</tr>
<tr>
<td></td>
@@ -244,7 +248,7 @@ For large, incrementally loaded files with integer data types, normalization is
<tr>
<td class="md" nowrap valign="top"> void WvIn::normalize </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">MY_FLOAT&nbsp;</td>
<td class="md" nowrap valign="top">StkFloat&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>peak</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
@@ -273,7 +277,7 @@ For large, incrementally loaded files with integer data types, normalization is
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> MY_FLOAT WvIn::getFileRate </td>
<td class="md" nowrap valign="top"> StkFloat WvIn::getFileRate </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">void&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
@@ -306,7 +310,7 @@ WAV, SND, and AIF formatted files specify a sample rate in their headers. STK RA
<tr>
<td class="md" nowrap valign="top"> void WvIn::setRate </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">MY_FLOAT&nbsp;</td>
<td class="md" nowrap valign="top">StkFloat&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>aRate</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
@@ -366,7 +370,7 @@ Interpolation is automatically off when the read rate is an integer value. If in
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual MY_FLOAT WvIn::tick </td>
<td class="md" nowrap valign="top"> virtual StkFloat WvIn::tick </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">void&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
@@ -399,9 +403,9 @@ Reimplemented in <a class="el" href="classRtWvIn.html#a5">RtWvIn</a>, and <a cla
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual MY_FLOAT* WvIn::tick </td>
<td class="md" nowrap valign="top"> virtual StkFloat* WvIn::tick </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">MY_FLOAT *&nbsp;</td>
<td class="md" nowrap valign="top">StkFloat *&nbsp;</td>
<td class="mdname" nowrap> <em>vector</em>, </td>
</tr>
<tr>
@@ -435,13 +439,55 @@ An <a class="el" href="classStkError.html">StkError</a> will be thrown if a file
Reimplemented in <a class="el" href="classRtWvIn.html#a6">RtWvIn</a>, and <a class="el" href="classTcpWvIn.html#a6">TcpWvIn</a>. </td>
</tr>
</table>
<a class="anchor" name="a19" doxytag="WvIn::tickFrame" ></a><p>
<a class="anchor" name="a18" doxytag="WvIn::tick" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual const MY_FLOAT* WvIn::tickFrame </td>
<td class="md" nowrap valign="top"> virtual <a class="el" href="classStkFrames.html">StkFrames</a>&amp; WvIn::tick </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>frames</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>channel</em> = 1</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with averaged sample frames.
<p>
The <code>channel</code> argument should be one or greater (the first channel is specified by 1). An <a class="el" href="classStkError.html">StkError</a> will be thrown if a file is read incrementally and a read error occurs or the <code>channel</code> argument is zero or it is greater than the number of channels in the <a class="el" href="classStkFrames.html">StkFrames</a> object.
<p>
Reimplemented in <a class="el" href="classRtWvIn.html#a7">RtWvIn</a>, and <a class="el" href="classTcpWvIn.html#a7">TcpWvIn</a>. </td>
</tr>
</table>
<a class="anchor" name="a20" doxytag="WvIn::tickFrame" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual const StkFloat* WvIn::tickFrame </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">void&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
@@ -465,18 +511,18 @@ Return a pointer to the next sample frame of data.
<p>
An <a class="el" href="classStkError.html">StkError</a> will be thrown if a file is read incrementally and a read error occurs.
<p>
Reimplemented in <a class="el" href="classRtWvIn.html#a8">RtWvIn</a>, <a class="el" href="classTcpWvIn.html#a8">TcpWvIn</a>, and <a class="el" href="classWaveLoop.html#a6">WaveLoop</a>. </td>
Reimplemented in <a class="el" href="classRtWvIn.html#a9">RtWvIn</a>, <a class="el" href="classTcpWvIn.html#a9">TcpWvIn</a>, and <a class="el" href="classWaveLoop.html#a6">WaveLoop</a>. </td>
</tr>
</table>
<a class="anchor" name="a20" doxytag="WvIn::tickFrame" ></a><p>
<a class="anchor" name="a21" doxytag="WvIn::tickFrame" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual MY_FLOAT* WvIn::tickFrame </td>
<td class="md" nowrap valign="top"> virtual StkFloat* WvIn::tickFrame </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">MY_FLOAT *&nbsp;</td>
<td class="md" nowrap valign="top">StkFloat *&nbsp;</td>
<td class="mdname" nowrap> <em>frameVector</em>, </td>
</tr>
<tr>
@@ -507,7 +553,40 @@ Read out sample <em>frames</em> of data to <em>frameVector</em>.
<p>
An <a class="el" href="classStkError.html">StkError</a> will be thrown if a file is read incrementally and a read error occurs.
<p>
Reimplemented in <a class="el" href="classRtWvIn.html#a9">RtWvIn</a>, and <a class="el" href="classTcpWvIn.html#a9">TcpWvIn</a>. </td>
Reimplemented in <a class="el" href="classRtWvIn.html#a10">RtWvIn</a>, <a class="el" href="classTcpWvIn.html#a10">TcpWvIn</a>, and <a class="el" href="classWaveLoop.html#a7">WaveLoop</a>. </td>
</tr>
</table>
<a class="anchor" name="a22" doxytag="WvIn::tickFrame" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual <a class="el" href="classStkFrames.html">StkFrames</a>&amp; WvIn::tickFrame </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>frames</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Fill the <a class="el" href="classStkFrames.html">StkFrames</a> object with sample frames of data and return the same reference.
<p>
An <a class="el" href="classStkError.html">StkError</a> will be thrown if a file is read incrementally and a read error occurs or if there is an incompatability between the number of channels in the WvIn object and that in the <a class="el" href="classStkFrames.html">StkFrames</a> object.
<p>
Reimplemented in <a class="el" href="classRtWvIn.html#a11">RtWvIn</a>, <a class="el" href="classTcpWvIn.html#a11">TcpWvIn</a>, and <a class="el" href="classWaveLoop.html#a8">WaveLoop</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
@@ -515,7 +594,7 @@ Reimplemented in <a class="el" href="classRtWvIn.html#a9">RtWvIn</a>, and <a cla
<HR>
<table>
<tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<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-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>