{"id":15628335,"url":"https://github.com/vvvar/peakeater","last_synced_at":"2025-04-07T06:08:32.186Z","repository":{"id":38378712,"uuid":"335593210","full_name":"vvvar/PeakEater","owner":"vvvar","description":"PeakEater is a free open-source cross-platform VST3/AU/LV2/CLAP wave shaper plugin","archived":false,"fork":false,"pushed_at":"2023-08-20T23:56:47.000Z","size":12969,"stargazers_count":346,"open_issues_count":39,"forks_count":16,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-03-31T04:07:48.032Z","etag":null,"topics":["audio","audio-unit","audio-units","clap","cpp","distortion","gain","juce","linux","lv2","lv2-plugin","macos","meters","vst3","vst3-plugin","waveshaper","windows"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vvvar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-02-03T10:51:14.000Z","updated_at":"2025-03-28T05:10:51.000Z","dependencies_parsed_at":"2024-10-03T10:22:19.254Z","dependency_job_id":"1c88c56f-558c-4679-be2e-1c78df92d956","html_url":"https://github.com/vvvar/PeakEater","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vvvar%2FPeakEater","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vvvar%2FPeakEater/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vvvar%2FPeakEater/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vvvar%2FPeakEater/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vvvar","download_url":"https://codeload.github.com/vvvar/PeakEater/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247601448,"owners_count":20964864,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["audio","audio-unit","audio-units","clap","cpp","distortion","gain","juce","linux","lv2","lv2-plugin","macos","meters","vst3","vst3-plugin","waveshaper","windows"],"created_at":"2024-10-03T10:21:59.261Z","updated_at":"2025-04-07T06:08:32.150Z","avatar_url":"https://github.com/vvvar.png","language":"C++","readme":"\u003c!-- HEADER --\u003e\n\n\u003ch1 align=\"center\"\u003e\u003ca href=\"https://github.com/vvvar/PeakEater\"\u003e\u003cimg width=\"100\" src=\"assets/icon-mac.png\" /\u003e\u003c/a\u003e\u003c/h1\u003e\n\u003ch1 align=\"center\"\u003ePeakEater\u003c/h1\u003e\n\u003cp align=\"center\"\u003eFree open-source VST3/AU/LV2/CLAP wave shaping plugin for macOS, Windows and Linux.\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/vvvar/PeakEater/releases/latest\"\u003e\u003cb\u003eDownload\u003c/b\u003e\u003c/a\u003e\n    · \u003ca target=\"_blank\" href=\"https://github.com/vvvar/PeakEater/issues/new?assignees=\u0026labels=Feature+Request\u0026template=feature_request.md\u0026title=\"\u003e\u003cb\u003eRequest Feature\u003c/b\u003e\u003c/a\u003e · \u003ca target=\"_blank\" href=\"https://github.com/vvvar/PeakEater/issues/new?assignees=\u0026labels=Bug\u0026template=bug_report.md\u0026title=%5BBug%5D\"\u003e\u003cb\u003eReport Bug\u003c/b\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n![screenshot](assets/screenshots/screenshot-mac.png)\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\nTable of Contents\n\n- [About](#about)\n- [Features](#features)\n  - [Input/Output RMS Meters](#rms-meters)\n  - [Input \u0026 Output Gain](#input--output-gain)\n  - [Link Input with Output](#link-input-with-output)\n  - [Ceiling Control](#ceiling-control)\n  - [Visualizer](#visualizer)\n  - [Analyzer](#analyzer)\n  - [Configurable Tick marks](#configurable-tick-marks)\n  - [Configurable Scaling](#configurable-scaling)\n  - [6 Clipping Types](#6-clipping-types)\n  - [Oversampling](#oversampling)\n  - [Dry/Wet](#dry-wet)\n  - [Bypass Mode](#bypass-mode)\n  - [Resizing](#resizing)\n  - [VST3, AU, LV2 and CLAP Support](#vst3-au-lv2-and-clap-support)\n  - [macOS, Windows and Linux Support](#available-on-all-major-platforms)\n  - [Verified by Pluginval](#verified-by-pluginval)\n- [Installation](#installation)\n  - [macOS](#macos)\n  - [Windows](#windows)\n  - [Linux](#linux)\n- [Building from sources](#building-from-sources)\n  - [Prerequisites](#prerequisites)\n  - [Build](#build)\n- [Contributing](#contributing)\n- [License](#license)\n- [Acknowledgments](#acknowledgments)\n\n\u003c!-- ABOUT --\u003e\n\n## About\n\nPeakEater is a free, easy-to-use wave-shaping plugin. PeakEater lets you choose between different [wave-shaping](https://en.wikipedia.org/wiki/Waveshaper) [functions](https://en.wikipedia.org/wiki/Sigmoid_function) 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 \u003ca href=\"#features\"\u003efeatures\u003c/a\u003e such as multiple clipping types, oversampling and visualizations of a clipping process that aims to make clipping easy and fun.\n\n## Features\n\n### RMS Meters\n\n\u003cimg src=\"assets/screenshots/screenshot-in.png\" alt=\"input-rms-screen\" height=\"250\"/\u003e\u003c---\u003e\u003cimg src=\"assets/screenshots/screenshot-out.png\" alt=\"output-rms-screen\" height=\"250\"/\u003e\n\nSee how loud the signal was before and after the plugin.\n\n### Input \u0026 Output Gain\n\n\u003cimg src=\"assets/screenshots/screenshot-in-gain.png\" alt=\"input-gain-screen\" height=\"100\"/\u003e\u003c---\u003e\u003cimg src=\"assets/screenshots/screenshot-out-gain.png\" alt=\"output-gain-screen\" height=\"100\"/\u003e\n\nAdjusts 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.\n\n### Link Input with Output\n\n\u003cimg src=\"assets/screenshots/screenshot-link.png\" alt=\"link-in-out\" height=\"100\"/\u003e\n\nUse 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.\n\n### Ceiling control\n\n\u003cimg src=\"assets/screenshots/screenshot-ceiling-knob.png\" alt=\"link-in-out\" height=\"100\"/\u003e\n\nControl 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.\n\n### Visualizer\n\n\u003cimg src=\"assets/screenshots/screenshot-clip-visualizer.png\" alt=\"clip-visualizer\" height=\"100\"/\u003e\n\nDisplays magnitude(in dB's) so you can see how peaks were eaten over time.\n\n### Analyzer\n\n\u003cimg src=\"assets/screenshots/screenshot-analyzer.png\" alt=\"clip-analyzer\" height=\"100\"/\u003e\n\nShows 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.\n\n### Configurable Tick marks\n\n\u003cimg src=\"assets/screenshots/screenshot-switch-ticks.gif\" alt=\"switch-db-level-scales\" width=\"400\"/\u003e\n\nRight-Mouse-Click on Visualizer to switch between different tick marks.\n\n## Configurable Scaling\n\n\u003cimg src=\"assets/screenshots/screenshot-scaling.gif\" alt=\"switch-db-level-scales\" width=\"400\"/\u003e\n\nAlso, you can switch between linear and non-linear scaling.\n\n### 6 Clipping Types\n\n\u003cimg src=\"assets/screenshots/screenshot-clip-type.png\" alt=\"clip-type\" height=\"100\"/\u003e\n\nChoose between 6 clipping functions, from Hard clipping to different types of Soft Clip (Up to Arctangent).\nAvailable clipping functions are:\n\n- Hard\n- Quintic\n- Cubic\n- Tangent\n- Algebraic\n- Arctangent\n\nYou can read more about the difference between Hard and Soft clipping [here](https://www.hackaudio.com/digital-signal-processing/distortion-effects/hard-clipping/) and [here](https://www.hackaudio.com/digital-signal-processing/distortion-effects/soft-clipping/).\n\n### Oversampling\n\n\u003cimg src=\"assets/screenshots/screenshot-oversample.png\" alt=\"oversample\" height=\"100\"/\u003e\n\nChoose between 2x, 4x, 8x, 16x and 32x oversampling to avoid signal aliasing. You can also turn off oversampling.\n\n\u003e **Note** High values of oversampling may hurt CPU performance.\n\nYou can read more about oversampling [here](https://www.nickwritesablog.com/introduction-to-oversampling-for-alias-reduction/).\n\n### \u003ca id=\"dry-wet\"\u003e\u003c/a\u003e Dry/Wet\n\n\u003cimg src=\"assets/screenshots/dry-wet.gif\" alt=\"drywet\" height=\"200\"/\u003e\n\nControl mix between original and clipped signal. Useful when the clipper is used as an exciter.\n\n### Bypass mode\n\n\u003cimg src=\"assets/screenshots/screenshot-bypass.png\" alt=\"bypass\" height=\"100\"/\u003e\n\nBypasses all plugin's processing. Useful when you need to make side-by-side comparisons before and after processing.\n\n### Resizing\n\n\u003cimg src=\"assets/screenshots/screenshot-resize.png\" alt=\"bypass\" height=\"100\"/\u003e\n\nDrag the corner to change the size of the window.\n\n### VST3, AU, LV2 and CLAP support\n\n\u003cimg src=\"assets/vendorIcons/vst3.png\" alt=\"vst3\" height=\"50\"/\u003e \u003cimg src=\"assets/vendorIcons/audio-units.png\" alt=\"au\" height=\"50\"/\u003e \u003cimg src=\"assets/vendorIcons/lv2.png\" alt=\"lv2\" height=\"50\"/\u003e \u003cimg src=\"assets/vendorIcons/clap.png\" alt=\"clap\" height=\"50\"/\u003e\n\nYou can use either VST3, AU (macOS only), LV2 or CLAP type of plugin.\n\n\u003e **Warning** LV2 and CLAP support is experimental and may be unstable.\n\n### Available on all major platforms\n\n\u003cimg src=\"assets/vendorIcons/macOS.png\" alt=\"macOS\" height=\"30\"/\u003e \u003cimg src=\"assets/vendorIcons/windows.png\" alt=\"windows\" height=\"30\"/\u003e \u003cimg src=\"assets/vendorIcons/linux.png\" alt=\"linux\" height=\"30\"/\u003e\n\nYou can use it on macOS, Windows or Linux.\n\n\u003e **Warning** Linux support is experimental and may be unstable.\n\n### \u003ca id=\"verified-by-pluginval\"\u003e\u003c/a\u003e Verified by Pluginval \u003cimg src=\"assets/pluginval.png\" alt=\"Pluginval\" height=\"20\"/\u003e\n\n\u003e 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](https://github.com/Tracktion/pluginval/tree/develop)\n\nVST3 and AU versions are verified by [Tracktion Pluginval](https://www.tracktion.com/develop/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).\n\n\u003c!-- INSTALLATION --\u003e\n\n## Installation\n\n1. Go to \u003ca href=\"https://github.com/vvvar/PeakEater/releases/latest\"\u003e\u003cb\u003ethe latest release\u003c/b\u003e\u003c/a\u003e page.\n2. In the Assets section choose the installer for your platform.\n\n### macOS\n\nSupported formats are VST3, AU, LV2 and CLAP.\nTested on: macOS 12.6.2\nProcessors: Intel(x86_64), Apple Silicon M1+(arm64)\n\nInstall the plugin via the **.dmg** file. Drag the plugin in a format of your choice into the folder with your plugins.\n\n\u003e **Note**\u003cbr /\u003e\n\u003e 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.\n\n\u003e **Note**\u003cbr /\u003e\n\u003e Due to macOS restrictions, you cannot drag files into untrusted directories. Therefore, double click on directory shortcut, open it and drag it directly there.\n\n\u003e **Note**\u003cbr /\u003e\n\u003e VST3 directory is `/Library/Audio/Plug-ins/VST3`\u003cbr /\u003e\n\u003e AU directory is `/Library/Audio/Plug-ins/Components`\u003cbr /\u003e\n\u003e LV2 directory is `/Library/Audio/Plug-Ins/LV2`\u003cbr /\u003e\n\u003e CLAP directory is `/Library/Audio/Plug-Ins/CLAP`\u003cbr /\u003e\n\n### Windows\n\nSupported formats are VST3, AU, LV2 and CLAP.\nTested on: Windows 10 21H2\n\nExtract the zip and copy the plugin in the format of choice into the folder with your plugins.\n\n\u003e **Note**\u003cbr /\u003e\n\u003e Standard VST3 folder is `C:\\Program Files\\Common Files\\VST3`\u003cbr /\u003e\n\u003e Standard LV2 folder is `C:\\Program Files\\Common Files\\LV2`\u003cbr /\u003e\n\u003e Standard CLAP folder is `C:\\Program Files\\Common Files\\CLAP`\u003cbr /\u003e\n\n### Linux\n\nSupported formats are VST3, AU, LV2 and CLAP.\nTested on: Ubuntu 18.04\n\nExtract the zip and copy the plugin in a format of your choice into the folder with your plugins.\n\n\u003e **Note**\u003cbr /\u003e\n\u003e Standard VST3 directory is `~/.vst3`\u003cbr /\u003e\n\u003e Standard LV2 directory is `~/.lv2`\u003cbr /\u003e\n\u003e Standard CLAP directory is `~/.clap`\u003cbr /\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n\n## Building from sources\n\n#### Prerequisites\n\n- [Just](https://github.com/casey/just) 1.13.0+\n- [Python](https://www.python.org) 3.11.4+\n- [Brew](https://brew.sh) 4.0.23+(macOS only)\n- [C++ Build Tools for Visual Studio 2022](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022)(Windows only)\n- [Chocolatey](https://chocolatey.org) 1.4.0+(Windows only)\n\n\u003e **Note**\u003cbr /\u003e\n\u003e It is recommended to use PowerShell on Windows\n\n### Building\n\n```sh\njust setup\njust build\n```\n\nBuild artifacts will be stored in the `/build/Release/peakeater_artefacts`.\n\n### Code signing on macOS\n\nBy default, code signing is turned **off**. To enable it:\n\n1. Make sure you have a valid [Apple Developer ID](https://developer.apple.com/support/developer-id/), [Apple Team ID](https://developer.apple.com/forums/thread/77563) and your signing certificate installed on your Mac(Use [this guide](https://melatonin.dev/blog/how-to-code-sign-and-notarize-macos-audio-plugins-in-ci/) as a starting point. Be aware - they are **not free**)\n\n2. 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):\n\n```env\nMACOS_APPLE_DEVELOPER_ID=\"Developer ID Application: John Doe (XXXXX6XX42)\"\nMACOS_APPLE_ID=\"johndoe@gmail.com\"\nMACOS_APPLE_PASSWORD=\"jhnd-oejh-ndoe-jhnn\"\nMACOS_APPLE_TEAM_ID=\"JHNDO6E642\"\n```\n\n3. Setup the `notarytool`(used to notarize DMG):\n\n```sh\njust setup-notarytool\n```\n\nYou should see something like this in the terminal:\n\n```\nxcrun notarytool store-credentials \"APPLE_SIGN_PROFILE\" --apple-id $MACOS_APPLE_ID --password $MACOS_APPLE_PASSWORD --team-id $MACOS_APPLE_TEAM_ID\n\nThis process stores your credentials securely in the Keychain. You reference these credentials later using a profile name.\n\nValidating your credentials...\nSuccess. Credentials validated.\nCredentials saved to Keychain.\nTo use them, specify `--keychain-profile \"APPLE_SIGN_PROFILE\"`\n```\n\nAfter this just run the build. CMake will automatically sign all binaries.\n\n\u003c!-- CONTRIBUTING --\u003e\n\n## Contributing\n\nIf you found a bug, please report it using [Bug Template](https://github.com/vvvar/PeakEater/issues/new/choose).\nIf you have any feedback, feel free to open a feedback ticket using [Feedback Template](https://github.com/vvvar/PeakEater/issues/new/choose).\nIf you have a specific feature request, please create it using [Feature Request Template](https://github.com/vvvar/PeakEater/issues/new/choose).\nIf you have a pull request, then just make it using common [Fork \u0026 PR flow](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).\n\n\u003c!-- LICENSE --\u003e\n\n## License\n\nDistributed under the GPL-3.0 License. See [`LICENSE.md`](https://github.com/vvvar/PeakEater/blob/master/LICENSE.md) for more information.\n\n\u003c!-- ACKNOWLEDGEMENTS --\u003e\n\n## Acknowledgments\n\n- [JUCE](https://github.com/juce-framework/JUCE) - Framework for multi-platform audio applications\n- [clap-juce-extensions](https://github.com/free-audio/clap-juce-extensions) - CLAP support for JUCE\n- [Free Clip](https://gitlab.com/JHVenn/Free-Clip) by [Venn Audio](https://www.vennaudio.com)\n- [The Audio Programmer](https://theaudioprogrammer.com) for providing extensive video lessons on audio programming and DSP\n- Testers-volunteers and active supporters - [George Budilov](), [Blue Four](https://soundcloud.com/bluefour), Garmata Music\n- Everyone who provided active feedback all this time\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvvvar%2Fpeakeater","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvvvar%2Fpeakeater","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvvvar%2Fpeakeater/lists"}