1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
% man(1) Version 2.79.3 (09-March-2025) | Faust man page
NAME
====
Faust - DSP to C/C++, CMajor, Codebox, CSharp, DLang, Interpreter, Java, LLVM IR, Julia, JSFX, Rust and WebAssembly (wast/wasm)
SYNOPSIS
========
**faust** \[options] file1 \[file2 ...]
DESCRIPTION
===========
Faust (Functional Audio Stream) is a functional programming language specifically designed for real-time signal processing and synthesis. Faust targets high-performance signal processing applications and audio plug-ins for a variety of platforms and standards.
OPTIONS
===========
Input options:
---------------------------------------
**-a** \<file> wrapper architecture file.
**-i** **--inline-architecture-files** inline architecture files.
**-A** \<dir> **--architecture-dir** \<dir> add the directory \<dir> to the architecture search path.
**-I** \<dir> **--import-dir** \<dir> add the directory \<dir> to the libraries search path.
**-L** \<file> **--library** \<file> link with the LLVM module \<file>.
Output options:
---------------------------------------
**-o** \<file> the output file.
**-e** **--export-dsp** export expanded DSP (with all included libraries).
**-uim** **--user-interface-macros** add user interface macro definitions to the output code.
**-xml** generate an XML description file.
**-json** generate a JSON description file.
**-O** \<dir> **--output-dir** \<dir> specify the relative directory of the generated output code and of additional generated files (SVG, XML...).
Code generation options:
---------------------------------------
**-lang** \<lang> **--language** select output language,
'lang' should be c, cpp (default), cmajor, codebox, csharp, dlang, fir, interp, java, jax, jsfx, julia, llvm, ocpp, rust, sdf3, vhdl or wast/wasm.
**-single** **--single-precision-floats** use single precision floats for internal computations (default).
**-double** **--double-precision-floats** use double precision floats for internal computations.
**-quad** **--quad-precision-floats** use quad precision floats for internal computations.
**-fx** **--fixed-point** use fixed-point for internal computations.
**-fx**-size **--fixed-point-size** fixed-point number total size in bits (-1 is used to generate a unique fixpoint_t type).
**-es** 1|0 **--enable-semantics** 1|0 use enable semantics when 1 (default), and simple multiplication otherwise.
**-lcc** **--local-causality-check** check causality also at local level.
**-light** **--light-mode** do not generate the entire DSP API.
**-clang** **--clang** when compiled with clang/clang++, adds specific #pragma for auto-vectorization.
**-nvi** **--no-virtual** when compiled with the C++ backend, does not add the 'virtual' keyword.
**-fp** **--full-parentheses** always add parentheses around binops.
**-cir** **--check-integer-range** check float to integer range conversion.
**-exp10** **--generate-exp10** pow(10,x) replaced by possibly faster exp10(x).
**-os** **--one-sample** generate one sample computation.
**-ec** **--external-control** separated 'control' and 'compute' functions.
**-it** **--inline-table** inline rdtable/rwtable code in the main class.
**-cm** **--compute-mix** mix in outputs buffers.
**-ct** **--check-table** check rtable/rwtable index range and generate safe access code [0/1: 1 by default].
**-cn** \<name> **--class-name** \<name> specify the name of the dsp class to be used instead of mydsp.
**-scn** \<name> **--super-class-name** \<name> specify the name of the super class to be used instead of dsp.
**-pn** \<name> **--process-name** \<name> specify the name of the dsp entry-point instead of process.
**-mcd** \<n> **--max-copy-delay** \<n> use a copy delay up to max delay \<n> and a dense delay above (ocpp only) or a ring buffer (default 16 samples).
**-mdd** \<n> **--max-dense-delay** \<n> use a dense delay up to max delay \<n> (if enough density) and a ring buffer delay above (ocpp only, default 1024).
**-mdy** \<n> **--min-density** \<n> minimal density (100*number of delays/max delay) to use a dense delays (ocpp only, default 33).
**-dlt** \<n> **--delay-line-threshold** \<n> use a mask-based ring buffer delays up to max delay \<n> and a select based ring buffers above (default INT_MAX samples).
**-mem** **--memory-manager** allocations done using a custom memory manager.
**-mem1** **--memory-manager1** allocations done using a custom memory manager, using the iControl/fControl and iZone/fZone model.
**-mem2** **--memory-manager2** use iControl/fControl, iZone/fZone model and no explicit memory manager.
**-mem3** **--memory-manager3** use iControl/fControl, iZone/fZone model and no explicit memory manager with access as function parameters.
**-ftz** \<n> **--flush-to-zero** \<n> code added to recursive signals [0:no (default), 1:fabs based, 2:mask based (fastest)].
**-rui** **--range-ui** whether to generate code to constraint vslider/hslider/nentry values in [min..max] range.
**-fui** **--freeze-ui** whether to freeze vslider/hslider/nentry to a given value (init value by default).
**-inj** \<f> **--inject** \<f> inject source file \<f> into architecture file instead of compiling a dsp file.
**-scal** **--scalar** generate non-vectorized code (default).
**-inpl** **--in-place** generates code working when input and output buffers are the same (scalar mode only).
**-vec** **--vectorize** generate easier to vectorize code.
**-vs** \<n> **--vec-size** \<n> size of the vector (default 32 samples).
**-lv** \<n> **--loop-variant** \<n> [0:fastest, fixed vector size and a remaining loop (default), 1:simple, variable vector size, 2:fixed, fixed vector size].
**-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.
**-ocl** **--opencl** generate tasks with OpenCL (experimental).
**-cuda** **--cuda** generate tasks with CUDA (experimental).
**-dfs** **--deep-first-scheduling** schedule vector loops in deep first order.
**-g** **--group-tasks** group single-threaded sequential tasks together when -omp or -sch is used.
**-fun** **--fun-tasks** separate tasks code as separated functions (in -vec, -sch, or -omp mode).
**-fm** \<file> **--fast-math** \<file> use optimized versions of mathematical functions implemented in \<file>, use 'faust/dsp/fastmath.cpp' when file is 'def', assume functions are defined in the architecture file when file is 'arch'.
**-mapp** **--math-approximation** simpler/faster versions of 'floor/ceil/fmod/remainder' functions.
**-noreprc** **--no-reprc** (Rust only) Don't force dsp struct layout to follow C ABI.
**-ns** \<name> **--namespace** \<name> generate C++ or D code in a namespace \<name>.
**-vhdl**-trace **--vhdl-trace** activate trace.
**-vhdl**-float **--vhdl-float** uses IEEE-754 format for samples instead of fixed point.
**-vhdl**-components \<file> **--vhdl-components** \<file> path to a file describing custom components for the VHDL backend.
**-fpga**-mem \<n> **--fpga-mem** \<n> FPGA block ram max size, used in -mem1/-mem2 mode.
**-wi** \<n> **--widening-iterations** \<n> number of iterations before widening in signal bounding.
**-ni** \<n> **--narrowing-iterations** \<n> number of iterations before stopping narrowing in signal bounding.
**-rnt** **--rust-no-faustdsp-trait** (Rust only) Don't generate FaustDsp trait implmentation.
**-rnlm** **--rust-no-libm** (Rust only) Don't generate FFI calls to libm.
Block diagram options:
---------------------------------------
**-ps** **--postscript** print block-diagram to a postscript file.
**-svg** **--svg** print block-diagram to a svg file.
**-sd** **--simplify-diagrams** try to further simplify diagrams before drawing.
**-drf** **--draw-route-frame** draw route frames instead of simple cables.
**-f** \<n> **--fold** \<n> threshold to activate folding mode during block-diagram generation (default 25 elements).
**-fc** \<n> **--fold-complexity** \<n> complexity threshold to fold an expression in folding mode (default 2).
**-mns** \<n> **--max-name-size** \<n> threshold during block-diagram generation (default 40 char).
**-sn** **--simple-names** use simple names (without arguments) during block-diagram generation.
**-blur** **--shadow-blur** add a shadow blur to SVG boxes.
**-sc** **--scaled-svg** automatic scalable SVG.
Math doc options:
---------------------------------------
**-mdoc** **--mathdoc** print math documentation of the Faust program in LaTeX format in a -mdoc folder.
**-mdlang** \<l> **--mathdoc-lang** \<l> if translation file exists (\<l> = en, fr, ...).
**-stripmdoc** **--strip-mdoc-tags** strip mdoc tags when printing Faust -mdoc listings.
Debug options:
---------------------------------------
**-d** **--details** print compilation details.
**-time** **--compilation-time** display compilation phases timing information.
**-flist** **--file-list** print file list (including libraries) used to eval process.
**-tg** **--task-graph** print the internal task graph in dot format.
**-sg** **--signal-graph** print the internal signal graph in dot format.
**-rg** **--retiming-graph** print the internal signal graph after retiming in dot format.
**-norm** **--normalized-form** print signals in normalized form and exit.
**-norm1** **--normalized-form1** print signals in normalized form with IDs for shared sub-expressions and exit.
**-me** **--math-exceptions** check / for 0 as denominator and remainder, fmod, sqrt, log10, log, acos, asin functions domain.
**-sts** **--strict-select** generate strict code for 'selectX' even for stateless branches (both are computed).
**-wall** **--warning-all** print all warnings.
**-t** \<sec> **--timeout** \<sec> abort compilation after \<sec> seconds (default 120).
Information options:
---------------------------------------
**-h** **--help** print this help message.
**-v** **--version** print version information and embedded backends list.
**-libdir** **--libdir** print directory containing the Faust libraries.
**-includedir** **--includedir** print directory containing the Faust headers.
**-archdir** **--archdir** print directory containing the Faust architectures.
**-dspdir** **--dspdir** print directory containing the Faust dsp libraries.
**-pathslist** **--pathslist** print the architectures and dsp library paths.
Environment variables:
---------------------------------------
FAUST_DEBUG = FAUST_LLVM1 print LLVM IR before optimisation.
FAUST_DEBUG = FAUST_LLVM2 print LLVM IR after optimisation.
FAUST_DEBUG = FIR_PRINTER print FIR after generation.
FAUST_DEBUG = FAUST_LLVM_NO_FM deactivate fast**-math** optimisation in LLVM IR.
FAUST_OPT = FAUST_SIG_NO_NORM deactivate signal normalisation.
Example:
---------------------------------------
faust **-a** jack-gtk.cpp -o myfx.cpp myfx.dsp
SEE ALSO
========
Grame Faust site at: **<https://faust.grame.fr>**
BUGS
====
Please report bugs to: **<https://github.com/grame-cncm/faust/issues>**
AUTHOR
======
Copyright (C) 2002-2025, GRAME - Centre National de Creation Musicale.
All rights reserved.
|
