README.md
1# faust2audiokit
2
3The **faust2audiokit** tool transforms a Faust DSP program into a fully working [AudioKit](https://audiokit.io) node. The result can be a monophonic DSP or a MIDI controllable polyphonic one (when the DSP describes an instrument, following the `freq, gain, gate` [parameter naming convention](https://faustdoc.grame.fr/manual/midi/#midi-polyphony-support)).
4
5## How to use
6
7**faust2audiokit** is used with the following command:
8
9`faust2audiokit [-midi] [-nvoices <num>] [additional Faust options (-vec -vs 8...)] <file.dsp>`
10
11Here are the available options:
12
13- `-midi` : activates MIDI control
14- `-nvoices <num>` : to produce a polyphonic self-contained DSP with <num> voices, ready to be used with MIDI
15
16The result is a folder containing a `FaustDSP.mm` file including the Faust generated C++ class for the DSP, and a `FaustXXX.swift` swift wrapper file, to be added and compiled in the AudioKit framework. Note that the generated C++ class takes the name of the compiled DSP, so that several different DSPs can be generated and used in a same project.
17