summaryrefslogtreecommitdiff
path: root/opcodes/fmbell.xml
blob: 4ea2b7936020b9452f6a3982c05394668542afac (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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
<refentry id="fmbell">
<indexterm id="IndexFmbell"><primary>fmbell</primary></indexterm>
  <refentryinfo><title>Signal Generators:FM Synthesis</title></refentryinfo>
  <refmeta>
    <refentrytitle>fmbell</refentrytitle>
  </refmeta>


 
  <refnamediv>
    <refname>fmbell</refname>
    <refpurpose>
      Uses FM synthesis to create a tublar bell sound.
          </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Uses FM synthesis to create a tublar bell sound. It comes from a family of FM sounds, all using 4 basic oscillators and various architectures, as used in the TX81Z synthesizer.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>ares <command>fmbell</command> kamp, kfreq, kc1, kc2, kvdepth, kvrate[, ifn1, ifn2, ifn3, \
      ifn4, ivfn, isus]</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Initialization</title>
    <para>
      All these opcodes take 5 tables for initialization. The first 4
      are the basic inputs and the last is the low frequency
      oscillator (LFO) used for vibrato. These all default to a
      siewave table.
    </para>

    <para>
      The initial waves should be:
      <itemizedlist>
        <listitem><para><emphasis>ifn1</emphasis> -- sine wave</para></listitem>
        <listitem><para><emphasis>ifn2</emphasis> -- sine wave</para></listitem>
        <listitem><para><emphasis>ifn3</emphasis> -- sine wave</para></listitem>
        <listitem><para><emphasis>ifn4</emphasis> -- sine wave</para></listitem>
      </itemizedlist>
    </para>

    <para>
      The optional argument <emphasis>isus</emphasis> controls how long the
      sound lasts, or how quickly it decays.  It defaults to 4.
    </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>kc1, kc2</emphasis> -- Controls for the synthesizer:
      <itemizedlist>
        <listitem><para><emphasis>kc1</emphasis> -- Mod index 1</para></listitem>
        <listitem><para><emphasis>kc2</emphasis> -- Crossfade of two outputs</para></listitem>
        <listitem><para><emphasis>Algorithm</emphasis> -- 5</para></listitem>
      </itemizedlist>
    </para>

    <para>
      <emphasis>kvdepth</emphasis> -- Vibrator depth
    </para>

    <para>
      <emphasis>kvrate</emphasis> -- Vibrator rate
    </para>
  </refsect1>

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

      <example>
        <title>Example of the fmbell 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/fmbell.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="fmb3"><citetitle>fmb3</citetitle></link>,
      <link linkend="fmmetal"><citetitle>fmmetal</citetitle></link>,
      <link linkend="fmpercfl"><citetitle>fmpercfl</citetitle></link>,
      <link linkend="fmrhode"><citetitle>fmrhode</citetitle></link>,
      <link linkend="fmwurlie"><citetitle>fmwurlie</citetitle></link>
    </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>
    <para>Optional argument new in 5.16</para>
    <para>More optional argument new in 6.0</para>
  </refsect1>
</refentry>