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

140
doc/html/classTcpWvIn.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>TcpWvIn Class Reference</h1>STK internet streaming input class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="TcpWvIn_8h-source.html">TcpWvIn.h</a>&gt;</code>
<h1>TcpWvIn Class Reference</h1><code>#include &lt;<a class="el" href="TcpWvIn_8h-source.html">TcpWvIn.h</a>&gt;</code>
<p>
<p>Inheritance diagram for TcpWvIn:
<p><center><img src="classTcpWvIn.png" usemap="#TcpWvIn_map" border="0" alt=""></center>
@@ -20,7 +17,17 @@
<area href="classWvIn.html" alt="WvIn" shape="rect" coords="0,56,61,80">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,61,24">
</map>
<a href="classTcpWvIn-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<a href="classTcpWvIn-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
STK internet streaming input class.
<p>
This protected Wvin subclass can read streamed data over a network via a TCP socket connection. The data is assumed in big-endian, or network, byte order.<p>
TcpWvIn supports multi-channel data in interleaved format. It is important to distinguish the <a class="el" href="classTcpWvIn.html#a5">tick()</a> methods, which return samples produced by averaging across sample frames, from the <a class="el" href="classTcpWvIn.html#a9">tickFrame()</a> methods, which return pointers to multi-channel sample frames. For single-channel data, these methods return equivalent values.<p>
This class starts a socket server, which waits for a single remote connection. The default data type for the incoming stream is signed 16-bit integers, though any of the defined StkFormats are permissible.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
<p>
<p>
Definition at line <a class="el" href="TcpWvIn_8h-source.html#l00042">42</a> of file <a class="el" href="TcpWvIn_8h-source.html">TcpWvIn.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="classTcpWvIn.html#a0">TcpWvIn</a> (int port=2006)</td></tr>
@@ -30,48 +37,44 @@
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.html#a1">~TcpWvIn</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="classTcpWvIn.html#a2">listen</a> (unsigned int nChannels=1, Stk::STK_FORMAT format=<a class="el" href="classStk.html#s1">STK_SINT16</a>)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.html#a2">listen</a> (unsigned int nChannels=1, Stk::StkFormat format=<a class="el" href="classStk.html#s1">STK_SINT16</a>)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Listen for a (new) connection with specified data channels and format. </em> <a href="#a2"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.html#a3">isConnected</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns TRUE is an input connection exists or input data remains in the queue. </em> <a href="#a3"></a><em><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true is an input connection exists or input data remains in the queue. </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="TcpWvIn::lastOut" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.html#a4">lastOut</a> (void) const </td></tr>
StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.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><a class="anchor" name="a5" doxytag="TcpWvIn::tick" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.html#a5">tick</a> (void)</td></tr>
StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.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. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="TcpWvIn::tick" ></a>
MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.html#a6">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.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>. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="TcpWvIn::lastFrame" ></a>
const MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.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="classTcpWvIn.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="TcpWvIn::lastFrame" ></a>
const StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.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><a class="anchor" name="a8" doxytag="TcpWvIn::tickFrame" ></a>
const MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.html#a8">tickFrame</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="TcpWvIn::tickFrame" ></a>
const StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.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. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="TcpWvIn::tickFrame" ></a>
MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.html#a9">tickFrame</a> (MY_FLOAT *frameVector, unsigned int frames)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a10" doxytag="TcpWvIn::tickFrame" ></a>
StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.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>. <br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK internet streaming input class.
<p>
This protected Wvin subclass can read streamed data over a network via a TCP socket connection. The data is assumed in big-endian, or network, byte order.<p>
TcpWvIn supports multi-channel data in interleaved format. It is important to distinguish the <a class="el" href="classTcpWvIn.html#a5">tick()</a> methods, which return samples produced by averaging across sample frames, from the <a class="el" href="classTcpWvIn.html#a8">tickFrame()</a> methods, which return pointers to multi-channel sample frames. For single-channel data, these methods return equivalent values.<p>
This class starts a socket server, which waits for a single remote connection. The default data type for the incoming stream is signed 16-bit integers, though any of the defined STK_FORMATs are permissible.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<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="classTcpWvIn.html#a11">tickFrame</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &amp;frames)</td></tr>
<p>
Definition at line <a class="el" href="TcpWvIn_8h-source.html#l00041">41</a> of file <a class="el" href="TcpWvIn_8h-source.html">TcpWvIn.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<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><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="TcpWvIn::TcpWvIn" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
@@ -118,7 +121,7 @@ An <a class="el" href="classStkError.html">StkError</a> will be thrown if an err
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Stk::STK_FORMAT&nbsp;</td>
<td class="md" nowrap>Stk::StkFormat&nbsp;</td>
<td class="mdname" nowrap> <em>format</em> = <a class="el" href="classStk.html#s1">STK_SINT16</a></td>
</tr>
<tr>
@@ -170,9 +173,84 @@ An <a class="el" href="classStkError.html">StkError</a> will be thrown a socket
<td>
<p>
Returns TRUE is an input connection exists or input data remains in the queue.
Returns true is an input connection exists or input data remains in the queue.
<p>
This method will not return FALSE after an input connection has been closed until all buffered input data has been read out. </td>
This method will not return false after an input connection has been closed until all buffered input data has been read out. </td>
</tr>
</table>
<a class="anchor" name="a7" doxytag="TcpWvIn::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"> <a class="el" href="classStkFrames.html">StkFrames</a>&amp; TcpWvIn::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 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="a11" doxytag="TcpWvIn::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; TcpWvIn::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 there is an incompatability between the number of channels in the TcpWvIn 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>
@@ -180,7 +258,7 @@ This method will not return FALSE after an input connection has been closed unti
<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>