summaryrefslogtreecommitdiff
path: root/opcodes/maxabsaccum.xml
blob: 79e589683b7620bb38292472a310067c791c8ba2 (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="maxabsaccum">
<indexterm id="IndexMaxabsaccum"><primary>maxabsaccum</primary></indexterm>
  <refentryinfo><title>Signal Modifiers:Comparators and Accumulators</title></refentryinfo>
  <refmeta>
    <refentrytitle>maxabsaccum</refentrytitle>
  </refmeta>


 
  <refnamediv>
    <refname>maxabsaccum</refname>
    <refpurpose>
      Accumulates the maximum of the absolute values of audio signals.
          </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      <emphasis>maxabsaccum</emphasis> compares two audio-rate variables and stores the maximum of their absolute values into the first.  
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis><command>maxabsaccum</command> aAccumulator, aInput</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>aAccumulator</emphasis> -- audio variable to store the maximum value
    </para>

    <para>
      <emphasis>aInput</emphasis> -- signal that aAccumulator is compared to
    </para>

    <para>
      The <emphasis>maxabsaccum</emphasis> opcode is designed to accumulate the maximum value from among many audio signals that may be in different note instances, different channels, or otherwise cannot all be compared at once using the <emphasis>maxabs</emphasis> opcode.  <emphasis>maxabsaccum</emphasis> is identical to <emphasis>maxaccum</emphasis> except that it takes the absolute value of aInput before the comparison.  Its semantics are similar to <emphasis>vincr</emphasis> since <emphasis>aAccumulator</emphasis> is used as both an input and an output variable, except that <emphasis>maxabsaccum</emphasis> keeps the maximum absolute value instead of adding the signals together.  <emphasis>maxabsaccum</emphasis> performs the following operation on each pair of samples:
    </para>

    <para>
      <literallayout>
            if  (abs(aInput) > aAccumulator)  aAccumulator = abs(aInput)
      </literallayout>
    </para>

    <para>
      <emphasis>aAccumulator</emphasis> will usually be a global audio variable.  At the end of any given computation cycle (k-period), after its value is read and used in some way, the accumulator variable should usually be reset to zero  (perhaps by using the <emphasis>clear</emphasis> opcode).  Clearing to zero is sufficient for <emphasis>maxabsaccum</emphasis>, unlike the <emphasis>maxaccum</emphasis> opcode.
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="minabsaccum"><citetitle>minabsaccum</citetitle></link>, 
      <link linkend="maxaccum"><citetitle>maxaccum</citetitle></link>, 
      <link linkend="minaccum"><citetitle>minaccum</citetitle></link>, 
      <link linkend="max"><citetitle>max</citetitle></link>, 
      <link linkend="min"><citetitle>min</citetitle></link>, 
      <link linkend="maxabs"><citetitle>maxabs</citetitle></link>, 
      <link linkend="minabs"><citetitle>minabs</citetitle></link>, 
      <link linkend="vincr"><citetitle>vincr</citetitle></link>,
      <link linkend="clear"><citetitle>clear</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &nameanthony;</member>
        <member>March 2006</member>
      </simplelist>
    </para>

    <para>New in Csound version 5.01</para>
  </refsect1>
</refentry>