# Gearmulator

[![CMake][s0]][l0] [![Nightly][s1]][l1] ![GPLv3][s2] [![Discord][s3]][l3]

[s0]: https://github.com/dsp56300/gearmulator/actions/workflows/cmake.yml/badge.svg
[l0]: https://github.com/dsp56300/gearmulator/actions/workflows/cmake.yml

[s1]: https://github.com/dsp56300/gearmulator/actions/workflows/nightly.yml/badge.svg
[l1]: https://github.com/dsp56300/gearmulator/actions/workflows/nightly.yml

[s2]: https://img.shields.io/badge/license-GPLv3-blue.svg

[s3]: https://img.shields.io/discord/829099347975208970?label=Discord
[l3]: https://discord.gg/WJ9cxySnsM

## Low Level Emulation of classic VA synths & effects of the late 90s/2000s

This project emulates the used ICs of various musical devices to run the original firmware - aka ROM - as audio plugins.

The supported plugin formats are [FST](https://github.com/pierreguillot/FTS), VST3, AU, [CLAP](https://cleveraudio.org/) and [LV2](https://lv2plug.in/).

Supported architectures: 64 bit x86 aka x64 and ARM aarch64 (Raspberry Pi, Apple Silicon). Note that 32 bit
architectures are not supported!

Platforms: Windows 7+, macOS 10.13+, Linux

At the moment, the following devices are supported:

* Osirus: Access Virus A,B,C
* OsTIrus: Access Virus TI/TI2/Snow
* Vavra: Waldorf microQ
* Xenia: Waldorf Microwave II/XT
* Nodal Red 2x: Clavia Nord Lead/Rack 2x
* JE-8086: Roland JP-8000
* 88emu: Roland MT-32 (both boards), CM-32L, CM-32P, CM-64, MV-30 and Sound Canvas family (SC-55, SC-88, SC-88pro, SC-8820, SC-8850 and variants)

### Compiling

The emulator compiles on any platform that supports C++17.

The build system used is [cmake](https://cmake.org/).

#### cmake options

| Variable | Description | Default |
|--|--|--|
| gearmulator_BUILD_JUCEPLUGIN | Build Juce based audio plugins | on |
| gearmulator_BUILD_JUCEPLUGIN_CLAP | Build CLAP plugins | on |
| gearmulator_BUILD_JUCEPLUGIN_LV2 | Build LV2 plugins | on |
| gearmulator_BUILD_FX_PLUGIN | Additionally build FX versions of all plugins | off |

Additional options to select which devices to build:

| Variable | Description | Default |
|--|--|--|
| gearmulator_SYNTH_OSIRUS | Build Osirus | on |
| gearmulator_SYNTH_OSTIRUS | Build OsTIrus | on |
| gearmulator_SYNTH_VAVRA | Build Vavra | on |
| gearmulator_SYNTH_XENIA | Build Xenia | on |
| gearmulator_SYNTH_NODALRED2X | Build Nodal Red 2x | on |
| gearmulator_SYNTH_JE8086 | Build JE-8086 | on |
| gearmulator_SYNTH_88EMU | Build 88emu | on |
| gearmulator_COMPONENT_DSPBRIDGE | Build the DSPBridge server and the device plugins it loads | on |

### Join us on Discord

If you want to help or just want to follow the state of the project, feel free to join us on Discord: https://discord.gg/WJ9cxySnsM

### Visit our Homepage

🎵 Visit our homepage for Audio and Video examples 🎧:
[The Usual Suspects Website](https://dsp56300.com/)