-
Notifications
You must be signed in to change notification settings - Fork 3
/
hum2XMLFixUp.py
286 lines (229 loc) · 9.93 KB
/
hum2XMLFixUp.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
import unittest
from music21 import common
from music21 import exceptions21
from music21 import pitch
from music21 import interval
from music21 import stream
from music21 import converter
from music21 import metadata
import numpy as np
import os
#-------------------------------------------------------------------------------
def oneKrnToXml(fileSourcePath, fileName):
'''
Processes one pair of corresponding KRN and XML files,
producing a new XML score with the original metadata (from the KRN score)
and any necessary character swaps in both the metadata and lyrics.
'''
interimScore = transferMetadata(fileSourcePath, fileName)
newScore = lyricSwap(interimScore)
return newScore
def corpusKrnToXml(fileSourcePath, fileDestinationPath,
searchTerm=None, fileFormat='.krn'): # Either, to avoid both
'''
Batch processes a corpus of corresponding KRN and XML files;
assumes the same folder (fileSourcePath) and file name, but different extensions (KRN vs XML).
Call either fileFormat='.krn' or '.xml' to avoid other files in the folder.
'''
preparedFileList = prepFileList(fileSourcePath, searchTerm, fileFormat)
for eachFile in preparedFileList: #[n]:
try:
xmlScore = oneKrnToXml(fileSourcePath, eachFile)
comp = commasIn(xmlScore.metadata.composer)
tit = xmlScore.metadata.title
xmlScore.write(fmt='musicxml',
fp=fileDestinationPath+comp+' - '+tit+'.xml')
except:
print('Error in processing '+eachFile)
#-------------------------------------------------------------------------------
def characterSwaps(anyTextString):
'''
Swaps out humdrum ASCII text representations like 'a/'
for the corresponding character with accents ('á').
Removes the characers used forphrase analysis etc ({, }, |)
Replaces the tilde ‘~’ used for literal dashes (in cases like ‘veux-tu’)
with an en-dash at the end of the dashed-from word,
and nothing at the start of the dashed-to word.
'''
characterDict = {'a/':'á', 'e/':'é', 'i/':'í', 'o/':'ó', 'u/':'ú',
'A/':'Á', 'E/':'É', 'I/':'Í', 'O/':'Ó', 'U/':'Ú',
'a\\':'à', 'e\\':'è', 'i\\':'ì', 'o\\':'ò', 'u\\':'ù',
'A\\':'À', 'E\\':'È', 'I\\':'Ì', 'O\\':'Ò', 'U\\':'Ù',
'a^':'â', 'e^':'ê', 'i^':'î', 'o^':'ô', 'u^':'û',
'A^':'A', 'E^':'Ê', 'I^':'Î', 'O^':'Ô', 'U^':'U',
'a0':'å', #'e0':'', 'i0':'', 'o0':'', 'u0':'',
'a1':'ā', 'e1':'ē', 'i1':'ī', 'o1':'ō', 'u1':'ū',
'a2':'ä', 'e2':'ē', 'i2':'ï', 'o2':'ö', 'u2':'ü',
'c5':'ç','C5':'Ç',
'c6':'č','C6':'Č',
'{': '', '}': '', '|': '', '"': '', #Single characters to cut
'~': '–',} # Cheat solution for literal dash in written French e.g. ‘veux-tu'
# https://musiccog.ohio-state.edu/Humdrum/representations/text.rep.html
output = anyTextString
for key in characterDict:
output = output.replace(key, characterDict[key])
if output:
if output[0] == '–':
output = output[1:] #Cut first character of dashed-to word
return output
def lyricSwap(score):
'''
Applies characterSwaps function to the lyrics (specifically) of an input score
'''
fullNotesAndRests = score.recurse().notesAndRests
for note in fullNotesAndRests:
if note.lyric:
note.lyric = characterSwaps(note.lyric)
return score
#-------------------------------------------------------------------------------
def prepFileList(fileSourcePath, searchTerm=None, fileFormat=None):
'''
Prepares a file list from a directory path and
(optionally) filters for searchTerm and / or fileFormat such as '.xml')
'''
initialList = []
finalList = []
for file in os.listdir(fileSourcePath):
initialList.append(file)
if searchTerm is not None and fileFormat is not None:
finalList = [x for x in initialList
if x.endswith(fileFormat)
and searchTerm in x]
elif searchTerm is None and fileFormat is not None:
finalList = [x for x in initialList
if x.endswith(fileFormat)]
elif searchTerm is not None and fileFormat is None:
finalList = [x for x in initialList
if searchTerm in x]
elif searchTerm is None and fileFormat is None:
finalList = initialList
return finalList
#-------------------------------------------------------------------------------
def commasOut(text):
'''
For 'Surname, FirstName' to 'FirstName Surname' conversions
'''
if ',' in text:
position = text.index(',')
twoNames = (text[position+2:],' ', text[:position])
newName = ''.join(twoNames)
else:
newName = text
return newName
def commasIn(text):
'''
For 'FirstName Surname' to 'Surname, FirstName' conversions
'''
if ',' not in text:
position = text.index(' ')#To do: ossia for 'van'?
twoNames = (text[position+1:],', ', text[:position])
newName = ''.join(twoNames)
else:
newName = text
return newName
#-------------------------------------------------------------------------------
def transferMetadata(fileSourcePath, fileName):
'''
Taking an KRN score and initial XML conversion using humtools,
transferMetadata returns an XML score with the original metadata (from the KRN score),
including character swaps.
Use either the '.krn' or the '.xml' version for the fileName.
'''
# try:
krnScore = converter.parse(fileSourcePath+fileName[0:-4]+'.krn')
xmlScore = converter.parse(fileSourcePath+fileName[0:-4]+'.xml')
# except:
# ScoreError:
# print('Error in converting score: '+fileName[0:-4])
# pass
md = krnScore.metadata.all()
mdDict = dict(md)
# NB: characterSwaps done here, once for all
newMDDict = {k: characterSwaps(v) for k, v in mdDict.items()}
#Special case of Composer (for commas)
if newMDDict.get('composer'):
comp = newMDDict.get('composer')
xmlScore.metadata.composer = commasOut(comp)
else:
xmlScore.metadata.composer = 'no_composer_info'
#Special case of Lyricist (for commas and contributor role)
c = metadata.Contributor()
c.role = 'lyricist'
if newMDDict.get('lyricist'):
lyr = newMDDict.get('lyricist')
c.name = commasOut(lyr)
else:
c.name = 'no_lyricist_info'
xmlScore.metadata.addContributor(c)
#The rest. TODO: generalise (see below)
if newMDDict.get('parentTitle'):
vanhemp = newMDDict.get('parentTitle')
xmlScore.metadata.parentTitle = vanhemp
else:
xmlScore.metadata.parentTitle = 'no_parentTitle_info'
if newMDDict.get('opusNumber'):
op = newMDDict.get('opusNumber')
xmlScore.metadata.opusNumber = op
else:
xmlScore.metadata.opusNumber = 'no_opusNumber_info'
if newMDDict.get('number'):
no = newMDDict.get('number')
xmlScore.metadata.number = no
else:
xmlScore.metadata.number = 'no_number_info'
if newMDDict.get('title'):
tit = newMDDict.get('title')
xmlScore.metadata.title = tit
xmlScore.metadata.movementName = tit
else:
xmlScore.metadata.title = 'no_title_info'
# metadataOfInterest = ('composer', 'lyricist',
# 'parentTitle', 'opusNumber', 'number',
# 'title', 'textOriginalLanguage')
# for item in metadataOfInterest:
# if newMDDict.get(item):
# value = newMDDict.get(item)
# "xmlScore.metadata.%s" %item
# %s = final # Fails from here
# else:
# xmlScore.metadata.item = 'No_'+item+'_Info'
return xmlScore
#------------------------------------------------------------------------------
class Test(unittest.TestCase):
def testOfCharacter(self):
startText = ['a/','e/','i/','o/','u/','A/','E/','I/','O/','U/',
'a\\','e\\','i\\','o\\','u\\','A\\','E\\','I\\','O\\','U\\',
'a^','e^','i^','o^','u^','A^','E^','I^','O^','U^',
'a0','a1','e1','i1','o1','u1','a2','e2','i2','o2','u2','c5','C5','c6','C6',
'{','}','|','"', '~']
newText = [characterSwaps(x) for x in startText]
self.assertIsInstance(startText[0], str)
self.assertIsInstance(newText[0], str)
self.assertEqual(len(startText), 50)
self.assertEqual(len(newText), 50)
self.assertEqual(startText[0], 'a/')
self.assertEqual(newText[0], 'á')
def testLyricSwap(self):
testVoice = corpus.parse('schubert/Lindenbaum').parts[0]
# TODO Get another song: quite slow to load and no lyrics needing swapping.
newScore = lyricSwap(testVoice) # No change in this case
oldNotesAndRests = testVoice.recurse().notes #AndRests
newNotesAndRests = newScore.recurse().notes #AndRests
note0 = newNotesAndRests[0]
note0Lyric = note0.lyric
self.assertEqual(len(oldNotesAndRests), 205)
self.assertEqual(oldNotesAndRests, newNotesAndRests)
self.assertEqual(note0.name, 'B')
self.assertEqual(note0Lyric, 'Am')
self.assertIsInstance(note0Lyric, str)
def testCommasOut(self):
testName = 'Surname, FirstName'
newName = commasOut(testName)
self.assertIsInstance(newName, str)
self.assertEqual(newName[0], 'F')
def testCommasIn(self):
testName = 'FirstName Surname'
newName = commasIn(testName)
self.assertIsInstance(newName, str)
self.assertEqual(newName[0], 'S')
#------------------------------------------------------------------------------