This repository has been archived by the owner on Dec 5, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
_simple_gate_process_8inl_source.html
189 lines (187 loc) · 21.9 KB
/
_simple_gate_process_8inl_source.html
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
180
181
182
183
184
185
186
187
188
189
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>swift: src/blacksound/dsp/SimpleGateProcess.inl Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">swift
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_12c808cff225019d616728af7d9c2555.html">blacksound</a></li><li class="navelem"><a class="el" href="dir_c0c7ca085f0248a6642a28bd99f998cb.html">dsp</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">SimpleGateProcess.inl</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Simple Gate (runtime function)</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * File : SimpleGateProcess.inl</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Library : SimpleSource</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Version : 1.12</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Implements : void SimpleGate::process( double &in1, double &in2 )</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * void SimpleGate::process( double &in1, double &in2, double keyLinked )</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * void SimpleGateRms::process( double &in1, double &in2 )</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * 2006, ChunkWare Music Software, OPEN-SOURCE</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * copy of this software and associated documentation files (the "Software"),</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * to deal in the Software without restriction, including without limitation</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * Software is furnished to do so, subject to the following conditions:</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * The above copyright notice and this permission notice shall be included in</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * all copies or substantial portions of the Software.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * DEALINGS IN THE SOFTWARE.</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#ifndef __SIMPLE_GATE_PROCESS_INL__</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#define __SIMPLE_GATE_PROCESS_INL__</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span>chunkware_simple</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> {</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="comment">//-------------------------------------------------------------</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classchunkware__simple_1_1_simple_gate.html#a80a11e9dcae23b97cdb64baf918153fa"> 39</a></span>  INLINE <span class="keywordtype">void</span> <a class="code" href="classchunkware__simple_1_1_simple_gate.html#a80a11e9dcae23b97cdb64baf918153fa">SimpleGate::process</a>( <span class="keywordtype">double</span> &in1, <span class="keywordtype">double</span> &in2 )</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// create sidechain</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">double</span> rect1 = fabs( in1 ); <span class="comment">// rectify input</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">double</span> rect2 = fabs( in2 );</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="comment">/* if desired, one could use another EnvelopeDetector to smooth</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * the rectified signal.</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">double</span> link = std::max( rect1, rect2 ); <span class="comment">// link channels with greater of 2</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="classchunkware__simple_1_1_simple_gate.html#a80a11e9dcae23b97cdb64baf918153fa">process</a>( in1, in2, link ); <span class="comment">// rest of process</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  }</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">//-------------------------------------------------------------</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classchunkware__simple_1_1_simple_gate.html#a3a833de83e6f3e676327638172d323c1"> 56</a></span>  INLINE <span class="keywordtype">void</span> <a class="code" href="classchunkware__simple_1_1_simple_gate.html#a80a11e9dcae23b97cdb64baf918153fa">SimpleGate::process</a>( <span class="keywordtype">double</span> &in1, <span class="keywordtype">double</span> &in2, <span class="keywordtype">double</span> keyLinked )</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  {</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  keyLinked = fabs( keyLinked ); <span class="comment">// rectify (just in case)</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">// threshold</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// key over threshold ( 0.0 or 1.0 )</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">double</span> over = double( keyLinked > thresh_ );</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// attack/release</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  over += DC_OFFSET; <span class="comment">// add DC offset to avoid denormal</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="classchunkware__simple_1_1_att_rel_envelope.html#aa61f2be5a8fb592bde1adab28468d801">AttRelEnvelope::run</a>( over, env_ ); <span class="comment">// run attack/release</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  over = env_ - DC_OFFSET; <span class="comment">// subtract DC offset</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">/* REGARDING THE DC OFFSET: In this case, since the offset is added before </span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * the attack/release processes, the envelope will never fall below the offset,</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * thereby avoiding denormals. However, to prevent the offset from causing</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * constant gain reduction, we must subtract it from the envelope, yielding</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * a minimum value of 0dB.</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// output gain</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  in1 *= over; <span class="comment">// apply gain reduction to input</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  in2 *= over;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  }</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="comment">//-------------------------------------------------------------</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="classchunkware__simple_1_1_simple_gate_rms.html#a5ed02a5f108d3bcbd403a6f4a02e7707"> 82</a></span>  INLINE <span class="keywordtype">void</span> <a class="code" href="classchunkware__simple_1_1_simple_gate_rms.html#a5ed02a5f108d3bcbd403a6f4a02e7707">SimpleGateRms::process</a>( <span class="keywordtype">double</span> &in1, <span class="keywordtype">double</span> &in2 )</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  {</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="comment">// create sidechain</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">double</span> inSq1 = in1 * in1; <span class="comment">// square input</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">double</span> inSq2 = in2 * in2;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">double</span> sum = inSq1 + inSq2; <span class="comment">// power summing</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  sum += DC_OFFSET; <span class="comment">// DC offset, to prevent denormal</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  ave_.<a class="code" href="classchunkware__simple_1_1_envelope_detector.html#a59d5730de1b2aa9768462a5caff332fd">run</a>( sum, aveOfSqrs_ ); <span class="comment">// average of squares</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordtype">double</span> rms = sqrt( aveOfSqrs_ ); <span class="comment">// rms (sort of ...)</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="comment">/* REGARDING THE RMS AVERAGER: Ok, so this isn't a REAL RMS</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * calculation. A true RMS is an FIR moving average. This</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * approximation is a 1-pole IIR. Nonetheless, in practice,</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * and in the interest of simplicity, this method will suffice,</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * giving comparable results.</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <a class="code" href="classchunkware__simple_1_1_simple_gate.html#a80a11e9dcae23b97cdb64baf918153fa">SimpleGate::process</a>( in1, in2, rms ); <span class="comment">// rest of process</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  }</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> } <span class="comment">// end namespace chunkware_simple</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor">#endif </span><span class="comment">// end __SIMPLE_GATE_PROCESS_INL__</span></div>
<div class="ttc" id="aclasschunkware__simple_1_1_att_rel_envelope_html_aa61f2be5a8fb592bde1adab28468d801"><div class="ttname"><a href="classchunkware__simple_1_1_att_rel_envelope.html#aa61f2be5a8fb592bde1adab28468d801">chunkware_simple::AttRelEnvelope::run</a></div><div class="ttdeci">INLINE void run(double in, double &state)</div><div class="ttdoc">Runtime function.</div><div class="ttdef"><b>Definition:</b> <a href="_simple_envelope_8h_source.html#l00113">SimpleEnvelope.h:113</a></div></div>
<div class="ttc" id="aclasschunkware__simple_1_1_envelope_detector_html_a59d5730de1b2aa9768462a5caff332fd"><div class="ttname"><a href="classchunkware__simple_1_1_envelope_detector.html#a59d5730de1b2aa9768462a5caff332fd">chunkware_simple::EnvelopeDetector::run</a></div><div class="ttdeci">INLINE void run(double in, double &state)</div><div class="ttdoc">runtime function</div><div class="ttdef"><b>Definition:</b> <a href="_simple_envelope_8h_source.html#l00070">SimpleEnvelope.h:70</a></div></div>
<div class="ttc" id="aclasschunkware__simple_1_1_simple_gate_html_a80a11e9dcae23b97cdb64baf918153fa"><div class="ttname"><a href="classchunkware__simple_1_1_simple_gate.html#a80a11e9dcae23b97cdb64baf918153fa">chunkware_simple::SimpleGate::process</a></div><div class="ttdeci">void process(double &in1, double &in2)</div><div class="ttdoc">Process audio.</div><div class="ttdef"><b>Definition:</b> <a href="_simple_gate_process_8inl_source.html#l00039">SimpleGateProcess.inl:39</a></div></div>
<div class="ttc" id="aclasschunkware__simple_1_1_simple_gate_rms_html_a5ed02a5f108d3bcbd403a6f4a02e7707"><div class="ttname"><a href="classchunkware__simple_1_1_simple_gate_rms.html#a5ed02a5f108d3bcbd403a6f4a02e7707">chunkware_simple::SimpleGateRms::process</a></div><div class="ttdeci">void process(double &in1, double &in2)</div><div class="ttdoc">gate runtime process</div><div class="ttdef"><b>Definition:</b> <a href="_simple_gate_process_8inl_source.html#l00082">SimpleGateProcess.inl:82</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 3 2023 18:38:41 for swift by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>