Git Product home page Git Product logo

ykchorus's Introduction

YK Chorus

A chorus effect inspired by the one found in certain well-known Japanese vintage analog synthesizers (You Know which).

screenshot

Formats

This audio effect supports a variety of audio and plug-in frameworks:

  • CLAP
  • DSSI
  • JACK (stand-alone program with GUI)
  • LADSPA
  • LV2
  • VST2
  • VST3

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/ykchorus.git
$ cd ykchorus
$ make

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 (<prefix>/lib/clap)
  • LADSPA: LADSPA_DIR (<prefix>/lib/ladspa)
  • LV2: LV2_DIR (<prefix>/lib/lv2)
  • VST2: VST2_DIR (<prefix>/lib/vst)
  • VST3: VST3_DIR (<prefix>/lib/vst3)

Example: make DESTDIR=/tmp/build-root VST_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 environment variables differ depending on the target OS.

Prerequisites

  • The GCC C++ compiler and the usual associated software build tools (make, etc.).

    Debian / Ubuntu users should install the build-essential package to get these.

  • patch

  • pkgconf

The CLAP, LV2, LADSPA, VST2 (vestige) and VST3 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 plug-in formats.

Some formats do have additional dependencies, though:

  • JACK client (stand-alone command line program): JACK development library and headers and pkgconf file.
  • GUI (JACK, LV2, VST2): OpenGL development library and headers and pkgconf file (provided by the libglvnd or similar package on Linux). On Linux also X11 development library and headers and pkgconf file.

Optional (only needed for checking plugins after building them):

License

This software is distributed under the GNU General Public License Version 2.

See the file LICENSE for more information.

Author

This software project was put together by Christopher Arndt.

Acknowledgements

Chorus DSP engine taken from the TAL Noisemaker software synthesizer by Patrick Kunz, Togu Audio Line, Inc., released under the GPL-2.0.

Build using the DISTRHO Plugin Framework (DPF) and set up with the cookiecutter-dpf-effect project template.

Toggle switch image by "az" from Knob Gallery, licensed under the Creative Commons CC-BY license, rotary knob image by "geoghela", published to the CC0 Public Domain.

ykchorus's People

Contributors

spotlightkid avatar trebmuh avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

sibilu

ykchorus's Issues

[Feature request] StudioRack integration

It's an open-source plugin manager called StudioRack:
https://github.com/studiorack

The aim of the project is to provide a free open-source way to manage plugin dependencies and their versions. It would involve the following steps:

Publish a Github release containing the plugin source along with metadata plugins.json
Tag your Github repository with studiorack-plugin so it can be discovered
Wait for the studiorack-registry to index your plugin (every 24 hours)
Check the registry feed for your plugin to appear

new readme image

image
i aiupscaled it. maybe you could incorporate the nicer background into the actual clap?

Build with UI broken

DGL (inside DPF folder) needs to be build first in order for the plugin + ui to be build.
Otherwise we get build errors on a fresh clone.

Misleading build requirements

The build requirements on the README mention that one needs LADSPA, DSSI and/or LV2 headers.
But plugin headers are never needed with DPF, as it already contains a copy of them.

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.