plugdata

Plugin wrapper around Pure Data to allow patching in a wide selection of DAWs.

plugdata is a plugin wrapper for Pure Data, featuring a new GUI made with JUCE. This is still a WIP, and there are probably still some bugs. By default, it ships with the ELSE collection of externals and abstractions. The aim is to provide a more comfortable patching experience for a large selection of DAWs. It can also be used as a standalone replacement for pure-data.

Join the Discord here, for sharing patches, reporting issues or requesting features: https://discord.gg/eT2RxdF9Nq

Installation

-Windows:

• Get the installer from the latest official release

-MacOS:

• Option 1: Get the installer from the latest official release
• Option 2: Install the homebrew cask. I do not maintain this so it may be outdated.

-Linux:

• Option 1: OBS repository/packages The repository contains the packages plugdata, plugdata-vst3 and plugdata-lv2 (lv2-plugdata and vst3-plugdata on some distros). If you get a package without the repo, it will only contain the standalone version.

  • Plugin versions can be found here:
    • Deb/Ubuntu: https://software.opensuse.org/package/plugdata-vst3 and https://software.opensuse.org/package/plugdata-lv2
    • RPM based distros: https://software.opensuse.org/package/vst3-plugdata and https://software.opensuse.org/package/lv2-plugdata

• Option 2: Arch User Repository (Arch only). Has the plugdata-bin package for the latest stable version, or the plugdata-git package for the latest experimental build.

• Option 3: Get the binaries from the latest official release

You can also download a recent experimental build from our website

Build

git clone --recursive https://github.com/plugdata-team/plugdata.git
cd plugdata
mkdir build && cd build
cmake .. (the generator can be specified using -G"Unix Makefiles", -G"Xcode" or -G"Visual Studio 16 2019" -A x64)
cmake --build .

Important:

• plugdata requires cmake 3.21 or later to build CLAP plugins. If you use an older version of cmake, CLAP plugin builds will be disabled.
• Ensure that the git submodules are initialized and updated! You can use the --recursive option while cloning or git submodule update --init --recursive in the plugdata repository .
• On Linux, Juce framework requires to install dependencies, please refer to Linux Dependencies.md and use the full command.
• The CMake build system has been tested with Unix Makefiles, XCode, Visual Studio 17 2022 and Visual Studio 16 2019
• Extra build options:
  • -DQUICK_BUILD=1 will skip objects that take a long time to compile (All Gem objects, sfz~ and ffmpeg based audio players)
  • Gem, sfz~ and ffmpeg can also be disabled separately by passing "-DENABLE_GEM=0", "-DENABLE_SFIZZ=0", "-DENABLE_FFMPEG=0"
  • You can enable Google Perfetto performance tracing library by passing -DENABLE_PERFETTO=1. This blog post gives more insight on how to use it.
    • To trace function calls and get performance information, add TRACE_COMPONENT() to function bodies you want.
    • A faster way is a Python 3 script Resources/Scripts/add_perfetto_tracepoints.py that will add TRACE_COMPONENT() calls to matched function bodies in provided .cpp files. This means you don't have to add TRACE_COMPONENT() everywhere by hand. To use the script you must have a recent llvm (>= 19.1.3) and compatible libclang package installed.
    • Recommended compiling with Release mode on for most accurate profiling information.

Adding your own externals

You can use externals inside plugdata's plugin version by recompiling the externals along with plugdata. This can be achieved by making the following modification to plugdata:

• Add your sources to the "externals" target inside Libraries/CMakeLists.txt. Alternatively the source files can be placed inside the Libraries/ELSE/Source folder, as all .c files in that folder will be compiled automatically.
• In Source/Pd/Setup.cpp, add the setup function for your external. The best place to call your setup function is inside libpd_init_pdlua. initialiseELSE and initialiseCyclone will also work, but it has the side-effect that the externals will also be available under the else/* and cyclone/* prefix.

Corporate sponsors

Licensing

This project uses the JUCE framework, which is licensed under the GNU Affero General Public License (AGPL-3.0). Because of this, the compiled application (the full program built with JUCE) is distributed under the terms of the AGPL-3.0.

The plugdata source code that is directly included in this repository (not in any third-party submodule) is licensed under the regular GPL-3.0

Third-party components (pure-data, pd-else, pd-cyclone, pd-lua, libwebp, liblzma, heavylib, fftw3, ffmpeg, sfz~ and many more) included with plugdata are licensed under their own respective licenses.

Credits

• Logo designed by Joshua A.C. Newman, executed by Bas de Bruin
• Camomile by Pierre Guillot
• ELSE by Alexandre Torres Porres
• cyclone by Krzysztof Czaja, Hans-Christoph Steiner, Fred Jan Kraan, Alexandre Torres Porres, Derek Kwan, Matt Barber and others (note: Cyclone is included to offer an easy entry point for Max users but ELSE contains several alternatives to objects in Cyclone and Pure Data Vanilla itself also has some alternatives. Not only that, but objects that weren't cloned into Cyclone also have alternatives in ELSE, see: this)
• pd-lua by Claude Heiland-Allen, Albert Graef, and others
• Pure Data by Miller Puckette and others
• libpd by the Peter Brinkmann, Dan Wilcox and others
• Heavy/hvcc originally by Enzien Audio, maintained and modernised by Wasted Audio
• Juce by Raw Material Software Ltd.
• Inter font by Rasmus Andersson