Giter Club home page Giter Club logo

scons_faust's Introduction

An SCons Tool for FAUST

Introduction

This is an SCons tool for compiling FAUST programs. It adds various builders to your construction environment: Faust, FaustXML, FaustSVG, FaustSC, and FaustHaskell. Their behaviour can be modified by changing various construction variables (see "Usage" below).

This tool is based on a FAUST tool I found here, but has been heavily modified to behave more nicely and to also work with FAUST2 (e.g., don’t force architecture files to end with ".cpp").

Installation

The SCons FAUST tool depends on the obvious:

  • Python (2.5 or newer)

  • SCons

  • FAUST (along with all the dependencies of architecture files you use)

If your project uses git, you might consider adding this repository as a git submodule in the site_scons/site_tools directory in faust. Otherwise, you can copy the repository into your projects site_scons/site_tools directory into a subdirectory named faust. Alternatively, you could clone the repository into $HOME/.scons/site_scons/site_tools, again, into a subdirectory named faust.

Usage

Use this as you would any other SCons tool: add it to the tools argument of Environment(), for example:

env = Environment(tools = ['default', 'faust'])

or manually add it using env.Tool().

To compile a FAUST DSP, you use the Faust() builder:

dsp = env.Faust(['some_dsp.dsp'])

To manipulate the behaviour of the builders, you can specify the following construction variables (variables for internal use are not listed here):

Variable name Function

FAUST_FAUST

The name of the faust executable.

FAUST_LANG

The FAUST backend (e.g., "cpp").

FAUST_ARCHITECTURE

The architecture file to compile with.

FAUST_FLAGS

Miscellaneous flags passed to faust and faust2sc.

FAUST_PATH

The FAUST library search path.

FAUST2SC_FAUST2SC

The name of the faust2sc executable.

FAUST2SC_PREFIX

The class or module prefix (FaustSC)

FAUST2SC_HASKELL_MODULE

The class or module prefix (FaustHaskell).

Furthermore, you can inspect the version of faust and faust2sc with the construction variables FAUST_VERSION and FAUST2SC_VERSION.

License

See the file LICENSE.

scons_faust's People

Contributors

marcecj avatar

Watchers

 avatar

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.