clap-plugins

KO | EN

gitlite — search

#python #react #llm #go #android #machine-learning #deep-learning #linux #docker #java #nodejs #windows #security #open-source

(★ 100)

No description available.

clap-plugins Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

- [Example Clap Plugins](#example-clap-plugins)
  - [Notes on GUI, static build vs dynamic build and symbols](#notes-on-gui-static-build-vs-dynamic-build-and-symbols)
- [Building on various platforms](#building-on-various-platforms)
  - [Headless](#headless)
  - [macOS with vcpkg](#macos-with-vcpkg)
  - [Windows](#windows)
    - [Enable long path support](#enable-long-path-support)
    - [Build](#build)
  - [Linux, using vcpkg (static)](#linux-using-vcpkg-static)

# Example Clap Plugins

This repo serves as an example to demonstrate how to create a CLAP plugin.

## Notes on GUI, static build vs dynamic build and symbols

The plugins use Qt for the GUI.

It is fine to dynamically link to Qt for a host, but it is very dangerous for a plugin.

Also one very important aspect of the plugin is the distribution.
Ideally a clap plugin should be self contained: it should not rely upon symbols from the host,
and it should export only one symbol: `clap_entry`.

You should be aware that even if you hide all your symbols some may still remain visible
at unexpected places. Objective-C seems to register every classes including those coming from
plugins in a **flat namespace**. Which means that if two plugins define two different
Objective-C classes but with the same, they will clash which will result in undeflined behavior.

Qt uses a few Objective-C classes on macOS. So it is crucial to use `QT_NAMESPACE`.

We abstracted the relation between the plugin and the GUI:
[`AbstractGui`](plugins/gui/abstract-gui.hh) and [`AbstractGuiListener`](plugins/gui/abstract-gui-listener.hh)
which lets us transparently insert proxies.

The GUI itself work with proxy objects to the parameters, transport info, ...
They are then bound into QML objects.
See [`Knob.qml`](plugins/gui/qml/clap/Knob.qml) and [`parameter-proxy.hh`](plugins/gui/parameter-proxy.hh).

# Building on various platforms

## Headless

This build variant doesn't include the GUI and is **much** faster to build due to the lack of dependencies.

```bash
git clone --recurse-submodules https://github.com/free-audio/clap-plugins
cd clap-plugins
cmake --preset ninja-headless
cmake --build --preset ninja-headless
```

## macOS with vcpkg

```shell
# Install build tools
brew install cmake ninja autoconf automake pkg-config libtool

# Checkout the code
git clone --recurse-submodules https://github.com/free-audio/clap-plugins
cd clap-plugins
scripts/build-gui.sh
```

## Windows

### Enable long path support

Make sure your system supports long paths. Run this in an administrator PowerShell:

```powershell
New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force
```

Reference: https://docs.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=powershell

### Build

Install **Visual Studio 2022**; you can install it from the **Microsoft Store**. It can also install **git** and **CMake** for you.

Use the following command inside `Powershell`:
```ps1
# Checkout the code very close to the root to avoid windows long path issues...
cd c:\
git clone --recurse-submodules https://github.com/free-audio/clap-plugins c-p
cd c-p

Powershell.exe -noexit -executionpolicy bypass -File .\scripts\build-gui.ps1
```

## Linux, using vcpkg (static)

```bash
# on unbuntu, adapt to your distribution and package manager
sudo apt install git ninja-build cmake

# on archlinux, adapt to your distribution and package manager
sudo pacman -S git ninja cmake

git clone --recurse-submodules https://github.com/free-audio/clap-plugins
cd clap-plugins
scripts/build-gui.sh
```

clap-plugins

clap-plugins Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

clap-plugins

clap-plugins Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README