ZZZ
###

| |SuperCollider| classes to interface with |expert_sleepers| devices.

Supported devices
-----------------

* |es-3|

Features
--------

* convenience methods to convert between midi, frequency, amplitude and
  corresponding output voltage
* **ZZZConstant**: a *SynthDef* for constant pitch (use helper functions to
  convert your input to amplitude - the *\mul* parameter)
* **ZZZClock**: a *SynthDef* for clock signals. Responds to Frequencies

Installation
------------

The classes are an extension of the |supercollider| language, therefore their
installation corresponds to |quark_installation|.

Usage
-----

ES-3
____

To create a new object interfacing your |es-3|, instantiate the *ZZZES3* class
with an Array holding your eight ADAT output channels:

  .. code:: supercollider

    // RME Babyface example
    ~es3 = ZZZES3(Array.series(8, 4, 1));

  .. note::

    | The instantiation of *ZZZES3* conveniently makes the outputs of the
      |es-3| available in a numbering range from 1-8 (as displayed on the
      hardware).
    | Generally, in |supercollider| channel numbering starts with 0, though!

To interface with your module on one of the eight |es-3| outputs, you can use
one of the *SynthDefs* added by the *ZZZ* class, such as *\ZZZConstant* (for
constant pitch) or *\ZZZClock* (for clock):

  .. code:: supercollider

    // start Synth \ZZZClock at ES-3 output 8 with a speed of 240bpm (defaults
    // to 120bpm)
    ~es3.addClock(8, (240/60));

  .. code:: supercollider

    // start Synth '\ZZZConstant' at ES-3 output 7 with a multiplication factor
    // corresponding to the note C5
    ~es3.addVCO(7, ZZZ.cpsamp(523.251));


Just like with any other *Synth* instance, you can now change their settings:

  .. code:: supercollider

    // change clock speed at output 8 to 300bpm
    ~es3.setClock(8, (300/60));

  .. code:: supercollider

    // change constant pitch on output 7 to A4
    ~es3.setVCO(7, ZZZ.midiamp(69));


Background
----------
| Modular synthesizers are controllable through several ranges of voltage.
| However, |cv_gate| as defined by |doepfer| in the |a100_manual| might not be coherently
  used throughout all Eurorack modules.
|
| The *ZZZ* classes nonetheless try to adhere to the standard, while at the
  same time providing convenience functions to low-level conversion.
| By default the helper functions are able to convert frequencies in the
  |c_musical_note| (between *C-2* and *C10*) to an output between -5V and 7V
  (adhering to the 1V/octave scheme) - the MIDI note range being a subset of it.
| As the range is not fixed, but can be moved up and down (e.g. when using
  filters or oscillators), you might have to make some adjustments to your
  module, to get "in tune".

.. |supercollider| raw:: html

  <a href="https://supercollider.github.io/" target="_blank">SuperCollider</a>

.. |expert_sleepers| raw:: html

  <a href="http://www.expert-sleepers.co.uk/" target="_blank">Expert Sleepers</a>

.. |es-3| raw:: html

  <a href="http://www.expert-sleepers.co.uk/es3.html" target="_blank">ES-3</a>

.. |quark_installation| raw:: html

  <a href="https://github.com/supercollider-quarks/quarks#installing-a-quark" target="_blank">the way quarks are installed</a>

.. |cv_gate| raw:: html

  <a href="https://en.wikipedia.org/wiki/CV/gate" target="_blank">CV/Gate</a>

.. |doepfer| raw:: html

  <a href="http://www.doepfer.de" target="_blank">Doepfer</a>

.. |a100_manual| raw:: html

  <a href="http://www.doepfer.de/a100_man/a100t_e.htm" target="_blank">A100 manual</a>

.. |c_musical_note| raw:: html

  <a href="https://en.wikipedia.org/wiki/C_(musical_note)" target="_blank">range of 12 octaves</a>