aural-scala

Aural-Scala

A codec for Scala scale files.

Intent

The Scala scale file format is the de facto standard for the description and the exchange of scales and system of tuning.

This module provides a decoder and an encoder for the format.

Installing and testing

With npm do:

npm install aural-scala

To run the test suite, run the following command:

npm test

Examples

Decoding

// the variable string being a valid scala scale format string

var ScalaScale = require('aural-scala'),
    scale = ScalaScale.parse(string);

Encoding

var ScalaScale = require('aural-scala'),
    scale = new ScalaScale();

scale.description = 'Short description of this custom scale';
scale.intervals.push(
    200,
    400,
    600,
    800,
    1000,
    1200
);

var string = scale.toString(); // returns a valid scala scale format string

Public API

Full API documentation

Changelog

1.0.0 (2015.03.16) :

• The method parse is now static.
• The constructor doesn't accept a string to parse as argument anymore.
• Declare stable (freeze the public API).

Full history

Roadmap

• TBD

License

MIT