faustgen~

The swiss knife for Faust development in Max/MSP.

---

faustgen~ is a Max external prototyping environment for the Faust programming language with an ultra-short edit-compile-run cycle.

faustgen~ is based on the Faust library and on LLVM.

How to compile:

Prerequisites

• you must have Faust installed and the faust command available from the command line, and the compiled libfaust library.
• you must have downloaded the Max SDK.
• you must have cmake installed.
• [Windows] you must have libsndfile installed.

Project generation

faustgen~ project is based on cmake. It is recommended to build faustgen~ in a separate subfolder. It isolates the compilation process from the rest of the project. Creates this folder and generate your project using cmake.

$ mkdir build
$ cd build
$ cmake .. -DMAXSDK="/path/to/the/max/sdk/source/c74support" -G "your generator"

You must define the path to the Max SDK the first time you invoke cmake. Next the value is cached by cmake. On Windows, cmake assumes that the libsndfile library is installed in C:/Program Files/Mega-Nerd/libsndfile. To override, you cand define the LIBSNDFILE variable to an alternate location (i.e. add -DLIBSNDFILE=/path/to/libsndfile on the command line).

Note: on Windows, you should use the same runtime than the other libraries. Thus make sure everything is compiled with the same Visual Studio version (including LLVM). The current Faust version (2.13.14) makes use of the following cmake generator: "Visual Studio 14 2015 Win64". You must use the same for faustgen~.

Compiling

You can launch your IDE and proceed as usual or you can use cmake build command from your build folder:

$ cmake --build . --config Release

Packaging

Packaging is based on the cmake install target and on the resources found the package folder. Simply call the 'install' target:

$ cmake --build . --config Release --target install

On output, you should find a folder named faustgen in the package folder.

Note: on Mac OS, this folder is also compressed to the faustgen.dmg image file.

Using

Depending of the number of audio inputs and outputs described in the DSP source code, the faustgen~ object has:

• N inlets, the first one being the message control one and a regular audio inlet, an all other audio inlets
• M outlets, audio outs from 1 to M-2
• an output messages outlet
• the right most outlet is used to send MIDI messages if MIDI metadata are used in the DSP UI items

The faustgen~ object can be controlled with the following messages:

• polyphony <nvoices> : to set the DSP in polyphonic mode with nvoices (note that the DSP code has to follow the polyphonic convention)
• osc <IP inport outport xmit[0|1] bundle[0|1]>: to activate OSC control in input and output mode, possibly generating messages when xmit = 1, and in bundle mode when bundle = 1
• midievent <midi message>: to receive and decode MIDI messages
• init: to generate all inputs and outputs control messages as a message list [path, init, min, max] that will be sent on the output messages outlet
• dump: to generate all inputs and outputs control messages as a message list [path, cur, min, max] that will be sent on the output messages outlet
• mute: to mute audio rendering

When the object has bargraphs, their values are sent in the right most outlet as a message list [path, cur, min, max].

Limitations and known bugs

---

Grame - Centre National de Creation Musicale