<!-- Converted to DocBook/SGML by Kevin Conder -->
<refentry id="fmmetal">
  <refmeta>
    <refentrytitle>fmmetal</refentrytitle>
  </refmeta>
 
  <refnamediv>
    <refname>fmmetal</refname>
    <refpurpose>
      Uses FM synthesis to create a <quote>Heavy Metal</quote> sound.
      <indexterm id="IndexFmmetal"><primary>fmmetal</primary></indexterm>
    </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Uses FM synthesis to create a <quote>Heavy Metal</quote> sound. It comes from a family of FM sounds, all using 4 basic oscillators and various architectures, as used in the TX81Z synthesizer.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>ar <command>fmmetal</command> kamp, kfreq, kc1, kc2, kvdepth, kvrate, ifn1, ifn2, ifn3, ifn4, ivfn</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Initialization</title>
    <para>
      All these opcodes take 5 tables for initialization. The first 4 are the basic inputs and the last is the low frequency oscillator (LFO) used for vibrato. The last table should usually be a sine wave.
    </para>

    <para>
      The initial waves should be:
      <itemizedlist>
        <listitem><para><emphasis>ifn1</emphasis> -- sine wave</para></listitem>
        <listitem><para><emphasis>ifn2</emphasis> -- <ulink url="examples/twopeaks.aiff"><citetitle>twopeaks.aiff</citetitle></ulink></para></listitem>
        <listitem><para><emphasis>ifn3</emphasis> -- <ulink url="examples/twopeaks.aiff"><citetitle>twopeaks.aiff</citetitle></ulink></para></listitem>
        <listitem><para><emphasis>ifn4</emphasis> -- sine wave</para></listitem>
      </itemizedlist>
    </para>

    <note>
      <title>Note</title>
      <para>
        The file <quote>twopeaks.aiff</quote> is also available at <ulink url="ftp://ftp.cs.bath.ac.uk/pub/dream/documentation/sounds/modelling/"><citetitle>ftp://ftp.cs.bath.ac.uk/pub/dream/documentation/sounds/modelling/</citetitle></ulink>.
      </para>
    </note>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>kamp</emphasis> -- Amplitude of note.
    </para>

    <para>
      <emphasis>kfreq</emphasis> -- Frequency of note played.
    </para>

    <para>
      <emphasis>kc1, kc2</emphasis> -- Controls for the synthesizer:
      <itemizedlist>
        <listitem><para><emphasis>kc1</emphasis> -- Total mod index</para></listitem>
        <listitem><para><emphasis>kc2</emphasis> -- Crossfade of two modulators</para></listitem>
        <listitem><para><emphasis>Algorithm</emphasis> -- 3</para></listitem>
      </itemizedlist>
    </para>

    <para>
      <emphasis>kvdepth</emphasis> -- Vibrator depth
    </para>

    <para>
      <emphasis>kvrate</emphasis> -- Vibrator rate
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the fmmetal opcode. It uses the files <ulink url="examples/fmmetal.orc"><citetitle>fmmetal.orc</citetitle></ulink>, <ulink url="examples/fmmetal.sco"><citetitle>fmmetal.sco</citetitle></ulink>, and <ulink url="examples/twopeaks.aiff"><citetitle>twopeaks.aiff</citetitle></ulink>.

      <example>
        <title>Example of the fmmetal opcode.</title>

        <programlisting>
<inlinemediaobject>
            <imageobject>
              <imagedata fileref="examples/fmmetal.orc" format="linespecific">
            </imageobject>
          </inlinemediaobject>
        </programlisting>

        <programlisting>
<inlinemediaobject>
            <imageobject>
              <imagedata fileref="examples/fmmetal.sco" format="linespecific">
            </imageobject>
          </inlinemediaobject>
        </programlisting>
      </example>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="fmb3"><citetitle>fmb3</citetitle></link>,
      <link linkend="fmbell"><citetitle>fmbell</citetitle></link>,
      <link linkend="fmpercfl"><citetitle>fmpercfl</citetitle></link>,
      <link linkend="fmrhode"><citetitle>fmrhode</citetitle></link>,
      <link linkend="fmwurlie"><citetitle>fmwurlie</citetitle></link>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namejohn; (after &nameperry;)</member>
        <member>University of Bath, Codemist Ltd.</member>
        <member>Bath, UK</member>
      </simplelist>
    </para>
    <para>Example written by &namekevin;.</para>

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