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



  <refnamediv>
    <refname>lpsholdp</refname>
    <refpurpose>
      Control signals based on held segments.
    </refpurpose>
  </refnamediv>
  
  <refsect1>
    <title>Description</title>
    <para>
    Generate control signal consisiting of held segments delimited
    by two or more specified points. The entire envelope can be looped
    at time-variant rate. Each segment coordinate can also be varied
    at k-rate. 
    </para>
  </refsect1>
  <refsect1>
    <title>Syntax</title>
    <synopsis>ksig <command>lpsholdp</command>  kphase, kvalue0, ktime0  [, kvalue1] [, ktime1] \
      [, kvalue2] [, ktime2] [...]</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>ksig</emphasis> - output signal
    </para>
    <para>
      <emphasis>kphase</emphasis> -- point of the sequence read, expressed as a fraction of a cycle (0 to 1) 
    </para>
    <para>
      <emphasis>kvalue0...kvalueN</emphasis> -- Values of points
    </para>
    <para>
      <emphasis>ktime0...ktimeN</emphasis> -- Times between points; expressed in fractions of a cycle (see below). The final time designates a ramp between the final value and the first value. 
    </para>
    <para>
    <emphasis>lpsholdp</emphasis> opcode is similar to
    <link linkend="lpshold"><citetitle>lpshold</citetitle></link>; the only difference is that, instead
    of frequency,  a time-variant phase is required. If you use a
    phasor to get the phase value, you will have a behaviour identical
    to <emphasis>lpshold</emphasis>, but interesting results can be achieved
    when using phases having non-linear motions, making <emphasis>lpsholdp</emphasis> more
    powerful and general than <emphasis>lpshold</emphasis>.
    </para>

  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>Written by &namegabriel;.</para>
    <para>New in Csound 5 (Previously available only on CsoundAV)</para>
  </refsect1>
</refentry>