mirror of
https://github.com/nucular/sfxrlua.git
synced 2024-12-24 18:44:20 +00:00
Improved documentation some more
This commit is contained in:
nucular
parent
57ccea261e
commit
fd81eea263
@ -54,6 +54,6 @@ Documentation
|
||||
|
||||
This project uses [LDoc](http://stevedonovan.github.io/ldoc/) for autogenerated
|
||||
API documentation.
|
||||
(Reminder to self: `ldoc . && git subtree push --prefix doc origin gh-pages`)
|
||||
(Note to self: `ldoc . && git subtree push --prefix doc origin gh-pages`)
|
||||
The old documentation is still available on the
|
||||
[Project Wiki](https://github.com/nucular/sfxrlua/wiki).
|
||||
|
||||
@ -63,21 +63,21 @@
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#WAVEFORM">WAVEFORM</a></td>
|
||||
<td class="summary">Wave form constants</td>
|
||||
<td class="summary"><a href="https://en.wikipedia.org/wiki/Waveform">Waveform</a> constants</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SAMPLERATE">SAMPLERATE</a></td>
|
||||
<td class="summary">Sample rate constants
|
||||
<td class="summary"><a href="https://en.wikipedia.org/wiki/Sampling_(signal_processing">Sampling rate</a> constants
|
||||
(use the number values directly, these are just for lookup)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#BITDEPTH">BITDEPTH</a></td>
|
||||
<td class="summary">Bit depth constants
|
||||
<td class="summary"><a href="https://en.wikipedia.org/wiki/Audio_bit_depth">Bit depth</a> constants
|
||||
(use the number values directly, these are just for lookup)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ENDIANNESS">ENDIANNESS</a></td>
|
||||
<td class="summary">Endianness constants</td>
|
||||
<td class="summary"><a href="https://en.wikipedia.org/wiki/Endianness">Endianness</a> constants</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Fields">Fields</a></h2>
|
||||
@ -94,6 +94,47 @@
|
||||
<td class="summary">Initialize the Sound instance.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.volume">self.volume</a></td>
|
||||
<td class="summary">The sound volume and gain all samples are multiplied with</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.envelope">self.envelope</a></td>
|
||||
<td class="summary">The <a href="https://en.wikipedia.org/wiki/Synthesizer#Attack_Deca
|
||||
y_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the sound amplitude
|
||||
(volume) over time</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.frequency">self.frequency</a></td>
|
||||
<td class="summary">The base and minimum frequencies of the tone generator and their slides</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.vibrato">self.vibrato</a></td>
|
||||
<td class="summary">A <a href="https://en.wikipedia.org/wiki/Vibrato">vibrato</a>-like amplitude
|
||||
modulation effect.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.change">self.change</a></td>
|
||||
<td class="summary">Changes the frequency mid-sound to create the characteristic
|
||||
"coin"-effect</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.duty">self.duty</a></td>
|
||||
<td class="summary">The <a href="https://en.wikipedia.org/wiki/Duty_cycle">duty</a> of the square
|
||||
waveform</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.phaser">self.phaser</a></td>
|
||||
<td class="summary">A simple <a href="https://en.wikipedia.org/wiki/Phaser_(effect">phaser</a> effect</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.lowpass">self.lowpass</a></td>
|
||||
<td class="summary">A <a href="https://en.wikipedia.org/wiki/Low-pass_filter">lowpass filter</a> effect</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.highpass">self.highpass</a></td>
|
||||
<td class="summary">A <a href="https://en.wikipedia.org/wiki/High-pass_filter">highpass filter</a> effect</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.volume.master">self.volume.master</a></td>
|
||||
<td class="summary">Master volume (<em>default</em> 0.5)</td>
|
||||
</tr>
|
||||
@ -118,19 +159,19 @@
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.envelope.attack">self.envelope.attack</a></td>
|
||||
<td class="summary">Attack time:
|
||||
Time the sound takes to reach its peak volume
|
||||
Time the sound takes to reach its peak amplitude
|
||||
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.envelope.sustain">self.envelope.sustain</a></td>
|
||||
<td class="summary">Sustain time:
|
||||
Time the sound stays on its peak volume
|
||||
Time the sound stays on its peak amplitude
|
||||
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.envelope.punch">self.envelope.punch</a></td>
|
||||
<td class="summary">Sustain punch:
|
||||
Amount by which the sound peak volume is increased at the start of the
|
||||
Amount by which the sound peak amplitude is increased at the start of the
|
||||
sustain time
|
||||
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
|
||||
</tr>
|
||||
@ -155,19 +196,19 @@
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.frequency.slide">self.frequency.slide</a></td>
|
||||
<td class="summary">Slide:
|
||||
Amount by which the frequency is increased or decreased through time
|
||||
Amount by which the frequency is increased or decreased over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.frequency.dslide">self.frequency.dslide</a></td>
|
||||
<td class="summary">Delta slide:
|
||||
Amount by which the slide is increased or decreased through time
|
||||
Amount by which the slide is increased or decreased over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.vibrato.depth">self.vibrato.depth</a></td>
|
||||
<td class="summary">Vibrato depth:
|
||||
Amount of vibrato-like amplitude (volume) modulation
|
||||
Amount of amplitude modulation
|
||||
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -203,7 +244,7 @@
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.duty.sweep">self.duty.sweep</a></td>
|
||||
<td class="summary">Duty sweep:
|
||||
Amount by which the square duty is increased or decreased through time
|
||||
Amount by which the square duty is increased or decreased over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -215,7 +256,7 @@
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.phaser.sweep">self.phaser.sweep</a></td>
|
||||
<td class="summary">Phaser sweep:
|
||||
Amount by which the phaser offset is increased or decreased through time
|
||||
Amount by which the phaser offset is increased or decreased over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -228,7 +269,7 @@
|
||||
<td class="name" nowrap><a href="#self.lowpass.sweep">self.lowpass.sweep</a></td>
|
||||
<td class="summary">Lowpass filter cutoff sweep:
|
||||
Amount by which the LP filter cutoff is increased or decreased
|
||||
through time
|
||||
over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -248,12 +289,12 @@
|
||||
<td class="name" nowrap><a href="#self.highpass.sweep">self.highpass.sweep</a></td>
|
||||
<td class="summary">Highpass filter cutoff sweep:
|
||||
Amount by which the HP filter cutoff is increased or decreased
|
||||
through time
|
||||
over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#sfxr.Sound:sanitizeParameters">sfxr.Sound:sanitizeParameters ()</a></td>
|
||||
<td class="summary">Clamp all parameters within sane ranges.</td>
|
||||
<td class="summary">Clamp all parameters within their sane ranges.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#sfxr.Sound:generate">sfxr.Sound:generate ([rate=44100[, depth=0]])</a></td>
|
||||
@ -330,7 +371,7 @@
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#sfxr.Sound:loadBinary">sfxr.Sound:loadBinary (f)</a></td>
|
||||
<td class="summary">Load the sound parameters from a file in the sfxr binary format
|
||||
(version 100, 101, 102)</td>
|
||||
(version 100-102)</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@ -378,7 +419,7 @@
|
||||
<strong>WAVEFORM</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Wave form constants
|
||||
<a href="https://en.wikipedia.org/wiki/Waveform">Waveform</a> constants
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
@ -407,7 +448,7 @@
|
||||
<strong>SAMPLERATE</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sample rate constants
|
||||
<a href="https://en.wikipedia.org/wiki/Sampling_(signal_processing">Sampling rate</a> constants
|
||||
(use the number values directly, these are just for lookup)
|
||||
|
||||
|
||||
@ -431,7 +472,7 @@
|
||||
<strong>BITDEPTH</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Bit depth constants
|
||||
<a href="https://en.wikipedia.org/wiki/Audio_bit_depth">Bit depth</a> constants
|
||||
(use the number values directly, these are just for lookup)
|
||||
|
||||
|
||||
@ -458,7 +499,7 @@
|
||||
<strong>ENDIANNESS</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Endianness constants
|
||||
<a href="https://en.wikipedia.org/wiki/Endianness">Endianness</a> constants
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
@ -515,6 +556,137 @@
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "self.volume"></a>
|
||||
<strong>self.volume</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
The sound volume and gain all samples are multiplied with
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "self.envelope"></a>
|
||||
<strong>self.envelope</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
The <a href="https://en.wikipedia.org/wiki/Synthesizer#Attack_Deca
|
||||
y_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the sound amplitude
|
||||
(volume) over time
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "self.frequency"></a>
|
||||
<strong>self.frequency</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
The base and minimum frequencies of the tone generator and their slides
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "self.vibrato"></a>
|
||||
<strong>self.vibrato</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
A <a href="https://en.wikipedia.org/wiki/Vibrato">vibrato</a>-like amplitude
|
||||
modulation effect.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "self.change"></a>
|
||||
<strong>self.change</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Changes the frequency mid-sound to create the characteristic
|
||||
"coin"-effect
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "self.duty"></a>
|
||||
<strong>self.duty</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
The <a href="https://en.wikipedia.org/wiki/Duty_cycle">duty</a> of the square
|
||||
waveform
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "self.phaser"></a>
|
||||
<strong>self.phaser</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
A simple <a href="https://en.wikipedia.org/wiki/Phaser_(effect">phaser</a> effect
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "self.lowpass"></a>
|
||||
<strong>self.lowpass</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
A <a href="https://en.wikipedia.org/wiki/Low-pass_filter">lowpass filter</a> effect
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "self.highpass"></a>
|
||||
<strong>self.highpass</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
A <a href="https://en.wikipedia.org/wiki/High-pass_filter">highpass filter</a> effect
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "self.volume.master"></a>
|
||||
@ -595,7 +767,7 @@
|
||||
</dt>
|
||||
<dd>
|
||||
Attack time:
|
||||
Time the sound takes to reach its peak volume
|
||||
Time the sound takes to reach its peak amplitude
|
||||
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)
|
||||
|
||||
|
||||
@ -611,7 +783,7 @@
|
||||
</dt>
|
||||
<dd>
|
||||
Sustain time:
|
||||
Time the sound stays on its peak volume
|
||||
Time the sound stays on its peak amplitude
|
||||
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)
|
||||
|
||||
|
||||
@ -627,7 +799,7 @@
|
||||
</dt>
|
||||
<dd>
|
||||
Sustain punch:
|
||||
Amount by which the sound peak volume is increased at the start of the
|
||||
Amount by which the sound peak amplitude is increased at the start of the
|
||||
sustain time
|
||||
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)
|
||||
|
||||
@ -692,7 +864,7 @@
|
||||
</dt>
|
||||
<dd>
|
||||
Slide:
|
||||
Amount by which the frequency is increased or decreased through time
|
||||
Amount by which the frequency is increased or decreased over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)
|
||||
|
||||
|
||||
@ -708,7 +880,7 @@
|
||||
</dt>
|
||||
<dd>
|
||||
Delta slide:
|
||||
Amount by which the slide is increased or decreased through time
|
||||
Amount by which the slide is increased or decreased over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)
|
||||
|
||||
|
||||
@ -724,7 +896,7 @@
|
||||
</dt>
|
||||
<dd>
|
||||
Vibrato depth:
|
||||
Amount of vibrato-like amplitude (volume) modulation
|
||||
Amount of amplitude modulation
|
||||
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)
|
||||
|
||||
|
||||
@ -820,7 +992,7 @@
|
||||
</dt>
|
||||
<dd>
|
||||
Duty sweep:
|
||||
Amount by which the square duty is increased or decreased through time
|
||||
Amount by which the square duty is increased or decreased over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)
|
||||
|
||||
|
||||
@ -852,7 +1024,7 @@
|
||||
</dt>
|
||||
<dd>
|
||||
Phaser sweep:
|
||||
Amount by which the phaser offset is increased or decreased through time
|
||||
Amount by which the phaser offset is increased or decreased over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)
|
||||
|
||||
|
||||
@ -885,7 +1057,7 @@
|
||||
<dd>
|
||||
Lowpass filter cutoff sweep:
|
||||
Amount by which the LP filter cutoff is increased or decreased
|
||||
through time
|
||||
over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)
|
||||
|
||||
|
||||
@ -935,7 +1107,7 @@
|
||||
<dd>
|
||||
Highpass filter cutoff sweep:
|
||||
Amount by which the HP filter cutoff is increased or decreased
|
||||
through time
|
||||
over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)
|
||||
|
||||
|
||||
@ -950,7 +1122,7 @@
|
||||
<strong>sfxr.Sound:sanitizeParameters ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Clamp all parameters within sane ranges.
|
||||
Clamp all parameters within their sane ranges.
|
||||
|
||||
|
||||
|
||||
@ -971,7 +1143,7 @@
|
||||
<ul>
|
||||
<li><span class="parameter">rate</span>
|
||||
<span class="types"><a class="type" href="../index.html#SAMPLERATE">SAMPLERATE</a></span>
|
||||
the sample rate
|
||||
the sampling rate
|
||||
(<em>default</em> 44100)
|
||||
</li>
|
||||
<li><span class="parameter">depth</span>
|
||||
@ -985,11 +1157,11 @@
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">function()</span></span>
|
||||
a generator that yields the sample data when called
|
||||
a generator that yields the next sample when called
|
||||
</ol>
|
||||
|
||||
<h3>Raises:</h3>
|
||||
"invalid sample rate: x", "invalid bit depth: x"
|
||||
"invalid sampling rate: x", "invalid bit depth: x"
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
@ -1014,14 +1186,14 @@
|
||||
<ul>
|
||||
<li><span class="parameter">rate</span>
|
||||
<span class="types"><a class="type" href="../index.html#SAMPLERATE">SAMPLERATE</a></span>
|
||||
the sample rate
|
||||
the sampling rate
|
||||
(<em>default</em> 44100)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3>Raises:</h3>
|
||||
"invalid sample rate: x", "invalid bit depth: x"
|
||||
"invalid sampling rate: x", "invalid bit depth: x"
|
||||
|
||||
|
||||
|
||||
@ -1038,7 +1210,7 @@
|
||||
<ul>
|
||||
<li><span class="parameter">rate</span>
|
||||
<span class="types"><a class="type" href="../index.html#SAMPLERATE">SAMPLERATE</a></span>
|
||||
the sample rate
|
||||
the sampling rate
|
||||
(<em>default</em> 44100)
|
||||
</li>
|
||||
<li><span class="parameter">depth</span>
|
||||
@ -1064,7 +1236,7 @@
|
||||
</ol>
|
||||
|
||||
<h3>Raises:</h3>
|
||||
"invalid sample rate: x", "invalid bit depth: x"
|
||||
"invalid sampling rate: x", "invalid bit depth: x"
|
||||
|
||||
|
||||
|
||||
@ -1081,7 +1253,7 @@
|
||||
<ul>
|
||||
<li><span class="parameter">rate</span>
|
||||
<span class="types"><a class="type" href="../index.html#SAMPLERATE">SAMPLERATE</a></span>
|
||||
the sample rate
|
||||
the sampling rate
|
||||
(<em>default</em> 44100)
|
||||
</li>
|
||||
<li><span class="parameter">depth</span>
|
||||
@ -1107,7 +1279,7 @@
|
||||
</ol>
|
||||
|
||||
<h3>Raises:</h3>
|
||||
"invalid sample rate: x", "invalid bit depth: x", "invalid endianness: x"
|
||||
"invalid sampling rate: x", "invalid bit depth: x", "invalid endianness: x"
|
||||
|
||||
|
||||
|
||||
@ -1124,7 +1296,7 @@
|
||||
<ul>
|
||||
<li><span class="parameter">rate</span>
|
||||
<span class="types"><a class="type" href="../index.html#SAMPLERATE">SAMPLERATE</a></span>
|
||||
the sample rate
|
||||
the sampling rate
|
||||
(<em>default</em> 44100)
|
||||
</li>
|
||||
<li><span class="parameter">depth</span>
|
||||
@ -1151,7 +1323,7 @@
|
||||
</ol>
|
||||
|
||||
<h3>Raises:</h3>
|
||||
"invalid sample rate: x", "invalid bit depth: x"
|
||||
"invalid sampling rate: x", "invalid bit depth: x"
|
||||
|
||||
|
||||
|
||||
@ -1380,7 +1552,7 @@
|
||||
</li>
|
||||
<li><span class="parameter">rate</span>
|
||||
<span class="types"><a class="type" href="../index.html#SAMPLERATE">SAMPLERATE</a></span>
|
||||
the sample rate
|
||||
the sampling rate
|
||||
(<em>default</em> 44100)
|
||||
</li>
|
||||
<li><span class="parameter">depth</span>
|
||||
@ -1392,7 +1564,7 @@
|
||||
|
||||
|
||||
<h3>Raises:</h3>
|
||||
"invalid sample rate: x", "invalid bit depth: x"
|
||||
"invalid sampling rate: x", "invalid bit depth: x"
|
||||
|
||||
|
||||
|
||||
@ -1476,7 +1648,7 @@
|
||||
</dt>
|
||||
<dd>
|
||||
Load the sound parameters from a file in the sfxr binary format
|
||||
(version 100, 101, 102)
|
||||
(version 100-102)
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
@ -1502,7 +1674,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2016-03-05 19:36:51 </i>
|
||||
<i style="float:right;">Last updated 2016-03-05 20:16:35 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
||||
264
doc/index.html
264
doc/index.html
@ -63,21 +63,21 @@
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#WAVEFORM">WAVEFORM</a></td>
|
||||
<td class="summary">Wave form constants</td>
|
||||
<td class="summary"><a href="https://en.wikipedia.org/wiki/Waveform">Waveform</a> constants</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SAMPLERATE">SAMPLERATE</a></td>
|
||||
<td class="summary">Sample rate constants
|
||||
<td class="summary"><a href="https://en.wikipedia.org/wiki/Sampling_(signal_processing">Sampling rate</a> constants
|
||||
(use the number values directly, these are just for lookup)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#BITDEPTH">BITDEPTH</a></td>
|
||||
<td class="summary">Bit depth constants
|
||||
<td class="summary"><a href="https://en.wikipedia.org/wiki/Audio_bit_depth">Bit depth</a> constants
|
||||
(use the number values directly, these are just for lookup)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ENDIANNESS">ENDIANNESS</a></td>
|
||||
<td class="summary">Endianness constants</td>
|
||||
<td class="summary"><a href="https://en.wikipedia.org/wiki/Endianness">Endianness</a> constants</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Fields">Fields</a></h2>
|
||||
@ -94,6 +94,47 @@
|
||||
<td class="summary">Initialize the Sound instance.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.volume">self.volume</a></td>
|
||||
<td class="summary">The sound volume and gain all samples are multiplied with</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.envelope">self.envelope</a></td>
|
||||
<td class="summary">The <a href="https://en.wikipedia.org/wiki/Synthesizer#Attack_Deca
|
||||
y_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the sound amplitude
|
||||
(volume) over time</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.frequency">self.frequency</a></td>
|
||||
<td class="summary">The base and minimum frequencies of the tone generator and their slides</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.vibrato">self.vibrato</a></td>
|
||||
<td class="summary">A <a href="https://en.wikipedia.org/wiki/Vibrato">vibrato</a>-like amplitude
|
||||
modulation effect.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.change">self.change</a></td>
|
||||
<td class="summary">Changes the frequency mid-sound to create the characteristic
|
||||
"coin"-effect</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.duty">self.duty</a></td>
|
||||
<td class="summary">The <a href="https://en.wikipedia.org/wiki/Duty_cycle">duty</a> of the square
|
||||
waveform</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.phaser">self.phaser</a></td>
|
||||
<td class="summary">A simple <a href="https://en.wikipedia.org/wiki/Phaser_(effect">phaser</a> effect</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.lowpass">self.lowpass</a></td>
|
||||
<td class="summary">A <a href="https://en.wikipedia.org/wiki/Low-pass_filter">lowpass filter</a> effect</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.highpass">self.highpass</a></td>
|
||||
<td class="summary">A <a href="https://en.wikipedia.org/wiki/High-pass_filter">highpass filter</a> effect</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.volume.master">self.volume.master</a></td>
|
||||
<td class="summary">Master volume (<em>default</em> 0.5)</td>
|
||||
</tr>
|
||||
@ -118,19 +159,19 @@
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.envelope.attack">self.envelope.attack</a></td>
|
||||
<td class="summary">Attack time:
|
||||
Time the sound takes to reach its peak volume
|
||||
Time the sound takes to reach its peak amplitude
|
||||
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.envelope.sustain">self.envelope.sustain</a></td>
|
||||
<td class="summary">Sustain time:
|
||||
Time the sound stays on its peak volume
|
||||
Time the sound stays on its peak amplitude
|
||||
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.envelope.punch">self.envelope.punch</a></td>
|
||||
<td class="summary">Sustain punch:
|
||||
Amount by which the sound peak volume is increased at the start of the
|
||||
Amount by which the sound peak amplitude is increased at the start of the
|
||||
sustain time
|
||||
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
|
||||
</tr>
|
||||
@ -155,19 +196,19 @@
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.frequency.slide">self.frequency.slide</a></td>
|
||||
<td class="summary">Slide:
|
||||
Amount by which the frequency is increased or decreased through time
|
||||
Amount by which the frequency is increased or decreased over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.frequency.dslide">self.frequency.dslide</a></td>
|
||||
<td class="summary">Delta slide:
|
||||
Amount by which the slide is increased or decreased through time
|
||||
Amount by which the slide is increased or decreased over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.vibrato.depth">self.vibrato.depth</a></td>
|
||||
<td class="summary">Vibrato depth:
|
||||
Amount of vibrato-like amplitude (volume) modulation
|
||||
Amount of amplitude modulation
|
||||
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -203,7 +244,7 @@
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.duty.sweep">self.duty.sweep</a></td>
|
||||
<td class="summary">Duty sweep:
|
||||
Amount by which the square duty is increased or decreased through time
|
||||
Amount by which the square duty is increased or decreased over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -215,7 +256,7 @@
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#self.phaser.sweep">self.phaser.sweep</a></td>
|
||||
<td class="summary">Phaser sweep:
|
||||
Amount by which the phaser offset is increased or decreased through time
|
||||
Amount by which the phaser offset is increased or decreased over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -228,7 +269,7 @@
|
||||
<td class="name" nowrap><a href="#self.lowpass.sweep">self.lowpass.sweep</a></td>
|
||||
<td class="summary">Lowpass filter cutoff sweep:
|
||||
Amount by which the LP filter cutoff is increased or decreased
|
||||
through time
|
||||
over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -248,12 +289,12 @@
|
||||
<td class="name" nowrap><a href="#self.highpass.sweep">self.highpass.sweep</a></td>
|
||||
<td class="summary">Highpass filter cutoff sweep:
|
||||
Amount by which the HP filter cutoff is increased or decreased
|
||||
through time
|
||||
over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#sfxr.Sound:sanitizeParameters">sfxr.Sound:sanitizeParameters ()</a></td>
|
||||
<td class="summary">Clamp all parameters within sane ranges.</td>
|
||||
<td class="summary">Clamp all parameters within their sane ranges.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#sfxr.Sound:generate">sfxr.Sound:generate ([rate=44100[, depth=0]])</a></td>
|
||||
@ -330,7 +371,7 @@
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#sfxr.Sound:loadBinary">sfxr.Sound:loadBinary (f)</a></td>
|
||||
<td class="summary">Load the sound parameters from a file in the sfxr binary format
|
||||
(version 100, 101, 102)</td>
|
||||
(version 100-102)</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@ -378,7 +419,7 @@
|
||||
<strong>WAVEFORM</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Wave form constants
|
||||
<a href="https://en.wikipedia.org/wiki/Waveform">Waveform</a> constants
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
@ -407,7 +448,7 @@
|
||||
<strong>SAMPLERATE</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sample rate constants
|
||||
<a href="https://en.wikipedia.org/wiki/Sampling_(signal_processing">Sampling rate</a> constants
|
||||
(use the number values directly, these are just for lookup)
|
||||
|
||||
|
||||
@ -431,7 +472,7 @@
|
||||
<strong>BITDEPTH</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Bit depth constants
|
||||
<a href="https://en.wikipedia.org/wiki/Audio_bit_depth">Bit depth</a> constants
|
||||
(use the number values directly, these are just for lookup)
|
||||
|
||||
|
||||
@ -458,7 +499,7 @@
|
||||
<strong>ENDIANNESS</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Endianness constants
|
||||
<a href="https://en.wikipedia.org/wiki/Endianness">Endianness</a> constants
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
@ -515,6 +556,137 @@
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "self.volume"></a>
|
||||
<strong>self.volume</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
The sound volume and gain all samples are multiplied with
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "self.envelope"></a>
|
||||
<strong>self.envelope</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
The <a href="https://en.wikipedia.org/wiki/Synthesizer#Attack_Deca
|
||||
y_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the sound amplitude
|
||||
(volume) over time
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "self.frequency"></a>
|
||||
<strong>self.frequency</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
The base and minimum frequencies of the tone generator and their slides
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "self.vibrato"></a>
|
||||
<strong>self.vibrato</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
A <a href="https://en.wikipedia.org/wiki/Vibrato">vibrato</a>-like amplitude
|
||||
modulation effect.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "self.change"></a>
|
||||
<strong>self.change</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Changes the frequency mid-sound to create the characteristic
|
||||
"coin"-effect
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "self.duty"></a>
|
||||
<strong>self.duty</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
The <a href="https://en.wikipedia.org/wiki/Duty_cycle">duty</a> of the square
|
||||
waveform
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "self.phaser"></a>
|
||||
<strong>self.phaser</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
A simple <a href="https://en.wikipedia.org/wiki/Phaser_(effect">phaser</a> effect
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "self.lowpass"></a>
|
||||
<strong>self.lowpass</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
A <a href="https://en.wikipedia.org/wiki/Low-pass_filter">lowpass filter</a> effect
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "self.highpass"></a>
|
||||
<strong>self.highpass</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
A <a href="https://en.wikipedia.org/wiki/High-pass_filter">highpass filter</a> effect
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "self.volume.master"></a>
|
||||
@ -595,7 +767,7 @@
|
||||
</dt>
|
||||
<dd>
|
||||
Attack time:
|
||||
Time the sound takes to reach its peak volume
|
||||
Time the sound takes to reach its peak amplitude
|
||||
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)
|
||||
|
||||
|
||||
@ -611,7 +783,7 @@
|
||||
</dt>
|
||||
<dd>
|
||||
Sustain time:
|
||||
Time the sound stays on its peak volume
|
||||
Time the sound stays on its peak amplitude
|
||||
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)
|
||||
|
||||
|
||||
@ -627,7 +799,7 @@
|
||||
</dt>
|
||||
<dd>
|
||||
Sustain punch:
|
||||
Amount by which the sound peak volume is increased at the start of the
|
||||
Amount by which the sound peak amplitude is increased at the start of the
|
||||
sustain time
|
||||
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)
|
||||
|
||||
@ -692,7 +864,7 @@
|
||||
</dt>
|
||||
<dd>
|
||||
Slide:
|
||||
Amount by which the frequency is increased or decreased through time
|
||||
Amount by which the frequency is increased or decreased over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)
|
||||
|
||||
|
||||
@ -708,7 +880,7 @@
|
||||
</dt>
|
||||
<dd>
|
||||
Delta slide:
|
||||
Amount by which the slide is increased or decreased through time
|
||||
Amount by which the slide is increased or decreased over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)
|
||||
|
||||
|
||||
@ -724,7 +896,7 @@
|
||||
</dt>
|
||||
<dd>
|
||||
Vibrato depth:
|
||||
Amount of vibrato-like amplitude (volume) modulation
|
||||
Amount of amplitude modulation
|
||||
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)
|
||||
|
||||
|
||||
@ -820,7 +992,7 @@
|
||||
</dt>
|
||||
<dd>
|
||||
Duty sweep:
|
||||
Amount by which the square duty is increased or decreased through time
|
||||
Amount by which the square duty is increased or decreased over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)
|
||||
|
||||
|
||||
@ -852,7 +1024,7 @@
|
||||
</dt>
|
||||
<dd>
|
||||
Phaser sweep:
|
||||
Amount by which the phaser offset is increased or decreased through time
|
||||
Amount by which the phaser offset is increased or decreased over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)
|
||||
|
||||
|
||||
@ -885,7 +1057,7 @@
|
||||
<dd>
|
||||
Lowpass filter cutoff sweep:
|
||||
Amount by which the LP filter cutoff is increased or decreased
|
||||
through time
|
||||
over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)
|
||||
|
||||
|
||||
@ -935,7 +1107,7 @@
|
||||
<dd>
|
||||
Highpass filter cutoff sweep:
|
||||
Amount by which the HP filter cutoff is increased or decreased
|
||||
through time
|
||||
over time
|
||||
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)
|
||||
|
||||
|
||||
@ -950,7 +1122,7 @@
|
||||
<strong>sfxr.Sound:sanitizeParameters ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Clamp all parameters within sane ranges.
|
||||
Clamp all parameters within their sane ranges.
|
||||
|
||||
|
||||
|
||||
@ -971,7 +1143,7 @@
|
||||
<ul>
|
||||
<li><span class="parameter">rate</span>
|
||||
<span class="types"><a class="type" href="index.html#SAMPLERATE">SAMPLERATE</a></span>
|
||||
the sample rate
|
||||
the sampling rate
|
||||
(<em>default</em> 44100)
|
||||
</li>
|
||||
<li><span class="parameter">depth</span>
|
||||
@ -985,11 +1157,11 @@
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">function()</span></span>
|
||||
a generator that yields the sample data when called
|
||||
a generator that yields the next sample when called
|
||||
</ol>
|
||||
|
||||
<h3>Raises:</h3>
|
||||
"invalid sample rate: x", "invalid bit depth: x"
|
||||
"invalid sampling rate: x", "invalid bit depth: x"
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
@ -1014,14 +1186,14 @@
|
||||
<ul>
|
||||
<li><span class="parameter">rate</span>
|
||||
<span class="types"><a class="type" href="index.html#SAMPLERATE">SAMPLERATE</a></span>
|
||||
the sample rate
|
||||
the sampling rate
|
||||
(<em>default</em> 44100)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3>Raises:</h3>
|
||||
"invalid sample rate: x", "invalid bit depth: x"
|
||||
"invalid sampling rate: x", "invalid bit depth: x"
|
||||
|
||||
|
||||
|
||||
@ -1038,7 +1210,7 @@
|
||||
<ul>
|
||||
<li><span class="parameter">rate</span>
|
||||
<span class="types"><a class="type" href="index.html#SAMPLERATE">SAMPLERATE</a></span>
|
||||
the sample rate
|
||||
the sampling rate
|
||||
(<em>default</em> 44100)
|
||||
</li>
|
||||
<li><span class="parameter">depth</span>
|
||||
@ -1064,7 +1236,7 @@
|
||||
</ol>
|
||||
|
||||
<h3>Raises:</h3>
|
||||
"invalid sample rate: x", "invalid bit depth: x"
|
||||
"invalid sampling rate: x", "invalid bit depth: x"
|
||||
|
||||
|
||||
|
||||
@ -1081,7 +1253,7 @@
|
||||
<ul>
|
||||
<li><span class="parameter">rate</span>
|
||||
<span class="types"><a class="type" href="index.html#SAMPLERATE">SAMPLERATE</a></span>
|
||||
the sample rate
|
||||
the sampling rate
|
||||
(<em>default</em> 44100)
|
||||
</li>
|
||||
<li><span class="parameter">depth</span>
|
||||
@ -1107,7 +1279,7 @@
|
||||
</ol>
|
||||
|
||||
<h3>Raises:</h3>
|
||||
"invalid sample rate: x", "invalid bit depth: x", "invalid endianness: x"
|
||||
"invalid sampling rate: x", "invalid bit depth: x", "invalid endianness: x"
|
||||
|
||||
|
||||
|
||||
@ -1124,7 +1296,7 @@
|
||||
<ul>
|
||||
<li><span class="parameter">rate</span>
|
||||
<span class="types"><a class="type" href="index.html#SAMPLERATE">SAMPLERATE</a></span>
|
||||
the sample rate
|
||||
the sampling rate
|
||||
(<em>default</em> 44100)
|
||||
</li>
|
||||
<li><span class="parameter">depth</span>
|
||||
@ -1151,7 +1323,7 @@
|
||||
</ol>
|
||||
|
||||
<h3>Raises:</h3>
|
||||
"invalid sample rate: x", "invalid bit depth: x"
|
||||
"invalid sampling rate: x", "invalid bit depth: x"
|
||||
|
||||
|
||||
|
||||
@ -1380,7 +1552,7 @@
|
||||
</li>
|
||||
<li><span class="parameter">rate</span>
|
||||
<span class="types"><a class="type" href="index.html#SAMPLERATE">SAMPLERATE</a></span>
|
||||
the sample rate
|
||||
the sampling rate
|
||||
(<em>default</em> 44100)
|
||||
</li>
|
||||
<li><span class="parameter">depth</span>
|
||||
@ -1392,7 +1564,7 @@
|
||||
|
||||
|
||||
<h3>Raises:</h3>
|
||||
"invalid sample rate: x", "invalid bit depth: x"
|
||||
"invalid sampling rate: x", "invalid bit depth: x"
|
||||
|
||||
|
||||
|
||||
@ -1476,7 +1648,7 @@
|
||||
</dt>
|
||||
<dd>
|
||||
Load the sound parameters from a file in the sfxr binary format
|
||||
(version 100, 101, 102)
|
||||
(version 100-102)
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
@ -1502,7 +1674,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2016-03-05 19:36:51 </i>
|
||||
<i style="float:right;">Last updated 2016-03-05 20:16:35 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
||||
87
sfxr.lua
87
sfxr.lua
@ -31,7 +31,7 @@ local bit = bit32 or require("bit")
|
||||
--- The module version (SemVer)
|
||||
sfxr.VERSION = "0.0.2"
|
||||
|
||||
--- Wave form constants
|
||||
--- [Waveform](https://en.wikipedia.org/wiki/Waveform) constants
|
||||
-- @field SQUARE square wave (`= 0`)
|
||||
-- @field SAW saw wave (`= 1`)
|
||||
-- @field SINE sine wave (`= 2`)
|
||||
@ -47,7 +47,7 @@ sfxr.WAVEFORM = {
|
||||
[3] = 3
|
||||
}
|
||||
|
||||
--- Sample rate constants
|
||||
--- [Sampling rate](https://en.wikipedia.org/wiki/Sampling_(signal_processing)#Sampling_rate) constants
|
||||
-- (use the number values directly, these are just for lookup)
|
||||
-- @field 22050 22.05 kHz (`= 22050`)
|
||||
-- @field 44100 44.1 kHz (`= 44100`)
|
||||
@ -56,7 +56,7 @@ sfxr.SAMPLERATE = {
|
||||
[44100] = 44100, --- 44.1 kHz
|
||||
}
|
||||
|
||||
--- Bit depth constants
|
||||
--- [Bit depth](https://en.wikipedia.org/wiki/Audio_bit_depth) constants
|
||||
-- (use the number values directly, these are just for lookup)
|
||||
-- @field 0 floating point bit depth, -1 to 1 (`= 0`)
|
||||
-- @field 8 unsigned 8 bit, 0x00 to 0xFF (`= 8`)
|
||||
@ -67,7 +67,7 @@ sfxr.BITDEPTH = {
|
||||
[8] = 8
|
||||
}
|
||||
|
||||
--- Endianness constants
|
||||
--- [Endianness](https://en.wikipedia.org/wiki/Endianness) constants
|
||||
-- @field LITTLE little endian (`= 0`)
|
||||
-- @field BIG big endian (`= 1`)
|
||||
sfxr.ENDIANNESS = {
|
||||
@ -242,14 +242,29 @@ sfxr.Sound.__index = sfxr.Sound
|
||||
-- Called by @{sfxr.newSound|the constructor}.
|
||||
function sfxr.Sound:__init()
|
||||
-- Build tables to store the parameters in
|
||||
|
||||
--- The sound volume and gain all samples are multiplied with
|
||||
self.volume = {}
|
||||
--- The [ASD envelope](https://en.wikipedia.org/wiki/Synthesizer#Attack_Deca
|
||||
--y_Sustain_Release_.28ADSR.29_envelope) that controls the sound amplitude
|
||||
-- (volume) over time
|
||||
self.envelope = {}
|
||||
--- The base and minimum frequencies of the tone generator and their slides
|
||||
self.frequency = {}
|
||||
--- A [vibrato](https://en.wikipedia.org/wiki/Vibrato)-like amplitude
|
||||
-- modulation effect.
|
||||
self.vibrato = {}
|
||||
--- Changes the frequency mid-sound to create the characteristic
|
||||
-- "coin"-effect
|
||||
self.change = {}
|
||||
--- The [duty](https://en.wikipedia.org/wiki/Duty_cycle) of the square
|
||||
-- waveform
|
||||
self.duty = {}
|
||||
--- A simple [phaser](https://en.wikipedia.org/wiki/Phaser_(effect)) effect
|
||||
self.phaser = {}
|
||||
--- A [lowpass filter](https://en.wikipedia.org/wiki/Low-pass_filter) effect
|
||||
self.lowpass = {}
|
||||
--- A [highpass filter](https://en.wikipedia.org/wiki/High-pass_filter) effect
|
||||
self.highpass = {}
|
||||
|
||||
-- These are not affected by resetParameters()
|
||||
@ -274,15 +289,15 @@ function sfxr.Sound:resetParameters()
|
||||
self.waveform = sfxr.SQUARE
|
||||
|
||||
--- Attack time:
|
||||
-- Time the sound takes to reach its peak volume
|
||||
-- Time the sound takes to reach its peak amplitude
|
||||
-- (*default* 0.0, *min* 0.0, *max* 1.0)
|
||||
self.envelope.attack = 0.0
|
||||
--- Sustain time:
|
||||
-- Time the sound stays on its peak volume
|
||||
-- Time the sound stays on its peak amplitude
|
||||
-- (*default* 0.0, *min* 0.0, *max* 1.0)
|
||||
self.envelope.sustain = 0.3
|
||||
--- Sustain punch:
|
||||
-- Amount by which the sound peak volume is increased at the start of the
|
||||
-- Amount by which the sound peak amplitude is increased at the start of the
|
||||
-- sustain time
|
||||
-- (*default* 0.0, *min* 0.0, *max* 1.0)
|
||||
self.envelope.punch = 0.0
|
||||
@ -300,16 +315,16 @@ function sfxr.Sound:resetParameters()
|
||||
-- (*default* 0.0, *min* 0.0, *max* 1.0)
|
||||
self.frequency.min = 0.0
|
||||
--- Slide:
|
||||
-- Amount by which the frequency is increased or decreased through time
|
||||
-- Amount by which the frequency is increased or decreased over time
|
||||
-- (*default* 0.0, *min* -1.0, *max* 1.0)
|
||||
self.frequency.slide = 0.0
|
||||
--- Delta slide:
|
||||
-- Amount by which the slide is increased or decreased through time
|
||||
-- Amount by which the slide is increased or decreased over time
|
||||
-- (*default* 0.0, *min* -1.0, *max* 1.0)
|
||||
self.frequency.dslide = 0.0
|
||||
|
||||
--- Vibrato depth:
|
||||
-- Amount of vibrato-like amplitude (volume) modulation
|
||||
-- Amount of amplitude modulation
|
||||
-- (*default* 0.0, *min* 0.0, *max* 1.0)
|
||||
self.vibrato.depth = 0.0
|
||||
--- Vibrato speed:
|
||||
@ -335,7 +350,7 @@ function sfxr.Sound:resetParameters()
|
||||
-- (*default* 0.0, *min* 0.0, *max* 1.0)
|
||||
self.duty.ratio = 0.0
|
||||
--- Duty sweep:
|
||||
-- Amount by which the square duty is increased or decreased through time
|
||||
-- Amount by which the square duty is increased or decreased over time
|
||||
-- (*default* 0.0, *min* -1.0, *max* 1.0)
|
||||
self.duty.sweep = 0.0
|
||||
|
||||
@ -344,7 +359,7 @@ function sfxr.Sound:resetParameters()
|
||||
-- (*default* 0.0, *min* -1.0, *max* 1.0)
|
||||
self.phaser.offset = 0.0
|
||||
--- Phaser sweep:
|
||||
-- Amount by which the phaser offset is increased or decreased through time
|
||||
-- Amount by which the phaser offset is increased or decreased over time
|
||||
-- (*default* 0.0, *min* -1.0, *max* 1.0)
|
||||
self.phaser.sweep = 0.0
|
||||
|
||||
@ -354,7 +369,7 @@ function sfxr.Sound:resetParameters()
|
||||
self.lowpass.cutoff = 1.0
|
||||
--- Lowpass filter cutoff sweep:
|
||||
-- Amount by which the LP filter cutoff is increased or decreased
|
||||
-- through time
|
||||
-- over time
|
||||
-- (*default* 0.0, *min* -1.0, *max* 1.0)
|
||||
self.lowpass.sweep = 0.0
|
||||
--- Lowpass filter resonance:
|
||||
@ -368,12 +383,12 @@ function sfxr.Sound:resetParameters()
|
||||
self.highpass.cutoff = 0.0
|
||||
--- Highpass filter cutoff sweep:
|
||||
-- Amount by which the HP filter cutoff is increased or decreased
|
||||
-- through time
|
||||
-- over time
|
||||
-- (*default* 0.0, *min* -1.0, *max* 1.0)
|
||||
self.highpass.sweep = 0.0
|
||||
end
|
||||
|
||||
--- Clamp all parameters within sane ranges.
|
||||
--- Clamp all parameters within their sane ranges.
|
||||
function sfxr.Sound:sanitizeParameters()
|
||||
self.repeatspeed = clamp(self.repeatspeed, 0, 1)
|
||||
self.wavetype = clamp(self.wavetype, sfxr.SQUARE, sfxr.NOISE)
|
||||
@ -409,17 +424,17 @@ function sfxr.Sound:sanitizeParameters()
|
||||
end
|
||||
|
||||
--- Generate the sound and yield the sample data.
|
||||
-- @tparam[opt=44100] SAMPLERATE rate the sample rate
|
||||
-- @tparam[opt=44100] SAMPLERATE rate the sampling rate
|
||||
-- @tparam[opt=0] BITDEPTH depth the bit depth
|
||||
-- @treturn function() a generator that yields the sample data when called
|
||||
-- @treturn function() a generator that yields the next sample when called
|
||||
-- @usage for s in sound:generate(44100, 0) do
|
||||
-- -- do something with s
|
||||
-- end
|
||||
-- @raise "invalid sample rate: x", "invalid bit depth: x"
|
||||
-- @raise "invalid sampling rate: x", "invalid bit depth: x"
|
||||
function sfxr.Sound:generate(rate, depth)
|
||||
rate = rate or 44100
|
||||
depth = depth or 0
|
||||
assert(sfxr.SAMPLERATE[rate], "invalid sample rate: " .. tostring(rate))
|
||||
assert(sfxr.SAMPLERATE[rate], "invalid sampling rate: " .. tostring(rate))
|
||||
assert(sfxr.BITDEPTH[depth], "invalid bit depth: " .. tostring(depth))
|
||||
|
||||
-- Initialize all locals
|
||||
@ -691,11 +706,11 @@ end
|
||||
--- Get the maximum sample limit allowed by the current envelope.
|
||||
-- Does not take any other limits into account, so the returned count might be
|
||||
-- higher than samples actually generated. Still useful though.
|
||||
-- @tparam[opt=44100] SAMPLERATE rate the sample rate
|
||||
-- @raise "invalid sample rate: x", "invalid bit depth: x"
|
||||
-- @tparam[opt=44100] SAMPLERATE rate the sampling rate
|
||||
-- @raise "invalid sampling rate: x", "invalid bit depth: x"
|
||||
function sfxr.Sound:getEnvelopeLimit(rate)
|
||||
rate = rate or 44100
|
||||
assert(sfxr.SAMPLERATE[rate], "invalid sample rate: " .. tostring(rate))
|
||||
assert(sfxr.SAMPLERATE[rate], "invalid sampling rate: " .. tostring(rate))
|
||||
|
||||
local env_length = {
|
||||
self.envelope.attack^2 * 100000, --- attack
|
||||
@ -708,16 +723,16 @@ function sfxr.Sound:getEnvelopeLimit(rate)
|
||||
end
|
||||
|
||||
--- Generate the sound into a table.
|
||||
-- @tparam[opt=44100] SAMPLERATE rate the sample rate
|
||||
-- @tparam[opt=44100] SAMPLERATE rate the sampling rate
|
||||
-- @tparam[opt=0] BITDEPTH depth the bit depth
|
||||
-- @tparam[opt] {} tab the table to synthesize into
|
||||
-- @treturn {number,...} the table filled with sample data
|
||||
-- @treturn int the number of written samples (== #tab)
|
||||
-- @raise "invalid sample rate: x", "invalid bit depth: x"
|
||||
-- @raise "invalid sampling rate: x", "invalid bit depth: x"
|
||||
function sfxr.Sound:generateTable(rate, depth, tab)
|
||||
rate = rate or 44100
|
||||
depth = depth or 0
|
||||
assert(sfxr.SAMPLERATE[rate], "invalid sample rate: " .. tostring(rate))
|
||||
assert(sfxr.SAMPLERATE[rate], "invalid sampling rate: " .. tostring(rate))
|
||||
assert(sfxr.BITDEPTH[depth], "invalid bit depth: " .. tostring(depth))
|
||||
|
||||
-- this could really use table pre-allocation, but Lua doesn't provide that
|
||||
@ -731,16 +746,16 @@ function sfxr.Sound:generateTable(rate, depth, tab)
|
||||
end
|
||||
|
||||
--- Generate the sound to a binary string.
|
||||
-- @tparam[opt=44100] SAMPLERATE rate the sample rate
|
||||
-- @tparam[opt=44100] SAMPLERATE rate the sampling rate
|
||||
-- @tparam[opt=16] BITDEPTH depth the bit depth (may not be @{BITDEPTH|0})
|
||||
-- @tparam[opt=0] ENDIANNESS endianness the endianness (ignored when depth == 8)
|
||||
-- @treturn string a binary string of sample data
|
||||
-- @treturn int the number of written samples
|
||||
-- @raise "invalid sample rate: x", "invalid bit depth: x", "invalid endianness: x"
|
||||
-- @raise "invalid sampling rate: x", "invalid bit depth: x", "invalid endianness: x"
|
||||
function sfxr.Sound:generateString(rate, depth, endianness)
|
||||
rate = rate or 44100
|
||||
depth = depth or 16
|
||||
assert(sfxr.SAMPLERATE[rate], "invalid sample rate: " .. tostring(rate))
|
||||
assert(sfxr.SAMPLERATE[rate], "invalid sampling rate: " .. tostring(rate))
|
||||
assert(sfxr.BITDEPTH[depth] and depth ~= 0, "invalid bit depth: " .. tostring(depth))
|
||||
assert(sfxr.ENDIANNESS[endianness], "invalid endianness: " .. tostring(endianness))
|
||||
|
||||
@ -780,17 +795,17 @@ function sfxr.Sound:generateString(rate, depth, endianness)
|
||||
end
|
||||
|
||||
--- Synthesize the sound to a LÖVE SoundData instance.
|
||||
-- @tparam[opt=44100] SAMPLERATE rate the sample rate
|
||||
-- @tparam[opt=44100] SAMPLERATE rate the sampling rate
|
||||
-- @tparam[opt=0] BITDEPTH depth the bit depth
|
||||
-- @tparam[opt] love.sound.SoundData sounddata a SoundData instance (will be
|
||||
-- created if not passed)
|
||||
-- @treturn love.sound.SoundData a SoundData instance
|
||||
-- @treturn int the number of written samples
|
||||
-- @raise "invalid sample rate: x", "invalid bit depth: x"
|
||||
-- @raise "invalid sampling rate: x", "invalid bit depth: x"
|
||||
function sfxr.Sound:generateSoundData(rate, depth, sounddata)
|
||||
rate = rate or 44100
|
||||
depth = depth or 0
|
||||
assert(sfxr.SAMPLERATE[rate], "invalid sample rate: " .. tostring(rate))
|
||||
assert(sfxr.SAMPLERATE[rate], "invalid sampling rate: " .. tostring(rate))
|
||||
assert(sfxr.BITDEPTH[depth] and depth, "invalid bit depth: " .. tostring(depth))
|
||||
|
||||
local tab, count = self:generateTable(rate, depth)
|
||||
@ -1117,13 +1132,13 @@ end
|
||||
--- Generate and export the audio data to a PCM WAVE file.
|
||||
-- @tparam ?string|file|love.filesystem.File f a path or file in `wb`-mode
|
||||
-- (passed files will not be closed)
|
||||
-- @tparam[opt=44100] SAMPLERATE rate the sample rate
|
||||
-- @tparam[opt=44100] SAMPLERATE rate the sampling rate
|
||||
-- @tparam[opt=0] BITDEPTH depth the bit depth
|
||||
-- @raise "invalid sample rate: x", "invalid bit depth: x"
|
||||
-- @raise "invalid sampling rate: x", "invalid bit depth: x"
|
||||
function sfxr.Sound:exportWAV(f, rate, depth)
|
||||
rate = rate or 44100
|
||||
depth = depth or 16
|
||||
assert(sfxr.SAMPLERATE[rate], "invalid sample rate: " .. tostring(rate))
|
||||
assert(sfxr.SAMPLERATE[rate], "invalid sampling rate: " .. tostring(rate))
|
||||
assert(sfxr.BITDEPTH[depth] and depth ~= 0, "invalid bit depth: " .. tostring(depth))
|
||||
|
||||
local close = false
|
||||
@ -1185,7 +1200,7 @@ function sfxr.Sound:exportWAV(f, rate, depth)
|
||||
w32(16) -- chunk size
|
||||
w16(1) -- compression code (1 = PCM)
|
||||
w16(1) -- channel number
|
||||
w32(freq) -- sample rate
|
||||
w32(freq) -- sampling rate
|
||||
w32(freq * bits / 8) -- bytes per second
|
||||
w16(bits / 8) -- block alignment
|
||||
w16(bits) -- bits per sample
|
||||
@ -1369,7 +1384,7 @@ function sfxr.Sound:saveBinary(f)
|
||||
end
|
||||
|
||||
--- Load the sound parameters from a file in the sfxr binary format
|
||||
-- (version 100, 101, 102)
|
||||
-- (version 100-102)
|
||||
-- @tparam ?string|file|love.filesystem.File f a path or file in `rb`-mode
|
||||
-- (passed files will not be closed)
|
||||
-- @raise "incompatible version: x", "unexpected file length"
|
||||
|
||||
Loading…
Reference in New Issue
Block a user