Awesome

Table of Contents

• About
• Features
  • Input/Output RMS Meters
  • Input & Output Gain
  • Link Input with Output
  • Ceiling Control
  • Visualizer
  • Analyzer
  • Configurable Tick marks
  • Configurable Scaling
  • 6 Clipping Types
  • Oversampling
  • Dry/Wet
  • Bypass Mode
  • Resizing
  • VST3, AU, LV2 and CLAP Support
  • macOS, Windows and Linux Support
  • Verified by Pluginval
• Installation
  • macOS
  • Windows
  • Linux
• Building from sources
  • Prerequisites
  • Build
• Contributing
• License
• Acknowledgments

About

PeakEater is a free, easy-to-use wave-shaping plugin. PeakEater lets you choose between different wave-shaping functions to clip everything above ceiling level. Therefore, you can boost the overall volume of your track safely without worrying that some nasty peak would go above the maximum allowed volume level of your DAW. It supports various <a href="#features">features</a> such as multiple clipping types, oversampling and visualizations of a clipping process that aims to make clipping easy and fun.

Features

RMS Meters

<img src="assets/screenshots/screenshot-in.png" alt="input-rms-screen" height="250"/><---><img src="assets/screenshots/screenshot-out.png" alt="output-rms-screen" height="250"/>

See how loud the signal was before and after the plugin.

Input & Output Gain

<img src="assets/screenshots/screenshot-in-gain.png" alt="input-gain-screen" height="100"/><---><img src="assets/screenshots/screenshot-out-gain.png" alt="output-gain-screen" height="100"/>

Adjusts gain level before and after processing. Input Gain is useful when you're either working with too quiet or too loud a signal and Output Gain can be helpful to compensate for loss of gain.

Link Input with Output

Use linking to automatically set the Output Gain level to the opposite of the Input Gain. For example, if the Input Gain value is set to +5dB then the Output Gain value will be automatically set to -5dB and vice versa.

Ceiling control

Control your ceiling. Everything above this level would be "eaten". Build-in RMS meter would show you the signal level that comes into the clipper and help you set the threshold.

Visualizer

Displays magnitude(in dB's) so you can see how peaks were eaten over time.

Analyzer

Shows approximated RMS that was cut ("Eaten") in the last 2 seconds and current clipping algorithm. Double-click on numbers to drop them to zero and force them re-calculate.

Configurable Tick marks

Right-Mouse-Click on Visualizer to switch between different tick marks.

Configurable Scaling

Also, you can switch between linear and non-linear scaling.

6 Clipping Types

Choose between 6 clipping functions, from Hard clipping to different types of Soft Clip (Up to Arctangent). Available clipping functions are:

• Hard
• Quintic
• Cubic
• Tangent
• Algebraic
• Arctangent

You can read more about the difference between Hard and Soft clipping here and here.

Oversampling

Choose between 2x, 4x, 8x, 16x and 32x oversampling to avoid signal aliasing. You can also turn off oversampling.

Note High values of oversampling may hurt CPU performance.

You can read more about oversampling here.

<a id="dry-wet"></a> Dry/Wet

Control mix between original and clipped signal. Useful when the clipper is used as an exciter.

Bypass mode

Bypasses all plugin's processing. Useful when you need to make side-by-side comparisons before and after processing.

Resizing

Drag the corner to change the size of the window.

VST3, AU, LV2 and CLAP support

<img src="assets/vendorIcons/vst3.png" alt="vst3" height="50"/> <img src="assets/vendorIcons/audio-units.png" alt="au" height="50"/> <img src="assets/vendorIcons/lv2.png" alt="lv2" height="50"/> <img src="assets/vendorIcons/clap.png" alt="clap" height="50"/>

You can use either VST3, AU (macOS only), LV2 or CLAP type of plugin.

Warning LV2 and CLAP support is experimental and may be unstable.

Available on all major platforms

<img src="assets/vendorIcons/macOS.png" alt="macOS" height="30"/> <img src="assets/vendorIcons/windows.png" alt="windows" height="30"/> <img src="assets/vendorIcons/linux.png" alt="linux" height="30"/>

You can use it on macOS, Windows or Linux.

Warning Linux support is experimental and may be unstable.

<a id="verified-by-pluginval"></a> Verified by Pluginval <img src="assets/pluginval.png" alt="Pluginval" height="20"/>

pluginval is a cross-platform plugin validator and tester application. It is designed to be used by both plugin and host developers to ensure stability and compatibility between plugins and hosts. GitHub Project Link

VST3 and AU versions are verified by Tracktion Pluginval for all platforms. Maximum possible strictness level 10 is used. For macOS and Linux - Headless Mode is being used and GUI Mode is used for Windows. Starting from v0.6.5, you may find proofs of Pluginval verification in the "Assets" section on the Release page(*.txt files are split by platform and plugin format).

Installation

1. Go to <a href="https://github.com/vvvar/PeakEater/releases/latest"><b>the latest release</b></a> page.
2. In the Assets section choose the installer for your platform.

macOS

Supported formats are VST3, AU, LV2 and CLAP. Tested on: macOS 12.6.2 Processors: Intel(x86_64), Apple Silicon M1+(arm64)

Install the plugin via the .dmg file. Drag the plugin in a format of your choice into the folder with your plugins.

Note<br /> Plugin is build as an Universal Binary. This means that same plugin supports both x86_64 and Apple Silicon(M1+). Just install it and it will automatically run natively with respect to your processor.

Note<br /> Due to macOS restrictions, you cannot drag files into untrusted directories. Therefore, double click on directory shortcut, open it and drag it directly there.

Note<br /> VST3 directory is /Library/Audio/Plug-ins/VST3<br /> AU directory is /Library/Audio/Plug-ins/Components<br /> LV2 directory is /Library/Audio/Plug-Ins/LV2<br /> CLAP directory is /Library/Audio/Plug-Ins/CLAP<br />

Windows

Supported formats are VST3, AU, LV2 and CLAP. Tested on: Windows 10 21H2

Extract the zip and copy the plugin in the format of choice into the folder with your plugins.

Note<br /> Standard VST3 folder is C:\Program Files\Common Files\VST3<br /> Standard LV2 folder is C:\Program Files\Common Files\LV2<br /> Standard CLAP folder is C:\Program Files\Common Files\CLAP<br />

Linux

Supported formats are VST3, AU, LV2 and CLAP. Tested on: Ubuntu 18.04

Extract the zip and copy the plugin in a format of your choice into the folder with your plugins.

Note<br /> Standard VST3 directory is ~/.vst3<br /> Standard LV2 directory is ~/.lv2<br /> Standard CLAP directory is ~/.clap<br />

Building from sources

Prerequisites

• Just 1.13.0+
• Python 3.11.4+
• Brew 4.0.23+(macOS only)
• C++ Build Tools for Visual Studio 2022(Windows only)
• Chocolatey 1.4.0+(Windows only)

Note<br /> It is recommended to use PowerShell on Windows

Building

just setup
just build

Build artifacts will be stored in the /build/Release/peakeater_artefacts.

Code signing on macOS

By default, code signing is turned off. To enable it:

1. Make sure you have a valid Apple Developer ID, Apple Team ID and your signing certificate installed on your Mac(Use this guide as a starting point. Be aware - they are not free)

2. Create a file called .env with the following content(replace the value with your Apple Developer ID, Apple ID, password from your Apple ID and Team ID):

MACOS_APPLE_DEVELOPER_ID="Developer ID Application: John Doe (XXXXX6XX42)"
MACOS_APPLE_ID="johndoe@gmail.com"
MACOS_APPLE_PASSWORD="jhnd-oejh-ndoe-jhnn"
MACOS_APPLE_TEAM_ID="JHNDO6E642"

3. Setup the notarytool(used to notarize DMG):

just setup-notarytool

You should see something like this in the terminal:

xcrun notarytool store-credentials "APPLE_SIGN_PROFILE" --apple-id $MACOS_APPLE_ID --password $MACOS_APPLE_PASSWORD --team-id $MACOS_APPLE_TEAM_ID

This process stores your credentials securely in the Keychain. You reference these credentials later using a profile name.

Validating your credentials...
Success. Credentials validated.
Credentials saved to Keychain.
To use them, specify `--keychain-profile "APPLE_SIGN_PROFILE"`

After this just run the build. CMake will automatically sign all binaries.

Contributing

If you found a bug, please report it using Bug Template. If you have any feedback, feel free to open a feedback ticket using Feedback Template. If you have a specific feature request, please create it using Feature Request Template. If you have a pull request, then just make it using common Fork & PR flow.

License

Distributed under the GPL-3.0 License. See LICENSE.md for more information.

Acknowledgments

• JUCE - Framework for multi-platform audio applications
• clap-juce-extensions - CLAP support for JUCE
• Free Clip by Venn Audio
• The Audio Programmer for providing extensive video lessons on audio programming and DSP
• Testers-volunteers and active supporters - George Budilov, Blue Four, Garmata Music
• Everyone who provided active feedback all this time