Complete JSFX tutorial.

grame-cncm · Sep 8, 2023 · 3abee49 · 3abee49
1 parent f098c92
commit 3abee49
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 18 deletions.
diff --git a/docs/index.html b/docs/index.html
@@ -464,5 +464,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.4.3
-Build Date UTC : 2023-09-07 04:38:13.255751+00:00
+Build Date UTC : 2023-09-08 14:19:23.493957+00:00
 -->
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/docs/tutorials/jsfx/exfaust0/exfaust0.svg b/docs/tutorials/jsfx/exfaust0/exfaust0.svg
diff --git a/docs/tutorials/jsfx/exfaust1/exfaust1.svg b/docs/tutorials/jsfx/exfaust1/exfaust1.svg
diff --git a/docs/tutorials/jsfx/exfaust2/exfaust2.svg b/docs/tutorials/jsfx/exfaust2/exfaust2.svg
diff --git a/docs/tutorials/jsfx/index.html b/docs/tutorials/jsfx/index.html
@@ -336,6 +336,14 @@
             </li>
             <li class="nav-item" data-level="2"><a href="#using-the-faust-web-ide" class="nav-link">Using the Faust Web IDE</a>
               <ul class="nav flex-column">
+            <li class="nav-item" data-level="3"><a href="#generating-a-jsfx-file" class="nav-link">Generating a JSFX file</a>
+              <ul class="nav flex-column">
+              </ul>
+            </li>
+            <li class="nav-item" data-level="3"><a href="#generating-a-jsfx-file-in-polyphonic-mode" class="nav-link">Generating a JSFX file in polyphonic mode</a>
+              <ul class="nav flex-column">
+              </ul>
+            </li>
               </ul>
             </li>
             <li class="nav-item" data-level="2"><a href="#limitations" class="nav-link">Limitations</a>
@@ -564,8 +572,11 @@ <h3 id="midi-polyphonic-example">MIDI polyphonic example</h3>
 (midi_event &gt; 0) ? (control());
 </code></pre>
 <h2 id="using-the-faust-web-ide">Using the Faust Web IDE</h2>
+<h3 id="generating-a-jsfx-file">Generating a JSFX file</h3>
 <p>The JSFX backend is available on the <a href="https://faustide.grame.fr/">Faust web IDE</a>. In order to export a Faust program as JSFX code, you will need to click on the "export/compile to specific target" button (on the left side, below "Save as"). Then, you need to  choose <strong><em>jsfx</em></strong> both as the platform and architecture, and click <strong><em>compile</em></strong>.<br />
 This will allow your to download a <code>binary.zip</code> file, containing the resulting <strong><em>jsfx</em></strong> file and your original <strong><em>dsp</em></strong> file. </p>
+<h3 id="generating-a-jsfx-file-in-polyphonic-mode">Generating a JSFX file in polyphonic mode</h3>
+<p>Use the <code>declare options "[midi:on][nvoices:n]";</code> <a href="https://faustdoc.grame.fr/manual/midi/#configuring-and-activating-polyphony">convention</a> in the DSP code to activate MIDI and polyphonic mode.</p>
 <h2 id="limitations">Limitations</h2>
 <p>As JSFX is a sandboxed environment, this backend cannot match the full Faust potential. Some features are missing, some other might come in the future. </p>
 <p>First, only three controls are available: </p>

diff --git a/src/tutorials/jsfx.md b/src/tutorials/jsfx.md
@@ -234,9 +234,16 @@ while (midirecv(mpos, msg1, msg2, msg3)) (
 
 ## Using the Faust Web IDE
 
+
+### Generating a JSFX file
+
 The JSFX backend is available on the [Faust web IDE](https://faustide.grame.fr/). In order to export a Faust program as JSFX code, you will need to click on the "export/compile to specific target" button (on the left side, below "Save as"). Then, you need to  choose ***jsfx*** both as the platform and architecture, and click ***compile***.  
 This will allow your to download a `binary.zip` file, containing the resulting ***jsfx*** file and your original ***dsp*** file. 
 
+### Generating a JSFX file in polyphonic mode
+
+Use the `declare options "[midi:on][nvoices:n]";` [convention](https://faustdoc.grame.fr/manual/midi/#configuring-and-activating-polyphony) in the DSP code to activate MIDI and polyphonic mode.
+
 ## Limitations
 
 As JSFX is a sandboxed environment, this backend cannot match the full Faust potential. Some features are missing, some other might come in the future.