summaryrefslogtreecommitdiff
path: root/opcodes/cosseg.xml
blob: 46797849fe2eabbc1906f04ba25509d7e05e363e (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
<refentry id="cosseg">
<indexterm id="IndexCosseg"><primary>cosseg</primary></indexterm>
  <refentryinfo><title>Signal Generators:Linear and Exponential Generators</title></refentryinfo>
  <refmeta>
    <refentrytitle>cosseg</refentrytitle>
  </refmeta>


 
  <refnamediv>
    <refname>cosseg</refname>
    <refpurpose>
      Trace a series of line segments between specified points with
      cosine interpolation.
    </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Trace a series of line segments between specified points with
      cosine interpolation.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>ares <command>cosseg</command> ia, idur1, ib [, idur2] [, ic] [...]</synopsis>

    <synopsis>kres <command>cosseg</command> ia, idur1, ib [, idur2] [, ic] [...]</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>ia</emphasis> -- starting value.
    </para>

    <para>
      <emphasis>ib, ic</emphasis>, etc. -- value after
      <emphasis>dur1</emphasis> seconds, etc. 
    </para>

    <para>
      <emphasis>idur1</emphasis> -- duration in seconds of first
      segment. A zero or negative value will cause all initialization
      to be skipped. 
    </para>

    <para>
      <emphasis>idur2, idur3</emphasis>, etc. -- duration in seconds
      of subsequent segments. A zero or negative value will terminate
      the initialization process with the preceding point, permitting
      the last-defined line or curve to be continued indefinitely in
      performance. The default is zero. 
    </para>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      These units generate control or audio signals whose values can
      pass through 2 or more specified points. The sum of
      <emphasis>dur</emphasis> values may or may not equal the
      instrument's performance time: a shorter performance will
      truncate the specified pattern, while a longer one will cause
      the last value to be repeated until the end of the note. 
    </para>
  </refsect1>
 
  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the cosseg opcode. It uses the file <ulink url="examples/cosseg.csd"><citetitle>cosseg.csd</citetitle></ulink>.

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

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="expon"><citetitle>expon</citetitle></link>,
      <link linkend="expseg"><citetitle>expseg</citetitle></link>,
      <link linkend="expsegb"><citetitle>expsegb</citetitle></link>,
      <link linkend="expsegr"><citetitle>expsegr</citetitle></link>,
      <link linkend="line"><citetitle>line</citetitle></link>,
      <link linkend="linseg"><citetitle>linseg</citetitle></link>,
      <link linkend="linsegr"><citetitle>linsegr</citetitle></link>
      <link linkend="transeg"><citetitle>transeg</citetitle></link>
      <link linkend="transegb"><citetitle>transegb</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>
       <simplelist>
         <member>Author: &namejohn;</member>
        <member>Aug 2012 </member>
       </simplelist>
    </para>
    <para> New in version 5.18</para>
  </refsect1>
</refentry>