e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-13 04:51:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
4.0
stk/doc/html/classWvIn.html
Gary Scavone 43dcd5775a Release 4.0 tarball
2013-09-29 23:33:56 +02:00

481 lines
19 KiB
HTML
Raw Permalink Blame History

<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"> &nbsp; <img src="ccrma.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="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>WvIn Class Reference</h1>STK audio data input base class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="WvIn_8h-source.html">WvIn.h</a>&gt;</code>
<p>
<p>Inheritance diagram for WvIn::
<p><center><img src="classWvIn.gif" usemap="#WvIn_map" border="0"></center>
<map name="WvIn_map">
<area href="classStk.html" alt="Stk" shape="rect" coords="82,0,154,24">
<area href="classRtWvIn.html" alt="RtWvIn" shape="rect" coords="0,112,72,136">
<area href="classTcpWvIn.html" alt="TcpWvIn" shape="rect" coords="82,112,154,136">
<area href="classWaveLoop.html" alt="WaveLoop" shape="rect" coords="164,112,236,136">
</map>
<a href="classWvIn-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="WvIn::WvIn"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classWvIn.html#a0">WvIn</a> ()</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>&nbsp;</td><td valign=bottom><a class="el" href="classWvIn.html#a1">WvIn</a> (const char *fileName, bool raw=FALSE)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Overloaded constructor for file input.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a2" doxytag="WvIn::~WvIn"></a>
virtual&nbsp;</td><td valign=bottom><a class="el" href="classWvIn.html#a2">~WvIn</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Class destructor.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classWvIn.html#a3">openFile</a> (const char *fileName, bool raw=FALSE)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Open the specified file and load its data.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a4" doxytag="WvIn::closeFile"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classWvIn.html#a4">closeFile</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>If a file is open, close it.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a5" doxytag="WvIn::reset"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classWvIn.html#a5">reset</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Clear outputs and reset time (file pointer) to zero.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classWvIn.html#a6">normalize</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Normalize data to a maximum of +-1.0.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classWvIn.html#a7">normalize</a> (MY_FLOAT peak)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Normalize data to a maximum of <em>+-peak</em>.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a8" doxytag="WvIn::getSize"></a>
unsigned long&nbsp;</td><td valign=bottom><a class="el" href="classWvIn.html#a8">getSize</a> (void) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the file size in sample frames.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a9" doxytag="WvIn::getChannels"></a>
unsigned int&nbsp;</td><td valign=bottom><a class="el" href="classWvIn.html#a9">getChannels</a> (void) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the number of audio channels in the file.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classWvIn.html#a10">getFileRate</a> (void) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the input file sample rate in Hz (not the data read rate).</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a11" doxytag="WvIn::isFinished"></a>
bool&nbsp;</td><td valign=bottom><a class="el" href="classWvIn.html#a11">isFinished</a> (void) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Query whether reading is complete.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classWvIn.html#a12">setRate</a> (MY_FLOAT aRate)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set the data read rate in samples. The rate can be negative.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a13" doxytag="WvIn::addTime"></a>
virtual void&nbsp;</td><td valign=bottom><a class="el" href="classWvIn.html#a13">addTime</a> (MY_FLOAT aTime)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Increment the read pointer by <em>aTime</em> samples.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classWvIn.html#a14">setInterpolate</a> (bool doInterpolate)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Turn linear interpolation on/off.</em> <a href="#a14">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a15" doxytag="WvIn::lastOut"></a>
virtual MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classWvIn.html#a15">lastOut</a> (void) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the average across the last output sample frame.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classWvIn.html#a16">tick</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Read out the average across one sample frame of data.</em> <a href="#a16">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual MY_FLOAT*&nbsp;</td><td valign=bottom><a class="el" href="classWvIn.html#a17">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Read out vectorSize averaged sample frames of data in <em>vector</em>.</em> <a href="#a17">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a18" doxytag="WvIn::lastFrame"></a>
virtual const MY_FLOAT*&nbsp;</td><td valign=bottom><a class="el" href="classWvIn.html#a18">lastFrame</a> (void) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return a pointer to the last output sample frame.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual const MY_FLOAT*&nbsp;</td><td valign=bottom><a class="el" href="classWvIn.html#a19">tickFrame</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return a pointer to the next sample frame of data.</em> <a href="#a19">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual MY_FLOAT*&nbsp;</td><td valign=bottom><a class="el" href="classWvIn.html#a20">tickFrame</a> (MY_FLOAT *frameVector, unsigned int frames)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Read out sample <em>frames</em> of data to <em>frameVector</em>.</em> <a href="#a20">More...</a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK audio data input base class.
<p>
This class provides input support for various audio file formats. It also serves as a base class for "realtime" streaming subclasses.
<p>
WvIn loads the contents of an audio file for subsequent output. Linear interpolation is used for fractional "read rates".
<p>
WvIn 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="classWvIn.html#a19">tickFrame</a>() methods, which return pointers to multi-channel sample frames. For single-channel data, these methods return equivalent values.
<p>
Small files are completely read into local memory during instantiation. Large files are read incrementally from disk. The file size threshold and the increment size values are defined in WvIn.h.
<p>
WvIn currently supports WAV, AIFF, SND (AU), MAT-file (Matlab), and STK RAW file formats. Signed integer (8-, 16-, and 32-bit) and floating- point (32- and 64-bit) data types are supported. Uncompressed data types are not supported. If using MAT-files, data should be saved in an array with each data channel filling a matrix row.
<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a1" doxytag="WvIn::WvIn"></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>
WvIn::WvIn (
</b></td>
<td valign="bottom"><b>
const char * <em>fileName</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>raw</em> = FALSE&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Overloaded constructor for file input.
<p>
An <a class="el" href="classStkError.html">StkError</a> will be thrown if the file is not found, its format is unknown, or a read error occurs. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a3" doxytag="WvIn::openFile"></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 WvIn::openFile (
</b></td>
<td valign="bottom"><b>
const char * <em>fileName</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>raw</em> = FALSE&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Open the specified file and load its data.
<p>
An <a class="el" href="classStkError.html">StkError</a> will be thrown if the file is not found, its format is unknown, or a read error occurs. </td>
</tr>
</table>
<a name="a6" doxytag="WvIn::normalize"></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 WvIn::normalize (
</b></td>
<td valign="bottom"><b>
void&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Normalize data to a maximum of +-1.0.
<p>
For large, incrementally loaded files with integer data types, normalization is computed relative to the data type maximum. No normalization is performed for incrementally loaded files with floating-point data types. </td>
</tr>
</table>
<a name="a7" doxytag="WvIn::normalize"></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 WvIn::normalize (
</b></td>
<td valign="bottom"><b>
MY_FLOAT <em>peak</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Normalize data to a maximum of <em>+-peak</em>.
<p>
For large, incrementally loaded files with integer data types, normalization is computed relative to the data type maximum (<em>peak/maximum)</em>. For incrementally loaded files with floating- point data types, direct scaling by <em>peak</em> is performed. </td>
</tr>
</table>
<a name="a10" doxytag="WvIn::getFileRate"></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>
MY_FLOAT WvIn::getFileRate (
</b></td>
<td valign="bottom"><b>
void&nbsp;) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Return the input file sample rate in Hz (not the data read rate).
<p>
WAV, SND, and AIF formatted files specify a sample rate in their headers. STK RAW files have a sample rate of 22050 Hz by definition. MAT-files are assumed to have a rate of 44100 Hz. </td>
</tr>
</table>
<a name="a12" doxytag="WvIn::setRate"></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 WvIn::setRate (
</b></td>
<td valign="bottom"><b>
MY_FLOAT <em>aRate</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set the data read rate in samples. The rate can be negative.
<p>
If the rate value is negative, the data is read in reverse order. </td>
</tr>
</table>
<a name="a14" doxytag="WvIn::setInterpolate"></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 WvIn::setInterpolate (
</b></td>
<td valign="bottom"><b>
bool <em>doInterpolate</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Turn linear interpolation on/off.
<p>
Interpolation is automatically off when the read rate is an integer value. If interpolation is turned off for a fractional rate, the time index is truncated to an integer value. </td>
</tr>
</table>
<a name="a16" doxytag="WvIn::tick"></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>
MY_FLOAT WvIn::tick (
</b></td>
<td valign="bottom"><b>
void&nbsp;)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Read out the average across one sample frame of data.
<p>
An <a class="el" href="classStkError.html">StkError</a> will be thrown if a file is read incrementally and a read error occurs.
<p>
Reimplemented in <a class="el" href="classRtWvIn.html#a5">RtWvIn</a>, and <a class="el" href="classTcpWvIn.html#a5">TcpWvIn</a>. </td>
</tr>
</table>
<a name="a17" doxytag="WvIn::tick"></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>
MY_FLOAT * WvIn::tick (
</b></td>
<td valign="bottom"><b>
MY_FLOAT * <em>vector</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
unsigned int <em>vectorSize</em>&nbsp;)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Read out vectorSize averaged sample frames of data in <em>vector</em>.
<p>
An <a class="el" href="classStkError.html">StkError</a> will be thrown if a file is read incrementally and a read error occurs.
<p>
Reimplemented in <a class="el" href="classRtWvIn.html#a6">RtWvIn</a>, and <a class="el" href="classTcpWvIn.html#a6">TcpWvIn</a>. </td>
</tr>
</table>
<a name="a19" doxytag="WvIn::tickFrame"></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>
const MY_FLOAT * WvIn::tickFrame (
</b></td>
<td valign="bottom"><b>
void&nbsp;)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Return a pointer to the next sample frame of data.
<p>
An <a class="el" href="classStkError.html">StkError</a> will be thrown if a file is read incrementally and a read error occurs.
<p>
Reimplemented in <a class="el" href="classRtWvIn.html#a8">RtWvIn</a>, <a class="el" href="classTcpWvIn.html#a8">TcpWvIn</a>, and <a class="el" href="classWaveLoop.html#a6">WaveLoop</a>. </td>
</tr>
</table>
<a name="a20" doxytag="WvIn::tickFrame"></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>
MY_FLOAT * WvIn::tickFrame (
</b></td>
<td valign="bottom"><b>
MY_FLOAT * <em>frameVector</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
unsigned int <em>frames</em>&nbsp;)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Read out sample <em>frames</em> of data to <em>frameVector</em>.
<p>
An <a class="el" href="classStkError.html">StkError</a> will be thrown if a file is read incrementally and a read error occurs.
<p>
Reimplemented in <a class="el" href="classRtWvIn.html#a9">RtWvIn</a>, and <a class="el" href="classTcpWvIn.html#a9">TcpWvIn</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="WvIn_8h-source.html">WvIn.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>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink