e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-16 14:21: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

152
doc/html/classRtWvIn.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>RtWvIn Class Reference</h1>STK realtime audio input class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="RtWvIn_8h-source.html">RtWvIn.h</a>&gt;</code>
<h1>RtWvIn Class Reference</h1><code>#include &lt;<a class="el" href="RtWvIn_8h-source.html">RtWvIn.h</a>&gt;</code>
<p>
<p>Inheritance diagram for RtWvIn:
<p><center><img src="classRtWvIn.png" usemap="#RtWvIn_map" border="0" alt=""></center>
@@ -20,10 +17,19 @@
<area href="classWvIn.html" alt="WvIn" shape="rect" coords="0,56,51,80">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,51,24">
</map>
<a href="classRtWvIn-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<a href="classRtWvIn-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
STK realtime audio (blocking) input class.
<p>
This class provides a simplified interface to <a class="el" href="classRtAudio.html">RtAudio</a> for realtime audio input. It is a protected subclass of <a class="el" href="classWvIn.html">WvIn</a>. Because this class makes use of RtAudio's blocking output routines, its performance is less robust on systems where the audio API is callback-based (Macintosh CoreAudio and Windows ASIO).<p>
RtWvIn supports multi-channel data in interleaved format. It is important to distinguish the <a class="el" href="classRtWvIn.html#a5">tick()</a> methods, which return samples produced by averaging across sample frames, from the <a class="el" href="classRtWvIn.html#a9">tickFrame()</a> methods, which return pointers to multi-channel sample frames. For single-channel data, these methods return equivalent values.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
<p>
<p>
Definition at line <a class="el" href="RtWvIn_8h-source.html#l00032">32</a> of file <a class="el" href="RtWvIn_8h-source.html">RtWvIn.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>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtWvIn.html#a0">RtWvIn</a> (int nChannels=1, MY_FLOAT sampleRate=Stk::sampleRate(), int device=0, int bufferFrames=RT_BUFFER_SIZE, int nBuffers=2)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtWvIn.html#a0">RtWvIn</a> (int nChannels=1, StkFloat sampleRate=Stk::sampleRate(), int device=0, int bufferFrames=RT_BUFFER_SIZE, int nBuffers=2)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. </em> <a href="#a0"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="RtWvIn::~RtWvIn" ></a>
@@ -37,36 +43,33 @@
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stop the audio input stream. </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="RtWvIn::lastOut" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtWvIn.html#a4">lastOut</a> (void) const </td></tr>
StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtWvIn.html#a4">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>MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtWvIn.html#a5">tick</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtWvIn.html#a5">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="#a5"></a><em><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="classRtWvIn.html#a6">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtWvIn.html#a6">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="#a6"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="RtWvIn::lastFrame" ></a>
const MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtWvIn.html#a7">lastFrame</a> (void) const </td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtWvIn.html#a7">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="#a7"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="RtWvIn::lastFrame" ></a>
const StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtWvIn.html#a8">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>const MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtWvIn.html#a8">tickFrame</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtWvIn.html#a9">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="#a8"></a><em><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="classRtWvIn.html#a9">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="#a9"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtWvIn.html#a10">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="#a9"></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="#a10"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtWvIn.html#a11">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="#a11"></a><em><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK realtime audio input class.
<p>
This class provides a simplified interface to <a class="el" href="classRtAudio.html">RtAudio</a> for realtime audio input. It is a protected subclass of <a class="el" href="classWvIn.html">WvIn</a>.<p>
RtWvIn supports multi-channel data in interleaved format. It is important to distinguish the <a class="el" href="classRtWvIn.html#a5">tick()</a> methods, which return samples produced by averaging across sample frames, from the <a class="el" href="classRtWvIn.html#a8">tickFrame()</a> methods, which return pointers to multi-channel sample frames. For single-channel data, these methods return equivalent values.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<p>
Definition at line <a class="el" href="RtWvIn_8h-source.html#l00029">29</a> of file <a class="el" href="RtWvIn_8h-source.html">RtWvIn.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="RtWvIn::RtWvIn" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
@@ -81,7 +84,7 @@ Definition at line <a class="el" href="RtWvIn_8h-source.html#l00029">29</a> of f
<tr>
<td></td>
<td></td>
<td class="md" nowrap>MY_FLOAT&nbsp;</td>
<td class="md" nowrap>StkFloat&nbsp;</td>
<td class="mdname" nowrap> <em>sampleRate</em> = Stk::sampleRate(), </td>
</tr>
<tr>
@@ -194,7 +197,7 @@ It may be necessary to use this method to avoid audio underflow problems if you
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> MY_FLOAT RtWvIn::tick </td>
<td class="md" nowrap valign="top"> StkFloat RtWvIn::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>
@@ -227,9 +230,9 @@ Reimplemented from <a class="el" href="classWvIn.html#a16">WvIn</a>. </td>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> MY_FLOAT* RtWvIn::tick </td>
<td class="md" nowrap valign="top"> StkFloat* RtWvIn::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>
@@ -263,13 +266,55 @@ An <a class="el" href="classStkError.html">StkError</a> will be thrown if an err
Reimplemented from <a class="el" href="classWvIn.html#a17">WvIn</a>. </td>
</tr>
</table>
<a class="anchor" name="a8" doxytag="RtWvIn::tickFrame" ></a><p>
<a class="anchor" name="a7" doxytag="RtWvIn::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"> const MY_FLOAT* RtWvIn::tickFrame </td>
<td class="md" nowrap valign="top"> <a class="el" href="classStkFrames.html">StkFrames</a>&amp; RtWvIn::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 an error occurs during input 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 from <a class="el" href="classWvIn.html#a18">WvIn</a>. </td>
</tr>
</table>
<a class="anchor" name="a9" doxytag="RtWvIn::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"> const StkFloat* RtWvIn::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>
@@ -293,18 +338,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 an error occurs during input.
<p>
Reimplemented from <a class="el" href="classWvIn.html#a19">WvIn</a>. </td>
Reimplemented from <a class="el" href="classWvIn.html#a20">WvIn</a>. </td>
</tr>
</table>
<a class="anchor" name="a9" doxytag="RtWvIn::tickFrame" ></a><p>
<a class="anchor" name="a10" doxytag="RtWvIn::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"> MY_FLOAT* RtWvIn::tickFrame </td>
<td class="md" nowrap valign="top"> StkFloat* RtWvIn::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>
@@ -335,7 +380,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 an error occurs during input.
<p>
Reimplemented from <a class="el" href="classWvIn.html#a20">WvIn</a>. </td>
Reimplemented from <a class="el" href="classWvIn.html#a21">WvIn</a>. </td>
</tr>
</table>
<a class="anchor" name="a11" doxytag="RtWvIn::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"> <a class="el" href="classStkFrames.html">StkFrames</a>&amp; RtWvIn::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 an error occurs during input or there is an incompatability between the number of channels in the RtWvIn object and that in the <a class="el" href="classStkFrames.html">StkFrames</a> object.
<p>
Reimplemented from <a class="el" href="classWvIn.html#a22">WvIn</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
@@ -343,7 +421,7 @@ Reimplemented from <a class="el" href="classWvIn.html#a20">WvIn</a>. </td>
<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>