summaryrefslogtreecommitdiff
path: root/opcodes/poscil3.xml
blob: d784693c9d11cd690652ea7dbaa388c0dcfbb4be (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
<refentry id="poscil3">
<indexterm id="Indexposcil3"><primary>poscil3</primary></indexterm>
  <refentryinfo><title>Signal Generators:Basic Oscillators</title></refentryinfo>
  <refmeta>
    <refentrytitle>poscil3</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>poscil3</refname>
    <refpurpose>
      High precision oscillator with cubic interpolation.
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
      High precision oscillator with cubic interpolation.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis>ares <command>poscil3</command> kamp, kcps, ifn [, iphs]</synopsis>

    <synopsis>kres <command>poscil3</command> kamp, kcps, ifn [, iphs]</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>ifn</emphasis> -- function table number
    </para>
    <para>
      <emphasis>iphs</emphasis> (optional, default=0) -- initial phase (normalized table index 0-1)
    </para>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>ares</emphasis> -- output signal
    </para>
    <para>
      <emphasis>kamp</emphasis> -- the amplitude of the output signal.
    </para>
    <para>
      <emphasis>kcps</emphasis> -- the frequency of the output signal in cycles per second.
    </para>
    <para>
      <emphasis>poscil3</emphasis> works like <link linkend="poscil"><citetitle>poscil</citetitle></link>, but uses cubic interpolation.
    </para>
    <para>Note that <emphasis>poscil3</emphasis> can use deffered (non-power of two) length tables.</para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the poscil3 opcode. It uses the file <ulink url="examples/poscil3.csd"><citetitle>poscil3.csd</citetitle></ulink>.
      <example>
        <title>Example of the poscil3 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/poscil3.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
    <para>
      Here is another example of the poscil3 opcode, which uses a table filled from a sound file. It uses the file <ulink url="examples/poscil3-file.csd"><citetitle>poscil3-file.csd</citetitle></ulink>.
      <example>
        <title>Another example of the poscil3 opcode.</title>
        <xi:include href="examples-xml/poscil3-file.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="poscil"><citetitle>poscil</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Authors: &namejohn;, &namegabriel;</member>
        <member>Italy</member>
      </simplelist>
    </para>
    <para>Example written by &namekevin;.</para>

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