summaryrefslogtreecommitdiff
path: root/opcodes/lposcila.xml
blob: 4cfaa469f192d6d9c0ea534159976871b928698b (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
<refentry id="lposcila">
<indexterm id="IndexLposcila"><primary>lposcila</primary></indexterm>
  <refentryinfo><title>Signal Generators:Sample Playback</title></refentryinfo>
  <refmeta>
    <refentrytitle>lposcila</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>lposcila</refname>
    <refpurpose>
      Read sampled sound from a table with looping and high precision.
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
      <emphasis>lposcila</emphasis> reads sampled sound from a table with looping and high precision.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis>ar <command>lposcila</command> aamp, kfreqratio, kloop, kend, ift [,iphs] </synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>ift</emphasis> -- function table number
    </para>
    <para>
      <emphasis>iphs</emphasis> -- initial phase (in samples)
    </para>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>ar</emphasis> -- output signal
    </para>
    <para>
      <emphasis>aamp</emphasis> -- amplitude
    </para>
<!--    <para>
      <emphasis>kcps</emphasis> - frequency
    </para>-->
    <para>
      <emphasis>kfreqratio</emphasis> -- multiply factor of table frequency (for example: 1 = original frequency, 1.5 = a fifth up , .5 = an octave down)
    </para>
    <para>
      <emphasis>kloop</emphasis> -- start loop point (in samples)
    </para>
    <para>
      <emphasis>kend</emphasis> -- end loop point (in samples)
    </para>
    <para>
      <emphasis>lposcila</emphasis> is the same as <link linkend="lposcil"><citetitle>lposcil</citetitle></link>, but has an audio-rate amplitude argument (instead of k-rate) to allow fast envelope transients.
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the lposcila opcode. It uses the file <ulink url="examples/lposcila.csd"><citetitle>lposcila.csd</citetitle></ulink>.
      <example>
        <title>Example of the lposcila 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/lposcila.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>
  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="lposcil"><citetitle>lposcil</citetitle></link>,
      <link linkend="lposcilsa"><citetitle>lposcilsa</citetitle></link>,
      <link linkend="lposcilsa2"><citetitle>lposcilsa2</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>Author: &namegabriel;</para>
    <para>New in version 5.06</para>
  </refsect1>
</refentry>