MUSIQ.js - a javascript library for music analysis
JavaScript CSS HTML Shell
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs Updated all code from the musiqlab git repository Mar 27, 2013
jsdoc-template
src small updates to make it work with newer version of node-static Oct 9, 2015
test
.gitignore small updates to make it work with newer version of node-static Oct 9, 2015
LICENSE.md
README.md Updated all code from the musiqlab git repository Mar 27, 2013
doc
min.js
minify Added minify functionality Mar 27, 2013
musiqjs.min.js Added minify functionality Mar 27, 2013
package.json
server.js

README.md

MUSIQ.js

A music analysis library for javascript

This open-source MIT-licensed library is your swiss knife of musical analysis. It allows you to descibe notes, intervals, chords, scales and other concepts used in musical theory.

It gives you all sorts of ways to work with these concepts, like looking up chords from notes, finding scales belonging to a certain chord, viewing the relationship between notes and more.

The Library

Still working on putting it in namespaces, writing tests and making it ready for production.

Getting Started

Take a look at the MUSIQ.js primer.

Testing

There is a QUnit test suite included in this release. Start the simple static file server as so:

node ./server.js

And then navigate to the URL:

http://musiqjs-server/test/qunit.html

You can add new tests as well.

API documentation

Musiq.js uses jsdoc to create it's API documentation with a custom template that lives in ./jsdoc-template/. You can build the documentation again by running the following command (provided you have jsdoc npm module installed):

./node_modules/jsdoc/jsdoc -r src/ -d docs/ -t jsdoc-template

Or simply run the provided shell script:

./doc

Instruments supported

So far the only instrument that is supported is the guitar. There are plans to support at least the piano as well. Empty files for this can be found in the src/piano/ folder.