summaryrefslogtreecommitdiff
path: root/opcodes/STKStifKarp.xml
blob: df4feb647a4898de19dc9d5caf0472a78c19ca6a (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
<refentry id="STKStifKarp">
  <indexterm id="IndexStkstifkarp"><primary>STKStifKarp</primary></indexterm>
  <refentryinfo><title>Signal Generators:STK Opcodes</title></refentryinfo>
  <refmeta>
    <refentrytitle>STKStifKarp</refentrytitle>
  </refmeta>
 
  <refnamediv>
    <refname>STKStifKarp</refname>
    <refpurpose>
      STKStifKarp is a plucked stiff string instrument. 
      </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      STKStifKarp is a plucked stiff string instrument. 
      It a simple plucked string algorithm (Karplus Strong) with enhancements, including string stiffness and pluck position controls. The stiffness is modeled with allpass filters.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>asignal <command>STKStifKarp</command> ifrequency, iamplitude, [kc1, kv1[, kc2, kv2[, kc3, kv3]]]</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>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 3 controller numbers and values that work for STKStifKarp are:
      <itemizedlist>
        <listitem><para><emphasis>kc, kv</emphasis> -- 4,   pickup position.</para></listitem>
        <listitem><para><emphasis>kc, kv</emphasis> -- 11,  string sustain </para></listitem>
        <listitem><para><emphasis>kc, kv</emphasis> -- 1,   string stretch.</para></listitem>
      </itemizedlist>
    </para>
  </refsect1>
 
    <refsect1>
    <note>
      <title>Note</title>
      <para>
         The code for this opcode is taken directly from the StifKarp 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>
    </note>
  </refsect1>
  
  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the STKStifKarp opcode. It uses the file <ulink url="examples/STKStifKarp.csd"><citetitle>STKStifKarp.csd</citetitle></ulink>.
     
      <example>
        <title>Example of the STKStifKarp opcode.</title>
        <xi:include href="examples-xml/STKStifKarp.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>

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