mirror of
https://github.com/thestk/stk
synced 2026-01-12 12:31:53 +00:00
158 lines
7.2 KiB
HTML
158 lines
7.2 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
|
|
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
|
|
</HEAD>
|
|
<BODY BGCOLOR="#FFFFFF">
|
|
<CENTER>
|
|
<img src="princeton.gif"> <img src="ccrma.gif"><P>
|
|
<a class="qindex" href="index.html">Home</a> <a class="qindex" href="information.html">Information</a> <a class="qindex" href="classes.html">Classes</a> <a class="qindex" href="download.html">Download</a> <a class="qindex" href="usage.html">Usage</a> <a class="qindex" href="maillist.html">Mail List</a> <a class="qindex" href="system.html">Requirements</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.2.8.1 -->
|
|
<h1>WaveLoop Class Reference</h1>STK waveform oscillator class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="WaveLoop_8h-source.html">WaveLoop.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for WaveLoop::
|
|
<p><center><img src="classWaveLoop.gif" usemap="#WaveLoop_map" border="0"></center>
|
|
<map name="WaveLoop_map">
|
|
<area href="classWvIn.html" alt="WvIn" shape="rect" coords="0,56,72,80">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,72,24">
|
|
</map>
|
|
<a href="classWaveLoop-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
|
|
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a0" doxytag="WaveLoop::WaveLoop"></a>
|
|
</td><td valign=bottom><a class="el" href="classWaveLoop.html#a0">WaveLoop</a> (const char *fileName, bool raw=FALSE)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Class constructor.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a1" doxytag="WaveLoop::~WaveLoop"></a>
|
|
virtual </td><td valign=bottom><a class="el" href="classWaveLoop.html#a1">~WaveLoop</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Class destructor.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classWaveLoop.html#a2">setFrequency</a> (MY_FLOAT aFrequency)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the data interpolation rate based on a looping frequency.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a3" doxytag="WaveLoop::addTime"></a>
|
|
void </td><td valign=bottom><a class="el" href="classWaveLoop.html#a3">addTime</a> (MY_FLOAT aTime)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Increment the read pointer by <em>aTime</em> samples, modulo file size.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classWaveLoop.html#a4">addPhase</a> (MY_FLOAT anAngle)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Increment current read pointer by <em>anAngle</em>, relative to a looping frequency.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classWaveLoop.html#a5">addPhaseOffset</a> (MY_FLOAT anAngle)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Add a phase offset to the current read pointer.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a6" doxytag="WaveLoop::tickFrame"></a>
|
|
const MY_FLOAT* </td><td valign=bottom><a class="el" href="classWaveLoop.html#a6">tickFrame</a> (void)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Return a pointer to the next sample frame of data.</em></font><br><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK waveform oscillator class.
|
|
<p>
|
|
This class inherits from <a class="el" href="classWvIn.html">WvIn</a> and provides audio file looping functionality.
|
|
<p>
|
|
WaveLoop supports multi-channel data in interleaved format. It is important to distinguish the <a class="el" href="classWvIn.html#a16">tick</a>() methods, which return samples produced by averaging across sample frames, from the <a class="el" href="classWaveLoop.html#a6">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>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a name="a2" doxytag="WaveLoop::setFrequency"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
void WaveLoop::setFrequency (
|
|
</b></td>
|
|
<td valign="bottom"><b>
|
|
MY_FLOAT <em>aFrequency</em> )
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Set the data interpolation rate based on a looping frequency.
|
|
<p>
|
|
This function determines the interpolation rate based on the file size and the current <a class="el" href="classStk.html#d0">Stk::sampleRate</a>. The <em>aFrequency</em> value corresponds to file cycles per second. The frequency can be negative, in which case the loop is read in reverse order. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a4" doxytag="WaveLoop::addPhase"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
void WaveLoop::addPhase (
|
|
</b></td>
|
|
<td valign="bottom"><b>
|
|
MY_FLOAT <em>anAngle</em> )
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Increment current read pointer by <em>anAngle</em>, relative to a looping frequency.
|
|
<p>
|
|
This function increments the read pointer based on the file size and the current <a class="el" href="classStk.html#d0">Stk::sampleRate</a>. The <em>anAngle</em> value is a multiple of file size. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a5" doxytag="WaveLoop::addPhaseOffset"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
void WaveLoop::addPhaseOffset (
|
|
</b></td>
|
|
<td valign="bottom"><b>
|
|
MY_FLOAT <em>anAngle</em> )
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Add a phase offset to the current read pointer.
|
|
<p>
|
|
This function determines a time offset based on the file size and the current <a class="el" href="classStk.html#d0">Stk::sampleRate</a>. The <em>anAngle</em> value is a multiple of file size. </td>
|
|
</tr>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="WaveLoop_8h-source.html">WaveLoop.h</a></ul>
|
|
<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>©1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|