vexflow
Version:
A JavaScript library for rendering music notation and guitar tablature
712 lines (508 loc) • 21.7 kB
HTML
<html>
<head>
<title>tuning.js</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="stylesheet" media="all" href="public/stylesheets/normalize.css" />
<link rel="stylesheet" media="all" href="docco.css" />
</head>
<body>
<div class="container">
<div class="page">
<div class="header">
<h1>tuning.js</h1>
<div class="toc">
<h3>Table of Contents</h3>
<ol>
<li>
<a class="source" href="accidental.html">
accidental.js
</a>
</li>
<li>
<a class="source" href="annotation.html">
annotation.js
</a>
</li>
<li>
<a class="source" href="articulation.html">
articulation.js
</a>
</li>
<li>
<a class="source" href="barnote.html">
barnote.js
</a>
</li>
<li>
<a class="source" href="beam.html">
beam.js
</a>
</li>
<li>
<a class="source" href="bend.html">
bend.js
</a>
</li>
<li>
<a class="source" href="boundingbox.html">
boundingbox.js
</a>
</li>
<li>
<a class="source" href="boundingboxcomputation.html">
boundingboxcomputation.js
</a>
</li>
<li>
<a class="source" href="canvascontext.html">
canvascontext.js
</a>
</li>
<li>
<a class="source" href="clef.html">
clef.js
</a>
</li>
<li>
<a class="source" href="clefnote.html">
clefnote.js
</a>
</li>
<li>
<a class="source" href="crescendo.html">
crescendo.js
</a>
</li>
<li>
<a class="source" href="curve.html">
curve.js
</a>
</li>
<li>
<a class="source" href="dot.html">
dot.js
</a>
</li>
<li>
<a class="source" href="easyscore.html">
easyscore.js
</a>
</li>
<li>
<a class="source" href="element.html">
element.js
</a>
</li>
<li>
<a class="source" href="factory.html">
factory.js
</a>
</li>
<li>
<a class="source" href="formatter.html">
formatter.js
</a>
</li>
<li>
<a class="source" href="fraction.html">
fraction.js
</a>
</li>
<li>
<a class="source" href="frethandfinger.html">
frethandfinger.js
</a>
</li>
<li>
<a class="source" href="ghostnote.html">
ghostnote.js
</a>
</li>
<li>
<a class="source" href="glyph.html">
glyph.js
</a>
</li>
<li>
<a class="source" href="glyphnote.html">
glyphnote.js
</a>
</li>
<li>
<a class="source" href="gracenote.html">
gracenote.js
</a>
</li>
<li>
<a class="source" href="gracenotegroup.html">
gracenotegroup.js
</a>
</li>
<li>
<a class="source" href="gracetabnote.html">
gracetabnote.js
</a>
</li>
<li>
<a class="source" href="index.html">
index.js
</a>
</li>
<li>
<a class="source" href="keymanager.html">
keymanager.js
</a>
</li>
<li>
<a class="source" href="keysignature.html">
keysignature.js
</a>
</li>
<li>
<a class="source" href="keysignote.html">
keysignote.js
</a>
</li>
<li>
<a class="source" href="modifier.html">
modifier.js
</a>
</li>
<li>
<a class="source" href="modifiercontext.html">
modifiercontext.js
</a>
</li>
<li>
<a class="source" href="multimeasurerest.html">
multimeasurerest.js
</a>
</li>
<li>
<a class="source" href="music.html">
music.js
</a>
</li>
<li>
<a class="source" href="note.html">
note.js
</a>
</li>
<li>
<a class="source" href="notehead.html">
notehead.js
</a>
</li>
<li>
<a class="source" href="notesubgroup.html">
notesubgroup.js
</a>
</li>
<li>
<a class="source" href="ornament.html">
ornament.js
</a>
</li>
<li>
<a class="source" href="parser.html">
parser.js
</a>
</li>
<li>
<a class="source" href="pedalmarking.html">
pedalmarking.js
</a>
</li>
<li>
<a class="source" href="raphaelcontext.html">
raphaelcontext.js
</a>
</li>
<li>
<a class="source" href="registry.html">
registry.js
</a>
</li>
<li>
<a class="source" href="renderer.html">
renderer.js
</a>
</li>
<li>
<a class="source" href="repeatnote.html">
repeatnote.js
</a>
</li>
<li>
<a class="source" href="smufl.html">
smufl.js
</a>
</li>
<li>
<a class="source" href="stave.html">
stave.js
</a>
</li>
<li>
<a class="source" href="stavebarline.html">
stavebarline.js
</a>
</li>
<li>
<a class="source" href="staveconnector.html">
staveconnector.js
</a>
</li>
<li>
<a class="source" href="stavehairpin.html">
stavehairpin.js
</a>
</li>
<li>
<a class="source" href="staveline.html">
staveline.js
</a>
</li>
<li>
<a class="source" href="stavemodifier.html">
stavemodifier.js
</a>
</li>
<li>
<a class="source" href="stavenote.html">
stavenote.js
</a>
</li>
<li>
<a class="source" href="staverepetition.html">
staverepetition.js
</a>
</li>
<li>
<a class="source" href="stavesection.html">
stavesection.js
</a>
</li>
<li>
<a class="source" href="stavetempo.html">
stavetempo.js
</a>
</li>
<li>
<a class="source" href="stavetext.html">
stavetext.js
</a>
</li>
<li>
<a class="source" href="stavetie.html">
stavetie.js
</a>
</li>
<li>
<a class="source" href="stavevolta.html">
stavevolta.js
</a>
</li>
<li>
<a class="source" href="stem.html">
stem.js
</a>
</li>
<li>
<a class="source" href="stemmablenote.html">
stemmablenote.js
</a>
</li>
<li>
<a class="source" href="stringnumber.html">
stringnumber.js
</a>
</li>
<li>
<a class="source" href="strokes.html">
strokes.js
</a>
</li>
<li>
<a class="source" href="svgcontext.html">
svgcontext.js
</a>
</li>
<li>
<a class="source" href="system.html">
system.js
</a>
</li>
<li>
<a class="source" href="tables.html">
tables.js
</a>
</li>
<li>
<a class="source" href="tabnote.html">
tabnote.js
</a>
</li>
<li>
<a class="source" href="tabslide.html">
tabslide.js
</a>
</li>
<li>
<a class="source" href="tabstave.html">
tabstave.js
</a>
</li>
<li>
<a class="source" href="tabtie.html">
tabtie.js
</a>
</li>
<li>
<a class="source" href="textbracket.html">
textbracket.js
</a>
</li>
<li>
<a class="source" href="textdynamics.html">
textdynamics.js
</a>
</li>
<li>
<a class="source" href="textnote.html">
textnote.js
</a>
</li>
<li>
<a class="source" href="tickable.html">
tickable.js
</a>
</li>
<li>
<a class="source" href="tickcontext.html">
tickcontext.js
</a>
</li>
<li>
<a class="source" href="timesignature.html">
timesignature.js
</a>
</li>
<li>
<a class="source" href="timesignote.html">
timesignote.js
</a>
</li>
<li>
<a class="source" href="tremolo.html">
tremolo.js
</a>
</li>
<li>
<a class="source" href="tuning.html">
tuning.js
</a>
</li>
<li>
<a class="source" href="tuplet.html">
tuplet.js
</a>
</li>
<li>
<a class="source" href="vex.html">
vex.js
</a>
</li>
<li>
<a class="source" href="vibrato.html">
vibrato.js
</a>
</li>
<li>
<a class="source" href="vibratobracket.html">
vibratobracket.js
</a>
</li>
<li>
<a class="source" href="voice.html">
voice.js
</a>
</li>
<li>
<a class="source" href="voicegroup.html">
voicegroup.js
</a>
</li>
</ol>
</div>
</div>
<p><a href="http://vexflow.com">VexFlow</a> - Copyright (c) Mohit Muthanna 2010.</p>
<h2 id="description">Description</h2>
<p>This class implements varies types of tunings for tablature.</p>
<div class='highlight'><pre>
<span class="hljs-keyword">import</span> { Vex } <span class="hljs-keyword">from</span> <span class="hljs-string">'./vex'</span>;
<span class="hljs-keyword">import</span> { Flow } <span class="hljs-keyword">from</span> <span class="hljs-string">'./tables'</span>;
<span class="hljs-keyword">export</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Tuning</span> </span>{
<span class="hljs-keyword">static</span> get names() {
<span class="hljs-keyword">return</span> {
<span class="hljs-string">'standard'</span>: <span class="hljs-string">'E/5,B/4,G/4,D/4,A/3,E/3'</span>,
<span class="hljs-string">'dagdad'</span>: <span class="hljs-string">'D/5,A/4,G/4,D/4,A/3,D/3'</span>,
<span class="hljs-string">'dropd'</span>: <span class="hljs-string">'E/5,B/4,G/4,D/4,A/3,D/3'</span>,
<span class="hljs-string">'eb'</span>: <span class="hljs-string">'Eb/5,Bb/4,Gb/4,Db/4,Ab/3,Db/3'</span>,
<span class="hljs-string">'standardBanjo'</span>: <span class="hljs-string">'D/5,B/4,G/4,D/4,G/5'</span>,
};
}
<span class="hljs-keyword">constructor</span>(tuningString = 'E/5,B/4,G/4,D/4,A/3,E/3,B/2,E/2') {</pre></div>
<p>Default to standard tuning.</p>
<div class='highlight'><pre> <span class="hljs-keyword">this</span>.setTuning(tuningString);
}
noteToInteger(noteString) {
<span class="hljs-keyword">return</span> Flow.keyProperties(noteString).int_value;
}
setTuning(noteString) {
<span class="hljs-keyword">if</span> (Tuning.names[noteString]) {
noteString = Tuning.names[noteString];
}
<span class="hljs-keyword">this</span>.tuningString = noteString;
<span class="hljs-keyword">this</span>.tuningValues = [];
<span class="hljs-keyword">this</span>.numStrings = <span class="hljs-number">0</span>;
<span class="hljs-keyword">const</span> keys = noteString.split(<span class="hljs-regexp">/\s*,\s*/</span>);
<span class="hljs-keyword">if</span> (keys.length === <span class="hljs-number">0</span>) {
<span class="hljs-keyword">throw</span> <span class="hljs-keyword">new</span> Vex.RERR(<span class="hljs-string">'BadArguments'</span>, <span class="hljs-string">'Invalid tuning string: '</span> + noteString);
}
<span class="hljs-keyword">this</span>.numStrings = keys.length;
<span class="hljs-keyword">for</span> (<span class="hljs-keyword">let</span> i = <span class="hljs-number">0</span>; i < <span class="hljs-keyword">this</span>.numStrings; ++i) {
<span class="hljs-keyword">this</span>.tuningValues[i] = <span class="hljs-keyword">this</span>.noteToInteger(keys[i]);
}
}
getValueForString(stringNum) {
<span class="hljs-keyword">const</span> s = <span class="hljs-built_in">parseInt</span>(stringNum, <span class="hljs-number">10</span>);
<span class="hljs-keyword">if</span> (s < <span class="hljs-number">1</span> || s > <span class="hljs-keyword">this</span>.numStrings) {
<span class="hljs-keyword">throw</span> <span class="hljs-keyword">new</span> Vex.RERR(
<span class="hljs-string">'BadArguments'</span>, <span class="hljs-string">`String number must be between 1 and <span class="hljs-subst">${<span class="hljs-keyword">this</span>.numStrings}</span>:<span class="hljs-subst">${stringNum}</span>`</span>
);
}
<span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.tuningValues[s - <span class="hljs-number">1</span>];
}
getValueForFret(fretNum, stringNum) {
<span class="hljs-keyword">const</span> stringValue = <span class="hljs-keyword">this</span>.getValueForString(stringNum);
<span class="hljs-keyword">const</span> f = <span class="hljs-built_in">parseInt</span>(fretNum, <span class="hljs-number">10</span>);
<span class="hljs-keyword">if</span> (f < <span class="hljs-number">0</span>) {
<span class="hljs-keyword">throw</span> <span class="hljs-keyword">new</span> Vex.RERR(<span class="hljs-string">'BadArguments'</span>, <span class="hljs-string">'Fret number must be 0 or higher: '</span> +
fretNum);
}
<span class="hljs-keyword">return</span> stringValue + f;
}
getNoteForFret(fretNum, stringNum) {
<span class="hljs-keyword">const</span> noteValue = <span class="hljs-keyword">this</span>.getValueForFret(fretNum, stringNum);
<span class="hljs-keyword">const</span> octave = <span class="hljs-built_in">Math</span>.floor(noteValue / <span class="hljs-number">12</span>);
<span class="hljs-keyword">const</span> value = noteValue % <span class="hljs-number">12</span>;
<span class="hljs-keyword">return</span> Flow.integerToNote(value) + <span class="hljs-string">'/'</span> + octave;
}
}</pre></div>
<div class="fleur">h</div>
</div>
</div>
</body>
</html>