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.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

138
doc/html/classRtWvOut.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>RtWvOut Class Reference</h1>STK realtime audio output class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="RtWvOut_8h-source.html">RtWvOut.h</a>&gt;</code>
<h1>RtWvOut Class Reference</h1><code>#include &lt;<a class="el" href="RtWvOut_8h-source.html">RtWvOut.h</a>&gt;</code>
<p>
<p>Inheritance diagram for RtWvOut:
<p><center><img src="classRtWvOut.png" usemap="#RtWvOut_map" border="0" alt=""></center>
@@ -20,10 +17,19 @@
<area href="classWvOut.html" alt="WvOut" shape="rect" coords="0,56,61,80">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,61,24">
</map>
<a href="classRtWvOut-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<a href="classRtWvOut-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
STK realtime audio (blocking) output class.
<p>
This class provides a simplified interface to <a class="el" href="classRtAudio.html">RtAudio</a> for realtime audio output. It is a protected subclass of <a class="el" href="classWvOut.html">WvOut</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>
RtWvOut supports multi-channel data in interleaved format. It is important to distinguish the <a class="el" href="classRtWvOut.html#a6">tick()</a> methods, which output single samples to all channels in a sample frame, from the <a class="el" href="classRtWvOut.html#a9">tickFrame()</a> method, which takes a pointer to multi-channel sample frame data.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
<p>
<p>
Definition at line <a class="el" href="RtWvOut_8h-source.html#l00031">31</a> of file <a class="el" href="RtWvOut_8h-source.html">RtWvOut.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="classRtWvOut.html#a0">RtWvOut</a> (unsigned int nChannels=1, MY_FLOAT sampleRate=Stk::sampleRate(), int device=0, int bufferFrames=RT_BUFFER_SIZE, int nBuffers=4)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtWvOut.html#a0">RtWvOut</a> (unsigned int nChannels=1, StkFloat sampleRate=Stk::sampleRate(), int device=0, int bufferFrames=RT_BUFFER_SIZE, int nBuffers=4)</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="RtWvOut::~RtWvOut" ></a>
@@ -41,29 +47,26 @@ unsigned long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" hre
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of sample frames output. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="RtWvOut::getTime" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtWvOut.html#a5">getTime</a> (void) const </td></tr>
StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtWvOut.html#a5">getTime</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of seconds of data output. <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="classRtWvOut.html#a6">tick</a> (const MY_FLOAT sample)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtWvOut.html#a6">tick</a> (const StkFloat sample)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Output a single sample to all channels in a sample frame. </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="classRtWvOut.html#a7">tick</a> (const MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtWvOut.html#a7">tick</a> (const StkFloat *vector, unsigned int vectorSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Output each sample in <em>vector</em> to all channels in <em>vectorSize</em> sample frames. </em> <a href="#a7"></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="classRtWvOut.html#a8">tickFrame</a> (const MY_FLOAT *frameVector, unsigned int frames=1)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtWvOut.html#a8">tick</a> (const <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">Output the <em>frameVector</em> of sample frames of the given length. </em> <a href="#a8"></a><em><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Output a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object to all channels of the RtWvOut object. </em> <a href="#a8"></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="classRtWvOut.html#a9">tickFrame</a> (const StkFloat *frameVector, unsigned int frames=1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Output the <em>frameVector</em> of sample frames of the given length. </em> <a href="#a9"></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="classRtWvOut.html#a10">tickFrame</a> (const <a class="el" href="classStkFrames.html">StkFrames</a> &amp;frames)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Output the <a class="el" href="classStkFrames.html">StkFrames</a> data to the RtWvOut object. </em> <a href="#a10"></a><em><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK realtime audio output class.
<p>
This class provides a simplified interface to <a class="el" href="classRtAudio.html">RtAudio</a> for realtime audio output. It is a protected subclass of <a class="el" href="classWvOut.html">WvOut</a>.<p>
RtWvOut supports multi-channel data in interleaved format. It is important to distinguish the <a class="el" href="classRtWvOut.html#a6">tick()</a> methods, which output single samples to all channels in a sample frame, from the <a class="el" href="classRtWvOut.html#a8">tickFrame()</a> method, which takes a pointer to multi-channel sample frame data.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<p>
Definition at line <a class="el" href="RtWvOut_8h-source.html#l00028">28</a> of file <a class="el" href="RtWvOut_8h-source.html">RtWvOut.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="RtWvOut::RtWvOut" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
@@ -78,7 +81,7 @@ Definition at line <a class="el" href="RtWvOut_8h-source.html#l00028">28</a> of
<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>
@@ -193,7 +196,7 @@ It may be necessary to use this method to avoid undesireable audio buffer cyclin
<tr>
<td class="md" nowrap valign="top"> void RtWvOut::tick </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const MY_FLOAT&nbsp;</td>
<td class="md" nowrap valign="top">const StkFloat&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>sample</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
@@ -215,7 +218,7 @@ Output a single sample to all channels in a sample frame.
<p>
An <a class="el" href="classStkError.html">StkError</a> will be thrown if an error occurs during output.
<p>
Reimplemented from <a class="el" href="classWvOut.html#a7">WvOut</a>. </td>
Reimplemented from <a class="el" href="classWvOut.html#a9">WvOut</a>. </td>
</tr>
</table>
<a class="anchor" name="a7" doxytag="RtWvOut::tick" ></a><p>
@@ -226,7 +229,7 @@ Reimplemented from <a class="el" href="classWvOut.html#a7">WvOut</a>. </td>
<tr>
<td class="md" nowrap valign="top"> void RtWvOut::tick </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const MY_FLOAT *&nbsp;</td>
<td class="md" nowrap valign="top">const StkFloat *&nbsp;</td>
<td class="mdname" nowrap> <em>vector</em>, </td>
</tr>
<tr>
@@ -257,10 +260,52 @@ Output each sample in <em>vector</em> to all channels in <em>vectorSize</em> sam
<p>
An <a class="el" href="classStkError.html">StkError</a> will be thrown if an error occurs during output.
<p>
Reimplemented from <a class="el" href="classWvOut.html#a8">WvOut</a>. </td>
Reimplemented from <a class="el" href="classWvOut.html#a10">WvOut</a>. </td>
</tr>
</table>
<a class="anchor" name="a8" doxytag="RtWvOut::tickFrame" ></a><p>
<a class="anchor" name="a8" doxytag="RtWvOut::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"> void RtWvOut::tick </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <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>
Output a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object to all channels of the RtWvOut object.
<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 output 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="classWvOut.html#a11">WvOut</a>. </td>
</tr>
</table>
<a class="anchor" name="a9" doxytag="RtWvOut::tickFrame" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -268,7 +313,7 @@ Reimplemented from <a class="el" href="classWvOut.html#a8">WvOut</a>. </td>
<tr>
<td class="md" nowrap valign="top"> void RtWvOut::tickFrame </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const MY_FLOAT *&nbsp;</td>
<td class="md" nowrap valign="top">const StkFloat *&nbsp;</td>
<td class="mdname" nowrap> <em>frameVector</em>, </td>
</tr>
<tr>
@@ -299,7 +344,40 @@ Output the <em>frameVector</em> of sample frames of the given length.
<p>
An <a class="el" href="classStkError.html">StkError</a> will be thrown if an error occurs during output.
<p>
Reimplemented from <a class="el" href="classWvOut.html#a9">WvOut</a>. </td>
Reimplemented from <a class="el" href="classWvOut.html#a12">WvOut</a>. </td>
</tr>
</table>
<a class="anchor" name="a10" doxytag="RtWvOut::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"> void RtWvOut::tickFrame </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <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>
Output the <a class="el" href="classStkFrames.html">StkFrames</a> data to the RtWvOut object.
<p>
An <a class="el" href="classStkError.html">StkError</a> will be thrown if an error occurs during output or if there is an incompatability between the number of channels in the <a class="el" href="classWvOut.html">WvOut</a> object and that in the <a class="el" href="classStkFrames.html">StkFrames</a> object.
<p>
Reimplemented from <a class="el" href="classWvOut.html#a13">WvOut</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
@@ -307,7 +385,7 @@ Reimplemented from <a class="el" href="classWvOut.html#a9">WvOut</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>