You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The SoXPlugins software package provides plugins for being used in
16
-
digital audio workstations (DAW); they implement some of the more
17
-
prominent audio processing effects from SoX as DAW audio plugins.
18
-
19
-
*[SoX][]* is a command line audio processing tool for Unix, Windows
20
-
and Mac OS that transforms source audio files in several formats into
21
-
other audio files. It provides several standard audio effects (like
22
-
e.g. filters or reverb) in good quality and with a transparent,
23
-
open-source implementation.
24
-
25
-
This plugin implementation is completely free, open-source,
26
-
platform-neutral and based on the *[JUCE][]* audio framework.
27
-
Currently only plugin versions as VST3 under Windows 10, VST3 and AU
28
-
under MacOSX (x86_64) and VST3 under Linux (x86_64) are provided, but
29
-
porting to other targets should be straightforward, since building is
30
-
supported by a platform-neutral CMAKE build file.
31
-
32
-
The effects provided here are a complete rewrite in C++ of the SoX
33
-
algorithms for producing *(bit-exact) identical* renderings in the
34
-
DAW. This can easily be checked by rendering some audio externally
35
-
with SoX and internally with the plugins and subtracting the results.
36
-
Apart from roundoff errors (SoX often uses 32bit integer processing,
37
-
while the SoXPlugins always uses double floating point processing) the
38
-
results cancel out with typically a residual noise of -140dBFS.
15
+
The SoX Plugins software package provides plugins for being used in
16
+
digital audio workstations (DAW); they implement some of the audio
17
+
processing effects from SoX.
18
+
19
+
*[SoX][reference:SoX]* is a command line audio processing tool for
20
+
Unix, Windows and Mac OS that transforms source audio files in several
21
+
formats into other audio files. It provides several standard audio
22
+
effects (like e.g. filters or reverb) in good quality and with a
23
+
transparent, open-source implementation. Currently a project called
24
+
[SoX_ng][reference:SoXNG] and led by Martin W. Guy is modernizing all
25
+
those effects and hence serves as the reference for this project.
26
+
27
+
The effects provided here are a complete rewrite in
28
+
C++ of the SoX algorithms for producing
29
+
*(bit-exact) identical* renderings in the DAW. This can easily be
30
+
checked by rendering some audio externally with SoX and internally
31
+
with the plugins and subtracting the results. Apart from roundoff
32
+
errors (SoX often uses 32bit integer processing, while the SoXPlugins
33
+
always uses double floating point processing) the results cancel out
34
+
with typically a residual noise of -140dBFS.
39
35
40
36
The main motivation for this package is to be able to play around with
41
37
effects in a DAW and be sure that the external rendering by SoX will
@@ -67,6 +63,13 @@ complexity in the original sources due to their several contributors.
67
63
Nevertheless - as pointed out - the effects provided here faithfully
68
64
model the SoX command-line processing.
69
65
66
+
This plugin implementation is completely free, open-source,
67
+
platform-neutral and based on the *[JUCE][reference:JUCE]* audio
68
+
framework. Currently only plugin versions as VST3 under Windows 10,
69
+
VST3 and AU under MacOSX (x86_64) and VST3 under Linux (x86_64) are
70
+
provided, but porting to other targets should be straightforward,
71
+
since building is supported by a platform-neutral CMAKE build file.
72
+
70
73
Available Effects
71
74
-----------------
72
75
@@ -92,11 +95,21 @@ The following effects are available in this package:
92
95
-*biquad*: a generic biquad (iir) filter with 6 coefficients
93
96
b0, b1, b2, a0, a1 and a2
94
97
98
+
-*chorus*: a chorus effect with multiple parallel echos modulated
99
+
either by sine or triangle signals,
100
+
95
101
-*compand*: a compander with attack, release, input gain
96
102
shift, threshold and compression and soft knee; this
97
103
is a reduced version of SoX compand with only a
98
104
simple transfer function
99
105
106
+
-*echo*: a tapped delay with several absolute delay times and
107
+
signal decays,
108
+
109
+
-*echos*: a sequential delay with delay stages with absolute
110
+
delay times and signal decays fed with signals from the previous
111
+
stages,
112
+
100
113
-*equalizer*: a biquad filter for equalizing with
101
114
settings for the pole count, the filter frequency
102
115
and the filter bandwith (in several units)
@@ -132,14 +145,17 @@ The following effects are available in this package:
132
145
-*tremolo*: a tremolo effect with sine modulation using a
133
146
double-sideband suppressed carrier modulation
134
147
148
+
149
+
135
150
Installation
136
151
------------
137
152
138
153
The installation is as follows:
139
154
140
-
1. Expand the appropriate binary archive of the <TT>SoXPlugins</TT>
141
-
for your platform from this [repository](../../releases) into
142
-
the directory for VST plugins of your DAW.
155
+
1. Expand the appropriate binary archive of the
156
+
<TT>SoXPlugins</TT> for your platform from this
157
+
[repository](../../releases) into the directory for VST plugins
158
+
of your DAW.
143
159
144
160
2. The distribution also contains a documentation [pdf
145
161
file](./SoXPlugins-documentation.pdf) in subdirectory doc and
@@ -149,7 +165,7 @@ The installation is as follows:
149
165
3. When installing the plugins on MacOSX, note that those are
150
166
**not signed**; so you have to explicitly remove the quarantine
151
167
flag from them (e.g. by applying the command `sudo xattr -rd
152
-
com.apple.quarantine «vstPath»`).
168
+
com.apple.quarantine vstPath`).
153
169
154
170
4. When installing the plugins on Windows, they require the
155
171
so-called *Microsoft Visual C++ Redistributable* library. Very
@@ -163,7 +179,7 @@ The installation is as follows:
163
179
Plugin Example - Phaser
164
180
-----------------------
165
181
166
-
182
+
167
183
168
184
The above diagram gives an example for one of the plugins: this is the
169
185
UI for the phaser effect.
@@ -199,13 +215,13 @@ those test and result files and applies the corresponding effect
199
215
plugins. Ideally (because the result files have inverted phase),
200
216
everything should cancel out as shown here:
201
217
202
-
218
+
203
219
204
220
Details
205
221
-------
206
222
207
223
The detailed user manual can be found
208
-
*[here](./SoXPlugins-documentation.pdf)*.
224
+
*[here][reference:manual]*.
209
225
210
226
Acknowledgements
211
227
----------------
@@ -215,9 +231,10 @@ SoX community. Although the algorithms used were modified and
215
231
redesigned, this project would been much more complicated and tedious
216
232
without this basis.
217
233
218
-
Hence my thanks go to Chris Bagwell, Nick Bailey, Daniel Pouzzner,
219
-
Måns Rullgård, Rob Sewell and all the other contributors of the SoX
220
-
project: without your effort this would not have been possible!
234
+
Hence my thanks go to Chris Bagwell, Nick Bailey, Martin W. Guy,
235
+
Daniel Pouzzner, Måns Rullgård, Rob Sewell and all the other
236
+
contributors of the SoX project: without your effort this would not
237
+
have been possible!
221
238
222
239
## License
223
240
@@ -229,6 +246,9 @@ There are two license models for this project:
229
246
230
247
This means that if you do *not* use the given binaries and compile the source code by yourself, the MIT license applies. If you *do* use the binaries, then the AGPL v3 license applies.
0 commit comments