summaryrefslogtreecommitdiff
path: root/opcodes/wgbow.xml
blob: 8da87b3e599c8e8e384d67aff6a2e4b49ed651eb (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
99
100
<refentry id="wgbow">
<indexterm id="IndexWgbow"><primary>wgbow</primary></indexterm>
  <refentryinfo><title>Signal Generators:Waveguide Physical Modeling</title></refentryinfo>
  <refmeta>
    <refentrytitle>wgbow</refentrytitle>
  </refmeta>


 
  <refnamediv>
    <refname>wgbow</refname>
    <refpurpose>
      Creates a tone similar to a bowed string.
          </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Audio output is a tone similar to a bowed string, using a physical model developed from &nameperry;, but re-coded for Csound.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>ares <command>wgbow</command> kamp, kfreq, kpres, krat, kvibf, kvamp, ifn [, iminfreq]</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>ifn</emphasis> -- table of shape of vibrato, usually a sine table, created by a function
    </para>

    <para>
      <emphasis>iminfreq</emphasis> (optional) -- lowest frequency at which the instrument will play. If it is omitted it is taken to be the same as the initial <emphasis>kfreq</emphasis>. If <emphasis>iminfreq</emphasis> is negative, initialization will be skipped.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      A note is played on a string-like instrument, with the arguments as below.
    </para>

    <para>
      <emphasis>kamp</emphasis> -- amplitude of note.
    </para>

    <para>
      <emphasis>kfreq</emphasis> -- frequency of note played.
    </para>

    <para>
      <emphasis>kpres</emphasis> -- a parameter controlling the pressure of the bow on the string. Values should be about 3. The useful range is approximately 1 to 5.
    </para>

    <para>
      <emphasis>krat</emphasis> -- the position of the bow along the string. Usual playing is about 0.127236. The suggested range is 0.025 to 0.23.
    </para>

    <para>
      <emphasis>kvibf</emphasis> -- frequency of vibrato in Hertz. Suggested range is 0 to 12
    </para>

    <para>
      <emphasis>kvamp</emphasis> -- amplitude of the vibrato
    </para>
  </refsect1>
 
  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the wgbow opcode. It uses the file <ulink url="examples/wgbow.csd"><citetitle>wgbow.csd</citetitle></ulink>.

      <example>
        <title>Example of the wgbow 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/wgbow.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namejohn; (after &nameperry;)</member>
        <member>University of Bath, Codemist Ltd.</member>
        <member>Bath, UK</member>
      </simplelist>
    </para>

    <para>New in Csound version 3.47</para>
  </refsect1>
</refentry>