Add faustdoctor project.

grame-cncm · Nov 23, 2024 · ca8c729 · ca8c729
1 parent c444383
commit ca8c729
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 8 deletions.
diff --git a/docs/index.html b/docs/index.html
@@ -473,5 +473,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.5.3
-Build Date UTC : 2024-11-11 11:21:52.630982+00:00
+Build Date UTC : 2024-11-23 09:11:35.892600+00:00
 -->
diff --git a/docs/manual/architectures/index.html b/docs/manual/architectures/index.html
@@ -320,12 +320,11 @@
     <div id="toc-collapse" class="navbar-collapse collapse card bg-secondary">
         <ul class="nav flex-column">
 
-            <li class="nav-item" data-level="1"><a href="#architecture-files" class="nav-link">Architecture Files</a>
-              <ul class="nav flex-column">
             <li class="nav-item" data-level="2"><a href="#minimal-structure-of-an-architecture-file" class="nav-link">Minimal Structure of an Architecture File</a>
               <ul class="nav flex-column">
               </ul>
             </li>
+
             <li class="nav-item" data-level="2"><a href="#audio-architecture-modules" class="nav-link">Audio Architecture Modules</a>
               <ul class="nav flex-column">
             <li class="nav-item" data-level="3"><a href="#external-and-internal-audio-sample-formats" class="nav-link">External and internal audio sample formats</a>
@@ -342,6 +341,7 @@
             </li>
               </ul>
             </li>
+
             <li class="nav-item" data-level="2"><a href="#midi-architecture-modules" class="nav-link">MIDI Architecture Modules</a>
               <ul class="nav flex-column">
             <li class="nav-item" data-level="4"><a href="#midi-messages-in-the-dsp-source-code" class="nav-link">MIDI Messages in the DSP Source Code</a>
@@ -358,6 +358,7 @@
             </li>
               </ul>
             </li>
+
             <li class="nav-item" data-level="2"><a href="#ui-architecture-modules" class="nav-link">UI Architecture Modules</a>
               <ul class="nav flex-column">
             <li class="nav-item" data-level="4"><a href="#active-widgets" class="nav-link">Active Widgets</a>
@@ -402,6 +403,7 @@
             </li>
               </ul>
             </li>
+
             <li class="nav-item" data-level="2"><a href="#dsp-architecture-modules" class="nav-link">DSP Architecture Modules</a>
               <ul class="nav flex-column">
             <li class="nav-item" data-level="3"><a href="#the-base-dsp-class" class="nav-link">The Base dsp Class</a>
@@ -506,6 +508,7 @@
             </li>
               </ul>
             </li>
+
             <li class="nav-item" data-level="2"><a href="#embedded-platforms" class="nav-link">Embedded Platforms</a>
               <ul class="nav flex-column">
             <li class="nav-item" data-level="4"><a href="#metadata-naming-convention" class="nav-link">Metadata Naming Convention</a>
@@ -518,6 +521,7 @@
             </li>
               </ul>
             </li>
+
             <li class="nav-item" data-level="2"><a href="#developing-a-new-architecture-file" class="nav-link">Developing a New Architecture File</a>
               <ul class="nav flex-column">
             <li class="nav-item" data-level="4"><a href="#adapting-the-generated-dsp" class="nav-link">Adapting the Generated DSP</a>
@@ -538,10 +542,12 @@
             </li>
               </ul>
             </li>
+
             <li class="nav-item" data-level="2"><a href="#other-languages-than-c" class="nav-link">Other Languages Than C++</a>
               <ul class="nav flex-column">
               </ul>
             </li>
+
             <li class="nav-item" data-level="2"><a href="#the-faust2xx-scripts" class="nav-link">The faust2xx Scripts</a>
               <ul class="nav flex-column">
             <li class="nav-item" data-level="3"><a href="#using-faust2xx-scripts" class="nav-link">Using faust2xx Scripts</a>
@@ -554,10 +560,12 @@
             </li>
               </ul>
             </li>
+
             <li class="nav-item" data-level="2"><a href="#the-faust2api-model" class="nav-link">The faust2api Model</a>
               <ul class="nav flex-column">
               </ul>
             </li>
+
             <li class="nav-item" data-level="2"><a href="#using-the-inj-option-with-faust2xx-scripts" class="nav-link">Using the -inj Option With faust2xx Scripts</a>
               <ul class="nav flex-column">
             <li class="nav-item" data-level="3"><a href="#using-the-template-llvmcpp-architecture" class="nav-link">Using the template-llvm.cpp architecture</a>
@@ -582,6 +590,7 @@
             </li>
               </ul>
             </li>
+
             <li class="nav-item" data-level="2"><a href="#additional-ressources" class="nav-link">Additional Ressources</a>
               <ul class="nav flex-column">
             <li class="nav-item" data-level="3"><a href="#preprocessing-tools" class="nav-link">Preprocessing tools</a>
@@ -602,6 +611,10 @@
               <ul class="nav flex-column">
               </ul>
             </li>
+            <li class="nav-item" data-level="4"><a href="#faustdoctor" class="nav-link">faustdoctor</a>
+              <ul class="nav flex-column">
+              </ul>
+            </li>
             <li class="nav-item" data-level="4"><a href="#dpf-faust-project-template" class="nav-link">dpf-faust-project-template</a>
               <ul class="nav flex-column">
               </ul>
@@ -774,14 +787,12 @@
             </li>
               </ul>
             </li>
-              </ul>
-            </li>
         </ul>
     </div>
 </div></div>
             <div class="col-md-9 main-container" role="main">
 
-<h1 id="architecture-files">Architecture Files</h1>
+<p># Architecture Files</p>
 <p>A Faust program describes a <em>signal processor</em>, a pure DSP computation that maps <em>input signals</em> to <em>output signals</em>. It says nothing about audio drivers or controllers (like GUI, OSC, MIDI, sensors) that are going to control the DSP. This additional information is provided by <em>architecture files</em>.</p>
 <p>An <em>architecture file</em> describes how to relate a Faust program to the external world, in particular the audio drivers and the controllers interfaces to be used. This approach allows a single Faust program to be easily deployed to a large variety of audio standards (e.g., Max/MSP externals, PD externals, VST plugins, CoreAudio applications, JACK applications, iPhone/Android, etc.):</p>
 <p><img src="img/Architectures.png" class="mx-auto d-block" width="90%"></p>
@@ -2667,6 +2678,8 @@ <h4 id="faust2hpp"><a href="https://github.com/resonantdsp/faust2hpp">faust2hpp<
 <p>Convert Faust code to a header-only standalone C++ library. A collection of header files is generated as the output. A class is provided from which a DSP object can be built with methods in the style of <a href="https://juce.com/">JUCE</a> DSP objects. </p>
 <h4 id="faustpp"><a href="https://github.com/jpcima/faustpp">faustpp</a></h4>
 <p>A post-processor for Faust, which allows to generate with more flexibility. This is a source transformation tool based on the Faust compiler. It permits to arrange the way how Faust source is generated with greater flexibility.</p>
+<h4 id="faustdoctor"><a href="https://github.com/SpotlightKid/faustdoctor">faustdoctor</a></h4>
+<p>A fork of <a href="https://github.com/jpcima/faustpp">faustpp</a> with greater flexibility.</p>
 <h4 id="dpf-faust-project-template"><a href="https://github.com/SpotlightKid/dpf-faust-project-template">dpf-faust-project-template</a></h4>
 <p>A <a href="https://github.com/copier-org/copier">copier</a> project template for DISTRHO Plugin Framework (<a href="https://github.com/DISTRHO/DPF">DPF</a>) audio effect plugins using <a href="https://faust.grame.fr">FAUST</a> for the implementation of the DSP pipeline.</p>
 <h4 id="faustmd"><a href="https://github.com/jpcima/faustmd">faustmd</a></h4>

diff --git a/docs/search/search_index.json b/docs/search/search_index.json
diff --git a/docs/sitemap.xml.gz b/docs/sitemap.xml.gz
diff --git a/mkdocs/docs/manual/architectures.md b/mkdocs/docs/manual/architectures.md
@@ -1,4 +1,4 @@
-# Architecture Files
+ # Architecture Files
 
 A Faust program describes a *signal processor*, a pure DSP computation that maps *input signals* to *output signals*. It says nothing about audio drivers or controllers (like GUI, OSC, MIDI, sensors) that are going to control the DSP. This additional information is provided by *architecture files*.
 
@@ -2279,6 +2279,10 @@ Convert Faust code to a header-only standalone C++ library. A collection of head
 
 A post-processor for Faust, which allows to generate with more flexibility. This is a source transformation tool based on the Faust compiler. It permits to arrange the way how Faust source is generated with greater flexibility.
 
+#### [faustdoctor](https://github.com/SpotlightKid/faustdoctor)
+
+A fork of [faustpp](https://github.com/jpcima/faustpp) with greater flexibility.
+
 #### [dpf-faust-project-template](https://github.com/SpotlightKid/dpf-faust-project-template)
 
 A [copier](https://github.com/copier-org/copier) project template for DISTRHO Plugin Framework ([DPF](https://github.com/DISTRHO/DPF)) audio effect plugins using [FAUST](https://faust.grame.fr) for the implementation of the DSP pipeline.