Giter VIP home page Giter VIP logo

peakeater's Introduction

PeakEater

Free open-source VST3/AU/LV2/CLAP wave shaping plugin for macOS, Windows and Linux.

Download · Request Feature · Report Bug

screenshot

Table of Contents
  1. About
  2. Features
  3. Installation
  4. Building from sources
  5. Contributing
  6. License
  7. Acknowledgements

About

PeakEater is a free, easy to use waveshaping plugin. PeakEater lets you choose between different waveshaping functions to clip everything above ceiling level. Therefore, you can boost overall volume of your track safely without worying that some nasty peak would go above maximum allowed volume level of your DAW. It supports variours features such as multiple clipping types, oversampling and visualizations of clipping process that aims to make clipping easy and fun.

Features

Input & Output RMS Meters

input-rms-screen<--->output-rms-screen

See how loud signal was before and after plugin.

Input & Output Gain

input-gain-screen<--->output-gain-screen

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

Link Input with Output

link-in-out

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

link-in-out

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

Visualizer

clip-visualizer

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

Analyzer

clip-analyzer

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

Switchable scales

switch-db-level-scales

Right click on Visualizer to switch between different scales.

6 Clipping Types

clip-type

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

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

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

Oversampling

oversample

Choose between 2x, 4x, 8x, and 16x 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.

Bypass mode

bypass

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

Resizing

bypass

Drag the corner to change the size of the window.

VST3, AU, LV2 and CLAP support

vst3 au lv2 clap

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

macOS windows linux

You can use it on macOS, Windows or Linux.

Warning Linux support is experimental and may be unstable.

Installation

  1. Go to latest release page.
  2. In the Assets section choose installer for your platform.

macOS

Supported formats are: VST3, AU, LV2, CLAP. Tested on: macOS 12.6.2

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

Note
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
VST3 directory is /Library/Audio/Plug-ins/VST3
AU directory is /Library/Audio/Plug-ins/Components
LV2 directory is /Library/Audio/Plug-Ins/LV2
CLAP directory is /Library/Audio/Plug-Ins/CLAP

Windows

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

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

Note
Standard VST3 folder is C:\Program Files\Common Files\VST3
Standard LV2 folder is C:\Program Files\Common Files\LV2
Standard CLAP folder is C:\Program Files\Common Files\CLAP

Linux

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

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

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

Building from sources

Prerequisites

Build

Clone this repo:

git clone --recurse-submodules https://github.com/vvvar/PeakEater.git

If you're using VS Code, then use Build tasks provided in settings.json. For manual build, checkout proper versions of dependencies:

cd Dependencies/JUCE && git checkout 4e68af7 && cd ../clap-juce-extensions/JUCE && git checkout cf93cac

Run cmake build:

mkdir build && cd build
cmake .. -DJUCE_BUILD_EXAMPLES=OFF -DJUCE_BUILD_EXTRAS=ON
cmake --build .

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.

Acknowledgements

peakeater's People

Contributors

vvvar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.