An overdrive/distortion effect module for the Web Audio API.
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
example
test
.gitignore
History.md
Makefile
Readme.md
component.json
index.js

Readme.md

Overdrive

An overdrive/distortion effect for the Web Audio API.

Installation

$ component install web-audio-components/overdrive

Example Usage

var context = new webkitAudioContext()
  , node = context.createOscillator();
  , Overdrive = require("overdrive")
  , overdrive = new Overdrive(context, {
      preBand: 1.0,
      color: 4000,
      drive: 0.8,
      postCut: 8000
    });

node.connect(overdrive.input);
overdrive.connect(context.destination);
node.start(0);

For another example, see the test directory.

API

Overdrive(context, options)

Instantiate an Overdrive effect module. Expects an AudioContext as the first parameter.

Options

  • preBand Pre-distortion bandpass filter wet gain coefficient.
  • color Pre-distortion bandpass filter frequency.
  • drive Overdrive amount
  • postCut Post-distortion lowpass filter cutoff frequency.

.connect(node)

Connect an Overdrive module to an AudioNode.

.disconnect()

Disconnect all outgoing connections from an Overdrive module.

License

Copyright (c) 2012 Nick Thompson

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.