e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-04-20 06:26:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.2.1 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:40:35 +02:00
committed by Stephen Sinclair
parent 11cf5faa0a
commit 21b93795e7
1041 changed files with 23984 additions and 16348 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
doc/html/classSkini.html
View File

@@ -8,8 +8,8 @@
<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.4 -->
<h1>Skini Class Reference</h1><code>#include &lt;<a class="el" href="Skini_8h-source.html">Skini.h</a>&gt;</code>
<!-- Generated by Doxygen 1.4.4 -->
<h1>Skini Class Reference</h1><!-- doxytag: class="Skini" --><!-- doxytag: inherits="Stk" --><code>#include &lt;<a class="el" href="Skini_8h-source.html">Skini.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Skini:
<p><center><img src="classSkini.png" usemap="#Skini_map" border="0" alt=""></center>
@@ -21,63 +21,64 @@ STK SKINI parsing class.
<p>
This class parses SKINI formatted text messages. It can be used to parse individual messages or it can be passed an entire file. The SKINI specification is Perry's and his alone, but it's all text so it shouldn't be too hard to figure out.<p>
SKINI (Synthesis toolKit Instrument Network Interface) is like MIDI, but allows for floating-point control changes, note numbers, etc. The following example causes a sharp middle C to be played with a velocity of 111.132:<p>
<div class="fragment"><pre> noteOn 60.01 111.132
<div class="fragment"><pre class="fragment"> noteOn 60.01 111.132
</pre></div><p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="skini.html">Synthesis toolKit Instrument Network Interface (SKINI)</a></dd></dl>
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
by Perry R. Cook and Gary P. Scavone, 1995 - 2005.
<p>
<p>
Definition at line <a class="el" href="Skini_8h-source.html#l00036">36</a> of file <a class="el" href="Skini_8h-source.html">Skini.h</a>.<table border=0 cellpadding=0 cellspacing=0>
<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="Skini::Skini" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSkini.html#a0">Skini</a> ()</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"></a><!-- doxytag: member="Skini::Skini" ref="a0" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSkini.html#a0">Skini</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><a class="anchor" name="a1" doxytag="Skini::~Skini" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSkini.html#a1">~Skini</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="Skini::~Skini" ref="a1" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSkini.html#a1">~Skini</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>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSkini.html#a2">setFile</a> (std::string fileName)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSkini.html#a2">setFile</a> (std::string fileName)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a SKINI formatted file for reading. </em> <a href="#a2"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSkini.html#a3">nextMessage</a> (<a class="el" href="structSkini_1_1Message.html">Skini::Message</a> &amp;message)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a SKINI formatted file for reading. <a href="#a2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSkini.html#a3">nextMessage</a> (<a class="el" href="structSkini_1_1Message.html">Skini::Message</a> &amp;message)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parse the next file message (if a file is loaded) and return the message type. </em> <a href="#a3"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSkini.html#a4">parseString</a> (std::string &amp;line, <a class="el" href="structSkini_1_1Message.html">Skini::Message</a> &amp;message)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parse the next file message (if a file is loaded) and return the message type. <a href="#a3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSkini.html#a4">parseString</a> (std::string &amp;line, <a class="el" href="structSkini_1_1Message.html">Skini::Message</a> &amp;message)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Attempt to parse the given string and returning the message type. </em> <a href="#a4"></a><em><br><br></td></tr>
<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="e0" doxytag="Skini::whatsThisType" ></a>
std::string&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSkini.html#e0">whatsThisType</a> (long type)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Attempt to parse the given string and returning the message type. <a href="#a4"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e0"></a><!-- doxytag: member="Skini::whatsThisType" ref="e0" args="(long type)" -->
static std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSkini.html#e0">whatsThisType</a> (long type)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the SKINI type string for the given type value. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="e1" doxytag="Skini::whatsThisController" ></a>
std::string&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSkini.html#e1">whatsThisController</a> (long number)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the SKINI type string for the given type value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e1"></a><!-- doxytag: member="Skini::whatsThisController" ref="e1" args="(long number)" -->
static std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSkini.html#e1">whatsThisController</a> (long number)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the SKINI controller string for the given controller number. <br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the SKINI controller string for the given controller number. <br></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSkini_1_1Message.html">Message</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A message structure to store and pass parsed SKINI messages. <a href="structSkini_1_1Message.html#_details">More...</a><br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a2" doxytag="Skini::setFile" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<a class="anchor" name="a2"></a><!-- doxytag: member="Skini::setFile" ref="a2" args="(std::string fileName)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Skini::setFile </td>
<td class="md" nowrap valign="top">bool Skini::setFile </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">std::string&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>fileName</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -87,28 +88,27 @@ std::string&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href=
<p>
Set a SKINI formatted file for reading.
<p>
If the file is successfully opened, this function returns <em>true</em>. Otherwise, <em>false</em> is returned. </td>
If the file is successfully opened, this function returns <em>true</em>. Otherwise, <em>false</em> is returned. </td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="Skini::nextMessage" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<a class="anchor" name="a3"></a><!-- doxytag: member="Skini::nextMessage" ref="a3" args="(Skini::Message &amp;message)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> long Skini::nextMessage </td>
<td class="md" nowrap valign="top">long Skini::nextMessage </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="structSkini_1_1Message.html">Skini::Message</a> &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>message</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -118,37 +118,36 @@ If the file is successfully opened, this function returns <em>true</em>. Otherwi
<p>
Parse the next file message (if a file is loaded) and return the message type.
<p>
This function skips over lines in a file which cannot be parsed. A type value equal to zero in the referenced message structure (and the returned value) indicates the file end is reached or no file is open for reading. </td>
This function skips over lines in a file which cannot be parsed. A type value equal to zero in the referenced message structure (and the returned value) indicates the file end is reached or no file is open for reading. </td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="Skini::parseString" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<a class="anchor" name="a4"></a><!-- doxytag: member="Skini::parseString" ref="a4" args="(std::string &amp;line, Skini::Message &amp;message)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> long Skini::parseString </td>
<td class="md" nowrap valign="top">long Skini::parseString </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">std::string &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>line</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="structSkini_1_1Message.html">Skini::Message</a> &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>message</em></td>
</tr>
<tr>
<td></td>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -158,7 +157,7 @@ This function skips over lines in a file which cannot be parsed. A type value eq
<p>
Attempt to parse the given string and returning the message type.
<p>
A type value equal to zero in the referenced message structure indicates an invalid message. </td>
A type value equal to zero in the referenced message structure indicates an invalid message. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
@@ -167,7 +166,7 @@ A type value equal to zero in the referenced message structure indicates an inva
<table>
<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>
<tr><td>&copy;1995-2005 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>