Update: 2024-09-28
BasicLimiter is a basic single band limiter. The sound is nothing new, but the design of true peak mode is a bit luxurious.
full
- VST 3 (github.com) macOS
- VST 3 (github.com) An extended version BasicLimiterAutoMake is also available. Added features are automatic make up gain, sidechain, and switching between left-right (L-R) and mid-side (M-S). Note that CPU load is over 1.5 times heavier than BasicLimiter.
full
package contains following builds.
Linux build is built on Ubuntu 24.04. If you are using distribution other than Ubuntu 24.04, plugin will not likely to run. In this case, please take a look at build instruction.
macOS
package is recommended for macOS user. I can’t
purchase Apple Developer Program, therefore installation requires a
workaround to bypass Gatekeeper. Details of workaround are written in
Installation -> macOS Specific
section.
Feel free to contact me on GitHub
repository or ryukau@gmail.com.
You can fund the development through paypal.me/ryukau.
Move *.vst3
directory to:
/Program Files/Common Files/VST3/
for Windows.$HOME/.vst3/
for Linux./Users/$USERNAME/Library/Audio/Plug-ins/VST3/
for
macOS.DAW may provides additional VST3 directory. For more information, please refer to the manual of the DAW.
Notice: Some plugins don’t have presets provided by Uhhyou Plugins.
Presets are included in the plugin package linked at the top of this page. To install presets, follow the steps below.
presets
directory placed in extracted
package.Uhhyou
directory into an OS specific preset
directory (see below).Below is a list of preset directories for each OS.
/Users/$USERNAME/Documents/VST3 Presets
$HOME/.vst3/presets
/Users/$USERNAME/Library/Audio/Presets
Preset directory name must be the same as the plugin. If preset directory does not exist, create it.
If DAW doesn’t recognize the plugin, try installing C++
redistributable (vc_redist.x64.exe
). Installer can be
found in the link below.
On Ubuntu 24.04, those packages are required.
sudo apt install libxcb-cursor0 libxkbcommon-x11-0
If DAW doesn’t recognize the plugin, take a look at
Package Requirements
section of the link below and make
sure all the VST3 related package is installed.
REAPER on Linux may not recognize the plugin. A workaround is to
delete a file ~/.config/REAPER/reaper-vstplugins64.ini
and restart REAPER.
Important: full
package is not
confirmed working. When using full
, try removing
following files.
Contents/Resources/Documentation
Contents/x86_64-linux
Contents/x86_64-win
macOS
package doesn’t contain above files. Also, all
packages are in “ad-hoc signing” state set by codesign
command.
When trying to run plugin first time, following message may appear on macOS.
<PluginName>.vst3 is damaged and can't be opened. You should move it to the Trash.
In this case, open terminal and try running one or both of
following command to unzipped .vst3
directory. Replace
/path/to/PluginName.vst3
according to your install
location.
xattr -rd com.apple.quarantine /path/to/PluginName.vst3
xattr -rc /path/to/PluginName.vst3
Plugin may be considered as unsigned/un-notarized application. In this case, open System Preferences, go to Security & Privacy → General, then click the Open Anyway button. The offcial Apple help page linked below has screenshots for the procedure. See “If you want to open an app that hasn’t been notarized or is from an unidentified developer” section.
If the plugin is still not working, try changing install location
to /Library/Audio/Plug-ins/VST3/
or
/Users/$USERNAME/Library/Audio/Plug-ins/VST3/
whichever
still haven’t tried.
If all the above methods do not work, try following the steps below.
sudo spctl --master-disable
.Beware that steps above degrades security of your system. To revert the settings, follow the steps below.
sudo spctl --master-enable
.codesign
Note This section may not relevant to
macOS
packages. However it’s not verified. (GitHub
issue)
To use full
package, following command might be
used.
sudo codesign --force --deep -s - /path/to/PluginName.vst3
codesign
might not be available without installing Xcode.
At first time, create color config file to:
/Users/USERNAME/AppData/Roaming/UhhyouPlugins/style/style.json
on Windows.$XDG_CONFIG_HOME/UhhyouPlugins/style/style.json
on
Linux.
$XDG_CONFIG_HOME
is empty, make
$HOME/.config/UhhyouPlugins/style/style.json
./Users/$USERNAME/Library/Preferences/UhhyouPlugins/style/style.json
on macOS.style.json
will be loaded for each time a plugin
window opens.
Several color themes are available on the link below. To use, copy
the text to style.json
.
Below is an example of style.json
.
{
"fontFamily" : "Tinos" ,
"fontBold" : true ,
"fontItalic" : true ,
"foreground" : "#000000" ,
"foregroundButtonOn": "#000000" ,
"foregroundInactive": "#8a8a8a" ,
"background" : "#ffffff" ,
"boxBackground" : "#ffffff" ,
"border" : "#000000" ,
"borderCheckbox" : "#000000" ,
"borderLabel" : "#000000" ,
"unfocused" : "#dddddd" ,
"highlightMain" : "#0ba4f1" ,
"highlightAccent" : "#13c136" ,
"highlightButton" : "#fcc04f" ,
"highlightWarning" : "#fc8080" ,
"overlay" : "#00000088",
"overlayHighlight" : "#00ff0033"
}
Following is a list of font options.
fontFamily
: Font family name.fontBold
: Enable bold style when
true
, disable when false
.fontItalic
: Enable italic style when
true
, disable when false
.System font can be used as fontFamily
. To use
different fonts for different plugins, place *.ttf
file
into custom font path:
*.vst3/Contents/Resources/Fonts
.
Notice: If the combination of
fontFamily
, fontBold
,
fontItalic
does not exist in custom font path, default
font of VSTGUI is used.
If fontFamily
is set to empty string ""
,
then "Tinos"
is used as fallback. If the length is greater than 1 and the font
family name doesn’t exist, default font of VSTGUI is used.
Styles other than bold, italic or bold-italic are not supported by VSTGUI. For example, “Thin”, “Light”, “Medium”, and “Black” weights cannot be used.
Hex color codes are used.
First letter #
is conventional. Plugins ignore the
first letter of color code, thus ?102938
,
\n11335577
are valid.
Do not use characters outside of 0-9a-f
for color
value.
Following is a list of color options. If an option is missing, default color will be used.
foreground
: Text color.foregroundButtonOn
: Text color of active toggle
button. Recommend to use the same value of foreground
or
boxBackground
.foregroundInactive
: Text color of inactive
components. Currently, only used for TabView.background
: Background color.boxBackground
: Background color of inside of box
shaped components (Barbox, Button, Checkbox, OptionMenu, TextKnob,
VSlider).border
: Border color of box shaped components.borderCheckbox
: Border color of CheckBox.borderLabel
: Line color of parameter section
label.unfocused
: Color to fill unfocused components.
Currently, only used for knobs.highlightMain
: Color to indicate focus is on a
component. Highlight colors are also used for value of slider
components (BarBox and VSlider).highlightAccent
: Same as highlightMain
.
Used for cosmetics.highlightButton
: Color to indicate focus is on a
button.highlightWarning
: Same as highlightMain
,
but only used for parameters which requires extra caution.overlay
: Overlay color. Used to overlay texts and
indicators.overlayHighlight
: Overlay color to highlight current
focus.Right Click on the controls pops up a context menu provided by DAW.
Knob and slider provides following controls:
dB
) parameters,
floor is applied after the value is converted to amplitude.The algorithm used in BasicLimiter causes over-limiting when input
amplitude is extremely high. When over-limiting happens, higher input
amplitude turns into lower output amplitude. This problems is expected
to happen when input amplitude exceeds 2^53
, or +319
dB.
If the image is small, use Ctrl + Mouse Wheel or “View Image” on right click menu to scale.
Diagram only shows overview. It’s not exact implementation.
Threshold of limiter output amplitude.
When True Peak
is off, output amplitude is limited
under Threshold
.
When True Peak
is on, output amplitude might exceeds
Threshold
. This is due to the limitation of real-time
algorithm.
Threshold of gate. When input amplitude is less than the value of
Gate
for the duration of Attack
, output
amplitude becomes 0.
Transition time of smoothing filter which applies to internal
envelope. The value of Attack
also adds to the
latency.
For the sound with sharp transitions like drums, recommend to set
Attack
under 0.02 seconds. This value, 0.02 seconds, is
based on a psychoacoustic effect called temporal
masking.
Smoothness to reset internal envelope to neutral position.
Internally, the inverse value of Release
is used as
cutoff frequency. This means that the value of Release
is
not exact. Because of temporal masking, setting the sum of
Release
and Sustain
under 0.2 seconds is
recommended.
Additional peak hold time for the internal envelope.
Sustain
causes more ducking when applied to sounds
like drums. For sounds like distorted guitar or sustaining
synthesizer, Sustain
might sound cleaner than
Release
, because it works similar to auto-gain. Note that
when sustain is longer, it deviates from the curve of temporal
masking.
When Stereo Link
is set to 0.0, limiter for each
channel works independently. When set to 1.0, maximum of all the input
amplitude is used for both limiter. Following snippet shows the
calculation of Stereo Link
absL = fabs(leftInput).
absR = fabs(rightInput).
absMax = max(absL, absR).
amplitudeL = absL + stereoLink * (absMax - absL).
amplitudeR = absR + stereoLink * (absMax - absR).
When Stereo Link
is set to 0.0, and input amplitude is
leaned to left or right, it may sounds like the pan is wobbling. To
reduce wobbling, set the value to 0.0, then gradually increase the
value to 1.0. Stop increasing the value when pan wobbling becomes
inaudible.
Enables true peak mode when checked.
While true peak mode is enabled, lowpass filter is applied to remove the components near nyquist frequency. This lowpass filter is designed to only change the gain over 18000 Hz when sampling rate is 48000 Hz.
Sample peak might exceeds Threshold
. Especially when
sample peak exceeds 0 dB, the value of Overshoot
becomes
greater than 0. Lower Threshold
in this case.
True peak restoration at nyquist frequency requires infinite length FIR filter (sinc interpolation). Therefore, it’s impossible to compute in real time. This is the reason that lowpass is applied, and true peak mode overshoots.
Resets Overshoot
to 0 when clicked.
When output sample peak exceeds 0 dB, the value of
Overshoots
changes to greater than 0, and
Reset Overshoot
will be lit.
Enable automatic make up gain when checked.
When Auto Make Up
is enabled, output amplitude become
lower when Threshold
is greater than
Auto Make Up Target Gain
.
When Auto Make Up
is enabled, and
Threshold
is increasing, overshoot may occur. Recommend
to set the target gain to -0.1 dB (default) or lower in this case.
If Threshold
needs to be changed when input signal is
hot, insert another limiter for safe guard.
Maximum amplitude after automatic make up gain is applied. This is
a control placed on the right side of Auto Make Up
. Unit
is decibel.
When Channel Type
is set to M-S
, maximum
amplitude is +6 dB of Auto Make Up Target Gain
.
When checked, enables sidechain and disables
Auto Make Up
.
Auto Make Up
is disabled because source amplitude is
not affected by Threshold
while sidechain is
activated.
BasicLimiterAutoMake has 2 stereo input. No. 1 is source, and No. 2 is sidechain. For routing, refer to your DAW manual.
Switch the type of stereo channel between left-right
(L-R
) and mid-side (M-S
).
When the type is M-S
, sample peak becomes
2 * Threshold
, or +6.02 dB over Threshold
.
Therefore, when using Auto Make Up
with M-S
,
it is recommended to set Auto Make Up Target Gain
to -6.1
dB or lower. This behavior aims to provide the same loudness when
comparing L-R
and M-S
.
style.json
crashes
plugin.foregroundInactive
.Attack
number slider to update value
at mouse up, instead of mouse move.processContext
is
nullptr
.virtual
to destructor of common components.
This may prevent some cause of crash or memory leak.style.json
.Gate
when the value is set to -inf
dB.style.json
crashes
plugin.foregroundInactive
.Attack
number slider to update value
at mouse up, instead of mouse move.Vst::BusTypes::kAux
flag is added for side chain
input.processContext
is
nullptr
.virtual
to destructor of common components.
This may prevent some cause of crash or memory leak.BasicLimiter is licensed under GPLv3. Complete licenses are linked below.
If the link above doesn’t work, please send email to
ryukau@gmail.com
.
VST is a trademark of Steinberg Media Technologies GmbH, registered in Europe and other countries.