summaryrefslogtreecommitdiff
path: root/opcodes/pvsgain.xml
blob: e04ad7d1b42e3f5f5404d1ff7cacd4190d820ce0 (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
<refentry id="pvsgain">
<indexterm id="IndexPvsgain"><primary>pvsgain</primary></indexterm>
  <refentryinfo><title>Spectral Processing:Streaming</title></refentryinfo>
  <refmeta>
    <refentrytitle>pvsgain</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>pvsgain</refname>
    <refpurpose>
      Scale the amplitude of a pv stream.
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
      Scale the amplitude of a pv stream.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis>fsig <command>pvsgain</command> fsigin, kgain </synopsis>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>fsig</emphasis> -- output pv stream
    </para>

    <para>
      <emphasis>fsigin</emphasis> -- input pv stream
    </para>

    <para>
      <emphasis>kgain</emphasis> -- amplitude scaling (defaults to 1).
    </para>
    <warning>
      <para>
        It is unsafe to use the same f-variable for both input and output of pvs opcodes. Using the same one might lead to undefined behavior on some opcodes. Use a different one on the left and right sides of the opcode.
      </para>
   </warning>
  </refsect1>
  
  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the use of the <emphasis>pvsgain</emphasis> opcode. It uses the file <ulink url="examples/pvsgain.csd"><citetitle>pvsgain.csd</citetitle></ulink>.
      <example>
        <title>Example of the <emphasis>pvsgain</emphasis> 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/pvsgain.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="pvsanal"><citetitle>pvsanal</citetitle></link>,
      <link linkend="pvsynth"><citetitle>pvsynth</citetitle></link>,
      <link linkend="pvsadsyn"><citetitle>pvsadsyn</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namevictor;</member>
        <member>2011 </member>
      </simplelist>
    </para>

    <para>New plugin in version 5</para>
    <para>2011</para>
  </refsect1>
</refentry>