summaryrefslogtreecommitdiff
path: root/opcodes/STKFMVoices.xml
diff options
context:
space:
mode:
Diffstat (limited to 'opcodes/STKFMVoices.xml')
-rw-r--r--[-rwxr-xr-x]opcodes/STKFMVoices.xml35
1 files changed, 14 insertions, 21 deletions
diff --git a/opcodes/STKFMVoices.xml b/opcodes/STKFMVoices.xml
index c48a831..5295da0 100755..100644
--- a/opcodes/STKFMVoices.xml
+++ b/opcodes/STKFMVoices.xml
@@ -9,7 +9,7 @@
<refname>STKFMVoices</refname>
<refpurpose>
STKFMVoices is a singing FM synthesis instrument.
- </refpurpose>
+ </refpurpose>
</refnamediv>
<refsect1>
@@ -21,7 +21,7 @@
<refsect1>
<title>Syntax</title>
- <synopsis>asignal <command>STKFMVoices</command> ifrequency, iamplitude, [kc1, kv1[, kc2, kv2[, kc3, kv3[, kc4, kv4[, kc5, kv5]]]]]</synopsis>
+ <synopsis>asignal <command>STKFMVoices</command> ifrequency, iamplitude, [kvowel, kv1[, kspec, kv2[, klfo, kv3[, klfodepth, kv4[, kadsr, kv5]]]]]</synopsis>
</refsect1>
<refsect1>
@@ -37,18 +37,11 @@
<refsect1>
<title>Performance</title>
-
- <para>
- <emphasis>kc1, kv1, kc2, kv2, kc3, kv3, kc4, kv4, kc5, kv5, kc6, kv6, kc7, kv7, kc8, kv8</emphasis> -- Up to 8 optional k-rate controller pairs for the STK opcodes.
- Each controller pair consists of a controller number (kc) followed by a controller value (kv). The 5 controller numbers and values that work for STKFMVoices are:
- <itemizedlist>
- <listitem><para><emphasis>kc, kv</emphasis> -- 2, vowel.</para></listitem>
- <listitem><para><emphasis>kc, kv</emphasis> -- 4, spectral tilt </para></listitem>
- <listitem><para><emphasis>kc, kv</emphasis> -- 11, speed of low-frequency oscillator.</para></listitem>
- <listitem><para><emphasis>kc, kv</emphasis> -- 1, depth of low-frequency oscillator.</para></listitem>
- <listitem><para><emphasis>kc, kv</emphasis> -- 128, ADSR 2 and 4 Target.</para></listitem>
- </itemizedlist>
- </para>
+<para><emphasis>kvowel</emphasis> -- controller 2, vowel. Value range of kv1 is 0-127.</para>
+<para><emphasis>kspec</emphasis> -- controller 4, spectral tilt. Value range of kv2 is 0-127.</para>
+<para><emphasis>klfo</emphasis> -- controller 11, speed of low-frequency oscillator. Value range of kv3 is 0-127.</para>
+<para><emphasis>klfodepth</emphasis> -- controller 1, depth of low-frequency oscillator. Value range of kv4 is 0-127.</para>
+<para><emphasis>kadsr</emphasis> -- controller 128, ADSR 2 and 4 Target. Value range of kv5 is 0-127.</para>
</refsect1>
<refsect1>
@@ -57,6 +50,11 @@
<para>
The code for this opcode is taken directly from the FMVoices class in the Synthesis Toolkit in C++ by Perry R. Cook and Gary P. Scavone. More on the STK classes can be found here:
<ulink url="https://ccrma.stanford.edu/software/stk/classes.html"><citetitle>https://ccrma.stanford.edu/software/stk/classes.html</citetitle></ulink>
+ </para>
+ <para>
+ <emphasis>kc1, kv1, kc2, kv2, kc3, kv3, kc4, kv4, kc5, kv5, kc6, kv6, kc7, kv7, kc8, kv8</emphasis> -- Up to 8 optional k-rate controller pairs for the STK opcodes.
+ Each controller pair consists of a controller number (kc) followed by a controller value (kv). Both the controller numbers and the controller values are krate variables. However, during a performance, normally the controller numbers stay fixed while the corresponding controller values may change at any time.
+The order of the controller pair is arbitrary, as long as they are after <emphasis>iamplitude</emphasis>. Also, it is not needed that all controller pairs are used.
</para>
</note>
</refsect1>
@@ -64,8 +62,7 @@
<refsect1>
<title>Examples</title>
<para>
- Here is an example of the STKFMVoices opcode. It uses the file <ulink url="examples/STKFMVoices.csd"><citetitle>STKFMVoices.csd</citetitle></ulink>, and <ulink url="examples/fwavblnk.aiff"><citetitle>fwavblnk.aiff</citetitle></ulink>.
-
+ Here is an example of the STKFMVoices opcode. It uses the file <ulink url="examples/STKFMVoices.csd"><citetitle>STKFMVoices.csd</citetitle></ulink>.
<example>
<title>Example of the STKFMVoices opcode.</title>
<xi:include href="examples-xml/STKFMVoices.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
@@ -76,7 +73,7 @@
<refsect1>
<title>See Also</title>
<para>
- <link linkend="STKBeeThree"><citetitle>STKBeeThree</citetitle></link>,
+ <link linkend="STKBeeThree"><citetitle>STKBeeThree</citetitle></link>.
</para>
</refsect1>
@@ -93,7 +90,3 @@
</refsect1>
</refentry>
-
-
-
-