table of contents
FAUST(1) | User Commands | FAUST(1) |
NAME¶
FAUST - functional programming language for realtime audio applicationsDESCRIPTION¶
FAUST (DSP to C++ compiler), Version 0.9.95 Copyright © 2002-2016, GRAME - Centre National de Creation Musicale. All rights reserved.usage: faust [options] file1 [file2 ...]
- where options represent zero or more compiler options and fileN represents a faust source file (.dsp extension).
options :¶
- -h
- print this --help message
- -v
- print compiler --version information
- -d
- print compilation --details
- -tg
- print the internal --task-graph in dot format file
- -sg
- print the internal --signal-graph in dot format file
- -ps
- print block-diagram --postscript file
- -svg
- print block-diagram --svg file
- -mdoc
- print --mathdoc of a Faust program in LaTeX format in a -mdoc directory
- -mdlang <l>
- load --mathdoc-lang <l> if translation file exists (<l> = en, fr, ...)
- -stripmdoc
- apply --strip-mdoc-tags when printing Faust -mdoc listings
- -sd
- try to further --simplify-diagrams before drawing them
-f <n> --fold <n> threshold during block-diagram generation (default 25 elements)
-mns <n> --max-name-size <n> threshold during block-diagram generation (default 40 char)
- -sn
- use --simple-names (without arguments) during block-diagram generation
- -xml
- generate an XML description file
- -json
- generate a JSON description file
- -blur
- add a --shadow-blur to SVG boxes
- -lb
- generate --left-balanced expressions
- -mb
- generate --mid-balanced expressions (default)
- -rb
- generate --right-balanced expressions
- -lt
- generate --less-temporaries in compiling delays
-mcd <n> --max-copy-delay <n> threshold between copy and ring buffer implementation (default 16 samples)
- -a <file>
- C++ architecture file
-i --inline-architecture-files
-cn <name> --class-name <name> specify the name of the dsp class to be used instead of mydsp
-t <sec> --timeout <sec>, abort compilation after <sec> seconds (default 120)
-time --compilation-time, flag to display compilation phases timing information
- -o <file>
- C++ output file
-vec --vectorize generate easier to vectorize code
-vs <n> --vec-size <n> size of the vector (default 32 samples)
-lv <n> --loop-variant [0:fastest (default), 1:simple]
-omp --openMP generate OpenMP pragmas, activates --vectorize option
-pl --par-loop generate parallel loops in --openMP mode
-sch --scheduler generate tasks and use a Work Stealing scheduler, activates --vectorize option
-dfs --deepFirstScheduling schedule vector loops in deep first order
-g --groupTasks group single-threaded sequential tasks together when -omp or -sch is used
-uim --user-interface-macros add user interface macro definitions in the C++ code
- -single
- use --single-precision-floats for internal computations (default)
- -double
- use --double-precision-floats for internal computations
- -quad
- use --quad-precision-floats for internal computations
- -flist
- use --file-list used to eval process
-norm --normalized-form prints signals in normalized form and exits
-I <dir> --import-dir <dir> add the directory <dir> to the import search path
-O <dir> --output-dir <dir> specify the relative directory of the generated C++ output, and the output directory of additional generated files (SVG, XML...)
-e --export-dsp export expanded DSP (all included libraries)
-inpl --in-place generates code working when input and output buffers are the same (in scalar mode only)
-inj <f> --inject source file <f> into architecture file instead of compile a dsp file
example : faust -a jack-gtk.cpp -o myfx.cpp myfx.dsp
COPYRIGHT¶
Copyright © 2002-2016, GRAME - Centre National de Creation Musicale. All rights reserved.January 2017 | FAUST (DSP to C++ compiler), Version 0.9.95 |