jpcima / faustpp

A post-processor for faust, which allows to generate with more flexibility
Boost Software License 1.0
23 stars 3 forks source link
faust

faustpp

Build Status

A post-processor for faust, which allows to generate with more flexibility

This is a source transformation tool based on the Faust compiler.

It permits to arrange the way how faust source is generated with greater flexibility.

Using a template language known as Jinja2, it is allowed to manipulate metadata with iteration and conditional constructs, to easily generate custom code tailored for the job. Custom metadata can be handled by the template mechanism.

Usage

For detailed information, refer to the documentation.

An example is provided in the architectures directory. It is usable and illustrates many features.

The example is able to create a custom processor class. It has these abilities:

This example can be used to generate any file. Pass options to the Faust compiler using -X. In this particular example, you should pass a definition of Identifier in order to name the result class, which is done with the option -D.

faustpp -X-vec -DIdentifier=MyEffect -a generic.cpp effect.dsp > effect.cpp
faustpp -X-vec -DIdentifier=MyEffect -a generic.hpp effect.dsp > effect.hpp

Installation

Assuming you have Python installed (>= 3), change directory to the working copy and type this command:

pip install .

Release notes

1.0.0