<!-- Converted to DocBook/SGML by Kevin Conder -->
<refentry id="rms">
  <refmeta>
    <refentrytitle>rms</refentrytitle>
  </refmeta>
 
  <refnamediv>
    <refname>rms</refname>
    <refpurpose>
      Determines the root-mean-square amplitude of an audio signal.
      <indexterm id="IndexRms"><primary>rms</primary></indexterm>
    </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Determines the root-mean-square amplitude of an audio signal.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>kr <command>rms</command> asig [, ihp] [, iskip]</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>ihp</emphasis> (optional, default=10) -- half-power point (in Hz) of a special internal low-pass filter. The default value is 10.
    </para>

    <para>
      <emphasis>iskip</emphasis> (optional, default=0) -- initial disposition of internal data space (see <link linkend="reson"><citetitle>reson</citetitle></link>). The default value is 0.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>asig</emphasis> -- input audio signal
    </para>

    <para>
      <emphasis>rms</emphasis> output values <emphasis>kr</emphasis> will trace the root-mean-square value of the audio input <emphasis>asig</emphasis>. This unit is not a signal modifier, but functions rather as a signal power-gauge.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Examples</title>
    <para>
      <informalexample>
        <programlisting>
asrc <emphasis>buzz</emphasis>    10000,440, sr/440, 1 ; band-limited pulse train
a1   <emphasis>reson</emphasis>   asrc, 1000,100       ; sent through
a2   <emphasis>reson</emphasis>   a1,3000,500          ; 2 filters
afin <emphasis>balance</emphasis> a2, asrc             ; then balanced with source
        </programlisting>
      </informalexample>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="balance"><citetitle>balance</citetitle></link>,
      <link linkend="gain"><citetitle>gain</citetitle></link>
    </para>
  </refsect1>
</refentry>
