e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-19 23:51:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.1.2 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:37:27 +02:00
committed by Stephen Sinclair
parent d12ef806ac
commit 5d63b50e85
436 changed files with 17966 additions and 14506 deletions
Download Patch File Download Diff File Expand all files Collapse all files

214
doc/html/classStk.html
View File

@@ -5,17 +5,17 @@
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
<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.2.8.1 -->
<h1>Stk Class Reference</h1>STK base class.
<!-- Generated by Doxygen 1.3.6 -->
<h1>Stk Class Reference</h1>STK base class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Stk_8h-source.html">Stk.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Stk::
<p><center><img src="classStk.gif" usemap="#Stk_map" border="0"></center>
<p>Inheritance diagram for Stk:
<p><center><img src="classStk.png" usemap="#Stk_map" border="0" alt=""></center>
<map name="Stk_map">
<area href="classBowTabl.html" alt="BowTabl" shape="rect" coords="79,56,148,80">
<area href="classChorus.html" alt="Chorus" shape="rect" coords="79,112,148,136">
@@ -42,62 +42,86 @@
<area href="classWvOut.html" alt="WvOut" shape="rect" coords="79,1288,148,1312">
</map>
<a href="classStk-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="d0" doxytag="Stk::sampleRate"></a>
MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#d0">sampleRate</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Static method which returns the current STK sample rate.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#d1">setSampleRate</a> (MY_FLOAT newRate)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Static method which sets the STK sample rate.</em> <a href="#d1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="d2" doxytag="Stk::swap16"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#d2">swap16</a> (unsigned char *ptr)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Static method which byte-swaps a 16-bit data type.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="d3" doxytag="Stk::swap32"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#d3">swap32</a> (unsigned char *ptr)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Static method which byte-swaps a 32-bit data type.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="d4" doxytag="Stk::swap64"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#d4">swap64</a> (unsigned char *ptr)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Static method which byte-swaps a 64-bit data type.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="d5" doxytag="Stk::sleep"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#d5">sleep</a> (unsigned long milliseconds)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Static cross-platform method to sleep for a number of milliseconds.</em></font><br><br></td></tr>
<tr><td></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="Stk::sampleRate" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e0">sampleRate</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method which returns the current STK sample rate. <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="classStk.html#e1">setSampleRate</a> (MY_FLOAT newRate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method which sets the STK sample rate. <a href="#e1"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="e2" doxytag="Stk::rawwavePath" ></a>
std::string&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e2">rawwavePath</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method which returns the current rawwave path. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="e3" doxytag="Stk::setRawwavePath" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e3">setRawwavePath</a> (std::string newPath)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method which sets the STK rawwave path. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="e4" doxytag="Stk::swap16" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e4">swap16</a> (unsigned char *ptr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method which byte-swaps a 16-bit data type. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="e5" doxytag="Stk::swap32" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e5">swap32</a> (unsigned char *ptr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method which byte-swaps a 32-bit data type. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="e6" doxytag="Stk::swap64" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e6">swap64</a> (unsigned char *ptr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method which byte-swaps a 64-bit data type. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="e7" doxytag="Stk::sleep" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e7">sleep</a> (unsigned long milliseconds)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static cross-platform method to sleep for a number of milliseconds. <br><br></td></tr>
<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>const STK_FORMAT&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#p0">STK_SINT8</a></td></tr>
<tr><td nowrap align=right valign=top>const STK_FORMAT&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#p1">STK_SINT16</a></td></tr>
<tr><td nowrap align=right valign=top>const STK_FORMAT&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#p2">STK_SINT32</a></td></tr>
<tr><td nowrap align=right valign=top>const STK_FORMAT&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#p3">STK_FLOAT32</a></td></tr>
<tr><td nowrap align=right valign=top>const STK_FORMAT&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#p4">STK_FLOAT64</a></td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="b0" doxytag="Stk::Stk"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#b0">Stk</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Default constructor.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="b1" doxytag="Stk::~Stk"></a>
virtual&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#b1">~Stk</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Class destructor.</em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Static Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="e0" doxytag="Stk::handleError"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#e0">handleError</a> (const char *message, StkError::TYPE type)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Function for error reporting and handling.</em></font><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const STK_FORMAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#s0">STK_SINT8</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const STK_FORMAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#s1">STK_SINT16</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const STK_FORMAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#s2">STK_SINT32</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const STK_FORMAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#s3">MY_FLOAT32</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const STK_FORMAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#s4">MY_FLOAT64</a></td></tr>
<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="b0" doxytag="Stk::Stk" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#b0">Stk</a> (void)</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="b1" doxytag="Stk::~Stk" ></a>
virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#b1">~Stk</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br><br></td></tr>
<tr><td colspan=2><br><h2>Static Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="f0" doxytag="Stk::handleError" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#f0">handleError</a> (const char *message, StkError::TYPE type)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function for error reporting and handling. <br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK base class.
<p>
Nearly all STK classes inherit from this class. The global sample rate can be queried and modified via Stk. In addition, this class provides error handling and byte-swapping functions.
STK base class.
<p>
Nearly all STK classes inherit from this class. The global sample rate and rawwave path variables can be queried and modified via Stk. In addition, this class provides error handling and byte-swapping functions.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<hr><h2>Member Function Documentation</h2>
<a name="d1" doxytag="Stk::setSampleRate"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<p>
Definition at line <a class="el" href="Stk_8h-source.html#l00082">82</a> of file <a class="el" href="Stk_8h-source.html">Stk.h</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e1" doxytag="Stk::setSampleRate" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="md">
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void Stk::setSampleRate (
</b></td>
<td valign="bottom"><b>
MY_FLOAT <em>newRate</em>&nbsp;)<code> [static]</code>
</b></td>
<td class="md" nowrap valign="top"> void Stk::setSampleRate </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">MY_FLOAT&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>newRate</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
@@ -112,23 +136,19 @@ MY_FLOAT <em>newRate</em>&nbsp;)<code> [static]</code>
<td>
<p>
Static method which sets the STK sample rate.
Static method which sets the STK sample rate.
<p>
The sample rate set using this method is queried by all STK classes which depend on its value. It is initialized to the default SRATE set in Stk.h. Many STK classes use the sample rate during instantiation. Therefore, if you wish to use a rate which is different from the default rate, it is imperative that it be set <em>BEFORE</em> STK objects are instantiated. </td>
The sample rate set using this method is queried by all STK classes which depend on its value. It is initialized to the default SRATE set in <a class="el" href="Stk_8h.html">Stk.h</a>. Many STK classes use the sample rate during instantiation. Therefore, if you wish to use a rate which is different from the default rate, it is imperative that it be set <em>BEFORE</em> STK objects are instantiated. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="p0" doxytag="Stk::STK_SINT8"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<a class="anchor" name="s0" doxytag="Stk::STK_SINT8" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="md">
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const STK_FORMAT Stk::STK_SINT8<code> [static]</code>
</b></td>
</tr>
<td class="md" nowrap valign="top"> const STK_FORMAT <a class="el" href="classStk.html#s0">Stk::STK_SINT8</a><code> [static]</code>
</table>
</td>
</tr>
@@ -141,20 +161,18 @@ const STK_FORMAT Stk::STK_SINT8<code> [static]</code>
<td>
<p>
-128 to +127 </td>
-128 to +127
<p>
Definition at line <a class="el" href="Stk_8h-source.html#l00087">87</a> of file <a class="el" href="Stk_8h-source.html">Stk.h</a>. </td>
</tr>
</table>
<a name="p1" doxytag="Stk::STK_SINT16"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<a class="anchor" name="s1" doxytag="Stk::STK_SINT16" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="md">
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const STK_FORMAT Stk::STK_SINT16<code> [static]</code>
</b></td>
</tr>
<td class="md" nowrap valign="top"> const STK_FORMAT <a class="el" href="classStk.html#s1">Stk::STK_SINT16</a><code> [static]</code>
</table>
</td>
</tr>
@@ -167,20 +185,18 @@ const STK_FORMAT Stk::STK_SINT16<code> [static]</code>
<td>
<p>
-32768 to +32767 </td>
-32768 to +32767
<p>
Definition at line <a class="el" href="Stk_8h-source.html#l00088">88</a> of file <a class="el" href="Stk_8h-source.html">Stk.h</a>. </td>
</tr>
</table>
<a name="p2" doxytag="Stk::STK_SINT32"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<a class="anchor" name="s2" doxytag="Stk::STK_SINT32" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="md">
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const STK_FORMAT Stk::STK_SINT32<code> [static]</code>
</b></td>
</tr>
<td class="md" nowrap valign="top"> const STK_FORMAT <a class="el" href="classStk.html#s2">Stk::STK_SINT32</a><code> [static]</code>
</table>
</td>
</tr>
@@ -193,20 +209,18 @@ const STK_FORMAT Stk::STK_SINT32<code> [static]</code>
<td>
<p>
-2147483648 to +2147483647. </td>
-2147483648 to +2147483647.
<p>
Definition at line <a class="el" href="Stk_8h-source.html#l00089">89</a> of file <a class="el" href="Stk_8h-source.html">Stk.h</a>. </td>
</tr>
</table>
<a name="p3" doxytag="Stk::STK_FLOAT32"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<a class="anchor" name="s3" doxytag="Stk::MY_FLOAT32" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="md">
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const STK_FORMAT Stk::STK_FLOAT32<code> [static]</code>
</b></td>
</tr>
<td class="md" nowrap valign="top"> const STK_FORMAT <a class="el" href="classStk.html#s3">Stk::MY_FLOAT32</a><code> [static]</code>
</table>
</td>
</tr>
@@ -219,20 +233,18 @@ const STK_FORMAT Stk::STK_FLOAT32<code> [static]</code>
<td>
<p>
Normalized between plus/minus 1.0. </td>
Normalized between plus/minus 1.0.
<p>
Definition at line <a class="el" href="Stk_8h-source.html#l00090">90</a> of file <a class="el" href="Stk_8h-source.html">Stk.h</a>. </td>
</tr>
</table>
<a name="p4" doxytag="Stk::STK_FLOAT64"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<a class="anchor" name="s4" doxytag="Stk::MY_FLOAT64" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="md">
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const STK_FORMAT Stk::STK_FLOAT64<code> [static]</code>
</b></td>
</tr>
<td class="md" nowrap valign="top"> const STK_FORMAT <a class="el" href="classStk.html#s4">Stk::MY_FLOAT64</a><code> [static]</code>
</table>
</td>
</tr>
@@ -245,7 +257,9 @@ const STK_FORMAT Stk::STK_FLOAT64<code> [static]</code>
<td>
<p>
Normalized between plus/minus 1.0. </td>
Normalized between plus/minus 1.0.
<p>
Definition at line <a class="el" href="Stk_8h-source.html#l00091">91</a> of file <a class="el" href="Stk_8h-source.html">Stk.h</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
@@ -254,7 +268,7 @@ Normalized between plus/minus 1.0. </td>
<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>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>