Merge branch 'fixes' of https://github.com/cucuwritescode/faust2clap into fixes

Author: cucuwritescode

architecture/max-msp/README.md

@@ -1,6 +1,6 @@
 # faust2max6/faust2msp
 
-The **faust2max6/faust2msp** tools transform a Faust DSP program into a compiled Max/MSP external, and a ready-to-use patch to load and use it. Polyphonic and MIDI controllable instruments can be created. Note that **faust2msp** is the old version compiling 32 bits external for Max5, and **faust2max6** compiles 64 bits for Max6 and newer versions, and should be preferably used. 
+The **faust2max6/faust2msp** tools transform a Faust DSP program into a compiled Max/MSP external, and a ready-to-use patch to load and use it, containing the control GUI. Polyphonic and MIDI controllable instruments can be created. Note that **faust2msp** is the old version compiling 32 bits external for Max5, and **faust2max6** compiles 64 bits for Max6 and newer versions, and should be preferably used. 
 
 ## How to use
 
@@ -90,6 +90,21 @@ If you plan to use **faust2max6/faust2msp** on your own machine, you will have t
 
 - the original DSP file as well as the compiled self-contained C++ file are kept in the compiled `.mxo` external, to be accessed using the *Show Package Contents* option. 
 
+# faust2gen
+
+The **faust2gen** tool transforms a Faust DSP program into a ready-to-use patch containing a **faustgen~/mc.faustgen~** object to compile it. Polyphonic and MIDI controllable patches can be created. The `read` message with the given DSP filename is added in the patch, so that the DSP code can be read and compiled. The control GUI is automatically created and connected to the **faustgen~/mc.faustgen~** object after the compilation step. The DSP code can be edited with an external editor. After the DSP code has been changed externally, the `read` message has to be used again to trigger compilation and GUI update.   
+
+## How to use
+
+**faust2gen** is used with the following options: `faust2gen [-nvoices <num>] [-mc] <file.dsp>` 
+
+## Options
+
+Here are the available options:
+
+ - `-nvoices <num>` : to produce a polyphonic ready patch to be used with MIDI events
+ - `-mc` : to use a mc.faustgen~ object
+
 # faust2rnbo
 
 The **faust2rnbo** tool transforms a Faust DSP program into a RNBO patch including the generated codebox code. Polyphonic and MIDI controllable instruments can be created. The `-sp` option allows to generate as a reusable rnbopat file. Two rnbopat files will always be generated in polyphonic mode with an effect, since using abstractions is the appropriate model to combine the DSP and effect in a single `rnbo~`object. Additional options are used to generate a special version of the RNBO patch used in the testing infrastructure. 

architecture/max-msp/ui.js

@@ -2,20 +2,20 @@
 // ui.js
 // -----------------
 //
-// Automatically (re)generate/destroy sliders according to Faust DSP module
+// Automatically (re)generate/destroy sliders/buttons according to Faust DSP module.
 // By Edgar Berdahl, July 2014
-// Grame, 2014-2016
+// Revised by Grame, 2014-2025
 //
 // Currently addHorizontalBargraph, addVerticalBargraph, declare,
-// openTabBox, openHorizontalBox, openVerticalBox, and closeBox are not really handled.
+// openTabBox, openHorizontalBox, openVerticalBox, and closeBox are not handled.
 //
 // Started from autosurface.js by rld, 5.04
 //
 
 // Global table
-const dsp_ui_table = [];
+var dsp_ui_table = (typeof dsp_ui_table === 'undefined') ? [] : dsp_ui_table;
 
-const faust = faust || {};
+var faust = (typeof faust === 'undefined') ? {} : faust;
 
 // global variables and arrays
 faust.numwidgets = -1;
@@ -26,47 +26,85 @@ faust.theSliders = new Array(128);
 faust.theMessages = new Array(128);
 faust.thenumberBoxes = new Array(128);
 
-faust.ui = function (json, patcher) {
+// Function to check if a string starts with a prefix
+faust.starts_with = function (str, prefix) {
+    return (str.lastIndexOf(prefix, 0) === 0);
+}
 
-    var widgHeight = 30;
-    var hBase = 150;
+// Function to get the DSP object by its name of class
+faust.get_with_name = function (patcher, name) {
+    var obj = patcher.firstobject;
+    while (obj) {
+        if (faust.starts_with(obj.varname, name) || faust.starts_with(obj.maxclass, name)) {
+            return obj;
+        }
+        obj = obj.nextobject;
+    }
+    return null;
+}
 
-    starts_with = function (str, prefix) {
-        return (str.lastIndexOf(prefix, 0) === 0);
+// Function to remove all existing faust UI objects
+faust.remove_ui = function () {
+    // Remove comments
+    for (var i = 0; i < faust.theComments.length; i++) {
+        patcher.remove(faust.theComments[i]);
     }
+    faust.theComments = [];
 
-    getDSPName = function (patcher, name) {
-        var obj = patcher.firstobject;
-        while (obj) {
-            if (starts_with(obj.varname, name)) {
-                return obj;
-            }
-            obj = obj.nextobject;
-        }
-        return null;
+    // Remove sliders
+    for (var i = 0; i < faust.theSliders.length; i++) {
+        patcher.remove(faust.theSliders[i]);
+    }
+    faust.theSliders = [];
+
+    // Remove messages
+    for (var i = 0; i < faust.theMessages.length; i++) {
+        patcher.remove(faust.theMessages[i]);
     }
+    faust.theMessages = [];
+
+    // Remove number boxes
+    for (var i = 0; i < faust.thenumberBoxes.length; i++) {
+        patcher.remove(faust.thenumberBoxes[i]);
+    }
+    faust.thenumberBoxes = [];
+
+    // Reset the counter
+    faust.numwidgets = 0;
+};
+
+// Main function
+faust.ui = function (json, patcher) {
+
+    var widgHeight = 30;
+    var hBase = 150;
 
     // JSON parsing
+
+    // Recursive functions to parse the JSON UI description
     parse_ui = function (ui, target, patcher) {
         var i;
         for (i = 0; i < ui.length; i++) {
             parse_group(ui[i], target, patcher);
         }
     }
 
+    // Parse a group
     parse_group = function (group, target, patcher) {
         if (group.items) {
             parse_items(group.items, target, patcher);
         }
     }
 
+    // Parse items in a group
     parse_items = function (items, target, patcher) {
         var i;
         for (i = 0; i < items.length; i++) {
             parse_item(items[i], target, patcher);
         }
     }
 
+    // Parse a single item
     parse_item = function (item, target, patcher) {
         if (item.type === "vgroup" || item.type === "hgroup" || item.type === "tgroup") {
 
@@ -190,29 +228,23 @@ faust.ui = function (json, patcher) {
     }
 
     // Remove old
-    while (faust.numwidgets >= 0) {
-        patcher.remove(faust.theComments[faust.numwidgets]);
-        patcher.remove(faust.theSliders[faust.numwidgets]);
-        patcher.remove(faust.theMessages[faust.numwidgets]);
-        patcher.remove(faust.thenumberBoxes[faust.numwidgets]);
-        faust.numwidgets--;
-    }
+    faust.remove_ui();
 
     // Create new
-    var parsed_json = JSON.parse(json);
+    const parsed_json = JSON.parse(json);
 
     // Tries to find the compiled object from the "name" field in the JSON
-    var dsp_object1 = patcher.getnamed(parsed_json.name + "~");
-    if (dsp_object1 !== patcher.getnamed("null_object")) {
-        parse_ui(parsed_json.ui, dsp_object1, patcher);
+    var dsp_object = patcher.getnamed(parsed_json.name + "~");
+    if (dsp_object !== patcher.getnamed("null_object")) {
+        parse_ui(parsed_json.ui, dsp_object, patcher);
     } else {
         // Tries to find the compiled object from the "filename" field in the JSON
-        var dsp_object2 = patcher.getnamed(parsed_json.filename.slice(0, -4) + "~");
-        if (dsp_object2 !== patcher.getnamed("null_object")) {
-            parse_ui(parsed_json.ui, dsp_object2, patcher);
+        dsp_object = patcher.getnamed(parsed_json.filename.slice(0, -4) + "~");
+        if (dsp_object !== patcher.getnamed("null_object")) {
+            parse_ui(parsed_json.ui, dsp_object, patcher);
         } else {
             // Tries to find the compiled object from the "name" argument (used with faustgen~)
-            var dsp_object = getDSPName(patcher, "faustgen");
+            dsp_object = faust.get_with_name(patcher, "faustgen");
             if (dsp_object !== patcher.getnamed("null_object")) {
                 parse_ui(parsed_json.ui, dsp_object, patcher);
             } else {
@@ -222,8 +254,9 @@ faust.ui = function (json, patcher) {
     }
 }
 
+// Main entry point
 function anything() {
-    var args = arrayfromargs(messagename, arguments);
+    const args = arrayfromargs(messagename, arguments);
     dsp_ui_table.push(faust.ui(args[1], this.patcher));
 }
 

compiler/generator/llvm/llvm_code_container.cpp

@@ -283,7 +283,7 @@ dsp_factory_base* LLVMCodeContainer::produceFactory()
 
     // Possibly link with additional LLVM modules
     if (!linkAllModules(fContext, fModule, error)) {
-        throw faustexception("ERROR : " + error);
+        throw faustexception("ERROR/LLVM : " + error);
     }
 
     return new llvm_dynamic_dsp_factory_aux("", fModule, fContext, "", -1);

compiler/generator/llvm/llvm_dsp_aux.cpp

@@ -103,7 +103,7 @@ uint64_t llvm_dsp_factory_aux::loadOptimize(const string& function, bool strict)
         return fun;
     } else if (strict) {
         stringstream error;
-        error << "ERROR : loadOptimize failed for '" << function << "'\n";
+        error << "ERROR/LLVM : loadOptimize failed for '" << function << "'\n";
         throw faustexception(error.str());
     } else {
         return 0;
@@ -195,7 +195,7 @@ llvm_dsp_factory_aux::~llvm_dsp_factory_aux()
 
 void llvm_dsp_factory_aux::LLVMFatalErrorHandler(const char* reason)
 {
-    throw faustexception("ERROR : " + string(reason));
+    throw faustexception("ERROR/LLVM : " + string(reason));
 }
 
 void llvm_dsp_factory_aux::init(const string& type_name, const string& dsp_name)

embedded/faustgen/README.md

@@ -47,12 +47,12 @@ Depending of the number of audio inputs and outputs described in the DSP source
 
 When double-clicking on it, the **faustgen~/mc.faustgen~** object opens several menu items:
 
-- *Edit DSP code* allows to open the integrated text editor, edit the DSP code, then JIT compile it when the window is closed
-- *View DSP parameters* print each parameters in the Max console window with its label, complete path (as *xxx/yyy/zzz* syntax) and range, as well as the complete DSP JSON 
-- *View compile options* print all Faust compilation options in the Max console window
-- *View SVG digram* creates the block diagram SVG view and opens it in a browser
--  *View Web documention* access the standard Faust documention in a browser
-- *View libraries* open the embedded Faust libraies in a text editor
+- *Edit DSP code*: allows to open the integrated text editor, edit the DSP code, then JIT compile it when the window is closed
+- *View DSP parameters*: print each parameters in the Max console window with its label, complete path (as *xxx/yyy/zzz* syntax) and range, as well as the complete DSP JSON 
+- *View compile options*: print all Faust compilation options in the Max console window
+- *View SVG diagram*: creates the block diagram SVG view and opens it in a browser
+- *View Web documention*: access the standard Faust documention in a browser
+- *View libraries*: open the embedded Faust libraies in a text editor
 
 ### Controlling
 

tools/faust2appls/faust2gen

@@ -20,11 +20,10 @@ JSFILE_PATH="ui.js"
 echoHelp()
 {
     usage faust2gen "[options] <file.dsp>"
-    require Max/MSP SDK
     echo "Compiles Faust programs to a fausgen~/mc.faustgen patch"
     option
-    option '-nvoices <num>'
-    option -mc "to activate multi-channels model"
+    echo '   -nvoices <num> : to produce a polyphonic ready patch to be used with MIDI events'
+    echo '   -mc : to use a mc.faustgen~ object'
     exit
 }