README

frequency-sweep

Sweep tone generator to create chirps with multiple stages.

Install

npm install frequency-sweep

Example

const frequencySweep = require('frequency-sweep');

// Define a sweep sequence.
// This sequence have 2 steps, each using a different waveform.
const sequence = [
  {
    start: 1, // start in 1 Hz
    end: 100, // end in 100 Hz
    time: 1, // goes from 1 Hz to 100 Hz in 1 second
    wave: "sine" // use a sine wave
  },
  {
    start: 100, // start in 100 Hz
    end: 1400, // end in 1.4 kHz
    time: 5.2, // goes from 100 Hz to 1.4 kHz in 5.2 seconds
    wave: "sawtooth" // use a sawtooth wave
  }
];

// Get the samples of the 2-step sweep sequence in 44.1kHz.
// The samples are 64-bit, in the -1 to 1 range.
let samples = frequencySweep.sweep(sequence, 44100);

By default the samples are returned in a Array. To return the samples as a Float64Array, set the optional outputTyped param to true:

// will return a Float64Array
let samples = frequencySweep.sweep(sequence, 44100, true);

Available waveforms:

'sine'
'triangle'
'square'
'sawtooth'

'noise' is also available.

In the browser:

<script src="https://unpkg.com/frequency-sweep"></script>
<script>
var samples = frequencySweep.sweep(sequence, 44100);
</script>

API

/**
 * Return the samples of a frequency sweep. The sweep may be divided
 * in segments, each using a different waveform (or noise), and each with
 * a start and end frequency.
 * @param {!Array<Object<string, string|number>>} sequence The sequence.
 *   Each item in the array must have the properties:
 *     start: Integer value, the start frequency of the segment.
 *     end: Integer value, the end frequency of the segment.
 *     time: Float value, the duration of the segment. 1 = 1 second.
 *     wave: String, "sine", "square", "triangle", "sawtooth" or "noise".
 * @param {number} sampleRate The sample rate.
 * @param {?boolean} outputTyped True to return Float64Array, false for Array.
 * @return {!Array<number>|!Float64Array}
 */
function sweep(sequence, sampleRate, outputTyped=false) {}

LICENSE

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.

Usage no npm install needed!