summaryrefslogtreecommitdiff
path: root/opcodes/jitter.xml
blob: f316e0438bee8af1d2b7dac392fddac1e3889a47 (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
<refentry id="jitter">
<indexterm id="IndexJitter"><primary>jitter</primary></indexterm>
  <refentryinfo><title>Signal Generators:Random (Noise) Generators</title></refentryinfo>
  <refmeta>
    <refentrytitle>jitter</refentrytitle>
  </refmeta>



  <refnamediv>
    <refname>jitter</refname>
    <refpurpose>
      Generates a segmented line whose segments are randomly generated.
          </refpurpose>
  </refnamediv>
  
  <refsect1>
    <title>Description</title>
    <para>
      Generates a segmented line whose segments are randomly generated.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis>kout <command>jitter</command> kamp, kcpsMin, kcpsMax</synopsis>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>kamp</emphasis> -- Amplitude of jitter deviation
    </para>

    <para>
      <emphasis>kcpsMin</emphasis> -- Minimum speed of random frequency variations (expressed in cps)
    </para>

    <para>
      <emphasis>kcpsMax</emphasis> -- Maximum speed of random frequency variations (expressed in cps)
    </para>

    <para>
      <emphasis>jitter</emphasis> generates a segmented line whose segments are randomly generated inside the +kamp and -kamp interval. Duration of each segment is a random value generated according to kcpsmin and kcpsmax values.
    </para>

    <para>
      <emphasis>jitter</emphasis> can be used to make more natural and <quote>analog-sounding</quote> some static, dull sound. For best results, it is suggested to keep its amplitude moderate.
    </para>
  </refsect1>

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

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

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="jitter2"><citetitle>jitter2</citetitle></link>,
      <link linkend="vibr"><citetitle>vibr</citetitle></link>,
      <link linkend="vibrato"><citetitle>vibrato</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>Author: &namegabriel;</para>
    <para>New in Version 4.15</para>
  </refsect1>
</refentry>