# BasicLimiter

BasicLimiter is a basic single band limiter. The sound is nothing new, but the design of true peak mode is a bit luxurious.

- Download BasicLimiter 0.1.23 `full` - VST 3 (github.com)
- Download BasicLimiter 0.1.23 `macOS` - VST 3 (github.com)
- Download Presets (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.

- Download BasicLimiterAutoMake 0.1.23 full - VST 3 (github.com)
- Download BasicLimiterAutoMake 0.1.23 macOS - VST 3 (github.com)

`full` package contains following builds.

- Windows (x86_64)
- Linux (x86_64)
- macOS (Universal 2)

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.

## Contact

Feel free to contact me on GitHub repository or `ryukau@gmail.com.`

You can fund the development through paypal.me/ryukau.

## Installation

### Plugin

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.

### Presets

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.

1. Download plugin from a link at the top of this page.
2. Extract downloaded zip file.
3. Open `presets` directory placed in extracted package.
4. Move `Uhhyou` directory into an OS specific preset directory (see below).

Below is a list of preset directories for each OS.

- Windows : `/Users/$USERNAME/Documents/VST3 Presets`
- Linux : `$HOME/.vst3/presets`
- macOS : `/Users/$USERNAME/Library/Audio/Presets`

Preset directory name must be the same as the plugin. If preset directory does not exist, create it.

- Preset Locations - VST 3 Developer Portal

### Windows Specific

If DAW doesn’t recognize the plugin, try installing C++ redistributable (`vc_redist.x64.exe`). Installer can be found in the link below.

- Latest supported Visual C++ Redistributable downloads | Microsoft Learn

### Linux Specific

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.

- VSTGUI: Setup

REAPER on Linux may not recognize the plugin. A workaround is to delete a file `~/.config/REAPER/reaper-vstplugins64.ini` and restart REAPER.

### macOS Specific

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.

#### Remove Quarantine

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

#### Bypass Gatekeeper

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.

- Safely open apps on your Mac - Apple Support

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.

1. Open terminal and run `sudo spctl --master-disable`.
2. Go to System Preferences → Security and Privacy → General → Allow apps downloaded from, then select “Anywhere”.

Beware that steps above degrades security of your system. To revert the settings, follow the steps below.

1. Go to System Preferences → Security and Privacy → General → Allow apps downloaded from, then select option to “App Store and identified developers”.
2. Open terminal and run `sudo spctl --master-enable`.

#### Applying `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.

#### Reference

- Safely open apps on your Mac - Apple Support
- java - “libprism_sw.dylib” cannot be opened because the developer cannot be verified. on mac JAVAFX - Stack Overflow
- How to Fix App “is damaged and can’t be opened. You should move it to the Trash” Error on Mac
- Allowing unsigned/un-notarized applications/plugins in Mac OS | Venn Audio

## GUI Style Configuration

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.
  - If `$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`.

- VSTPlugins/package/style/themes at master · ryukau/VSTPlugins

Below is an example of `style.json`.

    {
      "guiScale"          : 1          ,
      "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"
    }

### GUI Scale

- `guiScale`: GUI scaling. For example, `0.75` is 75%, and `2.0` is 200%.

The minimum of `guiScale` is `0.01`. The maximum is practically non-existent (the max value of 64-bit float).

Notice: If `guiScale` is too large, DAW may place the “close” button on the plugin window out of screen, making it unclickable.

### Font Options

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.

### Color Options

Hex color codes are used.

- 6 digit color is RGB.
- 8 digit color is RGBA.

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.

## Controls

`Right Click` on the controls pops up a context menu provided by DAW.

Knob and slider provides following controls:

- `Ctrl` + `Left Click`: Reset value.
- `Shift` + `Left Drag`: Fine adjustment.
- `Middle Click` : Rotate through minimum, default and maximum value.
- `Shift` + `Middle Click` : Take floor of current value.
  - Note: For decibel (`dB`) parameters, floor is applied after the value is converted to amplitude.

## Caution

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.

## Block Diagram

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.

## Parameters

Threshold [dB]

  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.

Gate [dB]

  Threshold of gate. When input amplitude is less than the value of `Gate` for the duration of `Attack`, output amplitude becomes 0.

Attack [s]

  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.

Release [s]

  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.

Sustain [s]

  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.

Stereo Link

  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.

True Peak

  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.

Reset Overshoot

  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.

### BasicLimiterAutoMake Specific Parameters

Auto Make Up

  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.

Auto Make Up Target Gain

  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`.

Sidechain

  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.

Channel Type

  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`.

## Change Log

### BasicLimiter

- 0.1.23
  - Fixed a bug that plugin to show up with incorrect window size (likely 512x512 pixels) at initialization.
  - Changed internals to speed up.
- 0.1.22
  - Fixed latency reporting. This fix provides proper latency reporting at initialization and at changing relevant parameters, without closing and opening the GUI again.
- 0.1.21
  - Added GUI scaling.
  - Updated the Linux patch for VSTGUI4.
- 0.1.20
  - Fixed GUI on Linux.
- 0.1.19
  - Changed to include presets in plugin zip package.
  - Fixed a bug that invalid `style.json` crashes plugin.
- 0.1.18
  - Changed default style color of `foregroundInactive`.
  - Fixed performance drop caused by subnormal floating point numbers.
- 0.1.17
  - Changed limiter `Attack` number slider to update value at mouse up, instead of mouse move.
- 0.1.16
  - Fixed crash on Renoise. Previous code was trying to access freed memory of GUI widgets, and it was causing the crash.
- 0.1.15
  - Fixed stuttering on Audacity where `processContext` is `nullptr`.
- 0.1.14
  - Updated splash screen text.
- 0.1.13
  - Added floor shortcut to number sliders. Shortcut is `Shift` + `Middle Click`.
- 0.1.12
  - Added to `virtual` to destructor of common components. This may prevent some cause of crash or memory leak.
- 0.1.11
  - Updated VST 3 SDK to version 3.7.6. This also fixes the crash when opening multiple GUI of same plugin on Linux.
- 0.1.10
  - Fixed resetting of release filter coefficient. This fix removes fade-in effect after resetting when release time is long.
- 0.1.9
  - Fixed a potential bug that breaks limiter when internal delay buffer length and attack time are set to same value.
- 0.1.8
  - Removed dependency to x86_64 specific SIMD instructions.
- 0.1.6
  - Fixed crash on Linux.
- 0.1.5
  - Fixed the condition of acceptable channel count. This is a fix for unintentional muting on sidechain in REAPER.
- 0.1.4
  - Added custom font options for `style.json`.
  - Changed to disable `Gate` when the value is set to -inf dB.
- 0.1.3
  - Updated VSTGUI from 4.10 to 4.11.
- 0.1.2
  - Initial release.

### BasicLimiterAutoMake

- 0.1.23
  - Fixed a bug that plugin to show up with incorrect window size (likely 512x512 pixels) at initialization.
  - Changed internals to speed up.
- 0.1.22
  - Fixed latency reporting. This fix provides proper latency reporting at initialization and at changing relevant parameters, without closing and opening the GUI again.
- 0.1.21
  - Added GUI scaling.
  - Updated the Linux patch for VSTGUI4.
- 0.1.20
  - Fixed GUI on Linux.
- 0.1.19
  - Changed to include presets in plugin zip package.
  - Fixed a bug that invalid `style.json` crashes plugin.
- 0.1.18
  - Changed default style color of `foregroundInactive`.
  - Fixed performance drop caused by subnormal floating point numbers.
- 0.1.17
  - Changed limiter `Attack` number slider to update value at mouse up, instead of mouse move.
  - Fixed a bug that side chain input was not recognized on Renoise. `Vst::BusTypes::kAux` flag is added for side chain input.
- 0.1.16
  - Fixed crash on Renoise. Previous code was trying to access freed memory of GUI widgets, and it was causing the crash.
- 0.1.15
  - Fixed stuttering on Audacity where `processContext` is `nullptr`.
- 0.1.14
  - Updated splash screen text.
- 0.1.13
  - Added floor shortcut to number sliders. Shortcut is `Shift` + `Middle Click`.
- 0.1.12
  - Added to `virtual` to destructor of common components. This may prevent some cause of crash or memory leak.
- 0.1.11
  - Updated VST 3 SDK to version 3.7.6. This also fixes the crash when opening multiple GUI of same plugin on Linux.
- 0.1.10
  - Changed parameter smoothing time from 0.2 seconds to 0.5 seconds.
  - Fixed resetting of release filter coefficient. This fix removes fade-in effect after resetting when release time is long.
- 0.1.9
  - Fixed a potential bug that breaks limiter when internal delay buffer length and attack time are set to same value.
- 0.1.8
  - Removed dependency to x86_64 specific SIMD instructions.
- 0.1.7
  - Fixed crash on Linux.
- 0.1.6
  - Added highEliminator for sidechain input to reduce overshoot in true peak mode.
- 0.1.5
  - Fixed the condition of acceptable channel count. This is a fix for unintentional muting on sidechain in REAPER.
- 0.1.4
  - Initial release.

## Old Versions

### BasicLimiter

- BasicLimiter 0.1.22 - VST 3 (github.com)
- BasicLimiter 0.1.21 - VST 3 (github.com)
- BasicLimiter 0.1.20 - VST 3 (github.com)
- BasicLimiter 0.1.19 - VST 3 (github.com)
- BasicLimiter 0.1.18 - VST 3 (github.com)
- BasicLimiter 0.1.17 - VST 3 (github.com)
- BasicLimiter 0.1.16 - VST 3 (github.com)
- BasicLimiter 0.1.15 - VST 3 (github.com)
- BasicLimiter 0.1.14 - VST 3 (github.com)
- BasicLimiter 0.1.13 - VST 3 (github.com)
- BasicLimiter 0.1.12 - VST 3 (github.com)
- BasicLimiter 0.1.11 - VST 3 (github.com)
- BasicLimiter 0.1.10 - VST 3 (github.com)
- BasicLimiter 0.1.9 - VST 3 (github.com)
- BasicLimiter 0.1.8 - VST 3 (github.com)
- BasicLimiter 0.1.6 - VST 3 (github.com)
- BasicLimiter 0.1.5 - VST 3 (github.com)
- BasicLimiter 0.1.4 - VST 3 (github.com)
- BasicLimiter 0.1.2 - VST 3 (github.com)

### BasicLimiterAutoMake

- BasicLimiterAutoMake 0.1.22 - VST 3 (github.com)
- BasicLimiterAutoMake 0.1.21 - VST 3 (github.com)
- BasicLimiterAutoMake 0.1.20 - VST 3 (github.com)
- BasicLimiterAutoMake 0.1.19 - VST 3 (github.com)
- BasicLimiterAutoMake 0.1.18 - VST 3 (github.com)
- BasicLimiterAutoMake 0.1.17 - VST 3 (github.com)
- BasicLimiterAutoMake 0.1.16 - VST 3 (github.com)
- BasicLimiterAutoMake 0.1.15 - VST 3 (github.com)
- BasicLimiterAutoMake 0.1.14 - VST 3 (github.com)
- BasicLimiterAutoMake 0.1.13 - VST 3 (github.com)
- BasicLimiterAutoMake 0.1.12 - VST 3 (github.com)
- BasicLimiterAutoMake 0.1.11 - VST 3 (github.com)
- BasicLimiterAutoMake 0.1.10 - VST 3 (github.com)
- BasicLimiterAutoMake 0.1.9 - VST 3 (github.com)
- BasicLimiterAutoMake 0.1.8 - VST 3 (github.com)
- BasicLimiterAutoMake 0.1.7 - VST 3 (github.com)
- BasicLimiterAutoMake 0.1.5 - VST 3 (github.com)
- BasicLimiterAutoMake 0.1.4 - VST 3 (github.com)

## License

BasicLimiter is licensed under GPLv3. Complete licenses are linked below.

- https://github.com/ryukau/VSTPlugins/tree/master/License

If the link above doesn’t work, please send email to `ryukau@gmail.com`.

### About VST

VST is a trademark of Steinberg Media Technologies GmbH, registered in Europe and other countries.