electrophone v1.0.0

ElectroPhone

JavaScript Library to build a modular synthesizer.

Based on WebAudio API and WebAudio Effects Libray tuna

Demo Application

https://civa86.github.io/electrophone

HTML5 Application to demonstrate the use of electrophone library.

Frameworks and Libraries:

Development Tools:

Library Code Documentation

Documentation Page

Code Documentation of the ElectroPhone class provided by the Library.

For a full development documentation:

• Download / Clone the Repository
• Enter in the electrophone project folder
• Run lib::docs npm script
• Run docs/index.html in a browser

Usage

Install npm module

npm install electrophone

Include Library

With ES5 via <script> tag:

<script src="<path_to_node_modules>/electrophone/dist/electrophone.min.js"/>

With ES2015 via Babel:

import ElectroPhone from 'electrophone'

Create an instance

// Get the browser AudioContext
var AudioCtx = window.AudioContext || window.webkitAudioContext;

// CREATE A ElectroPhone INSTANCE
var synth = new ElectroPhone(new AudioCtx(), {
        //Optional parameters
        spectrum: <true|false>,            // set true to manage data of playing sound
        updateSpectrum: <dataArray => {}>, // on receive data callback
        resetSpectrum: <() => {}>          // on stop data callback
    });

Create Modules

synth.create("moduleLabel", "moduleType", { ...properties });

Update Modules

synth.update("moduleLabel", { ...properties });

Destroy Modules

synth.destroy("moduleLabel");

Link modules

synth.link("sourceModuleLabel", "destinationModuleLabel");

Update Prebuilt Modules

// Master module
synth.master({ ...properties });

// ADSR module
synth.adsr({ ...properties });

Play and Stop sound

// Play a frequency (20 - 20000)
synth.play(440);

// Stop a frequency (20 - 20000)
synth.stop(440);

Get All Created Modules

synth.getModules();

Static Methods

// Get module properties by type.
ElectroPhone.getModuleProperties("moduleType");

// Describe all ElectroPhone modules with properties configuration.
ElectroPhone.describeModules("moduleType");

// Get frequency float value calculated from given note and octave.
ElectroPhone.getFrequency("A", 4);

// Get complete notes list.
ElectroPhone.getNotes();

Constants

The library expose two set of constants: CONST and TYPES

CONST

The set of string values to setup module properties.

TYPES

The set of string values to create modules.

Full Example: Two Voices Synth

// Load library
import ElectroPhone from 'electrophone';

// Build the synth instance (See Usage Section)
const AudioCtx = window.AudioContext || window.webkitAudioContext;
const synth = new ElectroPhone(new AudioCtx());

// Create the first voice
synth.create(
    'Voice1',
    ElectroPhone.TYPES.OSCILLATOR,
    {
        wave: ElectroPhone.CONST.WAVE_SAWTOOTH,
        detune: 500,
        level: 50
    }
);

// Create the second voice
synth.create(
    'Voice2',
    ElectroPhone.TYPES.OSCILLATOR,
    {
        wave: ElectroPhone.CONST.WAVE_SAWTOOTH,
        detune: -500,
        level: 50
    }
);

//Link voices to Master
synth.link('Voice1', ElectroPhone.CONST.MASTER);
synth.link('Voice2', ElectroPhone.CONST.MASTER);

// Setup ADSR
synth.adsr({ attack: 0, decay: 1, sustain: 50, release: 25 });

// Set Master Volume to 80%
synth.master({ level: 80 });

// Get the A4 note frequency
const a4 = ElectroPhone.getFrequency("A", 4);

// Play the a4 note
synth.play(a4);

// Stop the a4 note after 1 second
setTimeout(() => synth.stop(a4), 1000);

Prebuilt Modules

Every ElectroPhone instance has 2 hardcoded modules: Master and ADSR.

This is the minimal configuration to let sound coming out from your sound card and control its behaviour during time.

Master

Main Output Gain.

ADSR

Envelope on the master gain. Describes final sound behavior during time.

Sound Modules

Sound Modules can generate sounds and play frequencies.

They can be linked to any Effect Module or directly to Master

Oscillator

Sound Wave Generator.

Noise

Noise Generator.

Control Modules

Control Modules can change the behavior of a specific module property or modify the final sound.

Modulator

An Oscillator that produces modulation on another module property.

It can be linked to any module with freq or detune property.

Envelope

A module that can describe property changes during time.

It can be linked to any module with level property (gain target).

Pan

A module that routes sound between left and right channel.

It can be placed between a Sound Module and its destination to setup stereo routing.

Effect Modules

Effect Modules can change the nature of a sound.

They can be linked to other Effect Modules to create an effect chain and finally to Master.

Filter

A module that filters frequencies with different algorithms.

Delay

A module that plays a sound back after a period of time.

PingPongDelay

A different kind of Delay.

Tremolo

A trembling sound effect.

Overdrive

A module that alters the sound increasing its gain with distortion.

Bitcrusher

A module that produces a distortion by the reduction of the resolution or bandwidth of digital audio data.

Moogfilter

A Moog inspired filter