library-mirrors/sfxr.lua
1
0
Fork 0
mirror of https://github.com/nucular/sfxrlua.git synced 2024-12-05 11:34:21 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Tweak documentation some more

Browse Source
This commit is contained in:
nucular 2016-03-05 21:41:25 +01:00
parent e4fcde3227
commit 1bd524489e
4 changed files with 112 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -19,7 +19,7 @@ by the demo. A move to a new GUI framework is pending.
Example usage
-------------
These examples should play a randomly generated sound.
The following code examples demonstrate how to play a randomly generated sound:
With [LÖVE](http://love2d.org):
```lua
@ -28,7 +28,9 @@ local sfxr = require("sfxr")
function love.load()
local sound = sfxr.newSound()
sound:randomize()
sound:play()
local sounddata = sound:generateSoundData()
local source = love.audio.newSource(sounddata)
source:play()
end
```

65
doc/api/sfxr.html
View File

@ -33,17 +33,17 @@
<li><a href="#Constants">Constants</a></li>
<li><a href="#Class_Sound">Class Sound </a></li>
<li><a href="#Parameters">Parameters</a></li>
<li><a href="#Parameters_envelope">Parameters.envelope</a></li>
<li><a href="#Parameters_frequency">Parameters.frequency</a></li>
<li><a href="#Parameters_vibrato">Parameters.vibrato</a></li>
<li><a href="#Parameters_change">Parameters.change</a></li>
<li><a href="#Parameters_duty">Parameters.duty</a></li>
<li><a href="#Parameters_phaser">Parameters.phaser</a></li>
<li><a href="#Parameters_lowpass">Parameters.lowpass</a></li>
<li><a href="#Parameters_highpass">Parameters.highpass</a></li>
<li><a href="#Parameters_volume">Parameters.volume</a></li>
<li><a href="#ParametersEnvelope">ParametersEnvelope</a></li>
<li><a href="#ParametersFrequency">ParametersFrequency</a></li>
<li><a href="#ParametersVibrato">ParametersVibrato</a></li>
<li><a href="#ParametersChange">ParametersChange</a></li>
<li><a href="#ParametersDuty">ParametersDuty</a></li>
<li><a href="#ParametersPhaser">ParametersPhaser</a></li>
<li><a href="#ParametersLowpass">ParametersLowpass</a></li>
<li><a href="#ParametersHighpass">ParametersHighpass</a></li>
<li><a href="#ParametersVolume">ParametersVolume</a></li>
<li><a href="#Randomization">Randomization</a></li>
<li><a href="#SavingLoading">SavingLoading</a></li>
<li><a href="#SavingAndLoading">SavingAndLoading</a></li>
</ul>
@ -57,7 +57,8 @@
<div id="content">
<h1>Module <code>sfxr</code></h1>
<p>A port of the sfxr sound effect synthesizer to Lua</p>
<p>A port of the sfxr sound effect synthesizer to pure Lua, designed to be used
together with the <em>awesome</em> <a href="https://love2d.org">LÖVE</a> game framework.</p>
<p>
</p>
@ -151,7 +152,7 @@
<td class="summary">The base <a href="../index.html#WAVEFORM">waveform</a> (<em>default</em> <a href="../index.html#WAVEFORM">SQUARE</a>)</td>
</tr>
</table>
<h2><a href="#Parameters_envelope">Parameters.envelope</a></h2>
<h2><a href="#ParametersEnvelope">ParametersEnvelope</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.envelope">self.envelope</a></td>
@ -185,7 +186,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr>
</table>
<h2><a href="#Parameters_frequency">Parameters.frequency</a></h2>
<h2><a href="#ParametersFrequency">ParametersFrequency</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.frequency">self.frequency</a></td>
@ -217,7 +218,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
</tr>
</table>
<h2><a href="#Parameters_vibrato">Parameters.vibrato</a></h2>
<h2><a href="#ParametersVibrato">ParametersVibrato</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.vibrato">self.vibrato</a></td>
@ -243,7 +244,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr>
</table>
<h2><a href="#Parameters_change">Parameters.change</a></h2>
<h2><a href="#ParametersChange">ParametersChange</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.change">self.change</a></td>
@ -263,7 +264,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr>
</table>
<h2><a href="#Parameters_duty">Parameters.duty</a></h2>
<h2><a href="#ParametersDuty">ParametersDuty</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.duty">self.duty</a></td>
@ -283,7 +284,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
</tr>
</table>
<h2><a href="#Parameters_phaser">Parameters.phaser</a></h2>
<h2><a href="#ParametersPhaser">ParametersPhaser</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.phaser">self.phaser</a></td>
@ -303,7 +304,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
</tr>
</table>
<h2><a href="#Parameters_lowpass">Parameters.lowpass</a></h2>
<h2><a href="#ParametersLowpass">ParametersLowpass</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.lowpass">self.lowpass</a></td>
@ -331,7 +332,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr>
</table>
<h2><a href="#Parameters_highpass">Parameters.highpass</a></h2>
<h2><a href="#ParametersHighpass">ParametersHighpass</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.highpass">self.highpass</a></td>
@ -352,7 +353,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
</tr>
</table>
<h2><a href="#Parameters_volume">Parameters.volume</a></h2>
<h2><a href="#ParametersVolume">ParametersVolume</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.volume.master">self.volume.master</a></td>
@ -402,7 +403,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
<td class="summary">Randomize all sound parameters to generate a "blip" sound</td>
</tr>
</table>
<h2><a href="#SavingLoading">SavingLoading</a></h2>
<h2><a href="#SavingAndLoading">SavingAndLoading</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#sfxr.Sound:exportWAV">sfxr.Sound:exportWAV (f[, rate=44100[, depth=0]])</a></td>
@ -895,7 +896,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
</dl>
<h2 class="section-header "><a name="Parameters_envelope"></a>Parameters.envelope</h2>
<h2 class="section-header "><a name="ParametersEnvelope"></a>ParametersEnvelope</h2>
<dl class="function">
<dt>
@ -980,7 +981,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
</dl>
<h2 class="section-header "><a name="Parameters_frequency"></a>Parameters.frequency</h2>
<h2 class="section-header "><a name="ParametersFrequency"></a>ParametersFrequency</h2>
<dl class="function">
<dt>
@ -1063,7 +1064,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
</dl>
<h2 class="section-header "><a name="Parameters_vibrato"></a>Parameters.vibrato</h2>
<h2 class="section-header "><a name="ParametersVibrato"></a>ParametersVibrato</h2>
<dl class="function">
<dt>
@ -1130,7 +1131,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
</dl>
<h2 class="section-header "><a name="Parameters_change"></a>Parameters.change</h2>
<h2 class="section-header "><a name="ParametersChange"></a>ParametersChange</h2>
<dl class="function">
<dt>
@ -1181,7 +1182,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
</dl>
<h2 class="section-header "><a name="Parameters_duty"></a>Parameters.duty</h2>
<h2 class="section-header "><a name="ParametersDuty"></a>ParametersDuty</h2>
<dl class="function">
<dt>
@ -1232,7 +1233,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
</dl>
<h2 class="section-header "><a name="Parameters_phaser"></a>Parameters.phaser</h2>
<h2 class="section-header "><a name="ParametersPhaser"></a>ParametersPhaser</h2>
<dl class="function">
<dt>
@ -1283,7 +1284,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
</dl>
<h2 class="section-header "><a name="Parameters_lowpass"></a>Parameters.lowpass</h2>
<h2 class="section-header "><a name="ParametersLowpass"></a>ParametersLowpass</h2>
<dl class="function">
<dt>
@ -1352,7 +1353,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
</dl>
<h2 class="section-header "><a name="Parameters_highpass"></a>Parameters.highpass</h2>
<h2 class="section-header "><a name="ParametersHighpass"></a>ParametersHighpass</h2>
<dl class="function">
<dt>
@ -1404,7 +1405,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
</dl>
<h2 class="section-header "><a name="Parameters_volume"></a>Parameters.volume</h2>
<h2 class="section-header "><a name="ParametersVolume"></a>ParametersVolume</h2>
<dl class="function">
<dt>
@ -1647,7 +1648,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
</dl>
<h2 class="section-header "><a name="SavingLoading"></a>SavingLoading</h2>
<h2 class="section-header "><a name="SavingAndLoading"></a>SavingAndLoading</h2>
<dl class="function">
<dt>
@ -1789,7 +1790,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</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 21:02:39 </i>
<i style="float:right;">Last updated 2016-03-05 21:40:35 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

65
doc/index.html
View File

@ -33,17 +33,17 @@
<li><a href="#Constants">Constants</a></li>
<li><a href="#Class_Sound">Class Sound </a></li>
<li><a href="#Parameters">Parameters</a></li>
<li><a href="#Parameters_envelope">Parameters.envelope</a></li>
<li><a href="#Parameters_frequency">Parameters.frequency</a></li>
<li><a href="#Parameters_vibrato">Parameters.vibrato</a></li>
<li><a href="#Parameters_change">Parameters.change</a></li>
<li><a href="#Parameters_duty">Parameters.duty</a></li>
<li><a href="#Parameters_phaser">Parameters.phaser</a></li>
<li><a href="#Parameters_lowpass">Parameters.lowpass</a></li>
<li><a href="#Parameters_highpass">Parameters.highpass</a></li>
<li><a href="#Parameters_volume">Parameters.volume</a></li>
<li><a href="#ParametersEnvelope">ParametersEnvelope</a></li>
<li><a href="#ParametersFrequency">ParametersFrequency</a></li>
<li><a href="#ParametersVibrato">ParametersVibrato</a></li>
<li><a href="#ParametersChange">ParametersChange</a></li>
<li><a href="#ParametersDuty">ParametersDuty</a></li>
<li><a href="#ParametersPhaser">ParametersPhaser</a></li>
<li><a href="#ParametersLowpass">ParametersLowpass</a></li>
<li><a href="#ParametersHighpass">ParametersHighpass</a></li>
<li><a href="#ParametersVolume">ParametersVolume</a></li>
<li><a href="#Randomization">Randomization</a></li>
<li><a href="#SavingLoading">SavingLoading</a></li>
<li><a href="#SavingAndLoading">SavingAndLoading</a></li>
</ul>
@ -57,7 +57,8 @@
<div id="content">
<h1>Module <code>sfxr</code></h1>
<p>A port of the sfxr sound effect synthesizer to Lua</p>
<p>A port of the sfxr sound effect synthesizer to pure Lua, designed to be used
together with the <em>awesome</em> <a href="https://love2d.org">LÖVE</a> game framework.</p>
<p>
</p>
@ -151,7 +152,7 @@
<td class="summary">The base <a href="index.html#WAVEFORM">waveform</a> (<em>default</em> <a href="index.html#WAVEFORM">SQUARE</a>)</td>
</tr>
</table>
<h2><a href="#Parameters_envelope">Parameters.envelope</a></h2>
<h2><a href="#ParametersEnvelope">ParametersEnvelope</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.envelope">self.envelope</a></td>
@ -185,7 +186,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr>
</table>
<h2><a href="#Parameters_frequency">Parameters.frequency</a></h2>
<h2><a href="#ParametersFrequency">ParametersFrequency</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.frequency">self.frequency</a></td>
@ -217,7 +218,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
</tr>
</table>
<h2><a href="#Parameters_vibrato">Parameters.vibrato</a></h2>
<h2><a href="#ParametersVibrato">ParametersVibrato</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.vibrato">self.vibrato</a></td>
@ -243,7 +244,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr>
</table>
<h2><a href="#Parameters_change">Parameters.change</a></h2>
<h2><a href="#ParametersChange">ParametersChange</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.change">self.change</a></td>
@ -263,7 +264,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr>
</table>
<h2><a href="#Parameters_duty">Parameters.duty</a></h2>
<h2><a href="#ParametersDuty">ParametersDuty</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.duty">self.duty</a></td>
@ -283,7 +284,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
</tr>
</table>
<h2><a href="#Parameters_phaser">Parameters.phaser</a></h2>
<h2><a href="#ParametersPhaser">ParametersPhaser</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.phaser">self.phaser</a></td>
@ -303,7 +304,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
</tr>
</table>
<h2><a href="#Parameters_lowpass">Parameters.lowpass</a></h2>
<h2><a href="#ParametersLowpass">ParametersLowpass</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.lowpass">self.lowpass</a></td>
@ -331,7 +332,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> 0.0, <em>max</em> 1.0)</td>
</tr>
</table>
<h2><a href="#Parameters_highpass">Parameters.highpass</a></h2>
<h2><a href="#ParametersHighpass">ParametersHighpass</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.highpass">self.highpass</a></td>
@ -352,7 +353,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
(<em>default</em> 0.0, <em>min</em> -1.0, <em>max</em> 1.0)</td>
</tr>
</table>
<h2><a href="#Parameters_volume">Parameters.volume</a></h2>
<h2><a href="#ParametersVolume">ParametersVolume</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#self.volume.master">self.volume.master</a></td>
@ -402,7 +403,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
<td class="summary">Randomize all sound parameters to generate a "blip" sound</td>
</tr>
</table>
<h2><a href="#SavingLoading">SavingLoading</a></h2>
<h2><a href="#SavingAndLoading">SavingAndLoading</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#sfxr.Sound:exportWAV">sfxr.Sound:exportWAV (f[, rate=44100[, depth=0]])</a></td>
@ -895,7 +896,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
</dl>
<h2 class="section-header "><a name="Parameters_envelope"></a>Parameters.envelope</h2>
<h2 class="section-header "><a name="ParametersEnvelope"></a>ParametersEnvelope</h2>
<dl class="function">
<dt>
@ -980,7 +981,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
</dl>
<h2 class="section-header "><a name="Parameters_frequency"></a>Parameters.frequency</h2>
<h2 class="section-header "><a name="ParametersFrequency"></a>ParametersFrequency</h2>
<dl class="function">
<dt>
@ -1063,7 +1064,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
</dl>
<h2 class="section-header "><a name="Parameters_vibrato"></a>Parameters.vibrato</h2>
<h2 class="section-header "><a name="ParametersVibrato"></a>ParametersVibrato</h2>
<dl class="function">
<dt>
@ -1130,7 +1131,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
</dl>
<h2 class="section-header "><a name="Parameters_change"></a>Parameters.change</h2>
<h2 class="section-header "><a name="ParametersChange"></a>ParametersChange</h2>
<dl class="function">
<dt>
@ -1181,7 +1182,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
</dl>
<h2 class="section-header "><a name="Parameters_duty"></a>Parameters.duty</h2>
<h2 class="section-header "><a name="ParametersDuty"></a>ParametersDuty</h2>
<dl class="function">
<dt>
@ -1232,7 +1233,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
</dl>
<h2 class="section-header "><a name="Parameters_phaser"></a>Parameters.phaser</h2>
<h2 class="section-header "><a name="ParametersPhaser"></a>ParametersPhaser</h2>
<dl class="function">
<dt>
@ -1283,7 +1284,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
</dl>
<h2 class="section-header "><a name="Parameters_lowpass"></a>Parameters.lowpass</h2>
<h2 class="section-header "><a name="ParametersLowpass"></a>ParametersLowpass</h2>
<dl class="function">
<dt>
@ -1352,7 +1353,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
</dl>
<h2 class="section-header "><a name="Parameters_highpass"></a>Parameters.highpass</h2>
<h2 class="section-header "><a name="ParametersHighpass"></a>ParametersHighpass</h2>
<dl class="function">
<dt>
@ -1404,7 +1405,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
</dl>
<h2 class="section-header "><a name="Parameters_volume"></a>Parameters.volume</h2>
<h2 class="section-header "><a name="ParametersVolume"></a>ParametersVolume</h2>
<dl class="function">
<dt>
@ -1647,7 +1648,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</dd>
</dl>
<h2 class="section-header "><a name="SavingLoading"></a>SavingLoading</h2>
<h2 class="section-header "><a name="SavingAndLoading"></a>SavingAndLoading</h2>
<dl class="function">
<dt>
@ -1789,7 +1790,7 @@ Decay_Sustain_Release_.28ADSR.29_envelope">ASD envelope</a> that controls the so
</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 21:02:39 </i>
<i style="float:right;">Last updated 2016-03-05 21:40:35 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

90
sfxr.lua
View File

@ -21,7 +21,10 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
]]--
--- A port of the sfxr sound effect synthesizer to Lua
--[[--
A port of the sfxr sound effect synthesizer to pure Lua, designed to be used
together with the *awesome* [LÖVE](https://love2d.org) game framework.
]]--
-- @module sfxr
local sfxr = {}
local bit = bit32 or require("bit")
@ -85,7 +88,6 @@ sfxr.ENDIANNESS = {
-- Utilities
--- Truncate a number to an unsigned integer.
-- @within Locals
-- @tparam number n a (signed) number
-- @treturn int the number, truncated and unsigned
local function trunc(n)
@ -97,7 +99,6 @@ local function trunc(n)
end
--- Set the random seed and initializes the generator.
-- @within Locals
-- @tparam number seed the random seed
local function setseed(seed)
math.randomseed(seed)
@ -107,7 +108,6 @@ local function setseed(seed)
end
--- Return a random number between low and high.
-- @within Locals
-- @tparam number low the lower bound
-- @tparam number high the upper bound
-- @treturn number a random number where `low < n < high`
@ -119,7 +119,6 @@ end
-- w = 1: uniform distribution
-- w = n: false is n times as likely as true
-- Note: n < 0 do not work, use `not maybe(w)` instead
-- @within Locals
-- @tparam[opt=1] number w the weight towards false
-- @treturn bool a random boolean
local function maybe(w)
@ -127,7 +126,6 @@ local function maybe(w)
end
--- Clamp n between min and max.
-- @within Locals
-- @tparam number n the number
-- @tparam number min the lower bound
-- @tparam number max the upper bound
@ -137,7 +135,6 @@ local function clamp(n, min, max)
end
--- Copy a table (shallow) or a primitive.
-- @within Locals
-- @param t a table or primitive
-- @return a copy of t
local function shallowcopy(t)
@ -153,7 +150,6 @@ local function shallowcopy(t)
end
--- Recursively merge table t2 into t1.
-- @within Locals
-- @tparam tab t1 a table
-- @tparam tab t2 a table to merge into t1
-- @treturn tab t1
@ -174,7 +170,6 @@ end
--- Pack a number into a IEEE754 32-bit big-endian floating point binary string.
-- [source](https://stackoverflow.com/questions/14416734/)
-- @within Locals
-- @tparam number number a number
-- @treturn string a binary string
local function packIEEE754(number)
@ -214,7 +209,6 @@ end
--- Unpack a IEEE754 32-bit big-endian floating point string to a number.
-- [source](https://stackoverflow.com/questions/14416734/)
-- @within Locals
-- @tparam string packed a binary string
-- @treturn number a number
local function unpackIEEE754(packed)
@ -263,35 +257,35 @@ function sfxr.Sound:__init()
--- **The [ASD envelope](https://en.wikipedia.org/wiki/Synthesizer#Attack_
--Decay_Sustain_Release_.28ADSR.29_envelope) that controls the sound
-- amplitude (volume) over time**
-- @within Parameters.envelope
-- @within ParametersEnvelope
self.envelope = {}
--- **The base and minimum frequencies of the tone generator and their
-- slides**
-- @within Parameters.frequency
-- @within ParametersFrequency
self.frequency = {}
--- **A [vibrato](https://en.wikipedia.org/wiki/Vibrato)-like amplitude
-- modulation effect**
-- @within Parameters.vibrato
-- @within ParametersVibrato
self.vibrato = {}
--- **Changes the frequency mid-sound to create a characteristic
-- "coin"-effect**
-- @within Parameters.change
-- @within ParametersChange
self.change = {}
--- **The [duty](https://en.wikipedia.org/wiki/Duty_cycle) of the square
-- waveform**
-- @within Parameters.duty
-- @within ParametersDuty
self.duty = {}
--- **A simple [phaser](https://en.wikipedia.org/wiki/Phaser_(effect))
-- effect**
-- @within Parameters.phaser
-- @within ParametersPhaser
self.phaser = {}
--- **A [lowpass filter](https://en.wikipedia.org/wiki/Low-pass_filter)
-- effect**
-- @within Parameters.lowpass
-- @within ParametersLowpass
self.lowpass = {}
--- **A [highpass filter](https://en.wikipedia.org/wiki/High-pass_filter)
-- effect**
-- @within Parameters.highpass
-- @within ParametersHighpass
self.highpass = {}
-- These are not affected by resetParameters()
@ -300,10 +294,10 @@ function sfxr.Sound:__init()
-- @within Parameters
self.supersampling = 8
--- Master volume (*default* 0.5)
-- @within Parameters.volume
-- @within ParametersVolume
self.volume.master = 0.5
--- Additional gain (*default* 0.5)
-- @within Parameters.volume
-- @within ParametersVolume
self.volume.sound = 0.5
self:resetParameters()
@ -325,122 +319,122 @@ function sfxr.Sound:resetParameters()
--- Attack time:
-- Time the sound takes to reach its peak amplitude
-- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within Parameters.envelope
-- @within ParametersEnvelope
self.envelope.attack = 0.0
--- Sustain time:
-- Time the sound stays on its peak amplitude
-- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within Parameters.envelope
-- @within ParametersEnvelope
self.envelope.sustain = 0.3
--- Sustain punch:
-- 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)
-- @within Parameters.envelope
-- @within ParametersEnvelope
self.envelope.punch = 0.0
--- Decay time:
-- Time the sound takes to decay after its sustain time
-- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within Parameters.envelope
-- @within ParametersEnvelope
self.envelope.decay = 0.4
--- Start frequency:
-- Base tone of the sound, before sliding
-- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within Parameters.frequency
-- @within ParametersFrequency
self.frequency.start = 0.3
--- Min frequency:
-- Tone below which the sound will get cut off
-- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within Parameters.frequency
-- @within ParametersFrequency
self.frequency.min = 0.0
--- Slide:
-- Amount by which the frequency is increased or decreased over time
-- (*default* 0.0, *min* -1.0, *max* 1.0)
-- @within Parameters.frequency
-- @within ParametersFrequency
self.frequency.slide = 0.0
--- Delta slide:
-- Amount by which the slide is increased or decreased over time
-- (*default* 0.0, *min* -1.0, *max* 1.0)
-- @within Parameters.frequency
-- @within ParametersFrequency
self.frequency.dslide = 0.0
--- Vibrato depth:
-- Amount of amplitude modulation
-- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within Parameters.vibrato
-- @within ParametersVibrato
self.vibrato.depth = 0.0
--- Vibrato speed:
-- Oscillation speed of the vibrato
-- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within Parameters.vibrato
-- @within ParametersVibrato
self.vibrato.speed = 0.0
--- Vibrato delay:
-- Unused and unimplemented
-- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within Parameters.vibrato
-- @within ParametersVibrato
self.vibrato.delay = 0.0
--- Change amount:
-- Amount by which the frequency is changed mid-sound
-- (*default* 0.0, *min* -1.0, *max* 1.0)
-- @within Parameters.change
-- @within ParametersChange
self.change.amount = 0.0
--- Change speed:
-- Time before the frequency change happens
-- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within Parameters.change
-- @within ParametersChange
self.change.speed = 0.0
--- Square duty:
-- Width of the square wave pulse cycle (doesn't affect other waveforms)
-- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within Parameters.duty
-- @within ParametersDuty
self.duty.ratio = 0.0
--- Duty sweep:
-- Amount by which the square duty is increased or decreased over time
-- (*default* 0.0, *min* -1.0, *max* 1.0)
-- @within Parameters.duty
-- @within ParametersDuty
self.duty.sweep = 0.0
--- Phaser offset:
-- Amount by which the phaser signal is offset from the sound
-- (*default* 0.0, *min* -1.0, *max* 1.0)
-- @within Parameters.phaser
-- @within ParametersPhaser
self.phaser.offset = 0.0
--- Phaser sweep:
-- Amount by which the phaser offset is increased or decreased over time
-- (*default* 0.0, *min* -1.0, *max* 1.0)
-- @within Parameters.phaser
-- @within ParametersPhaser
self.phaser.sweep = 0.0
--- Lowpass filter cutoff:
-- Lower bound for frequencies allowed to pass through this filter
-- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within Parameters.lowpass
-- @within ParametersLowpass
self.lowpass.cutoff = 1.0
--- Lowpass filter cutoff sweep:
-- Amount by which the LP filter cutoff is increased or decreased
-- over time
-- (*default* 0.0, *min* -1.0, *max* 1.0)
-- @within Parameters.lowpass
-- @within ParametersLowpass
self.lowpass.sweep = 0.0
--- Lowpass filter resonance:
-- Amount by which certain resonant frequencies near the cutoff are
-- increased
-- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within Parameters.lowpass
-- @within ParametersLowpass
self.lowpass.resonance = 0.0
--- Highpass filter cutoff:
-- Upper bound for frequencies allowed to pass through this filter
-- (*default* 0.0, *min* 0.0, *max* 1.0)
-- @within Parameters.highpass
-- @within ParametersHighpass
self.highpass.cutoff = 0.0
--- Highpass filter cutoff sweep:
-- Amount by which the HP filter cutoff is increased or decreased
-- over time
-- (*default* 0.0, *min* -1.0, *max* 1.0)
-- @within Parameters.highpass
-- @within ParametersHighpass
self.highpass.sweep = 0.0
end
@ -600,7 +594,7 @@ function sfxr.Sound:generate(rate, depth)
if fperiod > maxperiod then
fperiod = maxperiod
-- XXX: Fail if the minimum frequency is too small
-- Fail if the minimum frequency is too small
if (self.frequency.min > 0) then
return nil
end
@ -1195,7 +1189,7 @@ function sfxr.Sound:randomBlip(seed)
end
--- Generate and export the audio data to a PCM WAVE file.
-- @within SavingLoading
-- @within SavingAndLoading
-- @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 sampling rate
@ -1304,7 +1298,7 @@ function sfxr.Sound:exportWAV(f, rate, depth)
end
--- Save the sound parameters to a file as a Lua table
-- @within SavingLoading
-- @within SavingAndLoading
-- @tparam ?string|file|love.filesystem.File f a path or file in `w`-mode
-- (passed files will not be closed)
-- @tparam[opt=true] bool minify whether to minify the output or not
@ -1363,7 +1357,7 @@ function sfxr.Sound:save(f, minify)
end
--- Load the sound parameters from a file containing a Lua table
-- @within SavingLoading
-- @within SavingAndLoading
-- @tparam ?string|file|love.filesystem.File f a path or file in `r`-mode
-- (passed files will not be closed)
-- @raise "incompatible version: x.x.x"
@ -1395,7 +1389,7 @@ function sfxr.Sound:load(f)
end
--- Save the sound parameters to a file in the sfxr binary format (version 102)
-- @within SavingLoading
-- @within SavingAndLoading
-- @tparam ?string|file|love.filesystem.File f a path or file in `wb`-mode
-- (passed files will not be closed)
function sfxr.Sound:saveBinary(f)
@ -1454,7 +1448,7 @@ end
--- Load the sound parameters from a file in the sfxr binary format
-- (version 100-102)
-- @within SavingLoading
-- @within SavingAndLoading
-- @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"