File: faust2api

package info (click to toggle)
faust 2.81.10%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 431,496 kB
  • sloc: cpp: 283,941; ansic: 116,215; javascript: 18,529; sh: 14,356; vhdl: 14,052; java: 5,900; python: 5,091; objc: 3,852; makefile: 2,725; cs: 1,672; lisp: 1,146; ruby: 954; yacc: 586; xml: 471; lex: 247; awk: 111; tcl: 26
file content (432 lines) | stat: -rwxr-xr-x 15,355 bytes parent folder | download | duplicates (2)
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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
#!/bin/bash

#####################################################################
#                                                                   #
#    Generates an API for Android or iOS based on a Faust object    #
#               (c) Romain Michon CCRMA and Grame, 2016-2024        #
#                                                                   #
#####################################################################

. faustpath
. faustoptflags
. usage.sh

CXXFLAGS+=" $MYGCCFLAGS"  # So that additional CXXFLAGS can be used

# change if you want to get the log of what's happening
LOG="/dev/null"

# exit if a command fails
set -e

# global option variables

NVOICES="0"
#PACKAGENAME="0"
POLY2="0"
MIDI="0"
SOUNDFILE="0"
OSC="0"
NODOC="0"
NOZIP="0"
APIFOLDER="dsp-faust"
EFFECT=""
BUILD="0"
DYNAMIC_DSP="0"
OPT=""
MISC_OPT=""
TARGETDEFINED="0"

COREAUDIO_DRIVER="0"
ANDROID_DRIVER="0"
IOS_DRIVER="0"
ALSA_DRIVER="0"
JACK_DRIVER="0"
PORTAUDIO_DRIVER="0"
RTAUDIO_DRIVER="0"
MINIAUDIO_DRIVER="0"
COREAUDIO_DRIVER="0"
OPEN_FRAMEWORK_DRIVER="0"
JUCE_DRIVER="0"
DUMMY_DRIVER="0"
TEENSY_DRIVER="0"
ESP32_DRIVER="0"

if [[ $(uname -s) == Darwin ]]; then
    ARCHLIB+=" -framework CoreMIDI -framework CoreFoundation -framework CoreAudio -framework AudioUnit -framework CoreServices "
else
    ARCHLIB=""
fi

echoHelp() 
{
    usage faust2api "[options] [Faust options] <file.dsp>"
    echo "faust2api can be used to generate Faust based dsp objects for various platforms (see https://github.com/grame-cncm/faust/tree/master-dev/architecture/api):"
    echo
    echo "Output options:"
    option -ios "generates an iOS API"
    option -android "generates an Android API"
    option -coreaudio "generates an OSX CoreAudio API"
    option -alsa "generates an ALSA API"
    option -jack "generates a JACK API"
    option -portaudio "generates a PortAudio API"
    option -rtaudio "generates an RTAudio API"
    option -miniaudio "generates a Miniaudio API"
    option -of "generates an openFrameworks API"
    option -juce "generates a JUCE API"
    option -dummy "generates a dummy audio API"
    option -teensy "generates a Teensy API"
    option -esp32 "generates a ESP32 API"
    echo
    echo "Global options:"
    option "-opt native|generic" "activates the best compilation options for the native or generic CPU"
    option "-nvoices <num>" "creates a polyphonic object with <num> voices"
    option "-effect <effect.dsp>" "adds an effect to the polyphonic synth (ignored if -nvoices is not specified)"
    option "-effect auto" "adds an effect (extracted automatically from the dsp file) to the polyphonic synth (ignored if -nvoices is not specified)"
    option -nodoc "prevents documentation from being generated"
    option -nozip "prevents generated files to be put in a zip file"
    option "-target <target>" "sets a name of the target folder or the zip file. Defaults to \"dsp-faust\""
    option "Faust options"
    echo
    echo "Android specific options:"
    option -package "set the JAVA package name (e.g. '-package mypackage' will change the JAVA package name to 'mypackage.DspFaust'). The default package name is 'com.DspFaust.'"
    echo
    echo "Options supported by iOS, CoreAudio, ALSA, JACK, PortAudio, RTAudio, Miniaudio, openFrameworks and JUCE"
    option -midi "add built-in RtMidi support to the API"
    option -osc "add built-in OSC support to the API"
    option -soundfile "add built-in Soundfile support to the API"
    echo
    echo "JACK specific options"
    option -build "build a ready to test binary"
    option -dynamic "add libfaust/LLVM dynamic DSP compilation mode"
    exit
}

if [ "$#" -eq 0 ]; then
    echo 'Please, provide a Faust file to process !'
    echo ''
    echoHelp
fi

createAPI ()
{
    cp -r $FAUSTARCH/api/DspFaust.h $APIFOLDER
    faust $OPTIONS $MISC_OPT -i -a api/DspFaust.cpp "$FILE" -o "$APIFOLDER/DspFaust.cpp" || exit 1
    if [ "$POLY2" = "1" ]; then
        faust $OPTIONS -i -cn effect -a minimal-effect.cpp $EFFECT | cat - "$APIFOLDER/DspFaust.cpp" > temp && mv temp "$APIFOLDER/DspFaust.cpp" || exit 1
        echo "#define POLY2 1" | cat - "$APIFOLDER/DspFaust.cpp" > temp && mv temp "$APIFOLDER/DspFaust.cpp"
    fi
    if [ "$NVOICES" -gt "0" ]; then
        echo "#define NVOICES $NVOICES" | cat - "$APIFOLDER/DspFaust.cpp" > temp && mv temp "$APIFOLDER/DspFaust.cpp"
    fi
    if [ "$MIDI" = "1" ]; then
        echo "#define MIDICTRL 1" | cat - "$APIFOLDER/DspFaust.cpp" > temp && mv temp "$APIFOLDER/DspFaust.cpp"
    fi
    if [ "$OSC" = "1" ]; then
        echo "#define OSCCTRL 1" | cat - "$APIFOLDER/DspFaust.cpp" > temp && mv temp "$APIFOLDER/DspFaust.cpp"
    fi
    if [ "$SOUNDFILE" = "1" ]; then
        echo "#define SOUNDFILE 1" | cat - "$APIFOLDER/DspFaust.cpp" > temp && mv temp "$APIFOLDER/DspFaust.cpp"
    fi
    if [ "$DYNAMIC_DSP" = "1" ]; then
        echo "#define DYNAMIC_DSP 1" | cat - "$APIFOLDER/DspFaust.cpp" > temp && mv temp "$APIFOLDER/DspFaust.cpp"
    fi
    if [ "$BUILD" = "1" ]; then
        echo "#define BUILD 1" | cat - "$APIFOLDER/DspFaust.cpp" > temp && mv temp "$APIFOLDER/DspFaust.cpp"
    fi
}

# dispatch command arguments
while [ $1 ]
do
    p=$1

    if [ $p = "-help" ] || [ $p = "-h" ]; then
        echoHelp
    elif [ $p = "-opt" ]; then
        shift
        OPT=$1
    elif [ "$PACKAGENAME" = "-1" ]; then
        PACKAGENAME="$p"
    elif [[ -f "$p" ]] && [ ${p: -4} == ".dsp" ]; then
        FILE="$p"
    elif [ $p = "-android" ]; then
        ANDROID_DRIVER=1
    elif [ $p = "-ios" ]; then
        IOS_DRIVER="1"
    elif [ $p = "-coreaudio" ]; then
        COREAUDIO_DRIVER=1
    elif [ $p = "-alsa" ]; then
        ALSA_DRIVER=1
    elif [ $p = "-jack" ]; then
        JACK_DRIVER=1
    elif [ $p = "-portaudio" ]; then
        PORTAUDIO_DRIVER=1
    elif [ $p = "-rtaudio" ]; then
        RTAUDIO_DRIVER=1
    elif [ $p = "-miniaudio" ]; then
        MINIAUDIO_DRIVER=1
    elif [ $p = "-of" ]; then
        OPEN_FRAMEWORK_DRIVER=1
    elif [ $p = "-juce" ]; then
        JUCE_DRIVER=1
    elif [ $p = "-dummy" ]; then
        DUMMY_DRIVER=1
    elif [ $p = "-teensy" ]; then
        TEENSY_DRIVER=1
        MISC_OPT="-uim"
    elif [ $p = "-esp32" ]; then
        ESP32_DRIVER=1
        MISC_OPT="-uim"
    elif [ "$p" = "-effect" ]; then
        POLY2="1"
        shift
        EFFECT=$1
    elif [ "$p" = "-midi" ]; then
        MIDI="1"
    elif [ "$p" = "-soundfile" ]; then
        SOUNDFILE="1"
    elif [ "$p" = "-osc" ]; then
        OSC="1"
    elif [ "$p" = "-nodoc" ]; then
        NODOC="1"
    elif [ "$p" = "-nozip" ]; then
        NOZIP="1"
    elif [ "$p" = "-target" ]; then
        TARGETDEFINED="1"
        shift
        APIFOLDER=$1
    elif [ "$p" = "-build" ]; then
        BUILD="1"
    elif [ "$p" = "-dynamic" ]; then
        DYNAMIC_DSP="1"
    elif [ $p = "-nvoices" ]; then
        shift
        NVOICES=$1
    elif [ $p = "-package" ]; then
        PACKAGENAME="-1"
    elif [ ${p:0:1} = "-" ]; then
        OPTIONS="$OPTIONS $p"
    elif [[ -f "$p" ]]; then
        FILES="$FILES $p"
    else
        OPTIONS="$OPTIONS $p"
    fi
    shift
done

###################################
# GENERATING API
###################################

rm -r "$APIFOLDER" 2> /dev/null || true
mkdir "$APIFOLDER"

#---------------------------------------------------------
# discover best compilation options
# discover best compilation options
if [ "$OPT" = "generic" ]; then
    echo "Look for best compilation options in 'generic' mode..."
    OPTIONS="$OPTIONS $(faustbench-llvm -notrace -generic $OPTIONS $f)"
    echo $OPTIONS
elif [ "$OPT" = "native" ]; then
    echo "Look for best compilation options in 'native' mode..."
    OPTIONS="$OPTIONS $(faustbench-llvm -notrace $OPTIONS $f)"
    echo $OPTIONS
fi

#---------------------------------------------------------
# START CHECKING FOR AUTO EFFECT
if [ "$NVOICES" -gt "0" ]; then
if [ "$EFFECT" = "auto" ]; then
    EFFECT="$APIFOLDER/autoeffect.dsp"
    cat > "$EFFECT" << EndOfCode
    adapt(1,1) = _;
    adapt(2,2) = _,_;
    adapt(1,2) = _ <: _,_;
    adapt(2,1) = _,_ :> _;
    adaptor(F,G) = adapt(outputs(F),inputs(G));
    process = adaptor(library("$FILE").process, library("$FILE").effect) : library("$FILE").effect;
EndOfCode
    # We check this is a faust valid code. No error if it is not.
    faust $EFFECT -o /dev/null 2> /dev/null || POLY2="0" EFFECT=""
fi
else
    # No polyphony, make sure no effect
    POLY2="0" EFFECT=""
fi

APILOCATION=""

if [ "$NOZIP" = "0" ]; then
    APILOCATION="$APIFOLDER.zip"
elif [ "$TARGETDEFINED" = "1" ]; then
    APILOCATION="$APIFOLDER/"
fi

# END CHECKING FOR AUTO EFFECT

if [ $ANDROID_DRIVER -eq 1 ]; then
    echo "Your $APILOCATION API package for Android is being created"
    CPPFOLDER="$APIFOLDER/cpp"
    JAVAFOLDER="$APIFOLDER/java"
    mkdir $CPPFOLDER
    mkdir $JAVAFOLDER
    cp -r $FAUSTARCH/api/android/jni/*.java $JAVAFOLDER
    if [ -n "$PACKAGENAME" ]; then
        PACKAGENAME="$PACKAGENAME.DspFaust"
        sed -i "s/com.DspFaust/$PACKAGENAME/g" $JAVAFOLDER/*.java
    fi
    cp -r $FAUSTARCH/api/android/jni/java_interface_wrap.cpp $CPPFOLDER
    createAPI
    mv $APIFOLDER/DspFaust.h $CPPFOLDER
    mv $APIFOLDER/DspFaust.cpp $CPPFOLDER
    echo "#define ANDROID_DRIVER 1" | cat - "$CPPFOLDER/DspFaust.cpp" > temp && mv temp "$CPPFOLDER/DspFaust.cpp"
elif [ $IOS_DRIVER -eq 1 ]; then
    echo "Your $APILOCATION API package for iOS is being created"
    createAPI
    echo "#define IOS_DRIVER 1" | cat - "$APIFOLDER/DspFaust.cpp" > temp && mv temp "$APIFOLDER/DspFaust.cpp"
elif [ $COREAUDIO_DRIVER -eq 1 ]; then
    echo "Your $APILOCATION API package for CoreAudio is being created"
    createAPI
    echo "#define COREAUDIO_DRIVER 1" | cat - "$APIFOLDER/DspFaust.cpp" > temp && mv temp "$APIFOLDER/DspFaust.cpp"
elif [ $ALSA_DRIVER -eq 1 ]; then
    echo "Your $APILOCATION API package for ALSA is being created"
    createAPI
    echo "#define ALSA_DRIVER 1" | cat - "$APIFOLDER/DspFaust.cpp" > temp && mv temp "$APIFOLDER/DspFaust.cpp"
elif [ $JACK_DRIVER -eq 1 ]; then
    echo "Your $APILOCATION API package for JACK is being created"
    createAPI
    echo "#define JACK_DRIVER 1" | cat - "$APIFOLDER/DspFaust.cpp" > temp && mv temp "$APIFOLDER/DspFaust.cpp"
elif [ $PORTAUDIO_DRIVER -eq 1 ]; then
    echo "Your $APILOCATION API package for PortAudio is being created"
    createAPI
    echo "#define PORTAUDIO_DRIVER 1" | cat - "$APIFOLDER/DspFaust.cpp" > temp && mv temp "$APIFOLDER/DspFaust.cpp"
elif [ $RTAUDIO_DRIVER -eq 1 ]; then
    echo "Your $APILOCATION API package for RTAudio is being created"
    createAPI
    echo "#define RTAUDIO_DRIVER 1" | cat - "$APIFOLDER/DspFaust.cpp" > temp && mv temp "$APIFOLDER/DspFaust.cpp"
elif [ $MINIAUDIO_DRIVER -eq 1 ]; then
    echo "Your $APILOCATION API package for Miniaudio is being created"
    createAPI
    echo "#define MINIAUDIO_DRIVER 1" | cat - "$APIFOLDER/DspFaust.cpp" > temp && mv temp "$APIFOLDER/DspFaust.cpp"
elif [ $OPEN_FRAMEWORK_DRIVER -eq 1 ]; then
    echo "Your $APILOCATION API package for OpenFramework is being created"
    createAPI
    echo "#define OPEN_FRAMEWORK_DRIVER 1" | cat - "$APIFOLDER/DspFaust.cpp" > temp && mv temp "$APIFOLDER/DspFaust.cpp"
elif [ $JUCE_DRIVER -eq 1 ]; then
    echo "Your $APILOCATION API package for JUCE is being created"
    createAPI
    echo "#define JUCE_DRIVER 1" | cat - "$APIFOLDER/DspFaust.cpp" > temp && mv temp "$APIFOLDER/DspFaust.cpp"
elif [ $DUMMY_DRIVER -eq 1 ]; then
    echo "Your $APILOCATION API package for dummy audio is being created"
    createAPI
    echo "#define DUMMY_DRIVER 1" | cat - "$APIFOLDER/DspFaust.cpp" > temp && mv temp "$APIFOLDER/DspFaust.cpp"
elif [ $TEENSY_DRIVER -eq 1 ]; then
    echo "Your $APILOCATION API package for teensy audio is being created"
    createAPI
    echo "#define TEENSY_DRIVER 1" | cat - "$APIFOLDER/DspFaust.cpp" > temp && mv temp "$APIFOLDER/DspFaust.cpp"
elif [ $ESP32_DRIVER -eq 1 ]; then
    echo "Your $APILOCATION API package for ESP32 audio is being created"
    createAPI
    echo "#define ESP32_DRIVER 1" | cat - "$APIFOLDER/DspFaust.cpp" > temp && mv temp "$APIFOLDER/DspFaust.cpp"
else
    echoHelp
    exit 1
fi

###################################
# GENERATING BINARY
###################################

if [ "$BUILD" = "1" ]; then
    if [ $JACK_DRIVER -eq 1 ]; then    
        ARCHLIB+=" $(pkg-config --cflags --static --libs jack)"
    fi
    if [ $SOUNDFILE -eq 1 ]; then
        ARCHLIB+=" $(pkg-config --cflags --static --libs sndfile)"
    fi
    if [ $DYNAMIC_DSP -eq 1 ]; then
        ARCHLIB+=" $(llvm-config --link-static --ldflags --libs all --system-libs)"
    fi
    if [ "$DYNAMIC_DSP" = "1" ]; then
        echo "Compile as a binary named 'dynamic-api'"
        # compile c++ to binary liked with libfaust/LLVM
        (
            $CXX $CXXFLAGS $APIFOLDER/DspFaust.cpp /usr/local/lib/libfaust.a -lz -lncurses -lOSCFaust $ARCHLIB -o dynamic-api
        ) > /dev/null || exit 1
        exit 0
   else
        echo "Compile the ${FILE%.dsp} binary"
        # compile c++ to binary
       
        (
            $CXX $CXXFLAGS $APIFOLDER/DspFaust.cpp -lOSCFaust $ARCHLIB -o ${FILE%.dsp}
        ) > /dev/null || exit 1
        exit 0
    fi

fi

###################################
# GENERATING API DOCUMENTATION
###################################

if [ $NODOC -eq 0 ]; then

    APIHEADERFILE="$FAUSTARCH/api/DspFaust.h"

    if [ $ANDROID_DRIVER -eq 1 ]; then
        DOCHEADERFILE="$FAUSTARCH/api/doc/Android.md"
    elif [ $IOS_DRIVER -eq 1 ]; then
        DOCHEADERFILE="$FAUSTARCH/api/doc/iOS.md"
    else
        DOCHEADERFILE="$FAUSTARCH/api/doc/Generic.md"
    fi

    PPFILE=pPrinter.cpp
    PPBINARY=pp
    READMEFILE="$APIFOLDER/README.md"

    faust $OPTIONS $MISC_OPT -i -a path-printer.cpp "$FILE" -o "$PPFILE" || exit 1
    if [ "$POLY2" = "1" ]; then
        faust $OPTIONS -i -cn effect -a minimal-effect.cpp $EFFECT | cat - "$PPFILE" > temp && mv temp "$PPFILE" || exit 1
        echo "#define POLY2 1" | cat - "$PPFILE" > temp && mv temp "$PPFILE"
    fi
    if [ "$NVOICES" -gt "0" ]; then
        echo "#define NVOICES $NVOICES" | cat - "$PPFILE" > temp && mv temp "$PPFILE"
    fi
    if [ "$SOUNDFILE" = "1" ]; then
        echo "#define SOUNDFILE 1" | cat - "$PPFILE"  > temp && mv temp "$PPFILE"
    fi

    # compile c++ to binary
    (
        if [ "$NVOICES" -gt "0" ]; then
            $CXX $CXXFLAGS -DPOLY_VOICES "$PPFILE" `pkg-config --cflags --static --libs sndfile` -pthread -o "$PPBINARY"
        else
            $CXX $CXXFLAGS "$PPFILE" `pkg-config --cflags --static --libs sndfile` -pthread -o "$PPBINARY"
        fi
    ) > /dev/null || exit 1
    rm "$PPFILE" || exit 1

    cp "$DOCHEADERFILE"  "$READMEFILE" || exit 1
    ./"$PPBINARY" | cat "$READMEFILE" - > temp && mv temp "$READMEFILE" || exit 1
    rm "$PPBINARY" || exit 1

    faust2md "$APIHEADERFILE" | cat "$READMEFILE" - > temp && mv temp "$READMEFILE" || exit 1
fi

###################################
# POST PROCESSING
###################################

if [ "$NOZIP" = "0" ]; then
    ZIPOUT="$APIFOLDER.zip"
    rm $ZIPOUT 2> /dev/null || true
    zip -r $ZIPOUT $APIFOLDER > /dev/null || exit 1
    rm -r $APIFOLDER || exit 1
elif [ "$TARGETDEFINED" = "0" ]; then
    mv $APIFOLDER/* . || exit 1
    rm -r $APIFOLDER || exit 1
fi