Merge pull request #733 from tjingboem/7.0

25th / EXTRA bunch of SeeAlso
csound · May 28, 2024 · 9cbb7a3 · 9cbb7a3
2 parents 3a77710 + d81a109
commit 9cbb7a3
Show file tree

Hide file tree

Showing 33 changed files with 205 additions and 141 deletions.
diff --git a/Faustopcodes/top.xml b/Faustopcodes/top.xml
@@ -0,0 +1,29 @@
+
+<chapter id="FaustTop">
+  <title>Faust Opcodes</title>
+
+ <para>The Faust opcodes allows access from within Csound to the Faust language. Faust (Functional Audio Stream) is a functional programming language for sound synthesis and audio processing: <ulink url="https://faust.grame.fr/">https://faust.grame.fr/</ulink>. </para>
+  <para>The following opcodes are available:</para>
+
+  <itemizedlist>
+    <listitem>
+      <para><link linkend="faustaudio"><citetitle>faustaudio</citetitle></link> - Instantiates and runs a compiled Faust program.</para>
+    </listitem>
+    <listitem>
+      <para><link linkend="faustcompile"><citetitle>faustcompile</citetitle></link> - Produce a instantiable DSP process from a Faust program.</para>
+    </listitem>
+    <listitem>
+      <para><link linkend="faustdsp"><citetitle>faustdsp</citetitle></link> - Instantiates a Faust program.</para>
+    </listitem>
+    <listitem>
+      <para><link linkend="faustctl"><citetitle>faustctl</citetitle></link> - Adjusts a given control in a Faust DSP instance.</para>
+    </listitem>
+    <listitem>
+      <para><link linkend="faustgen"><citetitle>faustgen</citetitle></link> - Compiles, Instantiates and runs a compiled Faust program.</para>
+    </listitem>
+   <listitem>
+      <para><link linkend="faustplay"><citetitle>faustplay</citetitle></link> - Runs an instantiated Faust program.</para>
+    </listitem>
+  </itemizedlist>
+
+</chapter>
diff --git a/control/invocat.xml b/control/invocat.xml
@@ -18,11 +18,22 @@
       <listitem><para><link linkend="schedkwhennamed"><citetitle>schedkwhennamed</citetitle></link></para></listitem>
     </itemizedlist>
   </para>
+
   <para>
     The <link linkend="mute"><citetitle>mute</citetitle></link> opcode can be used to mute/unmute instruments during a performance.
   </para>
+
   <para>
     Instruments definitions can be removed using the <link linkend="remove"><citetitle>remove</citetitle></link> opcode.
   </para>
 
+    <para>
+    These opcodes will compile one or more instruments at init time:
+    <itemizedlist>
+      <listitem><para><link linkend="compilecsd"><citetitle>compilecsd</citetitle></link></para></listitem>
+      <listitem><para><link linkend="compileorc"><citetitle>compileorc</citetitle></link></para></listitem>
+      <listitem><para><link linkend="compilestr"><citetitle>compilestr</citetitle></link></para></listitem>
+    </itemizedlist>
+  </para>
+
 </section>
diff --git a/manual.xml b/manual.xml
@@ -48,6 +48,7 @@
 <!ENTITY Remote SYSTEM "oscnetwork/Remote.xml">
 
 <!ENTITY AbletonLink SYSTEM "oscnetwork/AbletonLink.xml">
+<!ENTITY nonMIDIdevices SYSTEM "oscnetwork/nonMIDIdevices.xml">
 
 <!ENTITY command SYSTEM "command/top.xml">
 <!ENTITY commanddesc SYSTEM "command/desc.xml">
@@ -76,6 +77,7 @@
 <!ENTITY controlsubinstr SYSTEM "control/subinstr.xml">
 <!ENTITY controltimeread SYSTEM "control/timeread.xml">
 
+<!ENTITY Faustopcodes SYSTEM "Faustopcodes/top.xml">
 <!ENTITY imageopcodes SYSTEM "imageopcodes/top.xml">
 <!ENTITY stkopcodes SYSTEM "STKopcodes/top.xml">
 <!ENTITY miscopcodes SYSTEM "miscopcodes/top.xml">
@@ -1997,6 +1999,7 @@
     &signalflowgraph;
     &jacko;
     &py;
+    &Faustopcodes;
     &imageopcodes;
     &stkopcodes;
     &miscopcodes;

diff --git a/midi/input.xml b/midi/input.xml
@@ -1,5 +1,5 @@
 <section id="MidiInput">
-  <title>MIDI input and initialization</title>
+  <title>MIDI input and Initialization</title>
 
   <para>
     The following opcodes can receive MIDI information:
@@ -16,7 +16,9 @@
       </listitem>
       <listitem><para>MIDI controller  value initialization: <link linkend="initc7"><citetitle>initc7</citetitle></link>, <link linkend="initc14"><citetitle>initc14</citetitle></link>, 
         <link linkend="initc21"><citetitle>initc21</citetitle></link>, <link linkend="ctrlinit"><citetitle>ctrlinit</citetitle></link>, <link linkend="ctrlpreset"><citetitle>ctrlpreset</citetitle></link>, <link linkend="ctrlprint"><citetitle>ctrlprint</citetitle></link>, 
-      <link linkend="ctrlprintpresets"><citetitle>ctrlprintpresets</citetitle></link>, <link linkend="ctrlsave"><citetitle>ctrlsave</citetitle></link> and <link linkend="ctrlselect"><citetitle>ctrlselect</citetitle></link></para>
+      <link linkend="ctrlprintpresets"><citetitle>ctrlprintpresets</citetitle></link>, <link linkend="ctrlsave"><citetitle>ctrlsave</citetitle></link> and <link linkend="ctrlselect"><citetitle>ctrlselect</citetitle></link>.</para>
+      </listitem>
+      <listitem><para>MIDI file input information: <link linkend="midifilestatus"><citetitle>midifilestatus</citetitle></link>.</para>
       </listitem>
       <listitem><para>Generic MIDI input: <link linkend="midiin"><citetitle>midiin</citetitle></link>.</para>
       </listitem>

diff --git a/opcodes/arduinoRead.xml b/opcodes/arduinoRead.xml
@@ -60,11 +60,8 @@
 
   <refsect1>
     <title>See Also</title>
-                 <para> More information: <ulink url="https://csound.com/icsc2022/proceedings/New%20Arduino%20Opcodes%20to%20Simplify%20the%20Streaming%20of%20Sensor%20and%20Controller%20Data%20to%20Csound.pdf"><citetitle>New Arduino Opcodes to Simplify the Streaming of Sensor and Controller Data to Csound</citetitle></ulink></para>
-    <para>
-      <link linkend="arduinoStart"><citetitle></citetitle>arduinoStart</link>,
-      <link linkend="arduinoStop"><citetitle></citetitle>arduinoStop</link>,
-    </para>
+        <para><link linkend="nonMIDIdevices"><citetitle>non-MIDI Devices</citetitle></link></para>
+        <para> More information: <ulink url="https://csound.com/icsc2022/proceedings/New%20Arduino%20Opcodes%20to%20Simplify%20the%20Streaming%20of%20Sensor%20and%20Controller%20Data%20to%20Csound.pdf"><citetitle>New Arduino Opcodes to Simplify the Streaming of Sensor and Controller Data to Csound</citetitle></ulink></para>
   </refsect1>
 
   <refsect1>

diff --git a/opcodes/arduinoReadF.xml b/opcodes/arduinoReadF.xml
@@ -61,12 +61,8 @@
 
   <refsect1>
     <title>See Also</title>
-    <para>
-      <link linkend="arduinoStart"><citetitle></citetitle>arduinoStart</link>,
-      <link linkend="arduinoStop"><citetitle></citetitle>arduinoStop</link>,
-      <link linkend="arduinoRead"><citetitle></citetitle>arduinoRead</link>,
-    </para>
-    <para> More information: <ulink url="https://csound.com/icsc2022/proceedings/New%20Arduino%20Opcodes%20to%20Simplify%20the%20Streaming%20of%20Sensor%20and%20Controller%20Data%20to%20Csound.pdf"><citetitle>New Arduino Opcodes to Simplify the Streaming of Sensor and Controller Data to Csound</citetitle></ulink></para>
+        <para><link linkend="nonMIDIdevices"><citetitle>non-MIDI Devices</citetitle></link></para>
+        <para> More information: <ulink url="https://csound.com/icsc2022/proceedings/New%20Arduino%20Opcodes%20to%20Simplify%20the%20Streaming%20of%20Sensor%20and%20Controller%20Data%20to%20Csound.pdf"><citetitle>New Arduino Opcodes to Simplify the Streaming of Sensor and Controller Data to Csound</citetitle></ulink></para>
   </refsect1>
 
   <refsect1>

diff --git a/opcodes/arduinoStart.xml b/opcodes/arduinoStart.xml
@@ -40,10 +40,8 @@
 
   <refsect1>
     <title>See Also</title>
-    <para>
-      <link linkend="arduinoStop"><citetitle></citetitle>arduinoStop</link>,
-      <link linkend="arduinoRead"><citetitle></citetitle>arduinoRead</link>,
-    </para>
+        <para><link linkend="nonMIDIdevices"><citetitle>non-MIDI Devices</citetitle></link></para>
+        <para> More information: <ulink url="https://csound.com/icsc2022/proceedings/New%20Arduino%20Opcodes%20to%20Simplify%20the%20Streaming%20of%20Sensor%20and%20Controller%20Data%20to%20Csound.pdf"><citetitle>New Arduino Opcodes to Simplify the Streaming of Sensor and Controller Data to Csound</citetitle></ulink></para>
   </refsect1>
 
   <refsect1>

diff --git a/opcodes/arduinoStop.xml b/opcodes/arduinoStop.xml
@@ -37,10 +37,8 @@
 
   <refsect1>
     <title>See Also</title>
-    <para>
-      <link linkend="arduinoStart"><citetitle></citetitle>arduinoStart</link>,
-      <link linkend="arduinoRead"><citetitle></citetitle>arduinoRead</link>,
-    </para>
+        <para><link linkend="nonMIDIdevices"><citetitle>non-MIDI Devices</citetitle></link></para>
+        <para> More information: <ulink url="https://csound.com/icsc2022/proceedings/New%20Arduino%20Opcodes%20to%20Simplify%20the%20Streaming%20of%20Sensor%20and%20Controller%20Data%20to%20Csound.pdf"><citetitle>New Arduino Opcodes to Simplify the Streaming of Sensor and Controller Data to Csound</citetitle></ulink></para>
   </refsect1>
 
   <refsect1>

diff --git a/opcodes/compilecsd.xml b/opcodes/compilecsd.xml
@@ -48,17 +48,10 @@
 
   </refsect1>
 
-  <refsect1>
-    <title>See also</title>
-    <para>
-      <link linkend="event"><citetitle>event</citetitle></link>,
-      <link linkend="event_i"><citetitle>event_i</citetitle></link>,
-      <link linkend="schedule"><citetitle>schedule</citetitle></link>,
-      <link linkend="schedwhen"><citetitle>schedwhen</citetitle></link>,
-      <link linkend="schedkwhen"><citetitle>schedkwhen</citetitle></link>,
-      <link linkend="schedkwhennamed"><citetitle>schedkwhennamed</citetitle></link>
-    </para>
-  </refsect1>
+      <refsect1>
+        <title>See also</title>
+        <para><link linkend="ControlInvocat"><citetitle>Instrument Invocation</citetitle></link></para>
+    </refsect1>
 
   <refsect1>
     <title>Credits</title>

diff --git a/opcodes/compileorc.xml b/opcodes/compileorc.xml
@@ -50,17 +50,10 @@ definition will still perform until it terminates.
 
   </refsect1>
 
-  <refsect1>
-    <title>See also</title>
-    <para>
-      <link linkend="event"><citetitle>event</citetitle></link>,
-      <link linkend="event_i"><citetitle>event_i</citetitle></link>,
-      <link linkend="schedule"><citetitle>schedule</citetitle></link>,
-      <link linkend="schedwhen"><citetitle>schedwhen</citetitle></link>,
-      <link linkend="schedkwhen"><citetitle>schedkwhen</citetitle></link>,
-      <link linkend="schedkwhennamed"><citetitle>schedkwhennamed</citetitle></link>
-    </para>
-  </refsect1>
+      <refsect1>
+        <title>See also</title>
+        <para><link linkend="ControlInvocat"><citetitle>Instrument Invocation</citetitle></link></para>
+    </refsect1>
 
   <refsect1>
     <title>Credits</title>

diff --git a/opcodes/compilestr.xml b/opcodes/compilestr.xml
@@ -51,17 +51,10 @@ Multi-line strings are accepted, using {{  }} to enclose the string.
 
   </refsect1>
 
-  <refsect1>
-    <title>See also</title>
-    <para>
-      <link linkend="event"><citetitle>event</citetitle></link>,
-      <link linkend="event_i"><citetitle>event_i</citetitle></link>,
-      <link linkend="schedule"><citetitle>schedule</citetitle></link>,
-      <link linkend="schedwhen"><citetitle>schedwhen</citetitle></link>,
-      <link linkend="schedkwhen"><citetitle>schedkwhen</citetitle></link>,
-      <link linkend="schedkwhennamed"><citetitle>schedkwhennamed</citetitle></link>
-    </para>
-  </refsect1>
+      <refsect1>
+        <title>See also</title>
+        <para><link linkend="ControlInvocat"><citetitle>Instrument Invocation</citetitle></link></para>
+    </refsect1>
 
   <refsect1>
     <title>Credits</title>

diff --git a/opcodes/faustaudio.xml b/opcodes/faustaudio.xml
@@ -59,7 +59,12 @@ its controls with faustctl.
       </example>
     </para>
   </refsect1>
-
+
+      <refsect1>
+        <title>See also</title>
+        <para><link linkend="FaustTop"><citetitle>Faust Opcodes</citetitle></link></para>
+    </refsect1>
+
   <refsect1>
     <title>Credits</title>
     <para>Author: &namevictor;, 2013 </para>

diff --git a/opcodes/faustcompile.xml b/opcodes/faustcompile.xml
@@ -58,6 +58,12 @@
       </example>
     </para>
   </refsect1>
+
+      <refsect1>
+        <title>See also</title>
+        <para><link linkend="FaustTop"><citetitle>Faust Opcodes</citetitle></link></para>
+    </refsect1>
+
   <refsect1>
     <title>Credits</title>
     <para>Author: &namevictor;, 2013 </para>

diff --git a/opcodes/faustctl.xml b/opcodes/faustctl.xml
@@ -56,6 +56,12 @@
       </example>
     </para>
   </refsect1>
+
+      <refsect1>
+        <title>See also</title>
+        <para><link linkend="FaustTop"><citetitle>Faust Opcodes</citetitle></link></para>
+    </refsect1>
+
   <refsect1>
     <title>Credits</title>
     <para>Author: &namevictor;, 2013 </para>

diff --git a/opcodes/faustdsp.xml b/opcodes/faustdsp.xml
@@ -51,6 +51,11 @@ its controls with faustctl.
       </example>
     </para>
   </refsect1>
+
+      <refsect1>
+        <title>See also</title>
+        <para><link linkend="FaustTop"><citetitle>Faust Opcodes</citetitle></link></para>
+    </refsect1>
 
   <refsect1>
     <title>Credits</title>

diff --git a/opcodes/faustgen.xml b/opcodes/faustgen.xml
@@ -59,6 +59,12 @@ its controls with faustctl.
       </example>
     </para>
   </refsect1>
+
+      <refsect1>
+        <title>See also</title>
+        <para><link linkend="FaustTop"><citetitle>Faust Opcodes</citetitle></link></para>
+    </refsect1>
+
   <refsect1>
     <title>Credits</title>
     <para>Author: &namevictor;, 2013 </para>

diff --git a/opcodes/faustplay.xml b/opcodes/faustplay.xml
@@ -56,6 +56,11 @@
       </example>
     </para>
   </refsect1>
+
+      <refsect1>
+        <title>See also</title>
+        <para><link linkend="FaustTop"><citetitle>Faust Opcodes</citetitle></link></para>
+    </refsect1>
 
   <refsect1>
     <title>Credits</title>

diff --git a/opcodes/midifilestatus.xml b/opcodes/midifilestatus.xml
@@ -1,7 +1,7 @@
 
 <refentry id="midifilestatus">
 <indexterm id="IndexMidifilestatus"><primary>midifilestatus</primary></indexterm>
-  <refentryinfo><title>Instrument Control:Sensing and Control</title></refentryinfo>
+  <refentryinfo><title>MIDI input and Initialization</title></refentryinfo>
   <refmeta>
     <refentrytitle>midifilestatus</refentrytitle>
   </refmeta>
@@ -29,7 +29,12 @@ has been reached.
     <title>Syntax</title>
     <synopsis>ksig  <command>midifilestatus</command></synopsis>
   </refsect1>
-
+
+      <refsect1>
+        <title>See also</title>
+        <para><link linkend="MidiInput"><citetitle>MIDI input and Initialization</citetitle></link></para>
+    </refsect1>
+
   <refsect1>
     <title>Credits</title>
     <para>

diff --git a/opcodes/p5gconnect.xml b/opcodes/p5gconnect.xml
@@ -60,9 +60,7 @@
 
   <refsect1>
     <title>See Also</title>
-    <para>
-      <link linkend="p5gdata"><citetitle>p5gdata</citetitle></link>,
-     </para>
+        <para><link linkend="nonMIDIdevices"><citetitle>non-MIDI Devices</citetitle></link></para>
   </refsect1>
 
   <refsect1>

diff --git a/opcodes/p5gdata.xml b/opcodes/p5gdata.xml
@@ -129,9 +129,7 @@
 
   <refsect1>
     <title>See Also</title>
-    <para>
-      <link linkend="p5gconnect"><citetitle>p5gconnect</citetitle></link>,
-     </para>
+        <para><link linkend="nonMIDIdevices"><citetitle>non-MIDI Devices</citetitle></link></para>
   </refsect1>
 
   <refsect1>

diff --git a/opcodes/serialBegin.xml b/opcodes/serialBegin.xml
@@ -75,14 +75,7 @@ void loop() {
 
   <refsect1>
     <title>See Also</title>
-    <para>
-      <link linkend="serialEnd"><citetitle></citetitle>serialEnd</link>,
-      <link linkend="serialWrite_i"><citetitle></citetitle>serialWrite_i</link>,
-      <link linkend="serialWrite"><citetitle></citetitle>serialWrite</link>,
-      <link linkend="serialRead"><citetitle></citetitle>serialRead</link>,
-      <link linkend="serialPrint"><citetitle></citetitle>serialPrint</link>,
-      <link linkend="serialFlush"><citetitle></citetitle>serialFlush</link>.
-    </para>
+        <para><link linkend="nonMIDIdevices"><citetitle>non-MIDI Devices</citetitle></link></para>
   </refsect1>
 
   <refsect1>

diff --git a/opcodes/serialEnd.xml b/opcodes/serialEnd.xml
@@ -37,14 +37,7 @@
 
   <refsect1>
     <title>See Also</title>
-    <para>
-      <link linkend="serialBegin"><citetitle></citetitle>serialBegin</link>,
-      <link linkend="serialWrite_i"><citetitle></citetitle>serialWrite_i</link>,
-      <link linkend="serialWrite"><citetitle></citetitle>serialWrite</link>,
-      <link linkend="serialRead"><citetitle></citetitle>serialRead</link>,
-      <link linkend="serialPrint"><citetitle></citetitle>serialPrint</link>,
-      <link linkend="serialFlush"><citetitle></citetitle>serialFlush</link>.
-    </para>
+        <para><link linkend="nonMIDIdevices"><citetitle>non-MIDI Devices</citetitle></link></para>
   </refsect1>
 
   <refsect1>

diff --git a/opcodes/serialFlush.xml b/opcodes/serialFlush.xml
@@ -42,14 +42,7 @@ parse the data with the <emphasis>serialRead</emphasis> opcode.
 
   <refsect1>
     <title>See Also</title>
-    <para>
-      <link linkend="serialBegin"><citetitle></citetitle>serialBegin</link>,
-      <link linkend="serialEnd"><citetitle></citetitle>serialEnd</link>,
-      <link linkend="serialWrite_i"><citetitle></citetitle>serialWrite_i</link>,
-      <link linkend="serialWrite"><citetitle></citetitle>serialWrite</link>,
-      <link linkend="serialRead"><citetitle></citetitle>serialRead</link>,
-      <link linkend="serialPrint"><citetitle></citetitle>serialPrint</link>.
-    </para>
+        <para><link linkend="nonMIDIdevices"><citetitle>non-MIDI Devices</citetitle></link></para>
   </refsect1>
 
   <refsect1>