summaryrefslogtreecommitdiff
path: root/opcodes/STKSaxofony.xml
blob: f39dbb5ebd909581b2f47c659c5ac9c666659813 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
<refentry id="STKSaxofony">
  <indexterm id="IndexStksaxofony"><primary>STKSaxofony</primary></indexterm>
  <refentryinfo><title>Signal Generators:STK Opcodes</title></refentryinfo>
  <refmeta>
    <refentrytitle>STKSaxofony</refentrytitle>
  </refmeta>
 
  <refnamediv>
    <refname>STKSaxofony</refname>
    <refpurpose>
      STKSaxofony is a faux conical bore reed instrument.    </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      STKSaxofony is a faux conical bore reed instrument.
      This opcode uses a "hybrid" digital waveguide instrument that can generate a variety of wind-like sounds. It has also been referred to as the "blowed string" model. 
      The waveguide section is essentially that of a string, with one rigid and one lossy termination. The non-linear function is a reed table. 
      The string can be "blown" at any point between the terminations, though just as with strings, it is impossible to excite the system at either end. 
      If the excitation is placed at the string mid-point, the sound is that of a clarinet. At points closer to the "bridge", the sound is closer to that of a saxophone.</para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>asignal <command>STKSaxofony</command> ifrequency, iamplitude, [kstiff, kv1[, kapert, kv2[, kblow, kv3[, knoise, kv4[, klfo, kv5[, klfodepth, kv6[, kbreath, kv7]]]]]]]</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>ifrequency</emphasis> -- Frequency of note played, in Hertz.
    </para>
   
    <para>
      <emphasis>iamplitude</emphasis> -- Amplitude of note played (range 0-1).
    </para>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
<para><emphasis>kstiff</emphasis> -- controller 2, stiffness of reed. Value range of kv1 is 0-127.</para>
<para><emphasis>kapert</emphasis> -- controller 26, reed aperture. Value range of kv2 is 0-127.</para>
<para><emphasis>kblow</emphasis> -- controller 11, blow position. Value range of kv3 is 0-127.</para>
<para><emphasis>knoise</emphasis> -- controller 4, noise gain. Value range of kv4 is 0-127.</para>
<para><emphasis>klfo</emphasis> -- controller 29, speed of low-frequency oscillator. Value range of kv5 is 0-127.</para>
<para><emphasis>klfodepth</emphasis> -- controller 1, depth of low-frequency oscillator. Value range of kv6 is 0-127.</para>
<para><emphasis>kbreath</emphasis> -- controller 128, breath pressure. Value range of kv7 is 0-127.</para>
  </refsect1>
 
    <refsect1>
    <note>
      <title>Note</title>
      <para>
        The code for this opcode is taken directly from the Saxofony 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>
  
  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the STKSaxofony opcode. It uses the file <ulink url="examples/STKSaxofony.csd"><citetitle>STKSaxofony.csd</citetitle></ulink>.
     
      <example>
        <title>Example of the STKSaxofony opcode.</title>
        <xi:include href="examples-xml/STKSaxofony.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namemichael; (after Georg Essl)</member>
        <member>Irreducible Productions</member>
        <member>New York, NY</member>
      </simplelist>
    </para>
    <para>New in Csound version 5.11</para>
  </refsect1>
</refentry>