e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-04-22 07:26:54 +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

416
doc/html/classStkFrames.html
View File

@@ -8,79 +8,101 @@
<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>StkFrames Class Reference</h1><code>#include &lt;<a class="el" href="Stk_8h-source.html">Stk.h</a>&gt;</code>
<!-- Generated by Doxygen 1.4.4 -->
<h1>StkFrames Class Reference</h1><!-- doxytag: class="StkFrames" --><code>#include &lt;<a class="el" href="Stk_8h-source.html">Stk.h</a>&gt;</code>
<p>
<a href="classStkFrames-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
An STK class to handle vectorized audio data.
<p>
This class can hold single- or multi-channel audio data in either interleaved or non-interleaved formats. The data type is always StkFloat.<p>
Possible future improvements in this class could include static functions to inter- or de-interleave the data and to convert to and return other data types.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
This class can hold single- or multi-channel audio data in either interleaved or non-interleaved formats. The data type is always StkFloat. In an effort to maintain efficiency, no out-of-bounds checks are performed in this class.<p>
Possible future improvements in this class could include functions to inter- or de-interleave the data and to convert to and return other data types.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2005.
<p>
<p>
Definition at line <a class="el" href="Stk_8h-source.html#l00177">177</a> of file <a class="el" href="Stk_8h-source.html">Stk.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="StkFrames::StkFrames" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStkFrames.html#a0">StkFrames</a> (unsigned int nFrames=0, unsigned int nChannels=1, bool interleaved=true)</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="StkFrames::StkFrames" ref="a0" args="(unsigned int nFrames=0, unsigned int nChannels=0, bool interleaved=true)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStkFrames.html#a0">StkFrames</a> (unsigned int nFrames=0, unsigned int nChannels=0, bool interleaved=true)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The default constructor initializes the frame data structure to size zero. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="StkFrames::StkFrames" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStkFrames.html#a1">StkFrames</a> (const StkFloat &amp;value, unsigned int nFrames, unsigned int nChannels, bool interleaved=true)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The default constructor initializes the frame data structure to size zero. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="StkFrames::StkFrames" ref="a1" args="(const StkFloat &amp;value, unsigned int nFrames, unsigned int nChannels, bool interleaved=true)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStkFrames.html#a1">StkFrames</a> (const StkFloat &amp;value, unsigned int nFrames, unsigned int nChannels, bool interleaved=true)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overloaded constructor which initializes the frame data to the specified size with <code>value</code>. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>StkFloat &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStkFrames.html#a2">operator[]</a> (size_t n)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overloaded constructor that initializes the frame data to the specified size with <code>value</code>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="StkFrames::~StkFrames" ref="a2" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStkFrames.html#a2">~StkFrames</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Subscript operator which returns a reference to element <code>n</code> of self. </em> <a href="#a2"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStkFrames.html#a3">operator[]</a> (size_t n) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">StkFloat &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStkFrames.html#a3">operator[]</a> (size_t n)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Subscript operator which returns the value at element <code>n</code> of self. </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="StkFrames::size" ></a>
size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStkFrames.html#a4">size</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Subscript operator which returns a reference to element <code>n</code> of self. <a href="#a3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStkFrames.html#a4">operator[]</a> (size_t n) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the total number of audio samples represented by the object. <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="classStkFrames.html#a5">resize</a> (unsigned int nFrames, unsigned int nChannels=1, StkFloat value=0.0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Subscript operator that returns the value at element <code>n</code> of self. <a href="#a4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">StkFloat &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStkFrames.html#a5">operator()</a> (size_t frame, unsigned int channel)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Resize self to represent the specified number of channels and frames. </em> <a href="#a5"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="StkFrames::channels" ></a>
unsigned int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStkFrames.html#a6">channels</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Channel / frame subscript operator that returns a reference. <a href="#a5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStkFrames.html#a6">operator()</a> (size_t frame, unsigned int channel) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of channels represented by the data. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="StkFrames::frames" ></a>
unsigned int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStkFrames.html#a7">frames</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Channel / frame subscript operator that returns a value. <a href="#a6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStkFrames.html#a7">interpolate</a> (StkFloat frame, unsigned int channel=0) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of sample frames represented by the data. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="StkFrames::interleaved" ></a>
bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStkFrames.html#a8">interleaved</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return an interpolated value at the fractional frame index and channel. <a href="#a7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8"></a><!-- doxytag: member="StkFrames::size" ref="a8" args="() const " -->
size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStkFrames.html#a8">size</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns <code>true</code> if the data is in interleaved format, <code>false</code> if the data is non-interleaved. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="StkFrames::setInterleaved" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStkFrames.html#a9">setInterleaved</a> (bool isInterleaved)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the total number of audio samples represented by the object. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9"></a><!-- doxytag: member="StkFrames::empty" ref="a9" args="() const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStkFrames.html#a9">empty</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the flag to indicate whether the internal data is in interleaved (<code>true</code>) or non-interleaved (<code>false</code>) format. <br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns <em>true</em> if the object size is zero and <em>false</em> otherwise. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStkFrames.html#a10">resize</a> (size_t nFrames, unsigned int nChannels=1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Resize self to represent the specified number of channels and frames. <a href="#a10"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStkFrames.html#a11">resize</a> (size_t nFrames, unsigned int nChannels, StkFloat value)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Resize self to represent the specified number of channels and frames and perform element initialization. <a href="#a11"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a12"></a><!-- doxytag: member="StkFrames::channels" ref="a12" args="(void) const " -->
unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStkFrames.html#a12">channels</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of channels represented by the data. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a13"></a><!-- doxytag: member="StkFrames::frames" ref="a13" args="(void) const " -->
unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStkFrames.html#a13">frames</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of sample frames represented by the data. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStkFrames.html#a14">setDataRate</a> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the sample rate associated with the StkFrames data. <a href="#a14"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStkFrames.html#a15">dataRate</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the sample rate associated with the StkFrames data. <a href="#a15"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a16"></a><!-- doxytag: member="StkFrames::interleaved" ref="a16" args="(void) const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStkFrames.html#a16">interleaved</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns <code>true</code> if the data is in interleaved format, <code>false</code> if the data is non-interleaved. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStkFrames.html#a17">setInterleaved</a> (bool isInterleaved)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the flag to indicate whether the internal data is in interleaved (<code>true</code>) or non-interleaved (<code>false</code>) format. <a href="#a17"></a><br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a2" doxytag="StkFrames::operator[]" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<a class="anchor" name="a3"></a><!-- doxytag: member="StkFrames::operator[]" ref="a3" args="(size_t n)" --><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"> StkFloat&amp; StkFrames::operator[] </td>
<td class="md" nowrap valign="top">StkFloat&amp; StkFrames::operator[] </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">size_t&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>n</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></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;
@@ -90,33 +112,27 @@ void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classS
<p>
Subscript operator which returns a reference to element <code>n</code> of self.
<p>
The result can be used as an lvalue . This reference is valid until the resize function is called or the array is destroyed. The index <code>n</code> must be between 0 and size less one. No range checking is performed.
<p>
Definition at line <a class="el" href="Stk_8h-source.html#l00194">194</a> of file <a class="el" href="Stk_8h-source.html">Stk.h</a>.
<p>
<div class="fragment"><pre>00194 { <span class="keywordflow">return</span> data_[n]; };
</pre></div> </td>
The result can be used as an lvalue . This reference is valid until the resize function is called or the array is destroyed. The index <code>n</code> must be between 0 and size less one. No range checking is performed unless _STK_DEBUG_ is defined. </td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="StkFrames::operator[]" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<a class="anchor" name="a4"></a><!-- doxytag: member="StkFrames::operator[]" ref="a4" args="(size_t n) const " --><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"> StkFloat StkFrames::operator[] </td>
<td class="md" nowrap valign="top">StkFloat StkFrames::operator[] </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">size_t&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>n</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -124,50 +140,155 @@ Definition at line <a class="el" href="Stk_8h-source.html#l00194">194</a> of fil
<td>
<p>
Subscript operator which returns the value at element <code>n</code> of self.
Subscript operator that returns the value at element <code>n</code> of self.
<p>
The index <code>n</code> must be between 0 and size less one. No range checking is performed.
<p>
Definition at line <a class="el" href="Stk_8h-source.html#l00201">201</a> of file <a class="el" href="Stk_8h-source.html">Stk.h</a>.
<p>
<div class="fragment"><pre>00201 { <span class="keywordflow">return</span> data_[n]; };
</pre></div> </td>
The index <code>n</code> must be between 0 and size less one. No range checking is performed unless _STK_DEBUG_ is defined. </td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="StkFrames::resize" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<a class="anchor" name="a5"></a><!-- doxytag: member="StkFrames::operator()" ref="a5" args="(size_t frame, unsigned int channel)" --><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"> void StkFrames::resize </td>
<td class="md" nowrap valign="top">StkFloat&amp; StkFrames::operator() </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>nFrames</em>, </td>
<td class="md" nowrap valign="top">size_t&nbsp;</td>
<td class="mdname" nowrap> <em>frame</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>nChannels</em> = 1, </td>
<td class="mdname" nowrap> <em>channel</em></td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>StkFloat&nbsp;</td>
<td class="mdname" nowrap> <em>value</em> = 0.0</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;
</td>
<td>
<p>
Channel / frame subscript operator that returns a reference.
<p>
The result can be used as an lvalue. This reference is valid until the resize function is called or the array is destroyed. The <code>frame</code> index must be between 0 and <a class="el" href="classStkFrames.html#a13">frames()</a> - 1. The <code>channel</code> index must be between 0 and <a class="el" href="classStkFrames.html#a12">channels()</a> - 1. No range checking is performed unless _STK_DEBUG_ is defined. </td>
</tr>
</table>
<a class="anchor" name="a6"></a><!-- doxytag: member="StkFrames::operator()" ref="a6" args="(size_t frame, unsigned int channel) const " --><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">StkFloat StkFrames::operator() </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">size_t&nbsp;</td>
<td class="mdname" nowrap> <em>frame</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>channel</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Channel / frame subscript operator that returns a value.
<p>
The <code>frame</code> index must be between 0 and <a class="el" href="classStkFrames.html#a13">frames()</a> - 1. The <code>channel</code> index must be between 0 and <a class="el" href="classStkFrames.html#a12">channels()</a> - 1. No range checking is performed unless _STK_DEBUG_ is defined. </td>
</tr>
</table>
<a class="anchor" name="a7"></a><!-- doxytag: member="StkFrames::interpolate" ref="a7" args="(StkFloat frame, unsigned int channel=0) const " --><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">StkFloat StkFrames::interpolate </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">StkFloat&nbsp;</td>
<td class="mdname" nowrap> <em>frame</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>channel</em> = <code>0</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Return an interpolated value at the fractional frame index and channel.
<p>
This function performs linear interpolation. The <code>frame</code> index must be between 0.0 and <a class="el" href="classStkFrames.html#a13">frames()</a> - 1. The <code>channel</code> index must be between 0 and <a class="el" href="classStkFrames.html#a12">channels()</a> - 1. No range checking is performed unless _STK_DEBUG_ is defined. </td>
</tr>
</table>
<a class="anchor" name="a10"></a><!-- doxytag: member="StkFrames::resize" ref="a10" args="(size_t nFrames, unsigned int nChannels=1)" --><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">void StkFrames::resize </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">size_t&nbsp;</td>
<td class="mdname" nowrap> <em>nFrames</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>nChannels</em> = <code>1</code></td>
</tr>
<tr>
<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">
<tr>
<td>
&nbsp;
@@ -177,7 +298,142 @@ Definition at line <a class="el" href="Stk_8h-source.html#l00201">201</a> of fil
<p>
Resize self to represent the specified number of channels and frames.
<p>
Changes the size of self based on the number of frames and channels, and assigns <code>value</code> to every element. </td>
Changes the size of self based on the number of frames and channels. No element assignment is performed. No memory deallocation occurs if the new size is smaller than the previous size. Further, no new memory is allocated when the new size is smaller or equal to a previously allocated size. </td>
</tr>
</table>
<a class="anchor" name="a11"></a><!-- doxytag: member="StkFrames::resize" ref="a11" args="(size_t nFrames, unsigned int nChannels, StkFloat value)" --><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">void StkFrames::resize </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">size_t&nbsp;</td>
<td class="mdname" nowrap> <em>nFrames</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>nChannels</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>StkFloat&nbsp;</td>
<td class="mdname" nowrap> <em>value</em></td>
</tr>
<tr>
<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">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Resize self to represent the specified number of channels and frames and perform element initialization.
<p>
Changes the size of self based on the number of frames and channels, and assigns <code>value</code> to every element. No memory deallocation occurs if the new size is smaller than the previous size. Further, no new memory is allocated when the new size is smaller or equal to a previously allocated size. </td>
</tr>
</table>
<a class="anchor" name="a14"></a><!-- doxytag: member="StkFrames::setDataRate" ref="a14" args="(StkFloat rate)" --><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">void StkFrames::setDataRate </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">StkFloat&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>rate</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set the sample rate associated with the StkFrames data.
<p>
By default, this value is set equal to the current STK sample rate at the time of instantiation. </td>
</tr>
</table>
<a class="anchor" name="a15"></a><!-- doxytag: member="StkFrames::dataRate" ref="a15" args="(void) const " --><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">StkFloat StkFrames::dataRate </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">void&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Return the sample rate associated with the StkFrames data.
<p>
By default, this value is set equal to the current STK sample rate at the time of instantiation. </td>
</tr>
</table>
<a class="anchor" name="a17"></a><!-- doxytag: member="StkFrames::setInterleaved" ref="a17" args="(bool isInterleaved)" --><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">void StkFrames::setInterleaved </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">bool&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>isInterleaved</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set the flag to indicate whether the internal data is in interleaved (<code>true</code>) or non-interleaved (<code>false</code>) format.
<p>
Note that this function does not modify the internal data order with respect to the argument value. It simply changes the indicator flag value. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
@@ -186,7 +442,7 @@ Changes the size of self based on the number of frames and channels, and assigns
<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>