summaryrefslogtreecommitdiff
path: root/opcodes/STKResonate.xml
diff options
context:
space:
mode:
Diffstat (limited to 'opcodes/STKResonate.xml')
-rw-r--r--[-rwxr-xr-x]opcodes/STKResonate.xml30
1 files changed, 11 insertions, 19 deletions
diff --git a/opcodes/STKResonate.xml b/opcodes/STKResonate.xml
index b588c4b..0270433 100755..100644
--- a/opcodes/STKResonate.xml
+++ b/opcodes/STKResonate.xml
@@ -21,7 +21,7 @@
<refsect1>
<title>Syntax</title>
- <synopsis>asignal <command>STKResonate</command> ifrequency, iamplitude, [kc1, kv1[, kc2, kv2[, kc3, kv3[, kc4, kv4[, kc5, kv5]]]]]</synopsis>
+ <synopsis>asignal <command>STKResonate</command> ifrequency, iamplitude, [kfreq, kv1[, kpole, kv2[, knotch, kv3[, kzero, kv4[, kenv, 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 STKResonate are:
- <itemizedlist>
- <listitem><para><emphasis>kc, kv</emphasis> -- 2, frequency of resonance.</para></listitem>
- <listitem><para><emphasis>kc, kv</emphasis> -- 4, pole radii </para></listitem>
- <listitem><para><emphasis>kc, kv</emphasis> -- 11, notch frequency.</para></listitem>
- <listitem><para><emphasis>kc, kv</emphasis> -- 1, zero radii.</para></listitem>
- <listitem><para><emphasis>kc, kv</emphasis> -- 128, gain of envelope.</para></listitem>
- </itemizedlist>
- </para>
+<para><emphasis>kfreq</emphasis> -- controller 2, frequency of resonance. Value range of kv1 is 0-127.</para>
+<para><emphasis>kpole</emphasis> -- controller 4, pole radii. Value range of kv2 is 0-127.</para>
+<para><emphasis>knotch</emphasis> -- controller 11, notch frequency. Value range of kv3 is 0-127.</para>
+<para><emphasis>kzero</emphasis> -- controller 1, zero radii. Value range of kv4 is 0-127.</para>
+<para><emphasis>kenv</emphasis> -- controller 128, gain of envelope. Value range of kv5 is 0-127.</para>
</refsect1>
<refsect1>
@@ -58,6 +51,11 @@
The code for this opcode is taken directly from the Resonate 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>
@@ -86,9 +84,3 @@
</refsect1>
</refentry>
-
-
-
-
-
-