blob: 46bea504785d08ba25b6beb0fe51aafe8a2842ea (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Melisma modules</title>
<link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<p><a href="/melisma-modules">Back to repository</a></p>
<br/>
<h1>Melisma modules</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
</ul>
<h2>Classes</h2>
<ul class="nowrap">
<li><a href="../classes/buffer.html">buffer</a></li>
<li><a href="../classes/delay.html">delay</a></li>
<li><strong>gain</strong></li>
<li><a href="../classes/interp.html">interp</a></li>
<li><a href="../classes/ladspa.html">ladspa</a></li>
<li><a href="../classes/mixer.html">mixer</a></li>
<li><a href="../classes/nullsink.html">nullsink</a></li>
<li><a href="../classes/oscil.html">oscil</a></li>
<li><a href="../classes/pan.html">pan</a></li>
<li><a href="../classes/playback.html">playback</a></li>
<li><a href="../classes/sample.html">sample</a></li>
<li><a href="../classes/serial.html">serial</a></li>
<li><a href="../classes/timer.html">timer</a></li>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/biquad.html">biquad</a></li>
<li><a href="../modules/expression.html">expression</a></li>
<li><a href="../modules/fs.html">fs</a></li>
<li><a href="../modules/keycallback.html">keycallback</a></li>
<li><a href="../modules/udp.html">udp</a></li>
</ul>
</div>
<div id="content">
<h1>Class <code>gain</code></h1>
<p>Apply gain to signals.</p>
<p>
<pre>
<span class="keyword">local</span> mgain = <span class="global">require</span> <span class="string">'melisma.gain'</span>
<span class="comment">-- Interprets <code>cntl</code> as decibels and applies it to <code>input</code>
</span><span class="keyword">local</span> input = ...
<span class="keyword">local</span> cntl = ...
<span class="keyword">local</span> gain = mgain.<span class="function-name">db</span>(input,cntl)
</pre>
</p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#gain.db">gain.db(input, gain)</a></td>
<td class="summary">Creates a decibel gain unit.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#gain.linear">gain.linear(input, gain)</a></td>
<td class="summary">Creates a linear gain unit.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
Methods
<dl class="function">
<dt>
<a name = "gain.db"></a>
<strong>gain.db(input, gain)</strong>
</dt>
<dd>
Creates a decibel gain unit.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">input</span>
<span class="types"><span class="type">channel</span></span>
Input signal.
</li>
<li><span class="parameter">gain</span>
<span class="types"><span class="type">number</span> or <span class="type">channel</span></span>
Constant gain in decibels or a controlling signal.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/gain.html#">gain</a></span>
The newly created gain unit.
</ol>
</dd>
<dt>
<a name = "gain.linear"></a>
<strong>gain.linear(input, gain)</strong>
</dt>
<dd>
Creates a linear gain unit.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">input</span>
<span class="types"><span class="type">channel</span></span>
Input signal.
</li>
<li><span class="parameter">gain</span>
<span class="types"><span class="type">number</span> or <span class="type">channel</span></span>
Constant gain or a controlling signal.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/gain.html#">gain</a></span>
The newly created gain unit.
</ol>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 1980-01-01 00:00:00 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
|
