Last active
February 22, 2019 01:11
-
-
Save fabiozeh/62018d04ee9f507bf800d157e89c579f to your computer and use it in GitHub Desktop.
A simple parser for reading MusicXML scores into MATLAB.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
% | |
% This function reads from a musicXML file generating a MATLAB array | |
% holding per-note information. | |
% | |
% Only works with partwise MusicXML scores, for now. | |
% | |
% Notes array is compatible with MIDItoolbox nmap by taking its first | |
% seven columns. | |
% | |
% Octave users will need the io package for the xmlread function. Also, | |
% these notes should help solving java dependency problems: | |
% https://octave.sourceforge.io/io/function/xmlread.html | |
% | |
% Columns of the notes array: | |
% 1) note onset (measured in beats from the start, zero-based) | |
% 2) duration (in beats) | |
% 3) midi channel (always = 0) | |
% 4) midi pitch (0 for rests) | |
% 5) midi velocity (always = 80) | |
% 6) note onset (in seconds, quarter = 100bpm or as given in score) | |
% 7) duration (in seconds, see above) | |
% 8) measure number (one-based) | |
% 9) key (an integer representing number of fifths. | |
% e.g.: key = 2 --> D major / B minor, | |
% key = -1 --> F major / D minor) | |
% 10) time signature ''beats'' (top number) | |
% 11) time signature ''beat type'' (bottom number) | |
% 12) last dynamics indication with following syntax: | |
% no previous indication (default) = 'n' (in ascii) | |
% ppp (pianississimo) = '2' (in ascii) | |
% pp (pianissimo) = '3' | |
% p (piano) = '4' | |
% mp (mezzo piano) = '5' | |
% mf (mezzo forte) = '6' | |
% f (forte) = '7' | |
% ff (fortissimo) = '8' | |
% fff (fortississimo) = '9' | |
% sfz/fz/sf (sforzando) = 's' | |
% other (unmapped) = '0' | |
% 13) number of beats since last dynamics indication | |
% e.g.: 0 = indication aligned with this note | |
% 2 = last indication 2 beats before this note | |
% 14) change in dynamics with syntax (in ascii): | |
% no indication (default) = 'n' | |
% crescendo = 'c' | |
% diminuendo = 'd' | |
% 15) articulation with following syntax (in ascii): | |
% legato (default) = 'l' | |
% stacato = '.' | |
% accent = '<' | |
% tenuto = '-' | |
% 16) vibrato? (0 = no, 1 = yes) | |
% 17) ornamentation with syntax: | |
% no indication (default) = 'n' | |
% grace note (accacciatura or appoggiatura) = 'g' | |
% trill = 't' | |
% 18) slur present? (0 = no, 1 = yes) | |
% 19) Is note a slur start? (0 = no, 1 = yes) | |
% | |
% Notes: | |
% - treble clef is assumed, for now. | |
% - time alterations such as ties ans dots are handled by changing | |
% duration values. | |
% - Accidentals (sharps, flats etc.) are handled by changing | |
% pitch number accordingly. | |
% - Overlapping or nested slurs are not supported because of the | |
% chosen representation. In such cases the union of slurs is considered, | |
% preserving the representation of present/not present. | |
% - Grace notes themselves are ignored, and the following note marked as | |
% ornamented, regardless of the indicated grace note pitch. | |
% | |
% Copyright 2018 Fabio Jose Muneratti Ortega. | |
% | |
% Permission is hereby granted, free of charge, to any person obtaining a | |
% copy of this software and associated documentation files (the "Software"), | |
% to deal in the Software without restriction, including without limitation | |
% the rights to use, copy, modify, merge, publish, distribute, sublicense, | |
% and/or sell copies of the Software, and to permit persons to whom the | |
% Software is furnished to do so, subject to the following conditions: | |
% | |
% The above copyright notice and this permission notice shall be included | |
% in all copies or substantial portions of the Software. | |
% | |
% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS | |
% OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | |
% THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | |
% FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER | |
% DEALINGS IN THE SOFTWARE. | |
% | |
function mxml = parseMusicXML(filename) | |
% Test to see if we're in Octave | |
isOctave = exist('OCTAVE_VERSION', 'builtin') ~= 0; | |
if (isOctave) | |
pkg load io | |
% make sure Xerces2 jar files are loaded or put them in the folder | |
% where the script will run and uncomment below. | |
% javaaddpath ("./xercesImpl.jar"); | |
% javaaddpath ("./xml-apis.jar"); | |
fid = fopen(filename, 'rt'); | |
content = fread(fid, '*char')'; | |
fclose(fid); | |
newcontent = regexprep(content, '\n\s*?<!DOCTYPE.*?>', ''); | |
fout = fopen('temp.xml', 'wt'); | |
fwrite(fout, newcontent); | |
fclose(fout); | |
dom = xmlread('temp.xml'); | |
else | |
% Create the DocumentBuilder | |
builder = javaMethod('newInstance', 'javax.xml.parsers.DocumentBuilderFactory'); | |
% Disable validation (because of MATLAB's xmlread bug) | |
builder.setFeature('http://apache.org/xml/features/nonvalidating/load-external-dtd', false); | |
dom = xmlread(filename, builder); | |
end | |
beatCounter = 0; | |
currBeats = NaN; | |
currBeatType = NaN; | |
currKey = 0; % default C maj | |
%currAccidentals = [0, 0, 0, 0, 0, 0, 0]; % will be initialized below | |
currTempo = 100; % default tempo 100 bpm | |
currDyn = 'n'; % no dynamics indication | |
currWedge = 'n'; % no wedge | |
currOrnam = 'n'; % no ornamentation | |
currDynOnset = 0; | |
slurStarted = 0; | |
ind = 1; % note array index | |
% parse first 'part' | |
part = dom.getElementsByTagName('part').item(0); | |
measures = part.getElementsByTagName('measure'); | |
mxml(measures.getLength, 19) = NaN; % minimal preallocation | |
for i = 0:(measures.getLength()-1) | |
% parse each measure | |
measure = measures.item(i); | |
measureNum = javaMethod('parseInt', 'java.lang.Integer', measure.getAttributes(). ... | |
getNamedItem('number').getValue()); | |
% reset sharps/flats for new measure; | |
currAccidentals = accidentalsForKey(currKey); | |
% parse each measure element | |
for j = 0:(measure.getLength()-1) | |
switch char(measure.item(j).getNodeName()) | |
case 'attributes' | |
[currKey, currBeats, currBeatType] = parseAttributes(measure.item(j)); | |
currAccidentals = accidentalsForKey(currKey); | |
case 'note' | |
[st, oc, d, a, v, o, s, ac] = parseNote(measure.item(j)); | |
if (~isnan(ac)) | |
% Note indicated a change of accidentals. | |
currAccidentals = updateAccidentals(st, ac, currAccidentals); | |
end | |
if (o ~= 'g') % if the note isn't a grace note, include it in output | |
p = midiPitch(st, oc, currAccidentals); | |
if (o == '+' && a == 'l') | |
% if this note is linked with a tie, change | |
% duration of the previous note instead of | |
% including a new one. | |
mxml(ind-1, 2) = mxml(ind-1, 2) + d; | |
mxml(ind-1, 7) = mxml(ind-1, 7) + d*60.0/currTempo; | |
else | |
if currOrnam == 'n' % if there is no grace note to indicate | |
currOrnam = o; % indicated ornamentation is as parsed | |
end | |
mxml(ind, 1:4) = [beatCounter, d, 0, p];%, ... | |
mxml(ind, 5:7) = [ 80, beatCounter*60.0/currTempo, d*60.0/currTempo];%, ... | |
mxml(ind, 8:11) = [ measureNum, currKey, currBeats, currBeatType];%, ... | |
mxml(ind, 12:17) = [ currDyn, beatCounter - currDynOnset, currWedge, a, v, currOrnam];%, ... | |
mxml(ind, 18:19) = [ (s == 1 || slurStarted == 1), isequal(s,1)]; | |
currOrnam = 'n'; | |
ind = ind + 1; | |
end | |
beatCounter = beatCounter + d; | |
slurStarted = s + slurStarted; | |
else | |
currOrnam = o; | |
end | |
case 'direction' | |
typeList = measure.item(j).getElementsByTagName('direction-type').item(0).getChildNodes(); | |
for k = 0:(typeList.getLength()-1) | |
type = typeList.item(k); | |
switch char(type.getNodeName()) | |
case 'metronome' | |
unit = char(type.getElementsByTagName('beat-unit'). ... | |
item(0).getFirstChild().getNodeValue()); | |
tempo = javaMethod('parseInt', 'java.lang.Integer', ... | |
type.getElementsByTagName('per-minute').item(0).getFirstChild().getNodeValue()); | |
if (strcmp(unit, 'quarter')) | |
currTempo = tempo; | |
elseif (strcmp(unit, 'eighth')) | |
currTempo = tempo/2; | |
else | |
currTempo = tempo; | |
end | |
case 'dynamics' | |
dynNodes = type.getChildNodes(); | |
currDyn = '0'; % unknown | |
for l = 0:(dynNodes.getLength()-1) | |
dyn = char(dynNodes.item(l).getNodeName()); | |
if (strcmpi(dyn, 'fz') || strcmpi(dyn, 'sfz') || strcmpi(dyn, 'sf')) | |
currDyn = 's'; | |
elseif (strcmpi(dyn, 'fff')) | |
currDyn = '9'; | |
elseif (strcmpi(dyn, 'ff')) | |
currDyn = '8'; | |
elseif (strcmpi(dyn, 'f')) | |
currDyn = '7'; | |
elseif (strcmpi(dyn, 'mf')) | |
currDyn = '6'; | |
elseif (strcmpi(dyn, 'mp')) | |
currDyn = '5'; | |
elseif (strcmpi(dyn, 'p')) | |
currDyn = '4'; | |
elseif (strcmpi(dyn, 'pp')) | |
currDyn = '3'; | |
elseif (strcmpi(dyn, 'ppp')) | |
currDyn = '2'; | |
end | |
end | |
currDynOnset = beatCounter; | |
case 'wedge' | |
wt = char(type.getAttributes().getNamedItem('type').getValue()); | |
switch wt | |
case 'stop' | |
currWedge = 'n'; | |
otherwise | |
currWedge = wt(1); | |
end | |
end | |
end | |
end | |
end | |
end | |
end | |
function accid = accidentalsForKey(fifths) | |
fifthsMat = [0, 0, 0, 0, 0, 0, 0; | |
0, 0, 0, 1, 0, 0, 0; | |
1, 0, 0, 1, 0, 0, 0; | |
1, 0, 0, 1, 1, 0, 0; | |
1, 1, 0, 1, 1, 0, 0; | |
1, 1, 0, 1, 1, 1, 0; | |
1, 1, 1, 1, 1, 1, 0; | |
1, 1, 1, 1, 1, 1, 1]; | |
if (fifths >= 0) | |
accid = fifthsMat(fifths+1, :); | |
else | |
accid = fifthsMat(8+fifths,:) - 1; | |
end | |
end | |
function acList = updateAccidentals(step, newAc, acList) | |
if strcmpi('C', step) | |
acList(1) = newAc; | |
elseif strcmpi('D', step) | |
acList(2) = newAc; | |
elseif strcmpi('E', step) | |
acList(3) = newAc; | |
elseif strcmpi('F', step) | |
acList(4) = newAc; | |
elseif strcmpi('G', step) | |
acList(5) = newAc; | |
elseif strcmpi('A', step) | |
acList(6) = newAc; | |
elseif strcmpi('B', step) | |
acList(7) = newAc; | |
end | |
end | |
function p = midiPitch(step, octave, accid) | |
p = 12 + octave*12; | |
if strcmpi('C', step) | |
p = p + accid(1); | |
elseif strcmpi('D', step) | |
p = p + 2 + accid(2); | |
elseif strcmpi('E', step) | |
p = p + 4 + accid(3); | |
elseif strcmpi('F', step) | |
p = p + 5 + accid(4); | |
elseif strcmpi('G', step) | |
p = p + 7 + accid(5); | |
elseif strcmpi('A', step) | |
p = p + 9 + accid(6); | |
elseif strcmpi('B', step) | |
p = p + 11 + accid(7); | |
else %rest | |
p = 0; | |
end | |
end | |
function [step, octave, duration, art, vib, orn, slur, accid] = parseNote(note) | |
nodes = note.getChildNodes(); | |
hasDot = 0; | |
art = 'l'; % default: legato | |
vib = 0; | |
orn = 'n'; % default: no ornamentation | |
slur = 0; | |
step = NaN; | |
accid = NaN; | |
octave = 0; | |
duration = 0; | |
timeModNum = 1; | |
timeModDen = 1; | |
for i = 0:(nodes.getLength()-1) | |
elmt = nodes.item(i); | |
switch char(elmt.getNodeName()) | |
case 'pitch' | |
step = char(elmt.getElementsByTagName( ... | |
'step').item(0).getFirstChild().getNodeValue()); | |
octave = javaMethod('parseInt', 'java.lang.Integer', elmt.getElementsByTagName( ... | |
'octave').item(0).getFirstChild().getNodeValue()); | |
case 'dot' | |
hasDot = 1; | |
case 'rest' | |
step = 'rest'; | |
case 'tie' | |
if (strcmpi('stop', ... | |
char(elmt.getAttributes().getNamedItem('type'). ... | |
getValue()))) | |
orn = '+'; | |
end | |
case 'type' | |
switch char(elmt.getFirstChild().getNodeValue()) | |
case 'whole' | |
duration = 4; | |
case 'half' | |
duration = 2; | |
case 'quarter' | |
duration = 1; | |
case 'eighth' | |
duration = 0.5; | |
case '16th' | |
duration = 0.25; | |
case '32nd' | |
duration = 0.125; | |
end | |
case 'time-modification' | |
timeModNum = javaMethod('parseInt', 'java.lang.Integer', elmt.getElementsByTagName( ... | |
'normal-notes').item(0).getFirstChild().getNodeValue()); | |
timeModDen = javaMethod('parseInt', 'java.lang.Integer', elmt.getElementsByTagName( ... | |
'actual-notes').item(0).getFirstChild().getNodeValue()); | |
case 'accidental' | |
switch char(elmt.getFirstChild().getNodeValue()) | |
case 'sharp' | |
accid = 1; | |
case 'flat' | |
accid = -1; | |
case 'double-sharp' | |
accid = 2; | |
case 'double-flat' | |
accid = -2; | |
case 'natural' | |
accid = 0; | |
end | |
case 'grace' | |
orn = 'g'; % todo: accacciatura or appogiatura | |
case 'notations' | |
nots = elmt.getChildNodes(); | |
for j = 0:(nots.getLength()-1) | |
switch char(nots.item(j).getNodeName()) | |
case 'slur' | |
t = nots.item(j).getAttributes().getNamedItem( ... | |
'type').getValue(); | |
if strcmpi(t, 'start') | |
slur = 1; | |
else % stop | |
slur = -1; | |
end | |
case 'articulations' | |
art = nots.item(j).getChildNodes(); | |
if (art.getElementsByTagName('accent').getLength() > 0) | |
art = '<'; | |
elseif (art.getElementsByTagName('staccato').getLength() > 0) | |
art = '.'; | |
elseif (art.getElementsByTagName('tenuto').getLength() > 0) | |
art = '-'; | |
else | |
art = 'l'; | |
end | |
case 'technical' | |
% todo | |
case 'ornaments' | |
ornmt = nots.item(j).getChildNodes(); | |
if (ornmt.getElementsByTagName('trill-mark').getLength() > 0) | |
orn = 't'; | |
end | |
end | |
end | |
end | |
end | |
duration = duration *timeModNum/timeModDen; | |
if hasDot | |
duration = duration * 1.5; | |
end | |
end | |
function [key, beat, beatType] = parseAttributes(attr) | |
key = NaN; | |
beat = NaN; | |
beatType = NaN; | |
% change of key | |
k = attr.getElementsByTagName('key'); | |
if (k.getLength() > 0) | |
fifths = k.item(0).getElementsByTagName('fifths'); | |
if (fifths.getLength() > 0) | |
key = javaMethod('parseInt', 'java.lang.Integer', fifths.item(0).getFirstChild().getNodeValue()); | |
end | |
end | |
% change of time signature | |
time = attr.getElementsByTagName('time'); | |
if (time.getLength() > 0) | |
beats = time.item(0).getElementsByTagName('beats'); | |
if (beats.getLength() > 0) | |
beat = javaMethod('parseInt', 'java.lang.Integer', beats.item(0).getFirstChild().getNodeValue()); | |
end | |
beatType = time.item(0).getElementsByTagName('beat-type'); | |
if (beatType.getLength() > 0) | |
beatType = javaMethod('parseInt', 'java.lang.Integer', beatType.item(0).getFirstChild().getNodeValue()); | |
end | |
end | |
% ignoring clef... | |
end |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment