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


 
  <refnamediv>
    <refname>barmodel</refname>
    <refpurpose>
      Creates a tone similar to a struck metal bar.
    </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Audio output is a tone similar to a struck metal bar, using a
    physical model developed from solving the partial differential
    equation.  There are controls over the boundary conditions as
    well as the bar characteristics.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>ares <command>barmodel</command> kbcL, kbcR, iK, ib, kscan, iT30, ipos, ivel, iwid</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Initialization</title>
    <para>
    <emphasis>iK</emphasis> -- dimensionless stiffness parameter.  If
    this parameter is negative then the initialisation is skipped and
    the previous state of the bar is continued.
    </para>

    <para>
    <emphasis>ib</emphasis> -- high-frequency loss parameter (keep this small).
    </para>

    <para>
    <emphasis>iT30</emphasis> -- 30 db decay time in seconds.
    </para>

    <para>
    <emphasis>ipos</emphasis> -- position along the bar that the strike occurs.
    </para>

    <para>
    <emphasis>ivel</emphasis> -- normalized strike velocity.
    </para>

    <para>
    <emphasis>iwid</emphasis> -- spatial width of strike.
    </para>

  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      A note is played on a metalic bar, with the arguments as below.
    </para>

    <para>
      <emphasis>kbcL</emphasis> -- Boundary condition at left end of
    bar (1 is clamped, 2 pivoting and 3 free).
    </para>

    <para>
      <emphasis>kbcR</emphasis> -- Boundary condition at right end of
    bar (1 is clamped, 2 pivoting and 3 free).
    </para>

    <para>
      <emphasis>kscan</emphasis> -- Speed of scanning the output location.
    </para>

    <para>
      Note that changing the boundary conditions during playing may
  lead to glitches and is made available as an experiment.  The use of
  a non-zero <emphasis>kscan</emphasis> can give apparent re-introduction of sound due to
  modulation.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the barmodel opcode. It uses the file <ulink url="examples/barmodel.csd"><citetitle>barmodel.csd</citetitle></ulink>.

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

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