summaryrefslogtreecommitdiff
path: root/opcodes/repluck.xml
blob: 99db143c74291d9e437bbeda2877739ad7bb5617 (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
91
92
93
94
95
96
97
98
<refentry id="repluck">
<indexterm id="IndexRepluck"><primary>repluck</primary></indexterm>
  <refentryinfo><title>Signal Generators:Waveguide Physical Modeling</title></refentryinfo>
  <refmeta>
    <refentrytitle>repluck</refentrytitle>
  </refmeta>


 
  <refnamediv>
    <refname>repluck</refname>
    <refpurpose>
      Physical model of the plucked string.
          </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
       <emphasis>repluck</emphasis> is an implementation of the physical model of the plucked string. A user can control the pluck point, the pickup point, the filter, and an additional audio signal, <emphasis>axcite</emphasis>. <emphasis>axcite</emphasis> is used to excite the 'string'. Based on the Karplus-Strong algorithm.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>ares <command>repluck</command> iplk, kamp, icps, kpick, krefl, axcite</synopsis>
 </refsect1>
 
  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>iplk</emphasis> -- The point of pluck is <emphasis>iplk</emphasis>, which is a fraction of the way up the string (0 to 1). A pluck point of zero means no initial pluck.
    </para>

    <para>
      <emphasis>icps</emphasis>  -- The string plays at <emphasis>icps</emphasis> pitch.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>kamp</emphasis> -- Amplitude of note.
    </para>

    <para>
      <emphasis>kpick</emphasis> -- Proportion of the way along the string to sample the output.
    </para>

    <para>
      <emphasis>krefl</emphasis> -- the coefficient of reflection, indicating the lossiness and the rate of decay. It must be strictly between 0 and 1 (it will complain about both 0 and 1).
    </para>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>axcite</emphasis> -- A signal which excites the string.
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the repluck opcode. It uses the file <ulink url="examples/repluck.csd"><citetitle>repluck.csd</citetitle></ulink>.

      <example>
        <title>Example of the repluck opcode.</title>

        

        <para>See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.</para>
          <xi:include href="examples-xml/repluck.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="wgpluck2"><citetitle>wgpluck2</citetitle></link>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namejohn;</member>
        <member>University of Bath/Codemist Ltd.</member>
        <member>Bath, UK</member>
        <member>1997</member>
      </simplelist>
    </para>
    <para>New in version 3.47</para>
  </refsect1>
</refentry>