e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-14 05:21:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.4.3 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:49:37 +02:00
committed by Stephen Sinclair
parent cfdfe7736a
commit f13d5bb3cd
632 changed files with 12236 additions and 19041 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
doc/html/classstk_1_1FileLoop.html
View File

@@ -50,6 +50,9 @@ void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2c539902d697d0b87334ca7dc4f3ce69"></a><!-- doxytag: member="stk::FileLoop::reset" ref="a2c539902d697d0b87334ca7dc4f3ce69" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FileLoop.html#a2c539902d697d0b87334ca7dc4f3ce69">reset</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clear outputs and reset time (file) pointer to zero. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f3c514ce166068197684a21d31c3a76"></a><!-- doxytag: member="stk::FileLoop::channelsOut" ref="a9f3c514ce166068197684a21d31c3a76" args="(void) const " -->
unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FileLoop.html#a9f3c514ce166068197684a21d31c3a76">channelsOut</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of audio channels in the data or stream. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FileLoop.html#a7c4a3d5c427154bf653f86a53e900b8b">normalize</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Normalize data to a maximum of +-1.0. <a href="#a7c4a3d5c427154bf653f86a53e900b8b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FileLoop.html#aa1ac0c8d19f412f66f5fdb89854e2833">normalize</a> (StkFloat peak)</td></tr>
@@ -81,7 +84,7 @@ void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
<p>STK file looping / oscillator class. </p>
<p>This class provides audio file looping functionality. Any audio file that can be loaded by <a class="el" href="classstk_1_1FileRead.html" title="STK audio file input class.">FileRead</a> can be looped using this class.</p>
<p><a class="el" href="classstk_1_1FileLoop.html" title="STK file looping / oscillator class.">FileLoop</a> supports multi-channel data. It is important to distinguish the <a class="el" href="classstk_1_1FileLoop.html#a037b31918134ed1839a8b48de774ab95" title="Compute a sample frame and return the specified channel value.">tick()</a> method that computes a single frame (and returns only the specified sample of a multi-channel frame) from the overloaded one that takes an <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object for multi-channel and/or multi-frame data.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
<p>by Perry R. Cook and Gary P. Scavone, 1995-2011. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5905940c0dd046a95ca9c2a1d72983de"></a><!-- doxytag: member="stk::FileLoop::openFile" ref="a5905940c0dd046a95ca9c2a1d72983de" args="(std::string fileName, bool raw=false, bool doNormalize=true)" -->
<div class="memitem">
@@ -142,6 +145,9 @@ void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
<p>Reimplemented from <a class="el" href="classstk_1_1FileWvIn.html#aaecd1950fca3a5513e0efe4e86754b11">stk::FileWvIn</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00065"></a>00065 { <a class="code" href="classstk_1_1FileLoop.html#a7c4a3d5c427154bf653f86a53e900b8b" title="Normalize data to a maximum of +-1.0.">FileWvIn::normalize</a>( 1.0 ); };
</pre></div></p>
</div>
</div>
<a class="anchor" id="aa1ac0c8d19f412f66f5fdb89854e2833"></a><!-- doxytag: member="stk::FileLoop::normalize" ref="aa1ac0c8d19f412f66f5fdb89854e2833" args="(StkFloat peak)" -->
@@ -165,6 +171,9 @@ void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
<p>Reimplemented from <a class="el" href="classstk_1_1FileWvIn.html#a670b16fcbdd2a510706c23faeb00a1be">stk::FileWvIn</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00072"></a>00072 { <a class="code" href="classstk_1_1FileLoop.html#a7c4a3d5c427154bf653f86a53e900b8b" title="Normalize data to a maximum of +-1.0.">FileWvIn::normalize</a>( peak ); };
</pre></div></p>
</div>
</div>
<a class="anchor" id="aa18006c800c7dac1ddd277c987fe0003"></a><!-- doxytag: member="stk::FileLoop::getFileRate" ref="aa18006c800c7dac1ddd277c987fe0003" args="(void) const " -->
@@ -188,6 +197,9 @@ void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
<p>Reimplemented from <a class="el" href="classstk_1_1FileWvIn.html#a867b7b7fdb60e5194e25d7a85a26ec0b">stk::FileWvIn</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00083"></a>00083 { <span class="keywordflow">return</span> data_.dataRate(); };
</pre></div></p>
</div>
</div>
<a class="anchor" id="a13e1f693bc8a29d9051a400087347a3c"></a><!-- doxytag: member="stk::FileLoop::setRate" ref="a13e1f693bc8a29d9051a400087347a3c" args="(StkFloat rate)" -->
@@ -232,6 +244,9 @@ void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
<p>Set the data interpolation rate based on a looping frequency. </p>
<p>This function determines the interpolation rate based on the file size and the current <a class="el" href="classstk_1_1Stk.html#a5fbe37000a611ce56075ee7d8936472d" title="Static method that returns the current STK sample rate.">Stk::sampleRate</a>. The <em>frequency</em> value corresponds to file cycles per second. The frequency can be negative, in which case the loop is read in reverse order. </p>
<p><div class="fragment"><pre class="fragment"><a name="l00098"></a>00098 { this-&gt;<a class="code" href="classstk_1_1FileLoop.html#a13e1f693bc8a29d9051a400087347a3c" title="Set the data read rate in samples. The rate can be negative.">setRate</a>( file_.fileSize() * frequency / <a class="code" href="classstk_1_1Stk.html#a5fbe37000a611ce56075ee7d8936472d" title="Static method that returns the current STK sample rate.">Stk::sampleRate</a>() ); };
</pre></div></p>
</div>
</div>
<a class="anchor" id="a8e24d6f9292a9443fbc21e4e8797f482"></a><!-- doxytag: member="stk::FileLoop::addPhase" ref="a8e24d6f9292a9443fbc21e4e8797f482" args="(StkFloat angle)" -->
@@ -297,6 +312,9 @@ void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
<p>Reimplemented from <a class="el" href="classstk_1_1FileWvIn.html#ad17c12e8d51f90f59f0d0c9f6d626608">stk::FileWvIn</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00129"></a>00129 { <span class="keywordflow">return</span> <a class="code" href="classstk_1_1FileLoop.html#a826b6dd0968c5abd1020a9fe629a4ffd" title="Return the specified channel value of the last computed frame.">FileWvIn::lastOut</a>( channel ); };
</pre></div></p>
</div>
</div>
<a class="anchor" id="a037b31918134ed1839a8b48de774ab95"></a><!-- doxytag: member="stk::FileLoop::tick" ref="a037b31918134ed1839a8b48de774ab95" args="(unsigned int channel=0)" -->
@@ -353,7 +371,7 @@ void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
<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-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2011 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>