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
433
|
/************************************************************************
************************************************************************
FAUST compiler
Copyright (C) 2003-2018 GRAME, Centre National de Creation Musicale
---------------------------------------------------------------------
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
************************************************************************
************************************************************************/
/*****************************************************************************
******************************************************************************
FAUST SIGNAL COMPILER
Y. Orlarey, (c) Grame 2002
------------------------------------------------------------------------------
Compile a list of FAUST signals into a C++ class.
History :
---------
2002-02-08 : First version
******************************************************************************
*****************************************************************************/
#include <stdio.h>
#include <string>
#include "compile.hh"
#include "floats.hh"
#include "sigprint.hh"
#include "sigtype.hh"
#include "sigtyperules.hh"
#include "simplify.hh"
#include "timing.hh"
using namespace std;
/*****************************************************************************
******************************************************************************
API
******************************************************************************
*****************************************************************************/
/*****************************************************************************
******************************************************************************
GENERAL COMPILER METHODS
******************************************************************************
*****************************************************************************/
std::string nameDelayType(DelayType dt)
{
static std::string delayTypeName[] = {"kNotADelay", "kZeroDelay", "kMonoDelay",
"kSingleDelay", "kCopyDelay", "kDenseDelay",
"kMaskRingDelay", "kSelectRingDelay"};
return delayTypeName[int(dt)];
}
/*****************************************************************************
constructor
*****************************************************************************/
Compiler::Compiler(const string& name, const string& super, int numInputs, int numOutputs, bool vec)
: fClass(new Klass(name, super, numInputs, numOutputs, vec)),
fNeedToDeleteClass(true),
fUIRoot(uiFolder(cons(tree(0), tree("")))),
fDescription(0),
fJSON(numInputs, numOutputs)
{
fClass->addIncludeFile("<math.h>");
}
Compiler::Compiler(Klass* k)
: fClass(k),
fNeedToDeleteClass(false),
fUIRoot(uiFolder(cons(tree(0), tree("")))),
fDescription(0),
fJSON(k->inputs(), k->outputs())
{
}
Compiler::~Compiler()
{
if (fNeedToDeleteClass) {
delete fClass;
}
}
/*****************************************************************************
user interface elements
*****************************************************************************/
//================================= some string processing utilities
//=================================
/**
* Removes enclosing whitespaces : ' toto ' -> 'toto'
*/
static string wdel(const string& s)
{
size_t i = 0;
size_t j = s.size();
while (i < j && s[i] == ' ') {
i++;
}
while (j > i && s[j - 1] == ' ') {
j--;
}
return s.substr(i, j - i);
}
//================================= BUILD USER INTERFACE METHOD =================================
void Compiler::generateMetaData()
{
// Add global metadata
for (map<Tree, set<Tree>>::iterator i = gGlobal->gMetaDataSet.begin();
i != gGlobal->gMetaDataSet.end(); i++) {
if (i->first != tree("author")) {
stringstream str1, str2;
str1 << *(i->first);
str2 << **(i->second.begin());
string res1 = str1.str();
string res2 = unquote(str2.str());
fJSON.declare(res1.c_str(), res2.c_str());
} else {
for (set<Tree>::iterator j = i->second.begin(); j != i->second.end(); j++) {
if (j == i->second.begin()) {
stringstream str1, str2;
str1 << *(i->first);
str2 << **j;
string res1 = str1.str();
string res2 = unquote(str2.str());
fJSON.declare(res1.c_str(), res2.c_str());
} else {
stringstream str2;
str2 << **j;
string res2 = unquote(str2.str());
fJSON.declare("contributor", res2.c_str());
}
}
}
}
}
/**
* Generate buildUserInterface C++ lines of code corresponding
* to user interface element t
*/
void Compiler::generateUserInterfaceTree(Tree t, bool root)
{
Tree label, elements, varname, sig;
if (isUiFolder(t, label, elements)) {
const int orient = tree2int(left(label));
// Empty labels will be renamed with a 0xABCD (address) kind of name that is ignored and not
// displayed by UI architectures
const char* str = tree2str(right(label));
const char* model = nullptr;
// extract metadata from group label str resulting in a simplifiedLabel
// and metadata declarations for fictive zone at address 0
string simplifiedLabel;
map<string, set<string>> metadata;
extractMetadata(str, simplifiedLabel, metadata);
// add metadata if any
for (map<string, set<string>>::iterator i = metadata.begin(); i != metadata.end(); i++) {
const string& key = i->first;
const set<string>& values = i->second;
for (set<string>::const_iterator j = values.begin(); j != values.end(); j++) {
fClass->addUICode(
subst("ui_interface->declare($0, \"$1\", \"$2\");", "0", wdel(key), wdel(*j)));
fJSON.declare(NULL, wdel(key).c_str(), wdel(*j).c_str());
}
}
// At root level and if label is empty, use the name kept in "metadata" (either the one
// coded in 'declare name "XXX";' line, or the filename)
string group = (root && (simplifiedLabel == ""))
? unquote(tree2str(*(gGlobal->gMetaDataSet[tree("name")].begin())))
: checkNullLabel(t, simplifiedLabel);
switch (orient) {
case 0:
model = "ui_interface->openVerticalBox(\"$0\");";
fJSON.openVerticalBox(group.c_str());
break;
case 1:
model = "ui_interface->openHorizontalBox(\"$0\");";
fJSON.openHorizontalBox(group.c_str());
break;
case 2:
model = "ui_interface->openTabBox(\"$0\");";
fJSON.openTabBox(group.c_str());
break;
default:
cerr << "ASSERT : user interface generation 1\n";
faustassert(false);
break;
}
fClass->addUICode(subst(model, group));
generateUserInterfaceElements(elements);
fClass->addUICode("ui_interface->closeBox();");
fJSON.closeBox();
} else if (isUiWidget(t, label, varname, sig)) {
generateWidgetCode(label, varname, sig);
} else {
cerr << "ASSERT : user interface generation 2\n";
faustassert(false);
}
}
/**
* Iterate generateUserInterfaceTree on a list of user interface elements
*/
void Compiler::generateUserInterfaceElements(Tree elements)
{
while (!isNil(elements)) {
generateUserInterfaceTree(right(hd(elements)));
elements = tl(elements);
}
}
/////////////////////////////////////////////////
/**
* Generate buildUserInterface C++ lines of code corresponding
* to user interface widget t
*/
void Compiler::generateWidgetCode(Tree fulllabel, Tree varname, Tree sig)
{
Tree path, c, x, y, z;
map<string, set<string>> metadata;
string label, url;
extractMetadata(tree2str(fulllabel), label, metadata);
// Extract "url" metadata to be given as parameter to 'addSoundfile' function
if (isSigSoundfile(sig, path)) {
for (map<string, set<string>>::iterator i = metadata.begin(); i != metadata.end(); i++) {
string key = i->first;
set<string> values = i->second;
for (set<string>::const_iterator j = values.begin(); j != values.end(); j++) {
if (key == "url") {
url = prepareURL(*j);
}
}
}
} else {
// Add metadata if any
for (map<string, set<string>>::iterator i = metadata.begin(); i != metadata.end(); i++) {
const string& key = i->first;
const set<string>& values = i->second;
for (set<string>::const_iterator j = values.begin(); j != values.end(); j++) {
fClass->addUICode(subst("ui_interface->declare(&$0, \"$1\", \"$2\");",
tree2str(varname), wdel(key), wdel(*j)));
fJSON.declare(NULL, wdel(key).c_str(), wdel(*j).c_str());
}
}
}
if (isSigButton(sig, path)) {
fClass->incUIActiveCount();
fClass->addUICode(subst("ui_interface->addButton(\"$0\", &$1);",
checkNullLabel(varname, label), tree2str(varname)));
fJSON.addButton(checkNullLabel(varname, label).c_str(), NULL);
} else if (isSigCheckbox(sig, path)) {
fClass->incUIActiveCount();
fClass->addUICode(subst("ui_interface->addCheckButton(\"$0\", &$1);",
checkNullLabel(varname, label), tree2str(varname)));
fJSON.addCheckButton(checkNullLabel(varname, label).c_str(), NULL);
} else if (isSigVSlider(sig, path, c, x, y, z)) {
fClass->incUIActiveCount();
fClass->addUICode(subst("ui_interface->addVerticalSlider(\"$0\", &$1, $2, $3, $4, $5);",
checkNullLabel(varname, label), tree2str(varname),
T(tree2double(c)), T(tree2double(x)), T(tree2double(y)),
T(tree2double(z))));
fJSON.addVerticalSlider(checkNullLabel(varname, label).c_str(), NULL, (float)tree2double(c),
(float)tree2double(x), (float)tree2double(y),
(float)tree2double(z));
} else if (isSigHSlider(sig, path, c, x, y, z)) {
fClass->incUIActiveCount();
fClass->addUICode(subst("ui_interface->addHorizontalSlider(\"$0\", &$1, $2, $3, $4, $5);",
checkNullLabel(varname, label), tree2str(varname),
T(tree2double(c)), T(tree2double(x)), T(tree2double(y)),
T(tree2double(z))));
fJSON.addHorizontalSlider(checkNullLabel(varname, label).c_str(), NULL,
(float)tree2double(c), (float)tree2double(x),
(float)tree2double(y), (float)tree2double(z));
} else if (isSigNumEntry(sig, path, c, x, y, z)) {
fClass->incUIActiveCount();
fClass->addUICode(subst("ui_interface->addNumEntry(\"$0\", &$1, $2, $3, $4, $5);",
checkNullLabel(varname, label), tree2str(varname),
T(tree2double(c)), T(tree2double(x)), T(tree2double(y)),
T(tree2double(z))));
fJSON.addNumEntry(checkNullLabel(varname, label).c_str(), NULL, (float)tree2double(c),
(float)tree2double(x), (float)tree2double(y), (float)tree2double(z));
} else if (isSigVBargraph(sig, path, x, y, z)) {
fClass->incUIPassiveCount();
fClass->addUICode(subst("ui_interface->addVerticalBargraph(\"$0\", &$1, $2, $3);",
checkNullBargraphLabel(varname, label, 1), tree2str(varname),
T(tree2double(x)), T(tree2double(y))));
fJSON.addVerticalBargraph(checkNullLabel(varname, label).c_str(), NULL,
(float)tree2double(x), (float)tree2double(y));
} else if (isSigHBargraph(sig, path, x, y, z)) {
fClass->incUIPassiveCount();
fClass->addUICode(subst("ui_interface->addHorizontalBargraph(\"$0\", &$1, $2, $3);",
checkNullBargraphLabel(varname, label, 0), tree2str(varname),
T(tree2double(x)), T(tree2double(y))));
fJSON.addHorizontalBargraph(checkNullLabel(varname, label).c_str(), NULL,
(float)tree2double(x), (float)tree2double(y));
} else if (isSigSoundfile(sig, path)) {
fClass->incUIActiveCount();
fClass->addUICode(subst(
"ui_interface->addSoundfile(\"$0\", \"$1\", &$2);", checkNullLabel(varname, label),
((url == "") ? prepareURL(label).c_str() : url.c_str()), tree2str(varname)));
fJSON.addSoundfile(checkNullLabel(varname, label).c_str(),
((url == "") ? prepareURL(label).c_str() : url.c_str()), NULL);
} else {
cerr << "ASSERT : generating widget code 3\n";
faustassert(false);
}
}
//==================================== USER INTERFACE MACROS ==================================
/**
* Generate user interface macros corresponding
* to user interface element t
*/
void Compiler::generateMacroInterfaceTree(const string& pathname, Tree t)
{
Tree label, elements, varname, sig;
if (isUiFolder(t, label, elements)) {
string pathname2 = pathname;
string str = tree2str(right(label));
if (str.length() > 0) {
pathname2 += str + "/";
}
generateMacroInterfaceElements(pathname2, elements);
} else if (isUiWidget(t, label, varname, sig)) {
generateWidgetMacro(pathname, label, varname, sig);
} else {
cerr << "ASSERT : user interface macro generation 2\n";
faustassert(false);
}
}
/**
* Iterate generateMacroInterfaceTree on a list of user interface elements
*/
void Compiler::generateMacroInterfaceElements(const string& pathname, Tree elements)
{
while (!isNil(elements)) {
generateMacroInterfaceTree(pathname, right(hd(elements)));
elements = tl(elements);
}
}
/**
* Generate user interface macros corresponding
* to a user interface widget
*/
void Compiler::generateWidgetMacro(const string& pathname, Tree fulllabel, Tree varname, Tree sig)
{
Tree path, c, x, y, z;
string label;
map<string, set<string>> metadata;
extractMetadata(tree2str(fulllabel), label, metadata);
string pathlabel = pathname + label;
if (isSigButton(sig, path)) {
fClass->addUIMacro(subst("FAUST_ADDBUTTON(\"$0\", $1);", pathlabel, tree2str(varname)));
} else if (isSigCheckbox(sig, path)) {
fClass->addUIMacro(subst("FAUST_ADDCHECKBOX(\"$0\", $1);", pathlabel, tree2str(varname)));
} else if (isSigVSlider(sig, path, c, x, y, z)) {
fClass->addUIMacro(subst("FAUST_ADDVERTICALSLIDER(\"$0\", $1, $2, $3, $4, $5);", pathlabel,
tree2str(varname), T(tree2double(c)), T(tree2double(x)),
T(tree2double(y)), T(tree2double(z))));
} else if (isSigHSlider(sig, path, c, x, y, z)) {
fClass->addUIMacro(subst("FAUST_ADDHORIZONTALSLIDER(\"$0\", $1, $2, $3, $4, $5);",
pathlabel, tree2str(varname), T(tree2double(c)), T(tree2double(x)),
T(tree2double(y)), T(tree2double(z))));
} else if (isSigNumEntry(sig, path, c, x, y, z)) {
fClass->addUIMacro(subst("FAUST_ADDNUMENTRY(\"$0\", $1, $2, $3, $4, $5);", pathlabel,
tree2str(varname), T(tree2double(c)), T(tree2double(x)),
T(tree2double(y)), T(tree2double(z))));
} else if (isSigVBargraph(sig, path, x, y, z)) {
fClass->addUIMacro(subst("FAUST_ADDVERTICALBARGRAPH(\"$0\", $1, $2, $3);", pathlabel,
tree2str(varname), T(tree2double(x)), T(tree2double(y))));
} else if (isSigHBargraph(sig, path, x, y, z)) {
fClass->addUIMacro(subst("FAUST_ADDHORIZONTALBARGRAPH(\"$0\", $1, $2, $3);", pathlabel,
tree2str(varname), T(tree2double(x)), T(tree2double(y))));
} else if (isSigSoundfile(sig, path)) {
fClass->addUIMacro(subst("FAUST_ADDSOUNDFILE(\"$0\", $1);", pathlabel, tree2str(varname)));
} else {
cerr << "ASSERT in generating widget macro\n";
faustassert(false);
}
}
|
