UNPKG

react-orchestra

Version:

A toolbox to build interactive and smart instruments on the web and mobile.

107 lines (86 loc) 4.39 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Source: helpers/getScalesFromNoteNames.js</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Source: helpers/getScalesFromNoteNames.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>/* mod */ import SCALES from '../constants/SCALES'; import getUniqueNoteNamesNoOctave from './getUniqueNoteNamesNoOctave'; import getIntervalPermutationsFromNoteNames from './getIntervalPermutationsFromNoteNames'; /** * getScalesFromNoteNames - Get all scales matched with the given notes * * @param {array} noteNames noteNames with octave * @returns {array} Array of note names with octave * [{firstNoteName: string, intervals: number, guessedScales: array}] * @example * getScalesFromNoteNames(['A3', 'B3', 'C3']); * // [ * // { * // firstNoteName: 'A', * // intervals: [0, 9, 10], * // guessedScales: ['dorian', 'mixolydian', 'acoustic', 'algerian', 'majorBlues'] * // }, * // { * // firstNoteName: 'B', * // intervals: [0, 2, 11], * // guessedScales: ['ionian', 'lydian', 'harmonicMinor', 'melodicMinorAsc'] * // }, * // { * // firstNoteName: 'C', * // intervals: [0, 1, 3], * // guessedScales: ['phrygian', 'locrian', 'altered'] * // }, * // ] */ const getScalesFromNoteNames = (noteNames) => { const uniqueNoteNames = getUniqueNoteNamesNoOctave(noteNames); const sequencePermutations = getIntervalPermutationsFromNoteNames(uniqueNoteNames); Object.keys(SCALES).forEach((scaleName) => { const scaleSequence = SCALES[scaleName].sequence; if (scaleName === 'chromatic') { return; } sequencePermutations.forEach((sequencePermutation, i) => { const isInScaleSequence = sequencePermutation.intervals.reduce((prev, current) => { if (prev === false) { return false; } return scaleSequence.indexOf(current) !== -1; }, true); if (isInScaleSequence) { sequencePermutations[i].guessedScales.push(scaleName); } }); }); return sequencePermutations; }; export default getScalesFromNoteNames; </code></pre> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Instrument.html">Instrument</a></li><li><a href="Note.html">Note</a></li></ul><h3>Global</h3><ul><li><a href="global.html#addOctaveToNoteName">addOctaveToNoteName</a></li><li><a href="global.html#getInterval">getInterval</a></li><li><a href="global.html#getIntervalPermutationsFromNoteNames">getIntervalPermutationsFromNoteNames</a></li><li><a href="global.html#getJSONFromMidiURL">getJSONFromMidiURL</a></li><li><a href="global.html#getNoteNamesFromChordName">getNoteNamesFromChordName</a></li><li><a href="global.html#getNoteNamesFromIntervals">getNoteNamesFromIntervals</a></li><li><a href="global.html#getScaleNotes">getScaleNotes</a></li><li><a href="global.html#getScalesFromNoteNames">getScalesFromNoteNames</a></li><li><a href="global.html#getTracksAndMetaFromParsedMidi">getTracksAndMetaFromParsedMidi</a></li><li><a href="global.html#getTracksAndMetaFromUrl">getTracksAndMetaFromUrl</a></li><li><a href="global.html#getUniqueNoteNames">getUniqueNoteNames</a></li><li><a href="global.html#getUniqueNoteNamesNoOctave">getUniqueNoteNamesNoOctave</a></li><li><a href="global.html#isInHigherOctave">isInHigherOctave</a></li><li><a href="global.html#removeOctaveFromNoteName">removeOctaveFromNoteName</a></li><li><a href="global.html#reOrderNotes">reOrderNotes</a></li><li><a href="global.html#updateTempo">updateTempo</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sun Nov 20 2016 16:43:09 GMT+0200 (EET) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>