~ubuntu-branches/ubuntu/trusty/csound-manual/trusty-proposed

<refentry id="STKBeeThree">

  <indexterm id="IndexStkbeethree"><primary>STKBeeThree</primary></indexterm>

  <refentryinfo><title>Signal Generators:STK Opcodes</title></refentryinfo>

  <refmeta>

    <refentrytitle>STKBeeThree</refentrytitle>

  </refmeta>

 

  <refnamediv>

    <refname>STKBeeThree</refname>

    <refpurpose>

      STK Hammond-oid organ-like FM synthesis instrument.

      </refpurpose>

  </refnamediv>

 

  <refsect1>

    <title>Description</title>

    <para>

      STK Hammond-oid organ-like FM synthesis instrument.</para>

          <para>

      This opcode a simple 4 operator topology, also referred to as algorithm 8 of the TX81Z.

      It simulates the sound of a Hammond-oid organ, and some related sounds.

    </para>

  </refsect1>

 

  <refsect1>

    <title>Syntax</title>

    <synopsis>asignal <command>STKBeeThree</command> ifrequency, iamplitude, [kc1, kv1[, kc2, kv2[, kc3, kv3[, kc4, kv4[, kc5, kv5]]]]]</synopsis>

  </refsect1>

 

  <refsect1>

    <title>Initialization</title>

        <para>

      <emphasis>ifrequency</emphasis> -- Frequency of note played, in Hertz.

    </para>

   

    <para>

      <emphasis>iamplitude</emphasis> -- Amplitude of note played (range 0-1).

    </para>

  </refsect1>

 

  <refsect1>

    <title>Performance</title>

   

    <para>

      <emphasis>kc1, kv1, kc2, kv2, kc3, kv3, kc4, kv4, kc5, kv5, kc6, kv6, kc7, kv7, kc8, kv8</emphasis> -- Up to 8 optional k-rate controller pairs for the STK opcodes.

      Each controller pair consists of a controller number (kc) followed by a controller value (kv). The 5 controller numbers and values that work for STKBeeThree are:

      <itemizedlist>

        <listitem><para><emphasis>kc, kv</emphasis> -- 2,   gain of feedback of operator 4.</para></listitem>

        <listitem><para><emphasis>kc, kv</emphasis> -- 4,   gain of operator 3 </para></listitem>

        <listitem><para><emphasis>kc, kv</emphasis> -- 11,  speed of low-frequency oscillator.</para></listitem>

        <listitem><para><emphasis>kc, kv</emphasis> -- 1,   depth of low-frequency oscillator.</para></listitem>

        <listitem><para><emphasis>kc, kv</emphasis> -- 128, ADSR 2 and 4 target.</para></listitem>

      </itemizedlist>

    </para>

  </refsect1>

 

    <refsect1>

    <note>

      <title>Note</title>

      <para>

        The code for this opcode is taken directly from the BeeThree class in the Synthesis Toolkit in C++ by Perry R. Cook and Gary P. Scavone. More on the STK classes can be found here:  

<ulink url="https://ccrma.stanford.edu/software/stk/classes.html"><citetitle>https://ccrma.stanford.edu/software/stk/classes.html</citetitle></ulink>

</para>

    </note>

  </refsect1>

  

  <refsect1>

    <title>Examples</title>

    <para>

      Here is an example of the STKBeeThree opcode. It uses the file <ulink url="examples/STKBeeThree.csd"><citetitle>STKBeeThree.csd</citetitle></ulink>, and <ulink url="examples/fwavblnk.aiff"><citetitle>fwavblnk.aiff</citetitle></ulink>.

     

      <example>

        <title>Example of the STKBeeThree opcode.</title>

        <xi:include href="examples-xml/STKBeeThree.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

      </example>

    </para>

  </refsect1>

 

  <refsect1>

    <title>Credits</title>

    <para>

      <simplelist>

        <member>Author: &namemichael; (after &nameperry;)</member>

        <member>Irreducible Productions</member>

        <member>New York, NY</member>

      </simplelist>

    </para>

    <para>New in Csound version 5.11</para>

  </refsect1>

</refentry>