https://github.com/spotlightkid/cchorus
A versatile stereo chorus, multi-format audio effect plugin
https://github.com/spotlightkid/cchorus
audio-effect chorus clap clap-plugin faust-dsp ladspa ladspa-plugin lv2 lv2-plugin vst2 vst2-plugin vst3 vst3-plugin
Last synced: about 1 month ago
JSON representation
A versatile stereo chorus, multi-format audio effect plugin
- Host: GitHub
- URL: https://github.com/spotlightkid/cchorus
- Owner: SpotlightKid
- License: other
- Created: 2023-10-08T10:35:45.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-22T13:13:54.000Z (6 months ago)
- Last Synced: 2025-03-26T04:24:03.527Z (about 2 months ago)
- Topics: audio-effect, chorus, clap, clap-plugin, faust-dsp, ladspa, ladspa-plugin, lv2, lv2-plugin, vst2, vst2-plugin, vst3, vst3-plugin
- Language: C++
- Homepage:
- Size: 140 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# CChorus
A versatile stereo chorus effect
## Formats
This plugin is available in the following plugin formats by default:
* [CLAP] (`de.chrisarndt.cchorus`)
* [LADSPA] (`cchorus-ladspa.so`)
* [LV2] (`https://chrisarndt.de/plugins/cchorus`)
* [VST3][vst] (`cchorus.vst3`)
* [VST2][vst] (`cchorus-vst.so`)
Some formats are not available on all operating systems, and building of
unneeded formats can be disabled when compiling (see
["Compiling"](#compiling)):
The plugin depends on the host to provide a generic UI to control parameters.
## Compiling
Make sure you have installed the required build tools and libraries (see
section "Prerequisites" below) and then clone this repository (including
sub-modules) and simply run `make` in the project's root directory:
$ git clone --recursive https://github.com/SpotlightKid/cchorus.git
$ cd cchorus
$ make
To enable/disable building specific plugin formats, pass options like
`BUILD_LADSPA=true` resp. `BUILD_VST2=false` to `make`. For example:
make BUILD_VST2=false
The same settings must be passed to `make install` to also (not) install
these plugin formats.
## Installation
To install all plugin formats to their appropriate system-wide location, run
the following command (root priviledges may be required):
make install
The makefiles support the usual `PREFIX` and `DESTDIR` variables to change the
installation prefix and set an installation root directory (defaulty: empty).
`PREFIX` defaults to `/usr/local`, but on macOS and Windows it is not used,
since the system-wide installation directories for plugins are fixed.
Use make's `-n` option to see where the plugins would be installed without
actually installing them.
You can also set the installation directory for each plugin format with a
dedicated makefile variable.
* CLAP: `CLAP_DIR` (`/lib/clap`)
* LADSPA: `LADSPA_DIR` (`/lib/ladspa`)
* LV2: `LV2_DIR` (`/lib/lv2`)
* VST2: `VST2_DIR` (`/lib/vst`)
* VST3: `VST3_DIR` (`/lib/vst3`)
Example:
make DESTDIR=/tmp/build-root BUILD_VST2=true VST2_DIR=/usr/lib/lxvst install
To install the plugins only for your current user account, run
`make install-user`.
Again, you can also set the installation directory for each plugin format with
a dedicated makefile variable.
* CLAP: `USER_CLAP_DIR` (`$HOME/.clap`)
* LADSPA: `USER_LADSPA_DIR` (`$HOME/.ladspa`)
* LV2: `USER_LV2_DIR` (`$HOME/.lv2`)
* VST2: `USER_VST2_DIR` (`$HOME/.vst`)
* VST3: `USER_VST3_DIR` (`$HOME/.vst3`)
*Note: The given default values for all of the above listed makefile
variables differ depending on the target OS.*
## Prerequisites
* The GCC C++ compiler, library and the usual associated software build tools
(`make`, etc.).
Debian / Ubuntu users should install the `build-essential` package
to get these, Arch users the `base-devel` meta package.
* `patch`
* [pkgconf]
* The [faustdoctor] post-processor and [FAUST] (optional)
The [CLAP], [LV2], [LADSPA], [VST2][vst] (Xaymar VST2SDK) and [VST3][vst]
headers are included in the [DPF] framework, which is integrated as a Git
sub-module. These need not be installed separately to build the software in
the respective plugin formats.
`faustdoctor` and FAUST are only needed to re-generate C++ source and header
files if the FAUST DSP source files in the `faust` directory are changed.
## Author
This software was created by *Christopher Arndt*.
## License
This plugin is released under the *MIT* license. Please see the
[LICENSE.md](./LICENSE.md) file for details.
## Acknowledgements
The DSP code is generated from the FAUST sources via the [faustdoctor]
post-processor.
The project is built using the DISTRHO Plugin Framework ([DPF]) and was created
from the [dpf-faust-project-template] using [copier].
[automatic double tracking]: https://en.wikipedia.org/wiki/Automatic_double_tracking
[clap]: https://cleveraudio.org/
[dpf-faust-project-template]: https://github.com/SpotlightKid/dpf-faust-project-template
[copier]: https://copier.readthedocs.io/en/stable/
[dpf]: https://github.com/DISTRHO/DPF
[faust]: https://faust.grame.fr/
[faustdoctor]: https://github.com/SpotlightKid/faustdoctor
[ladspa]: https://www.ladspa.org/
[lv2]: https://lv2plug.in/
[pkgconf]: https://github.com/pkgconf/pkgconf
[vst]: https://en.wikipedia.org/wiki/Virtual_Studio_Technology