[NEW] Add -it option to inline rdtable/rwtable code in the main class…

…. Set version to 2.65.0.
grame-cncm · Aug 4, 2023 · e14fa86 · e14fa86
1 parent 7e791bb
commit e14fa86
Show file tree

Hide file tree

Showing 21 changed files with 126 additions and 66 deletions.
diff --git a/.github/workflows/libfaust.yml b/.github/workflows/libfaust.yml
@@ -1,7 +1,7 @@
 name: libfaust
 
 env:
-  FAUST_VERSION: 2.64.1
+  FAUST_VERSION: 2.65.0
   FAUSTGEN_VERSION: 1.65
   LLVM_PACKAGE_VERSION: 15.0.7
   CMAKE_OSX_DEPLOYMENT_TARGET: 10.15

diff --git a/COPYING.txt b/COPYING.txt
@@ -1,4 +1,4 @@
-    FAUST compiler, Version 2.64.1
+    FAUST compiler, Version 2.65.0
     Copyright (C) 2003-2019 GRAME, Centre National de Creation Musicale
     ---------------------------------------------------------------------
     This program is free software; you can redistribute it and/or modify

diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-version := 2.64.1
+version := 2.65.0
 
 system	?= $(shell uname -s)
 

diff --git a/architecture/faust/export.h b/architecture/faust/export.h
@@ -26,12 +26,12 @@
 #define __export__
 
 // Version as a global string
-#define FAUSTVERSION "2.64.1"
+#define FAUSTVERSION "2.65.0"
 
 // Version as separated [major,minor,patch] values
 #define FAUSTMAJORVERSION 2
-#define FAUSTMINORVERSION 64
-#define FAUSTPATCHVERSION 1
+#define FAUSTMINORVERSION 65
+#define FAUSTPATCHVERSION 0
 
 // Use FAUST_API for code that is part of the external API but is also compiled in faust and libfaust
 // Use LIBFAUST_API for code that is compiled in faust and libfaust

diff --git a/build/CMakeLists.txt b/build/CMakeLists.txt
@@ -3,7 +3,7 @@ project (faust)
 
 #######################################
 # versions management
-set (VERSION 2.64.1)
+set (VERSION 2.65.0)
 macro (get_major_minor_patch version)
 	string( REGEX REPLACE "([0-9]*)\\.([0-9]*)\\.([0-9]*)" "\\1"  VERSION_MAJOR ${version} )
 	string( REGEX REPLACE "([0-9]*)\\.([0-9]*)\\.([0-9]*)" "\\2"  VERSION_MINOR ${version} )

diff --git a/build/MakeRelease.bat b/build/MakeRelease.bat
@@ -1,6 +1,6 @@
 @echo off
 
-SET VERSION=2.64.1
+SET VERSION=2.65.0
 SET FAUSTGENVERSION=1.65
 
 SET MYPATH=%cd%

diff --git a/build/Makefile b/build/Makefile
@@ -28,7 +28,7 @@ system := $(shell echo $(system) | grep MINGW > /dev/null && echo MINGW || echo
 # output directories
 FAUSTDIR ?= faustdir
 IOSDIR   := iosdir
-VERSION := 2.64.1
+VERSION := 2.65.0
 
 #===============================================================
 # current generator and backends

diff --git a/compiler/README.md b/compiler/README.md
@@ -1,4 +1,4 @@
-% man(1) Version 2.64.1 (03-August-2023) | Faust man page
+% man(1) Version 2.65.0 (04-August-2023) | Faust man page
 
 NAME
 ====
@@ -88,6 +88,8 @@ Code generation options:
 
   **-os3**        **--one-sample3**               generate one sample computation (3 = like 2 but with external memory pointers kept in the DSP struct).
 
+  **-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].

diff --git a/compiler/generator/code_container.cpp b/compiler/generator/code_container.cpp
@@ -398,6 +398,7 @@ void CodeContainer::processFIR(void)
     /*
         Create memory layout, to be used in C++ backend and JSON generation.
         The description order follows what will be done at allocation time.
+        Subcontainers are ignored when gGlobal->gInlineTable == true
      
         // Create static tables
         mydsp::classInit();
@@ -421,22 +422,24 @@ void CodeContainer::processFIR(void)
             loop->accept(&struct_visitor);
 
             // Subcontainers used in classInit
-            for (const auto& it : fSubContainers) {
-                // Check that the subcontainer name appears as a type name in fStaticInitInstructions
-                SearchSubcontainer search_class(it->getClassName());
-                fStaticInitInstructions->accept(&search_class);
-                if (search_class.fFound) {
-                    // Subcontainer size
-                    VariableSizeCounter struct_size(Address::kStruct);
-                    it->generateDeclarations(&struct_size);
-                    fMemoryLayout.push_back(make_tuple(it->getClassName(), "kObj_ptr", 0, struct_size.fSizeBytes, 0, 0));
-
-                    // Get the associated table size and access
-                    pair<string, int> field = gGlobal->gTablesSize[it->getClassName()];
-
-                    // Check the table name memory description
-                    MemoryDesc& decs = struct_visitor.getMemoryDesc(field.first);
-                    fMemoryLayout.push_back(make_tuple(field.first, Typed::gTypeString[decs.fType], 0, field.second, decs.fRAccessCount, 0));
+            if (!gGlobal->gInlineTable) {
+                for (const auto& it : fSubContainers) {
+                    // Check that the subcontainer name appears as a type name in fStaticInitInstructions
+                    SearchSubcontainer search_class(it->getClassName());
+                    fStaticInitInstructions->accept(&search_class);
+                    if (search_class.fFound) {
+                        // Subcontainer size
+                        VariableSizeCounter struct_size(Address::kStruct);
+                        it->generateDeclarations(&struct_size);
+                        fMemoryLayout.push_back(make_tuple(it->getClassName(), "kObj_ptr", 0, struct_size.fSizeBytes, 0, 0));
+
+                        // Get the associated table size and access
+                        pair<string, int> field = gGlobal->gTablesSize[it->getClassName()];
+
+                        // Check the table name memory description
+                        MemoryDesc& decs = struct_visitor.getMemoryDesc(field.first);
+                        fMemoryLayout.push_back(make_tuple(field.first, Typed::gTypeString[decs.fType], 0, field.second, decs.fRAccessCount, 0));
+                    }
                 }
             }
         }
@@ -497,14 +500,16 @@ void CodeContainer::processFIR(void)
             }
 
             // Subcontainers used in instanceConstants
-            for (const auto& it : fSubContainers) {
-                // Check that the subcontainer name appears as a type name in fInitInstructions
-                SearchSubcontainer search_class(it->getClassName());
-                fInitInstructions->accept(&search_class);
-                if (search_class.fFound) {
-                    VariableSizeCounter struct_size(Address::kStruct);
-                    it->generateDeclarations(&struct_size);
-                    fMemoryLayout.push_back(make_tuple(it->getClassName(), "kObj_ptr", 0, struct_size.fSizeBytes, 0, 0));
+            if (!gGlobal->gInlineTable) {
+                for (const auto& it : fSubContainers) {
+                    // Check that the subcontainer name appears as a type name in fInitInstructions
+                    SearchSubcontainer search_class(it->getClassName());
+                    fInitInstructions->accept(&search_class);
+                    if (search_class.fFound) {
+                        VariableSizeCounter struct_size(Address::kStruct);
+                        it->generateDeclarations(&struct_size);
+                        fMemoryLayout.push_back(make_tuple(it->getClassName(), "kObj_ptr", 0, struct_size.fSizeBytes, 0, 0));
+                    }
                 }
             }
         }

diff --git a/compiler/generator/cpp/cpp_code_container.cpp b/compiler/generator/cpp/cpp_code_container.cpp
@@ -170,16 +170,24 @@ void CPPCodeContainer::produceInit(int tabs)
         tab(tabs, *fOut);
         *fOut << genVirtual() << "void init(int sample_rate) {";
         tab(tabs + 1, *fOut);
-        *fOut << "classInit(sample_rate);";
-        tab(tabs + 1, *fOut);
+        // Replaced by staticInit called in instanceInit
+        if (!gGlobal->gInlineTable) {
+            *fOut << "classInit(sample_rate);";
+            tab(tabs + 1, *fOut);
+        }
         *fOut << "instanceInit(sample_rate);";
         tab(tabs, *fOut);
         *fOut << "}";
     }
-
+    tab(tabs, *fOut);
     tab(tabs, *fOut);
     *fOut << genVirtual() << "void instanceInit(int sample_rate) {";
     tab(tabs + 1, *fOut);
+    // staticInit has to be called for each instance since the tables are actually not shared between instances
+    if (gGlobal->gInlineTable) {
+        *fOut << "staticInit(sample_rate);";
+        tab(tabs + 1, *fOut);
+    }
     *fOut << "instanceConstants(sample_rate);";
     tab(tabs + 1, *fOut);
     *fOut << "instanceResetUserInterface();";
@@ -301,11 +309,16 @@ void CPPCodeContainer::produceClass()
         tab(n, *fOut);
         *fOut << "namespace " << gGlobal->gNamespace << " {" << endl;
     }
-
+   
     generateHeader(n);
 
-    // Generate gub containers
-    generateSubContainers();
+    if (gGlobal->gInlineTable) {
+        // Sub containers are merged in the main class
+        mergeSubContainers();
+    } else {
+        // Generate gub containers
+        generateSubContainers();
+    }
 
     // Global declarations
     tab(n, *fOut);
@@ -377,12 +390,29 @@ void CPPCodeContainer::produceClass()
     */
 
     tab(n + 1, *fOut);
-    *fOut << "static void classInit(int sample_rate) {";
-    tab(n + 2, *fOut);
-    fCodeProducer->Tab(n + 2);
-    generateStaticInit(fCodeProducer);
-    back(1, *fOut);
-    *fOut << "}";
+    if (gGlobal->gInlineTable) {
+        // Dummy classInit
+        *fOut << "static void classInit(int sample_rate) {}";
+        tab(n + 1, *fOut);
+        // To be used in instanceInit
+        tab(n + 1, *fOut);
+        *fOut << "void staticInit(int sample_rate) {";
+        {
+            tab(n + 2, *fOut);
+            fCodeProducer->Tab(n + 2);
+            // Rename 'sig' in 'dsp', remove 'dsp' allocation, inline subcontainers 'instanceInit' and 'fill' function call
+            inlineSubcontainersFunCalls(fStaticInitInstructions)->accept(fCodeProducer);
+        }
+        back(1, *fOut);
+        *fOut << "}";
+    } else {
+        *fOut << "static void classInit(int sample_rate) {";
+        tab(n + 2, *fOut);
+        fCodeProducer->Tab(n + 2);
+        generateStaticInit(fCodeProducer);
+        back(1, *fOut);
+        *fOut << "}";
+    }
 
     if (gGlobal->gMemoryManager) {
         tab(n + 1, *fOut);
@@ -428,7 +458,12 @@ void CPPCodeContainer::produceClass()
     *fOut << genVirtual() << "void instanceConstants(int sample_rate) {";
     tab(n + 2, *fOut);
     fCodeProducer->Tab(n + 2);
-    generateInit(fCodeProducer);
+    if (gGlobal->gInlineTable) {
+        // Rename 'sig' in 'dsp', remove 'dsp' allocation, inline subcontainers 'instanceInit' and 'fill' function call
+        inlineSubcontainersFunCalls(fInitInstructions)->accept(fCodeProducer);
+    } else {
+        generateInit(fCodeProducer);
+    }
     back(1, *fOut);
     *fOut << "}";
     tab(n + 1, *fOut);
@@ -484,8 +519,8 @@ void CPPCodeContainer::produceClass()
 
     // Init
     produceInit(n + 1);
-
     tab(n + 1, *fOut);
+
     tab(n + 1, *fOut);
     *fOut << genVirtual() << fKlassName << "* clone() {";
     tab(n + 2, *fOut);
@@ -715,7 +750,7 @@ void CPPScalarOneSampleCodeContainer1::produceClass()
         produceInfoFunctions(n + 1, "", "dsp", true, FunTyped::kVirtual, fCodeProducer);
     }
 
-    // Dummy
+    // Dummy classInit
     tab(n + 1, *fOut);
     *fOut << "static void classInit(int sample_rate) {}";
     tab(n + 1, *fOut);
@@ -940,7 +975,7 @@ void CPPScalarOneSampleCodeContainer2::produceClass()
         produceInfoFunctions(n + 1, "", "dsp", true, FunTyped::kVirtual, fCodeProducer);
     }
 
-    // Dummy
+    // Dummy classInit
     tab(n + 1, *fOut);
     *fOut << "static void classInit(int sample_rate) {}";
     tab(n + 1, *fOut);
@@ -1185,7 +1220,7 @@ void CPPScalarOneSampleCodeContainer3::produceClass()
         produceInfoFunctions(n + 1, "", "dsp", true, FunTyped::kVirtual, fCodeProducer);
     }
 
-    // Dummy
+    // Dummy classInit
     tab(n + 1, *fOut);
     *fOut << "static void classInit(int sample_rate) {}";
     tab(n + 1, *fOut);
@@ -1452,7 +1487,7 @@ void CPPScalarOneSampleCodeContainer4::produceClass()
         produceInfoFunctions(n + 1, "", "dsp", true, FunTyped::kVirtual, fCodeProducer);
     }
 
-    // Dummy
+    // Dummy classInit
     tab(n + 1, *fOut);
     *fOut << "static void classInit(int sample_rate) {}";
     tab(n + 1, *fOut);

diff --git a/compiler/global.cpp b/compiler/global.cpp
@@ -478,6 +478,7 @@ void global::reset()
     gRemoveVarAddress     = false;
     gOneSample            = -1;
     gOneSampleControl     = false;
+    gInlineTable          = false;
     gComputeMix           = false;
     gBool2Int             = false;
     gFastMathLib          = "";
@@ -1361,6 +1362,10 @@ bool global::processCmdline(int argc, const char* argv[])
             gOneSample = 3;
             i += 1;
 
+        } else if (isCmd(argv[i], "-it", "--inline-table")) {
+            gInlineTable = true;
+            i += 1;
+
         } else if (isCmd(argv[i], "-cm", "--compute-mix")) {
             gComputeMix = true;
             i += 1;
@@ -1570,6 +1575,11 @@ bool global::processCmdline(int argc, const char* argv[])
                              "ERROR : '-dlt < INT_MAX' option can only be used in scalar mode and not with the 'ocpp' backend\n");
     }
 
+    // gInlinetable check
+    if (gInlineTable && gOutputLang != "cpp") {
+        throw faustexception("ERROR : -it can only be used with 'cpp' backend\n");
+    }
+
     // gComputeMix check
     if (gComputeMix && gOutputLang == "ocpp") {
         throw faustexception("ERROR : -cm cannot be used with the 'ocpp' backend\n");
@@ -1957,6 +1967,7 @@ static void printHelp()
          << "-os3        --one-sample3               generate one sample computation (3 = like 2 but with external "
          "memory pointers kept in the DSP struct)."
          << endl;
+    cout << tab << "-it         --inline-table              inline rdtable/rwtable code in the main class." << endl;
 
     cout << tab << "-cm         --compute-mix               mix in outputs buffers." << endl;
     cout << tab << "-ct         --check-table               check rtable/rwtable index range and generate safe access code [0/1: 1 by default]." << endl;

diff --git a/compiler/global.hh b/compiler/global.hh
@@ -205,6 +205,7 @@ struct global {
     bool   gRemoveVarAddress;      // If use of variable addresses (like &foo or &foo[n]) have to be removed
     int    gOneSample;             // -osX options, generate one sample computation
     bool   gOneSampleControl;      // -osX options, generate one sample computation control structure in DSP module
+    bool   gInlineTable;           // -it option, only in -cpp backend, to inline rdtable/rwtable code in the main class.
     bool   gComputeMix;            // -cm option, mix in outputs buffers
     bool   gBool2Int;              // Cast bool binary operations (comparison operations) to int
     std::string gNamespace;        // Wrapping namespace used with the C++ backend

diff --git a/documentation/compiler/Doxyfile b/documentation/compiler/Doxyfile
@@ -31,7 +31,7 @@ PROJECT_NAME           = "FAUST compiler"
 # This could be handy for archiving the generated documentation or 
 # if some version control system is used.
 
-PROJECT_NUMBER         = 2.64.1
+PROJECT_NUMBER         = 2.65.0
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
 # base path where the generated documentation will be put. 

diff --git a/documentation/libfaust/Doxyfile b/documentation/libfaust/Doxyfile
@@ -5,7 +5,7 @@
 #---------------------------------------------------------------------------
 DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = libfaust
-PROJECT_NUMBER         = 2.64.1
+PROJECT_NUMBER         = 2.65.0
 OUTPUT_DIRECTORY       = .
 CREATE_SUBDIRS         = NO
 OUTPUT_LANGUAGE        = English

diff --git a/documentation/libfaustremote/Doxyfile b/documentation/libfaustremote/Doxyfile
@@ -5,7 +5,7 @@
 #---------------------------------------------------------------------------
 DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = libfaustremote
-PROJECT_NUMBER         = 2.64.1
+PROJECT_NUMBER         = 2.65.0
 OUTPUT_DIRECTORY       = .
 CREATE_SUBDIRS         = NO
 OUTPUT_LANGUAGE        = English

diff --git a/documentation/man/README.md b/documentation/man/README.md
@@ -1,4 +1,4 @@
-% man(1) Version 2.64.1 (03-August-2023) | Faust man page
+% man(1) Version 2.65.0 (04-August-2023) | Faust man page
 
 NAME
 ====
@@ -88,6 +88,8 @@ Code generation options:
 
   **-os3**        **--one-sample3**               generate one sample computation (3 = like 2 but with external memory pointers kept in the DSP struct).
 
+  **-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].

diff --git a/documentation/man/man-header.txt b/documentation/man/man-header.txt
@@ -1,4 +1,4 @@
-% man(1) Version 2.64.1 (03-August-2023) | Faust man page
+% man(1) Version 2.65.0 (04-August-2023) | Faust man page
 
 NAME
 ====