music21j-port
Version:
A toolkit for computer-aided musicology, Javascript version
905 lines (729 loc) • 23.3 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Music21j Source: music21/tempo.js</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.spruce.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="navbar-inner">
<a class="brand" href="index.html">Music21j</a>
<ul class="nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="music21.html">music21</a>
</li>
<li>
<a href="music21.articulations.html">music21.articulations</a>
</li>
<li>
<a href="music21.audioSearch.html">music21.audioSearch</a>
</li>
<li>
<a href="music21.base.html">music21.base</a>
</li>
<li>
<a href="music21.beam.html">music21.beam</a>
</li>
<li>
<a href="music21.chord.html">music21.chord</a>
</li>
<li>
<a href="music21.clef.html">music21.clef</a>
</li>
<li>
<a href="music21.common.html">music21.common</a>
</li>
<li>
<a href="music21.duration.html">music21.duration</a>
</li>
<li>
<a href="music21.dynamics.html">music21.dynamics</a>
</li>
<li>
<a href="music21.expressions.html">music21.expressions</a>
</li>
<li>
<a href="music21.fromPython.html">music21.fromPython</a>
</li>
<li>
<a href="music21.instrument.html">music21.instrument</a>
</li>
<li>
<a href="music21.interval.html">music21.interval</a>
</li>
<li>
<a href="music21.key.html">music21.key</a>
</li>
<li>
<a href="music21.keyboard.html">music21.keyboard</a>
</li>
<li>
<a href="music21.meter.html">music21.meter</a>
</li>
<li>
<a href="music21.miditools.html">music21.miditools</a>
</li>
<li>
<a href="music21.note.html">music21.note</a>
</li>
<li>
<a href="music21.pitch.html">music21.pitch</a>
</li>
<li>
<a href="music21.prebase.html">music21.prebase</a>
</li>
<li>
<a href="music21.renderOptions.html">music21.renderOptions</a>
</li>
<li>
<a href="music21.roman.html">music21.roman</a>
</li>
<li>
<a href="music21.scale.html">music21.scale</a>
</li>
<li>
<a href="music21.sites.html">music21.sites</a>
</li>
<li>
<a href="music21.stream.html">music21.stream</a>
</li>
<li>
<a href="music21.tempo.html">music21.tempo</a>
</li>
<li>
<a href="music21.tie.html">music21.tie</a>
</li>
<li>
<a href="music21.tinyNotation.html">music21.tinyNotation</a>
</li>
<li>
<a href="music21.vfShow.html">music21.vfShow</a>
</li>
<li>
<a href="music21.webmidi.html">music21.webmidi</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="music21.articulations.Accent.html">music21.articulations.Accent</a>
</li>
<li>
<a href="music21.articulations.Articulation.html">music21.articulations.Articulation</a>
</li>
<li>
<a href="music21.articulations.DynamicArticulation.html">music21.articulations.DynamicArticulation</a>
</li>
<li>
<a href="music21.articulations.LengthArticulation.html">music21.articulations.LengthArticulation</a>
</li>
<li>
<a href="music21.articulations.Marcato.html">music21.articulations.Marcato</a>
</li>
<li>
<a href="music21.articulations.PitchArticulation.html">music21.articulations.PitchArticulation</a>
</li>
<li>
<a href="music21.articulations.Spiccato.html">music21.articulations.Spiccato</a>
</li>
<li>
<a href="music21.articulations.Staccatissimo.html">music21.articulations.Staccatissimo</a>
</li>
<li>
<a href="music21.articulations.Staccato.html">music21.articulations.Staccato</a>
</li>
<li>
<a href="music21.articulations.StrongAccent.html">music21.articulations.StrongAccent</a>
</li>
<li>
<a href="music21.articulations.Tenuto.html">music21.articulations.Tenuto</a>
</li>
<li>
<a href="music21.articulations.TimbreArticulation.html">music21.articulations.TimbreArticulation</a>
</li>
<li>
<a href="music21.base.Music21Object.html">music21.base.Music21Object</a>
</li>
<li>
<a href="music21.beam.Beam.html">music21.beam.Beam</a>
</li>
<li>
<a href="music21.beam.Beams.html">music21.beam.Beams</a>
</li>
<li>
<a href="music21.chord.Chord.html">music21.chord.Chord</a>
</li>
<li>
<a href="music21.clef.AltoClef.html">music21.clef.AltoClef</a>
</li>
<li>
<a href="music21.clef.BassClef.html">music21.clef.BassClef</a>
</li>
<li>
<a href="music21.clef.Clef.html">music21.clef.Clef</a>
</li>
<li>
<a href="music21.clef.MezzoSopranoClef.html">music21.clef.MezzoSopranoClef</a>
</li>
<li>
<a href="music21.clef.PercussionClef.html">music21.clef.PercussionClef</a>
</li>
<li>
<a href="music21.clef.SopranoClef.html">music21.clef.SopranoClef</a>
</li>
<li>
<a href="music21.clef.TenorClef.html">music21.clef.TenorClef</a>
</li>
<li>
<a href="music21.clef.Treble8vaClef.html">music21.clef.Treble8vaClef</a>
</li>
<li>
<a href="music21.clef.Treble8vbClef.html">music21.clef.Treble8vbClef</a>
</li>
<li>
<a href="music21.clef.TrebleClef.html">music21.clef.TrebleClef</a>
</li>
<li>
<a href="music21.duration.Duration.html">music21.duration.Duration</a>
</li>
<li>
<a href="music21.duration.Tuplet.html">music21.duration.Tuplet</a>
</li>
<li>
<a href="music21.dynamics.Dynamic.html">music21.dynamics.Dynamic</a>
</li>
<li>
<a href="music21.expressions.Expression.html">music21.expressions.Expression</a>
</li>
<li>
<a href="music21.expressions.Fermata.html">music21.expressions.Fermata</a>
</li>
<li>
<a href="music21.fromPython.Converter.html">music21.fromPython.Converter</a>
</li>
<li>
<a href="music21.instrument.Instrument.html">music21.instrument.Instrument</a>
</li>
<li>
<a href="music21.interval.ChromaticInterval.html">music21.interval.ChromaticInterval</a>
</li>
<li>
<a href="music21.interval.DiatonicInterval.html">music21.interval.DiatonicInterval</a>
</li>
<li>
<a href="music21.interval.GenericInterval.html">music21.interval.GenericInterval</a>
</li>
<li>
<a href="music21.interval.Interval.html">music21.interval.Interval</a>
</li>
<li>
<a href="music21.key.Key.html">music21.key.Key</a>
</li>
<li>
<a href="music21.key.KeySignature.html">music21.key.KeySignature</a>
</li>
<li>
<a href="music21.keyboard.BlackKey.html">music21.keyboard.BlackKey</a>
</li>
<li>
<a href="music21.keyboard.Key.html">music21.keyboard.Key</a>
</li>
<li>
<a href="music21.keyboard.Keyboard.html">music21.keyboard.Keyboard</a>
</li>
<li>
<a href="music21.keyboard.WhiteKey.html">music21.keyboard.WhiteKey</a>
</li>
<li>
<a href="music21.meter.TimeSignature.html">music21.meter.TimeSignature</a>
</li>
<li>
<a href="music21.miditools.Event.html">music21.miditools.Event</a>
</li>
<li>
<a href="music21.miditools.MidiPlayer.html">music21.miditools.MidiPlayer</a>
</li>
<li>
<a href="music21.note.GeneralNote.html">music21.note.GeneralNote</a>
</li>
<li>
<a href="music21.note.Lyric.html">music21.note.Lyric</a>
</li>
<li>
<a href="music21.note.Note.html">music21.note.Note</a>
</li>
<li>
<a href="music21.note.NotRest.html">music21.note.NotRest</a>
</li>
<li>
<a href="music21.note.Rest.html">music21.note.Rest</a>
</li>
<li>
<a href="music21.pitch.Accidental.html">music21.pitch.Accidental</a>
</li>
<li>
<a href="music21.pitch.Pitch.html">music21.pitch.Pitch</a>
</li>
<li>
<a href="music21.prebase.ProtoM21Object.html">music21.prebase.ProtoM21Object</a>
</li>
<li>
<a href="music21.renderOptions.RenderOptions.html">music21.renderOptions.RenderOptions</a>
</li>
<li>
<a href="music21.roman.RomanNumeral.html">music21.roman.RomanNumeral</a>
</li>
<li>
<a href="music21.stream.Measure.html">music21.stream.Measure</a>
</li>
<li>
<a href="music21.stream.Part.html">music21.stream.Part</a>
</li>
<li>
<a href="music21.stream.Score.html">music21.stream.Score</a>
</li>
<li>
<a href="music21.stream.Stream.html">music21.stream.Stream</a>
</li>
<li>
<a href="music21.stream.Voice.html">music21.stream.Voice</a>
</li>
<li>
<a href="music21.tempo.Metronome.html">music21.tempo.Metronome</a>
</li>
<li>
<a href="music21.tie.Tie.html">music21.tie.Tie</a>
</li>
<li>
<a href="music21.vfShow.Renderer.html">music21.vfShow.Renderer</a>
</li>
<li>
<a href="music21.vfShow.RenderStack.html">music21.vfShow.RenderStack</a>
</li>
<li>
<a href="Notation.html">Notation</a>
</li>
<li>
<a href="Page.html">Page</a>
</li>
<li>
<a href="Recorder.html">Recorder</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="global.html#getM21attribute">getM21attribute</a>
</li>
<li>
<a href="global.html#layout">layout</a>
</li>
<li>
<a href="global.html#midiNumDiffFromFrequency">midiNumDiffFromFrequency</a>
</li>
<li>
<a href="global.html#recorderWorkerJs">recorderWorkerJs</a>
</li>
<li>
<a href="global.html#unpickler">unpickler</a>
</li>
<li>
<a href="global.html#warnBanner">warnBanner</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span12">
<div id="main">
<h1 class="page-title">Source: music21/tempo.js</h1>
<section>
<article>
<pre
class="sunlight-highlight-javascript linenums">/**
* music21j -- Javascript reimplementation of Core music21 features.
* music21/tempo -- tempo and (not in music21p) metronome objects
*
* Copyright (c) 2013-18, Michael Scott Cuthbert and cuthbertLab
* Based on music21, Copyright (c) 2006–17, Michael Scott Cuthbert and cuthbertLab
*
*/
import * as MIDI from 'MIDI';
import * as $ from 'jquery';
import { prebase } from './prebase.js';
/* a Music21Object in m21p; the overhead is too high here to follow ... */
/**
* tempo module, see {@link music21.tempo}
*
* @exports music21/tempo
*/
/**
* tempo namespace
*
* @namespace music21.tempo
* @memberof music21
* @requires music21/prebase
* @requires music21/base
* @requires MIDI
* @property {number} [baseTempo=60] - basic tempo
*/
export const tempo = {};
/**
* Object mapping names to tempo values
*
* @name music21.tempo.defaultTempoValues
* @memberof music21.tempo
* @example
* music21.tempo.defaultTempoValues.grave
* // 40
*/
tempo.defaultTempoValues = {
larghissimo: 16,
largamente: 32,
grave: 40,
'molto adagio': 40,
largo: 46,
lento: 52,
adagio: 56,
slow: 56,
langsam: 56,
larghetto: 60,
adagietto: 66,
andante: 72,
andantino: 80,
'andante moderato': 83,
maestoso: 88,
moderato: 92,
moderate: 92,
allegretto: 108,
animato: 120,
'allegro moderato': 128,
allegro: 132,
fast: 132,
schnell: 132,
allegrissimo: 140,
'molto allegro': 144,
'très vite': 144,
vivace: 160,
vivacissimo: 168,
presto: 184,
prestissimo: 208,
};
tempo.baseTempo = 60;
/* --------- metronome ---------- */
/**
*
* @class Metronome
* @memberof music21.tempo
* @extends music21.prebase.ProtoM21Object
* @param {number} [tempo=music21.tempo.baseTempo] - the tempo of the metronome to start
* @property {number} tempo
* @property {int} [numBeatsPerMeasure=4]
* @property {number} [minTempo=10]
* @property {number} [maxTempo=600]
* @property {bool} [flash=false] - flash the tempo
* @property {bool} [silent=false] - play silently
* @property {int} beat - current beat number
* @property {int} chirpTimeout - an index of a timeout object for chirping
*/
export class Metronome extends prebase.ProtoM21Object {
constructor(tempoInt) {
super();
this._tempo = 60; // overridden by music21.tempo.baseTempo;
if (tempoInt === undefined) {
this.tempo = tempo.baseTempo;
} else {
this.tempo = tempoInt;
}
this.numBeatsPerMeasure = 4;
this.minTempo = 10;
this.maxTempo = 600;
this.beat = this.numBeatsPerMeasure;
this.chirpTimeout = undefined;
this.silent = false;
this.flash = false;
this.tempoRanges = [0, 40, 60, 72, 120, 144, 240, 999];
this.tempoIncreases = [0, 1, 2, 3, 4, 6, 8, 15, 100];
}
get tempo() {
return this._tempo;
}
set tempo(t) {
this._tempo = t;
if (this._tempo > this.maxTempo) {
this._tempo = this.maxTempo;
} else if (this._tempo < this.minTempo) {
this._tempo = this.minTempo;
}
}
get beatLength() {
return 60.0 / this.tempo;
}
_silentFlash(flashColor) {
this.$metronomeDiv
.find('.metroFlash')
.css('background-color', flashColor)
.fadeOut(this.beatLength * 1000 * 1 / 4, function silentFadeOut() {
$(this)
.css('background-color', '#ffffff')
.fadeIn(1);
});
}
/**
* Play a note (a higher one on the downbeat) and start the metronome chirping.
*
* @memberof music21.tempo.Metronome
*/
chirp() {
this.beat += 1;
if (this.beat > this.numBeatsPerMeasure) {
this.beat = 1;
if (this.silent !== true) {
MIDI.noteOn(0, 96, 100, 0);
MIDI.noteOff(0, 96, 0.1);
}
if (this.flash === true) {
this._silentFlash('#0000f0');
}
} else {
if (this.silent !== true) {
MIDI.noteOn(0, 84, 70, 0);
MIDI.noteOff(0, 84, 0.1);
}
if (this.flash === true) {
this._silentFlash('#ff0000');
}
}
const that = this;
this.chirpTimeout = setTimeout(() => {
that.chirp();
}, 1000 * 60 / this.tempo);
}
/**
* Stop the metronome from chirping.
*
* @memberof music21.tempo.Metronome
*/
stopChirp() {
if (this.chirpTimeout !== undefined) {
clearTimeout(this.chirpTimeout);
this.chirpTimeout = undefined;
}
}
/**
* Increase the metronome tempo one "click".
*
* Value changes depending on the current tempo. Uses standard metronome guidelines.
*
* To change the tempo, just set this.tempo = n
*
* @memberof music21.tempo.Metronome
* @param {int} n - number of clicks to the right
* @returns {number} new tempo
*/
increaseSpeed(n) {
// increase by one metronome 'click' for every n
if (n === undefined) {
n = 1;
}
for (let i = 0; i < n; i++) {
let t = this.tempo;
for (let tr = 0; tr < this.tempoRanges.length; tr++) {
const tempoExtreme = this.tempoRanges[tr];
const tempoIncrease = this.tempoIncreases[tr];
if (t < tempoExtreme) {
t += tempoIncrease;
t = tempoIncrease * Math.round(t / tempoIncrease);
break;
}
}
// console.log(t);
this.tempo = t;
}
return this.tempo;
}
/**
* Decrease the metronome tempo one "click"
*
* To change the tempo, just set this.tempo = n
*
* @memberof music21.tempo.Metronome
* @param {int} n - number of clicks to the left
* @returns {number} new tempo
*/
decreaseSpeed(n) {
if (n === undefined) {
n = 1;
}
for (let i = 0; i < n; i++) {
let t = this.tempo;
const trL = this.tempoRanges.length;
for (let tr = 1; tr <= trL; tr++) {
const tempoExtreme = this.tempoRanges[trL - tr];
const tempoIncrease = this.tempoIncreases[trL - tr + 1];
if (t > tempoExtreme) {
t -= tempoIncrease;
t = tempoIncrease * Math.floor(t / tempoIncrease);
break;
}
}
// console.log(t);
this.tempo = t;
}
}
/**
* add a Metronome interface onto the DOM at where
*
* @memberof music21.tempo.Metronome
* @param {JQueryDOMObject|DOMObject} [where='body']
* @returns {JQueryDOMObject} - a div holding the metronome.
*/
addDiv(where) {
let jWhere;
if (where !== undefined && where.jquery !== undefined) {
jWhere = where;
} else if (where !== undefined) {
jWhere = $(where);
} else {
jWhere = $('body');
}
const metroThis = this;
const tempoHolder = $(
'<span class="tempoHolder">' + this.tempo.toString() + '</span>'
);
tempoHolder.css({
'font-size': '24px',
'padding-left': '10px',
'padding-right': '10px',
});
const newDiv = $('<div class="metronomeRendered"></div>');
newDiv.append(tempoHolder);
const b1 = $('<button>start</button>');
b1.on('click', () => {
metroThis.chirp();
});
const b2 = $('<button>stop</button>');
b2.on('click', () => {
metroThis.stopChirp();
});
newDiv.prepend(b2);
newDiv.prepend(b1);
const b3 = $('<button>up</button>');
b3.on('click', function increaseSpeedButton() {
metroThis.increaseSpeed();
$(this)
.prevAll('.tempoHolder')
.html(metroThis.tempo.toString());
});
const b4 = $('<button>down</button>');
b4.on('click', function decreaseSpeedButton() {
metroThis.decreaseSpeed();
$(this)
.prevAll('.tempoHolder')
.html(metroThis.tempo.toString());
});
newDiv.append(b3);
newDiv.append(b4);
const $flash = $(
'<span class="metroFlash">'
+ '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span>'
);
$flash.css('margin-left', '40px');
$flash.css('height', '40px');
newDiv.append($flash);
jWhere.append(newDiv);
this.$metronomeDiv = newDiv;
return newDiv;
}
}
tempo.Metronome = Metronome;
</pre>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Music21j, Copyright © 2013-2018 Michael Scott Cuthbert and cuthbertLab.
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Wed Jul 4th 2018 using the <a
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
<br clear="both">
</div>
</div>
<!--<script src="scripts/sunlight.js"></script>-->
<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script>
$( function () {
$( "[id*='$']" ).each( function () {
var $this = $( this );
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
} );
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : "100px"
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
$( '.dropdown-toggle' ).dropdown();
// $( ".tutorial-section pre, .readme-section pre" ).addClass( "sunlight-highlight-javascript" ).addClass( "linenums" );
$( ".tutorial-section pre, .readme-section pre" ).each( function () {
var $this = $( this );
var example = $this.find( "code" );
exampleText = example.html();
var lang = /{@lang (.*?)}/.exec( exampleText );
if ( lang && lang[1] ) {
exampleText = exampleText.replace( lang[0], "" );
example.html( exampleText );
lang = lang[1];
} else {
lang = "javascript";
}
if ( lang ) {
$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );
}
} );
Sunlight.highlightAll( {
lineNumbers : true,
showMenu : true,
enableDoclinks : true
} );
} );
</script>
<!--Navigation and Symbol Display-->
<!--Google Analytics-->
</body>
</html>