summaryrefslogtreecommitdiff
path: root/opcodes/mandol.xml
blob: 374261e9b842619000e4b53eaf1626421d03dff6 (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
<refentry id="mandol">
<indexterm id="IndexMandol"><primary>mandol</primary></indexterm>
  <refentryinfo><title>Signal Generators:Models and Emulations</title></refentryinfo>
  <refmeta>
    <refentrytitle>mandol</refentrytitle>
  </refmeta>


 
  <refnamediv>
    <refname>mandol</refname>
    <refpurpose>
      An emulation of a mandolin.
          </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      An emulation of a mandolin.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>ares <command>mandol</command> kamp, kfreq, kpluck, kdetune, kgain, ksize, ifn [, iminfreq]</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>ifn</emphasis> -- table number containing the pluck wave form. The file <ulink url="examples/mandpluk.aiff"><citetitle>mandpluk.aiff</citetitle></ulink> is suitable for this. It is also available at <ulink
url="ftp://ftp.cs.bath.ac.uk/pub/dream/documentation/sounds/modelling/"><citetitle>ftp://ftp.cs.bath.ac.uk/pub/dream/documentation/sounds/modelling/</citetitle></ulink>.
    </para>

    <para>
      <emphasis>iminfreq</emphasis> (optional, default=0) -- Lowest frequency to be played on the note. If it is omitted it is taken to be the same as the initial <emphasis>kfreq</emphasis>.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>kamp</emphasis> -- Amplitude of note.
    </para>

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

    <para>
      <emphasis>kpluck</emphasis> -- The pluck position, in range 0 to 1. Suggest 0.4.
    </para>

    <para>
      <emphasis>kdetune </emphasis> -- The proportional detuning between the two strings. Suggested range 0.9 to 1.
    </para>

    <para>
      <emphasis>kgain</emphasis> -- the loop gain of the model, in the range 0.97 to 1.
    </para>

    <para>
      <emphasis>ksize</emphasis> -- The size of the body of the mandolin. Range 0 to 2.
    </para>
  </refsect1>

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

      <example>
        <title>Example of the mandol 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/mandol.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>